home-assistant.io/source/_components/websocket_api.markdown
Franck Nijhof c464056402
Making our website faster, cleaner and prettier (#9853)
* 🔥 Removes octopress.js

* 🔥 Removes use of root_url var

* 🔥 Removes Octopress generator reference from feed

* 🔥 Removes delicious support

* 🔥 Removes support for Pinboard

* 🔥 Removes support for Disqus

* 🔥 Removes support for Google Plus

* ↩️ Migrate custom after_footer to default template

* ↩️ Migrate custom footer to default template

* ↩️ Migrate custom header to default template

* 🔥 Removes unused template files

* 🚀 Places time to read directly in post template

* 🚀 Removes unneeded capture from archive_post.html template

* 🔥 🚀 Removes unused, but heaving sorting call in component page

* 🚀 Merged javascripts into a single file

* 🔥 Removes more uses of root_url

* 🚀 Removal of unneeded captures from head

* 🔥 🚀 Removal of expensive liquid HTML compressor

* 🔥 Removes unneeded templates

* 🚀 Replaces kramdown with GitHub's CommonMark 🚀

* 💄 Adds Prism code syntax highlighting

*  Adds support for redirect in Netlify

* ↩️ 🔥 Let Netlify handle all developer doc redirects

* ✏️ Fixes typo in redirects file: Netify -> Netlify

* 🔥 Removes unused .themes folder

* 🔥 Removes unused aside.html template

* 🔥 Removes Disqus config leftover

* 🔥 Removes rouge highlighter config

* 🔥 Removes Octopress 🎉

* 💄 Adjust code block font size and adds soft wraps

* 💄 Adds styling for inline code blocks

* 💄 Improve styling of note/warning/info boxes + div support

* 🔨 Rewrites all note/warning/info boxes
2019-07-15 22:17:54 +02:00

1.0 KiB

title description logo ha_category ha_qa_scale ha_release
Websocket API Instructions on how to setup the WebSocket API within Home Assistant. home-assistant.png
Other
internal 0.34

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