Skip to content

Commit 81ed9c7

Browse files
docs: update README with complete CLI set parameters and TUI keybindings
Expand the CLI "Set parameters" section from 6 to all 17 parameters grouped by category (fire control, flame, media lighting, overhead lighting, ambient, heat, timer/units). Expand the TUI keybindings table from 3 to all 21 user-facing keys. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d442140 commit 81ed9c7

1 file changed

Lines changed: 51 additions & 17 deletions

File tree

README.md

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -117,23 +117,39 @@ flameconnect off <fire_id>
117117
### Set parameters
118118

119119
```bash
120-
# Set operating mode (standby or manual)
121-
flameconnect set <fire_id> mode manual
122-
123-
# Set flame speed (1-5)
124-
flameconnect set <fire_id> flame-speed 3
125-
126-
# Set brightness (low, high)
127-
flameconnect set <fire_id> brightness low
128-
129-
# Set heat mode (normal, boost, eco)
130-
flameconnect set <fire_id> heat-mode eco
131-
132-
# Set heater target temperature
133-
flameconnect set <fire_id> heat-temp 22.5
134-
135-
# Set countdown timer in minutes (0 to disable)
136-
flameconnect set <fire_id> timer 120
120+
# Fire control
121+
flameconnect set <fire_id> mode manual # standby, manual
122+
123+
# Flame
124+
flameconnect set <fire_id> flame-effect on # on, off
125+
flameconnect set <fire_id> flame-speed 3 # 1-5
126+
flameconnect set <fire_id> flame-color blue # all, yellow-red, yellow-blue,
127+
# blue, red, yellow, blue-red
128+
flameconnect set <fire_id> brightness low # low, high
129+
flameconnect set <fire_id> pulsating on # on, off
130+
131+
# Media lighting
132+
flameconnect set <fire_id> media-theme prism # user-defined, white, blue,
133+
# purple, red, green, prism,
134+
# kaleidoscope, midnight
135+
flameconnect set <fire_id> media-light on # on, off
136+
flameconnect set <fire_id> media-color 255,0,0,80 # R,G,B,W (0-255) or preset name
137+
138+
# Overhead lighting
139+
flameconnect set <fire_id> overhead-light on # on, off
140+
flameconnect set <fire_id> overhead-color dark-blue # R,G,B,W or preset name
141+
142+
# Ambient
143+
flameconnect set <fire_id> ambient-sensor on # on, off
144+
145+
# Heat
146+
flameconnect set <fire_id> heat-status on # on, off
147+
flameconnect set <fire_id> heat-mode eco # normal, boost, eco, boost:<min>
148+
flameconnect set <fire_id> heat-temp 22.5 # target temperature
149+
150+
# Timer & units
151+
flameconnect set <fire_id> timer 120 # minutes (0 to disable)
152+
flameconnect set <fire_id> temp-unit celsius # celsius, fahrenheit
137153
```
138154

139155
### Launch the TUI
@@ -157,6 +173,24 @@ seconds. Key bindings:
157173
| Key | Action |
158174
|-----|--------|
159175
| `p` | Toggle power on/off |
176+
| `f` | Set flame speed (1-5) |
177+
| `e` | Toggle flame effect |
178+
| `c` | Set flame color |
179+
| `b` | Toggle brightness (high/low) |
180+
| `g` | Toggle pulsating effect |
181+
| `m` | Set media theme |
182+
| `l` | Toggle media light |
183+
| `d` | Set media color (RGBW) |
184+
| `o` | Toggle overhead light |
185+
| `v` | Set overhead color (RGBW) |
186+
| `a` | Toggle ambient sensor |
187+
| `s` | Toggle heat on/off |
188+
| `h` | Set heat mode |
189+
| `n` | Set temperature |
190+
| `u` | Toggle temp unit (°C/°F) |
191+
| `t` | Set timer |
192+
| `w` | Switch fireplace |
193+
| `?` | Toggle help overlay |
160194
| `r` | Manual refresh |
161195
| `q` | Quit |
162196

0 commit comments

Comments
 (0)