diff options
| author | xengineering <me@xengineering.eu> | 2025-01-20 21:22:55 +0100 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2025-01-20 21:22:55 +0100 |
| commit | d732a84ababe382f066c613c85142b8403c9e423 (patch) | |
| tree | bf78a8053bad21d3106c1f89df950bbb6f80507e | |
| parent | ae05f289a11af5b865431c9c8b21592f8880e736 (diff) | |
| download | soundbox-d732a84ababe382f066c613c85142b8403c9e423.tar soundbox-d732a84ababe382f066c613c85142b8403c9e423.tar.zst soundbox-d732a84ababe382f066c613c85142b8403c9e423.zip | |
fw: Add README.md
| -rw-r--r-- | fw/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/fw/README.md b/fw/README.md new file mode 100644 index 0000000..f58008f --- /dev/null +++ b/fw/README.md @@ -0,0 +1,33 @@ +# soundbox firmware + +This is the firmware for soundbox. It is based on the Zephyr real time +operating system [1]. + +## Setup Python environment + +``` +python -m venv zephyrproject/.venv +source zephyrproject/.venv/bin/activate +pip install -r zephyrproject/requirements.txt +``` + +## Build + +``` +cmake -Bbuild -GNinja +ninja -C build +``` + +## Flash + +``` +esptool.py --chip auto write_flash 0x1000 build/zephyr/zephyr.bin +``` + +## Get shell output + +``` +picocom -b 115200 /dev/ttyUSB0 +``` + +[1]: https://zephyrproject.org |