# roro9stack

A multi-app firmware for the **M5Stack Cardputer ADV** with the **Cap LoRa-1262**. It's a Meshtastic-compatible mesh messenger, plus Wi-Fi tools, IRC, GNSS and more. Licensed GPL-3.0.

- Domain language: [CONTEXT.md](CONTEXT.md)
- Decisions: [docs/adr/](docs/adr/)
- Milestones: [docs/milestones/](docs/milestones/)

## Requirements

Only **Docker** is needed. PlatformIO and the ESP32 toolchain run inside a container, and are cached in the `roro9stack-pio` Docker volume. The first build downloads about 1 GB and takes a few minutes.

## Build and test (local CI)

```sh
scripts/ci.sh
```

This runs the host-side unit tests (`test/`, `native` environment), then builds the firmware. The output is `.pio/build/cardputer-adv/firmware.factory.bin`.

## Flash

1. Connect the Cardputer by USB-C.
2. Run:

   ```sh
   scripts/flash.sh            # auto-detects the port; or: scripts/flash.sh /dev/ttyACM1
   ```

   This uploads the firmware, then opens the serial monitor. Quit the monitor with `Ctrl+C`.

**If the upload can't connect,** put the device in download mode: hold **G0** (the button next to the screen) while plugging in USB, or while pressing reset. Then retry.

**If you get "permission denied" on the port,** your user needs access to the serial device. Run this once, then log out and back in:

```sh
sudo usermod -aG dialout "$USER"
```