jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-04-27 14:57:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/websocket_api.markdown
Franck Nijhof 3488e288bf
Sync codebase with docs for 0.108
2020-04-08 16:43:31 +02:00

1.1 KiB
Raw Blame History

title description ha_category ha_release ha_quality_scale ha_codeowners ha_domain
Home Asssitant WebSocket API Instructions on how to setup the WebSocket API within Home Assistant.
Other
0.34 internal
@home-assistant/core
websocket_api

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