home-assistant.io/source/_integrations/sensor.websocket_api.markdown

695 B

title description logo ha_category ha_release ha_iot_class ha_quality_scale ha_domain
Websocket Connections Sensor Instructions on how to count connected clients within Home Assistant. home-assistant.png
Utility
Sensor
0.33 Local Push internal websocket_api

The websocket_api sensor platform shows how many clients are connected to the stream API.

Configuration

To add the connected clients to your installation, add the following to your configuration.yaml file:

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

Note

This replaces the previous api_streams sensor. The default sensor name is connected_clients.