jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Various things - t (#7020)

Browse Source 
Add missing titles
Remove trailing spaces
Fix grammar
 - login -> log in
 - show how a entry -> shows how an entry
Mention default and minimal value (telldus) or link to add-on which is mentioned (tellstick)
This commit is contained in:
Jorim Tielemans 2018-10-23 11:09:36 +02:00 committed by Fabian Affolter
parent c0d8b1fbf0
commit ac4baf0a8d
21 changed files with 109 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_components/tado.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `tado` component platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. It adds climate devices for every tado zone and sensors for some additional information of the zones.
## {% linkable_title Configuration %}
To use your tado thermostats in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -26,11 +28,11 @@ tado:
{% configuration %}
username:
description: Username for my.tado.com.
description: Your username for my.tado.com.
required: true
type: string
password:
description: Password for my.tado.com.
description: Your password for my.tado.com.
required: true
type: string
{% endconfiguration %}

9
source/_components/tahoma.markdown
View File

@ -13,9 +13,10 @@ ha_release: 0.59
ha_iot_class: "Cloud Polling"
---
The `Tahoma` component platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform.
## {% linkable_title Configuration %}
To use your Tahoma devices in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -28,15 +29,15 @@ tahoma:
{% configuration %}
username:
description: Username for tahomalink.com
description: Your username for tahomalink.com.
required: true
type: string
password:
description: Password for tahomalink.com
description: Your password for tahomalink.com.
required: true
type: string
exclude:
description: Excludes devices
description: List of devices to exclude.
required: false
type: list
{% endconfiguration %}

13
source/_components/telegram_bot.broadcast.markdown
View File

@ -14,11 +14,12 @@ ha_release: 0.48
Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the Internet and there is no polling to receive messages sent to the bot.
## {% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
telegram_bot:
- platform: broadcast
api_key: YOUR_API_KEY
@ -29,7 +30,7 @@ telegram_bot:
{% configuration %}
allowed_chat_ids:
description: A list of user in the `user_id` Telegram format enabled to interact to webhook
description: A list of users in the `user_id` Telegram format that are authorized to interact with the webhook.
required: true
type: list
api_key:
@ -37,16 +38,16 @@ api_key:
required: true
type: string
parse_mode:
description: "Default parser for messages if not explicit in message data: 'html' or 'markdown'."
description: Default parser for messages if not explicit in message data, either `html` or `markdown`.
required: false
default: markdown
type: string
default: "`markdown`"
proxy_url:
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`)
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`).
required: false
type: string
proxy_params:
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.)
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
required: false
type: string
{% endconfiguration %}

13
source/_components/telegram_bot.polling.markdown
View File

@ -16,11 +16,12 @@ Telegram chatbot polling implementation.
One of two bot implementations supported by Telegram. Your Home Assistant does not have to be exposed to the internet.
## {% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
telegram_bot:
- platform: polling
api_key: YOUR_API_KEY
@ -31,7 +32,7 @@ telegram_bot:
{% configuration %}
allowed_chat_ids:
description: A list of user in the `user_id` Telegram format enabled to interact to webhook
description: A list of users in the `user_id` Telegram format that are authorized to interact with the webhook.
required: true
type: list
api_key:
@ -39,16 +40,16 @@ api_key:
required: true
type: string
parse_mode:
description: "Default parser for messages if not explicit in message data: 'html' or 'markdown'."
description: Default parser for messages if not explicit in message data, either `html` or `markdown`.
required: false
default: markdown
type: string
default: "`markdown`"
proxy_url:
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`)
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`).
required: false
type: string
proxy_params:
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.)
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
required: false
type: string
{% endconfiguration %}

22
source/_components/telegram_bot.webhooks.markdown
View File

