fwt_software/docs/configuration.md

Configuration & Commands

Behaviour is controlled by three layers: the config.ini file, command-line flags (which override the config), and interactive console commands typed while running.

Config file resolution

There are no hardcoded paths. The file is resolved in this order (src/core/Paths.cpp):

1. --config <path> CLI flag
2. $FGC_CONFIG environment variable
3. ./config.ini (current directory)
4. <executable dir>/config.ini
5. $XDG_CONFIG_HOME/fire_gimbal_control/config.ini (else ~/.config/...)

If none exist, the program prints every location it searched and exits. Start from the template:

cp config/config.example.ini config.ini

config.ini keys

Parsed and validated by ConfigLoader (src/core/Config.cpp) into a typed AppConfig. Invalid types/values fail fast with a clear message.

Section	Key	Type	Default	Meaning
General	tower_name	string	Unnamed	Tower identity; used in all MQTT topics/payloads
General	image_interval	int > 0	5	Seconds between captures (→ image_rate = 1/interval)
General	debug	bool	false	Start with debug-level logging
Network	zkms_server_ip	string	127.0.0.1	MQTT broker host/IP, or a full tcp://… URI
Network	mqtt_port	int 1..65535	1883	Broker port (8883 for TLS). Ignored when zkms_server_ip carries its own port or a scheme
Network	mqtt_user / mqtt_pw	string	—	MQTT credentials (see secrets below)
Serial	device	string	/dev/ttyACM0	Motor-controller serial device
Serial	baud	int	115200	Serial baud rate
Camera.<name>	id	string	—	USB DEV_ id or GigE IP. Required when enabled
Camera.<name>	driver	vimba	vimba	Backend. Only vimba is implemented
Camera.<name>	label	string	the block name	Output subdirectory and CamEvent cam field
Camera.<name>	profile_dir	string	—	Directory of profile XMLs; a profile named X is <profile_dir>/X.xml. A relative path resolves against the directory holding the config.ini in use
Camera.<name>	profile	string	standard	Profile to start in. Switch live with set camera profile [<camera>] <name>
Camera.<name>	enabled	bool	true	A disabled camera is not opened and does not affect the scan timing
Camera.<name>	rotation_deg	0/90/180/270	0	Clockwise rotation applied to that camera's saved images
Camera.<name>.<profile>	settle_wait_ms	int ≥ 0	1000	Hold after standstill before keeping a frame
Camera.<name>.<profile>	frame_timeout_ms	int ≥ 0	2000	Abandon the waypoint after this
Camera	jxl_distance / jxl_effort	double ≥ 0 / int 1..9	0.8 / 4	Encoder defaults inherited by every camera block
Camera.<name>	jxl_distance / jxl_effort	double ≥ 0 / int 1..9	the [Camera] value	Per-camera override of the encoder settings
Paths	output_dir	string	$XDG_DATA_HOME/fire_gimbal_control/images	Image output dir; supports ~/$ENV
Features	enable_mqtt	bool	true	Use MQTT (vs null channel)
Features	enable_camera	bool	true	(reserved)
Features	enable_serial	bool	true	(reserved)
Features	enable_imu	bool	false	Use the Xsens MTi orientation/IMU
Features	mock_camera	bool	false	Use the simulated camera
Features	mock_serial	bool	false	Use the simulated motor controller
Features	mock_imu	bool	false	Use the simulated IMU instead of the MTi
Features	enable_env	bool	false	Use the ambient temp/humidity sensor (SHT41)
Features	mock_env	bool	false	Use the simulated env sensor instead of the SHT41
IMU	device	string	—	MTi serial device (see [IMU] note); required when enable_imu
IMU	baud	int	115200	MTi serial baud rate
Env	i2c_device	string	/dev/i2c-1	SHT41 I2C bus device (see [Env] note); required when enable_env
Env	i2c_addr	int	68 (0x44)	SHT41 I2C slave address; decimal or 0x-prefixed hex
Env	period_ms	int	2000	Sample interval
Logging	level	enum	info	Linear log level (--log-level overrides)
Logging	trace	csv	—	Wire-trace categories, off by default (--trace overrides)
UI	enable_tui	bool	false	Full-screen terminal dashboard (--tui/--no-tui override; needs WITH_TUI=ON)
Motor	yaw_counts_per_deg / pitch_counts_per_deg	float	983.33 / —	Encoder counts per degree (calibrate; may be negative to flip)
Motor	yaw_zero_count / pitch_zero_count	int	500000 / 0	xenc value that = 0°
Motor	yaw_min_deg/yaw_max_deg/pitch_*	float	-90/90/…	Soft clamp on commanded degrees
Scan	grid_file	string	—	CSV of yaw_deg,pitch_deg waypoints; empty → generate
Scan	yaw_intervals	int	56	Generated yaw positions across [yaw_min_deg, yaw_max_deg]
Scan	yaw_min_deg/yaw_max_deg	float	-90/90	Generated yaw arc
Scan	pitch_levels	csv	0	Generated pitch elevations (deg)

