Skip to content

Commit f16619a

Browse files
tannewttannewt
committed
Update driver links including categories!
1 parent 892d5cd commit f16619a

File tree

2 files changed

+170
-29
lines changed

2 files changed

+170
-29
lines changed

‎conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,5 +334,5 @@
334334

335335
# Example configuration for intersphinx: refer to the Python standard library.
336336
intersphinx_mapping = {"cpython": ('https://docs.python.org/3/', None),
337-
"bus_device": ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None),
337+
"bus_device": ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),
338338
"register": ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None)}

‎docs/drivers.rst

Lines changed: 169 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Bundle
1313
------
1414

1515
We provide a bundle of all our libraries to ease installation of drivers and
16-
their dependencies. he bundle is primarily geared to the Adafruit Express line
17-
of boards which will feature a relatively large external flash. With Express
18-
boards, its easy to copy them all onto the filesystem. However, if you don't
19-
have enough space simply copy things over as they are needed.
16+
their dependencies. The bundle is primarily geared to the Adafruit Express line
17+
of boards which feature a relatively large external flash. With Express boards,
18+
its easy to copy them all onto the filesystem. However, if you don't have
19+
enough space simply copy things over as they are needed.
2020

2121
The bundles are available `on GitHub <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_.
2222

@@ -26,8 +26,8 @@ To install them:
2626
and unzip the latest zip that's not a source zip.
2727
#. Copy the ``lib`` folder to the ``CIRCUITPY`` or ``MICROPYTHON``.
2828

29-
Foundational Libraries
30-
----------------------
29+
Foundational
30+
------------
3131

3232
These libraries provide critical functionality to many of the drivers below. It
3333
is recommended to always have them installed onto the CircuitPython file system in
@@ -36,37 +36,178 @@ the ``lib/`` directory. Some drivers may not work without them.
3636
.. toctree::
3737

3838
Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
39-
BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/>
39+
BusDevice Library <https://circuitpython.readthedocs.io/projects/busdevice/en/latest/>
40+
41+
Board-specific Helpers
42+
----------------------
43+
44+
These libraries tie lower-level libraries together to provide an easy, out-of-box experience for
45+
specific boards.
46+
47+
.. toctree::
48+
49+
Adafruit CircuitPlayground Express <https://circuitpython.readthedocs.io/projects/circuitplayground/en/latest/>
50+
Adafruit FeatherWings <https://circuitpython.readthedocs.io/projects/featherwing/en/latest/>
4051

4152
Helper Libraries
42-
----------------
53+
-----------------
4354

4455
These libraries build on top of the low level APIs to simplify common tasks.
4556

4657
.. toctree::
4758

48-
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
59+
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/>
60+
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/>
61+
OneWire <https://circuitpython.readthedocs.io/projects/onewire/>
62+
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/>
63+
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/>
64+
Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/>
65+
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/>
66+
AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/>
67+
DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/>
68+
SD Card <https://circuitpython.readthedocs.io/projects/sd/>
69+
70+
Blinky
71+
--------
72+
73+
Multi-color led drivers.
74+
75+
.. toctree::
76+
77+
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/>
78+
DotStar <https://circuitpython.readthedocs.io/projects/dotstar/>
79+
80+
Displays
81+
-------------
82+
83+
Drivers used to display information. Either pixel or segment based.
84+
85+
.. toctree::
86+
87+
RGB Displays <https://circuitpython.readthedocs.io/projects/rgb_display/>
88+
Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/>
89+
HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/>
90+
IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/>
91+
MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/>
92+
SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/>
93+
94+
Real-time clocks
95+
-----------------
96+
97+
Chips that keep current calendar time with a backup battery. The current date and time is available
98+
through ``datetime``.
99+
100+
.. toctree::
101+
102+
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/>
103+
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/>
104+
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/>
105+
106+
Motion Sensors
107+
----------------
108+
109+
Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and ``orientation``.
110+
111+
.. toctree::
112+
BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation <https://circuitpython.readthedocs.io/projects/bno055/>
113+
FXAS21002C Gyroscope <https://circuitpython.readthedocs.io/projects/fxas21002C/>
114+
FXOS8700 Accelerometer <https://circuitpython.readthedocs.io/projects/fxos8700/>
115+
GPS Global Position <https://circuitpython.readthedocs.io/projects/gps/>
116+
LIS3DH Accelerometer <https://circuitpython.readthedocs.io/projects/lis3dh/>
117+
LSM303 Accelerometer and Magnetometer <https://circuitpython.readthedocs.io/projects/lsm303/>
118+
LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds0/>
119+
LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/>
120+
MMA8451 3 axis accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/>
121+
122+
Environmental Sensors
123+
----------------------
124+
125+
Sense attributes of the environment including ``temperature``, ``relative_humidity``, ``pressure``,
126+
equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic compounds (``tvoc`` /
127+
``TVOC``).
128+
129+
.. toctree::
130+
131+
BME280 Temperature, Humidity and Pressure <https://circuitpython.readthedocs.io/projects/bme280/>
132+
BME680 Temperature, Humidity, Pressure and Gas <https://circuitpython.readthedocs.io/projects/bme680/>
133+
BMP280 Barometric Pressure and Altitude <https://circuitpython.readthedocs.io/projects/bmp280/>
134+
CCS811 Air Quality <https://circuitpython.readthedocs.io/projects/ccs811/>
135+
DHT Temperature and Humidity <https://circuitpython.readthedocs.io/projects/dht/>
136+
DS18x20 Temperature <https://circuitpython.readthedocs.io/projects/ds18x20/>
137+
MAX31865 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31865/>
138+
MAX31855 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31855/>
139+
MCP9808 Temperature <https://circuitpython.readthedocs.io/projects/mcp9808/>
140+
MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor <https://circuitpython.readthedocs.io/projects/mpl3115a2/>
141+
SGP30 Air Quality <https://circuitpython.readthedocs.io/projects/sgp30/>
142+
SHT31-D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/sht31d/>
143+
Si7021 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/si7021/>
144+
Thermistor Temperature <https://circuitpython.readthedocs.io/projects/thermistor/>
145+
146+
Light Sensors
147+
---------------
148+
149+
These sensors detect light related attributes such as ``color``, ``light`` (unit-less), and
150+
``lux`` (light in SI lux).
151+
152+
.. toctree::
153+
154+
APDS9960 Proximity, Light, RGB, and Gesture <https://circuitpython.readthedocs.io/projects/apds9960/>
155+
TCS34725 Color Sensor <https://circuitpython.readthedocs.io/projects/tcs34725/>
156+
TSL2561 Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2561/>
157+
TSL2591 High Dynamic Range Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2591/>
158+
VCNL4010 Proximity and Light <https://circuitpython.readthedocs.io/projects/vcnl4010/>
159+
VEML6070 UV Index <https://circuitpython.readthedocs.io/projects/veml6070/>
160+
161+
Distance Sensors
162+
------------------
163+
164+
These sensors measure the ``distance`` to another object and may also measure light level (``light`` and ``lux``).
165+
166+
.. toctree::
167+
168+
VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/>
169+
VL53L0x ~30 - 1000 mm <https://circuitpython.readthedocs.io/projects/vl53l0x/>
170+
171+
Radio
172+
--------
173+
174+
These chips communicate to other's over radio.
175+
176+
.. toctree::
177+
178+
RFM9x LoRa <https://circuitpython.readthedocs.io/projects/rfm9x/>
179+
RFM69 Packet Radio <https://circuitpython.readthedocs.io/projects/rfm69/>
49180

50-
Drivers
51-
-------
181+
IO Expansion
182+
--------------
52183

53-
Drivers provide easy access to sensors and other chips without requiring a
54-
knowledge of the interface details of the chip itself.
184+
These provide functionality similar to `analogio`, `digitalio`, `pulseio`, and `touchio`.
185+
186+
.. toctree::
187+
188+
Adafruit SeeSaw <https://circuitpython.readthedocs.io/projects/seesaw/>
189+
ADS1x15 Analog-to-Digital Converter <https://circuitpython.readthedocs.io/projects/ads1x15/>
190+
DS2413 OneWire GPIO Expander <https://circuitpython.readthedocs.io/projects/d2413/>
191+
FocalTech Capacitive Touch <https://circuitpython.readthedocs.io/projects/focaltouch/>
192+
MCP4725 Digital-to-Analog Converter <https://circuitpython.readthedocs.io/projects/mcp4725/>
193+
PCA9685 16 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/pca9685/>
194+
TLC5947 24 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc5947/>
195+
TLC59711 12 x 16-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc59711/>
196+
MCP4725 Capacitive Touch Sensor <https://circuitpython.readthedocs.io/projects/mpr121/>
197+
198+
199+
Miscellaneous
200+
----------------
55201

56202
.. toctree::
57203

58-
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
59-
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
60-
RGB Displays <http://micropython-rgb.readthedocs.io/>
61-
SD Card <https://circuitpython.readthedocs.io/projects/sdcard/en/latest/>
62-
Analog-to-digital converters: ADS1015 and ADS1115 <http://micropython-ads1015.readthedocs.io/>
63-
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
64-
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
65-
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
66-
TCS34725 Color Sensor <http://micropython-tcs34725.readthedocs.io/>
67-
TSL2561 Light Sensor <http://micropython-tsl2561.readthedocs.io/>
68-
PCA9685 Motor and Servo Controllers <http://micropython-pca9685.readthedocs.io/>
69-
HT16K33 LED Matrices and Segment Displays <http://micropython-ht16k33.readthedocs.io/>
70-
IS31FL3731 Charlieplexed LED Matrix <http://micropython-is31fl3731.readthedocs.io/>
71-
MAX7219 LED Matrix <http://circuitpython.readthedocs.io/projects/max7219/en/latest/>
72-
DotStar <https://circuitpython.readthedocs.io/projects/dotstar/en/latest/>
204+
Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/>
205+
AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/>
206+
Trellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/trellis/>
207+
DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/>
208+
MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/>
209+
Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/>
210+
Thermal Printer <https://circuitpython.readthedocs.io/projects/thermal_printer/>
211+
VC0706 TTL Camera <https://circuitpython.readthedocs.io/projects/vc0706/>
212+
INA219 High Side Current <https://circuitpython.readthedocs.io/projects/ina219/>
213+
Fingerprint <https://circuitpython.readthedocs.io/projects/fingerprint/>

0 commit comments

Comments
 (0)