Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/_addons/dhcp_server.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Configuration variables:
 - **range_end** (*Required*): End address for dhcp leases.
 - **broadcast** (*Required*): Network broadcast address.
 - **gateway** (*Required*): A List of gateways.
- **interface** (*Required*): Inteface on that will be listen. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
- **interface** (*Required*): Interface on that will be listen. Normally is `eth0` for ethernet wired connection and `wlan0` for wireless connection.
- **hosts** (*Optional*): A list of fixed IPs for devices.
- **name** (*Required*): Name/hostname of your device.
 - **mac** (*Required*): Mac address of your device.
Expand Down
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.bbb_gpio.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Configuration variables:
- **pins** array (*Required*): Array of used pins.
- **pin_name** (*Required*): Pin numbers and corresponding names.
- **name** (*Required*): Friendly name to use for the frontend.
- **bouncetime** (*Optional*): Debounce time for reading input pin defined in miliseconds [ms]. Defaults to `50 ms`.
- **bouncetime** (*Optional*): Debounce time for reading input pin defined in milliseconds [ms]. Defaults to `50 ms`.
- **invert_logic** (*Optional*): If `true`, inverts the input logic to ACTIVE LOW. Default is `false` (ACTIVE HIGH).
- **pull_mode** (*Optional*): Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor. Defaults to `UP`.

Expand Down
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.xiaomi_aqara.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component
| Smoke Detector | smoke | JTYJ-GD-01LM/BW | on, off | | | |
| Gas Leak Detector | natgas | JTQJ-BF-01LM/BW | on, off | | | |
| Water Leak Sensor | sensor_wleak.aq1 | SJCGQ11LM | on, off | | | |
| Button (1st gen) | switch | WXKG01LM | on (thru long_click_press), off | `click`| `click_type`| `long_click_press`, `long_click_release`, `hold`, `single`, `double` |
| Button (1st gen) | switch | WXKG01LM | on (through long_click_press), off | `click`| `click_type`| `long_click_press`, `long_click_release`, `hold`, `single`, `double` |
| Button (2nd gen) | sensor_switch.aq2 | WXKG11LM | off (always) | `click` | `click_type` | `single`, `double` |
| Aqara Wireless Switch (Single) | 86sw1 | WXKG03LM | off (always) | `click` | `click_type` | `single` |
| Aqara Wireless Switch (Double) | 86sw2 | WXKG02LM | off (always) | `click` | `click_type` | `single`, `both` |
Expand Down
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.zigbee.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ha_release: 0.12
ha_iot_class: "Local Polling"
---