[Motor] calibration & [Scan] grid

The firmware reports only encoder counts; [Motor] maps them to the heading/elevation degrees used by MQTT (target_HDG) and CamEvent. Calibrate *_counts_per_deg / *_zero_count against real xenc readings after homing (MOVE a known angle, read the resulting xenc), or run the automated IMU-referenced gimbal calib (below).

gimbal calib — automated IMU-referenced calibration

gimbal calib (requires the IMU) fits each axis's counts_per_deg / zero_count by sweeping it and correlating encoder counts with the MTi's measured angle. The sequence is deliberately ordered so the yaw fit is not spoiled by the IMU's heading drift (see the no-magnetometer discussion below):

1. Home if needed — if the gimbal is not already READY, it runs the endstop-finding home first.
2. Pitch at the first yaw position — yaw moves to the start of its travel and holds there while pitch is swept across its soft-limit travel; at each step it dwells and records the gravity-referenced IMU pitch (stable, absolute), then least-squares fits pitch.
3. Pitch → 0° — using the just-fitted pitch map.
4. Switch to a no-magnetometer XKF profile — picked from the device's own available-profiles list (a *nomag* profile, else a VRU one), so the IMU's heading stops chasing the stepper-distorted magnetic field. Sent in the MTi's Config state, so it persists on the device across power-cycles. Best-effort: if the device reports no magnetometer-free profile, this step is skipped (logged) and calibration continues.
5. Drift-correct + zero the heading — holding the gimbal still, it runs the MTi no-rotation gyro-bias update (cuts yaw drift), then a heading reset so the current pose becomes yaw 0. This happens right before the yaw sweep, so any drift accrued during the slow pitch sweep is discarded.
6. Yaw sweep — yaw is swept from that first (now zero-heading) position and fitted.

After calibration the IMU is left on the no-mag profile (this is intentional — the gimbal's homed encoders are the absolute heading reference; the IMU only needs stable roll/pitch and short-term yaw-rate). The i view's XKF profile row will show the new selection (press r to refresh if you changed it outside calibration).

Each axis fit reports an R² (shown in the gimbal g view + activity strip). The result is applied to the live session immediately; in the TUI the activity strip then offers to save it to [Motor] as the new default (y/n). gimbal stop cancels a run. Timings (dwell, no-rotation duration, etc.) are the CalibParams defaults in CalibrationRoutine.h.

The capture scan grid is the ordered (yaw,pitch) waypoints auto-sweep visits, always front to back. Set [Scan] grid_file to an editable CSV (config/scan.csv) to define exact coordinates, or leave it blank to generate yaw_intervals × pitch_levels points.

Each camera's output subfolder is its [Camera.<name>] label (defaulting to the block name); nothing is derived from the order of the blocks.

[IMU] — Xsens MTi orientation sensor

Enable with [Features] enable_imu = true and point [IMU] device at the MTi's serial node. On the LattePanda the MTi is wired to the RS-232 header, i.e. an onboard hardware UART — a stable /dev/ttyS* node (e.g. /dev/ttyS4), not a USB device and not /dev/ttyUSB0-3 (those are the modem). Find it with ls /dev/ttyS* / dmesg | grep -iE 'ttyS|LPSS', or probe for the 0xFA-framed stream. At startup the host reconfigures the MTi (GoToConfig → SetOutputMode → SetOutputSettings → GoToMeasurement) to a 100 Hz Euler + calibrated stream — so the device will start streaming even if it was left in Config state. Yaw is reported as a 0..360 heading (not the MTi's native −180..180). Set [Features] mock_imu = true to use a synthetic IMU on dev machines (no hardware). Protocol/units are documented in the modules reference (MtiProtocol).

