From 2c05c08f24b74a0a538a8b742fd58d4b7785052c Mon Sep 17 00:00:00 2001 From: pgdalmeida Date: Tue, 30 Jun 2026 11:48:01 +0200 Subject: [PATCH] docummentation cleanup --- README.md | 5 ++--- docs/deployment.md | 4 ++-- docs/mqtt-api.md | 8 ++++---- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 06dafa6..d2a04fd 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ -# Fire Gimbal Control (Staeffelsberg) +# Fire Gimbal Control Real-time control software for an automated **fire-watch gimbal**. A C++17 program runs on a tower-mounted PC, rotates a pan gimbal carrying up to four industrial cameras, captures a 360° panorama for wildfire detection, compresses each frame to JPEG XL, and reports to a ground station over MQTT. -This is the deployment for the **Staeffelsberg** fire-watch tower (FWT). The same codebase serves all towers; -the tower identity comes from `config.ini`. +A single codebase serves all fire-watch towers (FWT); the tower identity comes from `config.ini`. The code is organized around an **SDK-independent core** (`fgc_core`: config, logging, capture scheduler, parsers) and **swappable I/O implementations** behind three interfaces — motor controller, control channel, diff --git a/docs/deployment.md b/docs/deployment.md index 6543724..120e043 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -80,7 +80,7 @@ Set at least: ```ini [General] -tower_name = Staeffelsberg ; this tower's name (drives all MQTT topics) +tower_name = ExampleTower ; this tower's name (drives all MQTT topics) image_interval = 3 [Network] @@ -173,7 +173,7 @@ Confirm end to end: - Images accumulating under the configured `[Paths] output_dir` (default `~ggs/.local/share/fire_gimbal_control/images/RGB/`). - CamEvents on the broker: - `mosquitto_sub -h -t 'GGS/FWT/Staeffelsberg/#' -v`. + `mosquitto_sub -h -t 'GGS/FWT//#' -v`. ## 9. Update / redeploy diff --git a/docs/mqtt-api.md b/docs/mqtt-api.md index fcb9425..0b89a2e 100644 --- a/docs/mqtt-api.md +++ b/docs/mqtt-api.md @@ -58,7 +58,7 @@ When a ControlCode message arrives, the program echoes the current code back on Built by `MqttControlChannel::publishCamEvent` from a `CamEvent`: ```json -{ "fwt":"Staeffelsberg", "cam":"RGB", "hdg":1373, "pit":300, "time":1719312345678 } +{ "fwt":"ExampleTower", "cam":"RGB", "hdg":1373, "pit":300, "time":1719312345678 } ``` | Field | Type | Meaning | @@ -87,7 +87,7 @@ publish: GGS/FWT//StatusCode (echoed control code) Point `zkms_server_ip` at a local broker and exercise the topics with Mosquitto: ```bash -mosquitto_sub -t 'GGS/FWT/Staeffelsberg/#' -v # watch everything for the tower -mosquitto_pub -t 'GGS/FWT/Staeffelsberg/ControlCode' -m '0' -mosquitto_pub -t 'GGS/FWT/Staeffelsberg/target_HDG' -m '180' +mosquitto_sub -t 'GGS/FWT/ExampleTower/#' -v # watch everything for the tower +mosquitto_pub -t 'GGS/FWT/ExampleTower/ControlCode' -m '0' +mosquitto_pub -t 'GGS/FWT/ExampleTower/target_HDG' -m '180' ```