用于 Sparkfun Qwiic Twist 旋转编码器的 CircuitPython
项目描述
介绍
用于 Sparkfun Qwiic Twist RGB 旋转编码器的 CircuitPython 库。该库移植自 SparkFun Qwiic Twist Arduino 库
依赖项
此驱动程序取决于:
请确保 CircuitPython 文件系统上的所有依赖项都可用。这可以通过下载 Adafruit 库和驱动程序包轻松实现。
树莓派设置
快速入门总结:
从配置了 Wifi 的最新版本的 Raspbian 开始。
启用 SSH、I2C 和 SPI。
sudo raspi-config
将您的系统更新到最新版本。
sudo apt-get update
sudo apt-get upgrade
更新 python 工具
sudo pip3 install --upgrade setuptools
(如果没有安装pip3,安装后重新运行命令)
sudo apt-get install python3-pip
安装 CircuitPython 库
pip3 install RPI.GPIO
pip3 install adafruit-blinka
从 PyPI 安装
在 Raspberry Pi 等受支持的 GNU/Linux 系统上,您可以从 PyPI本地安装驱动程序。
安装此库还将安装依赖项 adafruit-circuitpython-busdevice。
从 PyPI 安装
pip3 install sparkfun-circuitpython-qwiictwist
要在系统范围内安装(在某些情况下可能需要这样做):
sudo pip3 install sparkfun-circuitpython-qwiictwist
要在当前项目的虚拟环境中安装:
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install sparkfun-circuitpython-qwiictwist
使用示例
Qwiic Twist Hookup Guide - 连接指南中的 Arduino 示例可用于 Python 与此库
Raspberry Pi 上的 CircuitPython - 有关如何在 Raspberry Pi 上安装 CircuitPython 的基本信息。
代码示例:
# import the CircuitPython board and busio libraries import board import busio # Create bus object using the board's I2C port i2c = busio.I2C(board.SCL, board.SDA) twist = QwiicTwist(i2c) # default address is 0x3F # For a different address use QwiicTwist(i2c, address) # twist = QwiicTwist(i2c, 0x3E)
贡献
欢迎投稿! 在帮助这个项目保持受欢迎之前,请阅读我们的行为准则。
本地建设
压缩发布文件
要在本地构建这个库,你需要安装 circuitpython-build-tools包。
python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools
安装后,请确保您处于虚拟环境中:
source .env/bin/activate
然后运行构建:
circuitpython-build-bundles --filename_prefix sparkfun-circuitpython-qwiictwist --library_location .
狮身人面像文档
Sphinx 用于基于 rST 文件和代码中的注释构建文档。首先,安装依赖项(随意重用上面的虚拟环境):
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme
现在,一旦您激活了虚拟环境:
cd docs
sphinx-build -E -W -b html . _build/html
这会将文档输出到docs/_build/html。在浏览器中打开 index.html 以查看它们。它也会(由于 -W)像 Travis 那样在任何警告上出错。这是在本地验证它是否会通过的好方法。
许可证信息
本产品是开源的!
请查看 LICENSE.md 文件以获取许可证信息。
请按您认为合适的方式使用、重用和修改这些文件。
请保持对 SparkFun Electronics 和 Adafruit 的归属,并在同一许可下发布任何衍生产品。
按原样分发;不提供任何保证。