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

Merge remote-tracking branch 'origin/current' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2017-11-03 23:33:18 -07:00
commit 8a6d1b256f
16 changed files with 717 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

4
source/_components/google_assistant.markdown
View file

@ -65,11 +65,15 @@ homeassistant:
aliases:
- bedroom shades
- bedroom covers
hallway_ceiling_switch:
google_assistant: true
google_assistant_type: light
```
*Entity Customization Keys:*
* *google_assistant*: True exposes entity, false will hide it
* *google_assistant_name*: Can be used to override the primary name of an entity. By default the `friendly_name` of an entity is used.
* *google_assistant_type*: Can be used to override the domain/type of an entity. For example a switch can be treated as a light
* *aliases*: Provides "nicknames" to Google Assistant. These function as alternate names for an entity that Assistant will understand when spoken.
### {% linkable_title Setup %}

2
source/_components/light.decora.markdown
View file

@ -1,6 +1,6 @@
---
layout: page
title: "Decora"
title: "Leviton Decora"
description: "Instructions on how to setup Leviton Decora Bluetooth dimmers within Home Assistant."
date: 2017-01-18 22:45
sidebar: true

2
source/_components/light.decora_wifi.markdown
View file

@ -1,6 +1,6 @@
---
layout: page
title: "Decora Wi-Fi"
title: "Leviton Decora Wi-Fi"
description: "Instructions on how to setup Leviton Decora Smart Wi-Fi switches/dimmers within Home Assistant."
date: 2017-07-19 12:00
sidebar: true

2
source/_components/recorder.markdown
View file

@ -113,7 +113,7 @@ action:
| MySQL (pymysql) | `mysql+pymysql://user:password@SERVER_IP/DB_NAME` |
| PostgreSQL | `postgresql://SERVER_IP/DB_NAME` |
| PostgreSQL | `postgresql://scott:tiger@SERVER_IP/DB_NAME` |
| MS SQL Server | `mssql+pymssql://user:pass@SERVER_IP/?charset=utf8` |
| MS SQL Server | `mssql+pymssql://user:pass@SERVER_IP/DB_NAME?charset=utf8` |
## {% linkable_title Installation notes %}

15
source/_components/remember_the_milk.markdown
View file

@ -7,17 +7,17 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Automation
ha_category: Calendar
ha_release: 0.57
---
The `Remember The Milk` (RTM) component allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g. water the plants. The component allows you to have several RTM accounts in parallel.
# {% linkable_title Setup %}
## {% linkable_title Setup %}
The setup consists of two steps: getting an API key and registering your account
## {% linkable_title step 1: API key %}
### {% linkable_title Step 1: API key %}
To be able to use this component, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal `shared secret`. Both of them need to be stored in your Home Assistant configuration:
@ -32,8 +32,9 @@ remember_the_milk:
```
Configuration variables:
{% configuration %}
account_name
account_name:
description: Name of the RTM account, as you can have serveral accounts in RTM. The name must be unique.
required: true
type: string
@ -47,7 +48,7 @@ Configuration variables:
type: string
{% endconfiguration %}
## {% linkable_title step 2: registering your account %}
### {% linkable_title Step 2: registering your account %}
After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Rember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account.
@ -57,12 +58,12 @@ If the registration was successful, the Configuration panel will disappear from
In the background Home Assistant downloaded a "token" from the Remember The Milk server which is stored in the `remember_the_milk.conf` file locally. So you only need to register once. After that the token is used to authenticate with the server.
# {% linkable_title Creating tasks %}
## {% linkable_title Creating tasks %}
This component offers a new service domain ```remember_the_milk``` with the service ```create_task```. You can call this service with the argument ```name``` to create a new task in your Remember The Milk account. You can call this service from your usual automations.
The task creation supports the "smart syntax", so to create a task with the tag "from_hass" which is due today you can create a task with the name ```test task created in Home Assistant ^today #from_hass```. More info about the smart syntax is available on the [Remember The Milk documentation](https://www.rememberthemilk.com/help/answer/basics-smartadd-howdoiuse).
# {% linkable_title Disclaimer %}
## {% linkable_title Disclaimer %}
This product uses the Remember The Milk API but is not endorsed or certified by Remember The Milk.

7
source/_components/sensor.sytadin.markdown
View file