During that same Config-state handshake the host also reads back the device configuration (ReqProductCode, ReqDID, ReqFWRev, ReqPeriod, ReqOutputMode, ReqOutputSettings, and the filter-profile / XKF profile via ReqFilterProfile + ReqAvailableFilterProfiles). The decoded values — product code, firmware, device ID, output mode/format, calibration channels, sample rate, and the list of supported Xsens Kalman Filter (XKF) profiles with the active one marked — are surfaced in the IMU CONFIG section of the expanded Sensors view (press i). This is read-only: it reports what the device is actually configured to do, which is the place to confirm the active XKF profile (e.g. General vs VRU_general) when diagnosing yaw drift. On the legacy MTi the same concept is called a "scenario" in the device manual (e.g. Machine_nomagfield); it is the same setting and shares the wire MIDs. Older MTi firmware that does not answer the Req* queries simply leaves the section absent (the host logs no configuration acks received).

The config is read once at startup and cached, so if you change the XKF profile externally the view stays stale until you refresh it: press r (or type refresh). That re-queries the device (briefly pausing the stream) and also requests a fresh firmware dump for the gimbal g view.

[Camera] — cameras and profiles

Each camera gets its own [Camera.<name>] block. Nothing is implied by position: the block names the camera, label names its output, and driver picks the backend. A camera's settings are not here at all.

The settings live in a profile XML exported from the VimbaX Viewer. A profile named X is <profile_dir>/X.xml, and the program hands that file straight to the Vimba X SDK. There is no other path by which settings reach the camera, and a missing XML is a startup error rather than a fallback.

That indirection exists because GenICam validity is stateful: AcquisitionFrameRate is only writable once AcquisitionFrameRateEnable is set, Width's maximum depends on binning, and IntensityAutoPrecedence accepts Minimizenoise but not MinimizeNoise. The Viewer greys out invalid combinations as you configure; a hand-written list has no such guardrail, and a line that silently fails leaves the camera on its previous value.

To change a camera's settings: open the Viewer, configure, save the settings XML over <profile>.xml, restart.

The .txt beside each XML is generated and configures nothing. It is a human-readable record of the same settings so a profile can be read and diffed without opening the Viewer. On startup the program hashes the XML and compares it with the hash recorded in the .txt; if they differ it regenerates the record and logs a warning naming every setting that moved:

[WARN ] camera 'rgb' profile 'standard': settings XML changed, regenerating standard.txt
[WARN ]   AcquisitionFrameRate  3.399707 -> 10
[WARN ]   ExposureAutoMax       50000 -> 15000

Timing is per camera and per profile, in [Camera.<name>.<profile>]. These are not camera settings — they are how long the program waits around them. With several cameras the scan uses the longest settle_wait_ms across the enabled ones, since the gimbal must stand still for all of them.

Every *.xml in profile_dir is loaded at start-up, so a profile nobody is using today still fails at launch rather than the first time someone switches to it.

[Env] — SHT41 ambient temperature/humidity sensor

Enable with [Features] enable_env = true and point [Env] i2c_device at the LattePanda's own native I2C bus — this is a separate physical link from the motor Leonardo's serial connection, not the Arduino's D2 pin (the original DHT11 plan). i2c_addr accepts either form — 0x44 hex or 68 decimal.

Finding the bus. The number varies by board, and on this LattePanda the sensor answers on /dev/i2c-2, not the /dev/i2c-1 default. Two traps make this harder than it looks:

• i2cdetect false-negatives on the SHT4x. Its probe (quick-write, or a plain read) is not a command the sensor answers, so the address can show empty on the very bus the sensor is on. Probe with a real measurement instead — i2ctransfer -y N w1@0x44 0xfd, wait ~10 ms, then i2ctransfer -y N r6@0x44; six bytes that pass the CRC is the bus.
• Not every /dev/i2c-* is a full I2C bus. An SMBus-only adapter (i2cdetect -F N reports I2C = no) cannot carry the SHT4x's transfers at all, so that bus can never work regardless of wiring.

