+ Note: Versions later than R44 adds support for Ikea Ansluta, Philips Living Colors Gen1, MySensors devices. +
+ +A complete list of devices supported by RFLink can be found [here](http://www.nemcon.nl/blog2/devlist) This component is tested with the following hardware/software: -- Nodo Rflink Gateway V1.4/Rflink R44 +- Nodo RFLink Gateway V1.4/RFLink R46 -To enable Rflink in your installation, add the following to your `configuration.yaml` file: +To enable RFLink in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -32,9 +38,9 @@ rflink: Configuration variables: -- **port** (*Required*): The path to Rflink usb/serial device or TCP port in TCP mode. +- **port** (*Required*): The path to RFLink USB/serial device or TCP port in TCP mode. - **host** (*Optional*): Switches to TCP mode, connects to host instead of to USB/serial. -- **wait_for_ack** (*Optional*): Wait for Rflink to ackowledge commands sent before sending new command (slower but more reliable). Defaults to `True` +- **wait_for_ack** (*Optional*): Wait for RFLink to ackowledge commands sent before sending new command (slower but more reliable). Defaults to `True` - **ignore_devices** (*Optional*): List of devices id's to ignore. Supports wildcards (*) at the end. - **reconnect_interval** (*Optional*): Time in seconds between reconnect attempts. @@ -52,9 +58,9 @@ rflink: ### {% linkable_title TCP mode %} -TCP mode allows connect to a Rflink device over TCP/IP network. This is for example useful if placing the Rflink device next to the HA server is not optimal or desired (eg: bad reception). +TCP mode allows connect to a RFLink device over TCP/IP network. This is for example useful if placing the RFLink device next to the HA server is not optimal or desired (eg: bad reception). -To expose the usb/serial interface over TCP on a different host (Linux) the following command can be used: +To expose the USB/serial interface over TCP on a different host (Linux) the following command can be used: ```bash $ socat /dev/ttyACM0,b57600 TCP-LISTEN:1234,reuseaddr @@ -65,7 +71,7 @@ Other methods of exposing the serial interface over TCP are possible (eg: ESP826 Tested with Wifi serial bridge [esp-link V2.2.3](https://github.com/jeelabs/esp-link/releases/tag/v2.2.3) running on a NodeMCU (ESP8266 Wifi module) with ESP8266 TXD0 (pin D10) and RXD0 (pin D9) connected to Arduino MEGA 2560 RX (Pin 2) and TX (Pin 3) respectively.-Due to different logical levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. +Due to different logic levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. The BSS138 bidirectional logic level converter has been tested for serial pins and the [link](https://www.aliexpress.com/item/8CH-IIC-I2C-Logic-Level-Converter-Bi-Directional-Module-DC-DC-5V-to-3-3V-Setp/32238089139.html) is recommended for the CC2500 transceiver (used for Ikea Ansluta and Living Colors)
@@ -81,7 +87,7 @@ rflink:
### {% linkable_title Ignoring devices %}
-Rflink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 Mhz technology.
+RFLink platform can be configured to completely ignore a device on a platform level. This is useful when you have neighbors which also use 433 Mhz technology.
For example:
@@ -102,15 +108,15 @@ Wildcards only work at the end of the ID, not in the middle of front!
### {% linkable_title Device support %}
-Even though a lot of devices are supported by Rflink, not all have been tested/implemented. If you have a device supported by Rflink but not by this component please consider testing and adding support yourself or [create an issue](https://github.com/home-assistant/home-assistant/issues/new) and mention `@aequitas` in the description.
+Even though a lot of devices are supported by RFLink, not all have been tested/implemented. If you have a device supported by RFLink but not by this component please consider testing and adding support yourself or [create an issue](https://github.com/home-assistant/home-assistant/issues/new) and mention `@aequitas` in the description.
### {% linkable_title Device Incorrectly Identified %}
-If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFlink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). http://www.nemcon.nl/blog2/faq#RFFind.
+If you find a device is recognized differently, with different protocols or the ON OFF is swapped or detected as two ON commands, it can be overcome with the RFlink 'RF Signal Learning' mechanism from RFLink Rev 46 (11 March 2017). [Link to further detail.](http://www.nemcon.nl/blog2/faq#RFFind)
### {% linkable_title Technical overview %}
-- The`rflink` Python module a asyncio transport/protocol is setup that fires an callback for every (valid/supported) packet received by the Rflink gateway.
+- The`rflink` Python module a asyncio transport/protocol is setup that fires an callback for every (valid/supported) packet received by the RFLink gateway.
- This component uses this callback to distribute 'rflink packet events' over the HASS bus which can be subscribed to by entities/platform implementations.
- The platform implementions take care of creating new devices (if enabled) for unsees incoming packet id's.
- Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entitiy logic is maintained in this main component.
diff --git a/source/_components/sensor.rflink.markdown b/source/_components/sensor.rflink.markdown
index f07d86606d0..759e51c8ed3 100644
--- a/source/_components/sensor.rflink.markdown
+++ b/source/_components/sensor.rflink.markdown
@@ -1,7 +1,7 @@
---
layout: page
-title: "Rflink Sensor"
-description: "Instructions how to integrate Rflink sensors into Home Assistant."
+title: "RFLink Sensor"
+description: "Instructions how to integrate RFLink sensors into Home Assistant."
date: 2016-01-04
sidebar: true
comments: false
@@ -12,11 +12,11 @@ ha_category: Sensor
ha_release: 0.38
---
-The `rflink` component support devices that use [Rflink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo Rflink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). Rflink gateway is an Arduino firmware that allows communication with 433Mhz devices using cheap hardware (Arduino + 433Mhz tranceiver).
+The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First you have to set up your [rflink hub](/components/rflink/).
-After configuring the Rflink hub sensors will be automatically discovered and added.
+After configuring the RFLink hub sensors will be automatically discovered and added.
New/unknown sensors can be assigned to a default group automatically by specifying the `new_devices_group` option with a group name. If the group doesn't exist it will be created.
@@ -26,10 +26,10 @@ For example:
# Example configuration.yaml entry
sensor:
platform: rflink
- new_devices_group: "New Rflink Sensors"
+ new_devices_group: "New RFLink Sensors"
```
-Rflink sensor ID's are composed of: protocol, id and type (optional). For example: `alectov1_0334_temp`. Some sensors emit multiple types of data. Each will be created as its own
+RFLink sensor ID's are composed of: protocol, id and type (optional). For example: `alectov1_0334_temp`. Some sensors emit multiple types of data. Each will be created as its own
Once the ID of a sensor is known it can be used to configure the sensor in HA, for example to add it to a different group, hide it or configure a nice name.
@@ -52,14 +52,14 @@ Configuration variables:
Device configuration variables:
-- **name** (*Optional*): Name for the device, defaults to Rflink ID.
+- **name** (*Optional*): Name for the device, defaults to RFLink ID.
- **sensor_type** (*Required*): Override automatically detected type of sensor.
- **unit_of_measurement** (*Optional*): Override automatically detected unit of sensor.
-- **aliasses** (*Optional*): Alternative Rflink ID's this device is known by.
+- **aliasses** (*Optional*): Alternative RFLink ID's this device is known by.
### {% linkable_title Hiding/ignoring sensors %}
-Sensors are added automatically when the Rflink gateway intercepts a 433Mhz command in the ether. To prevent cluttering the frontend use any of these methods:
+Sensors are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods:
- Configure a `new_devices_group` for sensors and optionally add it to a different `view`.
- Hide unwanted devices using [customizations](/getting-started/customizing-devices/)
diff --git a/source/_components/switch.rflink.markdown b/source/_components/switch.rflink.markdown
index c2ff4e31b44..92634c58b95 100644
--- a/source/_components/switch.rflink.markdown
+++ b/source/_components/switch.rflink.markdown
@@ -1,7 +1,7 @@
---
layout: page
-title: "Rflink Switch"
-description: "Instructions how to integrate Rflink switches into Home Assistant."
+title: "RFLink Switch"
+description: "Instructions how to integrate RFLink switches into Home Assistant."
date: 2016-01-04
sidebar: true
comments: false
@@ -12,13 +12,13 @@ ha_category: Switch
ha_release: 0.38
---
-The `rflink` component support devices that use [Rflink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo Rflink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). Rflink gateway is an Arduino firmware that allows communication with 433Mhz devices using cheap hardware (Arduino + 433Mhz tranceiver).
+The `rflink` component support devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First you have to set up your [rflink hub](/components/rflink/).
-The Rflink component does not know the difference between a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
+The RFLink component does not know the difference between a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
-Rflink switch/light ID's are composed of: protocol, id, switch. For example: `newkaku_0000c6c2_1`.
+RFLink switch/light ID's are composed of: protocol, id, switch. For example: `newkaku_0000c6c2_1`.
Once the ID of a switch is known it can be used to configure it as a switch type in HA, for example to add it to a different group, hide it or configure a nice name.
@@ -43,21 +43,21 @@ Configuration variables:
- **devices** (*Optional*): A list of devices with their name to use in the frontend.
- **device_defaults**: (*Optional*)
- - **fire_event_** (*Optional*): Set default `fire_event` for Rflink switch devices (see below).
- - **signal_repetitions** (*Optional*): Set default `signal_repetitions` for Rflink switch devices (see below).
+ - **fire_event_** (*Optional*): Set default `fire_event` for RFLink switch devices (see below).
+ - **signal_repetitions** (*Optional*): Set default `signal_repetitions` for RFLink switch devices (see below).
Device configuration variables:
-- **name** (*Optional*): Name for the device, defaults to Rflink ID.
-- **aliasses** (*Optional*): Alternative Rflink ID's this device is known by.
+- **name** (*Optional*): Name for the device, defaults to RFLink ID.
+- **aliasses** (*Optional*): Alternative RFLink ID's this device is known by.
- **fire_event_** (*Optional*): Fire an `button_pressed` event if this device is turned on or off (default: False).
-- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1)
+- **signal_repetitions** (*Optional*): Repeat every RFLink command this number of times (default: 1)
### {% linkable_title Switch state %}
-Initially the state of a switch is unknown. When the switch is turned on or off (via frontend or 433Mhz remote) the state is known and will be shown in the frontend.
+Initially the state of a switch is unknown. When the switch is turned on or off (via frontend or wireless remote) the state is known and will be shown in the frontend.
-Sometimes a switch is controlled by multiple 433Mhz remotes, each remote has its own code programmed in the switch. To allow tracking of the state when switched via other remotes add the corresponding remote codes as aliasses:
+Sometimes a switch is controlled by multiple wireless remotes, each remote has its own code programmed in the switch. To allow tracking of the state when switched via other remotes add the corresponding remote codes as aliasses:
```yaml
# Example configuration.yaml entry
diff --git a/source/_cookbook/automation_telegram_presence_alert.markdown b/source/_cookbook/automation_telegram_presence_alert.markdown
index 634908943eb..c31da51c22a 100644
--- a/source/_cookbook/automation_telegram_presence_alert.markdown
+++ b/source/_cookbook/automation_telegram_presence_alert.markdown
@@ -12,7 +12,7 @@ ha_category: Automation Examples
This will send a message when someone in your known devices list connects to your local network. In other words, when someone arrives home. It will only work if you are using the [nmap](/components/device_tracker.nmap_tracker/) device tracker or a similar component.
-This example uses [/components/notify.telegram/](Telegram) to send the notification.
+This example uses [Telegram](/components/notify.telegram/) to send the notification.
```yaml
notify:
diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown
index 0f5b7355139..fd9d06520ae 100644
--- a/source/_docs/automation/trigger.markdown
+++ b/source/_docs/automation/trigger.markdown
@@ -148,3 +148,20 @@ automation:
# Event is either enter or leave
event: enter # or "leave"
```
+
+
+### {% linkable_title Multiple triggers %}
+
+When your want your automation rule to have multiple triggers, just prefix the first line of each trigger with a dash (-) and indent the lines following accordingly. Whenever one of the triggers fires, your rule is executed.
+
+```yaml
+automation:
+ trigger:
+ # first trigger
+ - platform: time
+ minutes: 5
+ seconds: 00
+ # our second trigger is the sunset
+ - platform: sun
+ event: sunset
+```
diff --git a/source/_docs/backend/database.markdown b/source/_docs/backend/database.markdown
index 2e298a6379f..51266ff7484 100644
--- a/source/_docs/backend/database.markdown
+++ b/source/_docs/backend/database.markdown
@@ -122,5 +122,5 @@ The `VACUUM` command cleans the your database.
sqlite> VACUUM;
```
-For a more interactive way to work with the database or the create statistics, checkout our [Jupyther notebooks](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/tree/master/).
+For a more interactive way to work with the database or the create statistics, checkout our [Jupyter notebooks](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/tree/master/).
diff --git a/source/_cookbook/apache_configuration.markdown b/source/_docs/ecosystem/apache.markdown
similarity index 90%
rename from source/_cookbook/apache_configuration.markdown
rename to source/_docs/ecosystem/apache.markdown
index 65e6364bc2f..e526cc3f79e 100644
--- a/source/_cookbook/apache_configuration.markdown
+++ b/source/_docs/ecosystem/apache.markdown
@@ -1,13 +1,13 @@
---
layout: page
-title: "Apache Configuration"
-description: "Configure Apache to work with home assistant as a subdomain"
+title: "Apache Proxy"
+description: "Configure Apache to work with Home Assistant as a subdomain"
date: 2016-06-20 13:05
sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Infrastructure
+redirect_from: /cookbook/apache_configuration/
---
This example demonstrates how you can configure Apache to act as a proxy for Home Assistant.
@@ -22,7 +22,7 @@ This is useful if you want to have:
So you already have a working Apache server available at example.org. Your Home Assistant is correctly working on this web server and available at http://localhost:8123
-Enable [`mod_proxy_wstunnel`]((https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.htm) by running if you encounter issues while serving Home Assistant through your proxy:
+Enable [`mod_proxy_wstunnel`](https://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.htm) by running if you encounter issues while serving Home Assistant through your proxy:
```bash
$ sudo a2enmod proxy_wstunnel
diff --git a/source/_cookbook/githubbackup.markdown b/source/_docs/ecosystem/backup/backup_github.markdown
similarity index 98%
rename from source/_cookbook/githubbackup.markdown
rename to source/_docs/ecosystem/backup/backup_github.markdown
index 5b46bdfa9d7..2af70720c5c 100644
--- a/source/_cookbook/githubbackup.markdown
+++ b/source/_docs/ecosystem/backup/backup_github.markdown
@@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Infrastructure
+redirect_from: /cookbook/githubbackup/
---
Backing up and regularly syncing your Home Assistant configuration to [GitHub](http://GitHub.com) has several benefits:
@@ -149,7 +149,7 @@ Every time you run this script, you will be prompted for a comment to describe t
[Travis CI](https://travis-ci.org) is a continuous integration testing system that runs every time the code in your repository is updated and allows you to validate that your code works on a fresh install.
-- [Authorise Travis CI](https://travis-ci.org/auth) to have access to your github repos.
+- [Authorise Travis CI](https://travis-ci.org/auth) to have access to your github repos.
- Create the build script that travis will run to test your repo.
- Create a dummy secrets.yaml for Travis.
@@ -159,7 +159,7 @@ language: python
python:
- "3.4"
before_install:
- - mv travis_secrets.yaml secrets.yaml
+ - mv travis_secrets.yaml secrets.yaml
install:
- pip3 install homeassistant
script:
@@ -188,7 +188,7 @@ $ git status
Examples:
```bash
-homeassistant@raspberrypi:~/.homeassistant $ git ls-files
+homeassistant@raspberrypi:~/.homeassistant $ git ls-files
.gitignore
README.md
automation.yaml
diff --git a/source/_cookbook/tls_domain_certificate.markdown b/source/_docs/ecosystem/certificates/tls_domain_certificate.markdown
similarity index 94%
rename from source/_cookbook/tls_domain_certificate.markdown
rename to source/_docs/ecosystem/certificates/tls_domain_certificate.markdown
index fb0d98e31fb..91198ddd4f7 100644
--- a/source/_cookbook/tls_domain_certificate.markdown
+++ b/source/_docs/ecosystem/certificates/tls_domain_certificate.markdown
@@ -7,17 +7,19 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Infrastructure
+redirect_from: /cookbook/tls_domain_certificate/
---
If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. You can use [Self-sign certificate](/cookbook/tls_self_signed_certificate/) but your browser will present a warning and some https-only features might not work.
### {% linkable_title Prerequirement for this guide %}
+
* Your Home Assistant instance is not exposed to the internet. If it is - use [this guide]({{site_root}}/blog/2015/12/13/setup-encryption-using-lets-encrypt/)
* You control a public domain name. The domain doesn't have to point to a site. A domain controlled by a *trusted* friend will do. (A friend you trust not to MITM you)
* Your home router supports custom DNS entries.
### {% linkable_title Run certbot %}
+
```bash
$ mkdir certbot
$ cd certbot
@@ -44,17 +46,21 @@ Press Enter to Continue
```
* Deploy the value to TXT field using your domain registar.
-
* Go to a site that queries domain record. For example [this one](https://mxtoolbox.com/TXTLookup.aspx) and look if it sees your brand new TXT field (Don't forget to enter the full domain: `_acme-challenge.mydomain.com`)
* Press Enter at certbot prompt.
### {% linkable_title Make mydomain.com point to your Home Assistant instance %}
+
If your router uses DNSMasq (for example DDWRT) add the following line to DNSMasq options:
-```
+
+```text
address=/mydomain.com/
-If you deployed Home Assistant via the AiO installer prior to December 2016, replace `sudo su -s /bin/bash homeassistant` with `sudo su -s /bin/bash hass` and `source /srv/homeassistant/homeassistant_venv/bin/activate` with `source /srv/hass/hass_venv/bin/activate`
-If you deployed Home Assistant via the AiO installer prior to December 2016, replace `cd /srv/homeassistant/src/open-zwave-control-panel/` with `cd /srv/hass/src/open-zwave-control-panel/`
-
Don't check the USB box regardless of using a USB based device.
diff --git a/source/_docs/mqtt/certificate.markdown b/source/_docs/mqtt/certificate.markdown
index 71374bc85c1..bf410b916af 100644
--- a/source/_docs/mqtt/certificate.markdown
+++ b/source/_docs/mqtt/certificate.markdown
@@ -22,7 +22,7 @@ mqtt:
Configuration variables:
-- **certificate** (*Optional*): The certificate authority certificate file that is to be treated as trusted by this client. This file should contain the root certificate of the certificate authority that signed your broker's certificate, but may contain multiple certificates. Example: `/home/user/identrust-root.pem`
+- **certificate** (*Optional*): 'auto' or the certificate authority certificate file that is to be treated as trusted by this client. 'auto' uses the bundled certificates. If a file is specified the file should contain the root certificate of the certificate authority that signed your broker's certificate, but may contain multiple certificates. Example: `/home/user/identrust-root.pem`
- **client_key** (*Optional*): Client key, eg. `/home/user/owntracks/cookie.key`.
- **client_cert** (*Optional*): Client certificate, eg. `/home/user/owntracks/cookie.crt`.
diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown
index e8fc9a96b6c..eaf3e07f995 100644
--- a/source/_docs/z-wave.markdown
+++ b/source/_docs/z-wave.markdown
@@ -16,7 +16,7 @@ There is currently support for climate, covers, lights, locks, sensors, switches
### {% linkable_title Installation in Virtualenv (python-OpenZWave) %}
-If you installed Home Assistant using a virtual environment then please read the instructions on [Installing python-OpenZWave in a virtualenv](https://home-assistant.io/getting-started/installation-virtualenv/#installing-python-openzwave-in-a-virtualenv).
+If you installed Home Assistant using a virtual environment then please read the instructions on [Installing python-OpenZWave in a virtualenv](https://home-assistant.io/docs/installation/virtualenv/#installing-python-openzwave-in-a-virtualenv).
### {% linkable_title Installation %}
diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html
index 570697ab600..4bbcd23b184 100644
--- a/source/_includes/asides/docs_navigation.html
+++ b/source/_includes/asides/docs_navigation.html
@@ -136,7 +136,6 @@
@@ -147,7 +146,6 @@
@@ -179,9 +177,24 @@
+
+
+
+