Adafruit CircuitPython Library Bundle¶
This repo bundles a bunch of useful CircuitPython libraries into an easy to download zip file. CircuitPython boards can ship with the contents of the zip to make it easy to provide a lot of libraries by default.
Use¶
To use the bundle download the zip (not source zip) from the
latest release,
unzip it and copy over the subfolders, such as lib
, into the root of your
CircuitPython device. Make sure to indicate that it should be merged with the
existing folder when it exists.
CPython¶
DO NOT use this to install libraries on a Linux computer, such as the Raspberry Pi,
with regular Python (aka CPython). Instead, use the python3 version of pip
to install
the libraries you want to use. It will automatically install dependencies for you. For example:
pip3 install adafruit-circuitpython-lis3dh
Development¶
After you clone this repository you must run git submodule init
and then git submodule update
.
Updating libraries¶
To update the libraries run update-submodules.sh
. The script will fetch the
latest code and update to the newest tag (not master).
To find libraries with commits that haven’t been included in a release do:
git submodule foreach "git log --oneline HEAD...origin/master"
Adding a library¶
Determine the best location within libraries
(libraries/drivers/
or
libraries/helpers/
)for the new library and then run:
git submodule add <git url> libraries/<target directory>
The target directory should omit any CircuitPython specific prefixes such as
adafruit-circuitpython
to simplify the listing.
Removing a library¶
Only do this if you are replacing the module with an equivalent:
git submodule deinit libraries/<target directory>
git rm libraries/<target directory>
Building the bundle¶
To build this bundle locally you’ll need to install the circuitpython-build-tools package.
python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
source .env/bin/activate
Then run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-bundle --library_location libraries --library_depth 2
Table of Contents¶
- Adafruit Sponsored Libraries and Drivers on GitHub
- Foundational
- Board-specific Helpers
- Helper Libraries
- Blinky
- Displays
- Real-time clocks
- Motion Sensors
- ADXL34x 3 Axis Accelerometer
- BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation
- FXAS21002C Gyroscope
- FXOS8700 Accelerometer
- GPS Global Position
- L3GD20 3-Axis Gyroscope
- LIS3DH Accelerometer
- LSM303 Accelerometer and Magnetometer
- LSM303 Accelerometer Only
- LSM303AGR Magnetometer Only
- LSM303DLH Magnetometer Only
- LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature
- LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature
- MLX90390 3 Axis Magnetometer
- MMA8451 3 Axis Accelerometer
- MPU6050 Accelerometer, Gyroscope, and Temperature Sensor
- MSA301 3 Axis Accelerometer
- TLV493D 3 Axis Magnetometer
- Environmental Sensors
- AM2320 Temperature and Humidity
- ADT7410 High Accuracy Temperature Sensor
- BME280 Temperature, Humidity and Pressure
- BME680 Temperature, Humidity, Pressure and Gas
- BMP280 Barometric Pressure and Altitude
- BMP3xx Barometric Pressure and Altimeter
- CCS811 Air Quality
- DHT Temperature and Humidity
- DS18x20 Temperature
- HTU21D Temperature and Humidity
- LPS35HW Water Resistant Barometric Pressure, Temperature
- MAX31855 Thermocouple Amplifier, Temperature
- MAX31856 Thermocouple Amplifier, Temperature
- MAX31865 Thermocouple Amplifier, Temperature
- MCP9600 Thermocouple Amplifier
- MCP9808 Temperature
- MLX90614 Contactless Temperature
- MP115A2 Barometric Pressure, Temperature
- MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor
- MPRLS Ported Absolute Pressure
- PCT2075 Temperature Sensor
- SGP30 Air Quality
- SHT31-D Temperature and Humidity
- Si7021 Temperature and Humidity
- Thermistor Temperature
- TMP006 Contactless IR Thermopile Sensor
- TMP007 Contactless Temperature
- Light Sensors
- Distance Sensors
- Radio
- IO Expansion
- Adafruit SeeSaw
- ADS1x15 Analog-to-Digital Converter
- Crickit Robotics Boards
- DS2413 OneWire GPIO Expander
- FocalTech Capacitive Touch
- MCP230xx GPIO Expander
- MCP3xxx SPI ADC
- MCP4725 Digital-to-Analog Converter
- MPR121 Capacitive Touch Sensor
- PCA9685 16 x 12-bit PWM Driver
- TCA9548 I2C Multiplexer
- TLC5947 24 x 12-bit PWM Driver
- TLC59711 12 x 16-bit PWM Driver
- Miscellaneous
- 74HC595 Shift Register
- ATECCx08 Cryptographic Co-Processor
- AMG88xx Grid-Eye IR Camera
- BD3491FS Audio Processor
- CAP1188 8-Key Capacitive Touch
- DRV2605 Haptic Motor Controller
- DS3502 I2C Potentiometer
- Fingerprint Sensor
- FRAM Non-Volatile Memory
- Gizmo
- INA219 High Side Current
- INA260 Current and Power Monitor
- Matrix Keypad
- MAX9744 Audio Amplifier
- NeoTrellis 4x4 Keypad
- NeoTrellis M4 4x8 Keypad
- PyPixelbuf
- Si4713 Stereo FM Transmitter
- Si5351 Clock Generator
- STMPE610 Resistive Touchscreen
- Thermal Printer
- Touchscreen 4-Wire Resistive
- TPA2016 Audio Amplifier with AGC
- Trellis 4x4 Keypad
- VC0706 TTL Camera
- VS1053 Audio Codec
- Dymo Scale
- Nunchuk