Update README to reflect implemented functionality #2

2026-05-26T13:16:33Z

thatguygriff commented

2026-05-26 13:16:33 +00:00

Summary

The README's Known Limitations & Roadmap section was out of date — it claimed device control was not yet implemented and that Socket.IO was unused. Both are inaccurate: climate control (mode, target temperature, fan speed, swing) ships via Socket.IO machine events, and live device-data updates come over the same socket.

Changes

Replace Known Limitations & Roadmap with a How It Works section describing authentication, polling, the live Socket.IO connection, command flow, and unit handling.
Add a smaller Known Limitations list covering what genuinely still applies (reauth on refresh-token expiry; one entity per indoor unit, no installation aggregate).
Reword the temperature-units note to be clearer that HA always shows Celsius and Fahrenheit devices are converted transparently in both directions.

Test plan

Render the README on Gitea / GitHub and confirm formatting looks correct.
Sanity-check against the code: climate.py exposes async_set_* for hvac mode, temperature, fan mode, swing; api.py connects Socket.IO and sends create-machine-event for control.

## Summary The README's *Known Limitations & Roadmap* section was out of date — it claimed device control was not yet implemented and that Socket.IO was unused. Both are inaccurate: climate control (mode, target temperature, fan speed, swing) ships via Socket.IO machine events, and live `device-data` updates come over the same socket. ## Changes - Replace *Known Limitations & Roadmap* with a *How It Works* section describing authentication, polling, the live Socket.IO connection, command flow, and unit handling. - Add a smaller *Known Limitations* list covering what genuinely still applies (reauth on refresh-token expiry; one entity per indoor unit, no installation aggregate). - Reword the temperature-units note to be clearer that HA always shows Celsius and Fahrenheit devices are converted transparently in both directions. ## Test plan - [ ] Render the README on Gitea / GitHub and confirm formatting looks correct. - [ ] Sanity-check against the code: `climate.py` exposes `async_set_*` for hvac mode, temperature, fan mode, swing; `api.py` connects Socket.IO and sends `create-machine-event` for control.

thatguygriff added 1 commit 2026-05-26 13:16:33 +00:00

Update README to reflect implemented functionality

Validate / Hassfest validation (pull_request) Failing after 29s

Details

Validate / HACS validation (pull_request) Failing after 27s

Details

a7ceca779b

The "Known Limitations & Roadmap" section claimed device control
was not implemented and that Socket.IO was unused. Both are now
inaccurate — climate control (mode, temperature, fan speed, swing)
ships via Socket.IO machine events, and live device-data updates
come over the same socket connection.

Replace that section with a "How It Works" overview and a smaller
"Known Limitations" list reflecting the actual remaining gaps.

thatguygriff merged commit 2248b7197a into main

2026-05-26 13:42:02 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: GitHub/homeassistant-dkncloudna#2