Skip to content

Commit ae9d4c5

Browse files
committed
Add documentation for configuration commands
1 parent 279ecb0 commit ae9d4c5

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,11 @@ $cloud_meta,<vdd>,<ta>
8585
- `vdd` - Sensor supply voltage
8686
- `ta` - Ambient temperature from thermal sensor
8787

88-
### Optional Commands
88+
### Serial Commands
8989

90-
Send via serial to enable/disable thermal map streaming:
90+
Send commands via serial (115200 baud) to configure the device:
91+
92+
**Thermal Map:**
9193
- `thrmap_on` - Enable full 16×12 thermal map output
9294
- `thrmap_off` - Disable thermal map output
9395

@@ -97,6 +99,19 @@ $thrmap,<pixel0>,<pixel1>,...,<pixel191>
9799
```
98100
192 temperature values in °C (16×12 array)
99101

102+
**Configuration (requires config.h integration in firmware):**
103+
- `config_show` - Display current configuration
104+
- `config_save` - Save current configuration to EEPROM
105+
- `config_reset` - Reset configuration to defaults
106+
- `set sqm_offset <value>` - Set SQM calibration offset
107+
- `set sqm_multiplier <value>` - Set SQM multiplier
108+
- `set alert_enabled <0|1>` - Enable/disable alert output
109+
- `set alert_cloud_temp <value>` - Set cloud temperature threshold (°C)
110+
- `set alert_cloud_below <0|1>` - Alert when temp < threshold (1) or > threshold (0)
111+
- `set alert_light_lux <value>` - Set light threshold (lux)
112+
- `set alert_light_above <0|1>` - Alert when lux > threshold (1) or < threshold (0)
113+
- `set device_label <text>` - Set custom device label
114+
100115
## Firmware
101116

102117
Pre-built firmware binaries are available:

0 commit comments

Comments
 (0)