Skip to content

Commit bba29a9

Browse files
committed
Update README with implemented configuration system details
1 parent ca3a4a9 commit bba29a9

File tree

1 file changed

+30
-9
lines changed

1 file changed

+30
-9
lines changed

README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,18 +99,39 @@ $thrmap,<pixel0>,<pixel1>,...,<pixel191>
9999
```
100100
192 temperature values in °C (16×12 array)
101101

102-
**Configuration (requires config.h integration in firmware):**
102+
**Configuration:**
103+
104+
Configuration is stored persistently in EEPROM and survives power cycles.
105+
103106
- `config_show` - Display current configuration
104107
- `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)
108+
- `config_reset` - Reset configuration to factory defaults
109+
110+
**SQM Calibration:**
111+
- `set sqm_offset <value>` - Set SQM calibration offset (default: 8.5265)
112+
- `set sqm_multiplier <value>` - Set SQM multiplier (default: -2.5)
113+
114+
**Alert Configuration:**
115+
116+
The device has a hardware alert output (GPIO 27) that can trigger on cloud detection and/or light levels.
117+
118+
- `set alert_enabled <0|1>` - Enable (1) or disable (0) alert output
119+
- `set alert_cloud_temp <value>` - Cloud temperature threshold in °C (default: -10.0)
110120
- `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
121+
- `set alert_light_lux <value>` - Light threshold in lux (default: 10.0)
122+
- `set alert_light_above <0|1>` - Alert when light > threshold (1) or < threshold (0)
123+
124+
**Device Settings:**
125+
- `set device_label <text>` - Set custom device label/location (max 31 chars)
126+
127+
**Example Usage:**
128+
```
129+
set alert_enabled 1
130+
set alert_cloud_temp -15.0
131+
set alert_cloud_below 1
132+
config_save
133+
```
134+
This enables alerts when sky temperature drops below -15°C (indicating clouds).
114135

115136
## Firmware
116137

0 commit comments

Comments
 (0)