Skip to content

[WIP] MQTT Support / Home Assistant Integration#1195

Draft
PH89 wants to merge 6 commits intojetkvm:devfrom
PH89:mqtt_client
Draft

[WIP] MQTT Support / Home Assistant Integration#1195
PH89 wants to merge 6 commits intojetkvm:devfrom
PH89:mqtt_client

Conversation

@PH89
Copy link
Contributor

@PH89 PH89 commented Feb 7, 2026

Summary

  • Adds a full-featured MQTT client to JetKVM with Home Assistant Auto-Discovery support
  • Publishes device state (video signal, USB, cloud connection, active sessions, network info, system metrics, virtual media) as retained MQTT messages
  • Supports TLS connections with validation against rootcerts and optional insecure mode
  • Implements controllable entities via MQTT: mouse jiggler (switch), DC power (switch), ATX buttons, device reboot, firmware update, and virtual media selection
  • Adds EnableActions config toggle — when disabled, controllable entities are replaced with read-only sensors/binary sensors while keeping full monitoring capability. The firmware update entity remains visible but without install command.
  • Firmware update entity reports real-time in_progress status and update_percentage during OTA updates
  • Virtual media select entity dynamically updates its options list, supports storage-based and HTTP-mounted images, and exposes a source attribute (storage/url/none)
  • System metrics sensors: CPU load (with state_class: measurement for graphs), SoC temperature, memory usage, storage used/free
  • Extension-aware discovery: ATX and DC entities are published/removed based on the active extension
  • Proper cleanup: discovery entries and state topics are cleared when MQTT or HA Discovery is disabled
  • Adds MQTT settings page to the UI with full configuration (broker, port, TLS, credentials, base topic, HA Discovery toggle, actions toggle)
  • Includes English and German localization for all MQTT settings

Related Issues:

Test plan

  • Enable MQTT and verify connection to broker (with and without TLS)
  • Verify HA Auto-Discovery creates all expected entities
  • Toggle EnableActions off → confirm switches become binary sensors, buttons disappear, select becomes sensor, update entity loses install button
  • Toggle EnableActions on → confirm controllable entities reappear
  • Trigger firmware update via HA → confirm progress bar and percentage are displayed and update is applied in the background.
  • Mount a local disk image via the virtual media select → confirm state updates
  • Mount an HTTP image externally → confirm select shows extracted filename and source attribute is url
  • Switch active extension (ATX ↔ DC ↔ Serial ↔ none) → confirm discovery updates accordingly
  • Disable HA Discovery → confirm all discovery entries are removed from the broker (homeassistant topic)
  • Disable MQTT entirely → confirm all topics and discovery entries are cleaned up
  • Verify system metrics sensors (CPU load, temperature, memory, storage) update periodically and support HA graphs

Preview

JetKVM_MQTT

@PH89 PH89 mentioned this pull request Feb 7, 2026
Open
2 tasks
@Igglybuff
Copy link

Igglybuff commented Feb 8, 2026

@PH89 I've tested this on my JetKVM device and it seems to work well - I'll play around with it next week to see if I spot any issues.

I wonder if there's a simple way to add a debounce delay for certain things like ATX HDD LED which can flick on and off repeatedly/quickly for long read/write sessions (if I'm using my NAS, this spams my broker and Home Assistant 😅).

@PH89
Copy link
Contributor Author

PH89 commented Feb 10, 2026

I will check this out. Normally it should be possible. But should be configurable. For MQTT server it should not be a problem to handle such change frequency. On the Home Assistant site it could cause a quick pollution of the history log. So maybe it is better to disable logging for these entities.

@CLAassistant
Copy link

CLAassistant commented Feb 13, 2026 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@PH89 PH89 force-pushed the mqtt_client branch 2 times, most recently from 1be2637 to 6aa24d5 Compare February 13, 2026 16:03
@PH89
Copy link
Contributor Author

PH89 commented Feb 13, 2026

@Igglybuff Integrated debounce delay for ATX HDD Led.

PH89 and others added 6 commits February 13, 2026 17:11
@PH89
MQTT support
ac99caa
@PH89
lint fix
61f7a7a
@PH89
- Add EnableActions config toggle to control whether MQTT commands ca…
9534c7d 
…n be

  executed. When disabled, controllable entities (switches, buttons, select)
  are replaced with read-only sensors/binary sensors. The firmware update
  entity remains visible but without install capability.

- Fix update entity progress feedback by removing value_template which
  prevented HA from parsing in_progress/update_percentage fields. Add
  updateRequested flag and lastKnownLatestVersion cache to bridge the gap
  between MQTT command and OTA state transitions.

- Add system metrics sensors: CPU Load (with state_class measurement for
  graphs), SoC Temperature, Memory Used, Storage Used, Storage Free.

- Add Virtual Media select entity with dynamic options list, mount/unmount
  support, source attribute (url/storage)
@PH89
localization
d0472fa
@PH89
- Adds a debounce delay for HDD led with a default auf 500ms. Prevent…
1a18610 
…s too flaky states in HA.

- Changes on entities like mouse jiggler, virtual media, or active sessions are now published to MQTT instantly.
Previously, these changes only appeared in Home Assistant after the next periodic update cycle.
Additionally, all current states (ATX/DC, jiggler, virtual media,
sessions, network, system, video, etc.) are now published immediately
when the MQTT connection is first established, so Home Assistant knows
the full device state right away on startup or reconnect.

- Also fixes slow session disconnect detection: ICE 'Disconnected' state
now triggers an immediate connection close instead of waiting for the
ICE timeout (5-30s) before transitioning through 'Failed' to 'Closed'.
@PH89
lint adjustments
7e659af
@Igglybuff
Copy link

Igglybuff commented Feb 26, 2026

@Igglybuff Integrated debounce delay for ATX HDD Led.

I've just tested your branch and played around with the debounce setting, but I'm not sure it's behaving as expected. No matter what value I set it to (500, 1000, 0), the ATX HDD LED sensor is stuck disabled:

image

Though this could be because I need to start fresh and re-register with my broker? Not sure.

Were there any other features you were thinking of adding? I would be curious to hear what the JetKVM maintainers think of this PR - maybe they don't look at drafts 😄

@Igglybuff
Copy link

Igglybuff commented Feb 26, 2026

Actually I think the debounce is working now (PEBKAC error) - I had it disabled from a couple weeks ago, but for some reason it took a few attempts for Home Assistant to enable it again and for the entity state to start populating.

This shouldn't be a problem when setting it up for the first time I don't think.

@aaronbolton
Copy link

aaronbolton commented Feb 27, 2026

I've been testing this, and all seems to work great. The only issue I've noticed on reboot of the jetkvm it doesn't reconnect to MQTT and requires the save & connect to be selected

@PH89
Copy link
Contributor Author

PH89 commented Feb 27, 2026

Thanks for the feedback. I will check on this. I guess I will finalise the PR this weekend and mark it as ready for review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@PH89 @Igglybuff @CLAassistant @aaronbolton