summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--firmware/README.md39
1 files changed, 39 insertions, 0 deletions
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