diff options
| author | xengineering <me@xengineering.eu> | 2025-01-22 21:01:34 +0100 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2025-01-22 21:04:29 +0100 |
| commit | 7f3bd969c7ec40bb24576c753aa490c3dd5b9c32 (patch) | |
| tree | a5e0d498f751632ac7b9faaf99a0882413fa9666 /fw/README.md | |
| parent | 2d52623327c1218c34d61a24580093475ffc416a (diff) | |
| download | soundbox-7f3bd969c7ec40bb24576c753aa490c3dd5b9c32.tar soundbox-7f3bd969c7ec40bb24576c753aa490c3dd5b9c32.tar.zst soundbox-7f3bd969c7ec40bb24576c753aa490c3dd5b9c32.zip | |
fw: Extend usage instructions in README.md
Diffstat (limited to 'fw/README.md')
| -rw-r--r-- | fw/README.md | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/fw/README.md b/fw/README.md index f58008f..a940651 100644 --- a/fw/README.md +++ b/fw/README.md @@ -3,6 +3,13 @@ This is the firmware for soundbox. It is based on the Zephyr real time operating system [1]. +## Get all source files + +``` +git submodule update --init +./update_espressif_blobs.py # proprietary binary blobs +``` + ## Setup Python environment ``` @@ -24,10 +31,30 @@ ninja -C build esptool.py --chip auto write_flash 0x1000 build/zephyr/zephyr.bin ``` -## Get shell output +## Connect to shell ``` picocom -b 115200 /dev/ttyUSB0 ``` +## Scan for WLAN networks + +``` +wifi scan +``` + +## Connect to WLAN network + +This uses WPA2-PSK (`-k 1`). See `wifi connect help` for other options. + +``` +wifi connect -s <ssid> -p <passphrase> -k 1 +``` + +## Validate network connection + +``` +net ping 8.8.8.8 # Google DNS server +``` + [1]: https://zephyrproject.org |