CircuitPython帮助程序库,用于与Roomba开放接口设备进行接口。
circuitroomba的Python项目详细描述
依赖关系
此驱动程序取决于:
请确保circuitpython文件系统上的所有依赖项都可用。 这很容易通过下载来实现 the Adafruit library and driver bundle。
从PYPI为Blinka板安装
pip install circuitroomba
在当前项目的虚拟环境中安装:
mkdir project-name &&cd project-name python3 -m venv .env source .env/bin/activate pip install circuitroomba
对于不支持blinka
的电路python板,将/circuitroomba
从/src
复制到
/lib
在circuitpython板上。make install
已设置为帮助程序,但您可能需要
更新系统和板名的/Volume
路径。
make install
用法示例
importboardimportdigitalioimporttimefromcircuitroomba.series6importroomba__repo__="https://github.com/AlexanderHagerman/circuitroomba.git"# initialize roombabot=roomba.Commands(board.TX,board.RX,digitalio.DigitalInOut(board.A1))# wake roomba from sleep modebot.wake_up()# CircuitPython loopwhileTrue:# send commandsbot.start()bot.safe()bot.clean()time.sleep(2)bot.power()bot.stop()break
更多示例可在/examples
中找到。
贡献
欢迎投稿!请阅读我们的Code of Conduct 在帮助这个项目保持热情之前。
斯芬克斯文件
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)错误的任何警告,像特拉维斯将。这是个很好的方法
本地验证它将通过。