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-16 22:15:30 -08:00
commit 5ab2ca280b
47 changed files with 469 additions and 157 deletions
Download patch file Download diff file Expand all files Collapse all files

9
source/_components/binary_sensor.digital_ocean.markdown
View file

@ -26,7 +26,10 @@ binary_sensor:
- 'coreos-512mb-nyc3-01'
```
Configuration variables:
- **droplets** (*Required*): List of droplets you want to control.
{% configuration %}
droplets:
description: List of droplets you want to monitor.
required: true
type: list
{% endconfiguration %}

10
source/_components/binary_sensor.iss.markdown
View file

@ -25,9 +25,13 @@ binary_sensor:
- platform: iss
```
Configuration variables:
- **show_on_map** (*Optional*): Option to show the position of the ISS on the map. Defaults to `False`.
{% configuration %}
show_on_map:
description: Option to show the position of the ISS on the map.
required: optionsl
default: false
type: string
{% endconfiguration %}
<p class='note warning'>
If you set `show_on_map` `True` then the location attributes are named `latitude` and `longitude`. The default name of the location attributes is `lat` and `long` to avoid showing them on the map.

8
source/_components/binary_sensor.random.markdown
View file

@ -25,10 +25,10 @@ binary_sensor:
```
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
name:
description: Name to use in the frontend.
required: false
type: string
{% endconfiguration %}
See the [entity component options](/docs/configuration/platform_options/) to control how often the main component polls the random binary sensor. The default is 30 seconds.

2
source/_components/device_tracker.snmp.markdown
View file

@ -19,7 +19,7 @@ A lot WiFi access points and WiFi routers support the Simple Network Management
This device tracker needs SNMP to be enabled on the router. It could be that you need to install the SNMP support manually.
</p>
OID examples:
The following OID examples pull the current MAC Address table from a router. This reflects all recent devices seen on the network. However, since devices are not removed until they time out, this is less effective for [device tracker component page](/components/device_tracker/) than desirable. It is recommended to use [Ping](/components/device_tracker.ping/) or [NMAP](/components/device_tracker.nmap_tracker/) instead.
| Brand | Device/Firmware | OID |
|---|---|---|---|

8
source/_components/digital_ocean.markdown
View file

@ -26,6 +26,10 @@ digital_ocean:
access_token: YOUR_API_KEY
```
Configuration variables:
{% configuration %}
access_token:
description: Your Digital Ocean API access token.
required: true
type: string
{% endconfiguration %}
- **access_token** (*Required*): Your Digital Ocean API access token.

2
source/_components/linode.markdown
View file