A failed read is logged — once at the start of a failure streak (naming the bus, the address and an i2ctransfer probe to run), and again when the sensor recovers, so a wrong bus announces itself instead of leaving a silently empty panel, without reprinting the same line every period_ms for the life of the process. A sample that fails its CRC is logged separately each time. The backend (Sht41EnvSensor) polls at period_ms, discarding any sample that fails the SHT4x CRC-8 check (decode lives in the pure, unit-tested Sht41Protocol); once nothing valid arrives within 2× the period, sample() reports absence rather than a frozen value, which is what turns the panel from live to no fix. Set [Features] mock_env = true (or pass --mock-env, which also implies enable_env) to use a synthetic reading on dev machines with no hardware. The sensor sits behind the generic IEnvSensor interface (include/fgc/IEnvSensor.h), so swapping in a different ambient sensor later means adding a new backend, not touching Application, the UI, or MQTT.

Secrets

mqtt_user / mqtt_pw are read from the environment variables FGC_MQTT_USER / FGC_MQTT_PW first, falling back to the config file. Keep credentials out of config.ini (which is gitignored anyway) by exporting them or using a systemd EnvironmentFile.

Command-line flags

Parsed by Boost.Program_options (main.cpp). Flags override [Features].

Flag	Effect
-h, --help	Show help and exit
-c, --config <path>	Explicit config file path
-i, --init	Run the endstop-finding init sequence before the loop
-s, --start	Start capture automatically
-d, --demo	Demo mode: copy the placeholder image instead of encoding
--no-mqtt	Disable MQTT (use the null channel)
--mock-camera	Use the simulated camera
--mock-serial	Use the simulated motor controller
--mock-env	Use the simulated ambient temp/humidity sensor (implies [Features] enable_env)
--tui	Show the full-screen terminal dashboard (overrides [UI] enable_tui)
--no-tui	Force the headless line console (overrides config; wins over --tui)
--log-level <lvl>	trace/debug/info/warn/error/off
--trace <cats>	Verbatim wire trace; comma list serial,mqtt,camera,control,all,none

Typical headless dev run: scripts/run.sh --mock-serial --mock-camera --no-mqtt --start.

Init sequence (--init)

Sends ENABLE Y, ENABLE P, HOME, then polls telemetry until both axes report READY (firmware ST state A), bounded by the firmware's 60 s homing timeout, then sets SPEED Y/P (src/core/Application.cpp, runInitSequence).

Interactive console commands

Lines on stdin are parsed by parseCommand (src/core/CommandParser.cpp) — a whitespace tokenizer (<verb> [device] [option] [value]) that replaced the old fragile Boost.Spirit grammar. Handled in Application::Impl::handleCommand.

Type this	Meaning
start	Start camera acquisition + capture
stop	Stop acquisition
debug	Toggle debug logging
trace <cat> [on|off]	Toggle a wire-trace category (serial/mqtt/camera/control)
trace all / trace off	Enable every category / silence all
set camera profile [<camera>] <name>	Switch a camera to another profile from its profile_dir (the camera may be omitted when only one is configured)
set camera jxlq <v>	JPEG XL distance (0 = lossless)
set camera jxle <v>	JPEG XL effort
set camera display <0|1>	Toggle OpenCV preview window
set camera fps <v>	Camera acquisition frame rate (real camera only)
set fps <v>	Capture interval rate (images/second)
set motorctl <cmd>	Forward a raw command to the motor controller (e.g. set motorctl MOVE Y 20000)
test [<subsystem> [<leaf>]] [<profile>]	Run the hardware self-test suite (see below)
test list / test baseline	List profiles / pin the last report as the comparison baseline
imu status	One-line orientation + sample age
imu config	The configuration read back from the device (product, firmware, output mode, sample rate, XKF profile)
imu profile [<type|label>]	Show the available XKF profiles, or switch to one (by numeric type or by name, e.g. VRU_general)
imu zero	Heading reset — make the current yaw the zero reference
imu norotation [<seconds>]	Gyro-bias update; the sensor must be still for the whole window
refresh	Re-read the IMU configuration and request a fresh firmware dump
help [topic]	The command catalog, or one section/verb expanded
exit	Quit (Ctrl-D also works)

