Merge pull request #81 from Wouter0100/dev

Release v2.0.0

Author: chiconws

AGENTS.md

@@ -35,13 +35,17 @@ The integration follows the standard structure for a Home Assistant
 
 - **`coordinator.py`**: Hosts `NanoKVMDataUpdateCoordinator`.
   - Central polling logic (`_async_update_data`) and API fetch helpers.
-  - Handles reauthentication, storage-state fetches, and SSH metric refresh.
+  - Handles reauthentication, storage-state fetches, optional NanoKVM Pro
+    state, dynamic media/network/SSH entities, and SSH metric refresh.
+  - Gates non-Pro-only endpoints such as swap size, CD-ROM state, HDMI output,
+    and non-Pro virtual disk controls.
 
 - **`entity.py`**: Defines `NanoKVMEntity` base class.
   - Shared entity behavior (`unique_id`, `device_info`) for all platforms.
 
 - **`services.py`**: Service schemas, registration, and handlers.
-  - Implements all `nanokvm.*` service behavior and unregister logic.
+  - Implements all `nanokvm.*` service behavior, response services, and
+    unregister logic.
 
 - **`config_flow.py`**: Manages the user configuration flow in Home Assistant.
   - Implements `ConfigFlow` for manual setup and zeroconf discovery.
@@ -60,6 +64,9 @@ The integration follows the standard structure for a Home Assistant
 - **`ssh_metrics.py`**: SSH metrics collection implementation used by the
   coordinator.
 
+- **`led.py`**: Shared NanoKVM Pro LED strip validation and config helpers.
+  - Enforces LED brightness and bead-count constraints for entities/services.
+
 - **`manifest.json`**: Integration metadata.
   - Domain, name, version, dependencies (including `zeroconf`).
   - PyPI requirement (`nanokvm`).
@@ -75,6 +82,8 @@ Assistant entity type:
 - `button.py`
 - `camera.py`
 - `camera_webrtc.py` (WebRTC helper used by the camera platform)
+- `camera_webrtc_sdp.py` (NanoKVM Pro SDP split/merge helpers)
+- `number.py`
 - `select.py`
 - `sensor.py`
 - `switch.py`
@@ -112,6 +121,13 @@ Each platform follows a similar pattern:
 - **Coordinator pattern**:
   `DataUpdateCoordinator` provides one polling path and shared state for all
   entities.
+- **Optional and dynamic entities**:
+  Some entities are created only after the coordinator sees supporting state,
+  such as mounted media, active wired/wireless connections, or SSH metrics.
+- **NanoKVM Pro compatibility**:
+  Pro devices expose several APIs with different schemas from non-Pro models.
+  Keep Pro-specific polling optional and keep non-Pro-only entities gated by
+  hardware support.
 - **Declarative entities**:
   Dataclass-based entity descriptions keep entity definitions compact.
 - **`nanokvm` library boundary**:
@@ -127,12 +143,16 @@ Each platform follows a similar pattern:
 
 Run these checks locally before pushing:
 
-1. Python lint:
-   - `ruff check custom_components/nanokvm`
-   - If needed: `.\venv\Scripts\python -m ruff check custom_components/nanokvm`
-2. Validate metadata JSON:
-   - `Get-Content hacs.json | ConvertFrom-Json > $null`
-   - `Get-Content custom_components/nanokvm/manifest.json | ConvertFrom-Json > $null`
+1. Python checks:
+   - `python -m ruff check custom_components/nanokvm`
+   - `python -m py_compile custom_components/nanokvm/*.py`
+2. Validate JSON metadata, strings, and translations:
+   - `python -m json.tool hacs.json`
+   - `python -m json.tool custom_components/nanokvm/manifest.json`
+   - `python -m json.tool custom_components/nanokvm/strings.json`
+   - `python -m json.tool custom_components/nanokvm/translations/en.json`
+   - `python -m json.tool custom_components/nanokvm/translations/fr.json`
+   - `python -m json.tool custom_components/nanokvm/translations/pt-BR.json`
 3. Verify the integration against a Home Assistant test instance and inspect logs.
 
 ## Required GitHub Workflows

