Websocket API


The websocket_api component set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This component 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