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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion source/_addons/mariadb.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sharing: true
footer: true
---

Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users, and permission settings. If you want to only connect from inside home assistant use `core-mariadb` as the host address.
Set up a [mariadb](https://mariadb.org/) SQL server. It supports multiple databases, users, and permission settings. If you want to only connect from inside Home Assistant use `core-mariadb` as the host address.

```json
{
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.abode.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Abode Alarm Control Panel"
description: "Instructions how to setup the Abode Alarm control panel within Home Assistant."
description: "Instructions on how to setup the Abode Alarm control panel within Home Assistant."
date: 2017-08-26 0:28
sidebar: true
comments: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "AlarmDecoder Alarm Control Panel"
description: "Instructions how to setup the AlarmDecoder Alarm control panel within Home Assistant."
description: "Instructions on how to setup the AlarmDecoder Alarm control panel within Home Assistant."
date: 2017-04-02 13:28
sidebar: true
comments: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Alarm.com Alarm Control Panel"
description: "Instructions how to integrate Alarm.com into Home Assistant."
description: "Instructions on how to integrate Alarm.com into Home Assistant."
date: 2016-01-14 22:00
sidebar: true
comments: false
Expand Down
7 changes: 3 additions & 4 deletions source/_components/alarm_control_panel.arlo.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Arlo Control Panel"
description: "Instructions how to setup the Netgear Arlo Base Stations as a control panel within Home Assistant."
description: "Instructions on how to setup the Netgear Arlo Base Stations as a control panel within Home Assistant."
date: 2017-10-05 17:45
sidebar: true
comments: false
Expand All @@ -27,11 +27,11 @@ alarm_control_panel:

{% configuration %}
home_mode_name:
description: "Arlo base station does not have a built-in home mode. You can map one of your custom modes to home assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app."
description: "Arlo base station does not have a built-in home mode. You can map one of your custom modes to Home Assistant's home mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match exactly as you set it up in the Arlo app."
required: false
type: string
away_mode_name:
description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to home assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
description: "Arlo base station does not have a built-in away mode. You can map one of your custom modes to Home Assistant's away mode by setting the name of the custom mode in this configuration variable. The name of the custom mode should match eactly as you set it up in the Arlo app."
required: false
type: string
default: "`Armed` mode in Arlo"
Expand Down Expand Up @@ -74,4 +74,3 @@ Setting Arlo to a custom mode (mapped to `home_mode_name` in `configuration.yaml
You can also completely disarm the Arlo base station by calling the `alarm_control_panel.alarm_disarm` service, and trigger the alarm by calling the `alarm_control_panel.alarm_trigger` service.

More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples).