The full catalog with per-command detail lives in helpCatalog (src/core/HelpText.cpp) and is what help prints — the table above is a summary, and the gimbal … positioning/diagnostic verbs are documented there and in the motor vocabulary section below.

test — hardware self-test suite

test validates the gimbal/IMU/host on real hardware, writes a text report to logs/test_*.log, and compares each run to a pinned baseline and the previous run. It is modular (test gimbal, test imu drift, test host, …) and driven by profiles configured under [Test] / [TestProfile.<name>] in config.ini (repetition counts, sampling windows, pass thresholds; default standard). While a test (or calibration, or homing) runs, interfering commands are ignored and Esc cancels. Full reference: test-command.md. Replaces the former gimbal diag (now folded into test gimbal encoder).

Terminal dashboard (TUI)

An optional full-screen interface (--tui, or [UI] enable_tui = true) renders the tower status as sectioned, colored panels updated in place, with a scrolling log pane and a nano-style key bar. It is built on FTXUI (fetched via cmake/Ftxui.cmake when WITH_TUI=ON, the default) and is fully decoupled from application logic: the control loop publishes a plain UiSnapshot (include/fgc/ui/UiSnapshot.h) that the UI renders, and the UI forwards keystrokes/typed commands back through the same command queue the console uses. Headless operation is unchanged and remains the default — the same binary runs under systemd/ssh/pipes with logs on stdout.

Dashboard panels: Gimbal (per-axis state, heading, encoder counts, flag badges, target), Sensors (the Xsens MTi shows live roll/pitch/yaw once enable_imu; the ambient SHT41 shows live temp/humidity once enable_env. The SHT41's is the only temperature on the main window: the MTi's device-internal temp is diagnostic detail and appears solely in the expanded view), Camera (count, capture state, rate, last capture), Connectivity (MQTT state, broker, tower, control mode, target heading). Adding a panel later is a struct in UiSnapshot.h plus one node in src/ui/TuiUi.cpp.

Expanded takeover views replace the dashboard body full-screen (Esc or the same key closes):

• Gimbal (g) — both axes side by side: live telemetry, the decoded firmware register dump (d requests a fresh one), the homing limits, and the last calibration result (per-axis counts_per_deg / zero_count / R² / age).
• Cameras (c) — a block per configured camera: identity (name, label, id, driver, enabled), the active profile and the others available, the profile_dir and the exact XML applied, the per-profile settle_wait_ms, rotation_deg and the JPEG XL settings, plus live per-device telemetry (dimensions, streaming, frames, drops) and the scan grid.
• Connectivity (m) — broker, tower, client id, connection state and control mode, the delivery counters (sent / failed / connects / losses), and a history of the last MQTT messages — time, topic leaf and payload — so a publish can be confirmed without a broker-side subscriber. The compact Connectivity panel carries the m badge that opens it.
• Sensors (i) — both sensors, in headed sections so every reading is attributable. MTi: every channel with units — orientation (°), acceleration (m/s²), rate-of-turn (rad/s), magnetic field (a.u.), TEMP (internal), sample counter, plus an IMU CONFIG section (read back from the device at startup): product code, firmware, device ID, output mode/format, calibration channels, sample rate, and the Xsens Kalman Filter (XKF) profile list — every profile the device supports, by name, with the active one marked ● (selected). SHT41: TEMP (ambient), humidity, the age of the last sample, and the configured I2C bus (device, address, poll period — hidden for the mock). Empty states name what to enable (enable_env / --mock-env) or, when enabled but silent, the staleness window that was missed.

Activity strip — a compact section between the log and the key bar that shows the currently-running special operation with live progress (test, gimbal calib, homing, capture scan) and persists the last test/calibration result (PASS/FAIL, age) so it doesn't scroll away in the log. It only appears once something has run. While a procedure is running, Esc cancels it.

