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.20.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.20.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_bitbangio-1.3.20.tar.gz
Algorithm Hash digest
SHA256 5c0ed54868368e4b626e708afd8cc41d92d7fddc33446da287ae161358a84d85
MD5 56e64ec60e22e5316fd3c9648bd3729f
BLAKE2b-256 cde0e07b7de917cba03583906ae15ce5da8ca6943f0ce027d12f219e8a80d2f1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_bitbangio-1.3.20-py3-none-any.whl
Algorithm Hash digest
SHA256 170cf3ba05cc453003684effee57f680426aeb776fabea480da48d971e8dfd95
MD5 5787909051bbcc61876031570a22f650
BLAKE2b-256 07ff639343a4ac4c8a39b130366a91fdd557431f3a8f25c0160c16a5bb19ba45

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