This project is an example of how to describe peripherals with an intermediary layer (YAML files) which can be used to generate library files for a peripheral.
It can also generate reference documentation for a periphreal, useful for embedding into datasheets.
This is not an official Google product.
Note: This project requires Python3.
s
pip install -r requirements.txt --user
python3 src/codegen.py -t templates/doc.md -o ./build -i peripherals/Mcp4725.yaml
-t- A template file. You can provide multiple template files.-i- A peripheral file. You can provide multiple input files.-o- The output directory where files will be generated.-d- Debug flag to print out additional information-c- Clean the output directory before generating files
rm -rf ./build
python3 src/validator.py -i peripherals/MCP9808.yaml
-i- A CyanoByte document. You can provide multiple input files.
The current spec is described in docs/cyanobyte.md. You can find all examples in the peripherals/ directory.
python3 -m pylint --rcfile=test/pylintrc src/*.py
python3 -m pylint --rcfile=test/pylintrc test/sampleData/*.py
python3 -m unittest test.test_codegen
The templates directory includes a set of canonical templates which can be used with this codegen tool.
The peripherals directory includes a set of peripheral description files that have been created along with
the project. It is not an exhaustive list.
See LICENSE