From 0ff8c7370ad87ac450b32955210a1ec366413d61 Mon Sep 17 00:00:00 2001 From: xengineering Date: Thu, 29 Aug 2024 17:56:25 +0200 Subject: firmware: Add minimal README This adds instructions for: - Python environment setup - building the firmware - flashing the firmware - get output from the Zephyr shell - removing the firmware from the device --- firmware/README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 firmware/README.md diff --git a/firmware/README.md b/firmware/README.md new file mode 100644 index 0000000..b0d2c46 --- /dev/null +++ b/firmware/README.md @@ -0,0 +1,39 @@ +# iot-contact Firmware + +This is the firmware for iot-contact. 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 + +``` +st-flash --connect-under-reset write build/zephyr/zephyr.bin 0x8000000 +``` + +## Get shell output + +``` +picocom -b 115200 /dev/ttyACM0 +``` + +## Remove firmware from device + +``` +st-flash --connect-under-reset erase +``` + +[1]: https://zephyrproject.org -- cgit v1.2.3-70-g09d2