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

Merge branch 'current' into next

Browse Source
This commit is contained in:
Paulus Schoutsen 2019-01-23 12:58:56 -08:00
commit 05709adefb
1160 changed files with 1093 additions and 456 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Gemfile.lock
View File

@ -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)

12
_config.yml
View File

@ -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.

4
source/_addons/mosquitto.markdown
View File

@ -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 %}

2
source/_components/alarmdecoder.markdown
View File

@ -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

4
source/_components/alert.markdown
View File

@ -255,8 +255,8 @@ alert:
- 30
- 60
- 120
can_acknowledge: True
skip_first: True
can_acknowledge: true
skip_first: true
notifiers:
- ryans_phone
```

12
source/_components/binary_sensor.command_line.markdown
View File

@ -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'
```
<p class='note'>
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: `''`.
</p>
{% 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!

2
source/_components/binary_sensor.flic.markdown
View File

@ -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).

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

@ -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

2
source/_components/binary_sensor.pilight.markdown
View File

@ -80,6 +80,6 @@ binary_sensor:
payload:
unitcode: 371399
payload_on: 'closed'
disarm_after_trigger: True
disarm_after_trigger: true
reset_delay_sec: 30
```

2
source/_components/binary_sensor.point.markdown
View File

@ -31,5 +31,5 @@ Each Point exposes the following binary sensors:
For installation instructions, see [the Point component](/components/point/).
<p class='note'>
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.
</p>

2
source/_components/binary_sensor.rainmachine.markdown
View File

@ -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/).
<p class='note'>
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.
</p>

2
source/_components/binary_sensor.workday.markdown
View File

@ -96,6 +96,6 @@ automation:
```
<p class='note'>
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.
</p>

2
source/_components/bmw_connected_drive.markdown
View File

@ -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 %}

3
source/_components/calendar.google.markdown
View File

@ -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: "!!"

2
source/_components/camera.ffmpeg.markdown
View File

@ -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

2
source/_components/camera.generic.markdown
View File

@ -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

2
source/_components/camera.synology.markdown
View File

@ -74,7 +74,7 @@ camera:
username: YOUR_USERNAME
password: YOUR_PASSWORD
timeout: 15
verify_ssl: False
verify_ssl: false
```
<p class='note'>

2
source/_components/climate.evohome.markdown
View File

@ -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': {

2
source/_components/climate.generic_thermostat.markdown
View File

@ -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

2
source/_components/climate.radiotherm.markdown
View File

@ -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.

6
source/_components/climate.venstar.markdown
View File

@ -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
```

6
source/_components/counter.markdown
View File

@ -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 %}

6
source/_components/cover.rflink.markdown
View File

@ -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.

4
source/_components/cover.rfxtrx.markdown
View File

@ -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

8
source/_components/cover.rpi_gpio.markdown
View File

@ -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

2
source/_components/device_tracker.googlehome.markdown
View File

@ -45,4 +45,4 @@ Devices will appear in the format `devicetracker.<home hub ip>_<device mac addre
After running this component for a little while, you will likely see many devices appear. It's advisable to set the configuration to not discover new devices once the device you want to track have appeared (see [device tracker configuration][devicetrackerconfig] for details).
[googlehomeapi]: https://rithvikvibhu.github.io/GHLocalApi/
[devicetrackerconfig]: https://www.home-assistant.io/components/device_tracker/#configuring-a-device_tracker-platform
[devicetrackerconfig]: /components/device_tracker/#configuring-a-device_tracker-platform

6
source/_components/device_tracker.markdown
View File

@ -44,7 +44,7 @@ The following optional parameters can be used with any platform:
| `new_device_defaults`| | Default values for new discovered devices. Available options `track_new_devices` (default: `true`), `hide_if_away` (default: `false`) |
<p class='note'>
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`).
</p>
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
```

2
source/_components/device_tracker.tomato.markdown
View File

@ -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

2
source/_components/dialogflow.markdown
View File

@ -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.

4
source/_components/ecobee.markdown
View File

@ -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 %}

2
source/_components/egardia.markdown
View File

@ -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

2
source/_components/eight_sleep.markdown
View File

@ -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 %}

2
source/_components/fan.template.markdown
View File

@ -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:

4
source/_components/frontend.markdown
View File

@ -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'

4
source/_components/google_assistant.markdown
View File

@ -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.

2
source/_components/group.markdown
View File

@ -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:

2
source/_components/history.markdown
View File

@ -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

40
source/_components/homekit.markdown
View File

@ -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 %}

2
source/_components/homematic.markdown
View File

@ -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.

2
source/_components/homeworks.markdown
View File

@ -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:

2
source/_components/ifttt.markdown
View File

@ -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.

4
source/_components/image_processing.facebox.markdown
View File

@ -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:

2
source/_components/image_processing.tensorflow.markdown
View File

@ -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.

2
source/_components/insteon.markdown
View File

@ -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

2
source/_components/knx.markdown
View File

@ -93,7 +93,7 @@ local_ip:
```yaml
knx:
fire_event: True
fire_event: true
fire_event_filter: ["1/0/*", "6/2,3,4-6/*"]
```

2
source/_components/konnected.markdown
View File

@ -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 %}

2
source/_components/light.flux_led.markdown
View File

@ -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:

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

@ -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:

2
source/_components/light.nanoleaf_aurora.markdown
View File

@ -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:

2
source/_components/light.rfxtrx.markdown
View File

@ -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:

8
source/_components/light.yeelight.markdown
View File

@ -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 %}

2
source/_components/lutron.markdown
View File

@ -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"
---

2
source/_components/lutron_caseta.markdown
View File

@ -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"
---

2
source/_components/mailgun.markdown
View File

@ -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.

2
source/_components/media_player.denonavr.markdown
View File

@ -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

4
source/_components/media_player.emby.markdown
View File

@ -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

2
source/_components/media_player.plex.markdown
View File

@ -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 %}

2
source/_components/media_player.songpal.markdown
View File

@ -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
---

4
source/_components/notify.discord.markdown
View File

@ -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"
]
}

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

@ -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

4
source/_components/notify.group.markdown
View File

@ -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 %}

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

@ -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
```

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