@ -27,15 +27,8 @@ Configuration variables:
- **name** (*Optional*): Additional name for the sensors. Default to platform name.
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. Defaults to `traffic_jam`.
<<<<<<< HEAD
- **traffic_jam**: Amount of kilometers in traffic jam (km).
- **mean_velocity**: Mean velocity (km/h).
- **congestion**: Index of congestion (n/a).
=======
- **traffic_jam**: A human-readable text summary.
- **mean_velocity**: The current temperature.
- **congestion**: The wind speed.
>>>>>>> current
The data is coming from the [Direction des routes Île-de-France (DiRIF)](http://www.sytadin.fr).

20
source/_components/tradfri.markdown
View file

@ -14,31 +14,27 @@ ha_iot_class: "Local Polling"
ha_release: 0.43
---
The `tradfri` component supports for the IKEA Trådfri (Tradfri) gateway. The gateway can control lights connected to it and Home Assistant will automatically discover its presence on your network.
The `tradfri` component supports for the IKEA Trådfri (Tradfri) gateway. The gateway can control lights connected to it and Home Assistant will automatically discover its presence on your network, if `discovery:` is present in your `configuration.yaml` file.
This component requires cython, please ensure it's installed by running the following in your Home Assistant environment (virtualenv, etc);
```
$ pip3 install cython
```
You will be prompted to configure the gateway through the Home Assistant interface, Enter the security key when prompted and click configure
You will be prompted to configure the gateway through the Home Assistant interface. Enter the security key when prompted and click configure.
<p class='note'>
If you see an "Unable to connect" message, restart the gateway and try again. Don't forget to assign a permanent IP to your Trådfri gateway.
</p>
The gateway can also be manually configured by adding the following lines to your `configuration.yaml` file:
You can add the following to your `configuration.yaml` file if you are not using the [`discovery:`](/components/discovery/) component:
```yaml
# Example configuration.yaml entry
tradfri:
host: IP_ADDRESS
api_key: API_KEY
```
Configuration variables:
- **host** (*Required*): The IP address or hostname of your Trådfri gateway.
- **api_key** (*Required*): Can be found listed as Security Key on the back of the Trådfri gateway.
- **allow_tradfri_groups** (*Optional*): (true/false) Enable this to stop Home Assistant from importing the groups defined on the Trådfri bridge.
- **allow_tradfri_groups** (*Optional*): Enable this to stop Home Assistant from importing the groups defined on the Trådfri bridge. Defaults to `true`.
<p class='note'>
Do not use the `api_key` variable. The key is only needed once at initial setup.
</p>

45
source/_components/tts.microsoft.markdown Normal file
View file

@ -0,0 +1,45 @@
---
layout: page
title: "Microsoft Text-to-Speech"
description: "Instructions how to setup Microsoft Text-to-Speech with Home Assistant."
date: 2017-10-23 11:00
sidebar: true
comments: false
sharing: true
footer: true
logo: microsoft.png
ha_category: Text-to-speech
ha_release: 0.57
---
The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This component uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API.
You will need an API key, which is free. You can use your [Azure subscription](https://azure.microsoft.com) or get an API key on the [Cognitive Services site](https://azure.microsoft.com/en-us/try/cognitive-services/).
To enable text-to-speech with Microsoft, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
tts:
- platform: microsoft
api_key: [YourAPIKey]
```
Configuration variables:
- **api_key** (*Required*): Your API key.
- **language** (*Optional*): The language to use. Defaults to `en-us`. Accepted values are listed in the documentation mentioned below.
- **gender** (*Optional*): The gender you would like to use for the voice. Accepted values are `Female` and `Male`. Defaults to `Female`
- **type** (*Optional*): The voice type you want to use. Accepted values are listed in the service name mapping [in the documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/Speech/api-reference-rest/bingvoiceoutput). Defaults to `ZiraRUS`
A full configuration sample including optional configuration variables:
```yaml
# Example configuration.yaml entry
tts:
- platform: microsoft
api_key: XXXXXXXXX
language: en-us
gender: male
type: BenjaminRUS
```

17
source/_components/wink.markdown
View file

@ -24,7 +24,7 @@ Home Assistant integrates with the Wink API and automatically sets up any switch
Check the related components pages for actual devices that are supported.
### Authenticate using [developer.wink.com](https://developer.wink.com)
### {% linkable_title Authenticate using [developer.wink.com](https://developer.wink.com) %}
You need to setup a developer account with Wink. This process can take a few days to get approved.
@ -44,20 +44,7 @@ When using the configurator make sure the initial setup is performed on the same
wink:
```
~~### Authentication with your Wink email and password.~~
~~This method pulls a new token on every startup of Home Assistant from this [URL](https://winkbearertoken.appspot.com)~~
```yaml
wink:
email: YOUR_WINK_EMAIL_ADDRESS
password: YOUR_WINK_PASSWORD
```
This is no longer working due to a recent change Wink made, and will be removed in the next release of Home Assistant. Please create a [developer.wink.com](https://developer.wink.com) account so you can keep using Wink!
### Full oauth authentication (legacy).
### {% linkable_title Full oauth authentication (legacy). %}
This should be used for users that obtained their client_id and client_secret via email from Wink support prior to [developer.wink.com's](https://developer.wink.com) existance.