CONTRIBUTING.md

@@ -20,15 +20,24 @@ Recommended flow:
 - Keep changes focused and small when possible.
 - AI-assisted coding is welcome, but contributors are responsible for
   understanding, reviewing, and validating generated changes.
-- Update docs/translations when behavior or user-facing text changes.
+- Update README, SERVICES, strings, and translations together when behavior,
+  services, entities, or user-facing text changes.
 - Add tests for bug fixes and new behavior when practical.
 
 ## Validation
 
 Before opening a PR, run:
 
-1. `ruff check custom_components/nanokvm`
-2. Test the integration on a Home Assistant instance (if relevant)
+1. `python -m ruff check custom_components/nanokvm`
+2. `python -m py_compile custom_components/nanokvm/*.py`
+3. `python -m json.tool hacs.json`
+4. `python -m json.tool custom_components/nanokvm/manifest.json`
+5. `python -m json.tool custom_components/nanokvm/strings.json`
+6. `python -m json.tool custom_components/nanokvm/translations/en.json`
+7. `python -m json.tool custom_components/nanokvm/translations/fr.json`
+8. `python -m json.tool custom_components/nanokvm/translations/pt-BR.json`
+
+When behavior changes, also test the integration on a Home Assistant instance.
 
 CI must pass on the PR branch:
 

README.md

@@ -15,13 +15,14 @@ device settings, diagnostics, services, and camera streaming in Home Assistant.
 
 | Area | Capabilities |
 | --- | --- |
-| Power and hardware | Power/reset actions, status LEDs, HDMI output control (PCI-E) |
-| Device settings | SSH, mDNS, HID mode, OLED timeout, swap size, mouse jiggler, watchdog |
-| Virtual devices | Virtual network and virtual disk switches |
-| Monitoring | Mounted image, CD-ROM mode, Tailscale, Wi-Fi |
+| Power and hardware | Power/reset actions, status LEDs, HDMI output control (PCI-E), Pro HDMI capture/passthrough |
+| Device settings | SSH, mDNS, HID mode, OLED timeout, swap size, mouse jiggler, watchdog, Pro low power, Pro LCD time format |
+| Virtual devices | Virtual network, non-Pro virtual disk switch, Pro virtual mic, Pro virtual disk type |
+| Pro LED strip | On/off, brightness, horizontal bead count, vertical bead count |
+| Monitoring | Mounted image, CD-ROM mode, Tailscale, Wi-Fi, wired/wireless IP diagnostics, Pro time/static IP state |
 | Updates | Application version reporting and install action |
 | SSH diagnostics | Uptime, CPU temp, memory/storage usage when SSH is enabled |
-| Camera | HDMI still snapshots and native WebRTC streaming |
+| Camera | HDMI still snapshots on non-Pro models and native WebRTC streaming |
 
 ## Installation
 
@@ -66,18 +67,20 @@ Notes:
 
 - Host updates from discovery are disabled when **Use static host only** is enabled.
 - Camera stream availability depends on HDMI input/source status.
+- NanoKVM Pro still snapshots are skipped to avoid interrupting WebRTC video mode.
 - Feature-specific entities only appear when the device reports support for them.
 
 ## Entities
 
 | Platform | Highlights |
 | --- | --- |
