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: Black

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

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-bitbangio-1.3.8.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-bitbangio-1.3.8.tar.gz
Algorithm Hash digest
SHA256 a1eb8d96d81a2a8d46865832fc2f8d5b6e2134f7886e82efd67edb046bbf991b
MD5 18c4cf44d961a98de19fba051e851ea0
BLAKE2b-256 225eab5e9d7a3bb1a36d2230ef96af46f8bb16e8217fb18a5ef30f97507f7bfe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_bitbangio-1.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d15078b348d3f0e0b4df0dca907e5f4651090ae91bfa8a84ffb45ed9fb962227
MD5 e9464fe2c0de32312cedc1e01116a3b5
BLAKE2b-256 8bfde4bdedd7fdff5752622c1f49dc896954b01617ff8404dccb6c30e6075ce2

See more details on using hashes here.

Supported by

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