A `zigbee` binary sensor in this context is a device connected to one of the digital input pins on a [ZigBee](http://www.zigbee.org/) module. The states reported by such a device are limited to `on` or `off`. By default, a binary sensor is considered `on` when the ZigBee device's digital input pin is held 'high' and considered `off` when it is held `low`. This behaviour can be inverted by setting the `on_state` configuration variable to `low`.
A `zigbee` binary sensor in this context is a device connected to one of the digital input pins on a [ZigBee](http://www.zigbee.org/) module. The states reported by such a device are limited to `on` or `off`. By default, a binary sensor is considered `on` when the ZigBee device's digital input pin is held 'high' and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`.

To enable a digital input pin as binary sensor in your installation, add the following lines to your `configuration.yaml`:

Expand Down
2 changes: 1 addition & 1 deletion source/_components/climate.ecobee.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ For 'temp', the current temperature is taken as the target temperature.
When None is provided as parameter, the hold_mode is turned off.
It is not possible to set a vacation hold; such hold has to be
defined on the thermostat directly. However, a vacation hold can be
cancelled.
canceled.

| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ $ sudo apt install bluetooth libbluetooth-dev pkg-config libboost-python-dev lib
Before you get started with this platform, please note that:

- This platform is incompatible with Windows
- This platform requires access to the bluetooth stack, see [Rootless Setup section](#rootless-setup) for further infomation
- This platform requires access to the bluetooth stack, see [Rootless Setup section](#rootless-setup) for further information

To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:

Expand All @@ -52,7 +52,7 @@ Some BTLE devices (e.g. fitness trackers) are only visible to the devices that t

## {% linkable_title Rootless Setup %}

Normaly accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).
Normally accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).

```bash
$ sudo apt-get install libcap2-bin
Expand Down
6 changes: 3 additions & 3 deletions source/_components/device_tracker.gpslogger.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,14 @@ Add the above URL after you modified it with your settings into the **URL** fiel
- Use the domain that Home Assistant is available on the internet or the public IP address. Can be a local IP address if you are using a VPN setup.
- Only remove `[Port]` if your Home Assistant instance is using port 80. Otherwise set it to 8123.
- For Home Assistant only the above URL, as written, will work - do not add or remove any parameters.
- Make sure to include your [API password](/components/http/) if you have configured a password. Add `&api_password=[Your pasword]` to the end of the URL.
- Make sure to include your [API password](/components/http/) if you have configured a password. Add `&api_password=[Your password]` to the end of the URL.
- You can change the name of your device name by replacing `&device=%SER` with `&device=[Devicename]`.

If your battery drains fast then you can tune the performence of GPSLogger under **Performance** -> **Location providers**
If your battery drains fast then you can tune the performance of GPSLogger under **Performance** -> **Location providers**

<p class='img'>
<img width='300' src='/images/components/gpslogger/performance.png' />
Performance
</p>

A request can be forced from the app to test if everything is working fine. A succesful request will update the `known_devices.yaml` file with the device's serial number.
A request can be forced from the app to test if everything is working fine. A successful request will update the `known_devices.yaml` file with the device's serial number.
2 changes: 1 addition & 1 deletion source/_components/fan.xiaomi_miio.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ha_version: 0.57
ha_iot_class: "Local Polling"
---

The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier 2, Air Purifier 2S andd Air Purifier Pro.
The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier 2, Air Purifier 2S and Air Purifier Pro.

Currently, the supported features are

Expand Down
4 changes: 2 additions & 2 deletions source/_components/frontend.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ frontend:
required: true
type: [list, string]
extra_html_url:
description: "List of addtional [resources](/developers/frontend_creating_custom_ui/) to load in `latest` javascript mode."
description: "List of additional [resources](/developers/frontend_creating_custom_ui/) to load in `latest` javascript mode."
required: false
type: list
extra_html_url_es5:
description: "List of addtional [resources](/developers/frontend_creating_custom_ui/) to load in `es5` javascript mode."
description: "List of additional [resources](/developers/frontend_creating_custom_ui/) to load in `es5` javascript mode."
required: false
type: list
development_repo:
Expand Down
2 changes: 1 addition & 1 deletion source/_components/group.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ group:
- group.all_scripts
```

## {% linkable_title Group behaviour %}
## {% linkable_title Group behavior %}

When any member of a group is `on` then the group will also be `on`. Similarly with a device tracker, when any member of the group is `home` then the group is `home`.

Expand Down
2 changes: 1 addition & 1 deletion source/_components/hive.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The Hive Home Assistant platform currently supports the following Hive devices:
- Hive Active Heating (including hot water and Hive Multizone)
- Hive Active Light Dimmable
- Hive Active Light Cool to Warm White
- Hive Active Light Colour Changing
- Hive Active Light Color Changing
- Hive Active Plug
- Hive Window or Door Sensor
- Hive Motion Sensor
2 changes: 1 addition & 1 deletion source/_components/image_processing.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you are running Home Assistant over SSL or from within a container, you will

Alpr entities attribute have a vehicle counter `vehicles` and all found plates as `plates`.

This event is trigger after OpenALPR found a new licence plate.
This event is trigger after OpenALPR found a new license plate.

```yaml
# Example configuration.yaml automation entry
Expand Down
2 changes: 1 addition & 1 deletion source/_components/input_datetime.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ A datetime input entity's state exports several attributes that can be useful in
| --------- | ----------- |
| `has_time` | `true` if this entity has a time.
| `has_date` | `true` if this entity has a date.
| `year`<br>`month`<br>`day` | The year, month and day of the date.<br>(only availabel if `has_date: true`)
| `year`<br>`month`<br>`day` | The year, month and day of the date.<br>(only available if `has_date: true`)
| `hour`<br>`minute`<br>`second` | The hour, minute and second of the time.<br>(only available if `has_time: true`)
| `timestamp` | A timestamp representing the time held in the input.<br>If `has_date: true`, this is the UNIX timestamp of the date / time held by the input. Otherwise if only `has_time: true`, this is the number of seconds since midnight representing the time held by the input.

Expand Down
2 changes: 1 addition & 1 deletion source/_components/input_number.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ input_number:
required: true
type: float
max:
description: Maxium value.
description: Maximum value.
required: true
type: float
name:
Expand Down
2 changes: 1 addition & 1 deletion source/_components/knx.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ knx:

- **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus
- **fire_event_filter** (*Optional*): If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.
- **state_updater** (*Optional*): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.
- **state_updater** (*Optional*): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behavior.
- **time_address** (*Optional*): Broadcast current local time to KNX bus with configured group address.

### {% linkable_title Services %}
Expand Down
2 changes: 1 addition & 1 deletion source/_components/light.hive.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The 'hive' light component integrates your Hive lights into Home Assistant, enab
The Hive light component supports the following Hive products:
- **Hive Active Light Dimmable**
- **Hive Active Light Cool to Warm White**
- **Hive Active Light Colour Changing**
- **Hive Active Light Color Changing**


<p class='note'>
Expand Down
2 changes: 1 addition & 1 deletion source/_components/light.zigbee.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ha_release: 0.12
ha_iot_class: "Local Polling"
---

A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered `on` when the ZigBee device's digital output is held `high` and considered `off` when it is held `low`. This behaviour can be inverted by setting the `on_state` configuration variable to `low`.
A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered `on` when the ZigBee device's digital output is held `high` and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`.

To configure a digital output pin as light, add the following to your `configuration.yaml` file:

Expand Down
2 changes: 1 addition & 1 deletion source/_components/lirc.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The configuration is slightly different :
- The former single `lirc` service is replaced with the three systemd services `lircd.service`, `lircmd.service` and `irexec.service`. There is no counterpart to the 0.9.0 `lirc` service which covered all of these. Using a separate transmitter device requires yet another service.
- 0.9.4 defaults to using systemd for controlling the services. This is not just start/stop functionality, systemd is used to implement new features and to address shortcomings in 0.9.0. However, traditional systemV scripts are also installed and could be used although this is less tested and not really documented.

For more infomation have a look at `/usr/share/doc/lirc/README.Debian.gz` where the update process is explained when you have updated from jessie to stretch.
For more information have a look at `/usr/share/doc/lirc/README.Debian.gz` where the update process is explained when you have updated from jessie to stretch.
</p>

### {% linkable_title Configuring LIRC %}
Expand Down
2 changes: 1 addition & 1 deletion source/_components/media_player.denonavr.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ A few notes:

- Additional option the control Denon AVR receivers with a builtin web server is using the HTTP interface with denonavr platform.
- denonavr platform supports some additional functionalities like album covers, custom input source names and auto discovery.
- Marantz receivers seem to a have quite simliar interface. Thus if you own one, give it a try.
- Marantz receivers seem to a have quite similar interface. Thus if you own one, give it a try.

[Denon]: /components/media_player.denon/
2 changes: 1 addition & 1 deletion source/_components/media_player.yamaha.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Configuration variables:
volume control and source selection. Playback controls, for instance
play and stop are available for sources that supports it.
- The `play_media` service is implemented for `NET RADIO` source
only. The `media_id` is a `>` separted string of the menu path on
only. The `media_id` is a `>` separated string of the menu path on
the vtuner service. For instance `Bookmarks>Internet>WAMC 90.3 FM`.

### {% linkable_title Example configuration %}
Expand Down
2 changes: 1 addition & 1 deletion source/_components/namecheapdns.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ha_release: 0.56
With the `namecheapdns` component you can automatically update your dynamic DNS entry at [namecheapdns](https://www.namecheap.com/store/domains/freedns/).

<p class='note warning'>
Namecheap only supports IPv4 adresses to update.
Namecheap only supports IPv4 addresses to update.
</p>

To use the component in your installation, add the following to your `configuration.yaml` file:
Expand Down
2 changes: 1 addition & 1 deletion source/_components/notify.facebook.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ automation:
- '+919784516314'
```

You can also send messages to users that do not have stored their phone number with Facebook, but this requires a bit more work. The Messenger platform uses page specific user IDs instead of a global user ID. You will need to enable a webhook for the "messages" event in Facebook's developer console. Once a user writes a message to a page, that webhook will then receive the user's page specifc ID as part of the webhook's payload. Below is a simple PHP script that reacts to the message "get my id" and sends a reply containing the user's ID:
You can also send messages to users that do not have stored their phone number with Facebook, but this requires a bit more work. The Messenger platform uses page specific user IDs instead of a global user ID. You will need to enable a webhook for the "messages" event in Facebook's developer console. Once a user writes a message to a page, that webhook will then receive the user's page specific ID as part of the webhook's payload. Below is a simple PHP script that reacts to the message "get my id" and sends a reply containing the user's ID:

```php
<?php
Expand Down
6 changes: 3 additions & 3 deletions source/_components/notify.pushsafer.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ notify:

### {% linkable_title Examples %}

Message to two devices with formated text.
Message to two devices with formatted text.

```json
{
Expand All @@ -53,7 +53,7 @@ Message to two devices with formated text.
}
```

Message to one device with formated text and image from an external URL.
Message to one device with formatted text and image from an external URL.

```json
{
Expand All @@ -75,7 +75,7 @@ Message to one device with formated text and image from an external URL.
}
```

Message to two devices and one device group with formated text and local image.
Message to two devices and one device group with formatted text and local image.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion source/_components/pilight.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Configuration variables:
- **host** (*Required*): The IP address of the computer running the pilight-daemon, e.g. 192.168.1.32.
- **port** (*Required*): The network port to connect to. The usual port is [5000](https://manual.pilight.org/development/api.html).
- **send_delay** (*Optional*): You can define a send delay as a fraction of seconds if you experience transmission problems when you try to switch multiple switches at once. This can happen when you use a [pilight USB Nano](https://github.com/pilight/pilight-usb-nano) as hardware and switches a whole group of multiple switches on or off. Tested values are between 0.3 and 0.8 seconds depending on the hardware.
- **whitelist** (*Optional*): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbours weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true.
- **whitelist** (*Optional*): You can define a whitelist to prevent that too many unwanted RF codes (e.g. the neighbors weather station) are put on your HA event bus. All defined subsections have to be matched. A subsection is matched if one of the items are true.

In this example only received RF codes using a daycom or Intertechno protocol are put on the event bus and only when the device id is 42. For more possible settings please look at the receiver section of the pilight [API](https://manual.pilight.org/development/api.html).

Expand Down
2 changes: 1 addition & 1 deletion source/_components/remember_the_milk.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Configuration variables:

{% configuration %}
name:
description: Name of the RTM account, as you can have serveral accounts in RTM. The name must be unique.
description: Name of the RTM account, as you can have several accounts in RTM. The name must be unique.
required: true
type: string
api_key:
Expand Down
2 changes: 1 addition & 1 deletion source/_components/sensor.buienradar.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Configuration variables:
- **groundtemperature**: The current ground temperature (in [C](https://en.wikipedia.org/wiki/Celsius)).
- **windspeed**: The wind speed in [m/s](https://en.wikipedia.org/wiki/M/s).
- **windforce**: The wind speed/force in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale).
- **winddirection**: Where the wind is coming from: N (North),Z (south), NO (Noth-East), etc.
- **winddirection**: Where the wind is coming from: N (North),Z (south), NO (North-East), etc.
- **windazimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.
- **pressure**: The sea-level air pressure in [hPa](https://en.wikipedia.org/wiki/Hectopascal).
- **visibility**: Visibility in meters ([m](https://en.wikipedia.org/wiki/Metre)).
Expand Down
2 changes: 1 addition & 1 deletion source/_components/sensor.deutsche_bahn.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Deutsche Bahn"
description: "Instructions how to integrate timetable data for travelling in Germany within Home Assistant."
description: "Instructions how to integrate timetable data for traveling in Germany within Home Assistant."
date: 2015-06-02 21:45
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/sensor.dublin_bus_transport.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Dublin Bus Transport"
description: "Instructions how to integrate timetable data for travelling on Dublin Bus within Home Assistant."
description: "Instructions how to integrate timetable data for traveling on Dublin Bus within Home Assistant."
date: 2017-01-09 21:45
sidebar: true
comments: false
Expand Down
Loading