Skip to content

Commit 52278c0

Browse files
committed
updated example docs
1 parent 9cb2a03 commit 52278c0

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/examples.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,36 @@ Ensure your device works with this simple test.
66
.. literalinclude:: ../examples/qwiicrelay_simpletest.py
77
:caption: examples/qwiicrelay_simpletest.py
88
:linenos:
9+
10+
Ecamples
11+
---------
12+
13+
1. Basic Control - Turn the relay on and off.
14+
15+
.. literalinclude:: ../examples/example1_basic_control.py
16+
:caption: examples/example1_basic_control.py
17+
:linenos:
18+
19+
2. Change I2C Addres - Change the device I2C address.
20+
21+
.. literalinclude:: ../examples/example2_change_i2c_address.py
22+
:caption: example2_change_i2c_address.py
23+
:linenos:
24+
25+
3. I2C Scanner - Scan the IC2 bus for devices.
26+
27+
.. literalinclude:: ../examples/example3_i2c_scanner.py
28+
:caption: example3_i2c_scanner.py
29+
:linenos:
30+
31+
4. Relay Status - Show if the relay is on or off.
32+
33+
.. literalinclude:: ../examples/example4_get_relay_status.py
34+
:caption: examples/example4_get_relay_status.py
35+
:linenos:
36+
37+
1. Firmware Version - Display the firmware version string.
38+
39+
.. literalinclude:: ../examples/example5_get_firmware_version.py
40+
:caption: examples/example5_get_firmware_version.py
41+
:linenos:

0 commit comments

Comments
 (0)