4 changes: 2 additions & 2 deletions source/_components/alarm_control_panel.concord232.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Concord232 Alarm Control Panel"
description: "Instructions how to integrate Interlogix/GE Concord4 with RS-232 Automation Control Module into Home Assistant."
description: "Instructions on how to integrate Interlogix/GE Concord4 with RS-232 Automation Control Module into Home Assistant."
date: 2016-10-11 10:00
sidebar: true
comments: false
Expand All @@ -16,7 +16,7 @@ The `concord232` platform provides integration with GE, Interlogix (and other br

To use this platform, you will need to have the external concord232 client and server installed. The server must be running on the device which is connected to the automation module's serial port. The client must be installed on the machine running Home Assistant. These may often be the same machine, but do not have to be. For additional details in setting up and testing the client and server, see <https://github.com/JasonCarter80/concord232>

To enable this platform in home assistant, add the following lines to your `configuration.yaml`:
To enable this platform in Home Assistant, add the following lines to your `configuration.yaml`:

```yaml
# Example configuration.yaml entry
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.egardia.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Egardia / Woonveilig Alarm Control Panel"
description: "Instructions how to integrate Egardia / Woonveilig into Home Assistant."
description: "Instructions on how to integrate Egardia / Woonveilig into Home Assistant."
date: 2016-07-02 22:00
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.envisalink.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Envisalink Alarm"
description: "Instructions how to setup the Envisalink Alarm control panel within Home Assistant."
description: "Instructions on how to setup the Envisalink Alarm control panel within Home Assistant."
date: 2016-07-01 08:00
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.ialarm.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Antifurto365 iAlarm Control Panel"
description: "Instructions how to integrate iAlarms alarms into Home Assistant."
description: "Instructions on how to integrate iAlarms alarms into Home Assistant."
date: 2017-11-30 20:00
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.manual.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Manual Alarm Control Panel"
description: "Instructions how to integrate manual alarms into Home Assistant."
description: "Instructions on how to integrate manual alarms into Home Assistant."
date: 2015-10-13 19:10
sidebar: true
comments: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Manual Alarm Control Panel with MQTT Support"
description: "Instructions how to integrate manual alarms into Home Assistant with MQTT support."
description: "Instructions on how to integrate manual alarms into Home Assistant with MQTT support."
date: 2017-07-02 9:10
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Alarm Control Panels"
description: "Instructions how to integrate Alarm Control Panels into Home Assistant."
description: "Instructions on how to integrate Alarm Control Panels into Home Assistant."
date: 2015-10-13 19:10
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.mqtt.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "MQTT Alarm Control Panel"
description: "Instructions how to integrate MQTT capable Alarm Panels into Home Assistant."
description: "Instructions on how to integrate MQTT capable Alarm Panels into Home Assistant."
date: 2015-09-14 19:10
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.nx584.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "NX584 Alarm Control Panel"
description: "Instructions how to integrate NX584 into Home Assistant."
description: "Instructions on how to integrate NX584 into Home Assistant."
date: 2016-02-07 10:00
sidebar: true
comments: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Satel Integra Alarm Control Panel"
description: "Instructions how to setup the Satel Integra control panel within Home Assistant."
description: "Instructions on how to setup the Satel Integra control panel within Home Assistant."
date: 2017-09-07 13:28
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.simplisafe.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "SimpliSafe Alarm Control Panel"
description: "Instructions how to integrate SimpliSafe into Home Assistant."
description: "Instructions on how to integrate SimpliSafe into Home Assistant."
date: 2016-07-02 22:00
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.spc.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Vanderbilt SPC Alarm"
description: "Instructions how to setup the Vanderbilt SPC Alarm control panel within Home Assistant."
description: "Instructions on how to setup the Vanderbilt SPC Alarm control panel within Home Assistant."
date: 2017-05-18 22:01
sidebar: true
comments: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Honeywell TotalConnect Alarm Control Panel"
description: "Instructions how to integrate TotalConnect alarms into Home Assistant."
description: "Instructions on how to integrate TotalConnect alarms into Home Assistant."
date: 2017-04-02 22:00
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.verisure.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Verisure Alarm"
description: "Instructions how to setup the Verisure Alarm control panel within Home Assistant."
description: "Instructions on how to setup the Verisure Alarm control panel within Home Assistant."
date: 2016-02-15 22:00
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alarm_control_panel.wink.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Wink Alarm"
description: "Instructions how to setup the Wink alarms within Home Assistant."
description: "Instructions on how to setup the Wink alarms within Home Assistant."
date: 2017-01-14 12:00
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/alert.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Alert"
description: "Instructions how to setup automatic alerts within Home Assistant."
description: "Instructions on how to setup automatic alerts within Home Assistant."
date: 2017-01-15 20:00
sidebar: true
comments: false
Expand Down
4 changes: 2 additions & 2 deletions source/_components/alexa.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Alexa / Amazon Echo"
description: "Instructions how to connect Alexa/Amazon Echo to Home Assistant."
description: "Instructions on how to connect Alexa/Amazon Echo to Home Assistant."
date: 2015-12-13 13:02
sidebar: true
comments: false
Expand Down Expand Up @@ -167,7 +167,7 @@ intent_script:
text: OK
```

Here we are using [templates] to take the name we gave to Alexa e.g. `downstairs on` and replace the space with an underscore so it becomes `downstairs_on` as Home Assistant expects.
Here we are using [templates] to take the name we gave to Alexa e.g., `downstairs on` and replace the space with an underscore so it becomes `downstairs_on` as Home Assistant expects.

Now say `Alexa ask Home Assistant to activate <some scene>` and Alexa will activate that scene for you.

Expand Down
4 changes: 2 additions & 2 deletions source/_components/amcrest.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Amcrest IP Camera"
description: "Instructions how to integrate Amcrest IP cameras within Home Assistant."
description: "Instructions on how to integrate Amcrest IP cameras within Home Assistant."
date: 2017-06-24 10:00
sidebar: true
comments: false
Expand Down Expand Up @@ -45,7 +45,7 @@ Configuration variables:
- **port** (*Optional*): The port that the camera is running on. The default is 80.
- **resolution** (*Optional*): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option `high`. For VGA resolution (640x480p), specify the option `low`. If omitted, it defaults to *high*.
- **stream_source** (*Optional*): The data source for the live stream. `mjpeg` will use the camera's native MJPEG stream, whereas `snapshot` will use the camera's snapshot API to create a stream from still images. You can also set the `rtsp` option to generate the streaming via RTSP protocol. If omitted, it defaults to *snapshot*.
- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options.
- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g., image quality or video filter options.
- **authentication**: (*Optional*): Defines which authentication method to use only when **stream_source** is **mjpeg**. Currently, *aiohttp* only support *basic*. It defaults to *basic*.
- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. The default is 10 seconds.
- **sensors** array (*Optional*): Conditions to display in the frontend. By default, *none* of the conditions are enabled. The following conditions can be monitored.
Expand Down
2 changes: 1 addition & 1 deletion source/_components/api.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "API"
description: "Instructions how to setup the RESTful API within Home Assistant."
description: "Instructions on how to setup the RESTful API within Home Assistant."
date: 2018-01-21 08:00
sidebar: true
comments: false
Expand Down
7 changes: 3 additions & 4 deletions source/_components/apple_tv.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Apple TV"
description: "Instructions how to integrate Apple TV devices into Home Assistant."
description: "Instructions on how to integrate Apple TV devices into Home Assistant."
date: 2017-06-26 20:47
sidebar: true
comments: false
Expand All @@ -13,7 +13,7 @@ ha_iot_class: "Local Push"
ha_release: 0.49
---

The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/components/remote.apple_tv/) if you want to send remote control buttons, e.g. arrow keys.
The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/components/remote.apple_tv/) if you want to send remote control buttons, e.g., arrow keys.

