Skip to content

Commit 07b5af5

Browse files
Update example reference with links
1 parent 0e6efa8 commit 07b5af5

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

examples/README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,50 @@ NOTE: Any numbering of examples is to retain consistency with the Arduino librar
77
Simple Example for the Qwiic Button. Checks whether the button is pressed and
88
then prints its status.
99

10+
The key methods showcased by this example are:
11+
- [is_button_pressed()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a4650881c1b1b92ae7f5136f85c8f7385)
12+
1013
## Qwiic Button Ex2 Ledon
1114
Simple Example for the Qwiic Button. Turns on the button's built in LED
1215
when pressed and prints status.
1316

17+
The key methods showcased by this example are:
18+
- [LED_on()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a782725413ccd408499c68e98a90de8da)
19+
- [LED_off()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a336063d15fae188869bea17f28742950)
20+
1421
## Qwiic Button Ex3 Ledconfig
1522
Simple Example for the Qwiic Button. Checks whether the button is pressed and
1623
and the LED pulses if it is.
1724

25+
The key methods showcased by this example are:
26+
- [LED_config()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#abc191302e346c948db1afb240e4162db)
27+
1828
## Qwiic Button Ex4 Queueusage
1929
Simple Example for the Qwiic Button. Shows how to use he FIFO Queue on the Qwiic Button.
2030

31+
The key methods showcased by this example are:
32+
- [is_pressed_queue_empty()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#acbfa1c9c3a4e4d66db5bb7572899c346)
33+
- [time_since_last_press()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a9b613cd3b2950e32e5fdd55cd05db41e)
34+
- [time_since_first_press()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a3e03b887cc2689aadc7e7830f2f2b8ac)
35+
- [is_clicked_queue_empty()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#ad633b6b3f42fbd3c7a560e1e68e45848)
36+
- [time_since_last_click()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a35c95e275d2ec89a03a2fab95b63de58)
37+
- [time_since_first_click()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a34cf627be486f530c9e2a33b158990bc)
38+
2139
## Qwiic Button Ex5 Popqueue
2240
Simple Example for the Qwiic Button. Shows how to use he FIFO Queue on the Qwiic Button.
2341

42+
The key methods showcased by this example are:
43+
- [pop_clicked_queue()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a3e169dd9951d413a4c88e849fd22b67f)
44+
2445
## Qwiic Button Ex6 Changei2Caddress
2546
Simple Example for the Qwiic Button. Shows how to change the I2C address of
2647
the Qwiic Button
2748

49+
The key methods showcased by this example are:
50+
- [set_I2C_address()](https://docs.sparkfun.com/qwiic_button_py/classqwiic__button_1_1_qwiic_button.html#a0658dfd332b10404ad5d18e74de1b7aa)
51+
2852
## Qwiic Button Ex7 2Buttons
2953
Simple Example for the Qwiic Button. Daisy chain together two Qwiic Buttons
3054
with different I2C addresses. This example works for a Qwiic Button with the
3155
default address of 0x6F and one with an address changed to 0x5B. To change
3256
the address of a Qwiic Button, please visit example 6.
33-
34-

0 commit comments

Comments
 (0)