jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-27 19:26:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

document coalesce feature (#2128)

Browse Source 
* document coalesce feature

* Update docs/api/websocket.md

Co-authored-by: J. Nick Koston <nick@koston.org>

---------

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Max Rydahl Andersen 2025-02-06 22:19:23 +01:00 committed by GitHub
parent 3afcff2985
commit 6239a77559
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api/websocket.md
View File

@ -85,6 +85,20 @@ If the data is incorrect, the server will reply with `auth_invalid` message and
}
```
## Feature enablement phase
Clients that supports features that needs enabling should as their first message (with `"id": 1`) send a message in the form:
```
{
"id": 1,
"type": "supported_features",
"features": { coalesce_messages: 1 }
}
```
As of now the only feature supported is 'coalesce_messages' which result in messages being sent coalesced in bulk instead of individually.
## Command phase
During this phase the client can give commands to the server. The server will respond to each command with a `result` message indicating when the command is done and if it was successful along with the context of the command.