-| Binary sensor | Power LED, HDD LED, Wi-Fi connected, CD-ROM mode |
-| Button | Power/Reset buttons, reboot, reset HID/HDMI |
-| Camera | HDMI stream camera with still snapshots and WebRTC |
-| Select | HID mode, Mouse Jiggler, OLED timeout, Swap size |
-| Sensor | Mounted image, Tailscale, SSH diagnostics |
-| Switch | Power, SSH, mDNS, Virtual network/disk, HDMI output, watchdog |
+| Binary sensor | Power LED, HDD LED, Wi-Fi/wired connected, CD-ROM mode, Pro static IP enabled, Pro time synchronized |
+| Button | Power/Reset buttons, reboot, reset HID/HDMI, Pro sync time |
+| Camera | HDMI stream camera with WebRTC and non-Pro still snapshots |
+| Number | Pro LED brightness, horizontal beads, vertical beads |
+| Select | HID mode, Mouse Jiggler, OLED timeout, Swap size, Pro LCD time format, Pro virtual disk type |
+| Sensor | IP address, wired/wireless IP address, mounted image, Tailscale, SSH diagnostics |
+| Switch | Power, SSH, mDNS, virtual network/disk, HDMI output, watchdog, Pro HDMI capture/passthrough, Pro low power, Pro LED strip, Pro virtual mic |
 | Update | Application version and install action |
 
 Notes:
@@ -87,6 +90,7 @@ Notes:
 - Wi-Fi entities only appear when the device reports Wi-Fi support.
 - SSH diagnostics appear after SSH is enabled on the NanoKVM.
 - The watchdog switch requires SSH and NanoKVM application version `2.2.2` or newer.
+- Pro LED bead counts must satisfy `horizontal + (2 * vertical) <= 150`.
 
 ## Hardware Compatibility
 
@@ -95,6 +99,26 @@ Notes:
 | HDMI switch/button controls | PCI-E models |
 | HDD LED binary sensor | Alpha models |
 | SSH diagnostic sensors | Any model with SSH enabled |
+| Swap size, CD-ROM mode, virtual disk switch | Non-Pro models |
+| Virtual network switch | Non-Pro and Pro models |
+| HDMI capture/passthrough, low power, LED strip, virtual mic, LCD time format, sync time | Pro models |
+| Wired/wireless IP sensors | Created when that connection type is active |
+
+### NanoKVM Pro
+
+NanoKVM Pro devices are supported through the `nanokvm` Python library.
+The integration exposes Pro controls for HDMI capture/passthrough, low power,
+LED strip configuration, virtual network, virtual microphone, virtual disk
+type, LCD time format, sync time, static IP state, and time synchronization
+state.
+
+Because the Pro firmware does not expose the same endpoints as non-Pro models,
+these non-Pro entities are hidden on Pro:
+
+- Swap size select
+- HDMI output switch and Reset HDMI button
+- CD-ROM Mode binary sensor
+- Virtual Disk switch
 
 ## Services
 
@@ -110,11 +134,19 @@ For full call examples, see [`SERVICES.md`](SERVICES.md).
 | `reset_hid` | `host` | Reset HID subsystem |
 | `wake_on_lan` | `host`, `mac` | Send Wake-on-LAN packet |
 | `set_mouse_jiggler` | `host`, `enabled`, `mode` | Set mouse jiggler state |
+| `set_led_strip` | `host`, `on`, `brightness`, `horizontal_count`, `vertical_count` | Set NanoKVM Pro LED strip state |
+| `scan_wifi` | `host` | Scan Wi-Fi networks and return the Pro response |
+| `list_images` | `host` | Return available NanoKVM images |
+| `is_image_download_enabled` | `host` | Return whether image downloading is enabled |
+| `get_image_download_status` | `host` | Return image download status |
+| `list_custom_edids` | `host` | Return custom EDIDs available on NanoKVM Pro |
 
 Notes:
 
 - `push_button.duration` range is `100-5000` ms.
+- `set_led_strip.brightness` range is `0-100`; LED beads must satisfy `horizontal + (2 * vertical) <= 150`.
 - `host` is optional when one NanoKVM is configured and required when multiple devices are configured.
+- Response services return structured data to callers that request a response.
 
 ## Example Automation
 
@@ -140,6 +172,8 @@ automation:
 | Missing entities | Some entities only appear after the related feature is available (for example SSH enabled or media mounted) |
 | No SSH sensors | Enable SSH on NanoKVM |
 | No HDMI controls | HDMI controls only appear on PCI-E hardware |
