34
source/_components/alarm_control_panel.alarmdotcom.markdown
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Alarm.com Alarm Control Panel"
|
||||
description: "Instructions how to integrate Alarm.com into Home Assistant."
|
||||
date: 2016-01-14 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: alarmdotcom.png
|
||||
ha_category: Alarm
|
||||
---
|
||||
|
||||
The `alarmdotcom` platform is consuming the information provided by a [Alarm.com](https://www.alarm.com/).
|
||||
|
||||
To enable this, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
alarm_control_panel:
|
||||
platform: alarmdotcom
|
||||
name: "HA Alarm"
|
||||
code: PASSCODE
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): Username for the Alarm.com account.
|
||||
- **password** (*Required*): Password for Alarm.com account.
|
||||
- **name** (*Optional*): The name of the alarm. Default is 'Alarm.com'.
|
||||
- **code** (*Optional*): Specifies a code to enable or disable the alarm in the frontend.
|
||||
|
@ -243,6 +243,19 @@ automation:
|
||||
state: not_home
|
||||
```
|
||||
|
||||
#### {% linkable_title Sun condition %}
|
||||
|
||||
The sun condition can test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger](#sun-trigger).
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
condition:
|
||||
platform: sun
|
||||
after: sunset
|
||||
# Optional offset value
|
||||
after_offset: "-1:00:00"
|
||||
```
|
||||
|
||||
#### {% linkable_title Template condition %}
|
||||
|
||||
The template condition will test if [given template][template] renders a value equal to true. This is achieved by having the template result in a true boolean expression or by having the template render 'true'.
|
||||
|
@ -18,7 +18,7 @@ To use your aREST binary sensor in your installation, add the following to your
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
binary_sensor:
|
||||
platform: arest
|
||||
resource: http://IP_ADDRESS
|
||||
name: Office Switch
|
||||
|
67
source/_components/binary_sensor.command.markdown
Normal file
@ -0,0 +1,67 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Command binary sensor"
|
||||
description: "Instructions how to integrate Command binary sensors within Home Assistant."
|
||||
date: 2016-01-13 12:15
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: Binary Sensor
|
||||
---
|
||||
|
||||
|
||||
The `command` binary sensor platform issues specific commands to get data.
|
||||
|
||||
To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
platform: command_sensor
|
||||
command: cat /proc/sys/net/ipv4/ip_forward
|
||||
name: 'IP4 forwarding'
|
||||
payload_on: "1"
|
||||
payload_of: "0"
|
||||
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **command** (*Required*): The action to take to get the value.
|
||||
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
|
||||
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
|
||||
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
|
||||
- **value_template** (*Optional*): Defines a [template](/getting-started/templating/) to extract a value from the payload.
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
In this section you find some real life examples of how to use this sensor.
|
||||
|
||||
### {% linkable_title SickRage %}
|
||||
|
||||
Check the state of an [SickRage](https://github.com/sickragetv/sickrage) instance.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
platform: command_sensor
|
||||
command: netstat -na | find "33322" | find /c "LISTENING" > nul && (Echo 1 ) || (Echo 0)
|
||||
name: 'sickragerunning'
|
||||
payload_on: "1"
|
||||
payload_of: "0"
|
||||
```
|
||||
|
||||
### {% linkable_title Check RasPlex %}
|
||||
|
||||
Check if [RasPlex](http://www.rasplex.com/) is `online`.
|
||||
|
||||
```yaml
|
||||
binary_sensor:
|
||||
platform: command_sensor
|
||||
command: 'ping rasplex.local -c 1 | grep "1 received" | wc -l'
|
||||
name: 'is_rasplex_online'
|
||||
payload_on: 1
|
||||
payload_off: 0
|
||||
```
|
||||
|
@ -12,30 +12,29 @@ ha_category: DIY
|
||||
---
|
||||
|
||||
|
||||
The rpi_gpio sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
|
||||
The rpi_gpio binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
|
||||
|
||||
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
binary_sensor:
|
||||
platform: rpi_gpio
|
||||
ports:
|
||||
11: PIR Office
|
||||
12: PIR Bedroom
|
||||
pull_mode: "UP"
|
||||
value_high: "Active"
|
||||
value_low: "Inactive"
|
||||
bouncetime: 50
|
||||
invert_logic: false
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **ports** array (*Required*): Array of used ports.
|
||||
- **port: name** (*Required*): Your username for the Edimax switch.
|
||||
- **port: name** (*Required*): Port numbers and corresponding names.
|
||||
- **pull_mode** (*Optional*): The internal pull to use (UP or DOWN). Default is UP.
|
||||
- **value_high** (*Optional*): The value of the sensor when the port is HIGH. Default is "HIGH".
|
||||
- **value_low** (*Optional*): The value of the sensor when the port is LOW. Default is "LOW".
|
||||
- **bouncetime** (*Optional*): The time in milliseconds for port debouncing. Default is 50ms.
|
||||
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
|
||||
|
||||
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
|
||||
|
@ -1,23 +0,0 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Geofancy"
|
||||
description: "Instructions how to use Geofancy to track devices in Home Assistant."
|
||||
date: 2015-10-13 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: geofancy.png
|
||||
ha_category: Presence Detection
|
||||
---
|
||||
|
||||
|
||||
This platform allows you to detect presence using [Geofancy](https://my.geofancy.com/). Geofancy allows users to track their location on iOS devices.
|
||||
|
||||
To integrate Geofancy in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
platform: geofancy
|
||||
```
|
32
source/_components/device_tracker.locative.markdown
Normal file
@ -0,0 +1,32 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Locative"
|
||||
description: "Instructions how to use Locative to track devices in Home Assistant."
|
||||
date: 2015-10-13 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: locative.png
|
||||
ha_category: Presence Detection
|
||||
---
|
||||
|
||||
This platform allows you to detect presence using [Locative](https://my.locative.io/). Locative is an [open source](https://github.com/LocativeHQ/ios-app) app for iOS that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location.
|
||||
|
||||
To integrate Locative in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
platform: locative
|
||||
```
|
||||
|
||||
To configure Locative, you must set up the app to send a `GET` request to your Home Assistant server at `http://<ha_server>/api/locative`. Make sure to include the API password if you have configured a password in Home Assistant (add `?api_password=<password>` to the end of the URL). When you enter or exit a geofence, Locative will send a `GET` request to that URL, updating Home Assistant.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/locative.png'/>
|
||||
</p>
|
||||
|
||||
When you enter a geofence, your location name in Home Assistant will be set to the name of the geofence in Locative. When you exit a geofence, your location name in Home Assistant will be set to "not home".
|
||||
|
||||
To use Locative in combination with another device tracker, such as [nmap](/components/device_tracker.nmap_scanner/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last.
|
100
source/_components/media_player.universal.markdown
Normal file
@ -0,0 +1,100 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Universal"
|
||||
description: "Instructions how to create a universal media player in Home Assistant."
|
||||
date: 2016-01-12 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo:
|
||||
ha_category: Media Player
|
||||
featured: false
|
||||
---
|
||||
|
||||
Universal Media Players combine multiple existing entities in Home Assistant into one media player entity. This is used for creating a single entity that controls an entire media center.
|
||||
|
||||
Multiple Media Player entities can be controlled from a Universal Media Player. Additionally, the Universal Media Player allows volume and power commands to be re-routed to other entities in Home Assistant. This allows the power and volume to control external devices like a television or audio receiver.
|
||||
|
||||
A Universal Media Player is created in `configuration.yaml` as follows.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
platform: universal
|
||||
name: MEDIA_PLAYER_NAME
|
||||
children:
|
||||
- media_player.CHILD_1_ID
|
||||
- media_player.CHILD_2_ID
|
||||
commands:
|
||||
turn_on:
|
||||
service: SERVICE
|
||||
data: SERVICE_DATA
|
||||
turn_off:
|
||||
service: SERVICE
|
||||
data: SERVICE_DATA
|
||||
volume_up:
|
||||
service: SERVICE
|
||||
data: SERVICE_DATA
|
||||
volume_down:
|
||||
service: SERVICE
|
||||
data: SERVICE_DATA
|
||||
volume_mute:
|
||||
service: SERVICE
|
||||
data: SERVICE_DATA
|
||||
attributes:
|
||||
is_volume_muted: ENTITY_ID|ATTRIBUTE
|
||||
state: ENTITY_ID|ATTRIBUTE
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name**: The name to assign the player
|
||||
- **children**: Ordered list of child media players this entity will control
|
||||
- **commands** *Optional*: Commands to be overwritten. Possible entries are *turn_on*, *turn_off*, *volume_up*, *volume_down*, and *volume_mute*.
|
||||
- **attributes** *Optional*: Attributes that can be overwritten. Possible entries are *is_volume_muted* and *state*. The values should be an entity id and state attribute separated by a bar (\|). If the entity id's state should be used, then only the entity id should be provided.
|
||||
|
||||
The universal media player will primarily imitate one of its *children*. The first child in the list that is active (not idle/off) will be controlled the universal media player. The universal media player will also inherit its state from the first active child. Entities in the *children* list must be media players.
|
||||
|
||||
It is recommended that the command *turn_on*, the command *turn_off*, and the attribute *state* all be provided together. The *state* attribute indicates if the Media Player is on or off. If *state* indicates the media player is off, this status will take precedent over the states of the children. If all the children are idle/off and *state* is on, the universal media player's state will be on.
|
||||
|
||||
It is also recomended that the command *volume_up*, the command *volume_down*, the command *volume_mute*, and the attribute *is_volume_muted* all be provided together. The attribute *is_volume_muted* should return either True or the on state when the volume is muted. The *volume_mute* service should toggle the mute setting.
|
||||
|
||||
Below is an example configuration.
|
||||
|
||||
```yaml
|
||||
media_player:
|
||||
platform: universal
|
||||
name: Test Universal
|
||||
children:
|
||||
- media_player.living_room_cast
|
||||
- media_player.living_room_kodi
|
||||
commands:
|
||||
turn_on:
|
||||
service: switch.turn_on
|
||||
data:
|
||||
entity_id: switch.living_room_tv
|
||||
turn_off:
|
||||
service: switch.turn_off
|
||||
data:
|
||||
entity_id: switch.living_room_tv
|
||||
volume_up:
|
||||
service: switch.turn_on
|
||||
data:
|
||||
entity_id: switch.living_room_volume_up
|
||||
volume_down:
|
||||
service: switch.turn_on
|
||||
data:
|
||||
entity_id: switch.living_room_volume_down
|
||||
volume_mute:
|
||||
service: switch.turn_on
|
||||
data:
|
||||
entity_id: switch.living_room_mute
|
||||
attributes:
|
||||
state: switch.living_room_tv
|
||||
is_volume_muted: switch.living_room_mute
|
||||
```
|
||||
|
||||
In this example, a switch is available to control the power of the television. Switches are also available to turn the volume up, turn the volume down, and mute the audio. These could be command line switches or any other entity in Home Assistant. The *turn_on* and *turn_off* commands will be redirected to the television and the volume commands will be redirected to an audio receiver.
|
||||
|
||||
The children are a Chromecast and a Kodi player. If the Chromecast is playing, the Universal Media Player will reflect its status. If the Chromecast is idle and Kodi is playing, the Universal Media player will change to reflect its status.
|
29
source/_components/mqtt_eventstream.markdown
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
layout: component
|
||||
title: "MQTT Eventstream"
|
||||
description: "Instructions how to setup MQTT within Home Assistant."
|
||||
date: 2016-01-13 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: mqtt.png
|
||||
ha_category: Others
|
||||
---
|
||||
|
||||
The `mqtt_eventstream` components two Home Assistant instances via MQTT.
|
||||
|
||||
To integrate MQTT Eventstream into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mqtt_eventstream:
|
||||
publish_topic: MyServerName
|
||||
subscribe_topic: OtherHaServerName
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **publish_topic** (*Required*): Topic for pushlishing local events
|
||||
- **subscribe_topic** (*Required*): Topic to recieve events from the remote server.
|
||||
|
49
source/_components/notify.free_mobile.markdown
Normal file
@ -0,0 +1,49 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Free Mobile"
|
||||
description: "Instructions how to add user notifications to Home Assistant."
|
||||
date: 2016-01-12 08:36
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: free_mobile.png
|
||||
ha_category: Notifications
|
||||
---
|
||||
|
||||
The `free_mobile` platform is using the French mobile operator [Free Mobile](http://mobile.free.fr/) to send SMS to your own cell phone.
|
||||
|
||||
Before doing anything, you have to activate the SMS API option in your Free Mobile account (In "Gérer mon compte -> Mes Options"). Activating this option will automatically generate a token which is required in your configuration.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/components/free_mobile/token.png' />
|
||||
</p>
|
||||
|
||||
This API only send classic SMS and only on the cell phone of the account owner. So you only have to provide a text message in your payload.
|
||||
|
||||
<p class='note warning'>
|
||||
If you disable and re-enable the SMS API option, please be sure to update your token in your configuration.
|
||||
</p>
|
||||
|
||||
To enable SMS notifications in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
platform: free_mobile
|
||||
username: YOUR_ACCOUNT_ID
|
||||
access_token: TOKEN
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): This is the id given by FreeMobile to access to your online account.
|
||||
- **access_token** (*Required*): You can get this token by activating the SMS API in your online account.
|
||||
|
||||
#### Example service payload
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "Hello World"
|
||||
}
|
||||
```
|
48
source/_components/sensor.nest.markdown
Normal file
@ -0,0 +1,48 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Nest thermostat"
|
||||
description: "Instructions how to integrate Nest thermostats sensors within Home Assistant."
|
||||
date: 2016-01-13 19:59
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nest_thermostat.png
|
||||
ha_category: Sensor
|
||||
---
|
||||
|
||||
|
||||
The `nest` thermostat platform let you control a thermostat from [Nest](https://nest.com). It also includes the ability to monitor things like the state of our HVAC system and the current humidity and temperature.
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
sensor 3:
|
||||
platform: nest
|
||||
monitored_conditions:
|
||||
- 'fan'
|
||||
- 'hvac_ac_state',
|
||||
- 'hvac_aux_heater_state',
|
||||
- 'hvac_heat_x2_state',
|
||||
- 'hvac_heat_x3_state',
|
||||
- 'hvac_alt_heat_state',
|
||||
- 'hvac_alt_heat_x2_state',
|
||||
- 'hvac_emer_heat_state',
|
||||
- 'online'
|
||||
- 'temperature',
|
||||
- 'target',
|
||||
- 'away_temperature[0]',
|
||||
- 'away_temperature[1]'
|
||||
- 'humidity',
|
||||
- 'mode',
|
||||
- 'last_ip',
|
||||
- 'local_ip',
|
||||
- 'last_connection',
|
||||
- 'battery_level'
|
||||
```
|
||||
|
||||
You must have the [Nest Thermostat](https://home-assistant.io/components/thermostat.nest/) entity configured to use this sensor.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/nest-thermostat-card.png' />
|
||||
</p>
|
46
source/_components/sensor.netatmo.markdown
Normal file
@ -0,0 +1,46 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Netatmo"
|
||||
description: "Instructions how to integrate Netatmo sensors into Home Assistant."
|
||||
date: 2016-01-14 08:10
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: netatmo.png
|
||||
ha_category: Sensor
|
||||
---
|
||||
|
||||
|
||||
The `netatmo` sensor platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) device.
|
||||
|
||||
To enable the Netatmo sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
platform: netatmo
|
||||
api_key: YOUR_API_KEY
|
||||
secret_key: YOUR_SECRET_KEY
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
modules:
|
||||
module_name1:
|
||||
- temperature
|
||||
- humidity
|
||||
- noise
|
||||
- pressure
|
||||
- co2
|
||||
module_name2:
|
||||
- temperature
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): The API key for your netatmo account.
|
||||
- **secret_key** (*Required*): Your netatmo secret key
|
||||
- **username** (*Required*): Username for the netatmo account.
|
||||
- **password** (*Required*): Password for the netatmo account.
|
||||
- **modules** (*Required*): Modules to use. Multiple entries allowd.
|
||||
- **module_name** array (*Required*): Name of the module.
|
||||
- ** [conditions] **: Condition to monitor.
|
67
source/_components/sensor.yr.markdown
Normal file
@ -0,0 +1,67 @@
|
||||
---
|
||||
layout: component
|
||||
title: "YR"
|
||||
description: "Instructions how to integrate Yr.no within Home Assistant."
|
||||
date: 2016-01-04 14:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: yr.png
|
||||
ha_category: Weather
|
||||
---
|
||||
|
||||
|
||||
The `yr` platform uses [YR.no](http://www.yr.no/) as an source for current meteorological data for your location. The
|
||||
weather forecast is delivered by the Norwegian Meteorological Institute and the NRK.
|
||||
|
||||
To add YR to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Will show a symbol for the current weather as default:
|
||||
sensor:
|
||||
platform: yr
|
||||
|
||||
# Will show temperatue and wind direction:
|
||||
sensor:
|
||||
platform: yr
|
||||
monitored_conditions:
|
||||
- temperature
|
||||
- windDirection
|
||||
|
||||
# Will show all available sensors:
|
||||
sensor:
|
||||
platform: yr
|
||||
monitored_conditions:
|
||||
- temperature
|
||||
- symbol
|
||||
- precipitation
|
||||
- windSpeed
|
||||
- pressure
|
||||
- windDirection
|
||||
- humidity
|
||||
- fog
|
||||
- cloudiness
|
||||
- lowClouds
|
||||
- mediumClouds
|
||||
- highClouds
|
||||
- dewpointTemperature
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend.
|
||||
- **symbol**: A symbol for the current weather.
|
||||
- **temperature**: The current temperature.
|
||||
- **humidity**: The relative humidity.
|
||||
- **fog**: Fog.
|
||||
- **pressure**: The sea-level air pressure in millibars.
|
||||
- **precipitation**: The precipitation.
|
||||
- **dewpointTemperature**: The dew point temperature.
|
||||
- **windSpeed**: The wind speed.
|
||||
- **windDirection**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.
|
||||
- **cloudiness**: The cloudiness.
|
||||
- **lowClouds**: Low cloud level.
|
||||
- **mediumClouds**: Medium cloud level.
|
||||
- **highClouds**: High cloud level.
|
||||
|
@ -68,3 +68,17 @@ switch:
|
||||
offcmd: "/usr/sbin/poweroff"
|
||||
```
|
||||
|
||||
### {% linkable_title Control your VLC player %}
|
||||
|
||||
This switch will control a local VLC media player ([Source](https://automic.us/forum/viewtopic.php?f=4&t=144)).
|
||||
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
platform: command_switch
|
||||
switches:
|
||||
VLC:
|
||||
oncmd: "cvlc 1.mp3 vlc://quit &"
|
||||
offcmd: "pkill vlc"
|
||||
```
|
||||
|
@ -29,7 +29,7 @@ switch:
|
||||
Configuration variables:
|
||||
|
||||
- **ports** array (*Required*): Array of used ports.
|
||||
- **port: name** (*Required*): Your username for the Edimax switch.
|
||||
- **port: name** (*Required*): Port numbers and corresponding names.
|
||||
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
|
||||
|
||||
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
|
||||
|
@ -12,7 +12,7 @@ ha_category: Thermostat
|
||||
---
|
||||
|
||||
|
||||
The honeywell thermostat platform let you control [Honeywell Round Connected](http://getconnected.honeywell.com/en/) thermostat from Home Assistant.
|
||||
The honeywell thermostat platform let you control [Honeywell Connected](http://getconnected.honeywell.com/en/) thermostats from Home Assistant.
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
@ -27,4 +27,4 @@ Configuration variables:
|
||||
|
||||
- **username** (*Required*: The username of an user with access.
|
||||
- **password** (*Required*): The password for your given admin account.
|
||||
|
||||
- **away_temperature** (*optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C.
|
||||
|
40
source/_components/thermostat.proliphix.markdown
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Proliphix thermostat"
|
||||
description: "Instructions how to integrate Proliphix thermostats within Home Assistant."
|
||||
date: 2016-01-15 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: proliphix.png
|
||||
ha_category: Thermostat
|
||||
---
|
||||
|
||||
|
||||
The `proliphix` thermostat platform let you control [Proliphix](http://www.proliphix.com) thermostat from Home Assistant.
|
||||
|
||||
Currently supported and tested thermostats:
|
||||
|
||||
- NT10e
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
thermostat:
|
||||
platform: proliphix
|
||||
host: IP_ADDRESS
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): Adress of your thermostat, eg. 192.168.1.32
|
||||
- **username** (*Required*): Username for the thermostat.
|
||||
- **password** (*Required*): Password for the thermostat.
|
||||
|
||||
The Proliphix NT Thermostat series are ethernet connected
|
||||
thermostats. They have a local HTTP interface that is based on get/set
|
||||
of OID values. A complete collection of the API is available in this
|
||||
[API documentation](https://github.com/sdague/thermostat.rb/blob/master/docs/PDP_API_R1_11.pdf).
|
@ -32,6 +32,7 @@ verisure:
|
||||
hygrometers: 0
|
||||
smartplugs: 1
|
||||
thermometers: 0
|
||||
code_digits: 4
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
@ -42,4 +43,5 @@ Configuration variables:
|
||||
- **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.
|
||||
- **thermometers** (*Optional*): Set to 1 to show thermometers, 0 to disable. Default 1.
|
||||
- **code_digits** (*Optional*): Number of digits in PIN code. Default 4.
|
||||
|
||||
|
@ -11,7 +11,7 @@ logo: z-wave.png
|
||||
ha_category: Hub
|
||||
---
|
||||
|
||||
[Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Z-Wave support requires a Z-Wave USB stick to be plugged into the host.
|
||||
[Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Z-Wave support requires a [supported Z-Wave USB stick](https://github.com/OpenZWave/open-zwave/wiki/Controller-Compatibility-List) to be plugged into the host.
|
||||
|
||||
There is currently support for switches, lights and sensors. All will be picked up automatically after configuring this platform.
|
||||
|
||||
|
@ -14,13 +14,13 @@ After two weeks of hard work I'm proud to announce the release of Home Assistant
|
||||
|
||||
#### Changes
|
||||
|
||||
<img src='/images/supported_brands/radiotherm.png' style='border:none; box-shadow: none; float: right; margin-bottom: 16px;' height='50' /><img src='/images/supported_brands/firetv.png' style='border:none; box-shadow: none; float: right; margin-bottom: 16px; clear: right;' height='50' /><img src='/images/supported_brands/geofancy.png' style='border:none; box-shadow: none; float: right; margin-bottom: 16px; clear: right;' height='50' />
|
||||
<img src='/images/supported_brands/radiotherm.png' style='border:none; box-shadow: none; float: right; margin-bottom: 16px;' height='50' /><img src='/images/supported_brands/firetv.png' style='border:none; box-shadow: none; float: right; margin-bottom: 16px; clear: right;' height='50' /><img src='/images/supported_brands/locative.png' style='border:none; box-shadow: none; float: right; margin-bottom: 16px; clear: right;' height='50' />
|
||||
|
||||
- Device tracker: Newer [TP-Link routers](/components/device_tracker.tplink/) now supported ([@mKeRix](https://github.com/mKeRix))
|
||||
- Alarm Control Panel: [Manual alarm](/components/alarm_control_panel.manual/) added ([@sfam](https://github.com/sfam))
|
||||
- Thermostat: [Radiotherm](/components/thermostat.radiotherm/) now supported ([@toddeye](https://github.com/toddeye))
|
||||
- Media Player: [Amazon FireTV](/components/media_player.firetv/) now supported ([@happyleavesaoc](https://github.com/happyleavesaoc))
|
||||
- Device Tracker: [Geofancy](/components/device_tracker.geofancy/) now supported ([@wind-rider](https://github.com/wind-rider))
|
||||
- Device Tracker: [Geofancy](/components/device_tracker.locative/) now supported ([@wind-rider](https://github.com/wind-rider))
|
||||
- New component [Shell Command](/components/shell_command/) can expose shell commands as services ([@balloob](https://github.com/balloob))
|
||||
- [Scripts](/components/script/) can now be customized using `customize` key in `configuration.yaml` ([@balloob](https://github.com/balloob))
|
||||
- Light: [Hyperion](/components/light.hyperion/) now supported ([@MakeMeASandwich](https://github.com/MakeMeASandwich))
|
||||
|
@ -1 +0,0 @@
|
||||
<script>document.location = '/components/device_tracker.geofancy/';</script>
|
1
source/components/device_tracker.locative.html
Normal file
@ -0,0 +1 @@
|
||||
<script>document.location = '/components/device_tracker.locative/';</script>
|
@ -31,6 +31,7 @@ This page contains a list of people who have contributed in one way or another t
|
||||
- [Carlo Costanzo](https://github.com/CCOSTAN)
|
||||
- [Chris Mulder](https://github.com/chrisvis)
|
||||
- [Daniel Iversen](https://github.com/danielhiversen)
|
||||
- [Daren Lord](https://github.com/Xorso)
|
||||
- [Edwin Smulders](https://github.com/Dutchy-)
|
||||
- [ettisan](https://github.com/ettisan)
|
||||
- [Fabian Affolter](https://github.com/fabaff)
|
||||
@ -43,6 +44,7 @@ This page contains a list of people who have contributed in one way or another t
|
||||
- [Gustav Ahlberg](https://github.com/Gyran)
|
||||
- [happyleavesaoc](https://github.com/happyleavesaoc)
|
||||
- [Heathbar](https://github.com/heathbar)
|
||||
- [Hydreliox](https://github.com/HydrelioxGitHub)
|
||||
- [Issac Kelly](https://github.com/issackelly)
|
||||
- [James Cole](https://github.com/jamespcole)
|
||||
- [Jeffrey Tang](https://github.com/Qrtn)
|
||||
@ -50,6 +52,7 @@ This page contains a list of people who have contributed in one way or another t
|
||||
- [John McLaughlin](https://github.com/loghound)
|
||||
- [John Williams](https://github.com/Jaidan)
|
||||
- [Jon Maddox](https://github.com/maddox)
|
||||
- [Joseph Hughes](https://github.com/joshughes)
|
||||
- [Joseph Piron](https://github.com/eagleamon)
|
||||
- [Julien Danjou](https://github.com/jd)
|
||||
- [kixam](https://github.com/kixam)
|
||||
@ -61,6 +64,8 @@ This page contains a list of people who have contributed in one way or another t
|
||||
- [Michael Gilbert](https://github.com/Zyell)
|
||||
- [miniconfig](https://github.com/miniconfig)
|
||||
- [molobrakos](https://github.com/molobrakos)
|
||||
- [Moon Shot](https://github.com/moonshot)
|
||||
- [Nick Touran](https://github.com/partofthething)
|
||||
- [Nolan Gilley](https://github.com/nkgilley)
|
||||
- [Oliver van Porten](https://github.com/mcdeck))
|
||||
- [Pascal Bach](https://github.com/bachp)
|
||||
@ -68,8 +73,8 @@ This page contains a list of people who have contributed in one way or another t
|
||||
- [Philip Lundrigan](https://github.com/philipbl)
|
||||
- [Piratonym](https://github.com/Piratonym)
|
||||
- [Rev Michael Greb](https://github.com/mikegrb)
|
||||
- [Richard Arends](https://github.com/Mosibi)
|
||||
- [rhooper](https://github.com/rhooper)
|
||||
- [Richard Arends](https://github.com/Mosibi)
|
||||
- [rkabadi](https://github.com/rkabadi)
|
||||
- [Rowan Hine](https://github.com/GreenTurtwig)
|
||||
- [Ryan Kraus](https://github.com/rmkraus)
|
||||
|
@ -29,7 +29,7 @@ The device tracker component offers presence detection for Home Assistant. It su
|
||||
|
||||
Scanning for connected devices is easy to setup. See the instructions for our [supported routers][routers] or [scan the network using nmap][nmap]. This approach does have its limitations. It will only be able to detect if a device is home. It also struggles with iPhones because they disconnect from the WiFi if idle, marking them as not home while they are not.
|
||||
|
||||
Home Assistant currently supports two third party services for presence detection: [OwnTracks][ha-owntracks] and [Geofancy][ha-geofancy]. OwnTracks is an app that you install on your iPhone or Android phone that allows you to push the location of your device to Home Assistant using an MQTT broker. An MQTT broker is an Internet of Things communication platform that you can [freely host yourself][mqtt-self] or get [a private instance for free in the cloud](/components/mqtt/#run-your-own).
|
||||
Home Assistant currently supports two third party services for presence detection: [OwnTracks][ha-owntracks] and [Locative][ha-locative]. OwnTracks is an app that you install on your iPhone or Android phone that allows you to push the location of your device to Home Assistant using an MQTT broker. An MQTT broker is an Internet of Things communication platform that you can [freely host yourself][mqtt-self] or get [a private instance for free in the cloud](/components/mqtt/#run-your-own).
|
||||
|
||||
<p class='note'>
|
||||
OwnTracks communicates directly with your MQTT broker, no data will pass through their servers.
|
||||
@ -46,6 +46,7 @@ Home Assistant will know about the location for your device if you are using Own
|
||||
[routers]: /components/#presence-detection
|
||||
[nmap]: /components/device_tracker.nmap_scanner/
|
||||
[ha-owntracks]: /components/device_tracker.owntracks/
|
||||
[ha-locative]: /components/device_tracker.locative/
|
||||
[mqtt-self]: /components/mqtt/#run-your-own
|
||||
[mqtt-cloud]: /components/mqtt/#cloudmqtt
|
||||
[zone]: /components/zone/
|
||||
|
@ -27,6 +27,20 @@ The current logo was created by [Jeremy Geltman](http://jeremygeltman.com/). Fur
|
||||
|
||||
Home Assistant is open source software and available under the [MIT](https://opensource.org/licenses/MIT) license.
|
||||
|
||||
### {% linkable_title Numbers %}
|
||||
|
||||
This sections just contains some random numbers of the Home Assistant eco-system.
|
||||
|
||||
| Description | 2015 |
|
||||
|---|---|
|
||||
| [Gitter.io](https://gitter.im/balloob/home-assistant) | 334 |
|
||||
| [Forum posts](https://automic.us/forum/index.php) | 352 |
|
||||
| [Forum topics](https://automic.us/forum/index.php) | 83 |
|
||||
| [Forum members](https://automic.us/forum/index.php) | 92 |
|
||||
| [Github stars](https://github.com/balloob/home-assistant/stargazers) | 2519 |
|
||||
| [Github forks](https://github.com/balloob/home-assistant/network) | 374 |
|
||||
| Pageviews [ha.io](https://home-assistant.io) | 190'271|
|
||||
|
||||
### {% linkable_title Commit per year %}
|
||||
|
||||
The numbers below only covers the [main git repository](https://github.com/balloob/home-assistant/) and doesn't take the helpers ([home-assistant.io](https://github.com/balloob/home-assistant.io), [home-assistant-polymer](https://github.com/balloob/home-assistant-polymer), and [home-assistant-js](https://github.com/balloob/home-assistant-js)) into account.
|
||||
@ -34,7 +48,7 @@ The numbers below only covers the [main git repository](https://github.com/ballo
|
||||
```bash
|
||||
2013: 147
|
||||
2014: 328
|
||||
2015: 2266 (so far)
|
||||
2015: 2963
|
||||
```
|
||||
|
||||
More details and statistics can be found on [Github](https://github.com/balloob/home-assistant/graphs/contributors).
|
||||
|
BIN
source/images/components/free_mobile/token.png
Normal file
After Width: | Height: | Size: 182 KiB |
BIN
source/images/screenshots/locative.png
Normal file
After Width: | Height: | Size: 55 KiB |
BIN
source/images/supported_brands/alarmdotcom.png
Normal file
After Width: | Height: | Size: 3.1 KiB |
BIN
source/images/supported_brands/free_mobile.png
Normal file
After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
BIN
source/images/supported_brands/netatmo.png
Normal file
After Width: | Height: | Size: 4.7 KiB |
BIN
source/images/supported_brands/proliphix.png
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
source/images/supported_brands/yr.png
Normal file
After Width: | Height: | Size: 9.9 KiB |