@ -18,6 +18,8 @@ Using Telegrams `setWebhook` method your bot's webhook URL should be set to `htt
This is one of two bot implementations supported by Telegram. Described by Telegram as the preferred implementation but requires your Home Assistant instance to be exposed to the internet.
## {% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
@ -43,33 +45,35 @@ api_key:
description: The API token of your bot.
required: true
type: string
trusted_networks:
description: Telegram server access ACL as list.
required: false
default: 149.154.167.197-233
type: string
parse_mode:
description: "Default parser for messages if not explicit in message data: 'html' or 'markdown'."
description: Default parser for messages if not explicit in message data, either `html` or `markdown`.
required: false
default: markdown
type: string
proxy_url:
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`)
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`).
required: false
type: string
proxy_params:
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.)
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
required: false
type: string
url:
description: Allow to overwrite the `base_url` from the [`http`](/components/http/) component for different configurations (`https://<public_url>:<port>`).
required: false
type: string
trusted_networks:
description: Telegram server access ACL as list.
required: false
type: string
default: 149.154.167.197-233
{% endconfiguration %}
To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram). As well as authorizing the chat, if you have added your bot to a group you will also need to authorize any user that will be interacting with the webhook. When an unauthorized user tries to interact with the webhook Home Assistant will raise an error ("Incoming message is not allowed"), you can easily obtain the users id by looking in the "from" section of this error message.
Full configuration sample:
## {% linkable_title Full configuration example %}
The configuration sample below shows how an entry can look like:
```yaml
# Example configuration.yaml entry

6
source/_components/tellduslive.markdown
View File

@ -21,6 +21,8 @@ If you are upgrading from 0.58 or older, you need to remove all Telldus configur
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. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API.
## {% linkable_title Configuration %}
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
@ -34,10 +36,10 @@ host:
required: false
type: string
update_interval:
description: Interval (in seconds) for polling the Telldus Live server (or the local server).
description: Interval (in seconds) for polling the Telldus Live server (or the local server). Minimal value can't be less then 300.
required: false
default: 60
type: integer
default: 60
{% endconfiguration %}
The component will offer configuration through the Home Assistant user interface where it will let you associate it with your Telldus Live account.

4
source/_components/tellstick.markdown
View File

@ -11,7 +11,6 @@ logo: telldus_tellstick.png
ha_category: Hub
---
The `tellstick` component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf).
## {% linkable_title Configuration %}
@ -23,6 +22,8 @@ To get started, add the devices to your `configuration.yaml` file.
tellstick:
```
For Hass.io users there is a [TellStick add-on](/addons/tellstick/) available.
```yaml
# Example configuration.yaml entry for Hass.io with the TellStick add-on
tellstick:
@ -35,6 +36,7 @@ signal_repetitions:
description: Because the TellStick sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch and light to try to send each signal repeatedly.
required: false
type: integer
default: 1
host:
description: If you run TellStick on another server or with the Hass.io add-on.
required: inclusive

5
source/_components/tesla.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.53
ha_iot_class: "Cloud Polling"
---
The `Tesla` component offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature.
This component provides the following platforms:
@ -24,6 +23,8 @@ This component provides the following platforms:
- Climate - HVAC control. Allow you to control (turn on/off, set target temperature) your Tesla's HVAC system.
- Switch - Charger and max range switch. Allow you to start/stop charging and set max range charging.
## {% linkable_title Configuration %}
To use Tesla in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -45,6 +46,6 @@ password:
scan_interval:
description: API polling interval. Minimal value can't be less then 300.
required: false
default: 300
type: integer
default: 300
{% endconfiguration %}

21
source/_components/thethingsnetwork.markdown
View File

@ -23,7 +23,7 @@ The Things network support various integrations to make the data available:
| [Storage](https://www.thethingsnetwork.org/docs/applications/storage/) | [`thethingsnetwork`](/components/sensor.thethingsnetwork/) |
| [HTTP](https://www.thethingsnetwork.org/docs/applications/http/) | |
### {% linkable_title Setup %}
## {% linkable_title Setup %}
Visit the [The Things Network Console](https://console.thethingsnetwork.org/) website, log in with your The Things Network credentials, choose your application from **Applications**.
@ -41,6 +41,8 @@ You need an access key to be able to read the data from your application.
Access keys
</p>
## {% linkable_title Configuration %}
To enable this component, add the following lines to your `configuration.yaml`:
```yaml
@ -51,13 +53,12 @@ thethingsnetwork:
```
{% configuration %}
app_id:
description: The Application ID.
required: true
type: string
access_key:
description: The access key.
required: true
type: string
app_id:
description: The Application ID.
required: true
type: string
access_key:
description: The access key.
required: true
type: string
{% endconfiguration %}

2
source/_components/thingspeak.markdown
View File

@ -15,6 +15,8 @@ ha_release: 0.32
The `thingspeak` components makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/).
For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB component](/components/influxdb/).
## {% linkable_title Configuration %}
You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use.
To setup the ThingSpeak component in your installation, add the following to your `configuration.yaml` file:

9
source/_components/tibber.markdown
View File

@ -14,7 +14,6 @@ ha_qa_scale: silver
ha_iot_class: "Cloud Polling"
---
The `tibber` component provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer.
If you have a Tibber Pulse it will also show the electricity consumption in real time.
@ -34,8 +33,8 @@ tibber:
```
{% configuration %}
access_token:
description: Your Tibber API token.
required: true
type: string
access_token:
description: Your Tibber API token.
required: true
type: string
{% endconfiguration %}

