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.21.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_bitbangio-1.3.21.tar.gz
Algorithm Hash digest
SHA256 381ae69349f20524cf06039c57200c6b108b48c6200f8e4d30afba45273a21d7
MD5 fe14d889c6efd706e7dfa7ba68a9f29e
BLAKE2b-256 d2d077d12c491ff2ed22a80ec46af8e505ba40dc44a3cccd2b2e683591ee8765

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_bitbangio-1.3.21-py3-none-any.whl
Algorithm Hash digest
SHA256 863af051ad0f1c84d21a73d5bd3fb6d153f1ce2f3fcbf705a8d1de61434bb87a
MD5 c23945c43c0a05fa88bad29d00b8488f
BLAKE2b-256 a18d60995d1bce5f5474a9a3f6cd7f855d6f01fde5514b0d28b6df9b23458834

See more details on using hashes here.

Supported by

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