@ -13,7 +13,7 @@ ha_release: 0.57
ha_iot_class: "Cloud Polling"
---
The `linode` component allows you to access the information about your [Linode](https://www.linode.com) systems from Home Assistant.
The `linode` component allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant.
Obtain your oAuth2 Access Token from Linode account.
* <http://cloud.linode.com>

10
source/_components/lirc.markdown
View file

@ -26,9 +26,15 @@ To allow Home Assistant to talk to your IR receiver, you need to first make sure
$ sudo apt-get install lirc liblircclient-dev
```
<p class='note'>
If you are configuring on a Raspberry Pi, there are excellent instructions with GPIO schematics and driver configurations [here](http://alexba.in/blog/2013/01/06/setting-up-lirc-on-the-raspberrypi/). Consider following these.
If you are configuring on a Raspberry Pi, there are excellent instructions with GPIO schematics and driver configurations [here](http://alexba.in/blog/2013/01/06/setting-up-lirc-on-the-raspberrypi/). Take notice, the instructions in this blog are valid for Raspian Jesse where lirc 0.9.0 was included in the debian package. In Raspian Stretch lirc 0.9.4 is included in the Debian package.
The configuration is slightly different :
- The `hardware.conf` file is not supported, obsoleted by a new `lirc_options.conf` file and systemd unit definitions.
- The former single `lirc` service is replaced with the three systemd services `lircd.service`, `lircmd.service` and `irexec.service`. There is no counterpart to the 0.9.0 `lirc` service which covered all of these. Using a separate transmitter device requires yet another service.
- 0.9.4 defaults to using systemd for controlling the services. This is not just start/stop functionality, systemd is used to implement new features and to address shortcomings in 0.9.0. However, traditional systemV scripts are also installed and could be used although this is less tested and not really documented.
For more infomation have a look at `/usr/share/doc/lirc/README.Debian.gz` where the update process is explained when you have updated from jessie to stretch.
</p>
### {% linkable_title Configuring LIRC %}

1
source/_components/media_player.samsungtv.markdown
View file

@ -57,6 +57,7 @@ Currently known supported models:
- KS8005 (port must be set to 8001, and `pip3 install websocket-client` must be executed)
- KS7502 (port must be set to 8001, and `pip3 install websocket-client` must be executed, turn on doesn't work, turn off works fine)
- K5600AK (partially supported, turn on works but state is not updated)
- UE65KS8005 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button)
Currently tested but not working models:

2
source/_components/notify.telstra.markdown
View file

@ -15,7 +15,7 @@ ha_release: 0.31
The `telstra` notification platform allows you to deliver Home Assistant notifications to Australian phone numbers over the [Telstra SMS API](https://dev.telstra.com/content/sms-api-0).
To enable the Telstra notifications in your installation, you must first create an account and API app over at [dev.telstra.com](https://dev.telstra.com/). The free tier allows for 1000 notifications to be sent per month.
To enable the Telstra notifications in your installation, you must first create an account and API app over at [dev.telstra.com](https://dev.telstra.com/). The free tier allows for a maximum of 1000 free messages.
After your API app is approved, add the following to your `configuration.yaml` file:

79
source/_components/sensor.bitcoin.markdown
View file

@ -27,29 +27,58 @@ sensor:
- trade_volume_btc
```
Configuration variables:
- **currency** (*Optional*): The currency to exchange to, eg. CHF, USD, EUR, etc. Default is USD.
- **display_options** array (*Required*): Options to display in the frontend.
- **exchangerate**: Exchange rate of 1 BTC
- **trade_volume_btc**: Trade volume
- **miners_revenue_usd**: Miners revenue
- **btc_mined**: BTC mined
- **trade_volume_usd**: Trade volume in USD
- **difficulty**: Difficulty
- **minutes_between_blocks**: Time between blocks in minutes
- **number_of_transactions**: Number of transactions
- **hash_rate**: Hash rate in PH/s
- **timestamp**: Timestamp
- **mined_blocks**: Minded Blocks
- **blocks_size**: Block size
- **total_fees_btc**: Total fees in BTC
- **total_btc_sent**: Total sent in BTC
- **estimated_btc_sent**: Estimated sent in BTC
- **total_btc**: Total of BTC
- **total_blocks**: Total Blocks
- **next_retarget**: Next retarget
- **estimated_transaction_volume_usd**: Estimated transaction volume in BTC
- **miners_revenue_btc**: Miners revenue in BTC
- **market_price_usd**: Market price in USD
{% configuration %}
currency:
description: The currency to exchange to, eg. CHF, USD, EUR, etc.
required: false
type: string
default: USD
display_options:
description: Options to display in the frontend.
required: true
type: map
keys:
exchangerate:
description: Exchange rate of 1 BTC
trade_volume_btc:
description: Trade volume
miners_revenue_usd:
description: Miners revenue
btc_mined:
description: BTC mined
trade_volume_usd:
description: Trade volume in USD
difficulty:
description: Difficulty
minutes_between_blocks:
description: Time between blocks in minutes
number_of_transactions:
description: Number of transactions
hash_rate:
description: Hash rate in PH/s
timestamp:
description: Timestamp
mined_blocks:
description: Minded Blocks
blocks_size:
description: Block size
total_fees_btc:
description: Total fees in BTC
total_btc_sent:
description: Total sent in BTC
estimated_btc_sent:
description: Estimated sent in BTC
total_btc:
description: Total of BTC
total_blocks:
description: Total Blocks
next_retarget:
description: Next retarget
estimated_transaction_volume_usd:
description: Estimated transaction volume in BTC
miners_revenue_btc:
description: Miners revenue in BTC
market_price_usd:
description: Market price in USD
{% endconfiguration %}

9
source/_components/sensor.blockchain.markdown
View file

@ -27,7 +27,10 @@ sensor:
- '183J5pXWqYYsxZ7inTVw9tEpejDXyMFroe'
```
Configuration variables:
- **addresses** (*Required*): List of bitcoin wallet addresses to watch.
{% configuration %}
addresses:
description: List of bitcoin wallet addresses to watch.
required: true
type: string, list
{% endconfiguration %}

17
source/_components/sensor.coinmarketcap.markdown
View file

@ -24,7 +24,18 @@ sensor:
- platform: coinmarketcap
```
Configuration variables:
{% configuration %}
currency:
description: The cryptocurrency to use.
required: false
type: string, list
default: Bitcoin
display_currency:
description: The currency to display.
required: false
type: string, list
default: USD
{% endconfiguration %}
All supported currencies can be found [here](https://coinmarketcap.com/api/).
- **currency** (*Optional*): The cryptocurrency to use, eg. `bitcoin`, `litecoin`, `steem`, etc. Default is `bitcoin`.
- **display_currency** (*Optional*): The currency to display, eg. `USD`, `EUR`, `GBP`, etc. Default is `USD`. All supported currencies can be found [here](https://coinmarketcap.com/api/).

20
source/_components/sensor.currencylayer.markdown
View file

@ -31,8 +31,20 @@ sensor:
- INR
```
Configuration variables:
{% configuration %}
api_key:
description: "The API Key from [Currencylayer](https://currencylayer.com/)."
required: true
type: string
quote:
description: The symbol(s) of the quote or target currencies.
required: false
type: string, list
default: Exchange rate
base:
description: The symbol of the base currency.
required: false
type: string
default: USD
{% endconfiguration %}
- **api_key** (*Required*): API Key from [Currencylayer](https://currencylayer.com/).
- **base** (*Optional*): The symbol of the base currency. Defaults to USD.
- **quote** (*Required*): The symbol(s) of the quote or target currencies.

14
source/_components/sensor.etherscan.markdown
View file

@ -25,7 +25,15 @@ sensor:
address: '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'
```
Configuration variables:
{% configuration %}
address:
description: Ethereum wallet address to watch.
required: true
type: string
name:
description: The name of the sensor used in the frontend.
required: false
type: string
default: Ethereum Balance
{% endconfiguration %}
- **address** (*Required*): Ethereum wallet address to watch.
- **name** (*Optional*): The name of the sensor used in the frontend.

22
source/_components/sensor.fixer.markdown
View file

@ -27,9 +27,19 @@ sensor:
target: CHF
```
Configuration variables:
- **target** (*Required*): The symbol of the target currency.
- **name** (*Optional*): Name to use in the frontend.
- **base** (*Optional*): The symbol of the base currency. Default to USD
{% configuration %}
target:
description: The symbol of the target currency.
required: true
type: string
name:
description: Name to use in the frontend.
required: false
type: string
default: Exchange rate
base:
description: The symbol of the base currency.
required: false
type: string
default: USD
{% endconfiguration %}

25
source/_components/sensor.openexchangerates.markdown
View file

@ -28,9 +28,24 @@ sensor:
quote: EUR
```
Configuration variables:
{% configuration %}
name:
description: The name of the sensor.
required: false
type: string
default: Exchange Rate Sensor
api_key:
description: "The API Key for [Open Exchange Rates](https://openexchangerates.org)."
required: true
type: string
quote:
description: The symbol of the quote or target currency.
required: true
type: string
base:
description: The symbol of the base currency.
required: false
type: string
default: USD
{% endconfiguration %}
- **api_key** (*Required*): API Key for [Open Exchange Rates](https://openexchangerates.org).
- **quote** (*Required*): The symbol of the quote or target currency.
- **name** (*Optional*): Name to use in the frontend.
- **base** (*Optional*): The symbol of the base currency. Defaults to USD.

27
source/_components/sensor.random.markdown
View file

@ -24,12 +24,27 @@ sensor:
- platform: random
```
Configuration variables:
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Random Sensor`.
- **minimum** (*Optional*): Lower limit for the values. Defaults to `0`.
- **maximum** (*Optional*): Upper limit for the values. Defaults to `20`.
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: Random Sensor
minimum:
description: Lower limit for the values.
required: false
type: string
default: 0
maximum:
description: Upper limit for the values.
required: false
type: int
default: 20
unit_of_measurement:
description: Defines the units of measurement of the sensor, if any.
required: false
type: string
{% endconfiguration %}
See the [entity component options][entity-docs] to control how often the main component polls the random sensor. The default is 30 seconds.

14
source/_components/sensor.ripple.markdown
View file

@ -25,7 +25,15 @@ sensor:
address: 'r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV'
```
Configuration variables:
{% configuration %}
address:
description: Ripple wallet address to watch.
required: true
type: string
name:
description: Name for the sensor to use in the frontend.
required: false
type: string
default: Ripple Balance
{% endconfiguration %}
- **address** (*Required*): Ripple wallet address to watch
- **name** (*Optional*): Name for the sensor to use in the frontend.

16
source/_components/sensor.yahoo_finance.markdown
View file

@ -24,10 +24,18 @@ sensor:
- platform: yahoo_finance
```
Configuration variables:
- **name** (*Optional*): The name of the sensor. If not specified, it defaults to *Yahoo Stock*.
- **symbols** array (*Optional*): List of stock market symbols for given companies. If not specified, it defaults to *Yahoo (YHOO)*.
{% configuration %}
name:
description: The name of the sensor.
required: false
type: string
default: Yahoo Stock
symbols:
description: List of stock market symbols for given companies.
required: false
type: string, list
default: YHOO
{% endconfiguration %}
## {% linkable_title Examples %}

9
source/_components/switch.digital_ocean.markdown
View file

@ -26,7 +26,10 @@ switch:
- 'coreos-512mb-nyc3-01'
```
Configuration variables:
- **droplets** (*Required*): List of droplets you want to control.
{% configuration %}
droplets:
description: List of droplets you want to control.
required: true
type: list
{% endconfiguration %}

8
source/_components/switch.flux.markdown
View file

@ -16,9 +16,9 @@ The `flux` switch platform will change the temperature of your lights similar to
The component will update your lights based on the time of day. It will only affect lights that are turned on and listed in the flux configuration.
During the day (in between `start time` and `sunset time`), it will fade the lights from the `start_colortemp` to the `sunset_colortemp`. After sunset (between `sunset_time` and `stop_time`), the lights will fade from the `sunset_colortemp` to the `stop_colortemp`. If the lights are still on after the `stop_time` it will continue to change the light to the `stop_colortemp` until the light is turned off. The fade effect is created by updating the lights every 30 seconds with a 30 second transition time.
During the day (in between `start time` and `sunset time`), it will fade the lights from the `start_colortemp` to the `sunset_colortemp`. After sunset (between `sunset_time` and `stop_time`), the lights will fade from the `sunset_colortemp` to the `stop_colortemp`. If the lights are still on after the `stop_time` it will continue to change the light to the `stop_colortemp` until the light is turned off. The fade effect is created by updating the lights every periodically.
If you don't wish to have flux update on 30 second intervals, you can leave the switch turned off and use automation rules that call the service `switch.<name>_update` whenever you want the lights updated, where `<name>` equals the `name:` property in the switch configuration.
If you want to update at variable intervals, you can leave the switch turned off and use automation rules that call the service `switch.<name>_update` whenever you want the lights updated, where `<name>` equals the `name:` property in the switch configuration.
To use the Flux switch in your installation, add the following to your `configuration.yaml` file:
@ -43,6 +43,8 @@ Configuration variables:
- **brightness** (*Optional*): The brightness of the lights. Calculated with `RGB_to_xy` by default.
- **disable_brightness_adjust** (*Optional*): If true, brightness will not be adjusted besides color temperature. Defaults to False.
- **mode** (*Optional*): Select how color temperature is passed to lights. Valid values are `xy`, `mired` and `rgb`. Defaults to `xy`.
- **transition** (*Optional*): Transition time for the light changes (high values may not be supported by all light models). Defaults to 30.
- **interval** (*Optional*): Frequency at which the lights should be updated. Defaults to 30.
Full example:
@ -62,5 +64,7 @@ switch:
brightness: 200
disable_brightness_adjust: True
mode: xy
transition: 30
interval: 60
```

2
source/_components/vacuum.markdown
View file

@ -11,7 +11,7 @@ footer: true
The `vacuum` component enables the ability to control home cleaning robots within Home Assistant.
To use this component in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi/).
To use this component in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi_miio/).
```yaml
# Example configuration.yaml entry

2
source/_components/verisure.markdown
View file

@ -45,4 +45,4 @@ Configuration variables:
- **mouse** (*Optional*): Set to 1 to show mouse detectors, 0 to disable. Default 1.
- **door_window** (*Optional*): Set to 1 to show door and window sensors, 0 to disable. Default 1.
- **code_digits** (*Optional*): Number of digits in PIN code. Default 4.
- **giid** (*Optional*): The GIID of your installation (If you have more then one alarm system).

15
source/_components/weather.bom.markdown
View file

@ -22,10 +22,17 @@ weather:
- platform: bom
```
Configuration variables:
- **name** (*Optional*): The name you would like to give to the weather station.
- **station** (*Optional*): The station ID string; defaults to the closest station. See the [`sensor.bom` docs](/components/sensor.bom/) for details on how to find the ID of a station.
{% configuration %}
name:
description: The name you would like to give to the weather station.
required: optional
type: string
station:
description: "The station ID string. See the [`sensor.bom` docs](/components/sensor.bom/) for details on how to find the ID of a station."
required: optional
default: The closest station
type: string
{% endconfiguration %}
<p class='note'>
This platform is an alternative to the [`bom`](/components/sensor.bom/) sensor.