6
source/_components/toon.markdown
View File

@ -17,6 +17,8 @@ The `toon` component platform can be used to control your Toon thermostat. This
For the `toon` component to work, you'll need an active Toon subscription with Eneco. The component uses your Mijn Eneco credentials to control your thermostat through the [toonopafstand](https://toonopafstand.eneco.nl) domain.
## {% linkable_title Configuration %}
To use your Toon thermostat in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -38,13 +40,13 @@ password:
gas:
description: With this option you can choose whether you want to measure gas consumption.
required: false
default: true
type: boolean
default: true
solar:
description: With this option you can choose whether you want to measure electricity production.
required: false
default: false
type: boolean
default: false
{% endconfiguration %}
Toon is a smart thermostat delivered by the Eneco power company in The Netherlands. It can measure energy consumption (power and gas), but also the amount of energy generated in case solar panels are connected to it. Toon also acts as a z-wave hub for supported devices like the wall plug and the smoke detector. This component uses the [toonlib library](https://github.com/costastf/toonlib) by Costas Tyfoxylos that connects to the unofficial API on [https://toonopafstand.eneco.nl](https://toonopafstand.eneco.nl).

2
source/_components/tradfri.markdown
View File

@ -44,7 +44,6 @@ allow_tradfri_groups:
default: false
{% endconfiguration %}
## {% linkable_title Troubleshooting %}
### {% linkable_title Firmware updates %}
@ -58,4 +57,3 @@ Please make sure you have `autoconf` installed (`$ sudo apt-get install autoconf
### {% linkable_title Setting the `api_key` %}
Do not use the `api_key` variable in `configuration.yaml`. The API key is only needed once at initial setup and will be stored.

1
source/_components/tts.amazon_polly.markdown
View File

@ -68,7 +68,6 @@ sample_rate:
type: string
{% endconfiguration %}
## {% linkable_title Usage %}
Say to all `media_player` device entities:

5
source/_components/tts.baidu.markdown
View File

@ -14,6 +14,8 @@ ha_release: 0.59
The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices.
## {% linkable_title Configuration %}
To get started, add the following lines to your `configuration.yaml`:
```yaml
@ -54,9 +56,10 @@ volume:
type: integer
default: 5
person:
description: Voice type. You choose one from 0, 1, 3 or 4.
description: The voice type. You choose one from 0, 1, 3 or 4.
required: false
type: integer
default: 0
{% endconfiguration %}
At the moment, `zh` is the only supported language and therefore the default value.

19
source/_components/tts.microsoft.markdown
View File

@ -13,7 +13,9 @@ 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/).
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/).
## {% linkable_title Configuration %}
To enable text-to-speech with Microsoft, add the following lines to your `configuration.yaml`:
@ -32,39 +34,42 @@ api_key:
language:
description: The language to use. Accepted values are listed in the documentation mentioned below. Note that if you set the language to anything other than the default, you will need to specify a matching voice type as well.
required: false
default: "`en-us`"
type: string
default: "`en-us`"
gender:
description: The gender you would like to use for the voice. Accepted values are `Female` and `Male`.
required: false
default: "`Female`"
type: string
default: "`Female`"
type:
description: "The voice type you want to use. Accepted values are listed as the service name mapping [in the documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/Speech/api-reference-rest/bingvoiceoutput)."
required: false
default: "`ZiraRUS`"
type: string
default: "`ZiraRUS`"
rate:
description: "Change the rate of speaking in percentage. Example values: `25`, `50`."
required: false
default: 0
type: integer
default: 0
volume:
description: "Change the volume of the output in percentage. Example values: `-20`, `70`."
required: false
default: 0
type: integer
default: 0
pitch:
description: "Change the pitch of the output. Example values: `high`."
required: false
default: "`default`"
type: string
default: "`default`"
contour:
description: "Change the contour of the output in percentages. 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)`."
required: false
type: string
{% endconfiguration %}
## {% linkable_title Full configuration example %}
A full configuration sample including optional variables:
```yaml

10
source/_components/tts.picotts.markdown
View File

@ -16,6 +16,8 @@ The `picotts` text-to-speech platform uses offline pico Text-to-Speech engine to
This requires to install the pico tts library on the system, typically on debian just do `sudo apt-get install libttspico-utils`
On some Raspbian release, this package is missing but you can just copy the arm deb package from debian.
## {% linkable_title Configuration %}
To enable text-to-speech with Pico, add the following lines to your `configuration.yaml`:
```yaml
@ -26,13 +28,15 @@ tts:
{% configuration %}
language:
description: "The language to use. Supported languages : 'en-US', 'en-GB', 'de-DE', 'es-ES', 'fr-FR', 'it-IT'"
description: "The language to use. Supported languages are `en-US`, `en-GB`, `de-DE`, `es-ES`, `fr-FR` and `it-IT`."
required: false
default: "`en-US`"
type: string
default: "`en-US`"
{% endconfiguration %}
A full configuration sample:
## {% linkable_title Full configuration example %}
The configuration sample below shows how an entry can look like:
```yaml
# Example configuration.yaml entry

10
source/_components/tts.voicerss.markdown
View File

@ -33,25 +33,25 @@ api_key:
language:
description: The language to use.
required: false
default: "`en-us`"
type: string
default: "`en-us`"
codec:
description: The audio codec.
required: false
default: mp3
type: string
default: mp3
format:
description: The audio sample format.
required: false
default: 8khz_8bit_mono
type: string
default: 8khz_8bit_mono
{% endconfiguration %}
Check the [VoiceRSS API documentation](http://www.voicerss.org/api/documentation.aspx) for allow values.
Check the [VoiceRSS API documentation](http://www.voicerss.org/api/documentation.aspx) for allowed values.
## {% linkable_title Full configuration example %}
The configuration sample below show how a entry can look like:
The configuration sample below shows how an entry can look like:
```yaml
# Example configuration.yaml entry

