Compare commits
4 commits
next
...
NovapaX-pa
| Author | SHA1 | Date | |
|---|---|---|---|
|
7dbf76c25f | ||
|
|
f6db975a41 | ||
|
|
f2f34e8e9d | ||
|
|
41631bd881 |
236 changed files with 4744 additions and 3770 deletions
|
|
@ -139,9 +139,9 @@ social:
|
|||
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 69
|
||||
current_minor_version: 67
|
||||
current_patch_version: 0
|
||||
date_released: 2018-05-11
|
||||
date_released: 2018-04-13
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ module Jekyll
|
|||
class ConfigurationBlock < Liquid::Block
|
||||
TYPE_LINKS = {
|
||||
'action' => '/docs/scripts/',
|
||||
'device_class' => '/components/%{component}/#device-class',
|
||||
'device_class' => '/components/%{component}/#device_class',
|
||||
'template' => '/docs/configuration/templating/',
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -4,10 +4,6 @@ $primary-color: #049cdb;
|
|||
|
||||
.site-header {
|
||||
position: relative;
|
||||
|
||||
.site-title {
|
||||
font-weight: normal;
|
||||
}
|
||||
}
|
||||
|
||||
.search-container {
|
||||
|
|
@ -381,26 +377,18 @@ p.note {
|
|||
}
|
||||
|
||||
.copyright {
|
||||
text-align: left;
|
||||
text-align: center;
|
||||
|
||||
.company {
|
||||
.title {
|
||||
font-size: 1.5em;
|
||||
}
|
||||
|
||||
img {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
i {
|
||||
font-size: 2em;
|
||||
padding: 0 5px;
|
||||
}
|
||||
i {
|
||||
font-size: 3em;
|
||||
margin-right: 8px;
|
||||
position: relative;
|
||||
top: -5px;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin: 0;
|
||||
list-style: none;
|
||||
.credit {
|
||||
text-align: left;
|
||||
display: inline-block;
|
||||
font-size: .8em;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "Let's Encrypt"
|
||||
description: "Automatically manage your SSL certificate using Let's Encrypt."
|
||||
date: 2018-04-18 10:55
|
||||
date: 2017-04-30 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
|
|
@ -41,24 +41,4 @@ http:
|
|||
|
||||
If you use another port such as `8123` or an SSL proxy, change the port number.
|
||||
|
||||
## {% linkable_title Enabling auto-renewals %}
|
||||
|
||||
Out of the box, the add-on will not automatically renew your certificate. In fact, it only starts, tries to get/renew your certificte, and then stops. It's up to you to manually start it again whenever your certificate comes close to expiry.
|
||||
|
||||
However, you can automate this process using Home Assistant.
|
||||
|
||||
Use this in your `automations.yaml` to attempt certificate renewal each day at midnight:
|
||||
|
||||
```yaml
|
||||
- id: letsencrypt-renewal
|
||||
alias: "Let's Encrypt Renewal"
|
||||
trigger:
|
||||
- platform: time
|
||||
at: '00:00:00'
|
||||
action:
|
||||
- service: hassio.addon_restart
|
||||
data:
|
||||
addon: core_letsencrypt
|
||||
```
|
||||
|
||||
[DuckDNS add-on]: /addons/duckdns/
|
||||
|
|
|
|||
|
|
@ -2,14 +2,14 @@
|
|||
layout: page
|
||||
title: "Snips.ai"
|
||||
description: "Enhance your Hass.io installation with a local voice assistant."
|
||||
date: 2018-05-02 13:28
|
||||
date: 2018-03-22 13:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
[Snips.ai](https://snips.ai/) is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
|
||||
[Snips.ai] is an AI-powered voice assistant that runs on the Raspberry Pi 3 and x86 platforms. It runs on-device and is Private by Design.
|
||||
|
||||
The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so make sure that is installed.
|
||||
|
||||
|
|
@ -17,7 +17,7 @@ HomeAssistant comes with certain Intents builtin to handle common tasks. A compl
|
|||
|
||||
The Snips addon by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a shopping list if that component is enabled.
|
||||
|
||||
If using a USB microphone and speakers plugged into the Raspberry Pi output, Snips will work without any change to the configuration. Trying saying things like:
|
||||
If using a USB microphone and speakers plugged into the raspberry pi output, Snips will work without any change to the configuration. Trying saying things like:
|
||||
|
||||
```
|
||||
Turn on kitchen light
|
||||
|
|
@ -25,16 +25,42 @@ Open garage door
|
|||
What is on my shopping list
|
||||
```
|
||||
|
||||
To get started creating your own configuration, follow [their tutorial](https://snips.gitbook.io/documentation/console) to create an assistant and download the training data. You can also add the HomeAssistant Skill to your assistant to enable the built-in intents, and add or create your own intents to do more complex tasks.
|
||||
To get started creating your own configuration, follow [their tutorial](https://github.com/snipsco/snips-platform-documentation/wiki/2.-Create-an-assistant-using-an-existing-bundle) to create an assistant and download the training data. You can add the HomeAssistant bundle to your assistant to enable the built-in intents, and add or create your own intents to do more complex tasks.
|
||||
|
||||
Now install and activate the [Samba](/addons/samba/) add-on so you can upload your training data. Connect to the "share" Samba share and copy your assistant over. Name the file `assistant.zip` or whatever you have configured in the configuration options.
|
||||
Now install and activate the [Samba] add-on so you can upload your training data. Connect to the "share" Samba share and copy your training data over. Name the file `assistant.zip`.
|
||||
|
||||
Now it's time to start Snips for the first time. You can configure the microphone and sound card using the Add-on interface. Now start the add-on.
|
||||
Now it's time to start Snips for the first time. When the Snips add-on starts, it will output your audio devices. If you are using a USB mic and the raspberry pi output, you won't need to change anything:
|
||||
|
||||
### {% linkable_title Add-On configuration %}
|
||||
```text
|
||||
**** List of PLAYBACK Hardware Devices ****
|
||||
card 0: ALSA [bcm2835 ALSA], device 0: bcm2835 ALSA [bcm2835 ALSA]
|
||||
Subdevices: 8/8
|
||||
Subdevice #0: subdevice #0
|
||||
Subdevice #1: subdevice #1
|
||||
Subdevice #2: subdevice #2
|
||||
Subdevice #3: subdevice #3
|
||||
Subdevice #4: subdevice #4
|
||||
Subdevice #5: subdevice #5
|
||||
Subdevice #6: subdevice #6
|
||||
Subdevice #7: subdevice #7
|
||||
card 0: ALSA [bcm2835 ALSA], device 1: bcm2835 ALSA [bcm2835 IEC958/HDMI]
|
||||
Subdevices: 1/1
|
||||
Subdevice #0: subdevice #0
|
||||
```
|
||||
|
||||
You need to use this information to point the add-on at the right speakers and microphone. The information describes different cards and devices. On a Raspberry Pi 3, card 0 - device 0 is the built-in headset port, card 0 - device 1 is the HDMI port. In the example above, the USB microphone showed up as card 1 - device 0.
|
||||
|
||||
Find the microphone and speakers that you want to use and note down their device and card number. We will need that to configure the add-on options `mic` (microphone to use) and `speaker` (speaker to use). The format for these options is `<card #>,<device #>`. Change the configuration options and click save.
|
||||
|
||||
Now start the add-on.
|
||||
|
||||
### Add-On configuration
|
||||
|
||||
```json
|
||||
{
|
||||
"mic": "1,0",
|
||||
"speaker": "1,0",
|
||||
"assistant": "assistant.zip",
|
||||
"mqtt_bridge": {
|
||||
"active": true,
|
||||
"host": "172.17.0.1",
|
||||
|
|
@ -42,76 +68,23 @@ Now it's time to start Snips for the first time. You can configure the microphon
|
|||
"user": "",
|
||||
"password": ""
|
||||
},
|
||||
"assistant": "assistant.zip",
|
||||
"language": "en",
|
||||
"custom_tts": false,
|
||||
"tts_platform": "amazon_polly"
|
||||
}
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **mqtt_bridge**: Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on.
|
||||
- **assistant**: The name of your custom assistant in `/share`. If no assistant is found then a default assistant will be used.
|
||||
- **language**: Language. This is used to select the default custom assistant, Currently `en`, `de` and `fr` are supported.
|
||||
- **custom_tts**: Whether to use a TTS provider from Home Assistant for a variety of voices.
|
||||
- **tts_platform**: Which TTS platform to use.
|
||||
- **mqtt_bridge** : Snips uses MQTT to communicate and defaults to their own broker. Use this config option to bridge their broker to your the Mosquitto add-on.
|
||||
- **mic**: This is the hardware address of your microphone. Look at the Snips output if you are using different hardware.
|
||||
|
||||
### {% linkable_title Home Assistant configuration %}
|
||||
|
||||
A simple configuration just requires this. Consult [Snips.ai component](/components/snips/) for more options.
|
||||
Use the Home Assistant [Snips.ai component][comp] to integrate the add-on into Home Assistant.
|
||||
|
||||
```yaml
|
||||
snips:
|
||||
```
|
||||
|
||||
### {% linkable_title Home Assistant configuration %}
|
||||
|
||||
There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support.
|
||||
|
||||
### {% linkable_title Examples %}
|
||||
|
||||
So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the `/share` folder on your HassIO installation using the Samba addon.
|
||||
|
||||
Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksky/] and put the `api_key` in your `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
|
||||
```
|
||||
Next add this to your `configuration.yaml` file to reference a new `intent_script` component. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up.
|
||||
|
||||
```yaml
|
||||
intent_script: !include intent_script.yaml
|
||||
```
|
||||
|
||||
Finally, create this `intent_script.yaml` file in your configuration directory.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
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 %}
|
||||
|
||||
Now just restart HassIO and ask it what the weather is like.
|
||||
|
||||
[Snips.ai]: https://snips.ai/
|
||||
[their tutorial]: https://github.com/snipsco/snips-platform-documentation/wiki/2.-Create-an-assistant-using-an-existing-bundle
|
||||
|
||||
[Samba]: /addons/samba/
|
||||
[comp]: /components/snips/
|
||||
|
|
|
|||
|
|
@ -27,9 +27,7 @@ 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.
|
||||
|
||||
<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>
|
||||
**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.
|
||||
|
||||
### {% linkable_title Attributes %}
|
||||
|
||||
|
|
|
|||
|
|
@ -14,12 +14,11 @@ 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 platform supports the following Hive products:
|
||||
|
||||
- Hive Window or Door Sensor
|
||||
- Hive Motion Sensor
|
||||
The Hive sensor component supports the following Hive products:
|
||||
- **Hive Window or Door Sensor**
|
||||
- **Hive Motion Sensor**
|
||||
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
|
|
@ -11,8 +11,6 @@ footer: true
|
|||
|
||||
Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality.
|
||||
|
||||
### {% linkable_title Device Class %}
|
||||
|
||||
The way these sensors are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for binary sensors:
|
||||
|
||||
- **None**: Generic on/off. This is the default and doesn't need to be set.
|
||||
|
|
@ -41,8 +39,3 @@ The way these sensors are displayed in the frontend can be modified in the [cust
|
|||
- **window**: `On` means open, `Off` means closed
|
||||
|
||||
For analog sensors please check the [component overview](/components/#sensor).
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/binary_sensor_classes_icons.png' />
|
||||
Example of various device classes icons in `On` and `Off` state.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -15,12 +15,10 @@ ha_iot_class: "Local Push"
|
|||
|
||||
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
binary_sensor:
|
||||
- platform: modbus
|
||||
coils:
|
||||
|
|
@ -41,7 +39,7 @@ Configuration variables:
|
|||
|
||||
It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation.
|
||||
|
||||
## {% linkable_title Full example %}
|
||||
### {% linkable_title Full example %}
|
||||
|
||||
Example a sensor with a 10 seconds scan interval:
|
||||
|
||||
|
|
|
|||
|
|
@ -133,7 +133,7 @@ The configuration will look like the example below:
|
|||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
binary_sensor:
|
||||
- platform: mqtt
|
||||
name: Bathroom
|
||||
|
|
|
|||
|
|
@ -15,12 +15,10 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector).
|
||||
|
||||
|
||||
|
||||
To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
binary_sensor:
|
||||
- platform: pilight
|
||||
variable: 'state'
|
||||
|
|
|
|||
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
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,8 +16,6 @@ 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:
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ ha_category: Hub
|
|||
ha_release: 0.64
|
||||
---
|
||||
|
||||
This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work.
|
||||
This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account and a Connected Drive enabled vehicle for this to work.
|
||||
|
||||
For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github.
|
||||
|
||||
|
|
@ -52,38 +52,6 @@ bmw_connected_drive:
|
|||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Services %}
|
||||
|
||||
The `bmw_connected_drive` component offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN in the attributes of the device tracker for the vehicle. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
|
||||
|
||||
Using these services will impact the state of your vehicle. So use these services with care!
|
||||
|
||||
### {% linkable_title Locking and unlocking %}
|
||||
|
||||
The vehicle can be locked and unlocked via the lock component that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation.
|
||||
|
||||
### {% linkable_title Air condition %}
|
||||
|
||||
The air condition of the vehicle can be activated with the service `bmw_connected_drive.activate_air_conditioning`.
|
||||
|
||||
What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage).
|
||||
|
||||
The vehicle is identified via the parameter `vin`.
|
||||
|
||||
### {% linkable_title Sound the horn %}
|
||||
|
||||
The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. Use this feature responsibly, as it might annoy your neighbors. The vehicle is identified via the parameter `vin`.
|
||||
|
||||
### {% linkable_title Flash the lights %}
|
||||
|
||||
The service `bmw_connected_drive.light_flash' flashes the lights of the vehicle. The vehicle is identified via the parameter `vin`.
|
||||
|
||||
### {% linkable_title Update the state %}
|
||||
|
||||
The service `bmw_connected_drive.update_state`fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles.
|
||||
|
||||
This service does not require any attributes.
|
||||
|
||||
## {% linkable_title Disclaimer %}
|
||||
|
||||
This software is not affiliated with or endorsed by BMW Group.
|
||||
|
|
|
|||
|
|
@ -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 Configuration %}
|
||||
### {% linkable_title Basic Setup %}
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -95,8 +95,7 @@ Variables:
|
|||
- **track**: (*Required*): Should we create a sensor `True` or ignore it `False`?
|
||||
- **search**: (*Optional*): If set will only trigger for matched events.
|
||||
- **offset**: (*Optional*): A set of characters that precede a number in the event title for designating a pre-trigger state change on the sensor. (Default: `!!`)
|
||||
- **ignore_availablilty**: (*Optional*): Should we respect `free`/`busy` flags? (Defaults to `true`)
|
||||
|
||||
|
||||
From this we will end up with the binary sensors `calendar.test_unimportant` and `calendar.test_important` which will toggle themselves on/off based on events on the same calendar that match the search value set for each. You'll also have a sensor `calendar.test_everything` that will not filter events out and always show the next event available.
|
||||
|
||||
But what if you only wanted it to toggle based on all events? Just leave out the *search* parameter.
|
||||
|
|
|
|||
|
|
@ -111,7 +111,7 @@ Home Assistant does its best to determine what task in each project is "most" im
|
|||
|
||||
Todoist also comes with access to a service, `calendar.todoist_new_task`. This service can be used to create a new Todoist task. You can specify labels and a project, or you can leave them blank, and the task will go to your "Inbox" project.
|
||||
|
||||
Here are two example JSON payloads resulting in the same task:
|
||||
Here's an example JSON payload:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -123,17 +123,6 @@ Here are two example JSON payloads resulting in the same task:
|
|||
}
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"content": "Pick up the mail",
|
||||
"project": "Errands",
|
||||
"labels":"Homework,School",
|
||||
"priority":3,
|
||||
"due_date_string":"tomorrow at 14:00",
|
||||
"due_date_lang":"en"
|
||||
}
|
||||
```
|
||||
|
||||
- **content** (*Required*): The name of the task you want to create.
|
||||
|
||||
- **project** (*Optional*): The project to put the task in.
|
||||
|
|
@ -142,11 +131,6 @@ Here are two example JSON payloads resulting in the same task:
|
|||
|
||||
- **priority** (*Optional*): The priority of the task, from 1-4. Again, 1 means least important, and 4 means most important.
|
||||
|
||||
- **due_date_string** (*Optional*): When the task should be due, in [natural language](https://support.todoist.com/hc/en-us/articles/205325931-Dates-and-Times). Mutually exclusive with `due_date`
|
||||
|
||||
- **due_date_lang** (*Optional*): When `due_date_string` is set, it is posisble to set the language.
|
||||
Valid languages are: `en`, `da`, `pl`, `zh`, `ko`, `de`, `pt`, `ja`, `it`, `fr`, `sv`, `ru`, `es`, `nl`
|
||||
|
||||
- **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format. Mutually exclusive with `due_date_string`.
|
||||
- **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format.
|
||||
|
||||
Note that there's (currently) no way to mark tasks as done through Home Assistant; task names do not necessarily have to be unique, so you could find yourself in a situation where you close the wrong task.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Local File"
|
||||
description: "Instructions how to use Local File as a Camera within Home Assistant."
|
||||
description: "Instructions on 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 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.
|
||||
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 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.
|
||||
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.
|
||||
|
||||
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -31,11 +31,7 @@ Configuration variables:
|
|||
- **file_path** (*Required*): File to serve as the camera.
|
||||
- **name** (*Optional*): Name of the camera
|
||||
|
||||
### {% linkable_title Service `camera.local_file_update_file_path` %}
|
||||
<p class='note'>
|
||||
The given `file_path` must be an existing file because the camera platform setup make a readable check on it.
|
||||
</p>
|
||||
|
||||
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. |
|
||||
|
|
|
|||
|
|
@ -1,28 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Fritzbox Thermostat"
|
||||
description: "Instructions on how to integrate the AVM Fritzbox thermostat."
|
||||
date: 2017-11-12 17:10
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: avm.png
|
||||
ha_category: Climate
|
||||
ha_release: 0.68
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
<p class='note'>
|
||||
To get AVM fritzbox thermostat follow the instructions for the general [Fritzbox](/components/fritzbox/).
|
||||
</p>
|
||||
|
||||
### {% linkable_title Attributes %}
|
||||
|
||||
The are several attributes that can be useful for automations and templates.
|
||||
|
||||
| Attribute | Description |
|
||||
| --------- | ----------- |
|
||||
| `device_locked` | The state of the key lock at the device.
|
||||
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
|
||||
| `low_battery` | The low battery state indication.
|
||||
|
|
@ -14,15 +14,13 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
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**.
|
||||
|
||||
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**.
|
||||
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 platform supports the following Hive products:
|
||||
|
||||
- Hive Active Heating
|
||||
- Hive Multizone
|
||||
- Hot water control
|
||||
The Hive climate component supports the following Hive products:
|
||||
- **Hive Active Heating**
|
||||
- **Hive Multizone**
|
||||
- **Hot water control**
|
||||
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
|
|
@ -1,71 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Modbus"
|
||||
description: "Instructions how to integrate a Modbus thermostat within Home Assistant."
|
||||
date: 2018-01-29 9:35
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: modbus.png
|
||||
ha_category: Thermostat
|
||||
ha_release: 0.68
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `modbus` thermostat allows you to use a sensor value (current temperature) and target value (target temperature) from [Modbus](http://www.modbus.org/) registers.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Modbus thermostat in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
climate:
|
||||
- platform: modbus
|
||||
name: Watlow F4T
|
||||
slave: 1
|
||||
target_temp_register: 2782
|
||||
current_temp_register: 27586
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Name of the device
|
||||
required: true
|
||||
type: string
|
||||
slave:
|
||||
description: The number of the slave (Optional for tcp and upd Modbus, use 1).
|
||||
required: true
|
||||
type: int
|
||||
target_temp_register:
|
||||
description: Register number for target temperature (Setpoint).
|
||||
required: true
|
||||
type: int
|
||||
current_temp_register:
|
||||
description: Register number for current temperature (Process value).
|
||||
required: true
|
||||
type: int
|
||||
data_type:
|
||||
description: Response representation (int, uint, float, custom). If float selected, value will converted to IEEE 754 floating point format.
|
||||
required: false
|
||||
type: string
|
||||
default: float
|
||||
count:
|
||||
description: Number of registers to read.
|
||||
required: false
|
||||
type: int
|
||||
precision:
|
||||
description: Number of valid decimals.
|
||||
required: false
|
||||
type: int
|
||||
default: 0
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
### {% linkable_title Services %}
|
||||
|
||||
| Service | Description |
|
||||
| ------- | ----------- |
|
||||
| set_temperature | Set Temperature. Requires `value` to be passed in, which is the desired target temperature. `value` should be in the same type as `data_type` |
|
||||
|
|
@ -87,9 +87,3 @@ intent_script:
|
|||
- "{% if color == 'blue' %}255{% else %}0{% endif %}"
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
#### {% linkable_title Service `conversation.process` %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|------------------------|----------|--------------------------------------------------|
|
||||
| `text` | yes | Transcribed text |
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ The `gogogate2` cover platform lets you control Gogogate2-Enabled garage doors t
|
|||
To use your Gogogate2 cover in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
cover:
|
||||
- platform: gogogate2
|
||||
username: email@email.com
|
||||
|
|
|
|||
|
|
@ -15,8 +15,6 @@ ha_release: 0.18
|
|||
|
||||
The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter, or a garage door).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
The device state (`open` or `closed`) will be updated only after a new message is published on `state_topic` matching `state_open` or `state_closed`. If these messages are published with the `retain` flag set, the cover will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`.
|
||||
|
||||
There is an attribute that stores the relative position of the device, where 0 means the device is `closed` and all other intermediate positions means the device is `open`.
|
||||
|
|
@ -166,7 +164,7 @@ In this section you will find some real life examples of how to use this platfor
|
|||
The example below shows a full configuration for a cover without tilt.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
cover:
|
||||
- platform: mqtt
|
||||
name: "MQTT Cover"
|
||||
|
|
@ -190,9 +188,8 @@ cover:
|
|||
|
||||
The example below shows a full configuration for a cover.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
cover:
|
||||
- platform: mqtt
|
||||
name: "MQTT Cover"
|
||||
|
|
@ -209,7 +206,7 @@ cover:
|
|||
payload_available: "online"
|
||||
payload_not_available: "offline"
|
||||
optimistic: false
|
||||
value_template: '{{ value.x }}'
|
||||
value_template: '{% raw %}{{ value.x }}{% endraw %}'
|
||||
tilt_command_topic: 'home-assistant/cover/tilt'
|
||||
tilt_status_topic: 'home-assistant/cover/tilt-state'
|
||||
tilt_min: 0
|
||||
|
|
@ -217,7 +214,6 @@ cover:
|
|||
tilt_closed_value: 70
|
||||
tilt_opened_value: 180
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages. This allows you to operate your cover manually:
|
||||
|
||||
|
|
|
|||
|
|
@ -15,12 +15,10 @@ ha_iot_class: Cloud Polling
|
|||
|
||||
The `myq` cover platform lets you control MyQ-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your MyQ Device mobile app.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your MyQ cover in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
cover:
|
||||
- platform: myq
|
||||
username: YOUR_USERNAME
|
||||
|
|
|
|||
|
|
@ -13,20 +13,24 @@ ha_release: 0.13
|
|||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
Wink Cover garage door functionality varies on the product. Home Assistant can open, close, and view state of GoControl/Linear openers. For Chamberlain MyQ-enabled openers, Home Assistant is limited to show current state (open or closed) only using this Wink cover. This restriction was imposed by Chamberlain for third party control. Wink suggests that MyQ customers should contact Chamberlain directly to inquire about expanding permissions.
|
||||
Wink cover/garage door functionality depends on the product you're using. With GoControl/Linear Home Assistant can open, close, and view state. Chamberlain is currently limited to view only. Meaning Home Assistant will only show the current state of the door and control has been disabled (by Chamberlain). If you have a Chamberlain garage door, and would like to control it via Home Assistant, please contact Chamberlain and request that they re-enabled third-party control.
|
||||
|
||||
The [MyQ Cover](/components/cover.myq/) does provide full functionality for opening and closing Chamberlain MyQ-enabled garage doors. If installed along with the Wink Component, a duplicate garage door entity may exist. In that case, the semi-functional Wink garage door entity can be hidden via customize.yaml.
|
||||
The following quote is from Wink.
|
||||
|
||||
> As part of our agreement with Chamberlain, third-party access to control Chamberlain garage doors has been restricted. Please contact Chamberlain directly to inquire about permissions.
|
||||
|
||||
The requirement is that you have setup [Wink](/components/wink/).
|
||||
|
||||
|
||||
### {% linkable_title Supported cover devices %}
|
||||
|
||||
- Bali window treatments
|
||||
- Lutron shades
|
||||
- Pella motorized blinds and shades
|
||||
- GoControl garage door opener
|
||||
- Chamberlain MyQ (Limited functionality) (No Wink hub required)
|
||||
- Chamberlain (Limited functionality) (No Wink hub required)
|
||||
|
||||
<p class='note'>
|
||||
The above devices are confirmed to work, but others may work as well.
|
||||
</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -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 `.config_entries.json` 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 `deconz.conf` inside the `.homeassistant` folder.
|
||||
|
||||
You can add the following to your configuration.yaml file if you are not using the `discovery:` component:
|
||||
|
||||
|
|
|
|||
|
|
@ -15,8 +15,6 @@ ha_release: "0.10"
|
|||
|
||||
The `fritz` platform offers presence detection by looking at connected devices to a [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) based router.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
<p class='note warning'>
|
||||
It might be necessary to install additional packages: <code>$ sudo apt-get install libxslt-dev libxml2-dev python3-lxml</code>
|
||||
If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command <code> pip install lxml</code>; be patient this will take a while.</p>
|
||||
|
|
|
|||
|
|
@ -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: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
platform: google_maps
|
||||
username: example@gmail.com
|
||||
password: password
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
|
|
|
|||
|
|
@ -33,11 +33,9 @@ Configuration variables:
|
|||
- **username** (*Required*): The username for the iCloud account.
|
||||
- **password** (*Required*): The password for your given username.
|
||||
- **account_name** (*Optional*): The friendly name for the account_name. If this isn't given, it will use the account_name of the username (so the part before the `@` in the email address).
|
||||
- **max_interval** (*Optional*): Maximum interval in minutes between subsequent location upates. This tracker uses dynamic intervals for requesting location updates. When iphone is stationary, interval will eventually be set to `max_interval` to save battery. When iphone starts moving again interval will be dynamically updated to 1 min. Note that updating interval to 1 min might be delayed by maximum `max_interval` minutes. Default is 30 min. Minimum value is 1 min.
|
||||
- **gps_accuracy_threshold** (*Optional*): iCloud location updates come with some gps_accuracy varying from 10 to 5000 meters. This setting defines the accuracy threshold in meters for a location update. Less accurate updates will be discarded by this tracker. This allows more precise location monitoring and fewer false positive zone changes. Default is 1000 meters.
|
||||
|
||||
<p class='note warning'>
|
||||
Low `max_interval` may cause battery drainage as it wakes up your device to get the current location.
|
||||
This may cause battery drainage as it wakes up your device to get the current location.
|
||||
</p>
|
||||
|
||||
<p class='note warning'>
|
||||
|
|
@ -50,7 +48,7 @@ To disable the drainage of the battery, a dynamic interval is being used for eac
|
|||
2 Factor Authentication is the improved version of 2 Steps Authentication, this is still not supported by the pyicloud library. Therefore it's not possible to use it with the device_tracker yet.
|
||||
|
||||
4 services are available for this component:
|
||||
- **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iphone location. Can be used in automations when manual location update is needed, e.g. to check if anyone is home when door's been opened.
|
||||
- **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional.
|
||||
- **icloud_lost_iphone**: This service will play the Lost iPhone sound on a certain iDevice. The `account_name` and `device_name` are optional.
|
||||
- **icloud_set_interval**: This service will change the dynamic interval of an iDevice. The `account_name` and `device_name` are optional. If `interval` is used in the service_data, the iDevice will be updated with that new interval. That interval will be fixed until the iDevice changes zone or if this service is called again. If `interval` isn't used in the service_data, the interval for that iDevice will revert back to its default dynamic interval based on its current zone, its distance towards home and its battery level.
|
||||
- **icloud_reset_account**: This service can be used to reset an iCloud account. This is helpful when not all devices are being found by the component or if you have added a new iDevice to your account. The `account_name` is optional.
|
||||
|
|
|
|||
|
|
@ -40,10 +40,6 @@ 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,21 +11,8 @@ 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.
|
||||
|
||||
### {% 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 %}
|
||||
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.
|
||||
|
||||
After you configure access to the Meraki CMX API, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -37,13 +24,14 @@ 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 %}
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ ha_iot_class: "Local Polling"
|
|||
ha_release: pre 0.7
|
||||
---
|
||||
|
||||
|
||||
This platform allows you to detect presence by looking at connected devices to a [Netgear](http://www.netgear.com/) device.
|
||||
|
||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
|
|
@ -28,18 +29,10 @@ device_tracker:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **url** (*Optional*): The base URL, e.g., `http://routerlogin.com:5000` for example. If not provided `host` and `port` are used. If none provided autodetection of the URL will be used.
|
||||
- **host** (*Optional*): The IP address of your router, e.g., `192.168.1.1`.
|
||||
- **port** (*Optional*): The port your router communicates with.
|
||||
- **username** (*Optional*): The username of a user with administrative privileges. If not provided `admin` will be used.
|
||||
- **host** (*Optional*): The IP address of your router, e.g., `192.168.1.1`. If not provided `routerlogin.net` will be used.
|
||||
- **username** (*Optional*): The username of an user with administrative privileges. If not provided `admin` will be used.
|
||||
- **port** (*Optional*): The port your router communicates with (defaults to `5000`, but `80` is also known to be used on some models).
|
||||
- **password** (*Required*): The password for your given admin account.
|
||||
- **devices** (*Optional*): If provided only specified devices will be reported. Can be MAC address or the device name as reported in the Netgear UI.
|
||||
- **exclude** (*Optional*): Devices to exclude from the scan.
|
||||
- **accesspoints** (*Optional*): Also track devices on the specified APs. Only supports MAC address.
|
||||
|
||||
When `accesspoints` is specified an extra device will be reported for each device connected to the APs specified here, as `MY-LAPTOP on RBS40`. `Router` will be reported as AP name for the main AP. Only tested with Orbi.
|
||||
|
||||
The use of `devices` or `exclude` is recommended when using `accesspoints` to avoid having a lot of entries.
|
||||
|
||||
List of models that are known to use port 80:
|
||||
- Nighthawk X4S - AC2600 (R7800)
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Open OwnTracks and go to Connection preferences:
|
|||
- Mode: Select **Private HTTP**
|
||||
- Host: [Home Assistant URL]:[port]/api/owntracks/[your name]/[device name]
|
||||
- Identification: Turn **Authentication** on, username `homeassistant` and password is your API password that you use to login to Home Assistant.
|
||||
|
||||
|
||||
Host example: If I host my Home Assistant at `https://example.duckdns.org`, my name is Paulus and my phone is a Pixel I would set the host to be `https://example.duckdns.org/api/owntracks/paulus/pixel`. This will result in an entity with an ID of `device_tracker.paulus_pixel`. You can pick any name for the user and the device.
|
||||
|
||||
Since the battery data is available as an attribute of the device tracker entity, it can be tracked with a [`template` sensor](/components/sensor.template/).
|
||||
|
|
@ -47,6 +47,17 @@ sensor:
|
|||
friendly_name: Pixel of Paulus
|
||||
unit_of_measurement: "%"
|
||||
value_template: '{{ states.device_tracker.paulus_pixel.attributes.battery|int }}'
|
||||
device_class: battery
|
||||
icon_template: >-
|
||||
{% set battery_level = states.device_tracker.paulus_pixel.attributes.battery|default(0)|int %}
|
||||
{% set battery_round = (battery_level / 10) |int * 10 %}
|
||||
{% if battery_round >= 100 %}
|
||||
mdi:battery
|
||||
{% elif battery_round > 0 %}
|
||||
mdi:battery-{{ battery_round }}
|
||||
{% else %}
|
||||
mdi:battery-alert
|
||||
{% endif %}
|
||||
entity_id:
|
||||
- device_tracker.paulus_pixel
|
||||
```
|
||||
{% endraw %}
|
||||
|
|
|
|||
|
|
@ -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;` or `document.getElementById("pcPassword").value;`, depending on your firmware version.
|
||||
5. Type ```document.getElementById("login-password").value;```.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ comments: false
|
|||
sharing: true
|
||||
footer: true
|
||||
logo: xiaomi.png
|
||||
ha_category: Presence Detection
|
||||
ha_category: Sensor
|
||||
ha_version: 0.67
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ for state in hass.states():
|
|||
To enable `discovery` in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
discoverable:
|
||||
expose_password: yes
|
||||
```
|
||||
|
|
|
|||
|
|
@ -23,7 +23,6 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi
|
|||
* [DirecTV receivers](/components/media_player.directv/)
|
||||
* [Frontier Silicon internet radios](/components/media_player.frontier_silicon/)
|
||||
* [Google Cast](/components/media_player.cast/)
|
||||
* [HomeKit](/components/homekit_controller/)
|
||||
* [IKEA Trådfri (Tradfri)](/components/tradfri/)
|
||||
* [Linn / Openhome](/components/media_player.openhome/)
|
||||
* [Logitech Harmony Hub](/components/remote.harmony/)
|
||||
|
|
@ -51,8 +50,6 @@ discovery:
|
|||
ignore:
|
||||
- sonos
|
||||
- samsung_tv
|
||||
enable:
|
||||
- homekit
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
|
@ -88,12 +85,6 @@ Valid values for ignore are:
|
|||
* `yamaha`: Yamaha media player
|
||||
* `yeelight`: Yeelight Sunflower bulb
|
||||
|
||||
- **enable** (*Optional*): A list of platforms not enabled by default that `discovery` should discover.
|
||||
|
||||
Valid values for enable are:
|
||||
|
||||
* `homekit`: HomeKit accessories
|
||||
|
||||
<p class='note'>
|
||||
Home Assistant must be on the same network as the devices for uPnP discovery to work.
|
||||
If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network.
|
||||
|
|
|
|||
|
|
@ -26,9 +26,9 @@ dyson:
|
|||
password: YOUR_DYSON_PASSWORD
|
||||
language: YOUR_DYSON_ACCOUNT_LANGUGAGE
|
||||
devices:
|
||||
- device_id: DEVICE_ID_1 # eg. Serial number: XXX-XX-XXXXXXXX
|
||||
- device_id: DEVICE_ID_1 # eg: Pure Cool Link device
|
||||
device_ip: DEVICE_ID_1
|
||||
- device_id: DEVICE_ID_2
|
||||
- device_id: DEVICE_ID_2 # eg: Eye 360 robot vacuum
|
||||
device_ip: DEVICE_ID_2
|
||||
```
|
||||
|
||||
|
|
@ -38,7 +38,7 @@ Configuration variables:
|
|||
- **password** (*Required*): Dyson account password.
|
||||
- **language** (*Required*): Dyson account language country code. Known working codes: `FR`, `NL`, `GB`, `AU`. But others codes should work.
|
||||
- **devices** (*Optional*): List of devices.
|
||||
- **device_id** (*Required*): Device ID. The Serial Number of the device. Found in the mobiles applications device settings page.
|
||||
- **device_id** (*Required*): Device ID. Available in the mobiles applications (*Settings* page).
|
||||
- **device_ip** (*Required*): Device IP address.
|
||||
|
||||
`devices` list is optional but you'll have to provide them if discovery is not working (warnings in the logs and the devices are not available in Home Assistant web interface).
|
||||
|
|
|
|||
|
|
@ -1,54 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Eufy"
|
||||
description: "Instructions on how to integrate Eufy devices into Home Assistant."
|
||||
date: 2018-04-09 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: eufy.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.68
|
||||
---
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
eufy:
|
||||
username: testuser@domain
|
||||
password: p4ssw0rd
|
||||
```
|
||||
|
||||
where username and password are the ones configured in the EufyHome app. Alternately, Eufy devices that are not discoverable can be statically configured.
|
||||
|
||||
```yaml
|
||||
eufy:
|
||||
devices:
|
||||
- address: 192.168.1.10
|
||||
access_token: 1234567890abcdef
|
||||
type: T1012
|
||||
name: Smart Light
|
||||
- address: 192.168.1.11
|
||||
access_token: abcdef1234567890
|
||||
type: T1201
|
||||
name: Smart Switch
|
||||
```
|
||||
|
||||
access_token can be obtained by running:
|
||||
|
||||
```
|
||||
curl -H "Content-Type: application/json" -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' https://home-api.eufylife.com/v1/user/email/login | jq
|
||||
```
|
||||
|
||||
replacing USERNAME and PASSWORD with the Eufy username and password. This will give an access_token. Then run:
|
||||
|
||||
```
|
||||
curl -H token:TOKEN -H category:Home https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq
|
||||
```
|
||||
|
||||
replacing TOKEN with the access_token from the previous command. This will provide the local_code for each device.
|
||||
|
||||
|
|
@ -15,8 +15,6 @@ ha_iot_class: depends
|
|||
|
||||
The `mqtt` fan platform lets you control your MQTT enabled fans.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be `false` / `off`.
|
||||
|
||||
When a `state_topic` is not available, the fan will work in optimistic mode. In this mode, the fan will immediately change state after every command. Otherwise, the fan will wait for state confirmation from the device (message from `state_topic`).
|
||||
|
|
@ -26,7 +24,7 @@ Optimistic mode can be forced even if a `state_topic` is available. Try to enabl
|
|||
To enable MQTT fans in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
fan:
|
||||
- platform: mqtt
|
||||
command_topic: "bedroom_fan/on/set"
|
||||
|
|
@ -157,7 +155,7 @@ In this section you find some real life examples of how to use this fan.
|
|||
The example below shows a full configuration for a MQTT fan.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
fan:
|
||||
- platform: mqtt
|
||||
name: "Bedroom Fan"
|
||||
|
|
|
|||
|
|
@ -1,96 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Template Fan"
|
||||
description: "Instructions how to setup the Template fans within Home Assistant."
|
||||
date: 2018-05-03 09:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: Fan
|
||||
ha_release: 0.69
|
||||
ha_iot_class: "Local Push"
|
||||
logo: home-assistant.png
|
||||
---
|
||||
|
||||
The `template` platform creates fans that combine components and provides the
|
||||
ability to run scripts or invoke services for each of the turn_on, turn_off, set_speed, and
|
||||
set_oscillating commands of a fan.
|
||||
|
||||
To enable Template Fans in your installation, add the following to your
|
||||
`configuration.yaml` file:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
fan:
|
||||
- platform: template
|
||||
fans:
|
||||
bedroom_fan:
|
||||
friendly_name: "Bedroom fan"
|
||||
value_template: "{{ states('input_boolean.state') }}"
|
||||
speed_template: "{{ states('input_select.speed') }}"
|
||||
oscillating_template: "{{ states('input_select.osc') }}"
|
||||
turn_on:
|
||||
service: script.fan_on
|
||||
turn_off:
|
||||
service: script.fan_off
|
||||
set_speed:
|
||||
service: script.fan_speed
|
||||
data_template:
|
||||
speed: "{{ speed }}"
|
||||
set_oscillating:
|
||||
service: script.fan_oscillating
|
||||
data_template:
|
||||
oscillating: "{{ oscillating }}"
|
||||
speeds:
|
||||
- '1'
|
||||
- '2'
|
||||
- '3'
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{% configuration %}
|
||||
fans:
|
||||
description: List of your fans.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
friendly_name:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
value_template:
|
||||
description: "Defines a template to get the state of the fan. Valid value: 'on'/'off'"
|
||||
required: true
|
||||
type: template
|
||||
speed_template:
|
||||
description: Defines a template to get the speed of the fan.
|
||||
required: false
|
||||
type: template
|
||||
oscillating_template:
|
||||
description: "Defines a template to get the osc state of the fan. Valid value: True/False"
|
||||
required: false
|
||||
type: template
|
||||
turn_on:
|
||||
description: Defines an action to run when the fan is turned on.
|
||||
required: true
|
||||
type: action
|
||||
turn_off:
|
||||
description: Defines an action to run when the fan is turned off.
|
||||
required: true
|
||||
type: action
|
||||
set_speed:
|
||||
description: Defines an action to run when the fan is given a speed command.
|
||||
required: false
|
||||
type: action
|
||||
set_oscillating:
|
||||
description: Defines an action to run when the fan is given a osc state command.
|
||||
required: false
|
||||
type: action
|
||||
speeds:
|
||||
description: List of speeds the fan is capable of running at.
|
||||
required: false
|
||||
type: string list
|
||||
default: ['low', 'medium', 'high']
|
||||
{% endconfiguration %}
|
||||
|
|
@ -13,14 +13,13 @@ 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 within configured folders. 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. The monitored `event_type` are:
|
||||
* `created`
|
||||
* `deleted`
|
||||
* `modified`
|
||||
* `moved`
|
||||
|
||||
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.
|
||||
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:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,55 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Fritzbox"
|
||||
description: "Instructions on how to integrate the AVM Fritzbox Smart Home components."
|
||||
date: 2018-02-18 17:10
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: avm.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.68
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
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://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 %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
fritzbox:
|
||||
devices:
|
||||
- host: fritz.box
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
devices:
|
||||
description: A list of Fritzbox devices.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
host:
|
||||
description: The hostname or IP address of the Fritzbox.
|
||||
required: true
|
||||
type: optional
|
||||
username:
|
||||
description: The username for Smart Home access.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password of the user.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
|
@ -13,10 +13,6 @@ featured: true
|
|||
ha_release: 0.56
|
||||
---
|
||||
|
||||
<p class='note'>
|
||||
Use [Home Assistant Cloud](/cloud/) to integrate with Google Assistant without any effort.
|
||||
</p>
|
||||
|
||||
The `google_assistant` component allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device.
|
||||
|
||||
The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up.
|
||||
|
|
@ -25,8 +21,6 @@ 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
|
||||
|
|
@ -108,7 +102,7 @@ entity_config:
|
|||
required: false
|
||||
type: list
|
||||
room:
|
||||
description: Allows for associating this device to a Room in Google Assistant.
|
||||
description: Allows for associating this device to a Room in Google Assistant. This is currently non-functional, but will be enabled in the near future.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
|
@ -140,7 +134,7 @@ If you're not using Linux, you can use sites such as [this one](https://www.brow
|
|||
1. Create a new project in the [developer console](https://console.actions.google.com/).
|
||||
a. Add/Import project
|
||||
b. Click on `BUILD` on the `Smart home` card
|
||||
c. Type in your home assistant url: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / ip address and the port under which your Home Assistant is reachable.
|
||||
c. Type in your home assistant url: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / ip address and the port under which your Home Assistant is reachable.
|
||||
d. Click `Done`. Then click on `Overview`, which will lead you to the app details screen.
|
||||
2. You'll need to fill out most of the information on that page, but none of it really matters since you won't be addressing the App directly, only through the Smart Home functionality built into Google Assistant.
|
||||
3. The final item on that page `Account linking` is required for your app to interact with Home Assistant.
|
||||
|
|
|
|||
|
|
@ -14,13 +14,11 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
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 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, add the following to your `configuration.yaml` file:
|
||||
To add your Hive devices into your Home Assistant installation, using the default scan_interval, add the following to your 'configuration.yaml' file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
|
|||
|
|
@ -12,10 +12,10 @@ ha_release: 0.64
|
|||
logo: apple-homekit.png
|
||||
---
|
||||
|
||||
The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they can be controlled from Apple's `Home` app and `Siri`. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later.
|
||||
The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they could be controlled from Apple `Home` app and `Siri`. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later.
|
||||
|
||||
<p class="note warning">
|
||||
It might be necessary to install an additional package:
|
||||
It might be necessary to install an additional package:
|
||||
`$ sudo apt-get install libavahi-compat-libdnssd-dev`
|
||||
</p>
|
||||
|
||||
|
|
@ -39,10 +39,6 @@ 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
|
||||
|
|
@ -81,9 +77,6 @@ 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 %}
|
||||
|
||||
|
|
@ -94,7 +87,7 @@ To enable the `HomeKit` component in Home Assistant, add the following to your c
|
|||
homekit:
|
||||
```
|
||||
|
||||
After Home Assistant has started, the entities specified by the filter are exposed to `HomeKit` if they are [supported](#supported-components). To add them:
|
||||
After Home Assistant has started, the entities specified by the filter are exposed to `HomeKit` if the are [supported](#supported-components). To add them:
|
||||
1. Open the Home Assistant frontend. A new card will display the `pin code`.
|
||||
1. Open the `Home` app.
|
||||
2. Choose `Add Accessory`, than select `Don't Have a Code or Can't Scan?` and enter the `pin code`.
|
||||
|
|
@ -114,7 +107,7 @@ Currently this component uses the `entity_id` to generate a unique `accessory id
|
|||
|
||||
### {% linkable_title Persistence Storage %}
|
||||
|
||||
Unfortunately `HomeKit` doesn't support any kind of persistent storage - only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not setup, their config will be deleted. (State unknown or similar will not cause any issues.)
|
||||
Unfortunately `HomeKit` doesn't support any kind of persistence storage, only the configuration for accessories that are added to the `Home Assistant Bridge` are kept. To avoid problems it is recommended to use an automation to always start `HomeKit` with at least the same entities setup. If for some reason some entities are not setup, their config will be deleted. (State unknown or similar will not cause any issues.)
|
||||
|
||||
A common situation might be if you decide to disable parts of the configuration for testing. Please make sure to disable `auto start` and `turn off` the `Start HomeKit` automation (if you have one).
|
||||
|
||||
|
|
@ -123,7 +116,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`.
|
||||
|
||||
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:
|
||||
This can be automated using an `automation`.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
|
|
@ -141,8 +134,6 @@ 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
|
||||
|
|
@ -163,7 +154,7 @@ automation:
|
|||
|
||||
## {% linkable_title Configure Filter %}
|
||||
|
||||
By default no entity will be excluded. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
|
||||
By default no entity will be excluded. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
|
|
@ -193,7 +184,7 @@ Filters are applied as follows:
|
|||
- if both include and exclude domains specified, the exclude domains are ignored
|
||||
* Neither include or exclude domain specified
|
||||
- if entity is included, pass (as #2 above)
|
||||
- if entity include and exclude, the entity exclude is ignored
|
||||
- if entity include and exclude, the entity exclude is ignored
|
||||
|
||||
|
||||
## {% linkable_title Supported Components %}
|
||||
|
|
@ -203,20 +194,11 @@ The following components are currently supported:
|
|||
| Component | Type Name | Description |
|
||||
| --------- | --------- | ----------- |
|
||||
| alarm_control_panel | SecuritySystem | All security systems. |
|
||||
| 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`. |
|
||||
| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. |
|
||||
| sensor | AirQualitySensor | All sensors that have `pm25` as part of their `entity_id` or `pm25` as their `device_class` |
|
||||
| sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` |
|
||||
| sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` |
|
||||
| light | Light | Support for `on / off`, `brightness`, `color_temp` and `rgb_color`. |
|
||||
| sensor | TemperatureSensor | All sensors that have `Celsius` and `Fahrenheit` as their `unit_of_measurement`. |
|
||||
| sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` |
|
||||
| switch / remote / input_boolean / script | Switch | All represented as switches. |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,36 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "HomeKit controller support"
|
||||
description: "Instructions how to integrate your HomeKit devices within Home Assistant."
|
||||
date: 2018-03-19 21:04
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: apple-homekit.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.68
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This component should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit.
|
||||
|
||||
<p class="note warning">
|
||||
You may need additional packages to support the HomeKit Python module:
|
||||
`$ sudo apt-get install libgmp-dev libmpfr-dev libmpc-dev`
|
||||
</p>
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [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:
|
||||
|
||||
```yaml
|
||||
discovery:
|
||||
enable:
|
||||
- homekit
|
||||
```
|
||||
|
||||
For each detected HomeKit accessory, a configuration prompt will appear in the web front end. Use this to provide the HomeKit PIN. Note that HomeKit accessories can only be paired to one device at once. If your device is currently paired with Siri, you will need to reset it in order to pair it with Home Assistant. Once Home Assistant is configured to work with the device, you can export it back to Siri with the [`HomeKit`](/components/homekit/) component.
|
||||
|
|
@ -63,52 +63,26 @@ a responder or a controller.
|
|||
|
||||
In order for any two Insteon devices to talk with one another, they must be
|
||||
linked. For an overview of device linking please read the Insteon page on
|
||||
[understanding linking]. The Insteon PLM module supports All-Linking through
|
||||
[Development Tools] service calls. The following services are available:
|
||||
|
||||
In order for any two Insteon devices to talk with one another, they must be
|
||||
linked. For an overview of device linking, please read the Insteon page on
|
||||
[understanding linking]. The Insteon PLM module supports All-Linking through
|
||||
[Development Tools] service calls. The following services are available:
|
||||
- **insteon_plm.add_all_link**: Tells the Insteon Modem (IM) start All-Linking
|
||||
mode. Once the IM is in All-Linking mode, press the link button on the device
|
||||
to complete All-Linking.
|
||||
- **insteon_plm.delete_all_link**: Tells the Insteon Modem (IM) to remove an
|
||||
All-Link record from the All-Link Database of the IM and a device. Once the IM
|
||||
is set to delete the link, press the link button on the corresponding device
|
||||
to complete the process.
|
||||
- **insteon_plm.load_all_link_database**: Load the All-Link Database for a
|
||||
device. WARNING - Loading a device All-Link database is very time consuming
|
||||
and inconsistent. This may take a LONG time and may need to be repeated to
|
||||
obtain all records.
|
||||
- **insteon_plm.print_all_link_database**: Print the All-Link Database for a
|
||||
device. Requires that the All-Link Database is loaded into memory.
|
||||
- **insteon_plm.print_im_all_link_database**: Print the All-Link Database for
|
||||
the INSTEON Modem (IM).
|
||||
|
||||
If you are looking for more advanced options, you can use the
|
||||
[insteonplm_interactive] command line tool that is distributed with the
|
||||
[insteonplm] Python module. Please see the documentation on the [insteonplm]
|
||||
GitHub site. Alternatively, you can download [HouseLinc] which runs on any
|
||||
Windows PC, or you can use [Insteon Terminal] which is open source and runs
|
||||
on most platforms. SmartHome no longer supports HouseLinc, but it still
|
||||
works. Insteon Terminal is a very useful tool but please read the disclaimers
|
||||
carefully, they are important.
|
||||
[understanding linking]. Currently Insteon PLM does not support software
|
||||
linking of devices. If you need software that can link your devices (if you
|
||||
are using a USB Stick PLM for example), you can download [HouseLinc] which runs
|
||||
on any Windows PC, or you can use [Insteon Terminal] which is open source and
|
||||
runs on most platforms. HouseLinc is no longer supported by SmartHome but it
|
||||
still works. Insteon Terminal is a very useful tool but please read the
|
||||
disclaimers carefully, they are important.
|
||||
|
||||
[understanding linking]: http://www.insteon.com/support-knowledgebase/2015/1/28/understanding-linking
|
||||
[Development Tools]: https://www.home-assistant.io/docs/tools/dev-tools/
|
||||
[HouseLinc]: https://www.smarthome.com/houselinc.html
|
||||
[Insteon Terminal]: https://github.com/pfrommerd/insteon-terminal
|
||||
[insteonplm_interactive]: https://github.com/nugget/python-insteonplm#command-line-interface
|
||||
|
||||
### {% linkable_title Customization %}
|
||||
|
||||
The only configuration item that is absolutely necessary is the port so that
|
||||
Home Assistant can connect to the PLM. This will expose all the supported
|
||||
INSTEON devices which exist in the modem’s ALL-Link database. However, devices
|
||||
will only be shown by their INSTEON hex address (e.g., “1A.2B.3C”) which can
|
||||
be a bit unwieldy. As you link and unlink devices using the ‘Set’ buttons,
|
||||
they’ll be added and removed from Home Assistant automatically.
|
||||
The only configuration item that is absolutely necessary is the port so that
|
||||
Home Assistant can connect to the PLM. This will expose all the supported INSTEON
|
||||
devices which exist in the modem's ALL-Link database. However, devices will
|
||||
only be shown by their INSTEON hex address (e.g., "1A.2B.3C") which can be a bit
|
||||
unwieldy. As you link and unlink devices using the 'Set' buttons, they'll be
|
||||
added and removed from Home Assistant automatically.
|
||||
|
||||
You can use the normal Home Assistant [device customization] section of your
|
||||
configuration to assign friendly names and special icons to your devices. This
|
||||
|
|
@ -149,9 +123,7 @@ insteon_plm:
|
|||
cat: 0x10
|
||||
subcat: 0x11
|
||||
```
|
||||
|
||||
### {% linkable_title What NOT to do %}
|
||||
|
||||
Insteon PLM is a top level component and device discovery will identify
|
||||
the Home Assistant platform the device belongs in. As such, do not
|
||||
declare Insteon devices in other platforms. For example, this configuration
|
||||
|
|
@ -162,3 +134,4 @@ light:
|
|||
- platform: insteon_plm
|
||||
address: 1a2b3c
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -15,12 +15,10 @@ ha_release: 0.47
|
|||
|
||||
The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable the platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
juicenet:
|
||||
access_token: ACCESS_TOKEN
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Eufy Lights"
|
||||
description: "Instructions on how to integrate Eufy LED lights into Home Assistant."
|
||||
date: 2018-04-09 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: eufy.png
|
||||
ha_category: Light
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.68
|
||||
---
|
||||
|
||||
The `eufy` platform allows you to control your [Eufy](http://www.eufylife.com) lights from within Home Assistant.
|
||||
|
||||
They will be automatically discovered if the [Eufy](/components/eufy/) component is enabled.
|
||||
|
||||
|
|
@ -14,13 +14,12 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
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 integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light.
|
||||
|
||||
The platform supports the following Hive products:
|
||||
|
||||
- Hive Active Light Dimmable
|
||||
- Hive Active Light Cool to Warm White
|
||||
- Hive Active Light Color Changing
|
||||
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**
|
||||
|
||||
|
||||
<p class='note'>
|
||||
|
|
|
|||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "HomeKit Light"
|
||||
description: "Instructions how to setup HomeKit lights within Home Assistant."
|
||||
date: 2017-03-19 21:08
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: apple-homekit.png
|
||||
ha_category: Light
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.68
|
||||
---
|
||||
|
||||
To get your HomeKit lights working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/).
|
||||
|
|
@ -11,14 +11,13 @@ ha_category: Light
|
|||
ha_release: 0.51
|
||||
---
|
||||
|
||||
The `mochad` light platform lets you control an X10 enabled dimmer/light device.
|
||||
|
||||
|
||||
The `mochad` light platform lets you control an X10 enabled dimmer/light
|
||||
device.
|
||||
|
||||
To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
light:
|
||||
- platform: mochad
|
||||
devices:
|
||||
|
|
|
|||
|
|
@ -14,8 +14,6 @@ ha_iot_class: depends
|
|||
|
||||
The `mqtt` light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`.
|
||||
|
||||
When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from `state_topic`).
|
||||
|
|
@ -23,7 +21,7 @@ When a state topic is not available, the light will work in optimistic mode. In
|
|||
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
light:
|
||||
- platform: mqtt
|
||||
command_topic: "office/rgb1/light/switch"
|
||||
|
|
@ -196,7 +194,6 @@ payload_not_available:
|
|||
| RGB Color | ✔ | ✔ | ✔ |
|
||||
| Transitions | ✘ | ✔ | ✔ |
|
||||
| XY Color | ✔ | ✔ | ✘ |
|
||||
| HS Color | ✘ | ✔ | ✘ |
|
||||
| White Value | ✔ | ✔ | ✔ |
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
|
@ -209,7 +206,7 @@ To enable a light with brightness and RGB support in your installation, add the
|
|||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
light:
|
||||
- platform: mqtt
|
||||
name: "Office Light RGB"
|
||||
|
|
@ -234,7 +231,7 @@ light:
|
|||
To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
light:
|
||||
- platform: mqtt
|
||||
name: "Office light"
|
||||
|
|
@ -253,7 +250,7 @@ light:
|
|||
To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
light:
|
||||
- platform: mqtt
|
||||
name: "Brightness light"
|
||||
|
|
|
|||
|
|
@ -23,12 +23,10 @@ This platform supports on/off, brightness, RGB colors, XY colors, color temperat
|
|||
"color_temp": 155,
|
||||
"color": {
|
||||
"r": 255,
|
||||
"g": 180,
|
||||
"b": 200,
|
||||
"x": 0.406,
|
||||
"y": 0.301,
|
||||
"h": 344.0,
|
||||
"s": 29.412
|
||||
"g": 255,
|
||||
"b": 255,
|
||||
"x": 0.123,
|
||||
"y": 0.123
|
||||
},
|
||||
"effect": "colorloop",
|
||||
"state": "ON",
|
||||
|
|
@ -128,11 +126,6 @@ xy:
|
|||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
hs:
|
||||
description: Flag that defines if the light supports HS colors.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
availability_topic:
|
||||
description: The MQTT topic subscribed to receive availability (online/offline) updates.
|
||||
required: false
|
||||
|
|
@ -154,7 +147,7 @@ payload_not_available:
|
|||
</p>
|
||||
|
||||
<p class='note warning'>
|
||||
RGB, XY and HSV can not be used at the same time in `state_topic` messages. Make sure that only one of the color models is in the "color" section of the state MQTT payload.
|
||||
XY and RGB can not be used at the same time. If both are provided, XY overrides RGB.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Comparison of light MQTT platforms %}
|
||||
|
|
@ -168,7 +161,6 @@ payload_not_available:
|
|||
| RGB Color | ✔ | ✔ | ✔ |
|
||||
| Transitions | ✘ | ✔ | ✔ |
|
||||
| XY Color | ✔ | ✔ | ✘ |
|
||||
| HS Color | ✘ | ✔ | ✘ |
|
||||
| White Value | ✔ | ✔ | ✔ |
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
|
@ -223,32 +215,7 @@ Home Assistant will then convert its 8bit value in the message to and from the d
|
|||
```json
|
||||
{
|
||||
"brightness": 4095,
|
||||
"state": "ON"
|
||||
}
|
||||
```
|
||||
|
||||
### {% linkable_title HS Color %}
|
||||
|
||||
To use a light with hue+saturation as the color model, set `hs` to `true` in the platform configuration:
|
||||
|
||||
```yaml
|
||||
light:
|
||||
- platform: mqtt_json
|
||||
name: mqtt_json_hs_light
|
||||
state_topic: "home/light"
|
||||
command_topic: "home/light/set"
|
||||
hs: True
|
||||
```
|
||||
|
||||
Home Assistant expects the hue values to be in the range 0 to 360 and the saturation values to be scaled from 0 to 100. For example, the following is a blue color shade:
|
||||
|
||||
```json
|
||||
{
|
||||
"state": "ON",
|
||||
"color": {
|
||||
"h": 24.0,
|
||||
"s": 100.0
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -132,7 +132,6 @@ payload_not_available:
|
|||
| RGB Color | ✔ | ✔ | ✔ |
|
||||
| Transitions | ✘ | ✔ | ✔ |
|
||||
| XY Color | ✔ | ✔ | ✘ |
|
||||
| HS Color | ✘ | ✔ | ✘ |
|
||||
| White Value | ✔ | ✔ | ✔ |
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Optimistic mode can be forced, even if state topic is available. Try to enable i
|
|||
To enable MQTT locks in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
lock:
|
||||
- platform: mqtt
|
||||
command_topic: "home/frontdoor/set"
|
||||
|
|
|
|||
|
|
@ -1,136 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Matrix"
|
||||
description: "Matrix chatbot support"
|
||||
date: 2018-03-25 18:50
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: matrix.png
|
||||
ha_category: Hub
|
||||
ha_version: 0.69
|
||||
---
|
||||
|
||||
This component allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
matrix:
|
||||
homeserver: https://matrix.org
|
||||
username: "@my_matrix_user:matrix.org"
|
||||
password: supersecurepassword
|
||||
rooms:
|
||||
- "#hasstest:matrix.org"
|
||||
commands:
|
||||
- word: my_command
|
||||
name: my_command
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: "The matrix username that home assistant should use to log in. *Note*: You must specify a full matrix ID here, including the homeserver domain, e.g. '@my_matrix_bot:matrix.org'. Please note also that the '@' character has a special meaning in YAML, so this must always be given in quotes."
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your Matrix account.
|
||||
required: true
|
||||
type: string
|
||||
homeserver:
|
||||
description: "The full URL for your homeserver. If you use the defauls matrix.org homeserver, this is 'https://matrix.org'."
|
||||
required: true
|
||||
type: string
|
||||
verify_ssl:
|
||||
description: Verify the homeservers certificate.
|
||||
required: false
|
||||
type: string
|
||||
default: true
|
||||
rooms:
|
||||
description: "The list of rooms that the bot should join and listen for commands (see below) in. While you can limit the list of rooms that a certain command applies to on a per-command basis (see below), you must still list all rooms here that commands should be received in. Rooms can be given either by their internal ID (e.g., '!cURbafjkfsMDVwdRDQ:matrix.org') or any of their aliases (e.g., '#matrix:matrix.org')."
|
||||
required: false
|
||||
type: [string]
|
||||
default: empty
|
||||
commands:
|
||||
description: "A list of commands that the bot should listen for. If a command is triggered (via its *word* or *expression*, see below), an event is fired that you can handle using automations. Every command consists of these possible configuration options:"
|
||||
required: false
|
||||
type: map
|
||||
default: empty
|
||||
keys:
|
||||
word:
|
||||
description: "Specifies a word that the bot should listen for. If you specify 'my_command' here, the bot will react to any message starting with '!my_command'."
|
||||
required: false
|
||||
type: string
|
||||
expression:
|
||||
description: "Specifies a regular expression (in python regexp syntax) that the bot should listen to. The bot will react to any message that matches the regular expression."
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
description: "The name of the command. This will be an attribute of the event that is fired when this command triggers."
|
||||
required: true
|
||||
type: string
|
||||
rooms:
|
||||
description: "A list of rooms that the bot should listen for this command in. If this is not given, the *rooms* list from the main config is used. Please note that every room in this list must also be in the main *room* config."
|
||||
required: false
|
||||
type: [string]
|
||||
default: empty
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Event Data %}
|
||||
|
||||
If a command is triggered, a `matrix_command` event is fired. The event contains the name of the command in the `name` field. If the command is a word command that has no name set, the `name` field contains the word instead.
|
||||
|
||||
If the command is a word command, the `data` field contains a list of the command's arguments, i.e., everything that stood behind the word, split at spaces. If the command is an expression command, the `data` field contains the [group dictionary](https://docs.python.org/3.6/library/re.html?highlight=re#re.match.groupdict) of the regular expression that matched the message.
|
||||
|
||||
### {% linkable_title Comprehensive Configuration Example %}
|
||||
|
||||
This example also uses the [matrix `notify` platform](/components/notify.matrix/).
|
||||
|
||||
```yaml
|
||||
# The Matrix component
|
||||
matrix:
|
||||
homeserver: https://matrix.org
|
||||
username: "@my_matrix_user:matrix.org"
|
||||
password: supersecurepassword
|
||||
rooms:
|
||||
- "#hasstest:matrix.org"
|
||||
- "#someothertest:matrix.org"
|
||||
commands:
|
||||
- word: testword
|
||||
rooms:
|
||||
- "#someothertest:matrix.org"
|
||||
- expression: "My name is (?P<name>.*)"
|
||||
name: introduction
|
||||
|
||||
notify:
|
||||
- name: matrix_notify
|
||||
platform: matrix
|
||||
default_room: "#hasstest:matrix.org"
|
||||
|
||||
automation:
|
||||
- alias: 'React to !testword'
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: matrix_command
|
||||
event_data:
|
||||
command: testword
|
||||
action:
|
||||
service: notify.matrix_notify
|
||||
data:
|
||||
message: 'It looks like you wrote !testword'
|
||||
- alias: 'React to an introduction'
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: matrix_command
|
||||
event_data:
|
||||
command: introduction
|
||||
action:
|
||||
service: notify.matrix_notify
|
||||
data_template:
|
||||
message: "Hello {{trigger.event.data.name}}"
|
||||
```
|
||||
|
||||
This configuration will:
|
||||
- Listen for "!testword" in the room "#someothertest:matrix.org" (and *only*) there. If such a message is encountered, it will answer with "It looks like you wrote !testword" into the "#hasstest:matrix.org" channel.
|
||||
- Listen in both rooms for any message matching "My name is <any string>" and answer with "Hello <the string>" into "#hasstest:matrix.org".
|
||||
|
|
@ -25,42 +25,13 @@ Supported Devices:
|
|||
- MAX! Window Sensor (tested)
|
||||
- MAX! Wall Thermostat (tested)
|
||||
|
||||
### {% linkable_title One Gateway %}
|
||||
|
||||
A `maxcube` section must be present in the `configuration.yaml` file and contain the following options as required:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
maxcube:
|
||||
gateways:
|
||||
- host: 192.168.0.20
|
||||
host: 192.168.0.20
|
||||
```
|
||||
|
||||
### {% linkable_title Multiple Gateways %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
maxcube:
|
||||
gateways:
|
||||
- host: 192.168.0.20
|
||||
port: 62910
|
||||
- host: 192.168.0.21
|
||||
port: 62910
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address of the eQ-3 MAX! Cube to use.
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: The UDP port number.
|
||||
required: false
|
||||
type: int
|
||||
default: 62910
|
||||
scan_interval:
|
||||
description: The update interval in seconds
|
||||
required: false
|
||||
type: int
|
||||
default: 300
|
||||
{% endconfiguration %}
|
||||
Configuration variables:
|
||||
- **host** (*Required*): The IP address of the eQ-3 MAX! Cube to use.
|
||||
- **port** (*Optional*): The UDP port number. Defaults to `62910`.
|
||||
|
|
|
|||
|
|
@ -1,70 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Blackbird 8x8 HDMI Matrix Switch"
|
||||
description: "Instructions on how to integrate Monoprice Blackbird 4k 8x8 HDBaseT Matrix Switch into Home Assistant."
|
||||
date: 2018-03-29 16:35
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: monoprice.svg
|
||||
ha_category: Media Player
|
||||
ha_release: 0.68
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `blackbird` platform allows you to control [Monoprice Blackbird Matrix Switch](https://www.monoprice.com/product?p_id=21819) using a serial connection.
|
||||
|
||||
To add a Blackbird device to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
- platform: blackbird
|
||||
type: serial
|
||||
port: /dev/ttyUSB0
|
||||
zones:
|
||||
1:
|
||||
name: Living Room
|
||||
sources:
|
||||
3:
|
||||
name: BluRay
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
description: The type of device connection - serial or socket
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: The serial port to which Blackbird matrix switch is connected. Either port or host must be defined.
|
||||
required: optional
|
||||
type: string
|
||||
host:
|
||||
description: The IP address of the Blackbird matrix switch. Either port or host must be defined.
|
||||
required: optional
|
||||
type: string
|
||||
zones:
|
||||
description: This is the list of zones available. Valid zones are 1,2,3,4,5,6,7,8. Each zone must have a name assigned to it.
|
||||
required: true
|
||||
type: int
|
||||
keys:
|
||||
name:
|
||||
description: The name of the zone.
|
||||
sources:
|
||||
description: The list of sources available. Valid source numbers are 1,2,3,4,5,6,7,8. Each source number corresponds to the input number on the Blackbird matrix switch. Similar to zones, each source must have a name assigned to it.
|
||||
required: true
|
||||
type: int
|
||||
keys:
|
||||
name:
|
||||
description: The name of the source.
|
||||
{% endconfiguration%}
|
||||
|
||||
### {% linkable_title Service `BLACKBIRD_SETALLZONES` %}
|
||||
|
||||
Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | String that points at an `entity_id` of a zone.
|
||||
| `source` | no | String of source name to activate.
|
||||
|
|
@ -17,9 +17,7 @@ ha_iot_class: "Local Push"
|
|||
|
||||
The `kodi` platform allows you to control a [Kodi](http://kodi.tv/) multimedia system from Home Assistant.
|
||||
|
||||
The preferred way to set up the Kodi platform is by enabling the [discovery component](https://www.home-assistant.io/components/discovery/) which requires enabled [web interface](https://kodi.wiki/view/Web_interface) on your Kodi installation.
|
||||
|
||||
In case the discovery does not work, or you need specific configuration variables, you can add the following to your `configuration.yaml` file:
|
||||
To add Kodi to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
|
|||
|
|
@ -16,8 +16,6 @@ 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
|
||||
|
|
@ -30,28 +28,11 @@ media_player:
|
|||
pc: 'HTPC'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: IP address of the device. Example:`192.168.1.2`. If not specified, the platform will load any discovered receivers.
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
description: Name of the device. (*Required if host is specified*)
|
||||
required: false
|
||||
type: string
|
||||
max_volume:
|
||||
description: Maximum volume. Defaults to 80.
|
||||
required: false
|
||||
type: number
|
||||
sources:
|
||||
description: A list of mappings from source to source name. Valid sources can be found below. A default list will be used if no source mapping is specified.
|
||||
required: false
|
||||
type: list
|
||||
zone2:
|
||||
description: Enables control for the receiver's second zone.
|
||||
required: false
|
||||
type: bool
|
||||
{% endconfiguration %}
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Optional*): IP address of the device. Example:`192.168.1.2`. If not specified, the platform will load any discovered receivers.
|
||||
- **name** (*Required if host is specified*): Name of the device.
|
||||
- **sources** (*Optional*): A list of mappings from source to source name. Valid sources can be found below. A default list will be used if no source mapping is specified.
|
||||
|
||||
List of source names:
|
||||
|
||||
|
|
|
|||
|
|
@ -50,7 +50,6 @@ Currently known supported models:
|
|||
- EH5600
|
||||
- F6400AF
|
||||
- F6400
|
||||
- F8000BF
|
||||
- D6505
|
||||
- D6300SF
|
||||
- U6000 (port must be set to 8001)
|
||||
|
|
|
|||
|
|
@ -12,11 +12,12 @@ ha_category: Media Player
|
|||
ha_release: 0.41
|
||||
---
|
||||
|
||||
The `Volumio` platform allows you to control a [Volumio](http://volumio.org) media player from Home Assistant.
|
||||
The `Volumio` platform allows you to control a [Volumio](http://volumio.org) media player
|
||||
from Home Assistant.
|
||||
|
||||
The preferred way to set up the Volumio platform is by enabling the [discovery component](/components/discovery/).
|
||||
|
||||
In case the discovery does not work, or you need specific configuration variables, you can add the following to your `configuration.yaml` file:
|
||||
To add a Volumio player to your installation, add the following to
|
||||
your `configuration.yaml` file.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ A full configuration example will look like the sample below:
|
|||
media_player:
|
||||
- platform: webostv
|
||||
host: 192.168.0.10
|
||||
name: Living Room TV
|
||||
name: Living Room TV
|
||||
timeout: 5
|
||||
filename: webostv.conf
|
||||
turn_on_action:
|
||||
|
|
@ -76,7 +76,7 @@ Avoid using `[ ]` in the `name:` of your device.
|
|||
|
||||
Home Assistant is able to turn on a LG webOS Smart TV if you specify an action, like HDMI-CEC or WakeOnLan.
|
||||
|
||||
Common for webOS 3.0 and higher would be to use WakeOnLan feature.
|
||||
Common for webOS 3.0 and higher would be to use WakeOnLan feature.
|
||||
To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable *LG Connect Apps* feature in *Network* settings of the TV [instructions](http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others) (or *Mobile App* in *General* settings for older models).
|
||||
|
||||
```yaml
|
||||
|
|
@ -93,36 +93,12 @@ media_player:
|
|||
mac: B4:E6:2A:1E:11:0F
|
||||
```
|
||||
|
||||
Any other [actions](/docs/automation/action/) to power on the device can be configured.
|
||||
Any other [actions](/docs/automation/action/) to power on the device can be configured.
|
||||
|
||||
### {% linkable_title Sources %}
|
||||
|
||||
To obtain complete list of available sources currently configured on the TV, once the webOS TV is configured and linked, while its powered on head to the **Developer Tools** > **States**, find your `media_player.<name>` and use the sources listed in `source_list:` remembering to split them per line into your `sources:` configuration.
|
||||
|
||||
### {% linkable_title Change channel through play_media service %}
|
||||
|
||||
The `play_media` service can be used in a script to switch to the specified tv channel.
|
||||
It selects the best matching cannel according to the `media_content_id` parameter:
|
||||
1. Channel number *(i.e. '1' or '6')*
|
||||
2. Exact channel name *(i.e. 'France 2' or 'CNN')*
|
||||
3. Substring in channel name *(i.e. 'BFM' in 'BFM TV')*
|
||||
|
||||
```yaml
|
||||
# Example action entry in script to switch to channel number 1
|
||||
service: media_player.play_media
|
||||
data:
|
||||
entity_id: media_player.lg_webos_smart_tv
|
||||
media_content_id: 1
|
||||
media_content_type: "channel"
|
||||
|
||||
# Example action entry in script to switch to channel including 'TF1' in its name
|
||||
service: media_player.play_media
|
||||
data:
|
||||
entity_id: media_player.lg_webos_smart_tv
|
||||
media_content_id: "TF1"
|
||||
media_content_type: "channel"
|
||||
```
|
||||
|
||||
### {% linkable_title Next/Previous buttons %}
|
||||
|
||||
The behaviour of the next and previsous buttons is different depending on the active source:
|
||||
|
|
|
|||
|
|
@ -13,8 +13,6 @@ ha_release: 0.32
|
|||
|
||||
The `mochad` component is the main component to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
@ -22,20 +20,10 @@ To integrate your Mochad units with Home Assistant, add the following section to
|
|||
mochad:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The host that mochad is running on.
|
||||
required: false
|
||||
type: string
|
||||
default: localhost
|
||||
port:
|
||||
description: The port that mochad is running on.
|
||||
required: false
|
||||
type: int
|
||||
default: 1099
|
||||
{% endconfiguration %}
|
||||
Configuration variables:
|
||||
|
||||
## {% linkable_title Example %}
|
||||
- **host** (*Optional*): The host that mochad is running on. Defaults to `localhost`.
|
||||
- **port** (*Optional*): The port that mochad is running on. Defaults to `1099`.
|
||||
|
||||
A full configuration sample could look like the one below:
|
||||
|
||||
|
|
|
|||
|
|
@ -16,8 +16,6 @@ ha_iot_class: "Local Push"
|
|||
|
||||
[Modbus](http://www.modbus.org/) is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add modbus to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
For a network connection:
|
||||
|
|
|
|||
|
|
@ -15,12 +15,9 @@ ha_release: 0.48
|
|||
|
||||
The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant.
|
||||
|
||||
## {% linkable_title Prerequisites %}
|
||||
|
||||
### Get your ClickSend API Credentials
|
||||
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
|
||||
|
|
@ -31,14 +28,6 @@ notify:
|
|||
username: CLICKSEND_USERNAME
|
||||
api_key: CLICKSEND_API_KEY
|
||||
recipient: PHONE_NO
|
||||
|
||||
# Multiple recipients
|
||||
notify:
|
||||
- platform: clicksend
|
||||
name: ClickSend
|
||||
username: CLICKSEND_USERNAME
|
||||
api_key: CLICKSEND_API_KEY
|
||||
recipient: [PHONE_NO1, PHONE_NO2]
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
|
|
@ -55,9 +44,9 @@ api_key:
|
|||
required: true
|
||||
type: string
|
||||
recipient:
|
||||
description: "A single or multiple phone numbers. This is where you want to send your SMS notification messages, e.g., `09171234567` or `[09171234567, 09177654321]`."
|
||||
description: "Your phone number. This is where you want to send your notification SMS messages, e.g., `09171234567`."
|
||||
required: true
|
||||
type: string or list
|
||||
type: string
|
||||
sender:
|
||||
description: The name or number of the sender.
|
||||
required: false
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ automation:
|
|||
- '+919784516314'
|
||||
```
|
||||
|
||||
You can also send messages to users that do not have stored their phone number on 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:
|
||||
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
|
||||
|
|
@ -96,10 +96,10 @@ if (preg_match('/get my id/', strtolower($message))) {
|
|||
```
|
||||
|
||||
### {% linkable_title Rich messages %}
|
||||
You could also send rich messing (cards, buttons, images, videos, etc). [Info](https://developers.facebook.com/docs/messenger-platform/send-api-reference) to which types of messages and how to build them.
|
||||
You could also send rich messing (cards, buttons, images, videos, etc). [Info](https://developers.facebook.com/docs/messenger-platform/send-api-reference) to which types or messages and how to build them.
|
||||
|
||||
```yaml
|
||||
# Example script with a notification entry with a rich message
|
||||
# Example script with a notification entry with rich message
|
||||
|
||||
script:
|
||||
test_fb_notification:
|
||||
|
|
@ -117,21 +117,3 @@ script:
|
|||
title: Blue
|
||||
payload: DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_BLUE
|
||||
```
|
||||
|
||||
You can now also use Facebook public beta broadcast API to push messages to ALL users who interacted with your chatbot on your page, without having to collect their number. This will scale to thousands of users. Facebook requires that this only be used for non-commercial purposes and they validate every message you send. Also note, your Facebook bot needs to be authorized for "page_subscritions" if you want to make it to all but can be used right away to a selected group of testers of your choice.
|
||||
|
||||
To enable broadcast just use the keyword "BROADCAST" as your target. Only put ONE target BROADCAST as below:
|
||||
|
||||
```yaml
|
||||
- alias: Facebook Broadcast
|
||||
trigger:
|
||||
platform: sun
|
||||
event: sunset
|
||||
action:
|
||||
service: notify.facebook
|
||||
data:
|
||||
message: Some text you want to send
|
||||
target:
|
||||
- BROADCAST
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -17,21 +17,27 @@ The `matrix` platform allows you to deliver notifications from Home Assistant to
|
|||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable Matrix notifications in your installation, you first need to configure
|
||||
the [Matrix component](/components/matrix/). Then, add the following to your `configuration.yaml` file:
|
||||
To enable Matrix notifications in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: matrix
|
||||
homeserver: HOMESERVER
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
default_room: ROOM_ID_OR_ALIAS
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **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`.
|
||||
- **homeserver** (*Required*): The base URL of the homeserver, where the notifier account is registered (e.g., `https://matrix.org`).
|
||||
- **username** (*Required*): The username of the notifying Matrix account.
|
||||
- **password** (*Required*): The password for the given Matrix account.
|
||||
- **default_room** (*Required*): The room all messages will be sent to, when no other target is given.
|
||||
- **verify_ssl** (*Optional*): Verify the homeservers certificate. Defaults to `true`.
|
||||
|
||||
The target room has to be precreated, the room id can be obtained from the rooms settings dialog. Rooms by default have a canonical id of the form `"!<randomid>:homeserver.tld"`, but can also be allocated aliases like `"#roomname:homeserver.tld"`. Make sure to use quotes around the room id or alias to escape special characters (`!`, and `#`) in YAML. The notifying account may need to be invited to the room, depending on the individual rooms policies.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,8 +19,6 @@ This pilight hub connects to the [pilight-daemon](https://manual.pilight.org/pro
|
|||
|
||||
The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g., automation). Additionally a send service is provided to send RF codes.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -60,19 +60,16 @@ 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. Depending on the type, it will be a sensor or binary_sensor. Each sensor is configured with the following parameters:
|
||||
The sensor configuration is a list of sensors. 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 (binary_sensor, up to 6 channels)
|
||||
- door (binary_sensor, single channel)
|
||||
- qwikcord (Channel 1 = CTavg, Channel 2 = CTsum)
|
||||
- imod (up to 6 channels)
|
||||
- door (single channel)
|
||||
- qwikcord (Channel1 = 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:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,71 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "RainMachine"
|
||||
description: "Instructions on how to integrate RainMachine units within Home Assistant."
|
||||
date: 2018-04-25 20:32
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rainmachine.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.69
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `rainmachine` component is the main component to integrate all platforms
|
||||
related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/).
|
||||
|
||||
## {% linkable_title Base Configuration %}
|
||||
|
||||
To connect to your RainMachine device, add the following to your
|
||||
`configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
rainmachine:
|
||||
ip_address: 192.168.1.100
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
To configure switch-related functionality, add configuration options beneath
|
||||
a `switches` key within the `rainmachine` sections of `configuration.yaml`
|
||||
as below:
|
||||
|
||||
```yaml
|
||||
rainmachine:
|
||||
ip_address: 192.168.1.100
|
||||
password: YOUR_PASSWORD
|
||||
switches:
|
||||
# switch configuration options...
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
ip_address:
|
||||
description: the IP address or hostname of your RainMachine unit
|
||||
required: optional
|
||||
type: string
|
||||
password:
|
||||
description: your RainMachine password.
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: the TCP port used by your unit for the REST API
|
||||
required: false
|
||||
type: int
|
||||
default: 8080
|
||||
ssl:
|
||||
description: whether communication with the local device should occur over HTTPS
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
switches:
|
||||
description: switch-related configuration options
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
zone_run_time:
|
||||
description: the default number of seconds that a zone should run when turned on
|
||||
required: false
|
||||
type: int
|
||||
default: 600
|
||||
{% endconfiguration %}
|
||||
|
|
@ -51,7 +51,7 @@ Configuration variables:
|
|||
|
||||
### {% linkable_title Step 2: registering your account %}
|
||||
|
||||
After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Remember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account.
|
||||
After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Rember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account.
|
||||
|
||||
After that click on the "login completed" button. This will tell Home Assistant that you have completed the login process on the Remember The Milk page and Home Assistant should try to register with this account.
|
||||
|
||||
|
|
|
|||
|
|
@ -43,28 +43,3 @@ Entity ids will be sensor.device_name, where device_name is defined in deCONZ. S
|
|||
- Xiaomi Smart Home Wireless Switch
|
||||
- Temperature Sensor
|
||||
- Xiaomi Temperature/Humidity Sensor
|
||||
|
||||
#### {% linkable_title deCONZ Daylight Sensor %}
|
||||
|
||||
The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from https://github.com/mourner/suncalc, on which the deCONZ implementation is based):
|
||||
|
||||
| Sensor State | Description |
|
||||
|--------------|-------------|
|
||||
| sunrise_start | sunrise (top edge of the sun appears on the horizon) |
|
||||
| sunrise_end | sunrise ends (bottom edge of the sun touches the horizon) |
|
||||
| golden_hour_1 | morning golden hour (soft light, the best time for photography) |
|
||||
| solar_noon | solar noon (sun is in the highest position) |
|
||||
| golden_hour_2 | evening golden hour |
|
||||
| sunset_start | sunset starts (bottom edge of the sun touches the horizon) |
|
||||
| sunset_end | sunset (sun disappears below the horizon, evening civil twilight starts) |
|
||||
| dusk | dusk (evening nautical twilight starts) |
|
||||
| nautical_dusk | nautical dusk (evening astronomical twilight starts) |
|
||||
| night_start | night starts (dark enough for astronomical observations) |
|
||||
| nadir | nadir (darkest moment of the night, the sun is in the lowest position) |
|
||||
| night_end | night ends (morning astronomical twilight starts) |
|
||||
| nautical_dawn | nautical dawn (morning nautical twilight starts) |
|
||||
| dawn | dawn (morning nautical twilight ends, morning civil twilight starts) |
|
||||
|
||||
The sensor also has an attribute called "daylight" that has the value `true` when the sensor's state is `golden_hour_1`, `solar_noon`, or `golden_hour_2`, and `false` otherwise.
|
||||
|
||||
These states can be used in automations as a trigger (e.g., trigger when a certain phase of daylight starts or ends) or condition (e.g., trigger only if in a certain phase of daylight).
|
||||
|
|
|
|||
|
|
@ -1,37 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Domain Expiry"
|
||||
description: "Instructions on how to set up Domain expiry sensors within Home Assistant."
|
||||
date: 2018-04-24 14:14
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: home-assistant.png
|
||||
ha_category: System Monitor
|
||||
ha_release: 0.69
|
||||
ha_iot_class: "depends"
|
||||
---
|
||||
|
||||
The `domain_expiry` sensor gets whois information about domain and displays the expiry in days.
|
||||
|
||||
To add the Domain Expiry sensor to your installation, add these options to `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: domain_expiry
|
||||
domain: home-assistant.io
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
domain:
|
||||
description: Domain name to track
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The friendly name for the certificate.
|
||||
required: false
|
||||
type: string
|
||||
default: Domain Expiry
|
||||
{% endconfiguration %}
|
||||
|
|
@ -14,11 +14,10 @@ ha_iot_class: "Local Polling"
|
|||
---
|
||||
|
||||
|
||||
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes.
|
||||
The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers
|
||||
on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing`, or `talking` with the phone numbers involved contained in the state attributes.
|
||||
It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it.
|
||||
|
||||
To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
|
@ -45,7 +44,7 @@ Configuration variables:
|
|||
The example below shows a full configuration for a call monitor with phone book support.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: fritzbox_callmonitor
|
||||
name: Phone
|
||||
|
|
@ -62,9 +61,8 @@ sensor:
|
|||
|
||||
This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry.
|
||||
# Example configuration.yml entry.
|
||||
automation:
|
||||
- alias: "Notify about phone state"
|
||||
trigger:
|
||||
|
|
@ -75,7 +73,7 @@ automation:
|
|||
data:
|
||||
title: "Phone"
|
||||
message: >-
|
||||
{% if is_state("sensor.phone", "idle") %}
|
||||
{% raw %}{% if is_state("sensor.phone", "idle") %}
|
||||
Phone is idle
|
||||
{% elif is_state("sensor.phone", "dialing") %}
|
||||
Calling {{ states.sensor.phone.attributes.to_name }} ({{ states.sensor.phone.attributes.to }})
|
||||
|
|
@ -83,6 +81,5 @@ automation:
|
|||
Incoming call from {{ states.sensor.phone.attributes.from_name }} ({{ states.sensor.phone.attributes.from }})
|
||||
{% else %}
|
||||
Talking to {{ states.sensor.phone.attributes.with_name }} ({{ states.sensor.phone.attributes.with }})
|
||||
{% endif %}
|
||||
{% endif %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
|
|
|||
|
|
@ -15,27 +15,19 @@ ha_release: 0.47
|
|||
|
||||
This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token".
|
||||
|
||||
To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: gitter
|
||||
api_key: YOUR_API_TOKEN
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
api_key:
|
||||
description: Your Gitter.im API token.
|
||||
required: true
|
||||
type: string
|
||||
room:
|
||||
description: Gitter room to monitor.
|
||||
required: false
|
||||
type: string
|
||||
default: home-assistant/home-assistant
|
||||
{% endconfiguration %}
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your Gitter.im API token.
|
||||
- **room** (*Optional*): Gitter room to monitor. Defaults to `home-assistant/home-assistant`
|
||||
|
||||
|
|
|
|||
|
|
@ -14,12 +14,8 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
The `hive` sensor component exposes Hive data as a sensor.
|
||||
The 'hive' sensor component can expose as a sensor the current online status of your Hive Hub.
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -9,21 +9,8 @@ sharing: true
|
|||
footer: true
|
||||
---
|
||||
|
||||
Sensors are gathering information about states and conditions.
|
||||
Sensors are gathering information about states and conditions.
|
||||
|
||||
Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home Assistant directly, are gathered from web services, and, of course, physical devices. Please check the sidebar for a full list of supported sensor platforms.
|
||||
|
||||
### {% linkable_title Device Class %}
|
||||
|
||||
The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for sensors:
|
||||
|
||||
- **None**: Generic sensor. This is the default and doesn't need to be set.
|
||||
- **battery**: Percentage of battery that is left.
|
||||
- **humidity**: Percentage of humidity in the air.
|
||||
- **illuminance**: The current light level in lx or lm.
|
||||
- **temperature**: Temperature in °C or °F.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/sensor_device_classes_icons.png' />
|
||||
Example of various device class icons for sensors.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -1,93 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Xiaomi BLE Temperature and Humidity sensor"
|
||||
description: "Instructions on how to integrate MiTemp BLE temperature and humidity sensor with Home Assistant."
|
||||
date: 2018-04-22 12:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: xiaomi.png
|
||||
ha_category: DIY
|
||||
ha_release: 0.69
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `mitemp_bt` sensor platform allows one to monitor room temperature and humidity. The [Xiaomi Mijia BLE Temperature and Humidity sensor with LCD](https://www.amazon.com/Temperature-Humidity-Xiaomi-Bluetooth-Screen-Remote/dp/B079L6N6PC) is a small Bluetooth Low Energy device that monitors the room temperature and humidity. As only a single BLE device can be polled at the same time, the library employs locking to make sure this is the case.
|
||||
|
||||
# Installation
|
||||
Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system:
|
||||
|
||||
- On [Hass.io](/hassio/installation/): Not yet supported.
|
||||
- On other Linux systems:
|
||||
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
|
||||
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated`
|
||||
- Windows and MacOS are currently not supported by the btlewrap library.
|
||||
|
||||
# Configuration
|
||||
Start a scan to determine the MAC addresses of the sensor:
|
||||
|
||||
```bash
|
||||
$ sudo hcitool lescan
|
||||
LE Scan ...
|
||||
4C:65:A8:D2:31:7F MJ_HT_V1
|
||||
[...]
|
||||
```
|
||||
|
||||
Or if your distribution is using bluetoothctl:
|
||||
|
||||
```bash
|
||||
$ bluetoothctl
|
||||
[bluetooth]# scan on
|
||||
Discovery started
|
||||
[CHG] Controller XX:XX:XX:XX:XX:XX Discovering: yes
|
||||
[NEW] Device 4C:65:A8:D2:31:7F MJ_HT_V1
|
||||
|
||||
```
|
||||
|
||||
|
||||
Check for `MJ_HT_V1` or similar entries, those are your sensor.
|
||||
|
||||
To use your Mi Temperature and Humidity sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: mitemp_bt
|
||||
mac: 'xx:xx:xx:xx:xx:xx'
|
||||
monitored_conditions:
|
||||
- temperature
|
||||
```
|
||||
|
||||
- **mac** (*Required*): The MAC address of your sensor.
|
||||
- **monitored_conditions** array (*Optional*): The parameters that should be monitored (defaults to monitoring all parameters).
|
||||
- **temperature**: Temperature in C at the sensor's location.
|
||||
- **humidity**: Humidity level in % at the sensor's location.
|
||||
- **battery**: Battery details (in %).
|
||||
- **name** (*Optional*): The name displayed in the frontend.
|
||||
- **force_update** (*Optional*): Sends update events even if the value hasn't changed.
|
||||
- **median** (*Optional*): Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last 3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes. If you never have problems with spikes, `median: 1` will work fine.
|
||||
- **timeout** (*Optional*): Define the timeout value in seconds when polling (defaults to 10 if not defined)
|
||||
- **retries** (*Optional*): Define the number of retries when polling (defaults to 2 if not defined)
|
||||
- **cache_value** (*Optional*): Define cache expiration value in seconds (defaults to 1200 if not defined)
|
||||
- **adapter** (*Optional*): Define the Bluetooth adapter to use (defaults to hci0). Run `hciconfig` to get a list of available adapters.
|
||||
|
||||
Note that by default the sensor is only polled once every 5 minutes. This means with the `median: 3` setting will take as least 15 minutes before the sensor will report a value after a Home Assistant restart. Even though the hardware is able to provide new values every second, room temperaturs don't change that quickly.
|
||||
Reducing polling intervals will have a negative effect on the battery life.
|
||||
|
||||
A full configuration example could look like the one below:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: mitemp_bt
|
||||
mac: 'xx:xx:xx:xx:xx:xx'
|
||||
name: Kids Room Temp
|
||||
force_update: false
|
||||
median: 3
|
||||
monitored_conditions:
|
||||
- temperature
|
||||
- humidity
|
||||
- battery
|
||||
```
|
||||
|
||||
|
|
@ -16,12 +16,10 @@ ha_iot_class: "Local Push"
|
|||
|
||||
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
platform: modbus
|
||||
registers:
|
||||
|
|
|
|||
|
|
@ -16,12 +16,10 @@ ha_iot_class: depends
|
|||
|
||||
This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: mqtt
|
||||
state_topic: "home/bedroom/temperature"
|
||||
|
|
@ -82,15 +80,6 @@ json_attributes:
|
|||
description: A list of keys to extract values from a JSON dictionary payload and then set as sensor attributes.
|
||||
reqired: false
|
||||
type: list, string
|
||||
unique_id:
|
||||
description: "An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception."
|
||||
required: false
|
||||
type: string
|
||||
device_class:
|
||||
description: The type/class of the sensor to set the icon in the frontend.
|
||||
required: false
|
||||
type: device_class
|
||||
default: None
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
|
@ -99,17 +88,17 @@ In this section you find some real life examples of how to use this sensor.
|
|||
|
||||
### {% linkable_title JSON attributes configuration %}
|
||||
|
||||
The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the availability topic. Attributes can then be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}.
|
||||
The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the availability topic. Attributes can then be extracted in [Templates](configuration/templating/#attributes); Example to extract data from the sensor below {% raw %}'{{ states.sensor.bs_client_name.attributes.ClientName }}'{% endraw %}.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: mqtt
|
||||
name: "BS RSSI"
|
||||
state_topic: "HUISHS/BunnyShed/NodeHealthJSON"
|
||||
unit_of_measurement: 'dBm'
|
||||
value_template: "{{ value_json.RSSI }}"
|
||||
name: "BS RSSI"
|
||||
unit_of_measurement: "dBm"
|
||||
value_template: '{{ value_json.RSSI }}'
|
||||
availability_topic: "HUISHS/BunnyShed/status"
|
||||
payload_available: "online"
|
||||
payload_not_available: "offline"
|
||||
|
|
@ -125,7 +114,7 @@ sensor:
|
|||
|
||||
### {% linkable_title Get battery level %}
|
||||
|
||||
If you are using the [OwnTracks](/components/device_tracker.owntracks/) and enable the reporting of the battery level then you can use a MQTT sensor to keep track of your battery. A regular MQTT message from OwnTracks looks like this:
|
||||
If you are using the [Owntracks](/components/device_tracker.owntracks/) and enable the reporting of the battery level then you can use a MQTT sensor to keep track of your battery. A regular MQTT message from Owntracks looks like this:
|
||||
|
||||
```bash
|
||||
owntracks/tablet/tablet {"_type":"location","lon":7.21,"t":"u","batt":92,"tst":144995643,"tid":"ta","acc":27,"lat":46.12}
|
||||
|
|
@ -135,13 +124,13 @@ Thus the trick is extracting the battery level from the payload.
|
|||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: mqtt
|
||||
name: "Battery Tablet"
|
||||
state_topic: "owntracks/tablet/tablet"
|
||||
unit_of_measurement: '%'
|
||||
value_template: "{{ value_json.batt }}"
|
||||
name: "Battery Tablet"
|
||||
unit_of_measurement: "%"
|
||||
value_template: '{{ value_json.batt }}'
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
|
@ -161,18 +150,18 @@ Then use this configuration example to extract the data from the payload:
|
|||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: mqtt
|
||||
name: "Temperature"
|
||||
state_topic: "office/sensor1"
|
||||
state_topic: 'office/sensor1'
|
||||
name: 'Temperature'
|
||||
unit_of_measurement: '°C'
|
||||
value_template: "{{ value_json.temperature }}"
|
||||
value_template: '{{ value_json.temperature }}'
|
||||
- platform: mqtt
|
||||
name: "Humidity"
|
||||
state_topic: "office/sensor1"
|
||||
state_topic: 'office/sensor1'
|
||||
name: 'Humidity'
|
||||
unit_of_measurement: '%'
|
||||
value_template: "{{ value_json.humidity }}"
|
||||
value_template: '{{ value_json.humidity }}'
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
|
@ -197,10 +186,10 @@ The configuration will look like the example below:
|
|||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: mqtt
|
||||
name: "Brightness"
|
||||
state_topic: "home/bathroom/analog/brightness"
|
||||
state_topic: 'home/bathroom/analog/brightness'
|
||||
name: Brightness
|
||||
```
|
||||
{% endraw %}
|
||||
|
|
|
|||
|
|
@ -16,8 +16,6 @@ ha_iot_class: depends
|
|||
|
||||
The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
|
|
@ -16,8 +16,6 @@ ha_iot_class: "Cloud Polling"
|
|||
|
||||
The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
@ -44,7 +42,7 @@ Configuration variables:
|
|||
The example below shows a full configuration with three sensors that showcase the various configuration options.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: mvglive
|
||||
nextdeparture:
|
||||
|
|
|
|||
|
|
@ -16,12 +16,10 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: openevse
|
||||
host: IP_ADDRESS
|
||||
|
|
|
|||
|
|
@ -16,12 +16,10 @@ ha_iot_class: depends
|
|||
|
||||
This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your sensor via pilight, make sure it is [supported](https://wiki.pilight.org/doku.php/protocols) and add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: pilight
|
||||
variable: temperature
|
||||
|
|
|
|||
|
|
@ -1,47 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: PostNL Sensor
|
||||
description: "Instructions on how to set up PostNL sensors within Home Assistant."
|
||||
date: 2017-04-22 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: postnl.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.69
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `postnl` platform allows one to track deliveries by [PostNL](https://www.postnl.nl) (Dutch Postal Services). To use this sensor, you need a [PostNL Account](https://jouw.postnl.nl). It is possible to add multiple accounts to your Home Assistant configuration.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
sensors:
|
||||
- platform: postnl
|
||||
username: POSTNL_USERNAME
|
||||
password: POSTNL_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: Sensor name
|
||||
required: false
|
||||
default: "postnl"
|
||||
type: string
|
||||
username:
|
||||
description: Account username of jouw.postnl.nl
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Account password of jouw.postnl.nl
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note warning'>
|
||||
This component is not affiliated with PostNL and retrieves date from the endpoints of the mobile application. Use at your own risk.
|
||||
</p>
|
||||
|
|
@ -16,12 +16,10 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use the `qnap` sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: qnap
|
||||
host: IP_ADDRESS_OF_QNAP_NAS
|
||||
|
|
|
|||
|
|
@ -13,6 +13,6 @@ ha_iot_class: "Local Push"
|
|||
ha_release: "0.67"
|
||||
---
|
||||
|
||||
The `qwikswitch` sensor platform allows you to use your [QwikSwitch](http://www.qwikswitch.co.za/) sensors in Home Assistant.
|
||||
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 platform is configured through the [QwikSwitch component](/components/qwikswitch/).
|
||||
|
|
|
|||
|
|
@ -15,12 +15,10 @@ ha_release: 0.47
|
|||
|
||||
This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Radarr sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: radarr
|
||||
api_key: YOUR_API_KEY
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ Note that this will create the following sensors:
|
|||
- sensor.sabnzbd_left
|
||||
- sensor.sabnzbd_disk
|
||||
- sensor.sabnzbd_disk_free
|
||||
- sensor.sabnzbd_queue_count
|
||||
- sensor.sabnzdb_queue_count
|
||||
```
|
||||
|
||||
As always, you can determine the names of sensors by looking at the dev-state page `< >` in the web interface.
|
||||
|
|
|
|||
|
|
@ -1,54 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Sensirion SHT31 Sensor"
|
||||
description: "Instructions on how to integrate SHT31 sensors within Home Assistant."
|
||||
date: 2018-03-06 19:15
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: DIY
|
||||
ha_release: 0.68
|
||||
logo: sensirion.png
|
||||
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
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
platform: sht31
|
||||
name: Bedroom
|
||||
i2c_address: 0x44
|
||||
monitored_conditions:
|
||||
- temperature
|
||||
- humidity
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name of the sensor. Temperature and Humidity will be added to the name for the sensor name.
|
||||
required: false
|
||||
default: SHT31
|
||||
type: string
|
||||
i2c_address:
|
||||
description: I2C address of the sensor.
|
||||
required: false
|
||||
default: "`0x44`"
|
||||
type: int
|
||||
monitored_conditions:
|
||||
description: Conditions to monitor.
|
||||
required: false
|
||||
default: All conditions
|
||||
type: list
|
||||
keys:
|
||||
temperature:
|
||||
description: The current temperature of the SHT31.
|
||||
humidity:
|
||||
description: The current humidity of the SHT31.
|
||||
{% endconfiguration %}
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Sigfox Sensor"
|
||||
description: "Display messages from Sigfox devices in Home Assistant."
|
||||
date: 2018-04-07 12:10
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: sigfox.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.68
|
||||
---
|
||||
|
||||
[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ( [snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: sigfox
|
||||
api_login: your_api_login
|
||||
api_password: your_api_password
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
api_login:
|
||||
description: Your Sigfox API login.
|
||||
required: true
|
||||
type: string
|
||||
api_password:
|
||||
description: Your Sigfox API password.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name to prepend to the device ID.
|
||||
required: false
|
||||
default: "sigfox"
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following:
|
||||
|
||||
1. Log into [Sigfox backend](https://backend.sigfox.com)
|
||||
1. Select `GROUP`
|
||||
1. Select `API ACCESS`
|
||||
1. Click on `new` and create new access entry
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: Social Blade Sensor
|
||||
description: "Instructions on how to set up Social Blade Sensor within Home Assistant."
|
||||
date: 2018-04-23 08:00
|
||||
sidebar: false
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: socialblade.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.69
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `socialblade` sensor component allows you get updates on a youtube channel using your social blade channel id. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/)
|
||||
|
||||
to get the channel id you can go to [Social Blade Website]( https://socialblade.com/) and search for youtube channel by username, then select the channel and grab the id from the url.
|
||||
The channel id will be the last part of the url :
|
||||
https://socialblade.com/youtube/channel/{channel_id}
|
||||
|
||||
## Example for `configuration.yaml` :
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: socialblade
|
||||
channel_id: YOUR_CHANNEL_NUMBER
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
channel_id:
|
||||
description: channel id number optained from the URL when you access Social Blade web client.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
All the data will be fetch from [Social Blade]( https://socialblade.com/).
|
||||
|
|
@ -16,12 +16,10 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: sonarr
|
||||
api_key: YOUR_API_KEY
|
||||
|
|
|
|||
|
|
@ -16,12 +16,10 @@ ha_iot_class: "Local Polling"
|
|||
|
||||
The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
# Example configuration.yml entry
|
||||
sensor:
|
||||
- platform: synologydsm
|
||||
host: IP_ADDRESS_OF_SYNOLOGY_NAS
|
||||
|
|
@ -35,7 +33,7 @@ sensor:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address of the Synology NAS to monitor.
|
||||
- **host** (*Required*): The IP address of the Synology NAS to monitor
|
||||
- **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5000`.
|
||||
- **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).
|
||||
- **password** (*Required*): The password of the user to connect to the Synology NAS.
|
||||
|
|
|
|||
|
|
@ -69,11 +69,6 @@ sensor:
|
|||
description: Defines a template for the entity picture of the sensor.
|
||||
required: false
|
||||
type: template
|
||||
device_class:
|
||||
description: The type/class of the sensor to set the icon in the frontend.
|
||||
required: false
|
||||
type: device_class
|
||||
default: None
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Considerations %}
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@ 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.
|
||||
|
|
@ -56,8 +54,6 @@ 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
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue