8000 Merge pull request #658 from tannewt/driver_page_update · ladyada/circuitpython@5f326ac · GitHub
[go: up one dir, main page]
Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 5f326ac

Browse files
kattnikattni
authored
Merge pull request adafruit#658 from tannewt/driver_page_update
Update driver links (for 2.x) including categories!
2 parents 892d5cd + 4f55205 commit 5f326ac

File tree

2 files changed

+171
-29
lines changed

2 files changed

+171
-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: 170 additions & 28 deletions
10000
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,179 @@ 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/en/latest/>
60+
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/en/latest/< EDBE /span>>
61+
OneWire <https://circuitpython.readthedocs.io/projects/onewire/en/latest/>
62+
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
63+
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/en/latest/>
64+
Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/en/latest/>
65+
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
66+
AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/en/latest/>
67+
DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/en/latest/>
68+
SD Card <https://circuitpython.readthedocs.io/projects/sd/en/latest/>
69+
70+
Blinky
71+
--------
72+
73+
Multi-color led drivers.
74+
75+
.. toctree::
76+
77+
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
78+
DotStar <https://circuitpython.readthedocs.io/projects/dotstar/en/latest/>
79+
80+
Displays
81+
-------------
4982

50-
Drivers
51-
-------
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/en/latest/>
88+
Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/en/latest/>
89+
HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/en/latest/>
90+
IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/en/latest/>
91+
MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/en/latest/>
92+
SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/en/latest/>
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/en/latest/>
103+
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
104+
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
105+
106+
Motion Sensors
107+
----------------
108+
109+
Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and ``orientation``.
110+
111+
.. toctree::
52112

