Add some more component descriptions

This commit is contained in:
Paulus Schoutsen 2015-03-15 01:01:30 -07:00
parent 0a8bc2038d
commit a86578521f
5 changed files with 59 additions and 38 deletions

View File

@ -0,0 +1,20 @@
---
layout: page
title: "Configurator"
description: "Instructions how to integrate the configurator in your components."
date: 2015-03-15 00:51
sidebar: false
comments: false
sharing: true
footer: true
---
<p class='note'>
This component is intended for developers.
</p>
The configurator component allows components to request information from the user. It is currently implemented as the minimum viable product: it supports showing a text, image and button to the user. It will trigger a callback when the button is pressed.
The Hue component in [the demo](/demo) is implemented using the configurator. See [the source of the demo component](https://github.com/balloob/home-assistant/blob/master/homeassistant/components/demo.py#L72) for a simple example.
See [the source](https://github.com/balloob/home-assistant/blob/master/homeassistant/components/configurator.py#L39) for more details on how to use the configurator component.

View File

@ -0,0 +1,22 @@
---
layout: page
title: "Conversation"
description: "Instructions how to have conversations with your Home Assistant."
date: 2015-03-15 00:39
sidebar: false
comments: false
sharing: true
footer: true
---
The conversation component can process sentences into commands for Home Assistant. It is currently limited to parsing commands in the format `turn <Friendly Name> <on/off>`.
```
conversation:
```
When this component is active and you are using a supported browser voice commands will be activated in the frontend. Browse to [the demo](/demo/) in Chrome to see it in action.
<p class='img'>
<img src="/images/screenshots/voice-commands.png" />
</p>

View File

@ -1,7 +1,7 @@
---
layout: page
title: "Chromecast"
description: "Instructions how to setup your chromecasts with Home Assistant."
title: "Media Player"
description: "Instructions how to setup your media players with Home Assistant."
date: 2015-01-24 14:39
sidebar: false
comments: false
@ -9,16 +9,17 @@ sharing: true
footer: true
---
Interacts with media players on your network. Currently only supports Chromecasts. These will be automatically discovered if you setup [the discovery component]({{site_root}}/components/discovery.html). Can also be forced to load by adding the following lines to your `configuration.yaml`:
```
media_player:
platform: chromecast
```
<p class='note warning'>
Chromecasts have recently received a new API which is not yet supported by Home Assistant. Therefore we currently can only detect them and do not know what they are up to.
</p>
Interacts with Chromecasts on your network. Will be automatically discovered if you setup [the discovery component]({{site_root}}/components/discovery.html). Can also be forced to load by adding the following lines to your `configuration.yaml`:
```
chromecast:
```
## Services
### Media control services
@ -26,24 +27,24 @@ Available services: `turn_off`, `volume_up`, `volume_down`, `media_play_pause`,
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Target a specific chromecast. Defaults to all.
| `entity_id` | yes | Target a specific media player. Defaults to all.
### Media play services
There are three services to start playing YouTube video's on the ChromeCast.
There are three services to start playing YouTube video's on the media player.
#### Service `chromecast/play_youtube_video`
Service to start playing a YouTube vide on the Chromecast.
#### Service `media_player/play_youtube_video`
Service to start playing a YouTube vide on the media player.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Target a specific chromecast. Defaults to all.
| `entity_id` | yes | Target a specific media player. Defaults to all.
| `video` | no | YouTube video to be played, ie. `L0MK7qz13bU`
#### Service `chromecast/start_fireplace` and `chromecast/start_epic_sax`
Will either start a fireplace or Epic Sax Guy 10h on the Chromecast.
#### Service `media_player/start_fireplace` and `media_player/start_epic_sax`
Will either start a fireplace or Epic Sax Guy 10h on the media player.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Target a specific chromecast. Defaults to all.
| `entity_id` | yes | Target a specific media player. Defaults to all.

View File

@ -1,22 +0,0 @@
---
layout: page
title: "Tellstick Sensors"
description: "Instructions how to setup tellstick sensors with Home Assistant."
date: 2015-01-24 14:39
sidebar: false
comments: false
sharing: true
footer: true
---
Shows the values of that sensors that is connected to your Tellstick.
To enable it, add the following lines to your `configuration.yaml`:
```
tellstick_sensor:
```
<p class='note warning'>
This component is going to be merged into the sensor component.
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB