From 298cb131149f583ab986ee69901765c3dbcce674 Mon Sep 17 00:00:00 2001 From: xengineering Date: Fri, 14 Feb 2025 08:37:08 +0100 Subject: Switch to a global CMake build This allows to easily build everything from the repository root. For now this only covers firmware but later electrical PCB and mechanical case files can be added. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 72b2b57..c2db017 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,31 @@ iot-contact is an IoT device to check if doors and windows are closed or open. +## Usage + +The content of this repository can be build with CMake and Ninja. + +``` +cmake -Bbuild -GNinja +ninja -C build +``` + +The resulting firmware can be flashed via an ST-LINK debugger / programmer. + +``` +st-flash --connect-under-reset write build/fw/zephyr/zephyr.bin 0x8000000 +``` + +UART shell output can be retrieved with `picocom`. + +``` +picocom -b 115200 /dev/ttyACM0 +``` + +Finally the firmware can be erased from the device with the ST-LINK. + +``` +st-flash --connect-under-reset erase +``` + [1]: https://docs.kicad.org/ -- cgit v1.2.3-70-g09d2