jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Extend and update API documentation (#4485)

Browse source
This commit is contained in:
Fabian Affolter 2018-01-21 17:34:44 +01:00 • committed by GitHub
parent a7a467065d
commit 1330075f56
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 66 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

25
source/_components/websocket_api.markdown Normal file
View file

@ -0,0 +1,25 @@
---
layout: page
title: "Websocket API"
description: "Instructions how to setup the WebSocket API within Home Assistant."
date: 2018-01-21 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: "Other"
---
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](/components/http/).
<p class='note warning'>
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
</p>
```yaml
# Example configuration.yaml entry
websocket_api:
```
For details to use the WebSocket API, please refer to the [WebSocket API documentation](/developers/websocket_api/) .