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

Merge pull request #250 from balloob/master

Browse source 
Keeping next up to date with latest changes
This commit is contained in:
Paulus Schoutsen 2016-02-22 22:25:16 -08:00
commit 6f8b525cb8
52 changed files with 870 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

4
source/_components/binary_sensor.rest.markdown
View file

@ -17,7 +17,7 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
```yaml
# Example configuration.yaml entry
sensor:
binary_sensor:
platform: rest
resource: http://IP_ADDRESS/ENDPOINT
method: GET
@ -29,7 +29,7 @@ or for a POST request:
```yaml
# Example configuration.yaml entry
sensor:
binary_sensor:
platform: rest
resource: http://IP_ADDRESS/ENDPOINT
method: POST

2
source/_components/browser.markdown
View file

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: browser.png
logo: home-assistant.png
ha_category: Other
---

2
source/_components/camera.uvc.markdown
View file

@ -27,7 +27,7 @@ camera:
Configuration variables:
- **nvr** *Optional*: The IP or hostname of the NVR (Network Video Recorder) server.
- **nvr** *Required**: The IP or hostname of the NVR (Network Video Recorder) server.
- **port** *Optional*: The port number to use for accessing the NVR.
- **key** *Required*: The API key available from the NVR web interface.

2
source/_components/conversation.markdown
View file

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: conversation.png
logo: home-assistant.png
ha_category: "Voice"
---

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

@ -15,7 +15,7 @@ ha_category: Presence Detection
The `fritz` platform offers presence detection by looking at connected devices to a [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) based router.
<p class='note warning'>
It might be necessary to install additional packages: <code>$ sudo apt-get install libxslt-dev libxml2-dev</code>
It might be necessary to install additional packages: <code>$ sudo apt-get install libxslt-dev libxml2-dev python3-lxml</code>
</p>
To use an Fritz!Box router in your installation, add the following to your `configuration.yaml` file:

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

