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-25 13:57:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/websocket_api.markdown
Sven Serlier 4aee7353da
Small improvements (#27081)
2023-04-22 12:20:33 +02:00

1.1 KiB
Raw Blame History

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

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 integration.

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 currently connected clients. You can add it by adding the following to your configuration:

# Example configuration.yaml entry
sensor:
  - platform: websocket_api

This will create a sensor called sensor.connected_clients whose value is the total number of connected clients.