Skip to content

Commit 7ec4e2b

Browse files
Update example reference with links
1 parent 526cc1a commit 7ec4e2b

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

examples/README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,54 @@ NOTE: Any numbering of examples is to retain consistency with the Arduino librar
66
## Qwiic Alphanumeric Ex01 Print String
77
This example shows how to use the print() function to illuminate strings
88
on the alphanumeric display.
9-
----------------------------------------------------------------------
9+
10+
The key methods showcased by this example are:
11+
- [print()](https://docs.sparkfun.com/qwiic_alphanumeric_py/classqwiic__alphanumeric_1_1_qwiic_alphanumeric.html#a916b7edd972f2655306c29fa94e11c8b)
1012

1113
## Qwiic Alphanumeric Ex02 Turn On One Segment
1214
This example tests illuminating individual segments of the display. Pass
1315
in the segment and digit you wish to illuminate into illuminate_segment().
14-
----------------------------------------------------------------------
16+
17+
The key methods showcased by this example are:
18+
- [illuminate_segment()](https://docs.sparkfun.com/qwiic_alphanumeric_py/classqwiic__alphanumeric_1_1_qwiic_alphanumeric.html#a57963d3941b17d1cf992b60dd68bd299)
19+
- [update_display()](https://docs.sparkfun.com/qwiic_alphanumeric_py/classqwiic__alphanumeric_1_1_qwiic_alphanumeric.html#adaa07a72b027a94dff73b75bea491eae)
20+
1521

1622
## Qwiic Alphanumeric Ex03 Print Char
1723
This example tests illuminating a whole character on the 14-segment display.
18-
----------------------------------------------------------------------
24+
25+
The key methods showcased by this example are:
26+
- [print_char()](https://docs.sparkfun.com/qwiic_alphanumeric_py/classqwiic__alphanumeric_1_1_qwiic_alphanumeric.html#aa69cf5d994454993d1de69ad109773b2)
1927

2028
## Qwiic Alphanumeric Ex04 Set Brightness
2129
This example sets the brightness of the Qwiic Alphanumeric display.
22-
----------------------------------------------------------------------
30+
31+
The key methods showcased by this example are:
32+
- [set_brightness()](https://docs.sparkfun.com/qwiic_alphanumeric_py/classqwiic__alphanumeric_1_1_qwiic_alphanumeric.html#ac76307a2ce343f33fbb081fb6e79deaa)
2333

2434
## Qwiic Alphanumeric Ex05 Set Blink Rate
2535
This example sets the blink rate of the display.
26-
----------------------------------------------------------------------
36+
37+
The key methods showcased by this example are:
38+
- [set_blink_rate()](https://docs.sparkfun.com/qwiic_alphanumeric_py/classqwiic__alphanumeric_1_1_qwiic_alphanumeric.html#a3dd5d0256707dd2e47f46fbd7cb8d483)
2739

2840
## Qwiic Alphanumeric Ex06 Colon And Decimal
2941
This example tests the library's response to printing colons or decimal points.
30-
----------------------------------------------------------------------
3142

3243
## Qwiic Alphanumeric Ex07 Unknown Char
3344
This example demonstrates what the library does when the user tries to
3445
print an unknown character.
35-
----------------------------------------------------------------------
3646

3747
## Qwiic Alphanumeric Ex08 Multi Display
3848
This example demonstrates how to connect multiple displays to the bus
3949
to print longer strings.
40-
----------------------------------------------------------------------
50+
51+
The key methods showcased by this example are:
52+
- [set_brightness()](https://docs.sparkfun.com/qwiic_alphanumeric_py/classqwiic__alphanumeric_1_1_qwiic_alphanumeric.html#ac76307a2ce343f33fbb081fb6e79deaa)
4153

4254
## Qwiic Alphanumeric Ex09 Scrolling String
4355
This example tests the scrolling functionality of the display.
44-
----------------------------------------------------------------------
4556

57+
The key methods showcased by this example are:
58+
- [shift_left()](https://docs.sparkfun.com/qwiic_alphanumeric_py/classqwiic__alphanumeric_1_1_qwiic_alphanumeric.html#af8c2ce0cbca070fe7d133b3a1078429b)
4659

0 commit comments

Comments
 (0)