外设代码生成

该项目是使用中间层（YAML文件）描述外设的示例，可用于为外设生成库文件。

它还可以为外设生成参考文档，这对于嵌入到数据表中很有用。

该工具对I2C设备效果良好，而SPI支持目前处于alpha阶段。

这不是一个官方的Google产品。

设置

注意：此项目需要Python3。您可以使用pip进行安装

pip安装cyanobyte

运行Codegen

cyanobyte-codegen -t templates/doc.md -o ./build/peripherals/MCP4725.yaml

选项

• -t - 模板文件。您可以提供多个模板文件。
• -o - 文件生成的输出目录。
• -e - 存储浮雕文件夹的目录。
• -d - 调试标志，用于打印附加信息。
• -c - 在生成文件之前清理输出目录。

可以传递一个或多个文件作为参数。

清理

rm -rf ./build

运行验证器

cyanobyte-validator peripherals/MCP9808.yaml

可以传递一个或多个文件作为参数。

外围YAML文件

当前规范在docs/cyanobyte.md中描述。您可以在peripherals/目录中找到所有示例。

测试

代码风格检查

python3 -m pylint --rcfile=test/pylintrc cyanobyte/*.py
python3 -m pylint --rcfile=test/pylintrc test/sampleData/*.py

单元测试

python3 -m unittest test.test_codegen

模板

模板目录包含一组标准模板，可用于与此codegen工具一起使用。

外围设备目录包含一组与项目一起创建的外围设备描述文件。这不是一个详尽的列表。

开发设置

pip install -r requirements.txt --user

对于更高级的开发，也可以安装dev列表。pip install -r requirements-dev.txt --user

贡献者

欢迎贡献！有关更多信息，请参阅CONTRIBUTING.md。

在提交拉取请求时，会运行持续集成任务。必须在补丁合并之前成功完成CI任务。您可以在cloudbuild.yaml中查看运行的具体规则。

许可证

查看LICENSE