Add state command to CLI (#2042)

Author: frenck

src/wled/cli/__init__.py

@@ -310,6 +310,85 @@ async def command_reset(
     console.print("[green]WLED device has been rebooted!")
 
 
+@cli.command("state")
+async def command_state(
+    host: Annotated[
+        str,
+        typer.Option(
+            help="WLED device IP address or hostname",
+            prompt="Host address",
+            show_default=False,
+        ),
+    ],
+) -> None:
+    """Show the current state of the WLED device."""
+    with console.status("[cyan]Fetching WLED device state...", spinner="toggle12"):
+        async with WLED(host) as led:
+            device = await led.update()
+
+    state = device.state
+
+    state_table = Table(title="\nWLED device state", show_header=False)
+    state_table.add_column("Property", style="cyan bold")
+    state_table.add_column("Value", style="green")
+
+    state_table.add_row("Power", "On" if state.on else "Off")
+    state_table.add_row("Brightness", str(state.brightness))
+    state_table.add_row("Transition", str(state.transition))
+
+    if state.preset_id is not None and device.presets:
+        preset = device.presets.get(state.preset_id)
+        state_table.add_row(
+            "Preset", f"{preset.name} (#{state.preset_id})" if preset else "Unknown"
+        )
+
+    if state.playlist_id is not None and device.playlists:
+        playlist = device.playlists.get(state.playlist_id)
+        state_table.add_row(
+            "Playlist",
+            f"{playlist.name} (#{state.playlist_id})" if playlist else "Unknown",
+        )
+
+    state_table.add_row("Nightlight", "On" if state.nightlight.on else "Off")
+    state_table.add_row(
+        "Live override", state.live_data_override.name.replace("_", " ").title()
+    )
+
+    console.print(state_table)
+
+    seg_table = Table(title="\nSegments", show_lines=True)
+    seg_table.add_column("ID", style="cyan bold")
+    seg_table.add_column("Name")
+    seg_table.add_column("Power")
+    seg_table.add_column("Brightness")
+    seg_table.add_column("Effect")
+    seg_table.add_column("Palette")
+    seg_table.add_column("Range")
+
+    for seg in state.segments.values():
+        effect = (
+            device.effects.get(seg.effect_id)
+            if isinstance(seg.effect_id, int)
+            else None
+        )
+        palette = (
+            device.palettes.get(seg.palette_id)
+            if isinstance(seg.palette_id, int)
+            else None
+        )
+        seg_table.add_row(
+            str(seg.segment_id),
+            seg.name or "",
+            "On" if seg.on else "Off",
+            str(seg.brightness),
+            effect.name if effect else str(seg.effect_id),
+            palette.name if palette else str(seg.palette_id),
+            f"{seg.start}-{seg.stop}",
+        )
+
+    console.print(seg_table)
+
+
 @cli.command("upgrade")
 async def command_upgrade(
     host: Annotated[

tests/__snapshots__/test_cli.ambr

@@ -23,6 +23,9 @@
     ]),
     'scan': list([
     ]),
+    'state': list([
+      'host',
+    ]),
     'upgrade': list([
       'host',
       'version',
@@ -281,6 +284,27 @@
   └───────────┴─────────────┘
   '''
 # ---
+# name: test_state_command
+  '''
+                         
+     WLED device state   
+  ┌───────────────┬─────┐
+  │ Power         │ On  │
+  │ Brightness    │ 128 │
+  │ Transition    │ 7   │
+  │ Nightlight    │ Off │
+  │ Live override │ Off │
+  └───────────────┴─────┘
+                                                               
+                            Segments                           
+  ┏━━━━┳━━━━━━┳━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓
+  ┃ ID ┃ Name ┃ Power ┃ Brightness ┃ Effect ┃ Palette ┃ Range ┃
+  ┡━━━━╇━━━━━━╇━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━╇━━━━━━━┩
+  │ 0  │      │ On    │ 255        │ Solid  │ Default │ 0-30  │
+  └────┴──────┴───────┴────────────┴────────┴─────────┴───────┘
+  
+  '''
+# ---
 # name: test_unsupported_version_error_handler
   '''
   ╭────────────────────── Unsupported version ───────────────────────╮

tests/test_cli.py

@@ -383,6 +383,17 @@ def test_reset_command(
     mock.return_value.reset.assert_awaited_once()
 
 
+@pytest.mark.usefixtures("stable_terminal")
+def test_state_command(
+    runner: CliRunner,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """State command shows device state and segments."""
+    exit_code, output = _invoke(runner, ["state", "--host", "example.com"])
+    assert exit_code == 0
+    assert output == snapshot
+
+
 @pytest.mark.usefixtures("stable_terminal")
 def test_upgrade_command(
     runner: CliRunner,