When a gimbal calib completes it is applied to the live session and the strip shows a highlighted yes/no prompt — Save this calibration to config as the new default? (y / n). Press y to write the full [Motor] per-axis map — *_counts_per_deg, *_zero_count, and *_min_deg/*_max_deg — back into the config.ini the program was launched with (replacing those keys in place, preserving everything else) so it persists across restarts; press n to keep it for this session only. The keys are active only while the prompt is showing. (Until you answer y, calibration remains session-only — see known-issues.md.)

The key bar is contextual: it advertises the keys that are useful in the current view, not every binding. s start and x stop lead everywhere — a scan can be started and stopped from any view — and : command, ? help and q quit close every set. The overview adds h home, r refresh, g i c m views, p pause and the arrow keys (nudge the gimbal, yaw ±5 % / pitch ±10 %); an expanded view instead offers its own (d dump in the gimbal view, r refresh in sensors, the scroll keys, Esc close). Every binding still works everywhere; only the advertising changes. p freezes the live refresh so text can be selected and copied.

q asks rather than quitting. It opens a prompt: q quit (stop capture, close the camera, end the program), b background (detach and leave it running — the same as Ctrl-b d, shown dimmed and unavailable when the program is not inside a scripts/fgc tmux session), Esc cancel. Plain letters are used rather than Ctrl chords so terminal flow-control (Ctrl-S/Ctrl-Q XON/XOFF) can't swallow them. In TUI mode all log output is diverted from stdout into the on-screen log pane via a Logger sink, so the screen is never corrupted.

Build without it (-DWITH_TUI=OFF) for a smaller, dependency-free binary; --tui then warns and runs headless.

Logging: level vs. wire-trace categories

Two independent controls, each settable via config ([Logging]), CLI, and a console command:

• Linear level — [Logging] level, --log-level, console debug. Filters ordinary messages (trace<debug<info<warn<error<off). Default info; an active capture is nearly silent at info.
• Wire-trace categories — [Logging] trace, --trace, console trace. Each enabled category (serial, mqtt, camera, control) logs every message exchanged with that subsystem, verbatim. They are off by default and independent of the level: --trace serial prints all firmware serial traffic even at info. Only level off silences them. The camera category is high-rate (one line per frame, metadata only — no pixel data).

Precedence at startup: config applies first, then CLI overrides (--trace replaces the config set, it does not merge). At runtime the trace console command edits categories incrementally.

Trace lines carry a category tag and a TX/RX direction so one subsystem is easy to follow/grep:

[SERIAL]  TX MOVE -90,0                     (command to firmware: yaw,pitch counts)
[SERIAL]  RX ST Y:A,982,969,80084000,0,8,8,Se P:A,...  (status from firmware)
[MQTT]    PUB GGS/FWT/Tower/StatusCode 0   /   [MQTT] RX GGS/FWT/Tower/target_HDG 180
[CAMERA]  TX trigger cam0                  /   [CAMERA] RX frame cam0 1936x1216 7064576B
[CONTROL] sweep -> grid yaw=-90 pitch=0    (scheduler decisions + inbound console commands)

Motor command vocabulary (emitted by the software)

The firmware speaks full-word, newline-terminated commands in absolute encoder counts (see ../firmware/docs/protocol.md). The host converts degrees↔counts via the [Motor] calibration.

Command	When	Meaning
ENABLE Y / ENABLE P	init	energize the axis coils
HOME	init	home all axes (firmware runs it non-blocking; watch ST state R→H→A)
SPEED Y|P <vel>	init	set the production move speed (VMAX, counts/s)
MOVE <yaw>,<pitch>	each capture point	drive both axes to absolute counts (combined form)
MOVE Y|P <pos>	—	single-axis absolute move (set motorctl)
STOP Y|P|ALL	—	ramp to a controlled stop

Capture is a move → settle → trigger cycle: the scheduler issues a MOVE, waits until both axes report standstill at the target, then triggers the cameras. ControlCode 0 walks the scan grid (front to back, repeating); ControlCode 1 drives yaw to target_HDG (pitch held). Telemetry arrives as firmware ST lines (per-axis state + encoder counts), parsed by TelemetryParser.