Skip to content

Commit a24f835

Browse files
Update example reference with links
1 parent 1022d62 commit a24f835

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

examples/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,22 @@ NOTE: Any numbering of examples is to retain consistency with the Arduino librar
66
## Qwiic Relay Ex1 Single
77
Example that shows the basics of using the single relay.
88

9+
The key methods showcased by this example are:
10+
- [get_relay_state()](https://docs.sparkfun.com/qwiic_relay_py/classqwiic__relay_1_1_qwiic_relay.html#a13f6189e3eab51e3789634698b25e964)
11+
- [set_relay_off()](https://docs.sparkfun.com/qwiic_relay_py/classqwiic__relay_1_1_qwiic_relay.html#abf6d3441123340f697a3d3ed77ed81d1)
12+
913
## Qwiic Relay Ex2 Dual
1014
Example that shows the basics of using the dual relays.
1115

16+
It shows how to pass parameters to [get_relay_state()](https://docs.sparkfun.com/qwiic_relay_py/classqwiic__relay_1_1_qwiic_relay.html#a13f6189e3eab51e3789634698b25e964)
17+
1218
## Qwiic Relay Ex3 Quad
1319
Example that shows the basics of using the quad relays.
1420

1521
## Qwiic Relay Ex4 Pwm
1622
Example that shows how to set and get the slow PWM value
1723

24+
The key methods showcased by this example are:
25+
- [set_slow_pwm()](https://docs.sparkfun.com/qwiic_relay_py/classqwiic__relay_1_1_qwiic_relay.html#a8ef8b677aecdcb5fee370002b207fe72)
26+
- [get_slow_pwm()](https://docs.sparkfun.com/qwiic_relay_py/classqwiic__relay_1_1_qwiic_relay.html#a13c04f5a9c4802a382fa7458080543b1)
1827

0 commit comments

Comments
 (0)