@ -14,7 +14,7 @@ ha_category: Presence Detection
The `icloud` platform allows you to detect presence using the [iCloud](https://www.icloud.com/) service. iCloud allows users to track their location on iOS devices.
It does require that your device has beend registered with "Find My iPhone".
It does require that your device is registered with "Find My iPhone".
To integrate iCloud in Home Assistant, add the following section to your `configuration.yaml` file:

2
source/_components/downloader.markdown
View file

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: downloader.png
logo: home-assistant.png
ha_category: Other
---

2
source/_components/garage_door.wink.markdown
View file

@ -14,5 +14,5 @@ ha_category: Garage Door
The Wink garage door platform allows you to control your [Wink](http://www.wink.com/) enabled garage door.
The requirement is that you have setup your [Wink hub](/components/light.wink/).
The requirement is that you have setup your [Wink hub](/components/wink/).

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

@ -24,5 +24,5 @@ light:
Configuration variables:
- **server** (*Optional*): Your server address. Only needed if using more than one network interface. Omit if you are unsure.
- **consumer_secret** (*Optional*): The broadcast address, set to reach all LIFX bulbs.
- **broadcast** (*Optional*): The broadcast address, set to reach all LIFX bulbs.

24
source/_components/light.mysensors.markdown
View file

@ -2,7 +2,7 @@
layout: page
title: "MySensors Light"
description: "Instructions how to integrate MySensors lights into Home Assistant."
date: 2016-01-17 15:49
date: 2016-02-15 17:37 +0100
sidebar: true
comments: false
sharing: true
@ -13,3 +13,25 @@ featured: false
---
Integrates MySensors lights into Home Assistant. See the [main component] for configuration instructions.
The following actuator types are supported:
##### MySensors version 1.4 and higher
S_TYPE | V_TYPE
---------|--------------
S_LIGHT | V_LIGHT
S_DIMMER | V_DIMMER
##### MySensors version 1.5 and higher
S_TYPE | V_TYPE
------------|-------------
S_LIGHT | V_STATUS
S_DIMMER | V_PERCENTAGE
S_RGB_LIGHT | V_RGB
For more information, visit the [serial api] of MySensors.
[main component]: /components/mysensors/
[serial api]: https://www.mysensors.org/download/serial_api_15

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

@ -14,4 +14,4 @@ ha_category: Light
The wink light platform allows you to use your [Wink](http://www.wink.com/) lights.
The requirement is that you have setup your [Wink hub](/components/light.wink/).
The requirement is that you have setup your [Wink hub](/components/wink/).

2
source/_components/media_player.kodi.markdown
View file

@ -21,7 +21,7 @@ To add Kodi to your installation, add the following to your `configuration.yaml`
# Example configuration.yaml entry
media_player:
platform: kodi
host: 192.168.0.123
host: http://192.168.0.123
port: 8080
name: Kodi
user: USERNAME

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

@ -1,8 +1,8 @@
---
layout: page
title: "Samsung TV"
description: "Instructions how to integrate a Samsung TV in Home Assistant."
date: 2016-02-01 19:00
title: "Samsung Smart TV"
description: "Instructions on how to integrate a Samsung Smart TV into Home Assistant."
date: 2016-02-13 12:02
sidebar: true
comments: false
sharing: true
@ -12,14 +12,30 @@ ha_category: Media Player
featured: false
---
The `samsungtv` platform allows you to control an [Samsung TV](http://www.samsung.com).
The `samsungtv` platform allows you to control a [Samsung Smart TV](http://www.samsung.com/uk/consumer/tv-audio-video/televisions/).
When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication.
To add an Samsung TV to your installation, add the following to your `configuration.yaml` file:
To add a TV to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
media_player:
platform: samsungtv
host: 192.168.0.10
name: Living Room TV
```
Configuration variables:
- **host** *Required*: The IP of the Samsung Smart TV, e.g. 192.168.0.10
- **name** *Optional*: The name you would like to give to the Samsung Smart TV.
Currently known supported models:
- ES5500
- C7700
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/balloob/home-assistant.io).
The two letters at the beginning of the model number represent the region, UE is Europe, UN is North America and UA is Asia & Australia. The two numbers following that represent the screen size. If you add your model remember to remove these before adding them to the list.

8
source/_components/media_player.snapcast.markdown
View file

@ -1,7 +1,7 @@
---
layout: page
title: "snapcast"
description: "Instructions how to integrate a snapcast in Home Assistant."
title: "SnapCast"
description: "Instructions on how to integrate SnapCast into Home Assistant."
date: 2016-02-01 19:00
sidebar: true
comments: false
@ -12,9 +12,9 @@ ha_category: Media Player
featured: false
---
The `snapcast` platform allows you to control [Snapcast](https://github.com/badaix/snapcast).
The `snapcast` platform allows you to control [SnapCast](https://github.com/badaix/snapcast) from Home Assistant.
To add Snapcast to your installation, add the following to your `configuration.yaml` file:
To add SnapCast to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

12
source/_components/mysensors.markdown
View file

@ -2,7 +2,7 @@
layout: page
title: "MySensors"
description: "Instructions how to integrate MySensors sensors into Home Assistant."
date: 2015-05-14 21:57
date: 2016-02-18 20:13 +0100
sidebar: true
comments: false
sharing: true
@ -12,9 +12,9 @@ ha_category: Hub
featured: true
---
The [MySensors](https://www.mysensors.org) project combines Arduino boards with NRF24L01 radio boards to build sensor networks. The component will automatically add all available switches and sensors to Home Assistant.
The [MySensors](https://www.mysensors.org) project combines Arduino boards with NRF24L01 radio boards to build sensor networks. The component will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done.
### Configuration
### {% linkable_title Configuration %}
Integrate your Serial MySensors Gateway by adding the following to your `configuration.yaml` file:
@ -31,6 +31,7 @@ mysensors:
debug: true
persistence: true
version: '1.5'
optimistic: 'true'
```
Configuration variables:
@ -40,7 +41,8 @@ Configuration variables:
- **persistence** (*Optional*): Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts. Default is true.
- **persistence_file** (*Optional*): Path to a file to save sensor information. The file extension determines the file type. Currently supported file types are 'pickle' and 'json'.
- **version** (*Optional*): Specifies the MySensors protocol version to use. Supports 1.4 and 1.5. Default is 1.4.
- **baud_rate** (*Optional*): Specifies baud rate of the connected gateway.
- **baud_rate** (*Optional*): Specifies baud rate of the connected gateway. Default is 115200.
- **optimistic** (*Optional*): Enable or disable optimistic mode for actuators (switch/light). Default is false. Set this to true if no state feedback from actuators is possible. Home Assistant will assume that the command succeeded and change state.
If you are using an original Arduino the port will be named `ttyACM*`. The exact number can be determined with the command shown below.
@ -48,7 +50,7 @@ If you are using an original Arduino the port will be named `ttyACM*`. The exact
$ ls /dev/ttyACM*
```
### Presentation
### {% linkable_title Presentation %}
Present a MySensors sensor or actuator, by following these steps:

8
source/_components/sensor.mysensors.markdown
View file

@ -2,7 +2,7 @@
layout: page
title: "MySensors Sensor"
description: "Instructions how to integrate MySensors sensors into Home Assistant."
date: 2016-01-17 15:49
date: 2016-02-18 20:13 +0100
sidebar: true
comments: false
sharing: true
@ -55,6 +55,12 @@ S_LIGHT_LEVEL | V_LEVEL
S_AIR_QUALITY | V_LEVEL (replaces V_DUST_LEVEL)
S_DUST | V_LEVEL (replaces V_DUST_LEVEL)
### {% linkable_title Custom unit of measurement %}
Some sensor value types are not specific for a certain sensor type. These do not have a default unit of measurement in Home Assistant. For example, the V_LEVEL type can be used for different sensor types, dust, sound, vibration etc.
By using V_UNIT_PREFIX, it's possible to set a custom unit for any sensor. The string value that is sent for V_UNIT_PREFIX will be used in preference to any other unit of measurement, for the defined sensors. V_UNIT_PREFIX can't be used as a standalone sensor value type. Sending a supported value type and value from the tables above is also required. V_UNIT_PREFIX is available with MySensors version 1.5 and later.
For more information, visit the [serial api] of MySensors.
[main component]: /components/mysensors/

8
source/_components/sensor.speedtest.markdown
View file

@ -14,9 +14,9 @@ featured: false
The `speedtest` sensor component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance.
By default, it will run every hour on the hour. The user can change the update frequency in the config by defining the minute, hour, and day for speedtest to run.
By default, it will run every hour. The user can change the update frequency in the config by defining the minute, hour, and day for a speedtest to run.
To add speedtest.net sensors to your installation, add the following to your `configuration.yaml` file:
To add a Speedtest.net sensor to your installation, add the following to your `configuration.yaml` file:
Once per hour, on the hour (default):
@ -65,11 +65,11 @@ sensor:
Configuration variables:
- **monitored_conditions** array (*Required*): Sensors to display in the frontend.
- **ping**: Reaction time in ms of your connection–how fast you get a response after you've sent out a request.
- **ping**: Reaction time in ms of your connection, (how fast you get a response after you've sent out a request).
- **download**: Download speed in Mbps.
- **upload**: Upload speed in Mbps.
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.
This component uses [speetest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.
This component uses [speetest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.

1
source/_components/sensor.time_date.markdown
View file

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_iot_class: "Local Push"
---

2
source/_components/sensor.wink.markdown
View file

@ -14,5 +14,5 @@ ha_category: Sensor
The Wink sensor platform allows you to get data from your [Wink](http://www.wink.com/) sensors.
The requirement is that you have setup your [Wink hub](/components/light.wink/).
The requirement is that you have setup your [Wink hub](/components/wink/).

1
source/_components/sensor.worldclock.markdown
View file

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_iot_class: "Local Push"
---

4
source/_components/simple_alarm.markdown
View file

@ -27,6 +27,6 @@ simple_alarm:
Configuration variables:
- **known_light** (*Required*): Which light/light group has to flash when a known device comes home.
- **unknown_light** (*Required*): Which light/light group has to flash red when light turns on while no one home.
- **known_light** (*Optional*): Which light/light group has to flash when a known device comes home.
- **unknown_light** (*Optional*): Which light/light group has to flash red when light turns on while no one home.

2
source/_components/sun.markdown
View file

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: sun.png
logo: home-assistant.png
ha_category: Weather
---

2
source/_components/switch.hikvision.markdown
View file

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: hikvision.png
ha_category: Camera
ha_category: Switch
---

4
source/_components/switch.mysensors.markdown
View file

@ -2,7 +2,7 @@
layout: page
title: "MySensors Switch"
description: "Instructions how to integrate MySensors switches into Home Assistant."
date: 2016-01-17 15:49
date: 2016-02-15 20:49 +0100
sidebar: true
comments: false
sharing: true
@ -23,14 +23,12 @@ S_TYPE | V_TYPE
S_DOOR | V_ARMED
S_MOTION | V_ARMED
S_SMOKE | V_ARMED
S_LIGHT | V_LIGHT
S_LOCK | V_LOCK_STATUS
##### MySensors version 1.5 and higher
S_TYPE | V_TYPE
-------------|------------------
S_LIGHT | V_STATUS
S_BINARY | V_STATUS, V_LIGHT
S_SPRINKLER | V_STATUS
S_WATER_LEAK | V_ARMED

2
source/_components/switch.wink.markdown
View file

@ -14,5 +14,5 @@ ha_category: Switch
The Wink switch platform allows you to control your [Wink](http://www.wink.com/) switches.
The requirement is that you have setup your [Wink hub](/components/light.wink/).
The requirement is that you have setup your [Wink hub](/components/wink/).

2
source/_components/updater.markdown
View file

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: updater.png
logo: home-assistant.png
ha_category: Other
---

4
source/_components/verisure.markdown
View file

@ -17,9 +17,9 @@ Home Assistant has support to integrate your [Verisure](https://www.verisure.com
We support:
* Alarm
* Smartplugs
* Reading from thermometers and hygrometers integrated in various devices
* Reading alarm status
* Locks
To integrate Verisure with Home Assistant, add the following section to your `configuration.yaml` file:
@ -44,7 +44,7 @@ Configuration variables:
- **alarm** (*Optional*): Set to 1 to show alarm, 0 to disable. Default 1.
- **hygrometers** (*Optional*): Set to 1 to show hygrometers, 0 to disable. Default 1.
- **smartplugs** (*Optional*): Set to 1 to show smartplugs, 0 to disable. Default 1.
- **locls** (*Optional*): Set to 1 to show locks, 0 to disable. Default 1.
- **locks** (*Optional*): Set to 1 to show locks, 0 to disable. Default 1.
- **thermometers** (*Optional*): Set to 1 to show thermometers, 0 to disable. Default 1.
- **code_digits** (*Optional*): Number of digits in PIN code. Default 4.

8
source/_components/weblink.markdown
View file

@ -21,6 +21,14 @@ weblink:
entities:
- name: Router
url: http://192.168.1.1/
icon: mdi:router-wireless
- name: Home Assistant
url: https://home-assistant.io
```
Configuration variables:
- **name** (*Required*): Text for the link.
- **url** (*Required*): The URL for the link.
- **icon** (*Optional*): Icon for entry.
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.