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

Merge branch 'current' into next

Browse Source
This commit is contained in:
Fabian Affolter 2016-11-19 13:06:40 +01:00
commit 36d13382d8
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
46 changed files with 284 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
_config.yml
View File

@ -130,4 +130,5 @@ social:
current_major_version: 0
current_minor_version: 32
current_patch_version: 0
current_patch_version: 4
date_released: 2016-11-15

1
source/_components/alarm_control_panel.manual.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Alarm
ha_release: 0.7.6
---

4
source/_components/binary_sensor.envisalink.markdown
View File

@ -13,6 +13,8 @@ ha_category: Binary Sensor
ha_iot_class: "Local Push"
---
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).

4
source/_components/binary_sensor.trend.markdown
View File

@ -41,7 +41,7 @@ In this section you find some real life examples of how to use this sensor.
### {% linkable_title Temperature trend %}
This example indicates `true` if the temperture is rising:
This example indicates `true` if the temperature is rising:
```yaml
binary_sensor:
@ -53,7 +53,7 @@ binary_sensor:
sensor_class: heat
```
And this one indicates `true` if the temperture is falling:
And this one indicates `true` if the temperature is falling:
```yaml
binary_sensor:

48
source/_components/cover.garadget.markdown
View File

@ -36,10 +36,56 @@ Configuration variables:
- **device** (*Required*): This is the device id from your Garadget portal.
- Either:
- **username** (*Required*): Your Garadget account username.
- **device** (*Required*): Your Garadget account password.
- **password** (*Required*): Your Garadget account password.
- Or:
- **access_token** (*Required*): A generated access_token from your garadget account
- **name** (*Optional*): Name to use in the Frontend, will use name configured in Garadget otherwise.
If provided, the **access_token** will be used, otherwise the **username** and **password** will be used to automatically generate an access token at start time.
**Example with more detail:**
<p class='img'>
<img src='{{site_root}}/images/components/garadget/cover_garadget_details.png' />
</p>
```yaml
# Related configuration.yaml entry
cover:
platform: garadget
covers:
190028001947343412342341:
access_token: !secret garadget_access_token
name: Garage door
sensor:
platform: template
sensors:
garage_door_status:
friendly_name: 'State of the door'
value_template: {% raw %}'{{ states.cover.garage_door.state }}'{% endraw %}
garage_door_time_in_state:
friendly_name: 'Since'
value_template: {% raw %}'{{ states.cover.garage_door.attributes["time in state"] }}'{% endraw %}
garage_door_wifi_signal_strength:
friendly_name: 'WiFi strength'
value_template: {% raw %}'{{ states.cover.garage_door.attributes["wifi signal strength (dB)"] }}'{% endraw %}
unit_of_measurement: 'dB'
group:
garage_door:
name: Garage door
entities:
- cover.garage_door
- sensor.garage_door_status
- sensor.garage_door_time_in_state
- sensor.garage_door_wifi_signal_strength
customize:
sensor.garage_door_time_in_state:
icon: mdi:timer-sand
sensor.garage_door_wifi_signal_strength:
icon: mdi:wifi
```

12
source/_components/device_tracker.bluetooth_le_tracker.markdown
View File

@ -21,7 +21,7 @@ Requires PyBluez. If you are on Raspbian, make sure you first install `bluetooth
</p>
<p class='note warning'>
Requires gattlib, which is not compatible with windows. This tracker won't work on windows!
Requires gattlib, which is not compatible with Windows. This tracker won't work on Windows!
</p>
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
@ -35,7 +35,9 @@ device_tracker:
As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times.
Some BTLE devices (e.g. fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device.
BTLE tracking requires root privileges.
<p class='note warning'>
BT LE tracking requires root privileges.
</p>
For running Home Assistant as non root user we can give python3 the missing capabilities to access the bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).
@ -44,6 +46,12 @@ $ sudo apt-get install libcap2-bin
$ sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\``
```
If you have installed Home Assistant with [AIO](/getting-started/installation-raspberry-pi-all-in-one/), you need to do the following command, this will grant access to Home Assistant to run the required command.
```bash
$ sudo setcap cap_net_raw,cap_net_admin+eip /srv/hass/hass_venv/bin/python3
```
A restart of Home Assistant is required.
For additional configuration variables check the [Device tracker page](/components/device_tracker/).

3
source/_components/device_tracker.icloud.markdown
View File

@ -44,7 +44,8 @@ You may receive an email from Apple stating that someone has logged into your ac
To disable the drainage of the battery, a dynamic interval is being used for each individual device instead of a fixed interval for all devices linked to one account. The dynamic interval is based on the current zone of a device, the distance towards home and the battery level of the device.
2 Factor Authentication is enabled for iCloud. The component will ask which device you want to use as Trusted Device and then you can enter the code that has been sent to that device. The duration of this authentication is determined by Apple, but is now at 2 months, so you will only need to verify your account each two months, even after restarting Home Assistant.
2 Steps Authentication is enabled for iCloud. The component will ask which device you want to use as Trusted Device and then you can enter the code that has been sent to that device. The duration of this authentication is determined by Apple, but is now at 2 months, so you will only need to verify your account each two months, even after restarting Home Assistant.
2 Factor Authentication is the improved version of 2 Steps Authentication, this is still not supported by the pyicloud library. Therefore it's not possible to use it with the device_tracker yet.
4 services are available for this component:
- **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional.

2
source/_components/envisalink.markdown
View File

@ -66,6 +66,6 @@ Configuration variables:
- **keepalive_interval** (*Optional*): This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Defaults to `60` seconds.
- **zonedump_interval** (*Optional*): This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
- **panic_type** (*Optional*): Both DSC and Honeywell boards support a "panic" alarm. This is used when the alarm_trigger service is called in home assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance
- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. *Note: if no zones are specified, Home Assistant will not load any binary_sensor components.*
- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.envisalink/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
- **partitions** (*Optional*): Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.

24
source/_components/hdmi_cec.markdown
View File

@ -43,6 +43,29 @@ $ ln -s /usr/local/lib/python3.4/dist-packages/cec /srv/hass/hass_venv/lib/pytho
`* failed to open vchiq instance` you will also need to add the user account Home Asssistant runs under, to the `video` group. To add the Home Assisitant's user account to the `video` group, run the following command. `$ usermod -a -G video <hass_user_account>`
</p>
## {% linkable_title Testing your installation %}
* Login to Raspberry Pi `ssh pi@your_raspberry_pi_ip`
* at the command line type: `echo scan | cec-client -s -d 1`
* This will give you the list of devices that are on the bus
```bash
opening a connection to the CEC adapter...
requesting CEC bus information ...
CEC bus information
===================
device #4: Playback 1
address: 3.0.0.0
active source: no
vendor: Sony
osd string: BD
CEC version: 1.4
power status: on
language: ???
```
**Note the address: line above this will be used to configure HA, this address is represented below as 3: BlueRay player**
## {% linkable_title Configuration Example %}
In the following example, a Pi Zero running Home Assistant is on a TV's HDMI port 1. HDMI port 2 is attached to a AV receiver. Three devices are attached to the AV receiver on HDMI ports 1 through 3.
@ -55,6 +78,7 @@ hdmi_cec:
1: Fire TV Stick
2: Chromecast
3: Another Device
3: BlueRay player
```
## {% linkable_title Services %}

