Skip to main content

A library for adding bitbang I2C and SPI to CircuitPython without the built-in bitbangio module

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

A library for adding bitbang I2C and SPI to CircuitPython without the built-in bitbangio module. The interface is intended to be the same as bitbangio and therefore there is no bit order or chip select functionality. If your board supports bitbangio, it is recommended to use that instead as the timing should be more reliable.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-bitbangio

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-bitbangio

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-bitbangio

Usage Example

"""
This example is for demonstrating how to retrieving the
board ID from a BME280, which is stored in register 0xD0.
It should return a result of [96]
"""

import board
import digitalio
import adafruit_bitbangio as bitbangio

# Change these to the actual connections
SCLK_PIN = board.D6
MOSI_PIN = board.D17
MISO_PIN = board.D18
CS_PIN = board.D5

cs = digitalio.DigitalInOut(CS_PIN)
cs.switch_to_output(value=True)

spi = bitbangio.SPI(SCLK_PIN, MOSI=MOSI_PIN, MISO=MISO_PIN)
cs.value = 0
while not spi.try_lock():
    pass
spi.write([0xD0])
data = [0x00]
spi.readinto(data)
spi.unlock()
cs.value = 1
print("Result is {}".format(data))

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_bitbangio-1.3.19.tar.gz (34.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_bitbangio-1.3.19.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_bitbangio-1.3.19.tar.gz
Algorithm Hash digest
SHA256 e0c3854563c9673ce5d7f28509c71ddc0d3086cfe83761e24ac06a5a93354213
MD5 a765087f8563f9e49bd8cde534c1d54f
BLAKE2b-256 f6e4b0d1a8e25baa55bdbdeaa78776583685d7678003f5d00b7af4a7800eb091

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_bitbangio-1.3.19-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_bitbangio-1.3.19-py3-none-any.whl
Algorithm Hash digest
SHA256 320d3ec3e90cc4d5c8ef1b3671b1519dcaf0c98b800211c6d97286eeed9e21a3
MD5 c4489f6bb8e0dba7f1001617408755ec
BLAKE2b-256 f1b26b1e7283f278e6afc0bc5c3942c951938007062e6481c30920401f88c7bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page