Merge branch 'next' of https://github.com/balloob/home-assistant.io into next
This commit is contained in:
commit
ed647c1aac
68 changed files with 1079 additions and 170 deletions
|
@ -11,25 +11,19 @@ logo: apcupsd.png
|
|||
ha_category: Hub
|
||||
---
|
||||
|
||||
[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver).
|
||||
[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) is enabled on the APC device.
|
||||
|
||||
Create an `apcupsd` section in your configuration, optionally containing the following parameters:
|
||||
|
||||
- **host**: The hostname/IP address on which the APCUPSd NIS is being served. Default: `localhost`
|
||||
- **port**: The port on which the APCUPSd NIS is listening. Default: `3551`
|
||||
|
||||
#### Example
|
||||
|
||||
Use defaults:
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
apcupsd:
|
||||
host: IP_ADDRESS
|
||||
port: PORT
|
||||
```
|
||||
|
||||
Set parameters:
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Optional*): The hostname/IP address on which the APCUPSd NIS is being served. Defaults to `localhost`.
|
||||
- **port** (*Optional*): The port on which the APCUPSd NIS is listening. Defaults to `3551`.
|
||||
|
||||
```yaml
|
||||
apcupsd:
|
||||
host: 192.168.1.10
|
||||
port: 1234
|
||||
```
|
||||
|
|
|
@ -11,12 +11,18 @@ logo: apcupsd.png
|
|||
ha_category: Binary Sensor
|
||||
---
|
||||
|
||||
In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply `on` when the UPS status is `ONLINE` and `off` at all other times.
|
||||
In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
|
||||
|
||||
#### Example
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- name: UPS Online
|
||||
platform: apcupsd
|
||||
- platform: apcupsd
|
||||
name: UPS Online
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **resource** (*Required*): The resource or endpoint that contains the value.
|
||||
- **method** (*Optional*): The method of the request. Default is GET.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -9,6 +9,35 @@ sharing: true
|
|||
footer: true
|
||||
ha_category: Binary Sensor
|
||||
---
|
||||
The TCP Binary Sensor is a type of [TCP Sensor](/components/sensor.tcp/) which is either `OFF` or `ON`. In order the use this sensor type, in addition to the configuration for the TCP Sensor, you must supply a `value_on` value to represent what is returned when the device is turned `ON`.
|
||||
|
||||
- **value_on** (*Required*): The value returned when the device is `ON`.
|
||||
|
||||
The TCP Binary Sensor is a type of [TCP Sensor](/components/sensor.tcp/) which is either "off" or "on". In order to use this sensor type, in addition to the configuration for the TCP Sensor, you must supply a `value_on` value to represent what is returned when the device is turned on.
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
# Example configuration.yaml entry
|
||||
- platform: tcp
|
||||
name: TCP Binary Sensor
|
||||
host: IP_ADDRESS
|
||||
port: PORT
|
||||
payload: "r State\n"
|
||||
value_on: 1
|
||||
timeout: 5
|
||||
value_template: "{% raw %}{{ value.split(';')[0] }}{% endraw %}"
|
||||
unit: UNIT_OF_MEASUREMENT
|
||||
```
|
||||
|
||||
Configuration options for the a TCP Sensor:
|
||||
|
||||
- **name** (*Required*): The name you'd like to give the sensor in Home Assistant.
|
||||
- **host** (*Required*): The hostname/IP address to connect to.
|
||||
- **port** (*Required*): The port to connect to the host on.
|
||||
- **payload** (*Required*): What to send to the host in order to get the response we're interested in.
|
||||
- **value_on** (*Required*): The value returned when the device is "on".
|
||||
- **timeout** (*Optional*): How long in seconds to wait for a response from the service before giving up and disconnecting. Defaults to 10.
|
||||
- **value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract the value. By default it's assumed that the entire response is the value.
|
||||
- **unit** (*Optional*): The unit of measurement to use for the value.
|
||||
- **buffer_size** (*Optional*): The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Defaults to 1024.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: browser.png
|
||||
logo: home-assistant.png
|
||||
ha_category: Other
|
||||
---
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: conversation.png
|
||||
logo: home-assistant.png
|
||||
ha_category: "Voice"
|
||||
---
|
||||
|
||||
|
|
|
@ -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:
|
||||
|
|
|
@ -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:
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: downloader.png
|
||||
logo: home-assistant.png
|
||||
ha_category: Other
|
||||
---
|
||||
|
||||
|
|
|
@ -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/).
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -7,6 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: bus_scs.png
|
||||
ha_category: Light
|
||||
---
|
||||
|
||||
|
|
|
@ -1,24 +1,21 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Belkin WeMo Light"
|
||||
description: "Instructions how to integrate Belkin WeMo lights into Home Assistant."
|
||||
date: 2016-02-22 07:00
|
||||
title: "Belkin WeMo Lights"
|
||||
description: "Instructions how to integrate Belkin WeMo LED lights into Home Assistant."
|
||||
date: 2016-02-20 00:45
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: belkin_wemo.png
|
||||
ha_category: Light
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `wemo` light platform allows you to control your [Belkin WeMo](http://www.belkin.com) lights from within Home Assistant.
|
||||
The `wemo` platform allows you to control your [Belkin WeMo](http://www.belkin.com/us/p/P-F5Z0489/) LED lights from within Home Assistant.
|
||||
|
||||
They will be automatically discovered if the discovery component is enabled.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
light:
|
||||
platform: wemo
|
||||
```
|
||||
For more configuration information see the [WeMo component](/components/wemo/) documentation.
|
||||
|
||||
|
|
|
@ -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/).
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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:
|
||||
|
||||
|
|
|
@ -7,6 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: bus_scs.png
|
||||
ha_category: Rollershutter
|
||||
---
|
||||
The SCSGate device can control motirized roller shutters connected to the BTicino MyHome system.
|
||||
|
|
|
@ -7,6 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: bus_scs.png
|
||||
ha_category: Hub
|
||||
---
|
||||
|
||||
|
|
|
@ -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/
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -9,36 +9,55 @@ sharing: true
|
|||
footer: true
|
||||
ha_category: Sensor
|
||||
---
|
||||
|
||||
The TCP component allows the integration of some services for which a specific Home Assistant component does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this component will allow integration with it.
|
||||
|
||||
The configuration options for the a TCP Sensor:
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
# Example configuration.yaml entry
|
||||
- platform: tcp
|
||||
name: Central Heating Pressure
|
||||
host: IP_ADDRESS
|
||||
port: PORT
|
||||
timeout: 5
|
||||
payload: PAYLOAD
|
||||
value_template: "{% raw %}{{ value.split(';')[0] }}{% endraw %}"
|
||||
unit: UNIT_OF_MEASUREMENT
|
||||
```
|
||||
|
||||
Configuration options for the a TCP Sensor:
|
||||
|
||||
- **name** (*Required*): The name you'd like to give the sensor in Home Assistant.
|
||||
- **platform** (*Required*): Set to `tcp`.
|
||||
- **host** (*Required*): The hostname/IP address to connect to.
|
||||
- **port** (*Required*): The port to connect to the host on.
|
||||
- **payload** (*Required*): What to send to the host in order to get the response we're interested in.
|
||||
- **timeout**: How long in seconds to wait for a response from the service before giving up and disconnecting. Default: `10`
|
||||
- **value_template**: A Jinja2 template to extract the desired value from the response returned by the server. By default we assume that the entire response is the value.
|
||||
- **unit**: The unit of measurement to use for the value.
|
||||
- **buffer_size**: The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Default: `1024`.
|
||||
- **timeout** (*Optional*): How long in seconds to wait for a response from the service before giving up and disconnecting. Defaults to `10`
|
||||
- **value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract the value. By default it's assumed that the entire response is the value.
|
||||
- **unit** (*Optional*): The unit of measurement to use for the value.
|
||||
- **buffer_size** (*Optional*): The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Defaults to `1024`.
|
||||
|
||||
#### Example
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
The usage of the TCP component is best explained with an example. The [EBUSd](https://github.com/john30/ebusd/wiki) service enables connection to an EBUS serial bus on some home heating/cooling systems. Using this service it is possible to extract various metrics which may be useful to have within Home Assistant. In order to use EBUSd, you connect to it using a TCP socket and send it a command. The service will respond with the value it has received from EBUS. On the command line, this would look something like:
|
||||
In this section you find some real life examples of how to use this sensor.
|
||||
|
||||
### {% linkable_title EBUSd %}
|
||||
|
||||
The [EBUSd](https://github.com/john30/ebusd/wiki) service enables connection to an EBUS serial bus on some home heating/cooling systems. Using this service it is possible to extract various metrics which may be useful to have within Home Assistant. In order to use EBUSd, you connect to it using a TCP socket and send it a command. The service will respond with the value it has received from EBUS. On the command line, this would look something like:
|
||||
|
||||
```bash
|
||||
$ echo "r WaterPressure" | nc 10.0.0.127 8888
|
||||
0.903;ok
|
||||
|
||||
```
|
||||
|
||||
You will notice that the output from the service is not just a single value (it contains ";ok" as well). To grab the value we're interested in, we can use a Jinja2 template. The response received is injected into the template as the `value` variable. To use this value within Home Assistant, use the following configuration:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- name: Central Heating Pressure
|
||||
platform: tcp
|
||||
# Example configuration.yaml entry
|
||||
- platform: tcp
|
||||
name: Central Heating Pressure
|
||||
host: 10.0.0.127
|
||||
port: 8888
|
||||
timeout: 5
|
||||
|
@ -47,4 +66,3 @@ sensor:
|
|||
unit: Bar
|
||||
```
|
||||
|
||||
|
||||
|
|
|
@ -7,6 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: home-assistant.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
|
|
@ -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/).
|
||||
|
||||
|
|
|
@ -7,6 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: home-assistant.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: sun.png
|
||||
logo: home-assistant.png
|
||||
ha_category: Weather
|
||||
---
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ comments: false
|
|||
sharing: true
|
||||
footer: true
|
||||
logo: hikvision.png
|
||||
ha_category: Camera
|
||||
ha_category: Switch
|
||||
---
|
||||
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -7,6 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: bus_scs.png
|
||||
ha_category: Switch
|
||||
---
|
||||
|
||||
|
|
|
@ -2,13 +2,14 @@
|
|||
layout: page
|
||||
title: "Belkin WeMo Switch"
|
||||
description: "Instructions how to integrate Belkin WeMo switches into Home Assistant."
|
||||
date: 2015-03-23 19:59
|
||||
date: 2016-02-20 00:47
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: belkin_wemo.png
|
||||
ha_category: Switch
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
|
@ -16,22 +17,4 @@ The `wemo` platform allows you to control your [Belkin WeMo](http://www.belkin.c
|
|||
|
||||
They will be automatically discovered if the discovery component is enabled.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
platform: wemo
|
||||
```
|
||||
|
||||
Alternately, wemos that are not discoverable can be statically configured. If you have WeMo devices on subnets other than where Home Assistant is running, and/or devices in a remote location reachable over a VPN, you will need to manually configure them. This is also useful if you wish to disable discovery for some wemos, even if they are local. Example static configuration:
|
||||
|
||||
```yaml
|
||||
switch:
|
||||
platform: wemo
|
||||
static:
|
||||
- 192.168.1.23
|
||||
- 192.168.52.172
|
||||
```
|
||||
|
||||
Any WeMo devices that are not statically configured but reachable via discovery will still be added automatically.
|
||||
|
||||
Note that if you use this, you may want to configure your router (or whatever runs your DHCP server) to force your WeMo devices to use a static IP address. Check the DHCP section of your router configuration for this ability.
|
||||
For more configuration information see the [WeMo component](/components/wemo/) documentation.
|
||||
|
|
|
@ -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/).
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@ sidebar: true
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: updater.png
|
||||
logo: home-assistant.png
|
||||
ha_category: Other
|
||||
---
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -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`.
|
||||
|
|
34
source/_components/wemo.markdown
Normal file
34
source/_components/wemo.markdown
Normal file
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Belkin WeMo devices"
|
||||
description: "Instructions how to integrate Belkin WeMo devices into Home Assistant."
|
||||
date: 2016-02-20 00:41
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: belkin_wemo.png
|
||||
ha_category: Hub
|
||||
---
|
||||
|
||||
The `wemo` component is the main component to integrate various [Belkin WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant.
|
||||
|
||||
Supported devices will be automatically discovered if the discovery component is enabled. If you are not using the discovery component, loading the `wemo` component will scan for WeMo devices on the local network.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
wemo:
|
||||
```
|
||||
|
||||
Alternately, WeMo devices that are not discoverable can be statically configured. If you have WeMo devices on subnets other than where Home Assistant is running, and/or devices in a remote location reachable over a VPN, you will need to manually configure them. This is also useful if you wish to disable discovery for some wemos, even if they are local. Example static configuration:
|
||||
|
||||
```yaml
|
||||
wemo:
|
||||
static:
|
||||
- 192.168.1.23
|
||||
- 192.168.52.172
|
||||
```
|
||||
|
||||
Any WeMo devices that are not statically configured but reachable via discovery will still be added automatically.
|
||||
|
||||
Note that if you use this, you may want to configure your router (or whatever runs your DHCP server) to force your WeMo devices to use a static IP address. Check the DHCP section of your router configuration for this ability.
|
Loading…
Add table
Add a link
Reference in a new issue