<p class='note'>
Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
Expand Down Expand Up @@ -92,7 +92,7 @@ then device authentication is required. Press the icon in the upper left corner

<img src='/images/screenshots/developer-tools.png' />

Select `apple_tv` as domain, `apple_tv_authenticate` as service and enter `{"entity_id": "XXX"}` into "Service Data", but replace XXX with the entity id of your device (e.g. `media_player.apple_tv`). Press the button and hopefully you are presented with an input dialog asking for a pin code:
Select `apple_tv` as domain, `apple_tv_authenticate` as service and enter `{"entity_id": "XXX"}` into "Service Data", but replace XXX with the entity id of your device (e.g., `media_player.apple_tv`). Press the button and hopefully you are presented with an input dialog asking for a pin code:

<img src='/images/components/apple_tv/auth_start.jpg' />

Expand Down Expand Up @@ -143,4 +143,3 @@ To play media on an Apple TV with device authentication enabled (e.g., ATV4 with
### {% linkable_title Service `apple_tv_scan` %}

Scans the local network for Apple TVs. All found devices are presented as a persistent notification.

4 changes: 2 additions & 2 deletions source/_components/arduino.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Arduino"
description: "Instructions how to setup an Arduino boards within Home Assistant."
description: "Instructions on how to setup an Arduino boards within Home Assistant."
date: 2015-06-27 10:28
sidebar: true
comments: false
Expand Down Expand Up @@ -43,7 +43,7 @@ The exact number can be determined with the command shown below.
$ ls /dev/ttyACM*
```

If that's not working, check your `dmesg` or `journalctl -f` output. Keep in mind that Arduino clones are often using a different name for the port (e.g. `/dev/ttyUSB*`).
If that's not working, check your `dmesg` or `journalctl -f` output. Keep in mind that Arduino clones are often using a different name for the port (e.g., `/dev/ttyUSB*`).

<p class='note warning'>
A word of caution: The Arduino boards are not storing states. This means that with every initialization the pins are set to off/low.
Expand Down
2 changes: 1 addition & 1 deletion source/_components/asterisk_mbox.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Asterisk Voicemail"
description: "Instructions how to integrate your existing Asterisk voicemail within Home Assistant."
description: "Instructions on how to integrate your existing Asterisk voicemail within Home Assistant."
date: 2017-06-30 18:30
sidebar: true
comments: false
Expand Down
4 changes: 2 additions & 2 deletions source/_components/automation.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Automation"
description: "Instructions how to setup automation within Home Assistant."
description: "Instructions on how to setup automation within Home Assistant."
date: 2015-01-20 22:36
sidebar: true
comments: false
Expand All @@ -19,7 +19,7 @@ Starting with 0.28 your automation rules can be controlled with the frontend.
<img src='{{site_root}}/images/screenshots/automation-switches.png' />
</p>

This allows one to reload the automation without restarting Home Assistant itself. If you don't want to see the automation rule in your frontend use `hide_entity: True` to hide it. You can also use `initial_state: 'off'` so that the automation is not automatically turned on after a Home assistant reboot.
This allows one to reload the automation without restarting Home Assistant itself. If you don't want to see the automation rule in your frontend use `hide_entity: True` to hide it. You can also use `initial_state: 'off'` so that the automation is not automatically turned on after a Home Assistant reboot.

```yaml
automation:
Expand Down
2 changes: 1 addition & 1 deletion source/_components/bbb_gpio.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "BeagleBone Black GPIO"
description: "Instructions how to integrate the GPIO capability of a BeagleBone Black into Home Assistant."
description: "Instructions on how to integrate the GPIO capability of a BeagleBone Black into Home Assistant."
date: 2017-01-14 10:00
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.abode.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Abode Binary Sensor"
description: "Instructions how to integrate Abode binary sensors into Home Assistant."
description: "Instructions on how to integrate Abode binary sensors into Home Assistant."
date: 2017-08-26 0:28
sidebar: true
comments: false
Expand Down
2 changes: 1 addition & 1 deletion source/_components/binary_sensor.alarmdecoder.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "AlarmDecoder Binary Sensor"
description: "Instructions how to integrate AlarmDecoder binary sensors into Home Assistant."
description: "Instructions on how to integrate AlarmDecoder binary sensors into Home Assistant."
date: 2017-04-02 13:28
sidebar: true
comments: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Android IP Webcam Binary Sensor"
description: "Instructions how to integrate binary motion sensors for Android IP webcam within Home Assistant."
description: "Instructions on how to integrate binary motion sensors for Android IP webcam within Home Assistant."
date: 2017-03-10 00:00
sidebar: true
comments: false
Expand Down
4 changes: 2 additions & 2 deletions source/_components/binary_sensor.arest.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "aREST Binary Sensor"
description: "Instructions how to integrate aREST binary sensors within Home Assistant."
description: "Instructions on how to integrate aREST binary sensors within Home Assistant."
date: 2015-11-20 18:15
sidebar: true
comments: false
Expand All @@ -28,7 +28,7 @@ binary_sensor:

Configuration variables:

- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g., http://192.168.1.10.
- **pin** (*Required*): Number of the pin to monitor.
- **name** (*Optional*): Let you overwrite the name of the device. By default *name* from the device is used.

Expand Down
Loading