+| No Pro still image | Pro snapshots are intentionally skipped to avoid interrupting WebRTC video |
+| Missing wired/wireless IP sensor | The sensor appears after the device reports an active address for that connection type |
 
 ## Supported Languages
 

SERVICES.md

@@ -1,6 +1,11 @@
 # NanoKVM Service Examples
 
 All service calls use the `nanokvm` domain.
+The `host` field is optional when one NanoKVM is configured and required when
+multiple NanoKVM devices are configured.
+
+Response services return structured data. In automations or scripts, use
+`response_variable` when you need to consume the returned data.
 
 ## `nanokvm.push_button`
 
@@ -125,3 +130,120 @@ data:
   enabled: true
   mode: absolute
 ```
+
+## `nanokvm.set_led_strip`
+
+Configure NanoKVM Pro LED strip state.
+
+Parameters:
+
+- `host`: optional target host; required when multiple NanoKVM devices are configured
+- `on`: `true` or `false` (optional)
+- `brightness`: brightness percentage from `0` to `100` (optional)
+- `horizontal_count`: horizontal LED bead count, minimum `1` (optional)
+- `vertical_count`: vertical LED bead count, minimum `1` (optional)
+
+At least one of `on`, `brightness`, `horizontal_count`, or `vertical_count`
+is required. Omitted values are preserved from the current LED strip state.
+The bead counts must satisfy:
+
+```text
+horizontal_count + (2 * vertical_count) <= 150
+```
+
+Example:
+
+```yaml
+service: nanokvm.set_led_strip
+data:
+  host: "192.168.1.50"
+  on: true
+  brightness: 75
+  horizontal_count: 10
+  vertical_count: 70
+```
+
+## `nanokvm.scan_wifi`
+
+Scan nearby Wi-Fi networks and return the NanoKVM Pro response.
+
+Parameters:
+
+- `host`: optional target host; required when multiple NanoKVM devices are configured
+
+Example:
+
+```yaml
+service: nanokvm.scan_wifi
+data:
+  host: "192.168.1.50"
+response_variable: wifi_scan
+```
+
+## `nanokvm.list_images`
+
+List images available on the NanoKVM.
+
+Parameters:
+
+- `host`: optional target host; required when multiple NanoKVM devices are configured
+
+Example:
+
+```yaml
+service: nanokvm.list_images
+data:
+  host: "192.168.1.50"
+response_variable: images
+```
+
+## `nanokvm.is_image_download_enabled`
+
+Return whether image downloading is enabled on the NanoKVM.
+
+Parameters:
+
+- `host`: optional target host; required when multiple NanoKVM devices are configured
+
+Example:
+
+```yaml
+service: nanokvm.is_image_download_enabled
+data:
+  host: "192.168.1.50"
+response_variable: image_download_enabled
+```
+
+## `nanokvm.get_image_download_status`
+
+Return the current NanoKVM image download status.
+
+Parameters:
+
+- `host`: optional target host; required when multiple NanoKVM devices are configured
+
+Example:
+
+```yaml
+service: nanokvm.get_image_download_status
+data:
+  host: "192.168.1.50"
+response_variable: image_download_status
+```
+
+## `nanokvm.list_custom_edids`
+
+List custom EDIDs available on a NanoKVM Pro.
+
+Parameters:
+
+- `host`: optional target host; required when multiple NanoKVM devices are configured
+
+Example:
+
+```yaml
+service: nanokvm.list_custom_edids
+data:
+  host: "192.168.1.50"
+response_variable: custom_edids
+```

custom_components/nanokvm/__init__.py

@@ -24,6 +24,7 @@
     Platform.BINARY_SENSOR,
     Platform.BUTTON,
     Platform.CAMERA,
+    Platform.NUMBER,
     Platform.SELECT,
     Platform.SENSOR,
     Platform.SWITCH,