diff options
| author | Scott Shawcroft <scott.shawcroft@gmail.com> | 2018-03-06 16:54:13 -0800 |
|---|---|---|
| committer | Scott Shawcroft <scott.shawcroft@gmail.com> | 2018-03-06 16:54:13 -0800 |
| commit | f16619ad3cc8d19d739902632d52628b43dcf390 (patch) | |
| tree | 26a2eefd33a14fc9125935de345e0d4c01f33b55 /docs | |
| parent | 892d5cda63fbee051b88db3d9cc8e4ba8555cb96 (diff) | |
Update driver links including categories!
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/drivers.rst | 197 |
1 files changed, 169 insertions, 28 deletions
diff --git a/docs/drivers.rst b/docs/drivers.rst index d1baed8e1..40f56b2b0 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -13,10 +13,10 @@ Bundle ------ We provide a bundle of all our libraries to ease installation of drivers and -their dependencies. he bundle is primarily geared to the Adafruit Express line -of boards which will feature a relatively large external flash. With Express -boards, its easy to copy them all onto the filesystem. However, if you don't -have enough space simply copy things over as they are needed. +their dependencies. The bundle is primarily geared to the Adafruit Express line +of boards which feature a relatively large external flash. With Express boards, +its easy to copy them all onto the filesystem. However, if you don't have +enough space simply copy things over as they are needed. The bundles are available `on GitHub <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_. @@ -26,8 +26,8 @@ To install them: and unzip the latest zip that's not a source zip. #. Copy the ``lib`` folder to the ``CIRCUITPY`` or ``MICROPYTHON``. -Foundational Libraries ----------------------- +Foundational +------------ These libraries provide critical functionality to many of the drivers below. It 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. .. toctree:: Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/> - BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/> + BusDevice Library <https://circuitpython.readthedocs.io/projects/busdevice/en/latest/> + +Board-specific Helpers +---------------------- + +These libraries tie lower-level libraries together to provide an easy, out-of-box experience for +specific boards. + +.. toctree:: + + Adafruit CircuitPlayground Express <https://circuitpython.readthedocs.io/projects/circuitplayground/en/latest/> + Adafruit FeatherWings <https://circuitpython.readthedocs.io/projects/featherwing/en/latest/> Helper Libraries ----------------- +----------------- These libraries build on top of the low level APIs to simplify common tasks. .. toctree:: - USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/> + USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/> + Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/> + OneWire <https://circuitpython.readthedocs.io/projects/onewire/> + Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/> + InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/> + Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/> + SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/> + AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/> + DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/> + SD Card <https://circuitpython.readthedocs.io/projects/sd/> + +Blinky +-------- + +Multi-color led drivers. + +.. toctree:: + + NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/> + DotStar <https://circuitpython.readthedocs.io/projects/dotstar/> + +Displays +------------- + +Drivers used to display information. Either pixel or segment based. + +.. toctree:: + + RGB Displays <https://circuitpython.readthedocs.io/projects/rgb_display/> + Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/> + HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/> + IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/> + MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/> + SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/> + +Real-time clocks +----------------- + +Chips that keep current calendar time with a backup battery. The current date and time is available +through ``datetime``. + +.. toctree:: + + DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/> + DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/> + PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/> + +Motion Sensors +---------------- + +Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and ``orientation``. + +.. toctree:: + BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation <https://circuitpython.readthedocs.io/projects/bno055/> + FXAS21002C Gyroscope <https://circuitpython.readthedocs.io/projects/fxas21002C/> + FXOS8700 Accelerometer <https://circuitpython.readthedocs.io/projects/fxos8700/> + GPS Global Position <https://circuitpython.readthedocs.io/projects/gps/> + LIS3DH Accelerometer <https://circuitpython.readthedocs.io/projects/lis3dh/> + LSM303 Accelerometer and Magnetometer <https://circuitpython.readthedocs.io/projects/lsm303/> + LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds0/> + LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/> + MMA8451 3 axis accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/> + +Environmental Sensors +---------------------- + +Sense attributes of the environment including ``temperature``, ``relative_humidity``, ``pressure``, +equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic compounds (``tvoc`` / +``TVOC``). + +.. toctree:: + + BME280 Temperature, Humidity and Pressure <https://circuitpython.readthedocs.io/projects/bme280/> + BME680 Temperature, Humidity, Pressure and Gas <https://circuitpython.readthedocs.io/projects/bme680/> + BMP280 Barometric Pressure and Altitude <https://circuitpython.readthedocs.io/projects/bmp280/> + CCS811 Air Quality <https://circuitpython.readthedocs.io/projects/ccs811/> + DHT Temperature and Humidity <https://circuitpython.readthedocs.io/projects/dht/> + DS18x20 Temperature <https://circuitpython.readthedocs.io/projects/ds18x20/> + MAX31865 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31865/> + MAX31855 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31855/> + MCP9808 Temperature <https://circuitpython.readthedocs.io/projects/mcp9808/> + MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor <https://circuitpython.readthedocs.io/projects/mpl3115a2/> + SGP30 Air Quality <https://circuitpython.readthedocs.io/projects/sgp30/> + SHT31-D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/sht31d/> + Si7021 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/si7021/> + Thermistor Temperature <https://circuitpython.readthedocs.io/projects/thermistor/> + +Light Sensors +--------------- + +These sensors detect light related attributes such as ``color``, ``light`` (unit-less), and +``lux`` (light in SI lux). + +.. toctree:: + + APDS9960 Proximity, Light, RGB, and Gesture <https://circuitpython.readthedocs.io/projects/apds9960/> + TCS34725 Color Sensor <https://circuitpython.readthedocs.io/projects/tcs34725/> + TSL2561 Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2561/> + TSL2591 High Dynamic Range Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2591/> + VCNL4010 Proximity and Light <https://circuitpython.readthedocs.io/projects/vcnl4010/> + VEML6070 UV Index <https://circuitpython.readthedocs.io/projects/veml6070/> + +Distance Sensors +------------------ + +These sensors measure the ``distance`` to another object and may also measure light level (``light`` and ``lux``). + +.. toctree:: + + VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/> + VL53L0x ~30 - 1000 mm <https://circuitpython.readthedocs.io/projects/vl53l0x/> + +Radio +-------- + +These chips communicate to other's over radio. + +.. toctree:: + + RFM9x LoRa <https://circuitpython.readthedocs.io/projects/rfm9x/> + RFM69 Packet Radio <https://circuitpython.readthedocs.io/projects/rfm69/> -Drivers -------- +IO Expansion +-------------- -Drivers provide easy access to sensors and other chips without requiring a -knowledge of the interface details of the chip itself. +These provide functionality similar to `analogio`, `digitalio`, `pulseio`, and `touchio`. + +.. toctree:: + + Adafruit SeeSaw <https://circuitpython.readthedocs.io/projects/seesaw/> + ADS1x15 Analog-to-Digital Converter <https://circuitpython.readthedocs.io/projects/ads1x15/> + DS2413 OneWire GPIO Expander <https://circuitpython.readthedocs.io/projects/d2413/> + FocalTech Capacitive Touch <https://circuitpython.readthedocs.io/projects/focaltouch/> + MCP4725 Digital-to-Analog Converter <https://circuitpython.readthedocs.io/projects/mcp4725/> + PCA9685 16 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/pca9685/> + TLC5947 24 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc5947/> + TLC59711 12 x 16-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc59711/> + MCP4725 Capacitive Touch Sensor <https://circuitpython.readthedocs.io/projects/mpr121/> + + +Miscellaneous +---------------- .. toctree:: - NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/> - SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/> - RGB Displays <http://micropython-rgb.readthedocs.io/> - SD Card <https://circuitpython.readthedocs.io/projects/sdcard/en/latest/> - Analog-to-digital converters: ADS1015 and ADS1115 <http://micropython-ads1015.readthedocs.io/> - DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/> - DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/> - PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/> - TCS34725 Color Sensor <http://micropython-tcs34725.readthedocs.io/> - TSL2561 Light Sensor <http://micropython-tsl2561.readthedocs.io/> - PCA9685 Motor and Servo Controllers <http://micropython-pca9685.readthedocs.io/> - HT16K33 LED Matrices and Segment Displays <http://micropython-ht16k33.readthedocs.io/> - IS31FL3731 Charlieplexed LED Matrix <http://micropython-is31fl3731.readthedocs.io/> - MAX7219 LED Matrix <http://circuitpython.readthedocs.io/projects/max7219/en/latest/> - DotStar <https://circuitpython.readthedocs.io/projects/dotstar/en/latest/> + Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/> + AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/> + Trellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/trellis/> + DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/> + MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/> + Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/> + Thermal Printer <https://circuitpython.readthedocs.io/projects/thermal_printer/> + VC0706 TTL Camera <https://circuitpython.readthedocs.io/projects/vc0706/> + INA219 High Side Current <https://circuitpython.readthedocs.io/projects/ina219/> + Fingerprint <https://circuitpython.readthedocs.io/projects/fingerprint/> |
