Merge branch 'current' into next
This commit is contained in:
Fabian Affolter
commit
ade302523b
22 changed files with 249 additions and 175 deletions
|
|
@ -68,10 +68,6 @@ axis:
|
|||
location: köket
|
||||
```
|
||||
|
||||
<p class='note'>
|
||||
If you are using Python 3.6, you might need to replace the 34m with 36m in the _gi.*.so filename in the gi folder.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
Any specific levels for triggers needs to be configured on the device.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ The following OID examples pull the current MAC Address table from a router. Thi
|
|||
| TP-Link | Archer VR600 | `1.3.6.1.2.1.3.1.1.2` |
|
||||
| EdgeRouter | Lite v1.9.0 | `1.3.6.1.2.1.4.22.1.2` |
|
||||
| Ruckus | ZoneDirector 9.13.3 | `1.3.6.1.4.1.25053.1.2.2.1.1.3.1.1.1.6` |
|
||||
| DD-WRT | unknown RouterOS version/model | `1.3.6.1.2.1.4.22.1.2` |
|
||||
|
||||
To use the SNMP version 1 platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ google_assistant:
|
|||
* *client_id* (Required): A long random URL safe string (no spaces or special characters) that will be used for Implicit OAuth.
|
||||
* *access_token* (Required): Another different long random URL safe string.
|
||||
* *agent_user_id* (Optional): A string to identify the user, e.g., email address. If not provided, the component will generate one.
|
||||
* *api_key* (Optional): An API Key generated for the project from Google Console which allows you to update devices without unlinking and relinking an account (see setup below). If not provided then the request_sync service is not exposed.
|
||||
* *api_key* (Optional): An API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see setup below). If not provided then the request_sync service is not exposed.
|
||||
* *exposed_domains* (Optional): An array of Home Assistant domains to expose to Google Assistant. Options include:
|
||||
- `switch`
|
||||
- `light`
|
||||
|
|
@ -128,7 +128,7 @@ homeassistant:
|
|||
3. Click `Add`, type the new user's e-mail address and choose `Project -> Editor` role
|
||||
4. Have the new user go to [developer console](https://console.actions.google.com/) and repeat steps starting from point 7.
|
||||
11. If you want to use the `google_assistant.request_sync` service in Home Assistant, then enable Homegraph API for your project:
|
||||
1. Go to https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview
|
||||
1. Go to the [cloud console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview)
|
||||
2. Select your project and click Enable Homegraph API
|
||||
3. Go to Credentials and select API Key from Create Credentials
|
||||
4. Note down the generated API Key and use this in the configuration
|
||||
|
|
|
|||
|
|
@ -64,6 +64,7 @@ Choose "Webhooks" as service.
|
|||
You need to setup a unique trigger for each event you sent to IFTTT.
|
||||
</p>
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml Automation entry
|
||||
automation:
|
||||
|
|
@ -75,9 +76,11 @@ automation:
|
|||
service: ifttt.trigger
|
||||
data: {"event":"TestHA_Trigger", "value1":"Hello World!"}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
IFTTT can also be used in scripts and with `data_template`. Here is the above automation broken into an automation and script using variables and data_templates.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml Automation entry
|
||||
automation:
|
||||
|
|
@ -89,10 +92,12 @@ automation:
|
|||
service: script.ifttt_notify
|
||||
data_template:
|
||||
value1: 'HA Status:'
|
||||
value2: {% raw %}"{{ trigger.event.data.entity_id.split('_')[1] }} is "{% endraw %}
|
||||
value3: {% raw %}"{{ trigger.event.data.to_state.state }}"{% endraw %}
|
||||
value2: "{{ trigger.event.data.entity_id.split('_')[1] }} is "
|
||||
value3: "{{ trigger.event.data.to_state.state }}"
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
#Example Script to send TestHA_Trigger to IFTTT but with some other data (homeassistant UP).
|
||||
ifttt_notify:
|
||||
|
|
@ -100,6 +105,7 @@ ifttt_notify:
|
|||
- service: ifttt.trigger
|
||||
data_template: {"event":"TestHA_Trigger", "value1":"{{ value1 }}", "value2":"{{ value2 }}", "value3":"{{ value3 }}"}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Sending events from IFTTT to Home Assistant %}
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,9 @@ footer: true
|
|||
ha_category: "History"
|
||||
---
|
||||
|
||||
The `logentries` component makes it possible to log all state changes to [your Logentries account](http://logentries.com/) using Logentries Webhook endpoint and a token based log
|
||||
The `logentries` component makes it possible to log all state changes to [Logentries](http://logentries.com/) using Logentries Webhook endpoint.
|
||||
|
||||
Open the **Add a Log** page and choose **Manual**. Enter a name for your log in **Log Name**, add a group in **Select Log Set**, set **Token TCP - logs are identified by a token.** and press **Create Log Token**. The generated token is required for the Home Assistant configuration.
|
||||
|
||||
To use the `logentries` component in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -21,6 +23,10 @@ logentries:
|
|||
token: TOKEN
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
token:
|
||||
description: The token for the log to use.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
- **token** (*Required*): Your Logentries log token.
|
||||
|
|
|
|||
|
|
@ -21,14 +21,14 @@ To enable this platform, add the following lines to your `configuration.yaml` fi
|
|||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: html5
|
||||
gcm_api_key: 'gcm-sender-key'
|
||||
gcm_api_key: 'gcm-server-key'
|
||||
gcm_sender_id: 'gcm-sender-id'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **gcm_api_key** (*Required if pushing to Chrome*): The API key provided to you by Google for Google Cloud Messaging (GCM). Required to push to Chrome.
|
||||
- **gcm_api_key** (*Required if pushing to Chrome*): The API Server key provided to you by Google for Google Cloud Messaging (GCM). Required to push to Chrome.
|
||||
- **gcm_sender_id** (*Required if pushing to Chrome*): The sender ID provided to you by Google for Google Cloud Messaging (GCM). Required to push to Chrome.
|
||||
|
||||
### {% linkable_title Getting ready for Chrome %}
|
||||
|
|
@ -42,7 +42,7 @@ Configuration variables:
|
|||
#### {% linkable_title Verify your domain with Hass.io %}
|
||||
|
||||
1. For verifying your domain you need to download a file in step 2.
|
||||
2. Create a dictionary named "www" in you Hass.io configuration dictionary.
|
||||
2. Create a dictionary named "www" in you Hass.io configuration directory.
|
||||
3. Place the file (something like this: google*.html) in the "www" directory.
|
||||
4. You can open it by going to **https://yourdomain/local/exact_file_name.html**
|
||||
5. Proceed with step 3.
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ The `rss_feed_template` component can export any information from Home Assistant
|
|||
For example, on Android, the app "Simple RSS Widget" can be used to display temperatures on the home screen.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
# Example configuration.yaml entry
|
||||
rss_feed_template:
|
||||
# Accessible on <home assistant url>/api/rss_template/garden
|
||||
# Example: https://localhost:8123/api/rss_template/garden
|
||||
|
|
|
|||
|
|
@ -14,6 +14,10 @@ featured: false
|
|||
ha_release: 0.29
|
||||
---
|
||||
|
||||
<p class='note warning'>
|
||||
This sensor doesn't work anymore as [Yahoo!](https://yahoo.uservoice.com/forums/382977-finance/suggestions/32103877-yahoo-stock-quote-api-please-bring-back) decommissioned the service in early November 2017.
|
||||
</p>
|
||||
|
||||
The `yahoo_finance` platform uses [Yahoo Finance](https://finance.yahoo.com/) to monitor the stock market.
|
||||
|
||||
To enable the `yahoo_finance` platform, add the following lines to your `configuration.yaml` file:
|
||||
|
|
|
|||
|
|
@ -53,3 +53,20 @@ or change its state:
|
|||
$ curl -G -X GET http://IP_ADDRESS/relay -d 'state=1'
|
||||
```
|
||||
|
||||
### {% linkable_title Get the current power consumption %}
|
||||
|
||||
The switch is measuring the current power consumption. To expose this as a sensor use a [`template` sensor](/components/sensor.template/).
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: template
|
||||
sensors:
|
||||
power:
|
||||
friendly_name: "Current Power"
|
||||
unit_of_measurement: "W"
|
||||
value_template: "{{ states.switch.office.attributes.current_power_w }}"
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
|
|
|||
|
|
@ -13,25 +13,18 @@ featured: false
|
|||
ha_release: 0.11
|
||||
---
|
||||
|
||||
The `tellduslive` component let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick connected gear at home.
|
||||
The `tellduslive` component let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home.
|
||||
|
||||
To get started using Telldus Live, you will have to obtain developer keys from the [developer page](https://api.telldus.com/keys/index).
|
||||
|
||||
To integrate your Telldus Live with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) component is enabled. To manually integrate your Telldus Live with Home Assistant, e.g. if your device is on another network or in another location, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
tellduslive:
|
||||
public_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||
private_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||
token: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||
token_secret: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **public_key** (*Required*): The public key for the Telldus Live service.
|
||||
- **private_key** (*Required*): The private key for the Telldus Live service.
|
||||
- **token** (*Required*): The token for the Telldus Live service.
|
||||
- **token_secret** (*Required*): The token secret for the Telldus Live service.
|
||||
- **host** (*Optional*): Host address to Tellstick Net or Tellstick ZNet for Local API, only useful when automatic discovery is not enabled.
|
||||
- **update_interval** (*Optional*): Interval (in seconds) for polling the Telldus Live server (or the local server).
|
||||
|
||||
The component will offer configuration through the Home Assistant user interface where it will let you associate it with your Telldus Live account.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
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
|
||||
date: 2017-11-07 12:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
|
|
@ -27,10 +27,13 @@ tts:
|
|||
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.
|
||||
- **language** (*Optional*): The language to use. Defaults to `en-us`. Accepted values are listed in the documentation mentioned below. Note that if you set the language to anything other than the default of `en-us`, you will need to specify a matching voice type as well.
|
||||
- **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`
|
||||
|
||||
- **rate** (*Optional*): Change the rate of speaking. Example values: `-25%`, `+50%`. Defaults to `+0%` (no change)
|
||||
- **volume** (*Optional*): Change the volume of the output. Example values: `-20%`, `+70%`. Defaults to `+0%` (no change)
|
||||
- **pitch** (*Optional*): Change the pitch of the output. Example values: `high`. Defaults to `default` (no change)
|
||||
- **contour** (*Optional*): Change the contour of the output. This overrides the pitch setting. See the [W3 SSML specification](http://www.w3.org/TR/speech-synthesis/#pitch_contour) for what it does. Example value: `(0%,+0%) (100%,+100%)`
|
||||
|
||||
A full configuration sample including optional configuration variables:
|
||||
|
||||
|
|
@ -39,7 +42,11 @@ A full configuration sample including optional configuration variables:
|
|||
tts:
|
||||
- platform: microsoft
|
||||
api_key: XXXXXXXXX
|
||||
language: en-us
|
||||
gender: male
|
||||
type: BenjaminRUS
|
||||
language: en-gb
|
||||
gender: Male
|
||||
type: George, Apollo
|
||||
rate: +20%
|
||||
volume: -50%
|
||||
pitch: high
|
||||
contour: (0%, +0%) (100%, +100%)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ To enable {{ page.title }} in your installation, add the following to your `conf
|
|||
### {% linkable_title One Gateway %}
|
||||
|
||||
```yaml
|
||||
# You can leave mac empty if you only have one gateway.
|
||||
# You can leave MAC empty if you only have one gateway.
|
||||
xiaomi_aqara:
|
||||
discovery_retry: 5
|
||||
gateways:
|
||||
|
|
@ -66,7 +66,7 @@ xiaomi_aqara:
|
|||
### {% linkable_title Multiple Gateways %}
|
||||
|
||||
```yaml
|
||||
# 12 characters mac can be obtained from the gateway.
|
||||
# 12 characters MAC can be obtained from the gateway.
|
||||
xiaomi_aqara:
|
||||
gateways:
|
||||
- mac: xxxxxxxxxxxx
|
||||
|
|
@ -106,7 +106,7 @@ xiaomi_aqara:
|
|||
type: string
|
||||
default: any
|
||||
host:
|
||||
description: The host / ip address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
|
||||
description: The host/IP address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
|
@ -115,7 +115,7 @@ xiaomi_aqara:
|
|||
|
||||
The gateway provides the following services:
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.play_ringtone %}
|
||||
#### {% linkable_title Service `xiaomi_aqara.play_ringtone` %}
|
||||
|
||||
Play a specific ringtone. The version of the gateway firmware must be `1.4.1_145` at least. Take a look at the examples below.
|
||||
|
||||
|
|
@ -155,7 +155,7 @@ Allowed values of the `ringtone_id` are:
|
|||
- 29 - Thinker
|
||||
- Custom ringtones (uploaded by the Mi Home app) starting from 10001
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.stop_ringtone %}
|
||||
#### {% linkable_title Service `xiaomi_aqara.stop_ringtone` %}
|
||||
|
||||
Stops a playing ringtone immediately.
|
||||
|
||||
|
|
@ -163,13 +163,13 @@ Stops a playing ringtone immediately.
|
|||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.add_device %}
|
||||
#### {% linkable_title Service `xiaomi_aqara.add_device` %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.add_device %}
|
||||
#### {% linkable_title Service `xiaomi_aqara.add_device` %}
|
||||
|
||||
Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new device can be added afterwards by pressing the pairing button once.
|
||||
|
||||
|
|
@ -177,7 +177,7 @@ Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new de
|
|||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.remove_device %}
|
||||
#### {% linkable_title Service `xiaomi_aqara.remove_device` %}
|
||||
|
||||
Removes a specific device. The removal is required if a device shall be paired with another gateway.
|
||||
|
||||
|
|
@ -190,7 +190,7 @@ Removes a specific device. The removal is required if a device shall be paired w
|
|||
|
||||
### {% linkable_title Long Press on Smart Button %}
|
||||
|
||||
This example plays the sound of a dog barking when the button is held down, and stops the sound when the button is pressed once.
|
||||
This example plays the sound of a dog barking when the button is held down and stops the sound when the button is pressed once.
|
||||
|
||||
*Note: The sound will stop playing automatically when it has ended.*
|
||||
|
||||
|
|
@ -226,7 +226,7 @@ This example plays the sound of a dog barking when the button is held down, and
|
|||
|
||||
### {% linkable_title Initial setup problem %}
|
||||
|
||||
If you run into trouble initializing the gateway with your app, try another smartphone. I had trouble with the OnePlus 3, but it worked with a Nexus 5.
|
||||
If you run into trouble initializing the gateway with your app, try another smartphone. E.g., it didn't work on an OnePlus 3, but it worked with a Nexus 5.
|
||||
|
||||
### {% linkable_title Connection problem %}
|
||||
|
||||
|
|
@ -238,11 +238,12 @@ If you run into trouble initializing the gateway with your app, try another smar
|
|||
That means that Home Assistant is not getting any response from your Xiaomi gateway. Might be a local network problem or your firewall.
|
||||
- Make sure you have [enabled LAN access](https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)#Adding_the_Xiaomi_Gateway_to_Domoticz).
|
||||
- Turn off the firewall on the system where Home Assistant is running.
|
||||
- Ensure your router supports multicast as this is a requirement of the Xiaomi GW
|
||||
- Ensure your router supports multicast as this is a requirement of the Xiaomi Gateway.
|
||||
- Try to leave the MAC address `mac:` blank.
|
||||
- Try to set `discovery_retry: 10`.
|
||||
- Try to disable and then enable LAN access.
|
||||
- Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch.
|
||||
- If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`.
|
||||
- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternativly an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application.
|
||||
- If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g. `sudo apt-get install python3-dev libssl-dev libffi-dev`).
|
||||
- If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`).
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue