summaryrefslogtreecommitdiff
path: root/fw/README.md
diff options
context:
space:
mode:
authorxengineering <me@xengineering.eu>2025-02-11 06:58:50 +0100
committerxengineering <me@xengineering.eu>2025-02-11 06:58:50 +0100
commit304e1e443dc1283efbd1fe8b4a72c13f6cfc2fe4 (patch)
treed116911b7876abc796eee4ae649c3d6749c525c5 /fw/README.md
parent2c18a99bd24ddadd165eeabe5299ac094b0c0ee3 (diff)
downloadiot-contact-304e1e443dc1283efbd1fe8b4a72c13f6cfc2fe4.tar
iot-contact-304e1e443dc1283efbd1fe8b4a72c13f6cfc2fe4.tar.zst
iot-contact-304e1e443dc1283efbd1fe8b4a72c13f6cfc2fe4.zip
fw: Move content of `firmware` here
This makes the name shorter which is especially relevant for Git commit messages.
Diffstat (limited to 'fw/README.md')
-rw-r--r--fw/README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/fw/README.md b/fw/README.md
new file mode 100644
index 0000000..b0d2c46
--- /dev/null
+++ b/fw/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