pyCRUMBS Documentation
Python library for I2C communication between Raspberry Pi and Arduino devices using the CRUMBS protocol.
Quick Start
git clone https://github.com/FEASTorg/pyCRUMBS.git
cd pyCRUMBS
chmod +x setup_pycrumbs.sh
./setup_pycrumbs.sh
Test: ~/activate_pycrumbs.sh then python -m pyCRUMBS.examples.leader_example
Documentation
- Getting Started - Installation and basic usage
- API Reference - Complete API documentation
- Protocol - Message format and encoding details
- Examples - Practical usage examples
- Setup - Installation guides
Quick Reference
Basic usage:
from pyCRUMBS import CRUMBS, CRUMBSMessage
crumbs = CRUMBS()
crumbs.begin()
# Send message
msg = CRUMBSMessage(typeID=1, commandType=1, data=[1.0, 2.0, 3.0, 4.0, 5.0, 6.0])
crumbs.send_message(msg, 0x08)
# Request response
response = crumbs.request_message(0x08)
crumbs.close()
Common issues:
- Permission errors →
sudo adduser $USER i2cand reboot - Import errors → Run from parent directory with
-m pyCRUMBS.examples.leader_example - No devices → Check wiring and run
i2cdetect -y 1