23
source/_components/ifttt.markdown
View File

@ -12,7 +12,7 @@ ha_category: Automation
featured: true
---
[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so called "recipes". With the IFTTT component you can trigger recipes through the "maker" channel. See the [announcement blog post](/blog/2015/09/13/home-assistant-meets-ifttt/) for examples how to use it.
[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so called "Applets". With the IFTTT component you can trigger applets through the **"Maker"** channel. See the [announcement blog post](/blog/2015/09/13/home-assistant-meets-ifttt/) for examples how to use it.
```yaml
# Example configuration.yaml entry
@ -20,14 +20,14 @@ ifttt:
key: xxxxx-x-xxxxxxxxxxxxx
```
Key is your API key which can be obtained by viewing the properties of the [Maker Channel](https://ifttt.com/maker).
`key` is your API key which can be obtained by viewing the **Settings** of the [Maker Channel](https://ifttt.com/maker). It's the last part of the URL.
<p class='img'>
<img src='/images/components/ifttt/finding_key.png' />
Property screen of the Maker Channel
</p>
Once you have added your key to `configuration.yaml`, restart your Home Assistant server. This will load up the IFTTT component and make a service available to trigger events in IFTTT.
Once you have added your key to your `configuration.yaml` file, restart your Home Assistant server. This will load up the IFTTT component and make a service available to trigger events in IFTTT.
<p class='note'>
After restarting the server, be sure to watch the console for any logging errors that show up in red, white or yellow.
@ -35,7 +35,7 @@ After restarting the server, be sure to watch the console for any logging errors
### {% linkable_title Testing your trigger %}
You can use the developer tools to test your [Maker Channel](https://ifttt.com/maker) trigger. To do this, open the Home Assistant UI, open the sidebar, click on the first icon in the developer tools. This should get you to the 'Call Service' screen. Fill in the following values:
You can use the **Developer tools** to test your [Maker Channel](https://ifttt.com/maker) trigger. To do this, open the Home Assistant frontend, open the sidebar, click on the first icon in the developer tools. This should get you to the **Call Service** screen. Fill in the following values:
Field | Value
----- | -----
@ -50,6 +50,13 @@ When your screen looks like this, click the 'call service' button.
### {% linkable_title Setting up a recipe %}
Press the *New applet* button and search for *Maker* .
<p class='img'>
<img src='/images/components/ifttt/setup_service.png' />
Choose "Maker" as service.
</p>
<p class='img'>
<img src='/images/components/ifttt/setup_trigger.png' />
You need to setup a unique trigger for each event you sent to IFTTT.
@ -69,13 +76,9 @@ automation:
### {% linkable_title Sending events from IFTTT to Home Assistant %}
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web. This can be achieved by forwarding port 8123 from your router to the device running Home Assistant. If your ISP is giving you a new IP address from time to time, consider using [DuckDNS][duck-dns].
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web. This can be achieved by forwarding port 8123 from your router to the device running Home Assistant. If your ISP is giving you a new IP address from time to time, consider using [DuckDNS](https://duckdns.org).
In the URL field, you can then put an [API URL][rest-api]. You probably want to use a POST action, so select `POST` as method. After your request line, you need to add your Home Assistant password, which you defined in the [http section of your config][http-configuration], in the form off `?api_password=<your_password>`. For the message body, refer to the API page linked above.
[duck-dns]: https://duckdns.org
[rest-api]: https://home-assistant.io/developers/rest_api/
[http-configuration]: https://home-assistant.io/getting-started/basic/#password-protecting-the-web-interface
In the URL field, you can then put an [API URL](/developers/rest_api/). You probably want to use a POST action, so select `POST` as method. After your request line, you need to add your Home Assistant password, which you defined in the [http section of your config](/getting-started/basic/#password-protecting-the-web-interface), in the form of `?api_password=YOUR_PASSWORD`. For the message body, refer to the API page linked above.
<p class='img'>
<img src='/images/components/ifttt/IFTTT_to_HA.png' />

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

@ -46,6 +46,7 @@ Currently known supported models:
- F6500
- EH5600
- F6400AF
- D6505
Currently tested but not working models:

2
source/_components/notify.nfandroidtv.markdown
View File

@ -35,7 +35,7 @@ Configuration variables:
- **position** (*Optional*): Has to be one of: bottom-right (default), bottom-left, top-right, top-left, center
- **color** (*Optional*): Has to be one of: grey (default), black, indigo, green, red, cyan, teal, amber, pink
- **transparency** (*Optional*): Has to be one of: 0%, 25% (default), 50%, 75%, 100%
- **interrupt** (*Optional*): If set to true, 1, on etc., the notification is interactive and can be dismissed or selected to display more details.
- **interrupt** (*Optional*): If set to true, 1, on etc., the notification is interactive and can be dismissed or selected to display more details. Depending on the running app (e.g. Netflix), this may stop playback.
The configuration will be used to configure the default values for the notification for the host specified by the IP. However, you can override most of the settings by passing them with the data-attribute when calling the service.
This is a fully customized JSON you can use to test how the final notification will look like:

1
source/_components/notify.syslog.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: syslog.png
ha_category: Notifications
ha_release: pre 0.7
---

2
source/_components/pilight.markdown
View File

@ -32,6 +32,7 @@ Configuration variables:
- **host** (*Required*): The IP address of the computer running the pilight-daemon, e.g. 192.168.1.32.
- **port** (*Required*): The network port to connect to. The usual port is [5000](https://www.pilight.org/development/api/).
- **send_delay** (*Optional*): You can define a send delay as a fraction of seconds if you experience transmission problems when you try to switch multiple switches at once. This can happen when you use a [pilight USB Nano](https://github.com/pilight/pilight-usb-nano) as hardware and switches a whole group of multiple switches on or off. Tested values are between 0.3 and 0.8 seconds depending on the hardware.
- **whitelist** (*Optional*): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbours weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true.
In this example only received RF codes using a daycom or intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://www.pilight.org/development/api/).
@ -43,6 +44,7 @@ A full configuration sample could look like the sample below:
pilight:
host: 127.0.0.1
port: 5000
send_delay: 0.4
whitelist: # optional
protocol:
- daycom

42
source/_components/sensor.command_line.markdown
View File

@ -44,15 +44,15 @@ There are several ways to get the temperature of your hard drive. A simple solut
$ hddtemp -n /dev/sda
```
To use those information, the entry for a sensor in the `configuration.yaml` file will look like this.
To use those information, the entry for a command-line sensor in the `configuration.yaml` file will look like this.
```yaml
# Example configuration.yaml entry
sensor:
platform: command_line
name: HD Temperature
command: "hddtemp -n /dev/sda"
unit_of_measurement: "°C"
- platform: command_line
name: HD Temperature
command: "hddtemp -n /dev/sda"
unit_of_measurement: "°C"
```
### {% linkable_title CPU temperature %}
@ -68,14 +68,35 @@ Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, variou
value_template: '{% raw %}{{ value | multiply(0.001) }}{% endraw %}'
```
The `correction_factor` will make sure that the value is shown in a useful format in the frontend.
### {% linkable_title Monitoring the failed login attempt on HA %}
If you want to get the fillowing in case you want to know if someone is hammering your server is open on the net
```yaml
# Example configuration.yaml entry
sensor:
- platform: command_line
name: badlogin
command: grep -c 'Login attempt' /home/hass/.homeassistant/home-assistant.log
```
Make sure to configure the logger to monitor the proper component at the proper level.
```yaml
# Example working logger settings that works
logger:
default: critical
logs:
homeassistant.components.http: warning
```
### {% linkable_title Details about the upstream Home Assistant release %}
You can see directly in the frontend (**Developer tools** -> **About**) what release of Home Assistant you are running. The Home Assistant releases are available on the [Python Package Index](https://pypi.python.org/pypi). This makes it possible to get the current release.
```yaml
sensor:
- platform: command_line
command: python3 -c "import requests; print(requests.get('https://pypi.python.org/pypi/homeassistant/json').json()['info']['version'])"
name: HA release
@ -86,6 +107,7 @@ You can see directly in the frontend (**Developer tools** -> **About**) what rel
If you own a devices which are storing values in text files which are accessible over HTTP then you can use the same approach as shown in the previous section. Instead of looking at the JSON response we directly grab the sensor's value.
```yaml
sensor:
- platform: command_line
command: python3 -c "import requests; print(requests.get('http://remote-host/sensor_data.txt').text)"
name: File value
@ -115,8 +137,8 @@ To use the script you need to add something like the following to your `configur
```yaml
# Example configuration.yaml entry
sensor:
platform: command_line
name: Brightness
command: "python3 /path/to/script/arest-value.py"
unit_of_measurement: "°C"
- platform: command_line
name: Brightness
command: "python3 /path/to/script/arest-value.py"
unit_of_measurement: "°C"
```

2
source/_components/sensor.cups.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: cups.png
ha_category: System Monitoring
ha_category: System Monitor
ha_iot_class: "Local Polling"
ha_release: 0.32
---

43
source/_components/sensor.dovado.markdown Normal file
View File

@ -0,0 +1,43 @@
---
layout: page
title: "Dovado"
description: "How to integrate Dovado sensors within Home Assistant."
date: 2016-11-05 08:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: System Monitor
logo: dovado.png
ha_release: 0.32
---
The `dovado` platform let you monitor your router from [Dovado](http://www.dovado.com/)
To add a Dovado sensor to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: dovado
username: YOUR_USERNAME
password: YOUR_PASSWORD
host: IP_ADDRESS
port: PORT
sensors:
- network
```
Configuration variables:
- **username** (*Required*): Your username.
- **password** (*Required*): Your password.
- **host** (*Optional*): The IP address of your router, e.g. `192.168.1.1`.
- **port** (*Optional*): The port number of your router, e.g. `999`.
- **sensors** array (*Required*): Conditions to display in the frontend.
- **network**: Network state.
- **signal**: The signal strength.
- **download**: The download speed.
- **upload**: The upload speed.
- **sms**: Unread text messages

1
source/_components/sensor.moldindicator.markdown
View File

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

2
source/_components/sensor.openweathermap.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "OpenWeatherMap"
title: "OpenWeatherMap Sensor"
description: "Instructions how to integrate OpenWeatherMap within Home Assistant."
date: 2015-04-25 9:06
sidebar: true

8
source/_components/sensor.synologydsm.markdown
View File

@ -34,12 +34,13 @@ sensor:
- memory_real_usage
- network_up
```
Note: After booting HASS it can take up to 15 minutes for the sensors to show up. This is due to the fact that sensors are created after HASS has fully been initialised.
Configuration variables:
- **host** (*Required*): The IP address of the Synology NAS to monitor
- **port** (*Optional*): The port number on which the NAS is reachable. Defaults to `5000`.
- **username** (*Required*): An user to connect to the Synology NAS (a seperate account is adviced).
- **username** (*Required*): An user to connect to the Synology NAS (a seperate account is adviced, see the Seperate User Configuration section below for details).
- **password** (*Required*): The password of the user to connect to the Synology NAS.
- **volumes** (*Optional*): Array of volumes to monitor. Defaults to all volumes.
- **disks** (*Optional*): Array of disks to monitor. Defaults to all disks.
@ -75,3 +76,8 @@ Configuration variables:
- **volume_disk_temp_avg**: Displays the average temperature of all disks in the volume (creates a new entry for each volume).
- **volume_disk_temp_max**: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume).
Seperate User Configuration:
Due to the nature of the Synology DSM Api it is required to grant de user admin rights. This is related to the fact that utilisation information is stored in the core module.
When creating the user it is possible to deny access to all locations and applications. By doing this the user will not be able to login to the web interface or view any of the files on the NAS. It is still able to read the utilisation and storage information using the API.

16
source/_components/sensor.transmission.markdown
View File

@ -21,12 +21,12 @@ To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
sensor:
platform: transmission
host: IP_ADDRESS
monitored_variables:
- 'current_status'
- 'download_speed'
- 'upload_speed'
- platform: transmission
host: IP_ADDRESS
monitored_variables:
- 'current_status'
- 'download_speed'
- 'upload_speed'
```
Configuration variables:
@ -45,12 +45,12 @@ Configuration variables:
To use the monitoring, your transmission client needs to allow remote access. If you are running the graphical transmission client (transmission-gtk) go to **Edit** -> **Preferences** and choose the tab **Remote**. Check **Allow remote access**, enter your username and your password, and uncheck the network restriction as needed.
<p class='img'>
<img src='{{site_root}}/images/screenshots/transmission_perf.png' />
<img src='{{site_root}}/images/components/transmission/transmission_perf.png' />
</p>
If everything is setup correctly, the details will show up in the frontend.
<p class='img'>
<img src='{{site_root}}/images/screenshots/transmission.png' />
<img src='{{site_root}}/images/components/transmission/transmission.png' />
</p>

4
source/_components/switch.command_line.markdown
View File

@ -73,7 +73,7 @@ This switch will shutdown your host immediately, there will be no confirmation.
switch:
platform: command_line
switches:
Home Assistant system shutdown:
home_assistant_system_shutdown:
command_off: "/usr/sbin/poweroff"
```
@ -87,7 +87,7 @@ This switch will control a local VLC media player ([Source](https://community.ho
switch:
platform: command_line
switches:
VLC:
vlc:
command_on: "cvlc 1.mp3 vlc://quit &"
command_off: "pkill vlc"
```

1
source/_components/switch.mochad.markdown
View File

@ -29,4 +29,5 @@ Configuration variables:
- **address** (*Required*): The X10 address of the switch.
- **name** (*Optional*): The name of the switch. Default is: x10_switch_dev_*address*.
- **comm_type** (*Optional*): pl (powerline) or rf (radio frequency). Default is pl.

2
source/_components/switch.mqtt.markdown
View File

@ -13,7 +13,7 @@ ha_release: 0.7
ha_iot_class: depends
---
The `mqtt` switch platform let you control your MQTT enabled light.
The `mqtt` switch platform let you control your MQTT enabled switch.
In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.

6
source/_components/switch.rfxtrx.markdown
View File

@ -47,7 +47,7 @@ Configuration variables:
- **devices** (*Required*): A list of devices with their name to use in the frontend.
- **automatic_add** (*Optional*): To enable the automatic addition of new switches.
- **signal_repetitions** (*Optional*): Because the rxftrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch to try to send each signal repeatedly.
- **signal_repetitions** (*Optional*): Because the RFXtrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch to try to send each signal repeatedly.
- **fire_event** (*Optional*): Fires an event even if the state is the same as before, for example a doorbell switch. Can also be used for automations.
Generate codes:
@ -56,9 +56,11 @@ If you need to generate codes for switches you can use a template (usefull for e
- Go to home-assistant-IP:8123/dev-template
- Use this code to generate a code:
```yaml
{% raw %}0b11000{{ range(0,700) | random | int }}bc0cfe0{{ range(0,10) | random | int }}010f70{% endraw %}
{% raw %}0b11000{{ range(100,700) | random | int }}bc0cfe0{{ range(0,10) | random | int }}010f70{% endraw %}
```
- Use this code to add a new switch in your configuration.yaml
- Launch your homeassistant and go the website.
- Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket)

1
source/_components/thingspeak.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: thingspeak.png
ha_category: "History"
ha_release: 0.32
---

1
source/_components/weblink.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Front end
ha_release: 0.13
---

2
source/_includes/asides/component_navigation.html
View File

@ -33,7 +33,7 @@
</div>
{% endif %}
{% if is_platform and parent_name != 'sensor' and parent_name != 'binary_sensor' %}
{% if is_platform and parent_name != 'sensor' %}
<div class='section'>
This is a platform for
<a href='{{parent_component.url}}'>the {{parent_component.title}} component</a>.

82
source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown
View File

@ -30,40 +30,76 @@ For a long time we have had a bunch of [weather sensors][weather-sensors] but it
### {% linkable_title All changes %}
<img src='/images/supported_brands/icloud.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/influxdb.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/emby.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/synologydsm.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' />
<img src='/images/supported_brands/icloud.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/influxdb.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/emby.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/synologydsm.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/garadget_logo.jpg' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/yeelight.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/philips.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/nfandroidtv.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/currencylayer.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' /><img src='/images/supported_brands/influxdb.png' style='clear: right; margin-left: 5px; border:none; box-shadow: none; float: right; margin-bottom: 16px;' width='100' />
- Config: Exclude dirs/files prefixed with . ([@lwis])
- Cover: New [garadget] platform ([@JasonCarter80])
- Media player: New support for [Emby][emby-media] ([@mezz64])
- [LiteJet][litejet] switches and lights support ([@joncar])
- Light: [Yeelight][yeelight] Wifi bulbs are now supported ([@HydrelioxGitHub])
- Media player: [Philips TVs][philips_player] with jointSPACE API re now supported ([@danielperna84])
- Sensor: Support for [Synology DSM][synologydsm] ([@StaticCube])
- Sensor: Monitoring support for [Dovado routers][dovado-sensor] ([@molobrakos])
- Sensor: Support for monitoring [printers][cups-sensor] ([@fabaff])
- Add mochad component ([@mtreinish])
- Notify: Added support for [Android TV/FireTV](https://home-assistant.io/components/notify.nfandroidtv/) ([@danielperna84])
- HTTP: Migrate WSGI to asyncio ([@balloob])
- Configurator: Support for `entity_picture` ([@amills])
- Core: Configuration validation error prints line numbers ([@persandstrom])
- Media player: [Sonos] improvements incl. timer setting functionality ([@bjarniivarsson], [@americanwookie])
- Zoneminder: SSL/TLS support ([@Khabi])
- Media player: Discovery support for [Yamaha] ([@sdague])
- Sensor: New finance platform [CurrencyLayer][currencylayer] ([@arsaboo])
- Notify: Added support for [Android TV/FireTV](https://home-assistant.io/components/notify.nfandroidtv/) - Sensor: New finance platform [CurrencyLayer][currencylayer] ([@arsaboo])
- Sensor: Support for [InfluxDB sensors][influx-sensor] ([@bestlibre])
- Sensor: New support [HDDTemp sensors][hddtemp-sensor] ([@fabaff])
([@danielperna84])
- Media player: [Sonos] improvements incl. timer setting functionality ([@bjarniivarsson], [@americanwookie])
- Media player: Discovery support for [Yamaha] ([@sdague])
- Config: Exclude dirs/files prefixed with . ([@lwis])
- HTTP: Migrate WSGI to asyncio ([@balloob])
- Configurator: Support for `entity_picture` ([@armills])
- Core: Configuration validation error prints line numbers ([@persandstrom])
- Zoneminder: SSL/TLS support ([@Khabi])
- Camera: Improvements to [RPi camera][rpi-camera] ([@postlund])
- [ThingSpeak][thingspeak] component ([@simonszu])
- Core: New property `hass.data` to store internal data ([@balloob])
- Switch: Templating and configurable timeout for [REST][rest-switch] ([@aa755])
- Light: [Yeelight][yeelight] Wifi bulbs are now supported ([@HydrelioxGitHub])
- Sensor: New [random number][random-sensor] sensor ([@fabaff])
- Media player: New support for [Emby][emby-media] ([@mezz64])
- [LiteJet][litejet] switches and lights support ([@joncar])
- Cover: New [garadget] platform ([@JasonCarter80])
- Pilight: `send_delay` feature ([@janLo])
- Config: Improvements for `known_devices` ([@kellerza])
- Device tracker: New discovered event ([@lwis])
- Device tracker: Improvements and new features for the Volvo on Call platform ([@molobrakos])
- Climate: Use unit of measurement from a Vera device ([@pavoni])
- Media player: [Philips TVs][philips_player] with jointSPACE API re now supported ([@danielperna84])
- Device tracker: [ICloud][icloud] improvements ([@Bart274])
- Sensor: Support for [Synology DSM][synologydsm] ([@StaticCube])
- Sensor: Monitoring support for [Dovado routers][dovado-sensor] ([@molobrakos])
- Sensor: Support for monitoring [printers][cups-sensor] ([@fabaff])
- Minor features and bug fixes by [@fabaff], [@kellerza], [@robbiet480], [@balloob], [@DavidLP], [@Bart274], [@sdague], [@mtreinish], [@Khabi], [@bbesset], [@bestlibre], [@pvizeli], [@turbokongen], [@devdelay], [@molobrakos], [@postlund], [@wokar], [@amills], [@arsaboo], [@hartmms], [@nsideras], [@tbeckha], and [@kirichkov].
- Device tracker: [iCloud][icloud] improvements ([@Bart274])
- Minor features and bug fixes by [@fabaff], [@kellerza], [@robbiet480], [@balloob], [@DavidLP], [@Bart274], [@sdague], [@mtreinish], [@Khabi], [@bbesset], [@bestlibre], [@pvizeli], [@turbokongen], [@devdelay], [@molobrakos], [@postlund], [@wokar], [@armills], [@arsaboo], [@hartmms], [@nsideras], [@tbeckha], and [@kirichkov].
### {% linkable_title Release 0.32.1 - November 6 %}
We've added a warning to 0.32 to catch platforms accidentally slowing down Home Assistant. Our aim is to fix these quickly when reported, so here is 0.32.1 with all reported platforms fixed.
- Fix Sonos doing I/O inside the event loop ([@pvizeli])
- Fix Radiotherm doing I/O inside the event loop ([@balloob])
- Fix camera MJPEG streams when using HTTP 1.0 ([@balloob])
### {% linkable_title Release 0.32.2 - November 7 %}
- Move Honeywell I/O out of the event loop ([@balloob])
- Use sequential updates for non-async entities to prevent race conditions ([@pvizeli])
- Fix setting temperature in Celsius on Radiotherm CT50 thermostats ([@andyat])
- Fix PiLight config validation ([@DavidLP])
### {% linkable_title Release 0.32.3 - November 11 %}
- Fix OpenWeather weather platform doing I/O in event loop ([@lwis])
- Fix Alarm.com doing I/O in event loop ([@jnewland])
- Fix Tellstick doing I/O in event loop ([@balloob])
- Fix KNX doing I/O in event loop ([@balloob])
- Increase warning threshold for catching platforms that do I/O ([@balloob])
- Change pilight systemcode validation ([@janLo])
- Fix Yamaha discovering already configured receivers ([@sdague])
- Fix Sonos from installing dependency each time HA was started ([@pvizeli])
- Fix Synology camera SSL and error handling ([@pvizeli])
- Fix Panasonic Viera doing I/O in event loop ([@balloob])
- Improve generic camera error handling ([@kellerza])
- Light - Flux Led Lights: allow specifying mode if light does not support white mode ([@DanielHiversen])
- Fix Rest switch default template ([@pvizeli])
### {% linkable_title Release 0.32.4 - November 15 %}
- Fix device tracker from crashing HASS when a new device was discovered ([@balloob])
- HTTP: Fix X-Forwarded-For feature ([@mweinelt])
### {% linkable_title Misc %}
@ -83,9 +119,11 @@ Our website has now an additional category called "Ecosystem". This will become
...don't hesitate to use our [Forum](https://community.home-assistant.io/) or join us for a little [chat](https://gitter.im/home-assistant/home-assistant). The release notes have comments enabled but it's preferred if you the former communication channels. Thanks.
[@mweinelt]: https://github.com/mweinelt
[@aa755]: https://github.com/aa755
[@americanwookie]: https://github.com/americanwookie
[@amills]: https://github.com/armills
[@armills]: https://github.com/armills
[@andyat]: https://github.com/andyat
[@arsaboo]: https://github.com/arsaboo
[@balloob]: https://github.com/balloob
[@Bart274]: https://github.com/Bart274
@ -121,6 +159,8 @@ Our website has now an additional category called "Ecosystem". This will become
[@tchellomello]: https://github.com/tchellomello
[@turbokongen]: https://github.com/turbokongen
[@wokar]: https://github.com/wokar
[@jnewland]: https://github.com/jnewland
[@DanielHiversen]: https://github.com/DanielHiversen
[currencylayer]: https://home-assistant.io/components/sensor.currencylayer/
[yahoo]: https://home-assistant.io/components/sensor.yahoo_finance/

2
source/developers/website.markdown
View File

@ -13,7 +13,7 @@ The website you are reading now is the home of Home Assistant: [https://home-ass
home-assistant.io is built using [Jekyll](http://github.com/mojombo/jekyll) and [these available dependencies](https://pages.github.com/versions/). The pages are written in [markdown](http://daringfireball.net/projects/markdown/). To add a page, you don't need to know about HTML.
You can use the "**Edit this page on GitHub**" link to edit pages without creating a fork.
You can use the "**Edit this page on GitHub**" link to edit pages without creating a fork. Keep in mind that you can't upload images while working this way.
For larger changes, we suggest that you clone the website repository. This way, you can review your changes locally. The process for working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a pull request.

29
source/getting-started/customizing-devices.markdown
View File

@ -39,30 +39,13 @@ homeassistant:
| Attribute | Description |
| --------- | ----------- |
| friendly_name | Name of the entity
| hidden | Set to `true` to hide the entity.
| entity_picture | Url to use as picture for entity
| icon | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix name with `mdi:`, ie `mdi:home`.
| assumed_state | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
| sensor_class | Sets the class of the sensor, changing the device state and icon that is displayed on the UI (see below).
| `friendly_name` | Name of the entity
| `hidden` | Set to `true` to hide the entity.
| `entity_picture` | Url to use as picture for entity
| `icon` | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com). Prefix name with `mdi:`, ie `mdi:home`.
| `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
| `sensor_class` | Sets the [class of the sensor](/components/binary_sensor/), changing the device state and icon that is displayed on the UI (see below).
| sensor_class | Description |
| ------------ | ----------- |
| cold | On means cold (or too cold) |
| connectivity | On means connection present, Off means no connection
| gas | CO, CO2, etc. |
| heat | On means hot (or too hot) |
| light | Lightness threshold |
| moisture | Specifically a wetness sensor |
| motion | Motion sensor |
| moving | On means moving, Off means stopped |
| occupancy | On means occupied, Off means not occupied |
| opening | Door, window, etc. |
| power | Power, over-current, etc. |
| safety | On means unsafe, Off means safe |
| smoke | Smoke detector |
| sound | On means sound detected, Off means no sound |
| vibration | On means vibration detected, Off means no vibration |
### {% linkable_title Reloading customize %}

2
source/getting-started/z-wave.markdown
View File

@ -20,7 +20,7 @@ To allow Home Assistant to talk to your Z-Wave USB stick you will have to compil
Make sure you have the correct dependencies installed before running the script:
```bash
$ sudo apt-get install cython3 libudev-dev python3-sphinx python3-setuptools
$ sudo apt-get install cython3 libudev-dev python3-sphinx python3-setuptools git
```
Make sure you have at least version 0.23 and at the most 0.24.1 of cython.

BIN
source/images/components/garadget/cover_garadget_details.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
source/images/components/ifttt/IFTTT_to_HA.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 57 KiB

BIN
source/images/components/ifttt/finding_key.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 52 KiB

BIN
source/images/components/ifttt/setup_service.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 43 KiB

BIN
source/images/components/ifttt/setup_trigger.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 45 KiB

BIN
source/images/components/ifttt/testing_service.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 50 KiB

0
source/images/screenshots/transmission.png → source/images/components/transmission/transmission.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

0
source/images/screenshots/transmission_perf.png → source/images/components/transmission/transmission_perf.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

BIN
source/images/supported_brands/currencylayer.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.7 KiB

After

Width:  |  Height:  |  Size: 5.0 KiB

BIN
source/images/supported_brands/digital_ocean.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 3.2 KiB

BIN
source/images/supported_brands/dovado.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.7 KiB

BIN
source/images/supported_brands/syslog.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 160 KiB

BIN
source/images/supported_brands/thingspeak.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.3 KiB

2
source/index.html
View File

@ -18,7 +18,7 @@ hide_github_edit: true
<div class="grid__item one-third lap-one-third palm-one-whole">
<div class='current-version material-card text'>
<h1>Current Version: {{ site.current_major_version }}.{{ site.current_minor_version }}.{{ site.current_patch_version }}</h1>
Released: <span class='release-date' title='{{ recent_release_post.release_date }}'>{{ recent_release_post.release_date | date: '%B %d, %Y' }}</span>
Released: <span class='release-date'>{{ site.date_released | date: '%B %d, %Y' }}</span>
<div class='links'>
<a href='{{ root_url }}{{ recent_release_post.url }}'>Release notes</a>