Skip to content

Commit b4fff98

Browse files
committed
updated example docs
1 parent f421bc8 commit b4fff98

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/examples.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,30 @@ Ensure your device works with this simple test.
66
.. literalinclude:: ../examples/qwiicjoystick_simpletest.py
77
:caption: examples/qwiicjoystick_simpletest.py
88
:linenos:
9+
10+
Examples
11+
---------
12+
13+
1. Basic Readings - Print the joystick position and button status.
14+
15+
.. literalinclude:: ../examples/example1_basic_readings.py
16+
:caption: examples/example1_basic_readings.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: examples/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: examples/example3_i2c_scanner.py
29+
:linenos:
30+
31+
4. Joystick Output - Print joystick position and button status as directions.
32+
33+
.. literalinclude:: ../examples/example4_joytstick_output.py
34+
:caption: examples/example4_joystick_output.py
35+
:linenos:

0 commit comments

Comments
 (0)