Merge remote-tracking branch 'origin/current' into next
This commit is contained in:
Paulus Schoutsen
commit
31c4114e32
54 changed files with 1143 additions and 291 deletions
|
|
@ -27,7 +27,9 @@ The Alarm Decoder component gives you access to several services for you to cont
|
|||
- `alarm_disarm`: Disarms the alarm from any state. Also clears a `check_zone` flag after an alarm was triggered.
|
||||
- `alarmdecoder_alarm_toggle_chime`: Toggles the alarm's chime state.
|
||||
|
||||
**Note**: `alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder component.
|
||||
<p class='note'>
|
||||
`alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Attributes %}
|
||||
|
||||
|
|
|
|||
|
|
@ -14,11 +14,12 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
The 'hive' binary sensor component integrates your Hive sensors into Home Assistant.
|
||||
The `hive` binary sensor component integrates your Hive sensors into Home Assistant.
|
||||
|
||||
The Hive binary sensor component supports the following Hive products:
|
||||
- **Hive Window or Door Sensor**
|
||||
- **Hive Motion Sensor**
|
||||
The platform supports the following Hive products:
|
||||
|
||||
- Hive Window or Door Sensor
|
||||
- Hive Motion Sensor
|
||||
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
18
source/_components/binary_sensor.qwikswitch.markdown
Normal file
18
source/_components/binary_sensor.qwikswitch.markdown
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
title: "QwikSwitch Binary Sensor"
|
||||
description: "Instructions on how to integrate Qwikswitch dimmers and relays as sensors into Home Assistant."
|
||||
date: 2016-05-04 00:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: qwikswitch.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
ha_release: "0.68"
|
||||
---
|
||||
|
||||
The `qwikswitch` binary_sensor platform allows you to use your [QwikSwitch](http://www.qwikswitch.co.za/) sensors within Home Assistant.
|
||||
|
||||
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).
|
||||
|
|
@ -16,6 +16,8 @@ ha_release: 0.57
|
|||
|
||||
The `random` binary sensor platform is creating random states (`True`, 1, `on` or `False`, 0, `off`). This can be useful if you want to test automation rules. It generates a new state every time it is polled.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable the random binary sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ To enable the `workday` sensor in your installation, add the following to your `
|
|||
binary_sensor:
|
||||
- platform: workday
|
||||
country: DE
|
||||
workdays: [ mon, wed, fri ]
|
||||
workdays: [mon, wed, fri]
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ ha_release: 0.33
|
|||
|
||||
The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see.
|
||||
|
||||
### {% linkable_title Prerequisites %}
|
||||
## {% linkable_title Prerequisites %}
|
||||
|
||||
Generate a Client ID and Client Secret on [Google Developers Console](https://console.developers.google.com/start/api?id=calendar).
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ Generate a Client ID and Client Secret on [Google Developers Console](https://co
|
|||
1. Save the client ID and secret as you will need to put these in your `configuration.yaml` file.
|
||||
1. Click on "Library", search for "Google Calendar API" and enable it.
|
||||
|
||||
### {% linkable_title Basic Setup %}
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate Google Calendar in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -61,7 +61,7 @@ The next steps will require you to have Home Assistant running.
|
|||
|
||||
After you have it running complete the Google authentication that pops up. It will give you a URL and a code to enter. This will grant your Home Assistant service access to all the Google Calendars that the account you authenticate with can read. This is a Read-Only view of these calendars.
|
||||
|
||||
### {% linkable_title Calendar Configuration %}
|
||||
## {% linkable_title Calendar Configuration %}
|
||||
|
||||
Editing the `google_calendars.yaml` file.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Local File"
|
||||
description: "Instructions on how to use Local File as a Camera within Home Assistant."
|
||||
description: "Instructions how to use Local File as a Camera within Home Assistant."
|
||||
date: 2016-06-12 17:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
|
@ -13,9 +13,9 @@ ha_iot_class: "Local Polling"
|
|||
ha_release: 0.22
|
||||
---
|
||||
|
||||
The `local_file` camera platform allows you to integrate any readable image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated.
|
||||
The `local_file` camera platform allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file_update_file_path` can be used to update the image using an automation.
|
||||
|
||||
This can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
|
||||
The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
|
||||
|
||||
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -31,7 +31,11 @@ Configuration variables:
|
|||
- **file_path** (*Required*): File to serve as the camera.
|
||||
- **name** (*Optional*): Name of the camera
|
||||
|
||||
<p class='note'>
|
||||
The given `file_path` must be an existing file because the camera platform setup make a readable check on it.
|
||||
</p>
|
||||
### {% linkable_title Service `camera.local_file_update_file_path` %}
|
||||
|
||||
Use this service to change the file displayed by the camera.
|
||||
|
||||
| Service data attribute | Description |
|
||||
| -----------------------| ----------- |
|
||||
| `entity_id` | String of the `entity_id` of the camera to update. |
|
||||
| `file_path` | The full path to the new image file to be displayed. |
|
||||
|
|
|
|||
|
|
@ -14,13 +14,15 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
The 'hive' climate component integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.
|
||||
The `hive` climate platform integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**.
|
||||
|
||||
A short boost for Hive Heating or Hive Hot water can be set by using the **Aux Heat** function, this will turn on the boost feature for Hive Heating or Hive Hot water for 30 minutes at 0.5 degrees higher than the current temperature.
|
||||
|
||||
The Hive climate component supports the following Hive products:
|
||||
- **Hive Active Heating**
|
||||
- **Hive Multizone**
|
||||
- **Hot water control**
|
||||
The platform supports the following Hive products:
|
||||
|
||||
- Hive Active Heating
|
||||
- Hive Multizone
|
||||
- Hot water control
|
||||
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ ha_iot_class: "Local Push"
|
|||
|
||||
Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file.
|
||||
|
||||
If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in `deconz.conf` inside the `.homeassistant` folder.
|
||||
If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in `.config_entries.json` inside the `.homeassistant` folder.
|
||||
|
||||
You can add the following to your configuration.yaml file if you are not using the `discovery:` component:
|
||||
|
||||
|
|
|
|||
|
|
@ -29,9 +29,9 @@ To integrate Google Maps Location Sharing in Home Assistant, add the following s
|
|||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
platform: google_maps
|
||||
username: example@gmail.com
|
||||
password: password
|
||||
- platform: google_maps
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
|
|
|
|||
|
|
@ -40,6 +40,10 @@ The following optional parameters can be used with any platform. However device
|
|||
| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) |
|
||||
| `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`).
|
||||
</p>
|
||||
|
||||
The extended example from above would look like the following sample:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -11,8 +11,21 @@ logo: meraki.png
|
|||
ha_category: Presence Detection
|
||||
ha_release: "0.60"
|
||||
---
|
||||
Use your `Meraki AP` as device tracker. Note that Meraki will see all devices, not only connected to the network.
|
||||
Follow instructions [here](https://meraki.cisco.com/technologies/location-analytics-api) how to enable Location Analytics.
|
||||
|
||||
Use your Meraki AP as device tracker. Note that Meraki will see all devices, not only connected to the network.
|
||||
|
||||
### {% linkable_title Prerequisites %}
|
||||
|
||||
1. Go to Network-wide/General page, and find the Location and scanning section.
|
||||
1. Make sure analytics and Scanning API are both enabled.
|
||||
1. Make note of the Validator string, which will be used in the `device_tracker` configuration.
|
||||
1. Click **Add a Post URL**:
|
||||
1. Set the Post URL to `https://YOUR_HOSTNAME/api/meraki?api_password=YOUR_HASS_PASSWORD`
|
||||
1. Set the Secret to a randomly generated string, and make note of it for the `device_tracker` configuration.
|
||||
1. Make sure the API Version is set to `2.0`.
|
||||
1. Hit **Save** in the bottom right of the page.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
After you configure access to the Meraki CMX API, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -24,14 +37,13 @@ device_tracker:
|
|||
validator: meraki_validator
|
||||
```
|
||||
|
||||
|
||||
{% configuration %}
|
||||
secret:
|
||||
description: Secret code added in Meraki
|
||||
description: Secret code added in Meraki.
|
||||
required: true
|
||||
type: string
|
||||
validator:
|
||||
description: Validation string from Meraki
|
||||
description: Validation string from Meraki.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ For Archer C9 models running firmware version 150811 or later please use the enc
|
|||
2. Type in the password you use to login into the password field.
|
||||
3. Click somewhere else on the page so that the password field is not selected anymore.
|
||||
4. Open the JavaScript console of your browser (usually by pressing F12 and then clicking on "Console").
|
||||
5. Type ```document.getElementById("login-password").value;```.
|
||||
5. Type `document.getElementById("login-password").value;` or `document.getElementById("pcPassword").value;`, depending on your firmware version.
|
||||
6. Copy the returned value to your Home Assistant configuration as password.
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Eufy"
|
||||
description: "Instructions on how to integrate Eufy devices into Home Assistant."
|
||||
date: 2018-05-09 19:00
|
||||
date: 2018-04-09 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
|
|
@ -12,7 +12,7 @@ ha_category: Hub
|
|||
ha_release: 0.68
|
||||
---
|
||||
|
||||
The `eufy` component is the main component to integrate various [eufy](http://https://www.eufylife.com/) devices with Home Assistant.
|
||||
The `eufy` component is the main component to integrate various [eufy](https://www.eufylife.com/) devices with Home Assistant.
|
||||
|
||||
Supported devices will be discovered after the `eufy` component is configured:
|
||||
|
||||
|
|
|
|||
|
|
@ -13,13 +13,14 @@ ha_iot_class: "Local Polling"
|
|||
ha_release: 0.67
|
||||
---
|
||||
|
||||
This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files. The monitored `event_type` are:
|
||||
This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are:
|
||||
|
||||
* `created`
|
||||
* `deleted`
|
||||
* `modified`
|
||||
* `moved`
|
||||
|
||||
Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
|
||||
Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
|
||||
|
||||
To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -13,13 +13,14 @@ ha_release: 0.68
|
|||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The [AVM](www.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices.
|
||||
The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices.
|
||||
|
||||
#### {% linkable_title Tested Devices %}
|
||||
|
||||
- [FRITZ!Box 6490 Cable](https://avm.de/produkte/fritzbox/fritzbox-6490-cable/)
|
||||
- [FRITZ!DECT 200](https://avm.de/produkte/fritzdect/fritzdect-200/)
|
||||
- [Eurotronic Comet DECT](https://www.eurotronic.org/produkte/comet-dect.html)
|
||||
- [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/)
|
||||
- [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/)
|
||||
- [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/)
|
||||
- [Eurotronic Comet DECT](https://www.eurotronic.org/en/products/comet-dect.html)
|
||||
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
|
|
|||
|
|
@ -25,6 +25,8 @@ The Google Assistant component requires a bit more setup than most due to the wa
|
|||
To use Google Assistant, your Home Assistant configuration has to be externally accessible with a hostname and SSL certificate. If you haven't already configured that, you should do so before continuing.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -14,11 +14,13 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
This Hive component is the main component to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating.
|
||||
The `hive` component is the main component to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating.
|
||||
|
||||
This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant.
|
||||
|
||||
To add your Hive devices into your Home Assistant installation, using the default scan_interval, add the following to your 'configuration.yaml' file:
|
||||
|
||||
|
||||
To add your Hive devices into your Home Assistant installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
|
|||
|
|
@ -39,6 +39,10 @@ The `HomeKit` component allows you to forward entities from Home Assistant to Ap
|
|||
required: false
|
||||
type: int
|
||||
default: 51827
|
||||
ip_address:
|
||||
description: The local network IP address. Only necessary if the default from Home Assistant does not work.
|
||||
required: false
|
||||
type: string
|
||||
filter:
|
||||
description: Filter entities to available in the `Home` app. ([Configure Filter](#configure-filter))
|
||||
required: false
|
||||
|
|
@ -77,6 +81,9 @@ The `HomeKit` component allows you to forward entities from Home Assistant to Ap
|
|||
default: ''
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
If you use Z-Wave, or `discovery:` you'll need to disable auto-start, see the [section below](#disable-auto-start) for details on how to do this. You'll then need to start the HomeKit component once Z-Wave is ready, or an appropriate delay to allow your entities to be discovered.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
|
|
@ -116,7 +123,7 @@ A common situation might be if you decide to disable parts of the configuration
|
|||
|
||||
Depending on your individual setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully setup when the `HomeKit` component is started, can be added. To start `HomeKit` when `auto_start: False`, you can call the service `homekit.start`.
|
||||
|
||||
This can be automated using an `automation`.
|
||||
If you have Z-Wave entities you want 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:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
|
|
@ -134,6 +141,8 @@ automation:
|
|||
```
|
||||
{% endraw %}
|
||||
|
||||
For a general delay where your component doesn't generate an event, you can also do:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example using a delay after start of Home Assistant
|
||||
|
|
@ -194,12 +203,13 @@ The following components are currently supported:
|
|||
| Component | Type Name | Description |
|
||||
| --------- | --------- | ----------- |
|
||||
| alarm_control_panel | SecuritySystem | All security systems. |
|
||||
| binary_sensor | Sensor | Support for `CO2`, `Gas`, `Moisture`, `Motion`, `Occupancy`, `Opening` and `Smoke` device classes. Defaults to the `Occupancy` device class for everything else. |
|
||||
| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. |
|
||||
| climate | Thermostat | All climate devices. |
|
||||
| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` as their `device_class`. |
|
||||
| cover | WindowCovering | All covers that support `set_cover_position`. |
|
||||
| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) |
|
||||
| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) |
|
||||
| device_tracker | Sensor | Support for `occupancy` device class. |
|
||||
| light | Light | Support for `on / off`, `brightness` and `rgb_color`. |
|
||||
| lock | DoorLock | Support for `lock / unlock`. |
|
||||
| sensor | TemperatureSensor | All sensors that have `Celsius` or `Fahrenheit` as their `unit_of_measurement` or `temperature` as their `device_class`. |
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Light](../light.homekit_controller)
|
||||
- [Switch](../switch.homekit_controller)
|
||||
- [Light](/components/light.homekit_controller/)
|
||||
- [Switch](/components/switch.homekit_controller/)
|
||||
|
||||
The component will be automatically configured if the [`discovery:`](/components/discovery/) component is enabled and an enable entry added for HomeKit:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "EufyLights"
|
||||
title: "Eufy Lights"
|
||||
description: "Instructions on how to integrate Eufy LED lights into Home Assistant."
|
||||
date: 2018-05-09 19:00
|
||||
date: 2018-04-09 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
|
|
|
|||
|
|
@ -14,12 +14,13 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
The 'hive' light component integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light.
|
||||
The `hive` light platform integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light.
|
||||
|
||||
The Hive light component supports the following Hive products:
|
||||
- **Hive Active Light Dimmable**
|
||||
- **Hive Active Light Cool to Warm White**
|
||||
- **Hive Active Light Color Changing**
|
||||
The platform supports the following Hive products:
|
||||
|
||||
- Hive Active Light Dimmable
|
||||
- Hive Active Light Cool to Warm White
|
||||
- Hive Active Light Color Changing
|
||||
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
|
|
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/) and some recent [Pioneer](http://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this component to work in your Hardware.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add an Onkyo or Pioneer receiver to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -15,9 +15,12 @@ ha_release: 0.48
|
|||
|
||||
The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant.
|
||||
|
||||
### Get your ClickSend API Credentials
|
||||
## {% linkable_title Prerequisites %}
|
||||
|
||||
Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and create your new project. After creating your project, you should now be able to obtain your `username` and `api_key`.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -60,16 +60,19 @@ On some QS Mobile servers button events are only generated for switches added to
|
|||
|
||||
### {% linkable_title Qwikswitch Sensors %}
|
||||
|
||||
The sensor configuration is a list of sensors. Each sensor is configured with the following parameters:
|
||||
The sensor configuration is a list of sensors. Depending on the type, it will be a sensor or binary_sensor. Each sensor is configured with the following parameters:
|
||||
|
||||
- **name** (*Required*): The sensor name from which the entity_id will be derived.
|
||||
- **id** (*Required*): A QS_Id
|
||||
- **type** (*Required*): The Qwikswitch sensor type. These could include:
|
||||
- imod (up to 6 channels)
|
||||
- door (single channel)
|
||||
- qwikcord (Channel1 = CTavg, Channel 2 = CTsum)
|
||||
- imod (binary_sensor, up to 6 channels)
|
||||
- door (binary_sensor, single channel)
|
||||
- qwikcord (Channel 1 = CTavg, Channel 2 = CTsum)
|
||||
- **channel** (*Optional, default=1*): The channel of interest. Refer to type above.
|
||||
|
||||
The following parameters are only applicabe to binary_sensors (i.e. door/imod).
|
||||
- **invert** (*Optional, default=False): Invert the open/close state.
|
||||
- **class** (*Optional, default=door): The [class](https://www.home-assistant.io/components/binary_sensor) or binary_sensor.
|
||||
|
||||
Example sensor configuration:
|
||||
|
||||
|
|
|
|||
|
|
@ -14,11 +14,12 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
The 'hive' sensor component exposes hive data as a sensor.
|
||||
The `hive` sensor component exposes Hive data as a sensor.
|
||||
|
||||
The Hive sensor component exposes the following sensors:
|
||||
- **Hive Hub Online Status**
|
||||
- **Hive Outside Temperature**
|
||||
The platform exposes the following sensors:
|
||||
|
||||
- Hive Hub Online Status
|
||||
- Hive Outside Temperature
|
||||
|
||||
<p class='note'>
|
||||
Full configuration details can be found on the main [Hive component](/components/hive/) page.
|
||||
|
|
|
|||
|
|
@ -13,6 +13,6 @@ ha_iot_class: "Local Push"
|
|||
ha_release: "0.67"
|
||||
---
|
||||
|
||||
The `qwikswitch` sensor platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays and dimmers as sensors from within Home Assistant.
|
||||
The `qwikswitch` sensor platform allows you to use your [QwikSwitch](http://www.qwikswitch.co.za/) sensors in Home Assistant.
|
||||
|
||||
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).
|
||||
|
|
|
|||
|
|
@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
The `sht31` sensor platform allows you to get the current temperature and humidity from a Sensirion SHT31 device.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your SHT31 sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -17,6 +17,8 @@ The `thethingsnetwork` sensor platform allows you to get data from a [The Things
|
|||
|
||||
This platform requires that the [The Things Network component](/components/thethingsnetwork/) is set up and the [The Things Network Storage Integration](https://www.thethingsnetwork.org/docs/applications/storage/) as well.
|
||||
|
||||
## {% linkable_title Prerequisites %}
|
||||
|
||||
Visit the [The Things Network Console](https://console.thethingsnetwork.org/) website, log in with your The Things Network credentials, choose your application from **Applications** and go to **Integrations**.
|
||||
|
||||
Add a new integration.
|
||||
|
|
@ -54,6 +56,8 @@ Select **Devices** to get the ID of your device that you want to use.
|
|||
Devices overview
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this platform, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ sidebar: false
|
|||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: uscis.jpg
|
||||
logo: uscis.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.68
|
||||
ha_iot_class: "Cloud Polling"
|
||||
|
|
@ -31,9 +31,9 @@ friendly_name:
|
|||
default: USCIS
|
||||
type: string
|
||||
case_id:
|
||||
description: Case/receipt number used to get the case details from USCIS web client.
|
||||
description: Case/receipt number used to get the case details from USCIS web client.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
All the data will be fetch from [USCIS](https://egov.uscis.gov/casestatus/mycasestatus.do).
|
||||
All the data will be fetch from [USCIS](https://egov.uscis.gov/casestatus/mycasestatus.do).
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Snips"
|
||||
description: "Instructions on how to integrate Snips within Home Assistant."
|
||||
date: 2017-06-22 12:00
|
||||
date: 2018-05-02 12:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
|
|
@ -14,7 +14,7 @@ ha_release: 0.48
|
|||
|
||||
The [Snips Voice Platform](https://www.snips.ai) allows users to add powerful voice assistants to their Raspberry Pi devices without compromising on privacy. It runs 100% on-device, and does not require an internet connection. It features Hotword Detection, Automatic Speech Recognition (ASR), Natural Language Understanding (NLU) and Dialog Management.
|
||||
|
||||
The latest documentation can be found here: [Snips Platform Documentation](https://github.com/snipsco/snips-platform-documentation/wiki).
|
||||
The latest documentation can be found here: [Snips Platform Documentation](https://snips.gitbook.io/documentation/).
|
||||
|
||||
|
||||
|
||||
|
|
@ -97,7 +97,7 @@ followed by a command, e.g.
|
|||
|
||||
> Set the lights to green in the living room
|
||||
|
||||
As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/<intentName>` topic. The Snips Home Assistant component subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml`, as explained below.
|
||||
As the Snips Platform parses this query into an intent, it will be published on MQTT, on the `hermes/intent/<intentName>` topic. The Snips Home Assistant component subscribes to this topic, and handles the intent according to the rules defined in `configuration.yaml` file, as explained below.
|
||||
|
||||
#### {% linkable_title Optional: specifying an external MQTT broker %}
|
||||
|
||||
|
|
@ -166,11 +166,11 @@ SetTimer:
|
|||
```
|
||||
{% endraw %}
|
||||
|
||||
### Sending TTS Notifications
|
||||
### {% linkable_title Sending TTS Notifications %}
|
||||
|
||||
You can send TTS notifications to Snips using the snips.say and snips.say_action services. Say_action starts a session and waits for user response, "Would you like me to close the garage door?", "Yes, close the garage door".
|
||||
|
||||
#### {% linkable_title Service `snips/say` %}
|
||||
#### {% linkable_title Service `snips.say` %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------------|
|
||||
|
|
@ -178,7 +178,7 @@ You can send TTS notifications to Snips using the snips.say and snips.say_action
|
|||
| `site_id` | yes | Site to use to start session. |
|
||||
| `custom_data` | yes | custom data that will be included with all messages in this session. |
|
||||
|
||||
#### {% linkable_title Service `snips/say_action` %}
|
||||
#### {% linkable_title Service `snips.say_action` %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------------|
|
||||
|
|
@ -188,19 +188,48 @@ You can send TTS notifications to Snips using the snips.say and snips.say_action
|
|||
| `can_be_enqueued` | yes | If True, session waits for an open session to end, if False session is dropped if one is running. |
|
||||
| `intent_filter` | yes | Array of Strings - A list of intents names to restrict the NLU resolution to on the first query. |
|
||||
|
||||
#### Configuration Examples
|
||||
|
||||
### {% linkable_title Snips Support %}
|
||||
|
||||
There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support.
|
||||
|
||||
### {% linkable_title Configuration Examples %}
|
||||
|
||||
#### {% linkable_title Turn on a light %}
|
||||
|
||||
```yaml
|
||||
script:
|
||||
intent_script:
|
||||
turn_on_light:
|
||||
sequence:
|
||||
service: script.turn_on_light
|
||||
service: snips.say
|
||||
data:
|
||||
text: 'OK, the light is now on'
|
||||
speech:
|
||||
type: plain
|
||||
text: 'OK, closing the garage door'
|
||||
action:
|
||||
service: light.turn_on
|
||||
```
|
||||
|
||||
##### {% linkable_title Open a Garage Door %}
|
||||
|
||||
```yaml
|
||||
intent_script:
|
||||
OpenGarageDoor:
|
||||
speech:
|
||||
type: plain
|
||||
text: 'OK, opening the garage door'
|
||||
action:
|
||||
- service: cover.open_cover
|
||||
data:
|
||||
entity_id: garage_door
|
||||
```
|
||||
|
||||
##### {% linkable_title Intiating a query %}
|
||||
|
||||
Here is a more complex example. The automation is triggered if the garage door is open for more than 10 minutes.
|
||||
Snips will then ask you if you want to close it and if you respond with something like "Close the garage door" it
|
||||
will do so. Unfortunately there is no builtin support for yes and no responses.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
query_garage_door:
|
||||
garage_door_has_been_open:
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id: binary_sensor.my_garage_door_sensor
|
||||
|
|
@ -224,3 +253,40 @@ intent_script:
|
|||
action:
|
||||
- service: script.garage_door_close
|
||||
```
|
||||
|
||||
##### {% linkable_title Weather %}
|
||||
|
||||
So now you can open and close your garage door, let's check the weather. Add the Weather by Snips Skill to your assistant. Create a weather sensor, in this example (Dark Sky)[/components/sensor.darksky/] and the `api_key` in the `secrets.yaml` file.
|
||||
|
||||
```yaml
|
||||
- platform: darksky
|
||||
name: "Dark Sky Weather"
|
||||
api_key: !secret dark_sky_key
|
||||
update_interval:
|
||||
minutes: 10
|
||||
monitored_conditions:
|
||||
- summary
|
||||
- hourly_summary
|
||||
- temperature
|
||||
- temperature_max
|
||||
- temperature_min
|
||||
```
|
||||
|
||||
Then create this `intent_script.yaml` file in your configuration directory.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
intent_script:
|
||||
searchWeatherForecast:
|
||||
speech:
|
||||
type: plain
|
||||
text: >
|
||||
The weather is currently
|
||||
{{ states('sensor.dark_sky_weather_temperature') | round(0) }}
|
||||
degrees outside and {{ states('sensor.dark_sky_weather_summary') }}.
|
||||
The high today will be
|
||||
{{ states('sensor.dark_sky_weather_daily_high_temperature') | round(0)}}
|
||||
and {{ states('sensor.dark_sky_weather_hourly_summary') }}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
layout: page
|
||||
title: "EufySwitch"
|
||||
title: "Eufy Switch"
|
||||
description: "Instructions on how to integrate Eufy switches into Home Assistant."
|
||||
date: 2018-05-09 19:00
|
||||
date: 2018-04-09 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
|
|
|
|||
|
|
@ -14,10 +14,11 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
The 'hive' switch component integrates your Hive plugs into Home Assistant, enabling control of your devices.
|
||||
The `hive` switch platform integrates your Hive plugs into Home Assistant, enabling control of your devices.
|
||||
|
||||
The Hive switch component supports the following Hive products:
|
||||
- **Hive Active Plug**
|
||||
The platform supports the following Hive products:
|
||||
|
||||
- Hive Active Plug
|
||||
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: page
|
||||
title: "HomeKit Light"
|
||||
description: "Instructions how to setup HomeKit switches within Home Assistant."
|
||||
title: "HomeKit Switch"
|
||||
description: "Instructions on how to setup HomeKit switches within Home Assistant."
|
||||
date: 2017-03-19 21:08
|
||||
sidebar: true
|
||||
comments: false
|
||||
|
|
|
|||
|
|
@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
The `rest` switch platform allows you to control a given endpoint that supports a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). The switch can get the state via GET and set the state via POST on a given REST resource.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this switch, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
@ -93,7 +95,7 @@ switch:
|
|||
resource: http://IP_ADDRESS/led_endpoint
|
||||
body_on: '{"active": "true"}'
|
||||
body_off: '{"active": "false"}'
|
||||
is_on_template: '{{value_json.is_active}}'
|
||||
is_on_template: '{{ value_json.is_active }}'
|
||||
headers:
|
||||
Content-Type: application/json
|
||||
```
|
||||
|
|
|
|||
|
|
@ -107,30 +107,29 @@ timer:
|
|||
|
||||
```yaml
|
||||
# Example automations.yaml entry
|
||||
- action:
|
||||
- service: timer.start
|
||||
entity_id: timer.test
|
||||
alias: Timerswitch
|
||||
- alias: Timerswitch
|
||||
id: 'Timerstart'
|
||||
|
||||
# Timer is started when the switch pumprun is set to on.
|
||||
# Timer is started when the switch pumprun is set to on.
|
||||
trigger:
|
||||
platform: state
|
||||
- platform: state
|
||||
entity_id: switch.pumprun
|
||||
to: 'on'
|
||||
action:
|
||||
- service: timer.start
|
||||
entity_id: timer.test
|
||||
|
||||
# When timer is stopped, the time run out, another message is sent
|
||||
- action:
|
||||
- service: notify.nma
|
||||
data:
|
||||
message: "Timer stop"
|
||||
alias: Timerstop
|
||||
- alias: Timerstop
|
||||
id: 'Timerstop'
|
||||
trigger:
|
||||
platform: event
|
||||
- platform: event
|
||||
event_type: timer.finished
|
||||
event_data:
|
||||
entity_id: timer.test
|
||||
action:
|
||||
- service: notify.nma
|
||||
data:
|
||||
message: "Timer stop"
|
||||
```
|
||||
|
||||
### {% linkable_title Control a timer from the frontend %}
|
||||
|
|
|
|||
|
|
@ -15,6 +15,8 @@ ha_release: 0.37
|
|||
The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output.
|
||||
Polly is a paid service via Amazon Web Services. There is a [free tier](https://aws.amazon.com/polly/pricing/) for the first 12 months and then a charge per million characters afterwards.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly):
|
||||
|
||||
```yaml
|
||||
|
|
@ -23,33 +25,62 @@ tts:
|
|||
- platform: amazon_polly
|
||||
aws_access_key_id: AWS_ACCESS_KEY_ID
|
||||
aws_secret_access_key: AWS_SECRET_ACCESS_KEY
|
||||
profile_name: AWS_PROFILE
|
||||
region_name: 'us-east-1'
|
||||
voice: Joanna
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
aws_access_key_id:
|
||||
description: "Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`."
|
||||
required: true
|
||||
type: string
|
||||
aws_secret_access_key:
|
||||
description: "Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`."
|
||||
required: true
|
||||
type: string
|
||||
profile_name:
|
||||
description: A credentials profile name. For more information, please see the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) for more information.
|
||||
required: false
|
||||
type: string
|
||||
region_name:
|
||||
description: "The region identifier to connect to. The default is `us-east-1`. See the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions."
|
||||
required: false
|
||||
type: string or list
|
||||
name:
|
||||
description: "Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`."
|
||||
required: false
|
||||
type: string
|
||||
text_type:
|
||||
description: "Specify wherever to use text (default) or ssml markup by default."
|
||||
required: false
|
||||
type: string
|
||||
default: text
|
||||
voice:
|
||||
description: "Voice name to be used. See the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html) for available voices."
|
||||
required: false
|
||||
type: string
|
||||
output_format:
|
||||
description: "Override the default output format, e.g., `mp3`, `ogg_vorbis` or `pcm`."
|
||||
required: false
|
||||
type: string
|
||||
default: mp3
|
||||
sample_rate:
|
||||
description: "Override the default sample rate, defaults to 22050 for MP3 and Ogg Vorbis, 16000 for pcm."
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
| Parameter | Value | Description |
|
||||
|---------------------|----------|-------------|
|
||||
| `aws_access_key_id` | Required | Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name` |
|
||||
| `aws_secret_access_key` | Required | Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. |
|
||||
| `profile_name` | Optional | A credentials profile name. For more information, please see the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) for more information. |
|
||||
| `region_name` | Optional | The region identifier to connect to. The default is `us-east-1`. |
|
||||
| `name` | Optional | Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. |
|
||||
| `text_type` | text/ssml | text or ssml: Specify wherever to use text (default) or ssml markup by default. |
|
||||
| `voice` | Optional | Voice name to be used. See the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html) for available voices. |
|
||||
| `output_format` | mp3/ogg_vorbis/pcm | Override the default output format, defaults to MP3. |
|
||||
| `sample_rate` | 8000/16000/22050 | Override the default sample rate, defaults to 22050 for MP3 and Ogg Vorbis, 16000 for pcm. |
|
||||
|
||||
## Usage
|
||||
## {% linkable_title Usage %}
|
||||
|
||||
Say to all `media_player` device entities:
|
||||
|
||||
```yaml
|
||||
- service: tts.amazon_polly_say
|
||||
data_template:
|
||||
message: '<speak>Hello from Amazon Polly</speak>'
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```yaml
|
||||
- service: tts.amazon_polly_say
|
||||
data_template:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue