mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-04-28 23:37:35 +00:00
ebca3218c7
* Automatically create linkable headers
* Visually improve position of linkable header chain icon
* Do not auto link headers on homepage
* Remove linkable_title everywhere
* 🚑 Re-instante linkable_title plugin as NOOP
1.1 KiB
1.1 KiB
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_qa_scale | ha_release | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| page | Websocket API | Instructions on how to setup the WebSocket API within Home Assistant. | 2018-01-21 08:00 | true | false | true | true | home-assistant.png |
|
internal | 0.34 |
The websocket_api integration set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the http component.
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
Configuration
# Example configuration.yaml entry
websocket_api:
For details to use the WebSocket API, please refer to the WebSocket API documentation .
Track current connections
The websocket API provides a sensor that will keep track of the number of current connected clients. You can add it by adding the following to your configuration:
# Example configuration.yaml entry
sensor:
platform: websocket_api