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/_components/websocket_api.markdown
Paulus Schoutsen bdb9a933cf Fix broken links
2019-04-03 10:39:06 -07:00

1.2 KiB
Raw Blame History

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 Other internal 0.34

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.

{% linkable_title Configuration %}

# Example configuration.yaml entry
websocket_api:

For details to use the WebSocket API, please refer to the WebSocket API documentation .

{% linkable_title 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