diff --git a/Gemfile.lock b/Gemfile.lock
index de5c2add1eb..48440eeee35 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -53,9 +53,9 @@ GEM
ruby_dep (~> 1.2)
mercenary (0.3.6)
method_source (0.8.2)
- mini_portile2 (2.3.0)
- nokogiri (1.8.2)
- mini_portile2 (~> 2.3.0)
+ mini_portile2 (2.4.0)
+ nokogiri (1.10.1)
+ mini_portile2 (~> 2.4.0)
octopress (3.0.11)
jekyll (>= 2.0)
mercenary (~> 0.3.2)
diff --git a/_config.yml b/_config.yml
index 92d486cdbba..c2f323a8ff4 100644
--- a/_config.yml
+++ b/_config.yml
@@ -32,8 +32,12 @@ destination: public/
plugins_dir: plugins
code_dir: downloads/code
category_dir: blog/categories
+
markdown: kramdown
+highlighter: rouge
timezone: UTC
+liquid:
+ error_mode: strict
kramdown:
input: GFM
@@ -44,8 +48,6 @@ kramdown:
smart_quotes: lsquo,rsquo,ldquo,rdquo
parse_block_html: true
-highlighter: rouge
-
plugins:
- jekyll-redirect-from
- jekyll-time-to-read
@@ -141,9 +143,9 @@ social:
# Home Assistant release details
current_major_version: 0
-current_minor_version: 85
-current_patch_version: 1
-date_released: 2019-01-11
+current_minor_version: 86
+current_patch_version: 0
+date_released: 2019-01-23
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown
index 26d93276cc3..86d5c2316a3 100644
--- a/source/_addons/mosquitto.markdown
+++ b/source/_addons/mosquitto.markdown
@@ -57,7 +57,7 @@ To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the int
#### {% linkable_title Using Mosquitto with Hass.io %}
-1. Install the [Mosquitto add-on](https://www.home-assistant.io/addons/mosquitto/) with the default configuration via 'Hass.io > ADD-ON STORE'. (Don't forget to start the add-on & verify that 'Start on boot' is enabled.)
+1. Install the [Mosquitto add-on](/addons/mosquitto/) with the default configuration via 'Hass.io > ADD-ON STORE'. (Don't forget to start the add-on & verify that 'Start on boot' is enabled.)
2. Create a new user for MQTT via the `Configuration > Users (manage users)`. (Note: This name cannot be "homeassistant" or "addon")
@@ -71,7 +71,7 @@ To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the int
```
Note: .yaml modifications are not required.
-See [testing your setup](https://www.home-assistant.io/docs/mqtt/testing/) to verify the steps above.
+See [testing your setup](/docs/mqtt/testing/) to verify the steps above.
### {% linkable_title Disable listening on insecure (1883) ports %}
diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown
index 01d9bfb8053..0c47d81bb72 100644
--- a/source/_components/alarmdecoder.markdown
+++ b/source/_components/alarmdecoder.markdown
@@ -91,7 +91,7 @@ zones:
required: true
type: string
type:
- description: "A type for the zone. Here you can find a list of [Device Classes](https://www.home-assistant.io/components/binary_sensor/#device-class)."
+ description: "A type for the zone. Here you can find a list of [Device Classes](/components/binary_sensor/#device-class)."
required: false
default: opening
type: string
diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown
index 765d5c91312..4eccd76a044 100644
--- a/source/_components/alert.markdown
+++ b/source/_components/alert.markdown
@@ -255,8 +255,8 @@ alert:
- 30
- 60
- 120
- can_acknowledge: True
- skip_first: True
+ can_acknowledge: true
+ skip_first: true
notifiers:
- ryans_phone
```
diff --git a/source/_components/binary_sensor.command_line.markdown b/source/_components/binary_sensor.command_line.markdown
index 8f499766a42..da5435b7d9f 100644
--- a/source/_components/binary_sensor.command_line.markdown
+++ b/source/_components/binary_sensor.command_line.markdown
@@ -23,9 +23,11 @@ To use your Command binary sensor in your installation, add the following to you
# Example configuration.yaml entry
binary_sensor:
- platform: command_line
- command: cat /proc/sys/net/ipv4/ip_forward
+ command: 'cat /proc/sys/net/ipv4/ip_forward'
```
-
+
+It's highly recommended to enclose the command in single quotes `'` as it ensures all characters can be used in the command and reduces the risk of unintentional escaping. To include a single quote in a command enclosed in single quotes, double it: `''`.
+
{% configuration %}
command:
description: The action to take to get the value.
@@ -78,7 +80,7 @@ Check the state of an [SickRage](https://github.com/sickragetv/sickrage) instanc
# Example configuration.yaml entry
binary_sensor:
- platform: command_line
- command: netstat -na | find "33322" | find /c "LISTENING" > nul && (echo "Running") || (echo "Not running")
+ command: 'netstat -na | find "33322" | find /c "LISTENING" > nul && (echo "Running") || (echo "Not running")'
name: 'sickragerunning'
device_class: moving
payload_on: "Running"
@@ -105,7 +107,7 @@ An alternative solution could look like this:
binary_sensor:
- platform: command_line
name: Printer
- command: ping -W 1 -c 1 192.168.1.10 > /dev/null 2>&1 && echo success || echo fail
+ command: 'ping -W 1 -c 1 192.168.1.10 > /dev/null 2>&1 && echo success || echo fail'
device_class: connectivity
payload_on: "success"
payload_off: "fail"
@@ -134,5 +136,3 @@ binary_sensor:
payload_on: 'active'
payload_off: 'inactive'
```
-
-Note: Use single quotes!
diff --git a/source/_components/binary_sensor.flic.markdown b/source/_components/binary_sensor.flic.markdown
index dd70d2eb4cd..ef22b9b5e8e 100644
--- a/source/_components/binary_sensor.flic.markdown
+++ b/source/_components/binary_sensor.flic.markdown
@@ -19,7 +19,7 @@ The platform does not directly interact with the buttons, *but communicates with
#### {% linkable_title Service setup %}
-If you are using Hass.io, you can run the service locally by [installing](https://www.home-assistant.io/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons). On a Hass.io installation that's not yet based on HassOS, you also need to install the [bluetooth add-on](/addons/bluetooth_bcm43xx/).
+If you are using Hass.io, you can run the service locally by [installing](/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons). On a Hass.io installation that's not yet based on HassOS, you also need to install the [bluetooth add-on](/addons/bluetooth_bcm43xx/).
For instructions on how to install the service manually, visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown
index 64dd7f1daa2..d972e37862c 100644
--- a/source/_components/binary_sensor.mqtt.markdown
+++ b/source/_components/binary_sensor.mqtt.markdown
@@ -93,7 +93,7 @@ force_update:
description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history.
required: false
type: boolean
- default: False
+ default: false
off_delay:
description: "For sensors that only sends `On` state updates, this variable sets a delay in seconds after which the sensor state will be updated back to `Off`."
required: false
diff --git a/source/_components/binary_sensor.pilight.markdown b/source/_components/binary_sensor.pilight.markdown
index 7a5655570b9..b539a5b2778 100644
--- a/source/_components/binary_sensor.pilight.markdown
+++ b/source/_components/binary_sensor.pilight.markdown
@@ -80,6 +80,6 @@ binary_sensor:
payload:
unitcode: 371399
payload_on: 'closed'
- disarm_after_trigger: True
+ disarm_after_trigger: true
reset_delay_sec: 30
```
diff --git a/source/_components/binary_sensor.point.markdown b/source/_components/binary_sensor.point.markdown
index dadf24d5aa8..f12d9275172 100644
--- a/source/_components/binary_sensor.point.markdown
+++ b/source/_components/binary_sensor.point.markdown
@@ -31,5 +31,5 @@ Each Point exposes the following binary sensors:
For installation instructions, see [the Point component](/components/point/).
-The events sent from the Point is also sent as a webhook back to Home Assistant with `event_type` as `point_webhook_received`, please consider the documentation for the [IFTT](https://www.home-assistant.io/components/ifttt/) component on how to write automations for webhooks.
+The events sent from the Point is also sent as a webhook back to Home Assistant with `event_type` as `point_webhook_received`, please consider the documentation for the [IFTT](/components/ifttt/) component on how to write automations for webhooks.
diff --git a/source/_components/binary_sensor.rainmachine.markdown b/source/_components/binary_sensor.rainmachine.markdown
index 0a3072ad0b6..1cf2b676306 100644
--- a/source/_components/binary_sensor.rainmachine.markdown
+++ b/source/_components/binary_sensor.rainmachine.markdown
@@ -17,7 +17,7 @@ The `rainmachine` binary sensor platform allows you to view crucial sensor data
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
-You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)
+You must have the [RainMachine component](/components/rainmachine/)
configured to use this platform. After configuring that component, binary
sensors automatically appear.
-Please remember that [as explained here](https://www.home-assistant.io/docs/configuration/devices/) you can only have a single `automation:` entry. Add the automation to your existing automations.
+Please remember that [as explained here](/docs/configuration/devices/) you can only have a single `automation:` entry. Add the automation to your existing automations.
diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown
index e448407a08f..67002468a92 100644
--- a/source/_components/bmw_connected_drive.markdown
+++ b/source/_components/bmw_connected_drive.markdown
@@ -22,7 +22,7 @@ This component provides the following platforms:
- Device tracker: The location of your car.
- Lock: Control the lock of your car.
- Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars).
- - Services: Turn on air condition, sound the horn, flash the lights and update the state. More details can be found [here](https://www.home-assistant.io/components/bmw_connected_drive/#services).
+ - Services: Turn on air condition, sound the horn, flash the lights and update the state. More details can be found [here](/components/bmw_connected_drive/#services).
## {% linkable_title Configuration %}
diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown
index f47ee421ac3..cfb94721485 100644
--- a/source/_components/calendar.google.markdown
+++ b/source/_components/calendar.google.markdown
@@ -129,7 +129,8 @@ entities:
offset:
description: >
A set of characters that precede a number in the event title
- for designating a pre-trigger state change on the sensor.
+ for designating a pre-trigger state change on the sensor.
+ This should be in the format of HH:MM or MM.
required: false
type: string
default: "!!"
diff --git a/source/_components/camera.ffmpeg.markdown b/source/_components/camera.ffmpeg.markdown
index 7bf659ce119..09f2cffc814 100644
--- a/source/_components/camera.ffmpeg.markdown
+++ b/source/_components/camera.ffmpeg.markdown
@@ -17,7 +17,7 @@ The `ffmpeg` platform allows you to use any video feed as a camera in Home Assis
## {% linkable_title Configuration %}
-To enable your FFmpeg feed in your installation you must first configure the [ffmpeg component](https://www.home-assistant.io/components/ffmpeg/), then add the following to your `configuration.yaml` file:
+To enable your FFmpeg feed in your installation you must first configure the [ffmpeg component](/components/ffmpeg/), then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_components/camera.generic.markdown b/source/_components/camera.generic.markdown
index 013a6bb8c06..f7598dd79f5 100644
--- a/source/_components/camera.generic.markdown
+++ b/source/_components/camera.generic.markdown
@@ -51,7 +51,7 @@ authentication:
default: basic
type: string
limit_refetch_to_url_change:
- description: True/false value. Limits re-fetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image.
+ description: Limits re-fetching of the remote image to when the URL changes. Only relevant if using a template to fetch the remote image.
required: false
default: false
type: boolean
diff --git a/source/_components/camera.synology.markdown b/source/_components/camera.synology.markdown
index 2e0e232a0cb..8cfe0ca8ce3 100644
--- a/source/_components/camera.synology.markdown
+++ b/source/_components/camera.synology.markdown
@@ -74,7 +74,7 @@ camera:
username: YOUR_USERNAME
password: YOUR_PASSWORD
timeout: 15
- verify_ssl: False
+ verify_ssl: false
```
diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown
index c00c004f6e8..68b42151b67 100644
--- a/source/_components/climate.evohome.markdown
+++ b/source/_components/climate.evohome.markdown
@@ -29,7 +29,7 @@ A device's actual operating mode can be tracked via its `device_state_attributes
'zoneId': '999999',
'temperatureStatus': {
'temperature': 21.5,
- 'isAvailable': True
+ 'isAvailable': true
},
'activeFaults': [],
'setpointStatus': {
diff --git a/source/_components/climate.generic_thermostat.markdown b/source/_components/climate.generic_thermostat.markdown
index 53fdaac2f01..15207b93552 100644
--- a/source/_components/climate.generic_thermostat.markdown
+++ b/source/_components/climate.generic_thermostat.markdown
@@ -104,7 +104,7 @@ climate:
target_sensor: sensor.study_temperature
min_temp: 15
max_temp: 21
- ac_mode: False
+ ac_mode: false
target_temp: 17
cold_tolerance: 0.3
hot_tolerance: 0
diff --git a/source/_components/climate.radiotherm.markdown b/source/_components/climate.radiotherm.markdown
index 8dcdd724931..d7ffe2141ca 100644
--- a/source/_components/climate.radiotherm.markdown
+++ b/source/_components/climate.radiotherm.markdown
@@ -62,7 +62,7 @@ hold_temp:
type: boolean
{% endconfiguration %}
-Set `hold_temp: True` if you want temperature settings from Home Assistant to override a thermostat schedule on the thermostat itself. Otherwise Home Assistant will perform temporary temperature changes.
+Set `hold_temp: true` if you want temperature settings from Home Assistant to override a thermostat schedule on the thermostat itself. Otherwise Home Assistant will perform temporary temperature changes.
The away mode functions similarly to the away mode feature of the website and apps, but cannot detect if you set away mode outside of Home Assistant.
diff --git a/source/_components/climate.venstar.markdown b/source/_components/climate.venstar.markdown
index 7667b735434..7337e19f62e 100644
--- a/source/_components/climate.venstar.markdown
+++ b/source/_components/climate.venstar.markdown
@@ -61,7 +61,7 @@ ssl:
description: Whether to use SSL or not when communicating.
required: false
type: boolean
- default: False
+ default: false
timeout:
description: Number of seconds for API timeout.
required: false
@@ -81,9 +81,9 @@ humidifier:
climate:
- platform: venstar
host: IP_OR_HOSTNAME_OF_THERMOSTAT
- ssl: True/False
+ ssl: true
username: OPTIONAL_AUTH_USER_HERE
password: OPTIONAL_AUTH_PASS_HERE
timeout: 5
- humidifier: False
+ humidifier: false
```
diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown
index 89638656559..dd0c1a7c24f 100644
--- a/source/_components/counter.markdown
+++ b/source/_components/counter.markdown
@@ -45,7 +45,7 @@ counter:
description: Try to restore the last known value when Home Assistant starts.
required: false
type: boolean
- default: True
+ default: true
step:
description: Incremental/step value for the counter.
required: false
@@ -61,9 +61,9 @@ Pick an icon that you can find on [materialdesignicons.com](https://materialdesi
### {% linkable_title Restore State %}
-This component will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `True` which is the default. To disable this feature, set `restore` to `False`.
+This component will automatically restore the state it had prior to Home Assistant stopping as long as you your entity has `restore` set to `true` which is the default. To disable this feature, set `restore` to `false`.
-If `restore` is set to `False`, the `initial` value will only be used when no previous state is found or when the counter is reset.
+If `restore` is set to `false`, the `initial` value will only be used when no previous state is found or when the counter is reset.
## {% linkable_title Services %}
diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown
index 768d1e20455..f977166bfe7 100644
--- a/source/_components/cover.rflink.markdown
+++ b/source/_components/cover.rflink.markdown
@@ -91,7 +91,7 @@ devices:
fire_event:
description: Fire a `button_pressed` event if this device is turned on or off.
required: false
- default: False
+ default: false
type: boolean
signal_repetitions:
description: The number of times every Rflink command should repeat.
@@ -100,7 +100,7 @@ devices:
group:
description: Allow light to respond to group commands (ALLON/ALLOFF).
required: false
- default: True
+ default: true
type: boolean
group_aliases:
description: The `aliases` which only respond to group commands.
@@ -118,7 +118,7 @@ device_defaults:
fire_event:
description: The default `fire_event` for Rflink cover devices.
required: false
- default: False
+ default: false
type: boolean
signal_repetitions:
description: The default `signal_repetitions` for Rflink cover devices.
diff --git a/source/_components/cover.rfxtrx.markdown b/source/_components/cover.rfxtrx.markdown
index 801d0644b6b..e68c6324b23 100644
--- a/source/_components/cover.rfxtrx.markdown
+++ b/source/_components/cover.rfxtrx.markdown
@@ -25,7 +25,7 @@ The easiest way to find your roller shutters is to add this to your `configurati
```yaml
cover:
- platform: rfxtrx
- automatic_add: True
+ automatic_add: true
```
Launch your homeassistant and go the website (e.g http://localhost:8123). Push your remote and your device should be added.
@@ -52,7 +52,7 @@ Example configuration:
# Example configuration.yaml entry
cover:
- platform: rfxtrx
- automatic_add: False
+ automatic_add: false
signal_repetitions: 2
devices:
0b1100ce3213c7f210010f70: # Siemens/LightwaveRF
diff --git a/source/_components/cover.rpi_gpio.markdown b/source/_components/cover.rpi_gpio.markdown
index 2026b7bc3b6..635502caeb3 100644
--- a/source/_components/cover.rpi_gpio.markdown
+++ b/source/_components/cover.rpi_gpio.markdown
@@ -44,7 +44,7 @@ relay_time:
invert_relay:
description: Invert the relay pin output so that it is active-high (True).
required: false
- default: False
+ default: false
type: boolean
state_pull_mode:
description: The direction the State pin is pulling. It can be UP or DOWN.
@@ -54,7 +54,7 @@ state_pull_mode:
invert_state:
description: Invert the value of the State pin so that 0 means closed.
required: false
- default: False
+ default: false
type: boolean
covers:
description: List of your doors.
@@ -82,9 +82,9 @@ covers:
cover:
- platform: rpi_gpio
relay_time: 0.2
- invert_relay: False
+ invert_relay: false
state_pull_mode: 'UP'
- invert_state: True
+ invert_state: true
covers:
- relay_pin: 10
state_pin: 11
diff --git a/source/_components/device_tracker.googlehome.markdown b/source/_components/device_tracker.googlehome.markdown
index 34a821bbd36..6389280a22c 100644
--- a/source/_components/device_tracker.googlehome.markdown
+++ b/source/_components/device_tracker.googlehome.markdown
@@ -45,4 +45,4 @@ Devices will appear in the format `devicetracker._
- Note that setting `track_new_devices:false` will still result in new devices being recorded in `known_devices.yaml`, but they won't be tracked (`track: no`).
+ Note that setting `track_new_devices: false` will still result in new devices being recorded in `known_devices.yaml`, but they won't be tracked (`track: false`).
The extended example from above would look like the following sample:
@@ -74,7 +74,7 @@ devicename:
name: Friendly Name
mac: EA:AA:55:E7:C6:94
picture: https://www.home-assistant.io/images/favicon-192x192.png
- track: yes
+ track: true
hide_if_away: false
```
@@ -105,7 +105,7 @@ USERNAME_DEVICE_ID:
mac: EA:AA:55:E7:C6:94
picture: https://www.home-assistant.io/images/favicon-192x192.png
gravatar: test@example.com
- track: yes
+ track: true
hide_if_away: false
```
diff --git a/source/_components/device_tracker.tomato.markdown b/source/_components/device_tracker.tomato.markdown
index bb394f8c56b..2fd6c26ad59 100644
--- a/source/_components/device_tracker.tomato.markdown
+++ b/source/_components/device_tracker.tomato.markdown
@@ -49,7 +49,7 @@ ssl:
type: boolean
default: false
verify_ssl:
- description: "If SSL verification for https resources needs to be turned off (for self-signed certs, etc.) this can take on boolean values `False` or `True` or you can pass a location on the device where a certificate can be used for verification e.g., `/mnt/NAS/router_cert.pem`."
+ description: "If SSL verification for https resources needs to be turned off (for self-signed certs, etc.) this can take on boolean values `false` or `true` or you can pass a location on the device where a certificate can be used for verification e.g., `/mnt/NAS/router_cert.pem`."
required: false
type: [string, boolean]
default: true
diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown
index e7f00e1a74f..b90f327c7d3 100644
--- a/source/_components/dialogflow.markdown
+++ b/source/_components/dialogflow.markdown
@@ -16,7 +16,7 @@ redirect_from: /components/apiai/
The `dialogflow` component is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook.
-To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
+To be able to receive messages from DialogFlow, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms.
diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown
index 9edb7356213..7940b41e73c 100644
--- a/source/_components/ecobee.markdown
+++ b/source/_components/ecobee.markdown
@@ -57,9 +57,9 @@ api_key:
required: true
type: string
hold_temp:
- description: True/False whether or not to hold changes indefinitely (True) or until the next scheduled event.
+ description: Whether or not to hold changes indefinitely (`true`) or until the next scheduled event.
required: false
- default: "`false`"
+ default: false
type: boolean
{% endconfiguration %}
diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown
index b8f0b75396a..648b9d500e1 100644
--- a/source/_components/egardia.markdown
+++ b/source/_components/egardia.markdown
@@ -106,7 +106,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha
host: YOUR_HOST
username: YOUR_USERNAME
password: YOUR_PASSWORD
- report_server_enabled: True
+ report_server_enabled: true
report_server_port: PORT_OF_EGARDIASERVER (optional, defaults to 52010)
report_server_codes:
arm: XXXXXXXXXXXXXXXX, XXXXXXXXXXXXXXXX
diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown
index 74df0d234eb..a014716a649 100644
--- a/source/_components/eight_sleep.markdown
+++ b/source/_components/eight_sleep.markdown
@@ -43,7 +43,7 @@ password:
description: Defines if you'd like to fetch data for both sides of the bed.
required: false
type: string
- default: False
+ default: false
{% endconfiguration %}
### {% linkable_title Supported features %}
diff --git a/source/_components/fan.template.markdown b/source/_components/fan.template.markdown
index 189cad7ad79..a9f2420ec07 100644
--- a/source/_components/fan.template.markdown
+++ b/source/_components/fan.template.markdown
@@ -75,7 +75,7 @@ fan:
required: false
type: template
oscillating_template:
- description: "Defines a template to get the osc state of the fan. Valid value: True/False"
+ description: "Defines a template to get the osc state of the fan. Valid value: true/false"
required: false
type: template
direction_template:
diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown
index 09941498172..5edb773e4b7 100644
--- a/source/_components/frontend.markdown
+++ b/source/_components/frontend.markdown
@@ -68,7 +68,7 @@ frontend:
primary-color: blue
```
-The example above defined two themes named `happy` and `sad`. For each theme you can set values for CSS variables. For a partial list of variables used by the main frontend see [ha-style.js](https://github.com/home-assistant/home-assistant-polymer/blob/master/src/resources/ha-style.js).
+The example above defined two themes named `happy` and `sad`. For each theme you can set values for CSS variables. For a partial list of variables used by the main frontend see [ha-style.ts](https://github.com/home-assistant/home-assistant-polymer/blob/master/src/resources/ha-style.ts).
Check our [community forums](https://community.home-assistant.io/c/projects/themes) to find themes to use.
@@ -101,7 +101,7 @@ To enable "night mode":
```yaml
automation:
- alias: 'Set dark theme for the night'
- initial_state: True
+ initial_state: true
trigger:
- platform: time
at: '21:00'
diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown
index 443aaf14e6d..b6165599f75 100644
--- a/source/_components/google_assistant.markdown
+++ b/source/_components/google_assistant.markdown
@@ -132,7 +132,7 @@ allow_unlock:
description: "When True, allows Google Assistant to unlock locks."
required: false
type: boolean
- default: False
+ default: false
api_key:
description: Your Homegraph API key (for the `google_assistant.request_sync` service)
required: false
@@ -140,7 +140,7 @@ api_key:
expose_by_default:
description: "Expose devices in all supported domains by default. If set to false, you need to either expose domains or add the expose configuration option to each entity in `entity_config` and set it to true."
required: false
- default: True
+ default: true
type: boolean
exposed_domains:
description: List of entity domains to expose to Google Assistant.
diff --git a/source/_components/group.markdown b/source/_components/group.markdown
index 30d3bb01485..e52617c002b 100644
--- a/source/_components/group.markdown
+++ b/source/_components/group.markdown
@@ -61,7 +61,7 @@ name:
required: false
type: string
view:
- description: "If yes then the entry will be shown as a view (tab) at the top. Groups that are set to `view: yes` cannot be used as entities in other views."
+ description: "If yes then the entry will be shown as a view (tab) at the top. Groups that are set to `view: true` cannot be used as entities in other views."
required: false
type: boolean
icon:
diff --git a/source/_components/history.markdown b/source/_components/history.markdown
index f372a33e4a8..c2829753734 100644
--- a/source/_components/history.markdown
+++ b/source/_components/history.markdown
@@ -134,7 +134,7 @@ you can set the flag `use_include_order` to true.
```yaml
# Example configuration.yaml entry using specified entity display order
history:
- use_include_order: True
+ use_include_order: true
include:
entities:
- sun.sun
diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown
index 25faf84b3ff..e19a521331b 100644
--- a/source/_components/homekit.markdown
+++ b/source/_components/homekit.markdown
@@ -180,7 +180,7 @@ A common situation might be if you decide to disable parts of the configuration
## {% linkable_title Disable Auto Start %}
-Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` component is started, can be added. To start `HomeKit` when `auto_start: False`, you can call the service `homekit.start`.
+Depending on your setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully set up when the `HomeKit` component is started, can be added. To start `HomeKit` when `auto_start: false`, you can call the service `homekit.start`.
If you have Z-Wave entities you want to be exposed to HomeKit, then you'll need to disable auto start and then start it after the Z-Wave mesh is ready. This is because the Z-Wave entities won't be fully set up until then. This can be automated using an automation.
@@ -192,7 +192,7 @@ Please remember that you can only have a single `automation` entry. Add the auto
```yaml
# Example for Z-Wave
homekit:
- auto_start: False
+ auto_start: false
automation:
- alias: 'Start HomeKit'
@@ -214,7 +214,7 @@ For a general delay where your component doesn't generate an event, you can also
```yaml
# Example using a delay after the start of Home Assistant
homekit:
- auto_start: False
+ auto_start: false
automation:
- alias: 'Start HomeKit'
@@ -227,6 +227,35 @@ automation:
```
{% endraw %}
+In some cases it might be desirable to check that all entities are available before starting `HomeKit`. This can be accomplished by adding and additional `binary_sensor` as follows:
+
+{% raw %}
+```yaml
+# Example checking specific entities to be available before start
+homekit:
+ auto_start: False
+
+automation:
+ - alias: 'Start HomeKit'
+ trigger:
+ - platform: homeassistant
+ event: start
+ action:
+ - wait_template: >-
+ {% if not states.light.kitchen_lights %}
+ false
+ {% elif not states.sensor.outside_temperature %}
+ false
+ # Repeat for every entity
+ {% else %}
+ true
+ {% endif %}
+ timeout: 00:15 # Waits 15 minutes
+ continue_on_timeout: false
+ - service: homekit.start
+```
+{% endraw %}
+
## {% linkable_title Configure Filter %}
By default, no entity will be excluded. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
@@ -269,7 +298,7 @@ To use `safe_mode`, add the option to your `homekit` config:
```yaml
homekit:
- safe_mode: True
+ safe_mode: true
```
Restart your Home Assistant instance. If you don't see a `pincode`, follow the [guide](#deleting-the-homekitstate-file) here. Now you should be able to pair normally.
@@ -369,7 +398,8 @@ Pairing works fine when the filter is set to only include `demo.demo`, but fails
#### {% linkable_title Pairing hangs - no error %}
-Make sure that you don't try to add more than 100 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repo, so we can resolve it.
+1. Make sure that you don't try to add more than 100 accessories, see [device limit](#device-limit). In rare cases, one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repo, so we can resolve it.
+2. Check logs, and search for `Starting accessory Home Assistant Bridge on address`. Make sure Home Assistant Bridge hook ups to a correct interface. If it did not, explicitly set `homekit.ip_address` configuration variable.
#### {% linkable_title Duplicate AID found when attempting to add accessory %}
diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown
index ad0bd337546..d10b708a7e5 100644
--- a/source/_components/homematic.markdown
+++ b/source/_components/homematic.markdown
@@ -17,7 +17,7 @@ featured: false
The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.
If you are using Homegear with paired [Intertechno](http://intertechno.at/) devices, uni-directional communication is possible as well.
-Device support is available for most of the wired and wireless devices, as well as a lot of IP devices. If you have a setup with mixed protocols, you have to configure additional [interfaces](https://www.home-assistant.io/components/homematic#interfaces) with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 **and** require you to set the `path` setting to `/groups`. When using SSL on a CCU3, by default the same ports as usual with a prepended 4 are available. So 2001 becomes 42001, 2010 becomes 42010 etc..
+Device support is available for most of the wired and wireless devices, as well as a lot of IP devices. If you have a setup with mixed protocols, you have to configure additional [interfaces](/components/homematic#interfaces) with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 **and** require you to set the `path` setting to `/groups`. When using SSL on a CCU3, by default the same ports as usual with a prepended 4 are available. So 2001 becomes 42001, 2010 becomes 42010 etc..
If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute.
diff --git a/source/_components/homeworks.markdown b/source/_components/homeworks.markdown
index f5071fb05af..239df5790c6 100644
--- a/source/_components/homeworks.markdown
+++ b/source/_components/homeworks.markdown
@@ -9,7 +9,7 @@ sharing: true
footer: true
logo: lutron.png
ha_category: Hub
-featured: False
+featured: false
ha_release: 0.85
ha_iot_class: "Local Push"
redirect_from:
diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown
index 32f848d63b8..09b762f8772 100644
--- a/source/_components/ifttt.markdown
+++ b/source/_components/ifttt.markdown
@@ -17,7 +17,7 @@ ha_iot_class: "Cloud Push"
## {% 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 ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)).
+To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)).
To set it up, go to the integrations page in the configuration screen and find IFTTT. Click on configure. Follow the instructions on the screen to configure IFTTT.
diff --git a/source/_components/image_processing.facebox.markdown b/source/_components/image_processing.facebox.markdown
index f2aa6353685..d8253cc0408 100644
--- a/source/_components/image_processing.facebox.markdown
+++ b/source/_components/image_processing.facebox.markdown
@@ -77,7 +77,7 @@ source:
## {% linkable_title Automations %}
-Use the `image_processing.detect_face` events to trigger automations, and breakout the `trigger.event.data` using a [data_template](https://www.home-assistant.io/docs/automation/templating/). The following example automation sends a notification when Ringo Star is recognized:
+Use the `image_processing.detect_face` events to trigger automations, and breakout the `trigger.event.data` using a [data_template](/docs/automation/templating/). The following example automation sends a notification when Ringo Star is recognized:
{% raw %}
```yaml
@@ -139,7 +139,7 @@ You can use an automation to receive a notification when you train a face:
```
{% endraw %}
-Any errors on teaching will be reported in the logs. If you enable [system_log](https://www.home-assistant.io/components/system_log/) events:
+Any errors on teaching will be reported in the logs. If you enable [system_log](/components/system_log/) events:
```yaml
system_log:
diff --git a/source/_components/image_processing.tensorflow.markdown b/source/_components/image_processing.tensorflow.markdown
index 1ecd0591fff..96821aa6b78 100644
--- a/source/_components/image_processing.tensorflow.markdown
+++ b/source/_components/image_processing.tensorflow.markdown
@@ -160,4 +160,4 @@ image_processing:
## {% linkable_title Optimising resources %}
-[Image processing components](https://www.home-assistant.io/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
+[Image processing components](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
diff --git a/source/_components/insteon.markdown b/source/_components/insteon.markdown
index 0eee1e40433..caa63d5d0de 100644
--- a/source/_components/insteon.markdown
+++ b/source/_components/insteon.markdown
@@ -181,7 +181,7 @@ In order for any two Insteon devices to talk with one another, they must be link
If you are looking for more advanced options, you can use the [insteonplm_interactive] command line tool that is distributed with the [insteonplm] Python module. Please see the documentation on the [insteonplm] GitHub site. Alternatively, you can download [HouseLinc] which runs on any Windows PC, or you can use [Insteon Terminal] which is open source and runs on most platforms. SmartHome no longer supports HouseLinc, but it still works. Insteon Terminal is a very useful tool but please read the disclaimers carefully, they are important.
[understanding linking]: http://www.insteon.com/support-knowledgebase/2015/1/28/understanding-linking
-[Development Tools]: https://www.home-assistant.io/docs/tools/dev-tools/
+[Development Tools]: /docs/tools/dev-tools/
[HouseLinc]: https://www.smarthome.com/houselinc.html
[Insteon Terminal]: https://github.com/pfrommerd/insteon-terminal
[insteonplm_interactive]: https://github.com/nugget/python-insteonplm#command-line-interface
diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown
index 4f1b5b2c4a1..9b5f0038255 100644
--- a/source/_components/knx.markdown
+++ b/source/_components/knx.markdown
@@ -93,7 +93,7 @@ local_ip:
```yaml
knx:
- fire_event: True
+ fire_event: true
fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]
```
diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown
index dc7104dba18..b5ed591eda6 100644
--- a/source/_components/konnected.markdown
+++ b/source/_components/konnected.markdown
@@ -21,7 +21,7 @@ The component currently supports the following device types in Home Assistant:
- [Binary Sensor](/components/binary_sensor.konnected/): Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch.
- [Switch](/components/switch.konnected/): Actuate a siren, strobe, buzzer or relay module.
-This component requires the [`discovery`](https://www.home-assistant.io/components/discovery) component to be enabled.
+This component requires the [`discovery`](/components/discovery) component to be enabled.
### {% linkable_title Configuration %}
diff --git a/source/_components/light.flux_led.markdown b/source/_components/light.flux_led.markdown
index 426feb16ae1..33efa06d021 100644
--- a/source/_components/light.flux_led.markdown
+++ b/source/_components/light.flux_led.markdown
@@ -80,7 +80,7 @@ Will automatically search and add all lights on start up:
# Example configuration.yaml entry
light:
- platform: flux_led
- automatic_add: True
+ automatic_add: true
```
Will add two lights with given name and create an automation rule to randomly set color each 45 seconds:
diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown
index 4afcd0da978..6ad68f8e898 100644
--- a/source/_components/light.mqtt.markdown
+++ b/source/_components/light.mqtt.markdown
@@ -588,7 +588,7 @@ light:
name: mqtt_json_hs_light
state_topic: "home/light"
command_topic: "home/light/set"
- hs: True
+ hs: true
```
Home Assistant expects the hue values to be in the range 0 to 360 and the saturation values to be scaled from 0 to 100. For example, the following is a blue color shade:
diff --git a/source/_components/light.nanoleaf_aurora.markdown b/source/_components/light.nanoleaf_aurora.markdown
index 9127387e298..dc0805ffeb0 100644
--- a/source/_components/light.nanoleaf_aurora.markdown
+++ b/source/_components/light.nanoleaf_aurora.markdown
@@ -18,7 +18,7 @@ ha_release: 0.67
The `nanoleaf_aurora` platform allows you to control [Nanoleaf Aurora Light Panels](https://nanoleaf.me) from Home Assistant.
-The preferred way to set up this platform is by enabling the [discovery component](https://www.home-assistant.io/components/discovery/). Make sure to press and hold the *ON* button for 5 seconds (the LED will start flashing) on your Nanoleaf Aurora Panel while Home Assistant is starting.
+The preferred way to set up this platform is by enabling the [discovery component](/components/discovery/). Make sure to press and hold the *ON* button for 5 seconds (the LED will start flashing) on your Nanoleaf Aurora Panel while Home Assistant is starting.
To configure the Aurora lights manually, add the following lines to your `configuration.yaml` file:
diff --git a/source/_components/light.rfxtrx.markdown b/source/_components/light.rfxtrx.markdown
index 6795a5a2e25..553ba93be33 100644
--- a/source/_components/light.rfxtrx.markdown
+++ b/source/_components/light.rfxtrx.markdown
@@ -22,7 +22,7 @@ The easiest way to find your lights is to add this to your `configuration.yaml`:
```yaml
light:
- platform: rfxtrx
- automatic_add: True
+ automatic_add: true
```
Launch your Home Assistant and go the website. Push your remote and your device should be added:
diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown
index 8cb205602e2..2de5f6f171b 100644
--- a/source/_components/light.yeelight.markdown
+++ b/source/_components/light.yeelight.markdown
@@ -66,12 +66,12 @@ devices:
description: Enable music mode.
required: false
type: boolean
- default: False
+ default: false
save_on_change:
description: Saves the bulb state in its nonvolatile memory when changed from Home Assistant.
required: false
type: boolean
- default: False
+ default: false
model:
description: "Yeelight model. Possible values are `mono1`, `color1`, `color2`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`. The setting is used to enable model specific features f.e. a particular color temperature range."
required: false
@@ -141,8 +141,8 @@ light:
192.168.1.25:
name: Living Room
transition: 1000
- use_music_mode: True
- save_on_change: True
+ use_music_mode: true
+ save_on_change: true
```
### {% linkable_title Multiple bulbs %}
diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown
index 33f1e8f62fb..ced06e77a34 100644
--- a/source/_components/lutron.markdown
+++ b/source/_components/lutron.markdown
@@ -9,7 +9,7 @@ sharing: true
footer: true
logo: lutron.png
ha_category: Hub
-featured: False
+featured: false
ha_release: 0.37
ha_iot_class: "Local Polling"
---
diff --git a/source/_components/lutron_caseta.markdown b/source/_components/lutron_caseta.markdown
index 4a42d97b16f..64fc354a4f3 100644
--- a/source/_components/lutron_caseta.markdown
+++ b/source/_components/lutron_caseta.markdown
@@ -9,7 +9,7 @@ sharing: true
footer: true
logo: lutron.png
ha_category: Hub
-featured: False
+featured: false
ha_release: 0.41
ha_iot_class: "Local Polling"
---
diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown
index a0d3fb2dcea..db3085cc1fc 100644
--- a/source/_components/mailgun.markdown
+++ b/source/_components/mailgun.markdown
@@ -12,7 +12,7 @@ ha_category: Notifications
ha_release: 0.38
---
-To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)).
+To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)).
To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun.
diff --git a/source/_components/media_player.denonavr.markdown b/source/_components/media_player.denonavr.markdown
index 8812ba598fb..5d5c95ead98 100644
--- a/source/_components/media_player.denonavr.markdown
+++ b/source/_components/media_player.denonavr.markdown
@@ -48,7 +48,7 @@ media_player:
- platform: denonavr
host: IP_ADDRESS
name: NAME
- show_all_sources: True / False
+ show_all_sources: true
timeout: POSITIVE INTEGER
zones:
- zone: Zone2 / Zone3
diff --git a/source/_components/media_player.emby.markdown b/source/_components/media_player.emby.markdown
index 5e1716de191..bb10654c680 100644
--- a/source/_components/media_player.emby.markdown
+++ b/source/_components/media_player.emby.markdown
@@ -37,7 +37,7 @@ api_key:
required: true
type: string
ssl:
- description: True if you want to connect with HTTPS/WSS. Your SSL certificate must be valid.
+ description: Connect with HTTPS/WSS. Your SSL certificate must be valid.
required: false
default: false
type: boolean
@@ -47,7 +47,7 @@ port:
default: 8096 (No SSL), 8920 (SSL)
type: integer
auto_hide:
- description: True if you want to automatically hide devices that are unavailable from the Home Assistant Interface.
+ description: Automatically hide devices that are unavailable from the Home Assistant Interface.
required: false
default: false
type: boolean
diff --git a/source/_components/media_player.plex.markdown b/source/_components/media_player.plex.markdown
index 9b9bee06655..ef76c47304d 100644
--- a/source/_components/media_player.plex.markdown
+++ b/source/_components/media_player.plex.markdown
@@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
---
-The `plex` platform allows you to connect to a [Plex Media Server](https://plex.tv). Once connected, [Plex Clients](https://www.plex.tv/apps-devices/) playing media from the connected Plex Media Server will show up as [Media Players](https://www.home-assistant.io/components/media_player/) in Home Assistant. It will allow you to control media playback and see the current playing item.
+The `plex` platform allows you to connect to a [Plex Media Server](https://plex.tv). Once connected, [Plex Clients](https://www.plex.tv/apps-devices/) playing media from the connected Plex Media Server will show up as [Media Players](/components/media_player/) in Home Assistant. It will allow you to control media playback and see the current playing item.
## {% linkable_title Setup %}
diff --git a/source/_components/media_player.songpal.markdown b/source/_components/media_player.songpal.markdown
index 0fd9a73f72c..1dbfc0dd8a9 100644
--- a/source/_components/media_player.songpal.markdown
+++ b/source/_components/media_player.songpal.markdown
@@ -9,7 +9,7 @@ sharing: true
footer: true
logo: sony.png
ha_category: Media Player
-ha_iot_class: "Local Polling"
+ha_iot_class: "Local Push"
ha_release: 0.65
---
diff --git a/source/_components/notify.discord.markdown b/source/_components/notify.discord.markdown
index 01fca89820b..6f296ea538e 100644
--- a/source/_components/notify.discord.markdown
+++ b/source/_components/notify.discord.markdown
@@ -18,7 +18,7 @@ In order to get a token you need to go to the [Discord My Apps page](https://dis
Retreive the **Client ID** from the information section and the (hidden) **Token** of your bot for later.
-When setting up the application you can use this [icon](/demo/favicon-192x192.png).
+When setting up the application you can use this [icon](/images/favicon-192x192-full.png).
To use Discord notifications, add the following to your `configuration.yaml` file:
@@ -79,7 +79,7 @@ This channel ID has to be used as the target when calling the notification servi
"0987654321"
],
"data": {
- "images": [
+ "images": [
"/tmp/garage_cam.jpg"
]
}
diff --git a/source/_components/notify.file.markdown b/source/_components/notify.file.markdown
index 7b978d331fc..1fed47e1714 100644
--- a/source/_components/notify.file.markdown
+++ b/source/_components/notify.file.markdown
@@ -35,7 +35,7 @@ filename:
required: true
type: string
timestamp:
- description: Setting `timestamp` to `True` adds a timestamp to every entry.
+ description: Setting `timestamp` to `true` adds a timestamp to every entry.
required: false
default: false
type: boolean
diff --git a/source/_components/notify.group.markdown b/source/_components/notify.group.markdown
index 467ec40282b..a81cc3d6ce0 100644
--- a/source/_components/notify.group.markdown
+++ b/source/_components/notify.group.markdown
@@ -53,9 +53,11 @@ services:
An example on how to use it in an automation:
+{% raw %}
```yaml
action:
service: notify.NAME_OF_NOTIFIER_GROUP
data:
- message: "The sun is {% if is_state('sun.sun', 'above_horizon') %}up{% else %}down{% endif %}!"
+ message: "{% raw %}The sun is {% if is_state('sun.sun', 'above_horizon') %}up{% else %}down{% endif %}{% endraw %}!"
```
+{% endraw %}
diff --git a/source/_components/notify.homematic.markdown b/source/_components/notify.homematic.markdown
index 5ba5dd3b362..3f7cd5f64e0 100644
--- a/source/_components/notify.homematic.markdown
+++ b/source/_components/notify.homematic.markdown
@@ -102,7 +102,7 @@ alert:
name: Temperature too high
done_message: Temperature OK
entity_id: binary_sensor.temperature_too_high
- can_acknowledge: True
+ can_acknowledge: true
notifiers:
- group_hm
```
diff --git a/source/_components/notify.lametric.markdown b/source/_components/notify.lametric.markdown
index f68d978dba3..680b258278d 100644
--- a/source/_components/notify.lametric.markdown
+++ b/source/_components/notify.lametric.markdown
@@ -45,7 +45,7 @@ cycles:
default: 1
priority:
description: Defines the priority of the notification.
- required: False
+ required: false
type: string
default: warning
{% endconfiguration %}
diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown
index debdfaec6cb..937062df83f 100644
--- a/source/_components/opentherm_gw.markdown
+++ b/source/_components/opentherm_gw.markdown
@@ -45,7 +45,7 @@ climate:
type: float
default: "`0.5` for Celsius and `1.0` for Fahrenheit."
floor_temperature:
- description: "Some thermostats round all temperatures down to the lower value according to their precision. Default behavior for Home Assistant is to round temperatures to the nearest value. Set this to `True` to override Home Assistant and round to the lower value according to the configured `precision`."
+ description: "Some thermostats round all temperatures down to the lower value according to their precision. Default behavior for Home Assistant is to round temperatures to the nearest value. Set this to `true` to override Home Assistant and round to the lower value according to the configured `precision`."
required: false
type: boolean
default: false
@@ -392,7 +392,7 @@ opentherm_gw:
climate:
name: Thermostat
precision: 0.5
- floor_temperature: True
+ floor_temperature: true
monitored_variables:
- room_setpoint
- room_temp
diff --git a/source/_components/owntracks.markdown b/source/_components/owntracks.markdown
index 681476cff76..1b2f07dd3f5 100644
--- a/source/_components/owntracks.markdown
+++ b/source/_components/owntracks.markdown
@@ -176,6 +176,6 @@ USERNAME_DEVICE_ID:
mac: EA:AA:55:E7:C6:94
picture: https://www.home-assistant.io/images/favicon-192x192.png
gravatar: test@example.com
- track: yes
- hide_if_away: no
+ track: true
+ hide_if_away: false
```
diff --git a/source/_components/point.markdown b/source/_components/point.markdown
index 7b0d698c49e..4e5fdae6ddc 100644
--- a/source/_components/point.markdown
+++ b/source/_components/point.markdown
@@ -9,7 +9,7 @@ sharing: true
footer: true
logo: minut.svg
ha_category: Hub
-featured: true
+featured: false
ha_release: "0.83"
ha_iot_class: "Cloud Polling"
ha_qa_scale: silver
@@ -41,5 +41,5 @@ client_secret:
The Point is just active occasionally so the sensors are only updated every hour or so.
-The events sent from the Point is sent as a webhook back to Home Assistant with `event_type` as `point_webhook_received`, please consider the documentation for the [IFTT](https://www.home-assistant.io/components/ifttt/) component on how to write automations for webhooks.
+The events sent from the Point is sent as a webhook back to Home Assistant with `event_type` as `point_webhook_received`, please consider the documentation for the [IFTT](/components/ifttt/) component on how to write automations for webhooks.
diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown
index b176681d03e..9017de6e717 100644
--- a/source/_components/qwikswitch.markdown
+++ b/source/_components/qwikswitch.markdown
@@ -75,7 +75,7 @@ sensors:
default: false
type: string
class:
- description: The [class](https://www.home-assistant.io/components/binary_sensor) or binary_sensor. Only applicable to binary_sensors.
+ description: The [class](components/binary_sensor) or binary_sensor. Only applicable to binary_sensors.
required: false
default: door
type: string
diff --git a/source/_components/remote.xiaomi_miio.markdown b/source/_components/remote.xiaomi_miio.markdown
index 4d018dd3752..af8fde86c80 100644
--- a/source/_components/remote.xiaomi_miio.markdown
+++ b/source/_components/remote.xiaomi_miio.markdown
@@ -54,7 +54,7 @@ hidden:
description: Hide the entity from UI. There is currently no reason to show the entity in UI as turning it off or on does nothing.
required: false
type: boolean
- default: True
+ default: true
commands:
required: false
type: map
diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown
index ac0451e6523..7be07531702 100644
--- a/source/_components/rflink.markdown
+++ b/source/_components/rflink.markdown
@@ -68,7 +68,7 @@ reconnect_interval:
# Example configuration.yaml entry
rflink:
port: /dev/serial/by-id/usb-id01234
- wait_for_ack: False
+ wait_for_ack: false
ignore_devices:
- newkaku_000001_01
- digitech_*
@@ -131,7 +131,7 @@ For example:
# Example configuration.yaml entry
rflink:
port: /dev/serial/by-id/usb-id01234
- wait_for_ack: False
+ wait_for_ack: false
ignore_devices:
- newkaku_000001_01
- digitech_*
diff --git a/source/_components/rss_feed_template.markdown b/source/_components/rss_feed_template.markdown
index 8272e106476..4c8612ae2e1 100644
--- a/source/_components/rss_feed_template.markdown
+++ b/source/_components/rss_feed_template.markdown
@@ -23,7 +23,7 @@ rss_feed_template:
# Accessible on /api/rss_template/garden
# Example: https://localhost:8123/api/rss_template/garden
garden:
- requires_api_password: False
+ requires_api_password: false
title: "Garden {% raw %}{{ as_timestamp(now())|timestamp_custom('%H:%M', True) }}{% endraw %}"
items:
- title: "Outside temperature"
diff --git a/source/_components/sensor.daikin.markdown b/source/_components/sensor.daikin.markdown
index ba13c7bceb6..8a1a060c43e 100644
--- a/source/_components/sensor.daikin.markdown
+++ b/source/_components/sensor.daikin.markdown
@@ -3,7 +3,7 @@ layout: page
title: "Daikin AC Sensor"
description: "Instructions on how to integrate Daikin AC(s) with Home Assistant."
date: 2017-12-03 05:00
-sidebar: True
+sidebar: true
comments: false
sharing: true
footer: true
diff --git a/source/_components/sensor.dsmr.markdown b/source/_components/sensor.dsmr.markdown
index a4df6c3f187..0c47292e9cb 100644
--- a/source/_components/sensor.dsmr.markdown
+++ b/source/_components/sensor.dsmr.markdown
@@ -17,7 +17,7 @@ A sensor platform for Dutch Smart Meters which comply to DSMR (Dutch Smart Meter
- Currently support DSMR V2.2, V3, V4 and V5 through the [dsmr_parser](https://github.com/ndokter/dsmr_parser) module by Nigel Dokter.
- For official information about DSMR refer to: [DSMR Document](https://www.netbeheernederland.nl/dossiers/slimme-meter-15)
-- For official information about the P1 port refer to: https://www.wijhebbenzon.nl/media/kunena/attachments/3055/DSMRv5.0FinalP1.pdf
+- For official information about the P1 port refer to:
- For unofficial hardware connection examples refer to: [Domoticx](http://domoticx.com/p1-poort-slimme-meter-hardware/)
@@ -37,13 +37,13 @@ This component is known to work for:
USB serial converters:
- Cheap (Banggood/ebay) Generic PL2303
-- https://sites.google.com/site/nta8130p1smartmeter/webshop
-- https://www.sossolutions.nl/slimme-meter-kabel
-- https://tweakers.net/gallery/269738/aanbod/
+-
+-
+-
Serial to network proxies:
-- ser2net - http://ser2net.sourceforge.net/
+- ser2net -
```yaml
# Example configuration.yaml entry
@@ -138,4 +138,3 @@ The contents of this telegram differ between version but they generally consist
This module sets up an asynchronous reading loop using the `dsmr_parser` module which waits for a complete telegram, parser it and puts it on an async queue as a dictionary of `obis`/object mapping. The numeric value and unit of each value can be read from the objects attributes. Because the `obis` are know for each DSMR version the Entities for this component are create during bootstrap.
Another loop (DSMR class) is setup which reads the telegram queue, stores/caches the latest telegram and notifies the Entities that the telegram has been updated.
-
diff --git a/source/_components/sensor.fail2ban.markdown b/source/_components/sensor.fail2ban.markdown
index 20f46f6f15c..fd0f239026d 100644
--- a/source/_components/sensor.fail2ban.markdown
+++ b/source/_components/sensor.fail2ban.markdown
@@ -164,7 +164,7 @@ Once that's added to the nginx configuration, we need to modify the Home Assista
```yaml
http:
- use_x_forwarded_for: True
+ use_x_forwarded_for: true
```
At this point, once the Let's Encrypt and Home Assistant dockers are restarted, Home Assistant should be correctly logging the originating IP of any failed login attempt. Once that's done and verified, we can move onto the final step.
diff --git a/source/_components/sensor.fastdotcom.markdown b/source/_components/sensor.fastdotcom.markdown
index 5e9eb9d22af..5a6654dda7f 100644
--- a/source/_components/sensor.fastdotcom.markdown
+++ b/source/_components/sensor.fastdotcom.markdown
@@ -59,7 +59,7 @@ hour:
required: false
type: list
manual:
- description: True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests.
+ description: Turn manual mode on or off. Manual mode will disable scheduled speedtests.
required: false
default: false
type: boolean
diff --git a/source/_components/sensor.jewish_calendar.markdown b/source/_components/sensor.jewish_calendar.markdown
index 2c13d7e1ca5..6aa67ab5346 100644
--- a/source/_components/sensor.jewish_calendar.markdown
+++ b/source/_components/sensor.jewish_calendar.markdown
@@ -43,7 +43,7 @@ longitude:
diaspora:
required: false
description: Consider the location as diaspora or not for calculation of the weekly portion and holidays.
- default: False
+ default: false
type: string
candle_lighting_minutes_before_sunset:
required: false
diff --git a/source/_components/sensor.kwb.markdown b/source/_components/sensor.kwb.markdown
index e8d5493674c..5ed109dff6a 100644
--- a/source/_components/sensor.kwb.markdown
+++ b/source/_components/sensor.kwb.markdown
@@ -27,7 +27,7 @@ Direct connection via serial port:
name: kwb
device: "/dev/ttyUSB0"
type: serial
- raw: False
+ raw: false
```
Telnet terminal server with a serial-ethernet converter:
@@ -39,7 +39,7 @@ Telnet terminal server with a serial-ethernet converter:
host:
port: 23
type: tcp
- raw: False
+ raw: false
```
Take a good look at which configuration variables are for `TCP` use or for `serial` use.
diff --git a/source/_components/sensor.mitemp_bt.markdown b/source/_components/sensor.mitemp_bt.markdown
index d7bdbccaffe..5cf0f59fb12 100644
--- a/source/_components/sensor.mitemp_bt.markdown
+++ b/source/_components/sensor.mitemp_bt.markdown
@@ -20,7 +20,7 @@ The `mitemp_bt` sensor platform allows one to monitor room temperature and humid
Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system:
- On [Hass.io](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does).
-- On a [generic Docker installation](https://www.home-assistant.io/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
+- On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
- On other Linux systems:
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown
index 3345162f9db..bc6b78b8e30 100644
--- a/source/_components/sensor.modbus.markdown
+++ b/source/_components/sensor.modbus.markdown
@@ -78,7 +78,7 @@ registers:
reverse_order:
description: Reverse the order of registers when count >1.
required: false
- default: False
+ default: false
type: boolean
scale:
description: Scale factor (output = scale * value + offset).
diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown
index e6e4d92cfe8..6275510999d 100644
--- a/source/_components/sensor.mqtt.markdown
+++ b/source/_components/sensor.mqtt.markdown
@@ -63,7 +63,7 @@ force_update:
description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history.
reqired: false
type: boolean
- default: False
+ default: false
availability_topic:
description: The MQTT topic subscribed to receive availability (online/offline) updates.
required: false
diff --git a/source/_components/sensor.rainmachine.markdown b/source/_components/sensor.rainmachine.markdown
index 4db41b38eaf..76228738190 100644
--- a/source/_components/sensor.rainmachine.markdown
+++ b/source/_components/sensor.rainmachine.markdown
@@ -17,7 +17,7 @@ The `rainmachine` sensor platform allows you to view crucial sensor data within
a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
-You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)
+You must have the [RainMachine component](/components/rainmachine/)
configured to use this platform. After configuring that component, sensors
automatically appear.
diff --git a/source/_components/sensor.rest.markdown b/source/_components/sensor.rest.markdown
index 672f89517bf..98958f3797f 100644
--- a/source/_components/sensor.rest.markdown
+++ b/source/_components/sensor.rest.markdown
@@ -70,7 +70,7 @@ verify_ssl:
description: Verify the SSL certificate of the endpoint.
required: false
type: boolean
- default: True
+ default: true
unit_of_measurement:
description: Defines the units of measurement of the sensor, if any.
required: false
@@ -99,7 +99,7 @@ force_update:
description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history.
reqired: false
type: boolean
- default: False
+ default: false
{% endconfiguration %}
diff --git a/source/_components/sensor.rfxtrx.markdown b/source/_components/sensor.rfxtrx.markdown
index 6f12abc4173..2fbb9dbaf24 100644
--- a/source/_components/sensor.rfxtrx.markdown
+++ b/source/_components/sensor.rfxtrx.markdown
@@ -21,7 +21,7 @@ The easiest way to find your sensors is to add this to your `configuration.yaml`
# Example configuration.yaml entry
sensor:
platform: rfxtrx
- automatic_add: True
+ automatic_add: true
```
Then when the sensor emits a signal it will be automatically added:
@@ -76,11 +76,11 @@ Example configuration:
# Example configuration.yaml entry
sensor:
platform: rfxtrx
- automatic_add: True
+ automatic_add: true
devices:
0a52080705020095220269:
name: Lving
- fire_event: True
+ fire_event: true
0a520802060100ff0e0269:
name: Bath
data_type:
diff --git a/source/_components/sensor.ruter.markdown b/source/_components/sensor.ruter.markdown
index 1735623e084..a67bb96fa02 100644
--- a/source/_components/sensor.ruter.markdown
+++ b/source/_components/sensor.ruter.markdown
@@ -14,7 +14,7 @@ ha_release: 0.83
---
-The API used for this sensor is shutting down soon, you should consider starting to use the [`entur_public_transport`](https://www.home-assistant.io/components/sensor.entur_public_transport/) sensor before that happen.
+The API used for this sensor is shutting down soon, you should consider starting to use the [`entur_public_transport`](/components/sensor.entur_public_transport/) sensor before that happen.
To read the deprecation warning visit [ruter.no/labs](https://ruter.no/labs/),
diff --git a/source/_components/sensor.tellstick.markdown b/source/_components/sensor.tellstick.markdown
index f25207d60bd..54b39da34f2 100644
--- a/source/_components/sensor.tellstick.markdown
+++ b/source/_components/sensor.tellstick.markdown
@@ -28,7 +28,7 @@ sensor:
required: false
type: string
only_named:
- description: Only show the named sensors. Set to `True` to hide sensors.
+ description: Only show the named sensors. Set to `true` to hide sensors.
required: false
default: false
type: boolean
@@ -56,7 +56,7 @@ sensor:
- platform: tellstick
135: Outside
21: Inside
- only_named: True
+ only_named: true
temperature_scale: "°C"
datatype_mask: 1
```
diff --git a/source/_components/sensor.uk_transport.markdown b/source/_components/sensor.uk_transport.markdown
index b08b42895f9..ce0d0e813b0 100644
--- a/source/_components/sensor.uk_transport.markdown
+++ b/source/_components/sensor.uk_transport.markdown
@@ -147,4 +147,8 @@ And the template sensor for viewing the next bus attributes.
value_template: {% raw %}'{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].estimated}}'{% endraw %}
```
+## {% linkable_title Managing API requests %}
+
+If you wish to manage the rate of API requests (e.g., to disable requests when you aren't interested in travel, so that you can request updates more frequently when you do travel) set a really long `scan_interval` in the config options, and use the service `homeassistant.update_entity` to request the update of an entity, rather than waiting for the next scheduled update.
+
Powered by [transportAPI](http://www.transportapi.com/)
diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown
index a6a61d7ae98..5b7d762d92b 100644
--- a/source/_components/switch.arest.markdown
+++ b/source/_components/switch.arest.markdown
@@ -29,7 +29,7 @@ switch:
name: Fan
13:
name: Switch
- invert: True
+ invert: true
```
If you want to use custom functions, then add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.flux.markdown b/source/_components/switch.flux.markdown
index dccaf1ba957..68e87e72f19 100644
--- a/source/_components/switch.flux.markdown
+++ b/source/_components/switch.flux.markdown
@@ -108,7 +108,7 @@ switch:
sunset_colortemp: 3000
stop_colortemp: 1900
brightness: 200
- disable_brightness_adjust: True
+ disable_brightness_adjust: true
mode: xy
transition: 30
interval: 60
diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown
index 60ce92daadd..c6219ed3ee1 100644
--- a/source/_components/switch.modbus.markdown
+++ b/source/_components/switch.modbus.markdown
@@ -86,7 +86,7 @@ register:
verify_state:
description: Define if is possible to readback the status of the switch.
required: false
- default: True
+ default: true
type: boolean
verify_register:
description: Register to readback.
diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown
index 283ec133758..461785439d6 100644
--- a/source/_components/switch.mqtt.markdown
+++ b/source/_components/switch.mqtt.markdown
@@ -140,7 +140,7 @@ Make sure that your topic matches exactly. `some-topic/` and `some-topic` are di
## {% linkable_title Examples %}
-In this section you will find some real-life examples of how to use this sensor.
+In this section, you will find some real-life examples of how to use this sensor.
### {% linkable_title Full configuration %}
@@ -163,20 +163,20 @@ switch:
retain: true
```
-For a check you can use the command line tools `mosquitto_pub` shipped with `mosquitto` to send MQTT messages. This allows you to operate your switch manually:
+For a check, you can use the command line tools `mosquitto_pub` shipped with `mosquitto` to send MQTT messages. This allows you to operate your switch manually:
```bash
-$ mosquitto_pub -h 127.0.0.1 -t home/bedroom/switch1 -m "ON"
+mosquitto_pub -h 127.0.0.1 -t home/bedroom/switch1 -m "ON"
```
### {% linkable_title Set the state of a device with ESPEasy %}
-Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" is a name ("Unit Name:") set for your device (here it's "bathroom"). A configuration for a "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example the topics are prefixed with "home". There is no further configuration needed as the [GPIOs](https://www.letscontrolit.com/wiki/index.php/GPIO) can be controlled with MQTT directly.
+Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" is a name ("Unit Name:") set for your device (here it's "bathroom"). A configuration for a "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example, the topics are prefixed with "home". There is no further configuration needed as the [GPIOs](https://www.letscontrolit.com/wiki/index.php/GPIO) can be controlled with MQTT directly.
Manually you can set pin 13 to high with `mosquitto_pub` or another MQTT tool:
```bash
-$ mosquitto_pub -h 127.0.0.1 -t home/bathroom/gpio/13 -m "1"
+mosquitto_pub -h 127.0.0.1 -t home/bathroom/gpio/13 -m "1"
```
The configuration will look like the example below:
@@ -193,4 +193,3 @@ switch:
payload_off: "0"
```
{% endraw %}
-
diff --git a/source/_components/switch.mysensors.markdown b/source/_components/switch.mysensors.markdown
index 91d5c2e17aa..d2bbb9a26af 100644
--- a/source/_components/switch.mysensors.markdown
+++ b/source/_components/switch.mysensors.markdown
@@ -15,9 +15,11 @@ ha_iot_class: "Local Push"
Integrates MySensors switches into Home Assistant. See the [main component] for configuration instructions.
+## {% linkable_title Supported actuator types %}
+
The following actuator types are supported:
-##### MySensors version 1.4 and higher
+### {% linkable_title MySensors version 1.4 and higher %}
S_TYPE | V_TYPE
---------|-------------------
@@ -28,7 +30,7 @@ S_LIGHT | V_LIGHT
S_LOCK | V_LOCK_STATUS
S_IR | V_IR_SEND, V_LIGHT
-##### MySensors version 1.5 and higher
+### {% linkable_title MySensors version 1.5 and higher %}
S_TYPE | V_TYPE
-------------|----------------------
@@ -40,7 +42,7 @@ S_SOUND | V_ARMED
S_VIBRATION | V_ARMED
S_MOISTURE | V_ARMED
-##### MySensors version 2.0 and higher
+### {% linkable_title MySensors version 2.0 and higher %}
S_TYPE | V_TYPE
----------------|---------
@@ -50,7 +52,7 @@ All V_TYPES for each S_TYPE above are required to activate the actuator for the
For more information, visit the [serial api] of MySensors.
-### {% linkable_title Services %}
+## {% linkable_title Services %}
The MySensors switch platform exposes a service to change an IR code attribute for an IR switch device and turn the switch on. The IR switch will automatically be turned off after being turned on, if `optimistic` is set to `true` in the [config](/components/mysensors/#configuration) for the MySensors component. This will simulate a push button on a remote. If `optimistic` is `false`, the MySensors device will have to report its updated state to reset the switch. See the [example sketch](#ir-switch-sketch) for the IR switch below.
@@ -63,7 +65,7 @@ The service can be used as part of an automation script. For example:
```yaml
# Example configuration.yaml automation entry
automation:
- - alias: turn hvac on
+ - alias: Turn HVAC on
trigger:
platform: time
at: '5:30:00'
@@ -73,7 +75,7 @@ automation:
data:
V_IR_SEND: '0xC284' # the IR code to send
- - alias: turn hvac off
+ - alias: Turn HVAC off
trigger:
platform: time
at: '0:30:00'
@@ -84,9 +86,10 @@ automation:
V_IR_SEND: '0xC288' # the IR code to send
```
-### {% linkable_title Example sketches %}
+## {% linkable_title Example sketches %}
+
+### {% linkable_title Switch sketch %}
-#### {% linkable_title Switch sketch %}
```cpp
/*
* Documentation: http://www.mysensors.org
@@ -131,7 +134,8 @@ void incomingMessage(const MyMessage &message)
}
```
-#### {% linkable_title IR switch sketch %}
+### {% linkable_title IR switch sketch %}
+
```cpp
/*
* Documentation: http://www.mysensors.org
diff --git a/source/_components/switch.mystrom.markdown b/source/_components/switch.mystrom.markdown
index 8d2f93dc439..1d7627af32f 100644
--- a/source/_components/switch.mystrom.markdown
+++ b/source/_components/switch.mystrom.markdown
@@ -13,8 +13,7 @@ ha_release: 0.9
ha_iot_class: "Local Polling"
---
-
-The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/en/) switches. The built-in sensor is measuring the power consumption while the switch is on.
+The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/en/) switches. The built-in sensor is measuring the power consumption while the switch is on.
## {% linkable_title Setup %}
@@ -24,7 +23,6 @@ Make sure that you have enabled the REST API under **Advanced** in the web front
-
## {% linkable_title Configuration %}
To use your myStrom switch in your installation, add the following to your `configuration.yaml` file:
@@ -53,18 +51,18 @@ Check if you are able to access the device located at `http://IP_ADRRESS`. The d
```bash
$ curl -X GET -H "Content-Type: application/json" http://IP_ADDRESS/report
{
- "power": 0,
- "relay": false
+ "power": 0,
+ "relay": false
}
```
or change its state:
```bash
-$ curl -G -X GET http://IP_ADDRESS/relay -d 'state=1'
+curl -G -X GET http://IP_ADDRESS/relay -d 'state=1'
```
-### {% linkable_title Get the current power consumption %}
+## {% linkable_title Get the current power consumption %}
The switch is measuring the current power consumption. To expose this as a sensor use a [`template` sensor](/components/sensor.template/).
@@ -80,4 +78,3 @@ sensor:
value_template: "{{ states.switch.office.attributes.current_power_w }}"
```
{% endraw %}
-
diff --git a/source/_components/switch.pencom.markdown b/source/_components/switch.pencom.markdown
index fb26f7b3231..7718b88d2a7 100644
--- a/source/_components/switch.pencom.markdown
+++ b/source/_components/switch.pencom.markdown
@@ -13,11 +13,11 @@ ha_release: 0.85
ha_iot_class: "Local Polling"
---
-[Pencom Design](http://www.pencomdesign.com/) is a manufacturer of computer controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards/) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read.
+[Pencom Design](http://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards/) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read.
## {% linkable_title Configuration %}
-The Pencom relays can be daisychained to allow for up to 8 boards.
+The Pencom relays can be daisy-chained to allow for up to 8 boards.
``` yaml
# Example configuration.yaml entry
@@ -25,10 +25,10 @@ switch:
- platform: pencom
host: host.domain.com
port: 4001
- boards: 2
+ boards: 2
relays:
- name: "Irrigation"
- addr: 0
+ addr: 0
- name: "Upper Entry Door"
addr: 1
- name: "Fountain"
@@ -46,13 +46,13 @@ port:
required: true
type: port (positive integer between 1-65535)
boards:
- description: Number of boards daisychained together (default is 1).
+ description: Number of boards daisy-chained together (default is 1).
required: false
type: int between 1 and 8
relays:
- description: List of relays.
+ description: List of relays.
required: true
- type: list
+ type: list
keys:
name:
description: The name of the switch (component).
diff --git a/source/_components/switch.qwikswitch.markdown b/source/_components/switch.qwikswitch.markdown
index 805e47d5fe5..7307fefd74b 100644
--- a/source/_components/switch.qwikswitch.markdown
+++ b/source/_components/switch.qwikswitch.markdown
@@ -13,7 +13,6 @@ ha_iot_class: "Local Push"
ha_release: "0.20"
---
-
The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays as switches from within Home Assistant.
If the device name in the QS Mobile application ends with `Switch` it will be created as a switch, otherwise as a [light](/components/light.qwikswitch/).
diff --git a/source/_components/switch.rainmachine.markdown b/source/_components/switch.rainmachine.markdown
index 982220ccacb..a098979275a 100644
--- a/source/_components/switch.rainmachine.markdown
+++ b/source/_components/switch.rainmachine.markdown
@@ -14,10 +14,10 @@ ha_release: 0.51
---
The `rainmachine` switch platform allows you to control programs and zones
-within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
+within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
-You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)
+You must have the [RainMachine component](/components/rainmachine/)
configured to use this platform. After configuring that component, switches will
automatically appear.
@@ -28,8 +28,7 @@ After Home Assistant loads, new switches will be added for every enabled
program and zone. These work as expected:
- Program On/Off: starts/stops a program
-- Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to
-determine how long to run for)
+- Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to determine how long to run for)
Programs and zones are linked. While a program is running, you will see both
the program and zone switches turned on; turning either one off will turn the
diff --git a/source/_components/switch.raspihats.markdown b/source/_components/switch.raspihats.markdown
index 37f31ad59a4..7cd9fccddfd 100644
--- a/source/_components/switch.raspihats.markdown
+++ b/source/_components/switch.raspihats.markdown
@@ -13,12 +13,11 @@ ha_release: 0.45
ha_iot_class: "Local Push"
---
-
-The `raspihats` switch platform allows you to control the digital outputs of your [raspihats](http://www.raspihats.com/) boards.
+The `raspihats` switch platform allows you to control the digital outputs of your [Raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %}
-To use your raspihats boards in your installation, add the following to your `configuration.yaml` file:
+To use your Raspihats boards in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -96,12 +95,12 @@ $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-de
$ sudo usermod -a -G i2c homeassistant
```
-### {% linkable_title Check the i2c address of the sensor %}
+## {% linkable_title Check the i2c address of the sensor %}
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address:
```bash
-$ /usr/sbin/i2cdetect -y 1
+/usr/sbin/i2cdetect -y 1
```
It will output a table like this:
diff --git a/source/_components/switch.raspyrfm.markdown b/source/_components/switch.raspyrfm.markdown
index b9f3beb3af8..464ec8f5af5 100644
--- a/source/_components/switch.raspyrfm.markdown
+++ b/source/_components/switch.raspyrfm.markdown
@@ -17,8 +17,9 @@ The `raspyrfm` component adds support for cheap RC 433 MHz outlets via one of th
Initially, this component was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir though like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM/blob/master/connair.py) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi.
-Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this component like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html)
-
+Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this component like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html).
+
+## {% linkable_title Configuration %}
```yaml
# Example configuration.yaml entry
@@ -77,15 +78,15 @@ switches:
type: dict
{% endconfiguration %}
-### {% linkable_title Device support %}
+## {% linkable_title Device support %}
Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to check what gateways and control units (outlets) are supported.
-### {% linkable_title Channel configuration %}
+## {% linkable_title Channel configuration %}
Depending on the control unit the channel config can have varying formats. Have a look at the underlying library [raspyrfm-client](https://github.com/markusressel/raspyrfm-client) to find out about a specific model.
-### {% linkable_title Switch state %}
+## {% linkable_title Switch state %}
Initially, the state of a switch is unknown. When the switch is turned on or off (via frontend) the state is known and will be shown in the frontend.
@@ -93,7 +94,7 @@ Initially, the state of a switch is unknown. When the switch is turned on or off
Note that due to the way those cheap RC units work it is **not possible to query their current state**. Therefore the only way to preserve a consistent state within Home Assistant is to only use Home Assistant as the controller.
-### {% linkable_title Full example %}
+## {% linkable_title Full example %}
```yaml
switch:
diff --git a/source/_components/switch.recswitch.markdown b/source/_components/switch.recswitch.markdown
index e5f1ba62fc3..c1462baecc3 100644
--- a/source/_components/switch.recswitch.markdown
+++ b/source/_components/switch.recswitch.markdown
@@ -17,10 +17,11 @@ ha_iot_class: "Local Polling"
The `recswitch` switch platform allows you to control the Ankuoo Rec Switch devices.
Supported devices (tested):
+
- Ankuoo RecSwitch MS6126
- Lumitek CSW201 NEO WiFi
-### {% linkable_title Configuration %}
+## {% linkable_title Configuration %}
To enable this switch, add the following lines to your `configuration.yaml`:
diff --git a/source/_components/switch.rflink.markdown b/source/_components/switch.rflink.markdown
index 0b8840479e2..01827474f7b 100644
--- a/source/_components/switch.rflink.markdown
+++ b/source/_components/switch.rflink.markdown
@@ -12,15 +12,17 @@ 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 two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
+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/).
+## {% linkable_title Configuration %}
+
+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.
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.
+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.
Configuring a device as switch with a nice name:
@@ -36,7 +38,6 @@ switch:
name: Ceiling fan
conrad_00785c_0a:
name: Motion sensor kitchen
-
```
{% configuration %}
@@ -92,9 +93,9 @@ devices:
type: boolean
{% endconfiguration %}
-### {% linkable_title Switch state %}
+## {% linkable_title Switch state %}
-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.
+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 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 aliases:
@@ -111,8 +112,8 @@ switch:
- kaku_000001_a
```
-Any on/off command from any alias ID updates the current state of the switch. However when sending a command through the frontend only the primary ID is used.
+Any on/off command from any alias ID updates the current state of the switch. However, when sending a command through the frontend only the primary ID is used.
-### {% linkable_title Device support %}
+## {% linkable_title Device support %}
See [device support](/components/rflink/#device-support)
diff --git a/source/_components/switch.rfxtrx.markdown b/source/_components/switch.rfxtrx.markdown
index 02094e099d5..669ee3770f7 100644
--- a/source/_components/switch.rfxtrx.markdown
+++ b/source/_components/switch.rfxtrx.markdown
@@ -14,6 +14,8 @@ ha_release: 0.7.5
The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz.
+## {% linkable_title Configuration %}
+
First you have to set up your [rfxtrx hub](/components/rfxtrx/).
The easiest way to find your switches is to add this to your `configuration.yaml`:
@@ -21,10 +23,10 @@ The easiest way to find your switches is to add this to your `configuration.yaml
# Example configuration.yaml entry
switch:
platform: rfxtrx
- automatic_add: True
+ automatic_add: true
```
-Launch your Home Assistant and go the website.
+Launch your Home Assistant and go to the website.
Push your remote and your device should be added:
@@ -54,7 +56,7 @@ devices:
required: true
type: string
fire_event:
- description: Fires an event even if the state is the same as before, for example a doorbell switch. Can also be used for automations.
+ description: Fires an event even if the state is the same as before, for example, a doorbell switch. Can also be used for automations.
required: false
default: false
type: boolean
@@ -64,17 +66,17 @@ automatic_add:
default: false
type: boolean
signal_repetitions:
- description: 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.
+ description: 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.
required: false
type: integer
{% endconfiguration %}
-This component and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `False`.
+This component and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
-If a device ID consists of only numbers, please make sure to surround it with quotes.
+If a device ID consists of only numbers, please make sure to surround it with quotes.
This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
@@ -90,7 +92,7 @@ If you need to generate codes for switches you can use a template (useful for ex
```
- Use this code to add a new switch in your configuration.yaml
-- Launch your Home Assistant and go the website.
+- Launch your Home Assistant and go to the website.
- Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket)
- Toggle your new switch in the Home Assistant interface
@@ -102,7 +104,7 @@ Basic configuration with 3 devices:
# Example configuration.yaml entry
switch:
platform: rfxtrx
- automatic_add: False
+ automatic_add: false
signal_repetitions: 2
devices:
0b1100ce3213c7f210010f70:
@@ -111,7 +113,7 @@ switch:
name: Movment2
0b1111e003af16aa10000060:
name: Door
- fire_event: True
+ fire_event: true
```
Light hallway if doorbell is pressed (when is sun down):
@@ -120,7 +122,7 @@ Light hallway if doorbell is pressed (when is sun down):
# Example configuration.yaml entry
switch:
platform: rfxtrx
- automatic_add: False
+ automatic_add: false
devices:
0710014c440f0160:
name: Hall
@@ -129,7 +131,7 @@ switch:
fire_event: true
automation:
- - alias: Switch light on when door bell rings if sun is below horizon and light was off
+ - alias: Switch the light on when doorbell rings if the sun is below the horizon and the light was off
trigger:
platform: event
event_type: button_pressed
@@ -154,7 +156,7 @@ Use remote to enable scene (using event_data):
# Example configuration.yaml entry
switch:
platform: rfxtrx
- automatic_add: False
+ automatic_add: false
devices:
0b1100ce3213c7f210010f70:
name: Light1
diff --git a/source/_components/switch.rpi_gpio.markdown b/source/_components/switch.rpi_gpio.markdown
index 901734b1ee0..c40f8b85ec7 100644
--- a/source/_components/switch.rpi_gpio.markdown
+++ b/source/_components/switch.rpi_gpio.markdown
@@ -13,7 +13,6 @@ ha_release: pre 0.7
ha_iot_class: "Local Push"
---
-
The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
## {% linkable_title Configuration %}
@@ -52,7 +51,7 @@ For more details about the GPIO layout, visit the Wikipedia [article](https://en
Note that a pin managed by HASS is expected to be exclusive to HASS.
-A common question is what does Port refer to, this number is the actual GPIO # not the pin #.
+A common question is what does Port refer to, this number is the actual GPIO #, not the pin #.
For example, if you have a relay connected to pin 11 its GPIO # is 17.
```yaml
diff --git a/source/_components/switch.rpi_rf.markdown b/source/_components/switch.rpi_rf.markdown
index 0c7b52f53b1..1bc16d72f7f 100644
--- a/source/_components/switch.rpi_rf.markdown
+++ b/source/_components/switch.rpi_rf.markdown
@@ -13,7 +13,6 @@ ha_release: 0.19
ha_iot_class: "Assumed state"
---
-
The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/SRD signals with generic low-cost GPIO RF modules on a [Raspberry Pi](https://www.raspberrypi.org/).
Interoperable with codes sniffed via [the rpi-rf module](https://pypi.python.org/pypi/rpi-rf) or [rc-switch](https://github.com/sui77/rc-switch).
@@ -72,11 +71,11 @@ switches:
default: 1
type: integer
pulselength:
- description: Pulselength
+ description: Pulselength.
required: false
type: integer
signal_repetitions:
- description: Number of times to repeat transmission
+ description: Number of times to repeat transmission.
required: false
default: 10
type: integer
diff --git a/source/_components/switch.switchbot.markdown b/source/_components/switch.switchbot.markdown
index ff7e8911b50..a87273de79c 100644
--- a/source/_components/switch.switchbot.markdown
+++ b/source/_components/switch.switchbot.markdown
@@ -13,7 +13,7 @@ ha_release: 0.78
ha_iot_class: "Local Polling"
---
-This `Switchbot` switch platform allow you to control Switchbot [devices]( https://www.switch-bot.com/).
+This `Switchbot` switch platform allows you to control Switchbot [devices]( https://www.switch-bot.com/).
To enable it, add the following lines to your `configuration.yaml`:
@@ -31,5 +31,5 @@ mac:
name:
description: The name used to display the switch in the frontend.
required: false
- type: string
+ type: string
{% endconfiguration %}
diff --git a/source/_components/switch.switchmate.markdown b/source/_components/switch.switchmate.markdown
index bfc26d496c9..03e67161ca6 100644
--- a/source/_components/switch.switchmate.markdown
+++ b/source/_components/switch.switchmate.markdown
@@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
This `Switchmate` switch platform allows you to control Switchmate [devices]( https://www.mysimplysmarthome.com/products/switchmate-switches/).
+## {% linkable_title Configuration %}
+
To enable it, add the following lines to your `configuration.yaml`:
```yaml
@@ -31,13 +33,12 @@ mac:
name:
description: The name used to display the switch in the frontend.
required: false
- type: string
+ type: string
flip_on_off:
description: Option to flip the on/off state.
required: false
- type: boolean
+ type: boolean
default: false
{% endconfiguration %}
-
The component is tested with SwitchMate Lighting Control Rocker and SwitchMate Lighting Control Toggle.
diff --git a/source/_components/switch.tellduslive.markdown b/source/_components/switch.tellduslive.markdown
index 1cfa2c6fc86..e6f2309c108 100644
--- a/source/_components/switch.tellduslive.markdown
+++ b/source/_components/switch.tellduslive.markdown
@@ -13,4 +13,3 @@ featured: false
---
Integrates Telldus Live switches into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.
-
diff --git a/source/_components/switch.tellstick.markdown b/source/_components/switch.tellstick.markdown
index 9de976af4ba..f531c90f1d7 100644
--- a/source/_components/switch.tellstick.markdown
+++ b/source/_components/switch.tellstick.markdown
@@ -12,7 +12,6 @@ ha_category: Switch
ha_iot_class: "Assumed State"
---
-
This `tellstick` switch platform allows you to control [TellStick](http://www.telldus.se/products/tellstick) devices.
To use your TellStick device, you first have to set up your [Tellstick hub](/components/tellstick/) and then add the following to your `configuration.yaml` file:
diff --git a/source/_components/switch.tplink.markdown b/source/_components/switch.tplink.markdown
index 3b9fa0a549a..f6786aaeb04 100644
--- a/source/_components/switch.tplink.markdown
+++ b/source/_components/switch.tplink.markdown
@@ -63,7 +63,7 @@ switch:
host: SECOND_IP_ADDRESS
```
-## {% linkable_title Configure Energy Sensors %} ##
+## {% linkable_title Configure Energy Sensors %}
In order to get the power consumption readings from the HS110, you'll have to create a [template sensor](/components/switch.template/). In the example below, change all of the `my_tp_switch`'s to match your switch's entity ID.
diff --git a/source/_components/switch.transmission.markdown b/source/_components/switch.transmission.markdown
index cf7db2f2f32..11a69c59823 100644
--- a/source/_components/switch.transmission.markdown
+++ b/source/_components/switch.transmission.markdown
@@ -13,9 +13,10 @@ ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
-
The `transmission` switch platform allows you to control your [Transmission](http://www.transmissionbt.com/) client from within Home Assistant. The platform enables you switch to your 'Alternative Speed Limits' (aka 'Turtle mode') setting.
+## {% linkable_title Configuration %}
+
To add Transmission to your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -29,7 +30,7 @@ switch:
host:
required: true
type: string
- description: This is the IP address of your Transmission daemon, e.g., 192.168.1.32.
+ description: This is the IP address of your Transmission daemon, e.g., `192.168.1.32`.
port:
required: false
type: integer
diff --git a/source/_components/switch.tuya.markdown b/source/_components/switch.tuya.markdown
index 6f081aee6cd..28a130e0ce8 100644
--- a/source/_components/switch.tuya.markdown
+++ b/source/_components/switch.tuya.markdown
@@ -1,7 +1,7 @@
---
layout: page
title: "Tuya Switch"
-description: "Instructions on how to setup the Tuya switch within Home Assistant."
+description: "Instructions on how to set up the Tuya switch within Home Assistant."
date: 2018-07-09 09:00
sidebar: true
comments: false
@@ -13,11 +13,10 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.74
---
-
The `tuya` switch platform allows you to control your [Tuya Smart](https://www.tuya.com) switch.
The platform supports switch and socket.
Full configuration details can be found on the main [Tuya component](/components/tuya/) page.
-
\ No newline at end of file
+
diff --git a/source/_components/switch.verisure.markdown b/source/_components/switch.verisure.markdown
index c84b3739f81..ec0a5bd14ed 100644
--- a/source/_components/switch.verisure.markdown
+++ b/source/_components/switch.verisure.markdown
@@ -12,8 +12,6 @@ ha_category: Switch
ha_iot_class: "Cloud Polling"
---
-
The Verisure switch platform allows you to control your [Verisure](https://www.verisure.com/) SmartPlugs.
-The requirement is that you have setup your [Verisure hub](/components/verisure/).
-
+The requirement is that you have set up your [Verisure hub](/components/verisure/).
diff --git a/source/_components/switch.vesync.markdown b/source/_components/switch.vesync.markdown
index b02f476e93e..6d11779b6fe 100644
--- a/source/_components/switch.vesync.markdown
+++ b/source/_components/switch.vesync.markdown
@@ -16,6 +16,8 @@ The `vesync` switch platform enables integration with Etekcity VeSync smart swit
VeSync switches are low-cost wifi smart plugs that offer energy monitoring and work with popular voice assistants.
+## {% linkable_title Configuration %}
+
To use your VeSync switches, you must first register your switches with the VeSync app. Once registration is complete you must add the following to your `configuration.yaml` file:
```yaml
@@ -37,7 +39,7 @@ password:
type: string
{% endconfiguration %}
-### {% linkable_title Exposed Attributes %}
+## {% linkable_title Exposed Attributes %}
VeSync switches will expose the following details.
diff --git a/source/_components/tts.markdown b/source/_components/tts.markdown
index bfc40f912d6..364a2af27ec 100644
--- a/source/_components/tts.markdown
+++ b/source/_components/tts.markdown
@@ -33,7 +33,7 @@ cache:
description: Allow TTS to cache voice file to local storage.
required: false
type: boolean
- default: True
+ default: true
cache_dir:
description: Folder name or path to a folder for caching files.
required: false
diff --git a/source/_components/twilio.markdown b/source/_components/twilio.markdown
index 4908cde575c..f4f60e7cf7e 100644
--- a/source/_components/twilio.markdown
+++ b/source/_components/twilio.markdown
@@ -43,7 +43,7 @@ auth_token:
After configuring the base Twilio component, add and configure either or both of the [twilio SMS](/components/notify.twilio_sms/) and [twilio Phone](/components/notify.twilio_call) components to utilize the notification functionality.
-To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](https://www.home-assistant.io/components/http/#base_url)).
+To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web ([Hass.io instructions](/addons/duckdns/)) and you need to have the `base_url` configured for the HTTP component ([docs](/components/http/#base_url)).
To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio.
diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown
index 1159d02d9a6..cbbe93bf530 100644
--- a/source/_components/vacuum.xiaomi_miio.markdown
+++ b/source/_components/vacuum.xiaomi_miio.markdown
@@ -134,7 +134,7 @@ The following table shows the units of measurement for each attribute:
## {% linkable_title Retrieving the Access Token %}
-As per [`python-miio` issue 185](https://github.com/rytilahti/python-miio/issues/185) the Android Mi Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently, the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) is confirmed as working for the following Android methods. Using an older version than 5.0.30 is not recommended as it might lack support for some newer devices like the Roborock S50.
+As per Version 5.4.49 the Android Mi Home app stores the token readable in the log files. It can easily be retrieved in the folder Smarthome on in the Android device. Just open the text file inside the Smarthome/logs folder and search for the token.
The iPhone app still stores the token in the SQLite db as of v4.10.2 (Dec 22, 2018).
diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown
index 5656606e472..3b4c3e1fe4e 100644
--- a/source/_components/wink.markdown
+++ b/source/_components/wink.markdown
@@ -105,7 +105,7 @@ Error sending local control request. Sending request online
The Wink component only obtains the device states from the Wink API once, during startup. All updates after that are pushed via a third party called PubNub. On rare occasions where an update isn't pushed device states can be out of sync.
-You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `True` states will be pulled from the devices controlling hub, not the online API.
+You can use the service wink/refresh_state_from_wink to pull the most recent state from the Wink API for all devices. If `local_control` is set to `true` states will be pulled from the devices controlling hub, not the online API.
## {% linkable_title Service `pull_newly_added_devices_from_wink` %}
@@ -277,7 +277,7 @@ script:
sequence:
- service: wink.set_siren_strobe_enabled
data:
- enabled: False
+ enabled: false
```
### {% linkable_title Service `set_chime_strobe_enabled` %}
@@ -297,7 +297,7 @@ script:
sequence:
- service: wink.set_chime_strobe_enabled
data:
- enabled: False
+ enabled: false
```
### {% linkable_title Service `set_nimbus_dial_state` %}
diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown
index fe317fce810..decbd7437b8 100644
--- a/source/_components/zabbix.markdown
+++ b/source/_components/zabbix.markdown
@@ -37,7 +37,7 @@ path:
type: string
default: "`/zabbix/`"
ssl:
- description: Set to `True` if your Zabbix installation is using SSL.
+ description: Set to `true` if your Zabbix installation is using SSL.
required: false
type: boolean
default: false
@@ -58,7 +58,7 @@ password:
zabbix:
host: ZABBIX_HOST
path: ZABBIX_PATH
- ssl: False
+ ssl: false
username: USERNAME
password: PASSWORD
```
diff --git a/source/_docs/authentication/multi-factor-auth.markdown b/source/_docs/authentication/multi-factor-auth.markdown
index be55b3118ce..16ecd5b8e87 100644
--- a/source/_docs/authentication/multi-factor-auth.markdown
+++ b/source/_docs/authentication/multi-factor-auth.markdown
@@ -65,7 +65,7 @@ TOTP is _time based_ so it relies on your Home Assistant clock being accurate. I
### {% linkable_title Notify multi-factor authentication module %}
-The Notify MFA module uses the [notify component](https://www.home-assistant.io/components/notify/) to send you an [HMAC-based One-Time Password](https://en.wikipedia.org/wiki/HMAC-based_One-time_Password_algorithm). It is typically sent to your phone, but can be sent to any destination supported by a `notify` service. You use this password to log in.
+The Notify MFA module uses the [notify component](/components/notify/) to send you an [HMAC-based One-Time Password](https://en.wikipedia.org/wiki/HMAC-based_One-time_Password_algorithm). It is typically sent to your phone, but can be sent to any destination supported by a `notify` service. You use this password to log in.
#### {% linkable_title Setting up TOTP %}
diff --git a/source/_docs/automation.markdown b/source/_docs/automation.markdown
index 99ace9bb2e7..de7109405e2 100644
--- a/source/_docs/automation.markdown
+++ b/source/_docs/automation.markdown
@@ -49,14 +49,14 @@ Actions are all about calling services. To explore the available services open t
### {% linkable_title Automation initial state %}
-You have to set an initial state in your automations in order for Home Assistant to always enable them upon restart.
+If you always want your automations to be set to a certain enabled or disabled state upon Home Assistant restart, then you have to set an initial state in your automations. Otherwise, this setting is optional.
```text
automation:
- alias: Automation Name
- initial_state: True
+ initial_state: true
trigger:
...
```
-If you don't set this the previous state is restored. If you shut Home Assistant down before it finishes starting, the automation will be stored as being off, and your automations will be disabled at the next startup.
+If you don't set this then the previous state prior to restart is restored. However, if you shut down Home Assistant again before it finishes starting, any automation that doesn't have the initial state set to `true` will be stored as being off, and those automations will be disabled at the next startup.
diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown
index 48517d9ccda..6a084964d8c 100644
--- a/source/_docs/automation/trigger.markdown
+++ b/source/_docs/automation/trigger.markdown
@@ -115,6 +115,8 @@ automation:
Triggers when the sun is setting or rising. An optional time offset can be given to have it trigger a set time before or after the sun event (i.e. 45 minutes before sunset, when dusk is setting in).
+Sunrise as a trigger may need special attention as explained in time triggers below. This is due to the date changing at midnight and sunrise is at an earlier time on the following day.
+
```yaml
automation:
trigger:
@@ -125,7 +127,7 @@ automation:
offset: '-00:45:00'
```
-Sometimes you may want more granular control over an automation based on the elevation of the sun. This can be used to layer automations to occur as the sun lowers on the horizon or even after it is below the horizon. This is also useful when the "sunset" event is not dark enough outside and you would like the automation to run later at a precise solar angle instead of the time offset such as turning on exterior lighting.
+Sometimes you may want more granular control over an automation based on the elevation of the sun. This can be used to layer automations to occur as the sun lowers on the horizon or even after it is below the horizon. This is also useful when the "sunset" event is not dark enough outside and you would like the automation to run later at a precise solar angle instead of the time offset such as turning on exterior lighting. For most things, a general number like -4 degrees is suitable and is used in this example:
{% raw %}
```yaml
@@ -141,9 +143,15 @@ automation:
service: switch.turn_on
entity_id: switch.exterior_lighting
```
-}{% endraw %}
+{% endraw %}
-The US Naval Observatory has a [tool](http://aa.usno.navy.mil/data/docs/AltAz.php) that will help you estimate what the solar angle will be at any specific time.
+If you want to get more precise, start with the US Naval Observatory [tool](http://aa.usno.navy.mil/data/docs/AltAz.php) that will help you estimate what the solar angle will be at any specific time. Then from this, you can select from the defined twilight numbers. Although the actual amount of light depends on weather, topography and land cover, they are defined as:
+
+- Civil twilight: Solar angle > -6°
+- Nautical twilight: Solar angle > -12°
+- Astronomical twilight: Solar angle > -18°
+
+A very thorough explanation of this is available in the Wikipedia article about the [Twilight](https://en.wikipedia.org/wiki/Twilight).
### {% linkable_title Template trigger %}
@@ -200,6 +208,9 @@ automation 3:
minutes: '/5'
```
+As mentioned in the Sun trigger section, sunrise is a different day than any time prior to midnight. If you want to trigger an action with a large enough amount of time before sunrise that it precedes midnight, this must be accounted for properly. One way is to convert the sunrise time to a timestamp (seconds since 1 Jan 1970). Then do the same for the offset desired (in seconds). This is done with the _as_timestamp_ method explained in the [Templating - Home Assistant template extensions](/docs/configuration/templating/#home-assistant-template-extensions) section.
+
+
### {% linkable_title Webhook trigger %}
Webhook triggers are triggered by web requests made to the webhook endpoint: `/api/webhook/`. This endpoint does not require authentication besides knowing the webhook id. You can either send encoded form or JSON data, available in the template as either `trigger.json` or `trigger.data`.
diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown
index f97eb07c867..6a462d03d43 100644
--- a/source/_docs/configuration.markdown
+++ b/source/_docs/configuration.markdown
@@ -35,10 +35,11 @@ If you run into trouble while configuring Home Assistant, have a look at the [co
## {% linkable_title Reloading changes %}
-You will have to restart Home Assistant for most changes to `configuration.yaml` to take effect. You can load changes to [automations](/docs/automation/), [customize](/docs/configuration/customizing-devices/), [groups](/components/group/), and [scripts](/components/script/) without restarting if you're not using [packages](/docs/configuration/packages/).
+You will have to restart Home Assistant for most changes to `configuration.yaml` to take effect.
+You can load changes to [automations](/docs/automation/), [customize](/docs/configuration/customizing-devices/), [groups](/components/group/), and [scripts](/components/script/) without restarting.
-If you've made any changes, remember to [check your configuration](https://www.home-assistant.io/docs/configuration/troubleshooting/#problems-with-the-configuration) before trying to reload or restart.
+If you've made any changes, remember to [check your configuration](/docs/configuration/troubleshooting/#problems-with-the-configuration) before trying to reload or restart.
## {% linkable_title Migrating to a new system %}
diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown
index cb059e9ebd9..0ef2263845c 100644
--- a/source/_docs/configuration/customizing-devices.markdown
+++ b/source/_docs/configuration/customizing-devices.markdown
@@ -42,17 +42,17 @@ hidden:
description: Set to `true` to hide the entity.
required: false
type: boolean
- default: False
+ default: false
homebridge_hidden:
description: Set to `true` to hide the entity from `HomeBridge`.
required: false
type: boolean
- default: False
+ default: false
emulated_hue_hidden:
description: Set to `true` to hide the entity from `emulated_hue` (this will be deprecated in the near future and should be configured in [`emulated_hue`](/components/emulated_hue)).
required: false
type: boolean
- default: False
+ default: false
entity_picture:
description: URL to use as picture for entity.
required: false
@@ -65,7 +65,7 @@ assumed_state:
description: 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.
required: false
type: boolean
- default: True
+ default: true
device_class:
description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). It does not set the `unit_of_measurement`.
required: false
diff --git a/source/_docs/configuration/group_visibility.markdown b/source/_docs/configuration/group_visibility.markdown
index cab429ce404..230ae78b11b 100644
--- a/source/_docs/configuration/group_visibility.markdown
+++ b/source/_docs/configuration/group_visibility.markdown
@@ -20,7 +20,7 @@ To change visibility of a group, use the service `group.set_visibility`, pass th
service: group.set_visibility
entity_id: group.basement
data:
- visible: False
+ visible: false
```
@@ -42,7 +42,7 @@ automation:
service: group.set_visibility
entity_id: group.basement
data:
- visible: False
+ visible: false
automation 2:
trigger:
@@ -52,7 +52,7 @@ automation 2:
service: group.set_visibility
entity_id: group.basement
data:
- visible: True
+ visible: true
```
## {% linkable_title Easier automations %}
diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown
index 85117013ff5..945f1c3e834 100644
--- a/source/_docs/configuration/securing.markdown
+++ b/source/_docs/configuration/securing.markdown
@@ -55,4 +55,4 @@ For remote access for a component, for example, a device tracker, you have to en
* A [self-signed certificate](/cookbook/tls_self_signed_certificate/) - be warned though, some services will refuse to work with self-signed certificates
3. Optionally use a proxy like [NGINX](/docs/ecosystem/nginx/), [Apache](/cookbook/apache_configuration/), or another. These allow you to provide finer-grained access. You could use this to limit access to specific parts of the API (for example, only `/api/owntracks/`)
4. Enable IP Filtering and configure a low [Login Attempts Threshold](/components/http/)
-5. If you use a proxy then install [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to [monitor your proxy logs](https://www.home-assistant.io/cookbook/fail2ban/) (or Home Assistant logs) for failed authentication
+5. If you use a proxy then install [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to [monitor your proxy logs](/cookbook/fail2ban/) (or Home Assistant logs) for failed authentication
diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown
index 0d61a87c3e1..c04bd04460c 100644
--- a/source/_docs/configuration/splitting_configuration.markdown
+++ b/source/_docs/configuration/splitting_configuration.markdown
@@ -101,7 +101,7 @@ Let's look at the `device_tracker.yaml` file from our example:
hosts: 192.168.2.0/24
home_interval: 3
- track_new_devices: yes
+ track_new_devices: true
interval_seconds: 40
consider_home: 120
```
diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown
index f76ca7086a0..03efee288be 100644
--- a/source/_docs/configuration/troubleshooting.markdown
+++ b/source/_docs/configuration/troubleshooting.markdown
@@ -26,7 +26,7 @@ If you have incorrect entries in your configuration files you can use the [`chec
One of the most common problems with Home Assistant is an invalid `configuration.yaml` file.
- - You can test your configuration using the command line with: `hass --script check_config`. On Hass.io you can use the [hassio command](https://www.home-assistant.io/hassio/commandline/#home-assistant): `hassio homeassistant check`.
+ - You can test your configuration using the command line with: `hass --script check_config`. On Hass.io you can use the [hassio command](/hassio/commandline/#home-assistant): `hassio homeassistant check`.
- You can verify your configuration's yaml structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/).
- To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltstack.com/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well).
diff --git a/source/_docs/ecosystem/ios.markdown b/source/_docs/ecosystem/ios.markdown
index 2bf9d241aba..57c9ad0c579 100644
--- a/source/_docs/ecosystem/ios.markdown
+++ b/source/_docs/ecosystem/ios.markdown
@@ -31,7 +31,7 @@ The `ios` component is the companion component for the Home Assistant iOS app. W
Loading the `ios` component will also load the [`device_tracker`](/components/device_tracker), [`zeroconf`](/components/zeroconf) and [`notify`](/components/notify) platforms.
-In order to save credentials and adjust settings within the iOS Home Assistant app, the optional [`api_password`](/components/http/#api_password) must be set.
+The Home Assistant for iOS app supports the new authentication system introduced in Home Assistant 0.77.
## {% linkable_title Setup %}
diff --git a/source/_docs/ecosystem/ios/notifications/actions.markdown b/source/_docs/ecosystem/ios/notifications/actions.markdown
index 3112ae06a33..9f1493b3d72 100644
--- a/source/_docs/ecosystem/ios/notifications/actions.markdown
+++ b/source/_docs/ecosystem/ios/notifications/actions.markdown
@@ -58,7 +58,7 @@ When sending a notification:
- **identifier** (*Required*): A unique identifier for this action. Must be uppercase and have no special characters or spaces. Only needs to be unique to the category, not unique globally.
- **title** (*Required*): The text to display on the button. Keep it short.
- **activationMode** (*Optional*): The mode in which to run the app when the action is performed. Setting this to `foreground` will make the app open after selecting. Default value is `background`.
-- **authenticationRequired** (*Optional*): If a truthy value (`true`, `True`, `yes`, etc.) the user must unlock the device before the action is performed.
+- **authenticationRequired** (*Optional*): If `true`, the user must unlock the device before the action is performed.
- **destructive** (*Optional*): When the value of this property is a truthy value, the system displays the corresponding button differently to indicate that the action is destructive (text color is red).
- **behavior** (*Optional*): When `textInput` the system provides a way for the user to enter a text response to be included with the notification. The entered text will be sent back to Home Assistant. Default value is `default`.
- **textInputButtonTitle** (*Optional*): The button label. *Required* if `behavior` is `textInput`.
@@ -76,14 +76,14 @@ ios:
- identifier: 'SOUND_ALARM'
title: 'Sound Alarm'
activationMode: 'background'
- authenticationRequired: yes
- destructive: yes
+ authenticationRequired: true
+ destructive: true
behavior: 'default'
- identifier: 'SILENCE_ALARM'
title: 'Silence Alarm'
activationMode: 'background'
- authenticationRequired: yes
- destructive: no
+ authenticationRequired: true
+ destructive: false
behavior: 'textInput'
textInputButtonTitle: 'Silencio!'
textInputPlaceholder: 'Placeholder'
diff --git a/source/_docs/ecosystem/ios/notifications/content_extensions.markdown b/source/_docs/ecosystem/ios/notifications/content_extensions.markdown
index 721386de2e3..29f0f5c0727 100644
--- a/source/_docs/ecosystem/ios/notifications/content_extensions.markdown
+++ b/source/_docs/ecosystem/ios/notifications/content_extensions.markdown
@@ -93,13 +93,13 @@ ios:
- identifier: 'OPEN_COVER'
title: 'Open Cover'
activationMode: 'background'
- authenticationRequired: yes
+ authenticationRequired: true
destructive: no
- identifier: 'CLOSE_COVER'
title: 'Close Cover'
activationMode: 'background'
- authenticationRequired: yes
- destructive: yes
+ authenticationRequired: true
+ destructive: true
```
# Troubleshooting
diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown
index 2724a7a0784..3216b3de89d 100644
--- a/source/_docs/scripts/service-calls.markdown
+++ b/source/_docs/scripts/service-calls.markdown
@@ -61,10 +61,9 @@ You can use the Services Developer Tool to test data to pass in a service call.
For example, you may test turning on or off a 'group' (See [groups] for more info)
To turn a group on or off, pass the following info:
-Domain: `homeassistant`
-Service: `turn_on`
-Service Data: `{ "entity_id": "group.kitchen" }`
-
+- Domain: `homeassistant`
+- Service: `turn_on`
+- Service Data: `{ "entity_id": "group.kitchen" }`
### {% linkable_title Use templates to determine the attributes %}
diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown
index 6df8aca7acf..caf4e3ad221 100644
--- a/source/_docs/z-wave.markdown
+++ b/source/_docs/z-wave.markdown
@@ -42,4 +42,4 @@ You can get more information on the [available services](/docs/z-wave/services/)
When you toggle a switch or control a light locally you may find that it takes some time for that to be reflected in Home Assistant. That's because Lutron had patents on the status updates using the *Hail* command class, the traditional way of allowing devices to tell the controller that something happened locally. The same result can be achieved through the *Association* command class, or *Central Scene* command class (though, *Central Scene* isn't [fully supported](https://github.com/OpenZWave/open-zwave/pull/1125) in OpenZWave).
-If you search [the Z-Wave products database](http://products.z-wavealliance.org/) for your product and it lists one of those in the **Controlled** command classes (not the **Supported** command classes), then your device will be able to report state changes when they happen. If it doesn't then updates may either happen eventually, or you may need to (carefully) [enable polling](https://www.home-assistant.io/docs/z-wave/control-panel/#entities-of-this-node).
+If you search [the Z-Wave products database](http://products.z-wavealliance.org/) for your product and it lists one of those in the **Controlled** command classes (not the **Supported** command classes), then your device will be able to report state changes when they happen. If it doesn't then updates may either happen eventually, or you may need to (carefully) [enable polling](/docs/z-wave/control-panel/#entities-of-this-node).
diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown
index e9c0ae6068b..ad9d86339ba 100644
--- a/source/_docs/z-wave/installation.markdown
+++ b/source/_docs/z-wave/installation.markdown
@@ -63,7 +63,7 @@ network_key:
type: string
default: None
config_path:
- description: "The path to the Python OpenZWave configuration files. NOTE: there is also the [update_config service](https://www.home-assistant.io/docs/z-wave/services/) to perform updating the config within python-openzwave automatically."
+ description: "The path to the Python OpenZWave configuration files. NOTE: there is also the [update_config service](/docs/z-wave/services/) to perform updating the config within python-openzwave automatically."
required: false
type: string
default: the 'config' that is installed by python-openzwave
@@ -71,7 +71,7 @@ autoheal:
description: Allows disabling auto Z-Wave heal at midnight.
required: false
type: boolean
- default: True
+ default: true
polling_interval:
description: The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the zwave network and cause problems.
required: false
@@ -81,7 +81,7 @@ debug:
description: Print verbose z-wave info to log.
required: false
type: boolean
- default: False
+ default: false
device_config / device_config_domain / device_config_glob:
description: "This attribute contains node-specific override values. NOTE: This needs to be specified if you are going to use any of the following options. See [Customizing devices and services](/docs/configuration/customizing-devices/) for the format."
required: false
@@ -91,7 +91,7 @@ device_config / device_config_domain / device_config_glob:
description: Ignore this entity completely. It won't be shown in the Web Interface and no events are generated for it.
required: false
type: boolean
- default: False
+ default: false
polling_intensity:
description: Enables polling of a value and sets the frequency of polling (0=none, 1=every time through the list, 2=every other time, etc). If not specified then your device will not be polled.
required: false
@@ -101,7 +101,7 @@ device_config / device_config_domain / device_config_glob:
description: Enable refreshing of the node value. Only the light component uses this.
required: false
type: boolean
- default: False
+ default: false
delay:
description: Specify the delay for refreshing of node value. Only the light component uses this.
required: false
@@ -111,7 +111,7 @@ device_config / device_config_domain / device_config_glob:
description: Inverts function of the open and close buttons for the cover domain. This will not invert the position and state reporting.
required: false
type: boolean
- default: False
+ default: false
{% endconfiguration %}
diff --git a/source/_includes/asides/about.html b/source/_includes/asides/about.html
index 5d672861adc..e4a12f32618 100644
--- a/source/_includes/asides/about.html
+++ b/source/_includes/asides/about.html
@@ -5,7 +5,7 @@
Home Assistant is an open-source home automation platform running on Python 3. Track and control all devices at home and automate control.
diff --git a/source/_includes/custom/welcome.html b/source/_includes/custom/welcome.html
index 0eb5931cd4c..12eb9286563 100644
--- a/source/_includes/custom/welcome.html
+++ b/source/_includes/custom/welcome.html
@@ -5,6 +5,6 @@ Open source home automation that puts local control and privacy first. Powered b
diff --git a/source/_lovelace/shopping-list.markdown b/source/_lovelace/shopping-list.markdown
index ec57df242c6..ab0d78462f4 100644
--- a/source/_lovelace/shopping-list.markdown
+++ b/source/_lovelace/shopping-list.markdown
@@ -12,7 +12,7 @@ footer: true
The Shopping List Card allows you to add, edit, check-off, and clear items from your shopping list.
-Setup of the [Shopping List Intent](https://www.home-assistant.io/components/shopping_list/) is required
+Setup of the [Shopping List Intent](/components/shopping_list/) is required
This card works only with platforms that define a `weather` entity.
- E.g., it works with [Dark Sky](https://www.home-assistant.io/components/weather.darksky/) but not [Dark Sky Sensor](https://www.home-assistant.io/components/sensor.darksky/)
+ E.g., it works with [Dark Sky](/components/weather.darksky/) but not [Dark Sky Sensor](/components/sensor.darksky/)
diff --git a/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown b/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
index 2533a175c9d..92b9c96ce84 100644
--- a/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
+++ b/source/_posts/2016-09-29-async-sleepiq-emoncms-stocks.markdown
@@ -30,7 +30,7 @@ As you might have noticed, this release has been delayed by 5 days. This was due
### {% linkable_title Hide automation rules %}
-Since 0.28 [automation rules](/blog/2016/09/10/notify-group-reload-api-pihole/#reload-automation-rules) can be reloaded directly from the frontend. By default all automation rules are shown. If you want to [hide an automation rule](/getting-started/automation-create-first/), use `hide_entity: True`.
+Since 0.28 [automation rules](/blog/2016/09/10/notify-group-reload-api-pihole/#reload-automation-rules) can be reloaded directly from the frontend. By default all automation rules are shown. If you want to [hide an automation rule](/getting-started/automation-create-first/), use `hide_entity: true`.
### {% linkable_title All changes %}
diff --git a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
index b1c417b1a35..747f8bff0f2 100644
--- a/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
+++ b/source/_posts/2016-10-22-flash-briefing-updater-hacktoberfest.markdown
@@ -52,7 +52,7 @@ There are two ways to opt-out. The first way is by using the new `opt_out` optio
```yaml
updater:
- reporting: no
+ reporting: false
```
You can also disable the updater component entirely by removing `updater:` from your `configuration.yaml` although **we would not suggest you do this** as you would miss any critical updates.
diff --git a/source/_posts/2017-06-17-release-47.markdown b/source/_posts/2017-06-17-release-47.markdown
index b91503b06d1..95250dd2ece 100644
--- a/source/_posts/2017-06-17-release-47.markdown
+++ b/source/_posts/2017-06-17-release-47.markdown
@@ -125,7 +125,7 @@ lutron:
mailgun:
domain: !secret mailgun_domain
api_key: !secret mailgun_api_key
- sandbox: False
+ sandbox: false
notify:
- name: mailgun
diff --git a/source/_posts/2018-01-14-release-61.markdown b/source/_posts/2018-01-14-release-61.markdown
index 1cc48aad143..7120d061bcd 100644
--- a/source/_posts/2018-01-14-release-61.markdown
+++ b/source/_posts/2018-01-14-release-61.markdown
@@ -81,11 +81,11 @@ Experiencing issues introduced by this release? Please report them in our [issue
- States now use lower snake case.
- The "Play" and "Trade" states has been renamed to "looking_to_play" and "looking_to_trade".
([@frwickst] - [#11182]) ([sensor.steam_online docs]) (breaking change)
-- The [`tile`][device_tracker.tile docs] platform now shows only active Tiles by default; to show all Tiles, including expired/inactive ones, `show_inactive` must be `True`. The following state attributes have been removed: `last_seen` and `last_updated`. ([@bachya] - [#11172]) ([device_tracker.tile docs]) (breaking change)
+- The [`tile`][device_tracker.tile docs] platform now shows only active Tiles by default; to show all Tiles, including expired/inactive ones, `show_inactive` must be `true`. The following state attributes have been removed: `last_seen` and `last_updated`. ([@bachya] - [#11172]) ([device_tracker.tile docs]) (breaking change)
- The `hidden_string` feature has been removed from the isy994 component. Previously, this allowed entities to be "hidden" in Home Assistant if a configured string was present in an ISY device's name or folder path. This was removed because hiding devices is now done via the customization feature.
Note however, that this feature was replaced by a new ignore_string config option, which will now cause Home Assistant to completely ignore devices with the matching string so that they will not be imported as a Home Assistant device at all. This can be helpful if you have nodes in the ISY that aren't useful at all in Hass (IR transmitter nodes are a good example.) ([@OverloadUT] - [#11243]) ([isy994 docs]) ([binary_sensor.isy994 docs]) ([cover.isy994 docs]) ([fan.isy994 docs]) ([light.isy994 docs]) ([lock.isy994 docs]) ([sensor.isy994 docs]) ([switch.isy994 docs]) (breaking change)
- The [`egardia` alarm panel][alarm_control_panel.egardia docs] platform no longer a need the users to run a separate Egardiaserver component. It can now also run on HASS.io. ([@jeroenterheerdt] - [#11344]) ([alarm_control_panel.egardia docs]) (breaking change)
-- The binary sensor platform of the DoorBird integration has been deleted, so remove DoorBird from your `binary_sensor` configuration. Instead, set the `doorbell_events` option of the `doorbird` component to `True`. The `last_visitor` option has been removed from the camera component, as it is now always added as an entity. ([@Klikini] - [#11193]) ([camera.doorbird docs]) (breaking change)
+- The binary sensor platform of the DoorBird integration has been deleted, so remove DoorBird from your `binary_sensor` configuration. Instead, set the `doorbell_events` option of the `doorbird` component to `true`. The `last_visitor` option has been removed from the camera component, as it is now always added as an entity. ([@Klikini] - [#11193]) ([camera.doorbird docs]) (breaking change)
- The following attributes of the TP-Link switch and light platform have been renamed:
- Light: `current_consumption` -> `current_power_w`, `daily_consumption` -> `daily_energy_kwh` and `monthly_consumption` -> `monthly_energy_kwh`
- Switch: `current` -> `current_a`, `current_consumption` -> `current_power_w`, `total_consumption` -> `total_energy_kwh` and `daily_consumption` -> `today_energy_kwh` ([@DanNixon] - [#10979]) ([light.tplink docs]) ([switch.tplink docs]) (breaking change)
diff --git a/source/_posts/2018-04-22-hassio-2018.markdown b/source/_posts/2018-04-22-hassio-2018.markdown
index 90506053552..61e762341e0 100644
--- a/source/_posts/2018-04-22-hassio-2018.markdown
+++ b/source/_posts/2018-04-22-hassio-2018.markdown
@@ -58,7 +58,7 @@ Once our new installation images with HassioOS are released, you have to reflash
- Restore your snapshot.
- Enjoy a new and improved Hass.io
-[last July]: https://www.home-assistant.io/blog/2017/07/25/introducing-hassio/
+[last July]: /blog/2017/07/25/introducing-hassio/
[the conclusion]: #what-hassio-users-should-do-to-prepare-for-these-updates
[Buildroot]: https://buildroot.org/
[RAUC]: https://www.rauc.io/
diff --git a/source/_posts/2018-07-06-release-73.markdown b/source/_posts/2018-07-06-release-73.markdown
index e63aea2452b..7468e27a5d7 100644
--- a/source/_posts/2018-07-06-release-73.markdown
+++ b/source/_posts/2018-07-06-release-73.markdown
@@ -11,7 +11,7 @@ categories: Release-Notes
og_image: /images/blog/2018-07-0.73/lovelace-elements.png
---
-Today we're releasing Home Assistant 0.73. First, let's talk security. Home Assistant has a lot of power. It can control all devices in your house and know what you're up to. That's why securing it is very important. It's absolutely wrong to connect your instance unsecured to the internet and hope no one will find it. All ports on all computers are regularly scanned by bad actors. Please read [our guidelines thoroughly](https://www.home-assistant.io/docs/configuration/securing/) and follow them.
+Today we're releasing Home Assistant 0.73. First, let's talk security. Home Assistant has a lot of power. It can control all devices in your house and know what you're up to. That's why securing it is very important. It's absolutely wrong to connect your instance unsecured to the internet and hope no one will find it. All ports on all computers are regularly scanned by bad actors. Please read [our guidelines thoroughly](/docs/configuration/securing/) and follow them.
In the meanwhile, we're also working hard on the new authentication system. A preview version is included in this release, more info on [our developer blog](https://developers.home-assistant.io/blog/2018/07/02/trying-new-auth.html).
diff --git a/source/_posts/2018-07-11-hassio-images.markdown b/source/_posts/2018-07-11-hassio-images.markdown
index bedab4d9f12..b9097a76be8 100644
--- a/source/_posts/2018-07-11-hassio-images.markdown
+++ b/source/_posts/2018-07-11-hassio-images.markdown
@@ -60,5 +60,5 @@ Feel free to jump into the project and help us to improve the documentation or o
[Buildroot]: https://buildroot.org/
[AppArmor]: https://gitlab.com/apparmor/apparmor/wikis/home/
[USB stick]: https://github.com/home-assistant/hassos/blob/rel-1/Documentation/configuration.md#automatic
-[installation]: https://www.home-assistant.io/hassio/installation/
+[installation]: /hassio/installation/
[Etcher]: https://etcher.io/
diff --git a/source/_posts/2019-01-23-lovelace-released.markdown b/source/_posts/2019-01-23-lovelace-released.markdown
new file mode 100644
index 00000000000..a51c8dc1646
--- /dev/null
+++ b/source/_posts/2019-01-23-lovelace-released.markdown
@@ -0,0 +1,82 @@
+---
+layout: post
+title: "Lovelace UI released!"
+description: "After 8 months of development, we're proud to release our brand new Lovelace UI."
+date: 2019-01-23 00:01:02
+date_formatted: "January 23, 2019"
+author: Paulus Schoutsen
+author_twitter: balloob
+comments: true
+categories: Release-Notes
+og_image: /images/blog/2019-01-lovelace/demo.png
+---
+
+Today we're happy to announce that our new Lovelace UI, which has been in beta for the last 8 months, is becoming the new default interface of [Home Assistant 0.86](/blog/2019/01/23/release-86/). With Lovelace we're taking a new approach to building user interfaces for Home Assistant. We're no longer storing the look and feel of your UI in your configuration.yaml, requiring restarts for changes. With Lovelace we're keeping the UI concerns in the UI1, unlocking a whole new set of features:
+
+ - [24 cards](https://www.home-assistant.io/lovelace/alarm-panel/) to place and configure as you like.
+ - UI Editor. A configuration UI to manage your Lovelace UI including live preview when editing cards.
+ - Fast. Using a static config allows us to build up the UI once.
+ - Customizable.
+ - Cards have numerous options to configure how your data is presented.
+ - Themes; even at a per card basis.
+ - Ability to override names and icons of entities.
+ - Custom Cards from our amazing community are fully supported.
+
+
+
+## {% linkable_title Zigbee management panel %}
+
+This release includes a brand new Zigbee management panel to manage your Zigbee network thanks to the hard work by [@dmulcahey] with the help of [@Adminiuga] and [@damarco]. The new panel makes it easy to:
+
+ - Issue Permit and Remove operations
+ - Reconfigure Node, which will rebind and reconfigure the reporting for a device. Which can help solve issues.
+ - Reading and setting cluster attributes. This is useful for viewing and setting things such as device sensitivity levels.
+ - View and issue cluster commands. Note on this feature: support for commands with arguments is coming soon.
+
+The Zigbee team is also planning a bunch of cool things for 2019. Direct device binding (directly pairing remotes to lights) is already in development and they are planning support for group management as well. Targeted and broadcast joins are also right around the corner (we’re waiting for a new Zigpy release). Exciting times for Zigbee users!
+
+