@ -45,7 +45,7 @@ cycles:
default: 1
priority:
description: Defines the priority of the notification.
required: False
required: false
type: string
default: warning
{% endconfiguration %}

4
source/_components/opentherm_gw.markdown
View File

@ -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

4
source/_components/owntracks.markdown
View File

@ -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
```

4
source/_components/point.markdown
View File

@ -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:
<p class='note'>
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.
</p>

2
source/_components/qwikswitch.markdown
View File

@ -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

2
source/_components/remote.xiaomi_miio.markdown
View File

@ -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

4
source/_components/rflink.markdown
View File

@ -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_*

2
source/_components/rss_feed_template.markdown
View File

@ -23,7 +23,7 @@ rss_feed_template:
# Accessible on <Home Assistant url>/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"

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

@ -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

11
source/_components/sensor.dsmr.markdown
View File

@ -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: <https://www.wijhebbenzon.nl/media/kunena/attachments/3055/DSMRv5.0FinalP1.pdf>
- For unofficial hardware connection examples refer to: [Domoticx](http://domoticx.com/p1-poort-slimme-meter-hardware/)
<p class='img'>
@ -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/
- <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 - <http://ser2net.sourceforge.net/>
```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.

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

@ -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.

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

@ -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

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

@ -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

4
source/_components/sensor.kwb.markdown
View File

@ -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: <ip>
port: 23
type: tcp
raw: False
raw: false
```
Take a good look at which configuration variables are for `TCP` use or for `serial` use.

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

@ -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`.

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

@ -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).

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

@ -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

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

@ -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/).
<p class='note'>
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.
</p>

4
source/_components/sensor.rest.markdown
View File

@ -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 %}
<p class='note warning'>

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

@ -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:

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

@ -14,7 +14,7 @@ ha_release: 0.83
---
<p class='note warning'>
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/),
</p>

4
source/_components/sensor.tellstick.markdown
View File

@ -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
```

4
source/_components/sensor.uk_transport.markdown
View File

@ -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/)

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

@ -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:

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

@ -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

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

@ -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.

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

@ -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 %}

22
source/_components/switch.mysensors.markdown
View File

@ -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

13
source/_components/switch.mystrom.markdown
View File

@ -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
<img src='{{site_root}}/images/components/mystrom/mystrom-advanced.png' />
</p>
## {% 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 %}

14
source/_components/switch.pencom.markdown
View File

@ -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).

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

@ -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/).

7
source/_components/switch.rainmachine.markdown
View File

@ -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/).
<p class='note'>
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.
</p>
@ -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

9
source/_components/switch.raspihats.markdown
View File

@ -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:

13
source/_components/switch.raspyrfm.markdown
View File

@ -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.
</p>
### {% linkable_title Full example %}
## {% linkable_title Full example %}
```yaml
switch:

3
source/_components/switch.recswitch.markdown
View File

@ -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`:

17
source/_components/switch.rflink.markdown
View File

@ -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)

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

@ -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:
<p class='img'>
@ -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 %}
<p class='note warning'>
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`.
</p>
<p class='note warning'>
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.
</p>
@ -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

3
source/_components/switch.rpi_gpio.markdown
View File

@ -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.
</p>
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

Some files were not shown because too many files have changed in this diff Show More