53-
Drivers provide easy access to sensors and other chips without requiring a
54-
knowledge of the interface details of the chip itself.
113+
BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation <https://circuitpython.readthedocs.io/projects/bno055/en/latest/>
114+
FXAS21002C Gyroscope <https://circuitpython.readthedocs.io/projects/fxas21002C/en/latest/>
115+
FXOS8700 Accelerometer <https://circuitpython.readthedocs.io/projects/fxos8700/en/latest/>
116+
GPS Global Position <https://circuitpython.readthedocs.io/projects/gps/en/latest/>
117+
LIS3DH Accelerometer <https://circuitpython.readthedocs.io/projects/lis3dh/en/latest/>
118+
LSM303 Accelerometer and Magnetometer <https://circuitpython.readthedocs.io/projects/lsm303/en/latest/>
119+
LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds0/en/latest/>
120+
LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/en/latest/>
121+
MMA8451 3 axis accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/en/latest/>
122+
123+
Environmental Sensors
124+
----------------------
125+
126+
Sense attributes of the environment including ``temperature``, ``relative_humidity``, ``pressure``,
127+
equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic compounds (``tvoc`` /
128+
``TVOC``).
129+
130+
.. toctree::
131+
132+
BME280 Temperature, Humidity and Pressure <https://circuitpython.readthedocs.io/projects/bme280/en/latest/>
133+
BME680 Temperature, Humidity, Pressure and Gas <https://circuitpython.readthedocs.io/projects/bme680/en/latest/>
134+
BMP280 Barometric Pressure and Altitude <https://circuitpython.readthedocs.io/projects/bmp280/en/latest/>
135+
CCS811 Air Quality <https://circuitpython.readthedocs.io/projects/ccs811/en/latest/>
136+
DHT Temperature and Humidity <https://circuitpython.readthedocs.io/projects/dht/en/latest/>
137+
DS18x20 Temperature <https://circuitpython.readthedocs.io/projects/ds18x20/en/latest/>
138+
MAX31865 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31865/en/latest/>
139+
MAX31855 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31855/en/latest/>
140+
MCP9808 Temperature <https://circuitpython.readthedocs.io/projects/mcp9808/en/latest/>
141+
MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor <https://circuitpython.readthedocs.io/projects/mpl3115a2/en/latest/>
142+
SGP30 Air Quality <https://circuitpython.readthedocs.io/projects/sgp30/en/latest/>
143+
SHT31-D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/sht31d/en/latest/>
144+
Si7021 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/si7021/en/latest/>
145+
Thermistor Temperature <https://circuitpython.readthedocs.io/projects/thermistor/en/latest/>
146+
147+
Light Sensors
148+
---------------
149+
150+
These sensors detect light related attributes such as ``color``, ``light`` (unit-less), and
151+
``lux`` (light in SI lux).
152+
153+
.. toctree::
154+
155+
APDS9960 Proximity, Light, RGB, and Gesture <https://circuitpython.readthedocs.io/projects/apds9960/en/latest/>
156+
TCS34725 Color Sensor <https://circuitpython.readthedocs.io/projects/tcs34725/en/latest/>
157+
TSL2561 Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2561/en/latest/>
158+
TSL2591 High Dynamic Range Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2591/en/latest/>
159+
VCNL4010 Proximity and Light <https://circuitpython.readthedocs.io/projects/vcnl4010/en/latest/>
160+
VEML6070 UV Index <https://circuitpython.readthedocs.io/projects/veml6070/en/latest/>
161+
162+
Distance Sensors
163+
------------------
164+
165+
These sensors measure the ``distance`` to another object and may also measure light level (``light`` and ``lux``).
166+
167+
.. toctree::
168+
169+
VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/en/latest/>
170+
VL53L0x ~30 - 1000 mm <https://circuitpython.readthedocs.io/projects/vl53l0x/en/latest/>
171+
172+
Radio
173+
--------
174+
175+
These chips communicate to other's over radio.
176+
177+
.. toctree::
178+
179+
RFM9x LoRa <https://circuitpython.readthedocs.io/projects/rfm9x/en/latest/>
180+
RFM69 Packet Radio <https://circuitpython.readthedocs.io/projects/rfm69/en/latest/>
181+
182+
IO Expansion
183+
--------------
184+
185+
These provide functionality similar to `analogio`, `digitalio`, `pulseio`, and `touchio`.
186+
187+
.. toctree::
188+
189+
Adafruit SeeSaw <https://circuitpython.readthedocs.io/projects/seesaw/en/latest/>
190+
ADS1x15 Analog-to-Digital Converter <https://circuitpython.readthedocs.io/projects/ads1x15/en/latest/>
191+
DS2413 OneWire GPIO Expander <https://circuitpython.readthedocs.io/projects/ds2413/en/latest/>
192+
FocalTech Capacitive Touch <https://circuitpython.readthedocs.io/projects/focaltouch/en/latest/>
193+
MCP4725 Digital-to-Analog Converter <https://circuitpython.readthedocs.io/projects/mcp4725/en/latest/>
194+
PCA9685 16 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/pca9685/en/latest/>
195+
TLC5947 24 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc5947/en/latest/>
196+
TLC59711 12 x 16-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc59711/en/latest/>
197+
MPR121 Capacitive Touch Sensor <https://circuitpython.readthedocs.io/projects/mpr121/en/latest/>
198+
199+
200+
Miscellaneous
201+
----------------
55202

56203
.. toctree::
57204

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/>
205+
Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/en/latest/>
206+
AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/en/latest/>
207+
Trellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/trellis/en/latest/>
208+
DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/en/latest/>
209+
MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/en/latest/>
210+
Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/en/latest/>
211+
Thermal Printer <https://circuitpython.readthedocs.io/projects/thermal_printer/en/latest/>
212+
VC0706 TTL Camera <https://circuitpython.readthedocs.io/projects/vc0706/en/latest/>
213+
INA219 High Side Current <https://circuitpython.readthedocs.io/projects/ina219/en/latest/>
214+
Fingerprint <https://circuitpython.readthedocs.io/projects/fingerprint/en/latest/>

0 commit comments

Comments
 (0)
0