18
source/_components/tts.yandextts.markdown
View File

@ -31,37 +31,37 @@ api_key:
required: true
type: string
language:
description: "The language to use. Supported `en-US`, `ru-RU`, `uk-UK`, `tr-TR`."
description: "The language to use. Supported languages are `en-US`, `ru-RU`, `uk-UK` and `tr-TR`."
required: false
type: string
default: "`en-US`"
type: string
codec:
description: "The audio codec. Supported us `mp3`, `wav`, `opus`."
description: "The audio codec. Supported codecs are `mp3`, `wav` and `opus`."
required: false
default: "`mp3`"
type: string
default: "`mp3`"
voice:
description: "The speaker voice. Supported female voices are `jane`, `oksana`, `alyss`, `omazh` and male voices are `zahar` and `ermil`."
required: false
type: string
default: "`zahar`"
type: string
emotion:
description: "The speaker emotional intonation. Also supported are `good` (friendly) and `evil` (angry)"
description: "The speaker emotional intonation. Supported emotions are `good` (friendly), `evil` (angry) and `neutral`"
required: false
default: "`neutral`"
type: string
default: "`neutral`"
speed:
description: The speech speed. Highest speed is `3` and lowest `0,1`
required: false
default: "`1`"
type: float
default: "`1`"
{% endconfiguration %}
Please check the [API documentation](https://tech.yandex.com/speechkit/cloud/doc/guide/concepts/tts-http-request-docpage/) for details. It seems that the English version of documentation is outdated. You could request an API key [by email](https://tech.yandex.com/speechkit/cloud/) or [online](https://developer.tech.yandex.ru/).
## {% linkable_title Full configuration example %}
The configuration sample below show how a entry can look like:
The configuration sample below shows how an entry can look like:
```yaml
# Example configuration.yaml entry

6
source/_components/tuya.markdown
View File

@ -28,15 +28,15 @@ tuya:
{% configuration %}
username:
description: Your username to login to Tuya. This may be your phone number.
description: Your username to log in to Tuya. This may be your phone number.
required: true
type: string
password:
description: Your password to login to Tuya.
description: Your password to log in to Tuya.
required: true
type: string
country_code:
description: "Your account [country code](https://www.countrycode.org/) (e.g., 1 for USA or 86 for China)."
description: "Your account [country code](https://www.countrycode.org/), e.g., 1 for USA or 86 for China."
required: true
type: string
platform:

2
source/_components/twilio.markdown
View File

@ -17,6 +17,8 @@ The `twilio` component enables the sending of notifications via SMS and the crea
Free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers.
Calls are limited to 10 minutes and will play a short trial message before your message runs. Upgraded accounts have no limitation.
## {% linkable_title Configuration %}
To use this notification component in your installation, add the following to your `configuration.yaml` file:
```yaml