Merge branch 'next' into rc

This commit is contained in:
Franck Nijhof 2019-08-01 08:43:31 +02:00
commit 1709ae8562
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
262 changed files with 2374 additions and 1295 deletions

View File

@ -6,6 +6,9 @@ ENV DEBIAN_FRONTEND=noninteractive
# Use Bash as the default shell
ENV SHELL=/bin/bash
# Set an environment variable to be able to detect we are in dev container
ENV DEVCONTAINER=true
# Locale env vars
ENV \
LANG=en_US.UTF-8 \

1
.gitignore vendored
View File

@ -16,3 +16,4 @@ source/.jekyll-metadata
!.vscode/extensions.json
!.vscode/tasks.json
*.suo
tags*

1
.vscode/cSpell.json vendored
View File

@ -12,6 +12,7 @@
"Denon",
"endconfiguration",
"endraw",
"Etekcity",
"fitbit",
"Flexit",
"geizhals",

View File

@ -89,6 +89,7 @@ end
desc "preview the site in a web browser"
task :preview, :listen do |t, args|
listen_addr = args[:listen] || '127.0.0.1'
listen_addr = '0.0.0.0' unless ENV['DEVCONTAINER'].nil?
raise "### You haven't set anything up yet. First run `rake install` to set up an Octopress theme." unless File.directory?(source_dir)
puts "Starting to watch source with Jekyll and Compass. Starting Rack on port #{server_port}"
system "compass compile --css-dir #{source_dir}/stylesheets" unless File.exist?("#{source_dir}/stylesheets/screen.css")

View File

@ -99,8 +99,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 96
current_patch_version: 0
date_released: 2019-07-17
current_patch_version: 5
date_released: 2019-07-25
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

View File

@ -7,6 +7,11 @@ module Jekyll
'icon' => '/docs/configuration/customizing-devices/#icon',
}
TYPES = [
'action', 'boolean', 'string', 'integer', 'float', 'time', 'template',
'device_class', 'icon', 'map', 'list', 'date', 'datetime'
]
def initialize(tag_name, text, tokens)
super
@component, @platform = text.strip.split('.', 2)
@ -32,7 +37,7 @@ module Jekyll
type.strip!
if TYPE_LINKS.include? type.downcase
url = TYPE_LINKS[type.downcase] % {component: component}
"[%s](%s)" % [type, url]
"<a href=\"%s\">%s</a>" % [url, type]
else
type
end
@ -48,7 +53,7 @@ module Jekyll
end
end
def render_config_vars(vars:, component:, platform:, classes: nil)
def render_config_vars(vars:, component:, platform:, converter:, classes: nil, parent_type: nil)
result = Array.new
result << "<dl class='#{classes}'>"
@ -57,20 +62,56 @@ module Jekyll
markup << "<dt><a class='title-link' name='#{slug(key)}' href='\##{slug(key)}'></a> #{key}</dt>"
markup << "<dd>"
markup << "<p class='desc'>"
if attr.key? 'type'
# Check if the type (or list of types) are valid
if attr['type'].kind_of? Array
attr['type'].each do |type|
raise ArgumentError, "Configuration type '#{type}' for key '#{key}' is not a valid type in the documentation."\
" See: https://developers.home-assistant.io/docs/en/documentation_create_page.html#configuration" unless \
TYPES.include? type
end
else
raise ArgumentError, "Configuration type '#{attr['type']}' for key '#{key}' is not a valid type in the documentation."\
" See: https://developers.home-assistant.io/docs/en/documentation_create_page.html#configuration" unless \
TYPES.include? attr['type']
end
markup << "<span class='type'>(<span class='#{type_class(attr['type'])}'>"
markup << "#{type_link(attr['type'], component: component)}</span>)</span>"
else
# Type is missing, which is required (unless we are in a list or template)
raise ArgumentError, "Configuration key '#{key}' is missing a type definition" \
unless ['list', 'template'].include? parent_type
end
if attr.key? 'required'
# Check if required is a valid value
raise ArgumentError, "Configuration key '#{key}' required field must be specified as: "\
"true, false, inclusive or exclusive."\
unless [true, false, 'inclusive', 'exclusive'].include? attr['required']
markup << "<span class='required'>(#{required_value(attr['required'])})</span>"
end
if attr.key? 'description'
markup << "<span class='description'>#{attr['description']}</span>"
markup << "<span class='description'>#{converter.convert(attr['description'].to_s)}</span>"
else
# Description is missing
raise ArgumentError, "Configuration key '#{key}' is missing a description."
end
markup << "</p>"
if attr.key? 'default'
markup << "<p class='default'>Default value: #{attr['default']}</p>"
if attr.key? 'default' and not attr['default'].to_s.empty?
markup << "<p class='default'>\nDefault value: #{converter.convert(attr['default'].to_s)}</p>"
elsif attr['type'].to_s.include? 'boolean'
# Is the type is a boolean, a default key is required
raise ArgumentError, "Configuration key '#{key}' is a boolean type and"\
" therefore, requires a default."
end
markup << "</dd>"
# Check for nested configuration variables
@ -78,7 +119,8 @@ module Jekyll
markup << "<dd>"
markup << render_config_vars(
vars: attr['keys'], component: component,
platform: platform, classes: 'nested')
platform: platform, converter: converter,
classes: 'nested', parent_type: attr['type'])
markup << "</dd>"
end
@ -100,12 +142,20 @@ module Jekyll
component = Liquid::Template.parse(@component).render context
platform = Liquid::Template.parse(@platform).render context
site = context.registers[:site]
converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
vars = SafeYAML.load(contents)
<<~MARKUP
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
#{render_config_vars(vars: vars, component: component, platform: platform)}
#{render_config_vars(
vars: vars,
component: component,
platform: platform,
converter: converter
)}
</div>
MARKUP
end

View File

@ -23,12 +23,13 @@ featured: true
lets_encrypt:
description: Let's Encrypt is a free, automated, and open certificate authority.
required: true
type: list
type: map
keys:
accept_terms:
description: If you accept the [Let's Encrypt Subscriber Agreement](https://letsencrypt.org/repository/), it will generate and update Let's Encrypt certificates for your DuckDNS domain.
required: true
type: boolean
default: false
token:
description: Your Duck DNS API key, from your DuckDNS account page.
required: true

View File

@ -44,6 +44,7 @@ rf_enable:
description: Enable or disable BidCoS-RF.
required: true
type: boolean
default: false
rf:
description: RF devices.
required: true
@ -61,6 +62,7 @@ wired_enable:
description: Enable or disable BidCoS-Wired.
required: true
type: boolean
default: false
wired:
description: Wired devices.
required: true
@ -82,6 +84,7 @@ hmip_enable:
description: Enable or disable hmip.
required: true
type: boolean
default: false
hmip:
description: HMIP devices.
required: true

View File

@ -41,6 +41,7 @@ customize:
description: If you enable it, it reads additional configuration files (`*.conf`) from `/share/mosquitto`.
required: false
type: [boolean, string]
default: false
{% endconfiguration %}
### Home Assistant user management

View File

@ -57,6 +57,7 @@ language:
custom_tts:
description: Whether to use a TTS provider from Home Assistant for a variety of voices.
type: boolean
default: false
tts_platform:
description: Which TTS platform to use.
type: string

View File

@ -79,6 +79,7 @@ fade:
description: Fade is either `true` or `false` and tells a dimmer if it should fade smooth or instant between values (only for IKEA protocol as it seems).
required: false
type: boolean
default: false
code:
description: A number series based on ones and zeroes often used for dip-switch based devices.
required: false

View File

@ -97,7 +97,7 @@ Next you need create a Lambda function.
- Under `Configuration` tab, expand `Designer`, then click `Alexa Smart Home` in the left part of the panel to add a Alexa Smart Home trigger to your Lambda function.
- Scroll down little bit, you need input the `Skill ID` from the skill you created in previous step. (tips: you may need switch back to Alexa Developer Console to copy the `Skill ID`.
- Click your Lambda Function icon in the middle of the diagram, scroll down you will see a `Function code` window.
- Clear the example code, copy the Python script from: <https://gist.github.com/awarecan/630510a9742f5f8901b5ab284c25e912>
- Clear the example code, copy the Python script from: <https://gist.github.com/matt2005/744b5ef548cc13d88d0569eea65f5e5b> (modified code to support Alexa's proactive mode, see details below)
- Scroll down a little bit, you will find `Environment variables`, you need add 4 environment variables:
* BASE_URL *(required)*: your Home Assistant instance's Internet accessible URL with port if need
* NOT_VERIFY_SSL *(optional)*: you can set it to *True* to ignore the SSL issue, if you don't have a valid SSL certificate or you are using self-signed certificate.
@ -168,7 +168,7 @@ Alexa can link your Amazon account to your Home Assistant account. Therefore Hom
* `Access Token URI`: https://[YOUR HOME ASSISTANT URL:PORT]/auth/token
* `Client ID`:
- https://pitangui.amazon.com/ if you are in US
- https://layla.amazon.com/ if you are in EU (not verified yet)
- https://layla.amazon.com/ if you are in EU
- https://alexa.amazon.co.jp/ if you are in JP and AU (not verified yet)
The trailing slash is important here.
@ -216,12 +216,11 @@ alexa:
display_categories: LIGHT
```
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode. Please note the following if you want to enable proactive mode:
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e. "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode:
- There are different endpoint URLs, depending on the region of your skill. Please check the available endpoints at <https://developer.amazon.com/docs/smarthome/send-events-to-the-alexa-event-gateway.html#endpoints>
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the [Alexa Developer Console][amazon-dev-console]: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available."
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available. Also, you need to restart your Home Assistant after each disabling/enabling the skill in Alexa."
### Alexa web-based app

View File

@ -40,189 +40,4 @@ app_key:
description: The Application key to access the service.
required: true
type: string
monitored_conditions:
description: Weather conditions to track.
required: false
type: list
keys:
24hourrainin:
description: 24h rain accumulation
baromabsin:
description: Absolute atmospheric pressure
baromrelin:
description: Relative atmospheric pressure
battout:
description: Weather station battery health
batt1:
description: Sensor 1 battery health
batt2:
description: Sensor 2 battery health
batt3:
description: Sensor 3 battery health
batt4:
description: Sensor 4 battery health
batt5:
description: Sensor 5 battery health
batt6:
description: Sensor 6 battery health
batt7:
description: Sensor 7 battery health
batt8:
description: Sensor 8 battery health
batt9:
description: Sensor 9 battery health
batt10:
description: Sensor 10 battery health
co2:
description: CO2 level
dailyrainin:
description: Daily rain accumulation
dewPoint:
description: Dewpoint temperature
eventrainin:
description: Event Rain accumulation
feelsLike:
description: Feels Like temperature
hourlyrainin:
description: Hourly rain accumulation
humidity:
description: Outdoor humidity
humidity1:
description: Sensor 1 humidity
humidity2:
description: Sensor 2 humidity
humidity3:
description: Sensor 3 humidity
humidity4:
description: Sensor 4 humidity
humidity5:
description: Sensor 5 humidity
humidity6:
description: Sensor 6 humidity
humidity7:
description: Sensor 7 humidity
humidity8:
description: Sensor 8 humidity
humidity9:
description: Sensor 9 humidity
humidity10:
description: Sensor 10 humidity
humidityin:
description: Indoor humidity
lastRain:
description: Datetime of last rain event
maxdailygust:
description: Max daily wind gust
monthlyrainin:
description: Monthly rain accumulation
relay1:
description: Sensor 1 relay status
relay2:
description: Sensor 2 relay status
relay3:
description: Sensor 3 relay status
relay4:
description: Sensor 4 relay status
relay5:
description: Sensor 5 relay status
relay6:
description: Sensor 6 relay status
relay7:
description: Sensor 7 relay status
relay8:
description: Sensor 8 relay status
relay9:
description: Sensor 9 relay status
relay10:
description: Sensor 10 relay status
soilhum1:
description: Sensor 1 soil humidity
soilhum2:
description: Sensor 2 soil humidity
soilhum3:
description: Sensor 3 soil humidity
soilhum4:
description: Sensor 4 soil humidity
soilhum5:
description: Sensor 5 soil humidity
soilhum6:
description: Sensor 6 soil humidity
soilhum7:
description: Sensor 7 soil humidity
soilhum8:
description: Sensor 8 soil humidity
soilhum9:
description: Sensor 9 soil humidity
soilhum10:
description: Sensor 10 soil humidity
soiltemp1f:
description: Sensor 1 soil temperature
soiltemp2f:
description: Sensor 2 soil temperature
soiltemp3f:
description: Sensor 3 soil temperature
soiltemp4f:
description: Sensor 4 soil temperature
soiltemp5f:
description: Sensor 5 soil temperature
soiltemp6f:
description: Sensor 6 soil temperature
soiltemp7f:
description: Sensor 7 soil temperature
soiltemp8f:
description: Sensor 8 soil temperature
soiltemp9f:
description: Sensor 9 soil temperature
soiltemp10f:
description: Sensor 10 soil temperature
solarradiation:
description: Solar radiation
temp1f:
description: Sensor 1 temperature
temp2f:
description: Sensor 2 temperature
temp3f:
description: Sensor 3 temperature
temp4f:
description: Sensor 4 temperature
temp5f:
description: Sensor 5 temperature
temp6f:
description: Sensor 6 temperature
temp7f:
description: Sensor 7 temperature
temp8f:
description: Sensor 8 temperature
temp9f:
description: Sensor 9 temperature
temp10f:
description: Sensor 10 temperature
tempf:
description: Outdoor temperature
tempinf:
description: Indoor temperature
totalrainin:
description: Lifetime rain accumulation (since last reset)
uv:
description: UV index
weeklyrainin:
description: Weekly rain accumulation
winddir:
description: Wind direction
winddir_avg10m:
description: Wind direction, 10m moving average
winddir_avg2m:
description: Wind direction, 2m moving average
windgustdir:
description: Wind gust direction
windgustmph:
description: Wind gust
windspdmph_avg10m:
description: Wind speed, 10m moving average
windspdmph_avg2m:
description: Wind speed, 2m moving average
windspeedmph:
description: Windspeed
yearlyrainin:
description: Yearly rain accumulation
{% endconfiguration %}

View File

@ -232,6 +232,6 @@ Available key commands include:
- `BACK`
- `MENU`
The full list of key commands can be found [here](https://github.com/JeffLIrion/python-androidtv/blob/e1c07176efc9216cdcff8245c920224c0234ea56/androidtv/constants.py#L115-L155).
The full list of key commands can be found [here](https://github.com/JeffLIrion/python-androidtv/blob/bf1058a2f746535921b3f5247801469c4567e51a/androidtv/constants.py#L143-L186).
You can also use the command `GET_PROPERTIES` to retrieve the properties used by Home Assistant to update the device's state. These will be stored in the media player's `'adb_response'` attribute and logged at the INFO level, this information can be used to help improve state detection in the backend [androidtv](https://github.com/JeffLIrion/python-androidtv) package.

View File

@ -0,0 +1,60 @@
---
title: "Apache Kafka"
description: "Send data and events to Apache Kafka."
logo: apache_kafka.png
ha_category:
- History
ha_release: 0.97
---
The `apache_kafka` integration sends all state changes to a
[Apache Kafka](https://kafka.apache.org/) topic.
Apache Kafka is a real-time data pipeline that can read and write streams of data. It
stores its data safely in a distributed, replicated, fault-tolerant cluster.
To use the `apache_kafka` integration in your installation, add the following to your
`configuration.yaml` file:
```yaml
apache_kafka:
ip_address: localhost
port: 9092
topic: home_assistant_1
```
{% configuration %}
host:
description: The IP address or hostname of an Apache Kafka cluster.
required: true
type: string
port:
description: The port to use.
required: true
type: integer
topic:
description: The Kafka topic to send data to.
required: true
type: string
filter:
description: Filters for entities to be included/excluded.
required: false
type: map
keys:
include_domains:
description: Domains to be included.
required: false
type: list
include_entities:
description: Entities to be included.
required: false
type: list
exclude_domains:
description: Domains to be excluded.
required: false
type: list
exclude_entities:
description: Entities to be excluded.
required: false
type: list
{% endconfiguration %}

View File

@ -17,7 +17,7 @@ To enable APRS tracking in Home Assistant, add the following section to `configu
# Example configuration.yaml entry
device_tracker:
- platform: aprs
username: FO0BAR
username: FO0BAR # or FO0BAR-1 to FO0BAR-15
callsigns:
- 'XX0FOO*'
- 'YY0BAR-1'
@ -25,7 +25,7 @@ device_tracker:
{% configuration %}
username:
description: Your callsign. This is used to connect to the host.
description: "Your callsign (or callsign-SSID combination). This is used to connect to the host. Note: Do not use the same callsign or callsign-SSID combination as a device you intend to track: the APRS-IS network will not route the packets to Home Assistant. This is a known limitation of APRS packet routing."
required: true
type: string
password:

View File

@ -75,4 +75,4 @@ Currently known supported models:
- LC-60EQ10U
- LC-60SQ15U
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/media_player.aquostv.markdown).
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io/blob/current/source/_components/aquostv.markdown).

View File

@ -1,12 +1,6 @@
---
layout: page
title: "Arcam FMJ Receivers"
description: "Instructions on how to integrate Arcam FMJ Receivers into Home Assistant."
date: 2019-04-28 13:59 +0200
sidebar: true
comments: false
sharing: true
footer: true
logo: arcam.svg
ha_category: Media Player
ha_release: 0.96
@ -49,15 +43,18 @@ zone:
type: map
keys:
ZONE_INDEX:
name:
description: Name of zone
required: false
type: string
default: Arcam FMJ - ZONE_INDEX
turn_on:
description: Service to use when turning on device when no connection is established
required: false
type: action
description: Zone index number.
type: map
keys:
name:
description: Name of zone
required: false
type: string
default: Arcam FMJ - ZONE_INDEX
turn_on:
description: Service to use when turning on device when no connection is established
required: false
type: action
{% endconfiguration %}
```yaml

View File

@ -1,12 +1,6 @@
---
layout: page
title: "Aurora ABB Powerone PV Inverter Sensor"
description: "Instructions on how to integrate an Aurora ABB Powerone solar inverter within Home Assistant."
date: 2019-06-27 23:30
sidebar: true
comments: false
sharing: true
footer: true
logo: powerone.png
ha_category:
- Sensor

View File

@ -0,0 +1,21 @@
---
title: "Elgato Avea"
description: "Instructions on how to integrate Elgato Avea with Home Assistant."
logo: avea.png
ha_category:
- Light
ha_release: 0.97
ha_iot_class: Local Polling
---
[Elgato Avea](http://web.archive.org/web/20170930210431/https://www.elgato.com/avea) is a Bluetooth light bulb that is no longer supported by the manufacturer. The `avea` integration allows you to control all your Avea bulbs with Home Assistant.
### Configuration
To enable Avea, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: avea
```

View File

@ -13,7 +13,7 @@ redirect_from:
- /components/device_tracker.bbox/
---
The `bbox` platform uses the [Bbox Modem Router](https://fr.wikipedia.org/wiki/Bbox/) from the French Internet provider Bouygues Telecom. Sensors are mainly bandwidth measures.
The `bbox` platform uses the [Bbox Modem Router](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) from the French Internet provider Bouygues Telecom. Sensors are mainly bandwidth measures.
There is currently support for the following device types within Home Assistant:
@ -26,7 +26,7 @@ Due to third party limitation, the sensors will only be available if Home Assist
## Presence Detection
The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://fr.wikipedia.org/wiki/Bbox) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France.
The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France.
Bbox is a generic name for different hardware routers. The platform has been tested with the following devices:

View File

@ -10,7 +10,7 @@ redirect_from:
- /components/sensor.bh1750/
---
The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](https://www.mouser.com/ds/2/348/bh1750fvi-e-186247.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
Tested devices:

View File

@ -90,7 +90,7 @@ automatic_add:
<div class='note warning'>
This integration and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
This integration and the [rfxtrx switch](/components/switch.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
</div>

View File

@ -85,7 +85,7 @@ Template Binary Sensor may get an `unknown` state during startup. This results
in error messages in your log file until that platform has completed loading.
If you use `is_state()` function in your template, you can avoid this situation.
For example, you would replace
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
{% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %}
with this equivalent that returns `true`/`false` and never gives an unknown
result:
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}

View File

@ -220,7 +220,7 @@ Again, this example assumes your camera's name (in the blink app) is `My Camera`
to: 'on'
action:
service: blink.save_video
data:
data_template:
name: "My Camera"
filename: "/tmp/videos/blink_video_{{ now().strftime('%Y%m%d_%H%M%S') }}.mp4"

View File

@ -10,7 +10,7 @@ ha_iot_class: Configurable
The `mqtt` camera platform allows you to integrate the content of an image file sent through MQTT into Home Assistant as a camera. Every time a message under the `topic` in the configuration is received, the image displayed in Home Assistant will also be updated.
This can be used with an application or a service capable of sending images through MQTT, for example [Zanzito](https://play.google.com/store/apps/details?id=it.barbaro.zanzito).
This can be used with an application or a service capable of sending images through MQTT.
## Configuration

View File

@ -11,7 +11,7 @@ redirect_from: /components/media_player.cast/
---
Google Cast devices like Android TVs and Chromecasts will be automatically
discovered if you enable [the discovery integration(/components/discovery/). If
discovered if you enable [the discovery integration](/components/discovery/). If
you don't have the discovery integration enabled, you can enable the Cast
integration by going to the Integrations page inside the config panel.

View File

@ -80,7 +80,7 @@ Set target temperature of climate device
| `temperature` | no | New target temperature for hvac
| `target_temp_high` | yes | New target high temperature for hvac
| `target_temp_low` | yes | New target low temperature for hvac
| `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly.
| `hvac_mode` | yes | HVAC mode to set temperature to. This defaults to current HVAC mode if not set, or set incorrectly.
#### Automation example
@ -94,7 +94,7 @@ automation:
data:
entity_id: climate.kitchen
temperature: 24
operation_mode: Heat
hvac_mode: heat
```
### Service `climate.set_humidity`
@ -163,7 +163,7 @@ automation:
- service: climate.set_hvac_mode
data:
entity_id: climate.kitchen
operation_mode: heat
hvac_mode: heat
```
### Service `climate.set_swing_mode`

View File

@ -107,7 +107,7 @@ mode_state_template:
required: false
type: template
modes:
description: A list of supported modes.
description: A list of supported modes. Needs to be a subset of the default values.
required: false
default: ['auto', 'off', 'cool', 'heat', 'dry', 'fan_only']
type: list
@ -139,6 +139,11 @@ temperature_high_state_topic:
description: The MQTT topic to subscribe for changes in the target high temperature. If this is not set, the target high temperature works in optimistic mode (see below).
required: false
type: string
precision:
description: The desired precision for this device. Can be used to match your actual thermostat's precision. Supported values are `0.1`, `0.5` and `1.0`.
required: false
type: float
default: 0.1 for Celsius and 1.0 for Fahrenheit.
fan_mode_command_topic:
description: The MQTT topic to publish commands to change the fan mode.
required: false
@ -200,6 +205,7 @@ hold_state_template:
hold_modes:
description: A list of available hold modes.
required: false
type: list
aux_command_topic:
description: The MQTT topic to publish commands to switch auxiliary heat.
required: false
@ -281,7 +287,7 @@ climate:
name: Study
modes:
- "off"
- "on"
- "heat"
- "auto"
mode_command_topic: "study/ac/mode/set"
mode_state_topic: "study/ac/mode/state"
@ -317,4 +323,5 @@ climate:
temperature_command_topic: "study/ac/temperature/set"
fan_mode_command_topic: "study/ac/fan/set"
swing_mode_command_topic: "study/ac/swing/set"
precision: 1.0
```

View File

@ -47,12 +47,12 @@ payload_on:
description: The payload that represents enabled state.
required: false
type: string
default: ON
default: 'ON'
payload_off:
description: The payload that represents disabled state.
required: false
type: string
default: OFF
default: 'OFF'
value_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
required: false

View File

@ -3,7 +3,7 @@ title: "Config"
description: "Instructions on how to setup the configuration panel for Home Assistant."
logo: home-assistant.png
ha_category:
- Front end
- Front End
ha_release: 0.39
ha_qa_scale: internal
---

View File

@ -13,9 +13,9 @@ The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a
## 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`.
`state_topic` can only manage `state_open` and `state_closed`. No percentage positons etc.
`state_topic` can only manage `state_open` and `state_closed`. No percentage positions etc.
For this purpose is `position_topic` which can set state of the cover and positon.
For this purpose is `position_topic` which can set state of the cover and position.
Default setting are 0 means the device is `closed` and all other intermediate positions means the device is `open`.
`position_topic` is managed by `position_open` and `position_closed`
You can set it up in opossite way as well.

View File

@ -16,7 +16,7 @@ Supported platforms (tested):
<div class='note warning'>
You must first create an API client [here](https://clearpass.server.com/guest/api_clients.php).
You must first create an API client [here](https://www.arubanetworks.com/techdocs/ClearPass/6.6/Guest/Content/AdministrationTasks1/CreateEditAPIclient.htm).
</div>

View File

@ -15,7 +15,7 @@ The `cups` sensor platform is using the open source printing system [CUPS](https
## Setup
You will need to install the `python3-dev` or `python3-devel` pacakge and the development files for CUPS (`libcups2-dev` or`cups-devel`) on your system manually (e.g., `sudo apt-get install python3-dev libcups2-dev` or `sudo dnf -y install python3-devel cups-devel`) along with a compiler (`gcc`). This integration doesn't work out-of-the-box in a container-based setup.
You will need to install the `python3-dev` or `python3-devel` package and the development files for CUPS (`libcups2-dev` or`cups-devel`) on your system manually (e.g., `sudo apt-get install python3-dev libcups2-dev` or `sudo dnf -y install python3-devel cups-devel`) along with a compiler (`gcc`). This integration doesn't work out-of-the-box in a container-based setup.
To set up the sensor the "Queue Name" of the printer is needed. The fastest way to get it, is to visit the CUPS web interface at "http://[IP ADDRESS PRINT SERVER]:631" and go to "Printers".
@ -57,3 +57,23 @@ is_cups_server:
type: boolean
default: true
{% endconfiguration %}
## {% linkable_title Examples %}
Default configuration for an IPP printer:
```yaml
# Example configuration.yaml entry for an IPP printer
sensor:
- platform: cups
host: PRINTER_IP
is_cups_server: false
printers:
- ipp/print
```
<div class='note'>
You will need to install the `python3-dev` or `python3-devel` and the development files for CUPS (`libcups2-dev` or`cups-devel`) package on your system manually (eg. `sudo apt-get install python3-dev libcups2-dev` or `sudo dnf -y install python3-devel cups-devel`) along with a compiler (`gcc`).
</div>

View File

@ -57,9 +57,10 @@ The `daikin` climate platform integrates Daikin air conditioning systems into Ho
- [**set_hvac_mode**](/components/climate/#service-climateset_hvac_mode) (off, heat, cool, auto, or fan only)
- [**target temperature**](https://www.home-assistant.io/components/climate#service-climateset_temperature)
- [**turn on/off**](https://www.home-assistant.io/components/climate#service-climateturn_on)
- [**fan mode**](https://www.home-assistant.io/components/climate#service-climateset_fan_mode) (speed)
- [**swing mode**](https://www.home-assistant.io/components/climate#service-climateset_swing_mode)
- [**set_preset_mode**](https://www.home-assistant.io/components/climate#service-climateset_away_mode) (away, home)
- [**set_preset_mode**](https://www.home-assistant.io/components/climate#service-climateset_preset_mode) (away, none)
Current inside temperature is displayed.
@ -69,6 +70,18 @@ Some models do not support setting of **fan speed** or **swing mode**.
</div>
<div class='note'>
Preset mode **away** translates to Daikin's "Holiday Mode":<br/>
<br>
_"Holiday mode" is used when you want to turn off your units when you leave you home for a longer time._<br>
<br>
_When "Holiday mode" is enabled, the following action take place:_
- _All connected units are turned OFF._
- _All schedule timers are disabled._
</div>
## Sensor
The `daikin` sensor platform integrates Daikin air conditioning systems into Home Assistant, enabling displaying the following parameters:

View File

@ -52,7 +52,7 @@ The following sensors are supported.
- **Supply temperature:** Air temperature of the air supplied to the house.
- **Extract temperature:** Air temperature of the air extracted from the house.
- **Exhaust temperature:** Exhausted air temperature.
- **Remaining filter lifetime:** Reamining filter lifetime measured in percent.
- **Remaining filter lifetime:** Remaining filter lifetime measured in percent.
## Switch

View File

@ -143,6 +143,8 @@ monitored_conditions:
description: The approximate distance to the nearest storm in miles.
nearest_storm_bearing:
description: The approximate direction of the nearest storm in degrees, with true north at 0° and progressing clockwise.
alerts:
description: Current severe weather advisories.
units:
description: Specify the unit system. Valid options are `auto`, `us`, `si`, `ca` and `uk2`. `auto` will let Dark Sky decide the unit system based on location.
required: false

View File

@ -9,7 +9,7 @@ redirect_from:
- /components/device_tracker.ddwrt/
---
This platform offers presence detection by looking at connected devices to a [DD-WRT](http://www.dd-wrt.com/site/index) based router.
This platform offers presence detection by looking at connected devices to a [DD-WRT](https://dd-wrt.com/) based router.
To use a DD-WRT router in your installation, add the following to your `configuration.yaml` file:

View File

@ -0,0 +1,73 @@
---
title: "De Lijn"
description: "Instructions on how to integrate De Lijn (Flemish public transport company) departure times into Home Assistant."
ha_release: 0.97
ha_category:
- Transport
- Sensor
ha_iot_class: Cloud Polling
logo: delijn.svg
---
The `delijn` sensor will give you the departure time of the next bus, tram or subway at a specific stop of the De Lijn public transport network in Flanders (Belgium).
## Setup
Create a developer account at [De Lijn Open Data portal](https://data.delijn.be/) to get a free API subscription key.
For valid stop IDs check for the 6 digits at the physical stops or visit the [stops page](https://www.delijn.be/en/haltes/) of the De Lijn website.
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: delijn
api_key: 'API_SUBSCRIPTION_KEY'
next_departure:
- stop_id: 'STOP_ID'
```
{% configuration %}
api_key:
description: "API Subscription key needed to access De Lijn API's."
required: true
type: string
next_departure:
description: One or multiple departure sensors.
required: true
type: list
keys:
stop_id:
description: "ID of the stop, e.g. `200552`."
required: true
type: string
number_of_departures:
description: "Specify the maximum number of departures/passages at a stop to retrieve"
required: false
default: 5
type: integer
{% endconfiguration %}
## Examples
### Full configuration
The example below shows a full configuration with two sensors, only the abcdefg needs to be replaced with an actual API subscription key. The first stop_id will return the default next 5 passages, the second stop_id has been forced to return the next 20 passages.
```yaml
# Example configuration.yaml entry
sensor:
# De Lijn public transport
- platform: delijn
api_key: 'abcdefg'
next_departure:
- stop_id: '200018'
- stop_id: '201169'
number_of_departures: 20
```
## Custom Lovelace card
Works best with the following custom Lovelace card: <https://github.com/bollewolle/delijn-card>

View File

@ -13,7 +13,7 @@ The [Discord service](https://discordapp.com/) is a platform for the notify comp
In order to get a token you need to go to the [Discord My Apps page](https://discordapp.com/developers/applications/me) and create a new application. Once the application is ready, create a [bot](https://discordapp.com/developers/docs/topics/oauth2#bots) user (**Create a Bot User**).
Retreive the **Client ID** from the information section and the (hidden) **Token** of your bot for later.
Retrieve the **Client ID** from the information section and the (hidden) **Token** of your bot for later.
When setting up the application you can use this [icon](/images/favicon-192x192-full.png).
@ -66,21 +66,15 @@ Right click channel name and copy the channel ID (**Copy ID**).
This channel ID has to be used as the target when calling the notification service. Multiple channel IDs can be specified, across multiple servers.
#### Example service payload
#### Example service call
```json
{
"message": "A message from Home Assistant",
"target": [
"1234567890",
"0987654321"
],
"data": {
"images": [
"/tmp/garage_cam.jpg"
]
}
}
```yaml
- service: notify.discord
data:
message: "A message from Home Assistant"
target: ["1234567890", "0987654321"]
data:
images: "/tmp/garage_cam"
```
### Notes

View File

@ -107,7 +107,7 @@ monitored_conditions:
Zone1OperativeMode:
description: Heating circuit operative mode (on/off/day/night).
ContinuosHeating:
description: Continuos heating.
description: Continuous heating.
PowerEnergyConsumptionLastMonth:
description: Power energy consumption from last month.
PowerEnergyConsumptionThisMonth:

View File

@ -2,7 +2,7 @@
title: "eCoal water boiler controller"
description: "Instructions on how to integrate eSterownik.pl eCoal.pl controller into Home Assistant."
ha_category:
- Water heater
- Water Heater
ha_release: 0.87
ha_iot_class: Local Polling
redirect_from:

View File

@ -142,7 +142,7 @@ auto, and off.
## Services
The following extra services are provided by the Ecobee Thermostat: `resume_program`.
Besides the standard services provided by the Home Assistant [Climate](https://www.home-assistant.io/components/climate/) integration, the following extra service is provided by the Ecobee Thermostat: `resume_program`.
### Service `resume_program`

View File

@ -3,7 +3,7 @@ title: "EcoNet water heater"
description: "Instructions on how to integrate Rheem EcoNet water heaters into Home Assistant."
logo: econet.png
ha_category:
- Water heater
- Water Heater
ha_release: 0.61
ha_iot_class: Cloud Polling
redirect_from:

View File

@ -36,18 +36,21 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To integrate Elk-M1 controller with Home Assistant, add the following
To integrate one or more Elk-M1 controllers with Home Assistant, add the following
section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
elkm1:
host: elk://IP_ADDRESS
- host: elk://IP_ADDRESS_1
...
- host: elk://IP_ADDRESS_2
prefix: gh # for guest house controller
```
{% configuration %}
host:
description: Connection string to Elk of the form `<method>://<address>[:port]`. `<method>` is `elk` for non-secure connection, `elks` for secure connection, and `serial` for serial port connection. `<address>` is IP address or domain or for `serial` the serial port that the Elk is connected to. Optional `<port>` is the port to connect to on the Elk, defaulting to 2101 for `elk` and 2601 for `elks`. For `serial` method, _address_ is the path to the tty _/dev/ttyS1_ for example and `[:baud]` is the baud rate to connect with.
description: Connection string to Elk of the form `<method>://<address>[:port]`. `<method>` is `elk` for non-secure connection, `elks` for secure connection, and `serial` for serial port connection. `<address>` is IP address or domain or for `serial` the serial port that the Elk is connected to. Optional `<port>` is the port to connect to on the Elk, defaulting to 2101 for `elk` and 2601 for `elks`. For `serial` method, _address_ is the path to the tty _/dev/ttyS1_ for example and `[:baud]` is the baud rate to connect with. You may have multiple host sections for connecting multiple controllers.
required: true
type: string
username:
@ -58,6 +61,10 @@ password:
description: Password to login to Elk. Only required if using `elks` connection method.
required: false
type: string
prefix:
description: The prefix to use, if any, for all the devices created for this controller. At most one host can omit the prefix, all others must have a unique prefix within the home assistant instance.
require: false
type: string
temperature_unit:
description: The temperature unit that the Elk panel uses. Valid values are `C` and `F`.
required: false
@ -75,12 +82,12 @@ area:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.
@ -96,12 +103,12 @@ counter:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.
@ -117,12 +124,12 @@ keypad:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.
@ -138,12 +145,12 @@ output:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.
@ -159,12 +166,12 @@ setting:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.
@ -180,12 +187,12 @@ task:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.
@ -201,12 +208,12 @@ thermostat:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.
@ -222,12 +229,12 @@ plc:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.
@ -243,12 +250,12 @@ zone:
required: false
default: true
include:
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a postive integer or a X10 housecode. See configuration below for examples of ranges.
description: List to include in the form of either `<value>` or `<value>-<value>` where `<value>` is a positive integer or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: All included.
exclude:
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or a X10 housecode. See configuration below for examples of ranges.
description: List to exclude in the form of either `<value>` or `<value>-<value>` where `<value>` is a number or an X10 housecode. See configuration below for examples of ranges.
type: list
required: false
default: None excluded.

View File

@ -129,4 +129,4 @@ The stop id is the content after `id=` parameter in the url. Copy paste this int
**Q:** Where do I find a line id to add to the whitelisting?
**A:** The sensor will show the line id, and is the recommended way to find it, while we wait for 'Nasjonalt Stoppestedregister' to become public. It is also possible to see the line ids by using the developer tool in the browser while looking at the trafic in [Entur's travel planer](https://en-tur.no).
**A:** The sensor will show the line id, and is the recommended way to find it, while we wait for 'Nasjonalt Stoppestedregister' to become public. It is also possible to see the line ids by using the developer tool in the browser while looking at the traffic in [Entur's travel planer](https://en-tur.no).

View File

@ -18,6 +18,13 @@ The following device types and data are supported:
- [Sensor](#sensor) - Current conditions and alerts
- [Camera](#camera) - Radar imagery
<p class='note'>
On Raspbian or Hassbian, you may need to manually install additional prerequisites with the following command:
`sudo apt-get install libatlas-base-dev libopenjp2-7`
</p>
## Location Selection
Each platform automatically determines which weather station's data to use. However, as station coordinates provided by Environment Canada are somewhat imprecise, in some cases you may need to override the automatic selection to use the desired station.
@ -40,10 +47,10 @@ weather:
- platform: environment_canada
```
- The sensor checks for new data every 10 minutes, and the source data is typically updated hourly within 10 minutes after the hour.
- The platform checks for new data every 10 minutes, and the source data is typically updated hourly within 10 minutes after the hour.
- If no name is given, the weather entity will be named `weather.<station_name>`.
- The platform automatically determines which weather station to use based on the system's latitude/longitude settings. For greater precision, it is also possible to specify either:
- A specific station code based on [this CSV file](http://dd.weatheroffice.ec.gc.ca/citypage_weather/docs/site_list_towns_en.csv), or
- A specific station code of the form `AB/s0000123` based on those listed in [this CSV file](http://dd.weatheroffice.ec.gc.ca/citypage_weather/docs/site_list_towns_en.csv), or
- A specific latitude/longitude
{% configuration %}
@ -60,7 +67,7 @@ station:
required: false
type: string
name:
description: Name to be used for the weather entity.
description: Name to be used for the entity ID, e.g. `weather.<name>`.
required: false
type: string
forecast:
@ -82,11 +89,35 @@ sensor:
- platform: environment_canada
```
- By default, a sensor entity is created for each monitored condition and each category of alert. Each sensor entity will be given the `device_id` of `sensor.<optional-name_><condition>`.
- The sensor checks for new data every 10 minutes, and the source data is typically updated hourly within 10 minutes after the hour.
- A sensor will be created for each of the following conditions, with a default name like `sensor.temperature`:
- `temperature` - The current temperature, in ºC.
- `dewpoint` - The current dewpoint, in ºC.
- `wind_chill` - The current wind chill, in ºC.
- `humidex` - The current humidex, in ºC.
- `pressure` - The current air pressure, in kPa.
- `tendency` - The current air pressure tendency, e.g. "Rising".
- `humidity` - The current humidity, in %.
- `visibility` - The current visibility, in km.
- `condition` - A brief text statement of the current weather conditions, e.g. "Sunny".
- `wind_speed` - The current sustained wind speed, in km/h.
- `wind_gust` - The current wind gust, in km/h.
- `wind_dir` - The current cardinal wind direction, e.g. "SSW".
- `wind_bearing` - The current wind direction in degrees.
- `high_temp` - The next forecast high temperature, in ºC.
- `low_temp` - The next forecast low temperature, in ºC.
- `uv_index` - The next forecast UV index.
- `pop` - The next forecast probability of precipitation, in %.
- `text_summary` - A textual description of the next forecast period, e.g. "Tonight. Mainly cloudy. Low -12."
- `precip_yesterday` - The total amount of precipitation that fell the previous day.
- `warnings` - Current warning alerts.
- `watches` - Current watch alerts.
- `advisories` - Current advisory alerts.
- `statements` - Current special weather statements.
- `endings` - Alerts that have recently ended.
- The platform automatically determines which weather station to use based on the system's latitude/longitude settings. For greater precision, it is also possible to specify either:
- A specific station code based on [this CSV file](http://dd.weatheroffice.ec.gc.ca/citypage_weather/docs/site_list_towns_en.csv), or
- A specific station code of the form `AB/s0000123` based on those listed in [this CSV file](http://dd.weatheroffice.ec.gc.ca/citypage_weather/docs/site_list_towns_en.csv), or
- A specific latitude/longitude
- In the case of multiple alerts in the same category, the titles and details of each are concatenated together with a pipe (`|`) separator.
{% configuration %}
latitude:
@ -101,58 +132,32 @@ station:
description: The station code of a specific weather station to use. If provided, this station will be used and any latitude/longitude coordinates provided will be ignored. Station codes must be in the form of `AB/s0000123`, where `AB`is a provincial abbreviation and `s0000123` is a numeric station code.
required: false
type: string
name:
description: Name to be used for the sensor entities.
language:
description: Language to use for entity display names and textual data (English or French).
required: false
type: string
monitored_conditions:
description: The conditions to monitor. A sensor will be created for each condition.
required: true
type: list
default: All keys
keys:
temperature:
description: The current temperature, in ºC.
dewpoint:
description: The current dewpoint, in ºC.
wind_chill:
description: The current wind chill, in ºC.
humidex:
description: The current humidex, in ºC.
pressure:
description: The current air pressure, in kPa.
tendency:
description: The current air pressure tendency, e.g. "Rising" or "Falling".
humidity:
description: The current humidity, in %.
visibility:
description: The current visibility, in km.
condition:
description: A brief text statement of the current weather conditions, e.g. "Sunny".
wind_speed:
description: The current sustained wind speed, in km/h.
wind_gust:
description: The current wind gust, in km/h.
wind_dir:
description: The current cardinal wind direction, e.g. "SSW".
high_temp:
description: The next forecast high temperature, in ºC.
low_temp:
description: The next forecast low temperature, in ºC.
pop:
description: The next forecast probability of precipitation, in %.
warnings:
description: Current warning alerts.
watches:
description: Current watch alerts.
advisories:
description: Current advisory alerts.
statements:
description: Current special weather statements.
endings:
description: Alerts that have recently ended.
default: english
scan_interval:
description: The time between updates in seconds.
required: false
type: integer
default: 600
{% endconfiguration %}
###Alert TTS Script
If you would like to have alerts announced via a text-to-speech service, you can use a script similar to the following:
{% raw %}
```yaml
weather_alert_tts:
sequence:
- service: tts.amazon_polly_say
data_template:
message: "{{ states('sensor.warnings') }} in effect. {{ state_attr('sensor.warnings', 'alert detail') }}"
```
{% endraw %}
## Camera
The `environment_canada` camera platform displays Environment Canada meteorological [radar imagery](https://weather.gc.ca/radar/index_e.html).
@ -165,6 +170,11 @@ camera:
- platform: environment_canada
```
<p class='note'>
On Raspbian or Hassbian, you may need to manually install additional prerequisites with the following command:
`sudo apt-get install libatlas-base-dev libopenjp2-7`
</p>
- If no name is given, the camera entity will be named `camera.<station_name>_radar`.
- The platform automatically determines which radar station to use based on the system's latitude/longitude settings. For greater precision, it is also possible to specify either:
- A specific station ID from [this table](https://en.wikipedia.org/wiki/Canadian_weather_radar_network#List_of_radars) (remove the leading `C`, e.g. `XFT` or `ASBV`), or
@ -184,7 +194,7 @@ station:
required: false
type: string
name:
description: Name to be used for the camera entity.
description: Name to be used for the entity ID, e.g. `camera.<name>`.
required: false
type: string
loop:

View File

@ -0,0 +1,85 @@
---
title: "FleetGO"
description: "Instructions on how to use a FleetGO as a device tracker."
logo: fleetgo.png
ha_category:
- Car
ha_iot_class: Cloud Polling
ha_release: 0.76
redirect_from:
- /components/device_tracker.ritassist/
- /components/ritassist
---
The `fleetgo` device tracker platform allows you to integrate your vehicles equipped with [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map.
## Setup
To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key).
## Configuration
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: fleetgo
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
username: YOUR_FLEETGO_USERNAME
password: YOUR_FLEETGO_PASSWORD
include:
- LICENSE_PLATE
```
{% configuration %}
client_id:
description: The client ID used to connect to the FleetGO API.
required: true
type: string
client_secret:
description: The client secret used to connect to the FleetGO API.
required: true
type: string
username:
description: Your FleetGO username.
required: true
type: string
password:
description: Your FleetGO password.
required: true
type: string
include:
description: A list of license plates to include, if this is not specified, all vehicles will be added.
required: false
type: list
{% endconfiguration %}
See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked.
## Available attributes
| Attribute | Description |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| latitude | The latitude of your vehicle |
| longitude | The longitude of your vehicle |
| altitude | Altitude of your vehicle |
| id | Identifier used to identify your vehicle |
| make | The make of the vehicle |
| model | Model of your vehicle |
| license_plate | License plate number |
| active | If the engine is currently active or not |
| odo | The odometer in kilometers |
| speed | The current speed of your vehicle, in KM/h |
| last_seen | The date and time when your vehicle last communicated with the API |
| fuel_level | Fuel level of the vehicle [1] |
| malfunction_light | Are any malfunction lights burning [1] |
| coolant_temperature | Temperature of the coolant [1] |
| power_voltage | Power voltage measured by the hardware [1] |
| distance_from_home | How far is your vehicle located from your Home Assistant Home location |
| current_max_speed | The maximum speed on the road the device is currently on (if available) |
| current_address | Object with address information the device is currently on. This resolves to the closest address to the coordinates of the device. |
[1] Only available on certain cars and hardware revisions.

View File

@ -0,0 +1,75 @@
---
title: "Fortigate"
description: "Instructions on how to integrate FortiGate Firewalls into Home Assistant."
logo: fortinet.jpg
ha_category:
- Presence Detection
ha_release: 0.97
ha_iot_class: Local Polling
---
This is a FortiGate presence sensor based on device detection of the FortiGate API
## FortiGate set up
Configure the FortiGate with a USERNAME API user and assign its minimum rights profile:
```text
config system accprofile
edit "homeassistant_profile"
set authgrp read
next
end
config system api-user
edit "USERNAME"
set api-key API_KEY
set accprofile "homeassistant_profile"
set vdom "root"
config trusthost
edit 1
set ipv4-trusthost <trusted subnets>
next
end
next
end
```
## Configuration
Add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
fortigate:
host: HOST_IP
username: YPUR_USERNAME
api_key: YOUR_API_KEY
```
{% configuration %}
host:
description: The IP address of the FortiGate device.
required: true
type: string
username:
description: The username of the user that will connect to the FortiGate device.
required: true
type: string
api_key:
description: The API key associated with the user.
required: true
type: string
devices:
description: The MAC addresses of the devices to monitor.
required: false
type: string
{% endconfiguration %}
## Errors
If the rights of the profile are not sufficient, you will get the following error:
```txt
ERROR (MainThread) [homeassistant.core] Error doing job: Task exception was never retrieved
```

View File

@ -0,0 +1,42 @@
---
title: "Device Tracker FortiOS"
description: "Instructions on how to use Fortinet FortiOS to track devices in Home Assistant."
logo: fortinet.png
ha_category:
- Presence Detection
ha_release: 0.97
ha_iot_class: Local Polling
---
This integration enables Home Assistant to do device tracking of devices with a MAC address connected to a FortiGate from [Fortinet](https://www.fortinet.com).
The integration relies on the [fortiosapi](https://pypi.org/project/fortiosapi/).
The integration has been tested both on FortiGate appliance and FortiGate VM running SW FortiOS v. 6.0.x and 6.2.0.
All devices with a MAC address identified by FortiGate would be tracked, this covers both Ethernet and WiFi devices, including devices detected by LLDP.
The integration is based on the Home Assistant `device_tracker` platform.
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: fortios
host: YOUR_HOST
token: YOUR_API_USER_KEY
```
{% configuration %}
host:
description: Hostname or IP address of the FortiGate.
required: true
type: string
token:
description: "See [Fortinet Developer Network](https://fndn.fortinet.com) for how to create an API token. Remember this integration only needs read access to a FortiGate, so configure the API user to only to have limited and read-only access."
required: true
type: string
verify_ssl:
description: If the SSL certificate should be verified. In most home cases users do not have a verified certificate.
required: false
type: boolean
default: false
{% endconfiguration %}

View File

@ -45,9 +45,9 @@ port:
type: string
{% endconfiguration %}
You can find out your Freebox host and port by opening
[this address](http://mafreebox.freebox.fr/api_version) in your browser. The
You can find out your Freebox host and port by opening the address mafreebox.freebox.fr/api_version in your browser. The
returned json should contain an api_domain (`host`) and a https_port (`port`).
Please consult the [api documentation](https://dev.freebox.fr/sdk/os/) for more information.
### Initial setup
@ -60,7 +60,7 @@ authorize it by pressing the right arrow on the facade of the Freebox when
prompted to do so.
To make the WiFi switch working you will have to add "Modification des réglages de la Freebox
" permission to Home Assitant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications".
" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications".
### Supported routers

View File

@ -0,0 +1,98 @@
---
title: "Fronius"
description: "Instructions on how to connect your Fronius Inverter to Home Assistant."
ha_category:
- Energy
- Sensor
logo: fronius.png
ha_iot_class: Local Polling
ha_release: 0.96
---
The `fronius` sensor will poll a [Fronius](http://www.fronius.com/) solar inverter, battery system or smart meter and present the values as sensors (or attributes of sensors) in Home Assistant.
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
sensor:
- platform: fronius
resource: FRONIUS_URL
monitored_conditions:
- sensor_type: inverter
```
{% configuration %}
resource:
description: "The IP address of the Fronius device"
required: true
type: string
monitored_conditions:
description: "Conditions to display in the frontend"
required: true
type: list
keys:
type:
description: "The kind of device, can be one of \"inverter\", \"storage\", \"meter\", or \"power_flow\""
required: true
type: string
scope:
description: "The device type for storage and inverter, can be either \"device\" or \"system\""
required: false
type: string
default: "device"
device:
description: "The id of the device to poll"
required: false
default: "\"1\" for inverters and \"0\" for other devices such as storages in compliance with Fronius Specs"
{% endconfiguration %}
## Examples
When including more of the components that one Fronius device offers,
a list of sensors that are to be integrated can be given like below.
```yaml
sensor:
- platform: fronius
resource: FRONIUS_IP_ADDRESS
monitored_conditions:
- sensor_type: inverter
device: 1
- sensor_type: meter
scope: system
- sensor_type: meter
device: 3
- sensor_type: storage
device: 0
- sensor_type: power_flow
```
## Sensors configuration
To extract more detailed values from the state of each integrated sensor and to circumvent undefined values,
it is recommended to use template sensors as an interface:
{% raw %}
```yaml
- platform: template
sensors:
electricity_inverter1_power_netto:
unit_of_measurement: 'W'
value_template: >-
{% if states.sensor.fronius_1921684247_inverter_1.attributes.power_ac is defined -%}
{{ states_attr('sensor.fronius_1921684247_inverter_1', 'power_ac') | float | round(2) }}
{%- else -%}
0
{%- endif %}
electricity_autonomy:
unit_of_measurement: '%'
value_template: >-
{% if states.sensor.fronius_1921684247_power_flow.attributes.relative_autonomy is defined -%}
{{ states_attr('sensor.fronius_1921684247_power_flow', 'relative_autonomy') | float | round(2) }}
{%- else -%}
0
{%- endif %}
```
{% endraw %}

View File

@ -100,8 +100,8 @@ The Frontier Silicon API does not provide a multi-user environment. There is alw
[Medion Radios]: http://internetradio.medion.com/
[IR110]: https://www.hama.com/00054823/hama-ir110-internet-radio-internet-radio-multi-room-app-control
[DIR3110]: https://www.hama.com/00054824/hama-digitalradio-dir3110-internetradio-dab+-fm-multiroom-app-steuerung
[MD 87466]: https://www.medion.com/de/shop/internet-dab-radios-medion-kuechen-internetradio-medion-p83302-md-87466-50051273a1.html
[SIRD 14 C2]: https://www.lidl.de/de/silvercrest-stereo-internetradio-sird-14-c2/p233545
[MD 87466]: https://www.medion.com/gb/service/start/_product.php?msn=50051273&gid=14
[SIRD 14 C2]: https://www.silvercrest-multiroom.de/fileadmin/user_upload/pdf/handbucher/Bedienungsanleitungen/IR/279398_SIRD_14_C2_ML4_V1.1_GB_CZ_SK_DE.pdf
[fsapi]: https://github.com/zhelev/python-fsapi
[UNDOK]: http://www.frontier-silicon.com/undok
[flammy]: https://github.com/flammy/fsapi/

View File

@ -73,7 +73,7 @@ keep_alive:
required: false
type: [time, integer]
initial_hvac_mode:
description: Set the initial HVAC mode. Valid values are `heat`, `cool` or `auto`. Value has to be double quoted. If this parameter is not set, it is preferable to set a *keep_alive* value. This is helpful to align any discrepancies between *generic_thermostat* and *heater* state.
description: Set the initial HVAC mode. Valid values are `off`, `heat` or `cool`. Value has to be double quoted. If this parameter is not set, it is preferable to set a *keep_alive* value. This is helpful to align any discrepancies between *generic_thermostat* and *heater* state.
required: false
type: string
away_temp:

View File

@ -4,9 +4,9 @@ description: "Instructions on how to integrate Genius Hub with Home Assistant."
logo: geniushub.png
ha_category:
- Climate
- Water heater
- Water Heater
- Sensor
- Binary sensor
- Binary Sensor
ha_release: 0.92
ha_iot_class: Local Polling
---

View File

@ -15,11 +15,12 @@ The [Geolocation trigger](/docs/automation/trigger/#geolocation-trigger) can be
| Platform | Source |
|---------------------------------------------------|-------------------------------|
| GeoJSON Events | `geo_json_events` |
| IGN Sismología | `ign_sismologia` |
| NSW Rural Fire Service Incidents | `nsw_rural_fire_service_feed` |
| Queensland Bushfire Alert | `qld_bushfire` |
| U.S. Geological Survey Earthquake Hazards Program | `usgs_earthquakes_feed` |
| GeoJSON Events | `geo_json_events` |
| IGN Sismología | `ign_sismologia` |
| NSW Rural Fire Service Incidents | `nsw_rural_fire_service_feed` |
| Queensland Bushfire Alert | `qld_bushfire` |
| U.S. Geological Survey Earthquake Hazards Program | `usgs_earthquakes_feed` |
| The World Wide Lightning Location Network | `wwlln` |
Conditions can be used to further filter entities, for example by inspecting their state attributes.

View File

@ -29,7 +29,7 @@ To use Google Assistant, your Home Assistant configuration has to be [externally
## Migrate to release 0.80 and above
<div class='note'>
If this is the first time setting up your Google Assistant integration, you can skip this section and continue with the [maual setup instructions](#first-time-setup) below.
If this is the first time setting up your Google Assistant integration, you can skip this section and continue with the [manual setup instructions](#first-time-setup) below.
</div>
@ -248,7 +248,7 @@ The request_sync service may fail with a 404 if the project_id of the Homegraph
4. Generate a new API key.
5. Again, create a new project in the [Actions on Google console](https://console.actions.google.com/). Described above. But at the step 'Build under the Actions SDK box' choose your newly created project. By this, they share the same `project_id`.
Syncing may also fail after a period of time, likely around 30 days, due to the fact that your Actions on Google app is techincally in testing mode and has never been published. Eventually, it seems that the test expires. Control of devices will continue to work but syncing may not. If you say "Ok Google, sync my devices" and get the response "Unable to sync Home Assistant", this can usually be resolved by going back to your test app in the [Actions on Google console](https://console.actions.google.com/) and clicking `Simulator` under `TEST`. Regenerate the draft version Test App and try asking Google to sync your devices again.
Syncing may also fail after a period of time, likely around 30 days, due to the fact that your Actions on Google app is technically in testing mode and has never been published. Eventually, it seems that the test expires. Control of devices will continue to work but syncing may not. If you say "Ok Google, sync my devices" and get the response "Unable to sync Home Assistant", this can usually be resolved by going back to your test app in the [Actions on Google console](https://console.actions.google.com/) and clicking `Simulator` under `TEST`. Regenerate the draft version Test App and try asking Google to sync your devices again.
### Troubleshooting with NGINX

View File

@ -14,9 +14,12 @@ The `google_maps` platform allows you to detect presence using the unofficial AP
## Configuration
You first need to create an additional Google account and share your location with that account. This platform will use that account to fetch the location of your device(s). You have to setup sharing through the Google Maps app on your mobile phone. You can find more information [here](https://support.google.com/accounts?p=location_sharing).
You first need to create an additional Google account and share your location with that account. This platform will use that account to fetch the location of your device(s).
This platform will create a file named `.google_maps_location_sharing.cookies` extended with the slugified username where it caches your login session.
1. You have to setup sharing through the Google Maps app on your mobile phone. You can find more information [here](https://support.google.com/accounts?p=location_sharing).
2. You must use `mapscookiegettercli` to get a cookie file which can be used with this device tracker. See more information [here](#maps-cookie-getter)
3. Save the cookie file to your Home Assistant configuration directory with the following name: `.google_maps_location_sharing.cookies.` followed by the slugified username of the NEW Google account.
- For example: if your email was `location.tracker@gmail.com`, the filename would be: `.google_maps_location_sharing.cookies.location_tracker_gmail_com`.
<div class='note warning'>
@ -32,7 +35,6 @@ To integrate Google Maps Location Sharing in Home Assistant, add the following s
device_tracker:
- platform: google_maps
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
@ -48,4 +50,25 @@ max_gps_accuracy:
description: Sometimes Google Maps can report GPS locations with a very low accuracy (few kilometers). That can trigger false zoning. Using this parameter, you can filter these false GPS reports. The number has to be in meters. For example, if you put 200 only GPS reports with an accuracy under 200 will be taken into account - Defaults to 100km if not specified.
required: false
type: float
scan_interval:
description: The frequency (in seconds) to check for location updates.
required: false
default: 60
type: integer
{% endconfiguration %}
### Maps Cookie Getter
You must run the [`mapscookiegetter`](https://mapscookiegettercli.readthedocs.io/en/latest/) tool to get the cookie file from a computer with a Web Browser. To install, your computer must have Python 3 and PIP installed:
```shell
pip3 install mapscookiegettercli
```
Then run the command:
```shell
maps-cookie-getter
```
This will open up a browser window for you to log-in to the NEW Google Account (the one you are sharing the location with, not your normal account). After logging in, the program will save the pickled cookie file `location_sharing.cookies` in the same directory as you ran the command from. Copy this to your Home Assistant configuration directory and rename as described above.

View File

@ -28,7 +28,7 @@ stop:
required: true
type: string
bus_name:
description: The name of the choosen bus.
description: The name of the chosen bus.
required: false
type: string
{% endconfiguration %}

View File

@ -10,7 +10,7 @@ redirect_from:
- /components/climate.heatmiser/
---
The `heatmiser` climate platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](https://www.heatmisershop.co.uk/thermostats) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
The `heatmiser` climate platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](https://www.heatmisershop.co.uk/room-thermostats/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.
Further work would be required to get this setup to connect over Wifi, but the HeatmiserV3 python module being used is a full implementation of the V3 protocol.

View File

@ -41,7 +41,7 @@ A connection to a single device enables control for all devices on the network.
### Service `heos.sign_in`
Use the sign-in service to sign the connected controller into a HEOS account so that it can retreive and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload:
Use the sign-in service to sign the connected controller into a HEOS account so that it can retrieve and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload:
```json
{
@ -142,7 +142,7 @@ You can play a URL through a HEOS media player using the `media_player.play_medi
### Debugging
The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml` to enable debug logging:
The HEOS integration will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the the relevant line below to the `configuration.yaml` to enable debug logging:
```yaml
logger:
@ -157,4 +157,4 @@ logger:
If the HEOS controller is not signed in to a HEOS account, HEOS favorites will not be populated in the media player source selection and the service `media_player.play_media` for `favorite` and `playlist` will fail. Additionally, the following warning will be logged at startup:
> IP_ADDRESS is not logged in to a HEOS account and will be unable to retrieve HEOS favorites: Use the 'heos.sign_in' service to sign-in to a HEOS account
To resolve this issue, use the `heos.sign_out` service to sign the controller into an account as documented above. This only needs to be performed once, as the controller will remain signed in while the account credentails are valid.
To resolve this issue, use the `heos.sign_out` service to sign the controller into an account as documented above. This only needs to be performed once, as the controller will remain signed in while the account credentials are valid.

View File

@ -25,11 +25,12 @@ This integration uses the unofficial API used in the official Hive website [http
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Climate](#climate)
- [Light](#light)
- [Sensor](#sensor)
- [Switch](#switch)
- [Binary Sensor](#Binary-Sensor)
- [Climate](#Climate)
- [Light](#Light)
- [Sensor](#Sensor)
- [Switch](#Switch)
- [Water Heater](#Water-Heater)
To add your Hive devices into your Home Assistant installation, add the following to your `configuration.yaml` file:
@ -102,3 +103,11 @@ The `hive` switch platform integrates your Hive plugs into Home Assistant, enabl
The platform supports the following Hive products:
- Hive Active Plug
## Water Heater
The `hive` water heater platform integrates your Hive hot water into Home Assistant, enabling control of setting the **mode**.
The platform supports the following Hive products:
- Hot Water Control

View File

@ -76,7 +76,7 @@ deviceid:
type: map
keys:
relayid:
description: The array that contains the HLK-SW16 relays, each must be a number between 0 and 9 or letter between a and f which each corresponds to a labled relay switch on the HLK-SW16.
description: The array that contains the HLK-SW16 relays, each must be a number between 0 and 9 or letter between a and f which each corresponds to a labeled relay switch on the HLK-SW16.
required: false
type: map
keys:

View File

@ -114,11 +114,11 @@ homekit:
type: map
keys:
name:
description: Name of the entity to show in HomeKit. HomeKit will cache the name on the first run so a device must be removed and then re-added for any change to take effect.
description: Name of the entity to show in HomeKit. HomeKit will cache the name on the first run so the accessory must be [reset](#resetting-accessories) for any change to take effect.
required: false
type: string
linked_battery_sensor:
description: The `entity_id` of a `sensor` entity to use as the battery of the accessory. HomeKit will cache an accessory's feature set on the first run so a device must be removed and then re-added for any change to take effect.
description: The `entity_id` of a `sensor` entity to use as the battery of the accessory. HomeKit will cache an accessory's feature set on the first run so a device must be [reset](#resetting-accessories) for any change to take effect.
required: false
type: string
low_battery_threshold:
@ -141,7 +141,7 @@ homekit:
required: true
type: string
type:
description: Only for `switch` entities. Type of accessory to be created within HomeKit. Valid types are `faucet`, `outlet`, `shower`, `sprinkler`, `switch` and `valve`. HomeKit will cache the type on the first run so a device must be removed and then re-added for any change to take effect.
description: Only for `switch` entities. Type of accessory to be created within HomeKit. Valid types are `faucet`, `outlet`, `shower`, `sprinkler`, `switch` and `valve`. HomeKit will cache the type on the first run so a device must be [reset](#resetting-accessories) for any change to take effect.
required: false
type: string
default: '`switch`'
@ -460,12 +460,20 @@ To fix this, you need to unpair the `Home Assistant Bridge`, delete the `.homeki
#### The linked battery sensor isn't recognized
Try removing the entity from HomeKit and then adding it again. If you are adding this config option to an existing entity in HomeKit, any changes you make to this entity's config options won't appear until the accessory is removed from HomeKit and then re-added.
Try removing the entity from HomeKit and then adding it again. If you are adding this config option to an existing entity in HomeKit, any changes you make to this entity's config options won't appear until the accessory is removed from HomeKit and then re-added. See [resetting accessories](#resetting-accessories).
#### My media player is not showing up as a television accessory
Media Player entities with `device_class: tv` will show up as Television accessories on devices running iOS 12.2/macOS 10.14.4 or later. If needed, try removing the entity from HomeKit and then adding it again, especially if the `media_player` was previously exposed as a series of switches. Any changes, including changed supported features, made to an existing accessory won't appear until the accessory is removed from HomeKit and then re-added.
Media Player entities with `device_class: tv` will show up as Television accessories on devices running iOS 12.2/macOS 10.14.4 or later. If needed, try removing the entity from HomeKit and then adding it again, especially if the `media_player` was previously exposed as a series of switches. Any changes, including changed supported features, made to an existing accessory won't appear until the accessory is removed from HomeKit and then re-added. See [resetting accessories](#resetting-accessories).
#### Can't control volume of your TV media player?
The volume and play/pause controls will show up on the Remote app or Control Center. If your TV supports volume control through Home Assistant, you will be able to control the volume using the side volume buttons on the device while having the remote selected on screen.
#### Resetting accessories
On Home Assistant `0.97.x` or later, you may use the service `homekit.reset_accessory` with one or more entity_ids to reset accessories whose configuration may have changed. This can be useful when changing a media_player's device class to `tv`, linking a battery, or whenever HomeAssistant add supports for new HomeKit features to existing entities.
On earlier versions of Home Assistant, you can reset accessories by removing the entity from HomeKit (via [filter](#configure-filter)) and then re-adding the accessory.
With either strategy, the accessory will behave as if it's the first time the accessory has been set up, so you will need to restore the name, group, room, scene, and/or automation settings.

View File

@ -24,7 +24,7 @@ redirect_from:
- /components/sensor.homekit_controller/
---
[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This integration should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit.
[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This integration should not be confused with the [HomeKit](/components/homekit/) integration, which allows you to control Home Assistant devices via HomeKit.
There is currently support for the following device types within Home Assistant:
@ -34,9 +34,9 @@ There is currently support for the following device types within Home Assistant:
- Light (HomeKit lights)
- Lock (HomeKit lock)
- Switch (HomeKit switches)
- Binary Sensor (HomeKit motion sensors)
- Binary Sensor (HomeKit motion sensors and contact sensors)
- Sensor (HomeKit humidity, temperature, and light level sensors)
The integration will be automatically configured if the [`discovery`](/components/discovery/) integration is enabled.
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.
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/) integration.

View File

@ -86,6 +86,7 @@ authtoken:
* homematicip_cloud.binary_sensor
* Window and door contact (*HmIP-SWDO, -I*)
* Contact Interface flush-mount 1 channel (*HmIP-FCI1*)
* Window Rotary Handle Sensor (*HmIP-SRH*)
* Smoke sensor and alarm (*HmIP-SWSD*)
* Motion Detector with Brightness Sensor - indoor (*HmIP-SMI*)
@ -110,8 +111,10 @@ authtoken:
* Temperature and humidity Sensor with display (*HmIP-STHD*)
* homematicip_cloud.cover
* Shutter actuator brand-mount (*HmIP-BROLL*)
* Shutter actuator flush-mount (*HmIP-FROLL*)
* Shutter actuator for brand-mount (*HmIP-BROLL*)
* Shutter actuator for flush-mount (*HmIP-FROLL*)
* Blind Actuator for brand switches (*HmIP-BBL*)
* Blind Actuator for flush-mount (*HmIP-FBL*)
* homematicip_cloud.light
* Switch actuator and meter for brand switches (*HmIP-BSM*)
@ -138,13 +141,83 @@ authtoken:
* Switch Actuator and Meter flush-mount (*HmIP-FSM, -FSM16*)
* Open Collector Module Receiver - 8x (*HmIP-MOD-OC8*)
* Multi IO Box - 2x (*HmIP-MIOB*)
* Switch Circuit Board - 1x channels (*HmIP-PCBS*)
* Switch Circuit Board - 2x channels (*HmIP-PCBS2*)
* Printed Circuit Board Switch Battery (*HmIP-PCBS-BAT*)
* homematicip_cloud.weather
* Weather Sensor basic (*HmIP-SWO-B*)
* Weather Sensor plus (*HmIP-SWO-PL*)
* Weather Sensor pro (*HmIP-SWO-PR*)
Additional info:
## Services
- `homematicip_cloud.activate_eco_mode_with_duration`: Activate eco mode with duration.
- `homematicip_cloud.activate_eco_mode_with_period`: Activate eco mode with period.
- `homematicip_cloud.activate_vacation`: Activates the vacation mode until the given time.
- `homematicip_cloud.deactivate_eco_mode`: Deactivates the eco mode immediately.
- `homematicip_cloud.deactivate_vacation`: Deactivates the vacation mode immediately.
### Service Examples
`accesspoint_id` (SGTIN) is optional for all services and only relevant if you have multiple Homematic IP Accesspoints connected to HA. If empty, service will be called for all configured Homematic IP Access Points.
The `accesspoint_id` (SGTIN) can be found on top of the integration page, or on the back of your Homematic IP Accesspoint.
Activate eco mode with duration.
```yaml
...
action:
service: homematicip_cloud.activate_eco_mode_with_duration
data:
duration: 60
accesspoint_id: 3014xxxxxxxxxxxxxxxxxxxx
```
Activate eco mode with period.
```yaml
...
action:
service: homematicip_cloud.activate_eco_mode_with_period
data:
endtime: 2019-09-17 18:00
accesspoint_id: 3014xxxxxxxxxxxxxxxxxxxx
```
Activates the vacation mode until the given time.
```yaml
...
action:
service: homematicip_cloud.activate_vacation
data:
endtime: 2019-09-17 18:00
temperature: 18.5
accesspoint_id: 3014xxxxxxxxxxxxxxxxxxxx
```
Deactivates the eco mode immediately.
```yaml
...
action:
service: homematicip_cloud.deactivate_eco_mode
data:
accesspoint_id: 3014xxxxxxxxxxxxxxxxxxxx
```
Deactivates the vacation mode immediately.
```yaml
...
action:
service: homematicip_cloud.deactivate_vacation_mode
data:
accesspoint_id: 3014xxxxxxxxxxxxxxxxxxxx
```
## Additional info
Push button devices are only available with a battery sensor. This is due to a limitation of the vendor API (eq3).
It's not possible to detect a key press event on these devices at the moment.

View File

@ -17,9 +17,11 @@ It does not support the home security functionality of TCC.
It uses the [somecomfort](https://github.com/kk7ds/somecomfort) client library.
<div class='note'>
There is some potential confusion over this integration because it was previously implemented as a combination of two _distinct_ climate systems, one being US-based, the other EU-based.
These two regions are _not_ interchangeable, and the `eu` region is now deprecated. Ongoing support for such systems is available via the [evohome](/components/evohome/) integration.
</div>
### US-based Systems

View File

@ -122,8 +122,8 @@ sensor:
monitored_conditions:
- device_information.SoftwareVersion
- device_signal.rssi
- traffic_statistics.CurrentDownloadRate
- traffic_statistics.TotalConnectTime
- monitoring_traffic_statistics.CurrentDownloadRate
- monitoring_traffic_statistics.TotalConnectTime
```
{% configuration %}
@ -152,14 +152,14 @@ monitored_conditions:
device_signal.sinr:
description: The signal SINR value.
default: default
traffic_statistics.CurrentDownloadRate:
monitoring_traffic_statistics.CurrentDownloadRate:
description: Current download rate, bytes/sec.
traffic_statistics.CurrentUploadRate:
monitoring_traffic_statistics.CurrentUploadRate:
description: Current upload rate, bytes/sec.
traffic_statistics.TotalUpload:
monitoring_traffic_statistics.TotalUpload:
description: Total bytes uploaded since last reset.
traffic_statistics.TotalDownload:
monitoring_traffic_statistics.TotalDownload:
description: Total bytes downloaded since last reset.
traffic_statistics.TotalConnectTime:
monitoring_traffic_statistics.TotalConnectTime:
description: Total time connected since last reset.
{% endconfiguration %}

View File

@ -45,7 +45,7 @@ scan_interval:
default: 30
{% endconfiguration %}
To get your API access token log into your [Hydrawise account](https://app.hydrawise.com/config/account) and in the 'My Account Details' section under Account Settings click 'Generate API Key'. Enter that key in your configuration file as the `API_KEY`.
To get your API access token log into your [Hydrawise account](https://app.hydrawise.com/config/login) and in the 'My Account Details' section under Account Settings click 'Generate API Key'. Enter that key in your configuration file as the `API_KEY`.
## Binary Sensor

View File

@ -81,7 +81,7 @@ ifttt:
### Testing your trigger
You can use the **Developer tools** to test your [Webhooks](https://ifttt.com/maker_webhooks) trigger. To do this, open the Home Assistant frontend, open the sidebar, click on the first icon in the developer tools. This should get you to the **Call Service** screen. Fill in the following values:
You can use **Developer Tools** to test your [Webhooks](https://ifttt.com/maker_webhooks) trigger. To do this, open the Home Assistant sidebar, click on Developer Tools, and then the **Services** tab. Fill in the following values:
Field | Value
----- | -----

View File

@ -3,10 +3,10 @@ title: "Intergas InComfort"
description: "Instructions on how to integrate an Intergas Lan2RF gateway with Home Assistant."
logo: incomfort.png
ha_category:
- Water heater
- Water Heater
- Climate
- Sensor
- Binary sensor
- Binary Sensor
ha_release: 0.93
ha_iot_class: Local Polling
---

View File

@ -21,13 +21,16 @@ add the following lines to your `configuration.yaml`:
input_datetime:
both_date_and_time:
name: Input with both date and time
has_ has_time: true
has_date: true
has_time: true
only_date:
name: Input with only date
has_ has_time: false
has_date: true
has_time: false
only_time:
name: Input with only time
has_ has_time: true
has_date: false
has_time: true
```
{% configuration %}
@ -50,6 +53,10 @@ input_datetime:
required: false
type: boolean
default: false
icon:
description: Icon to display in the frontend.
required: false
type: icon
initial:
description: Set the initial value of this input, depending on `has_time` and `has_date`.
required: false
@ -68,6 +75,7 @@ automations and templates.
| `has_date` | `true` if this entity has a date.
| `year`<br>`month`<br>`day` | The year, month and day of the date.<br>(only available if `has_| `hour`<br>`minute`<br>`second` | The hour, minute and second of the time.<br>(only available if `has_time: true`)
| `timestamp` | A timestamp representing the time held in the input.<br>If `has_
### Restore State
This integration will automatically restore the state it had prior to Home

View File

@ -299,8 +299,6 @@ script:
method: VideoLibrary.Scan
```
For a more complex usage of the `kodi_call_method` service, with event triggering of Kodi API results, you can have a look at this [example](/cookbook/automation_kodi_dynamic_input_select/)
## Notifications
The `kodi` notifications platform allows you to send messages to your [Kodi](https://kodi.tv/) multimedia system from Home Assistant.

View File

@ -10,7 +10,7 @@ redirect_from:
- /components/sensor.kwb/
---
The `kwb` integration integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (<http://www.kwbheizung.de/de/produkte/kwb-comfort-3.html>) into Home Assistant.
The `kwb` integration integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (https://www.kwb.net/produkte/) into Home Assistant.
Direct connection via serial (RS485) or via telnet terminal server is supported. The serial cable has to be attached to the control unit port 25 (which is normally used for detached control terminals).

View File

@ -21,7 +21,7 @@ redirect_from:
The `lcn` integration for Home Assistant allows you to connect to [LCN](http://www.lcn.eu) hardware devices.
The integration requires one unused license of the coupling software LCN-PCHK (version >2.8) and a LCN hardware coupler. Alternatively a LCN-PKE coupler can be used which offers two PCHK licenses.
The integration requires one unused license of the coupling software LCN-PCHK (version >2.8) and an LCN hardware coupler. Alternatively, an LCN-PKE coupler can be used which offers two PCHK licenses.
With this setup sending and receiving commands to and from LCN modules is possible.
There is currently support for the following device types within Home Assistant:
@ -36,8 +36,8 @@ There is currently support for the following device types within Home Assistant:
<div class='note'>
Please note: Besides the implemented platforms the `lcn` integration offers a variety of [service calls](#services).
These service calls cover functionalities of the LCN system which cannot be represented by the platform implementations.
Please note: Besides the implemented platforms, the `lcn` integration offers a variety of [service calls](#services).
These service calls cover functionalities of the LCN system, which cannot be represented by the platform implementations.
They are ideal to be used in automation scripts or for the `template` platforms.
</div>
@ -45,7 +45,7 @@ There is currently support for the following device types within Home Assistant:
## Configuration
To use your LCN system in your installation, add the following lines to your `configuration.yaml` file.
You have to specify at least one ip/port with login credentials for a PCHK host.
You have to specify at least one IP/port with login credentials for a PCHK host.
Consider to store your credentials in a [secrets.yaml](/docs/configuration/secrets).
```yaml
@ -127,7 +127,7 @@ connections:
required: true
type: string
name:
description: Optional connection identifier. If omited, the connections will be named consecutively as _pchk_, _pchk1_, _pchk2_, ...
description: Optional connection identifier. If omitted, the connections will be named consecutively as _pchk_, _pchk1_, _pchk2_, ...
required: false
default: pchk
type: string
@ -219,6 +219,10 @@ covers:
description: "Motor port ([MOTOR_PORT](#ports))."
required: true
type: string
reverse_time:
description: "Reverse time ([REVERSE_TIME](#variables-and-units), see also [Cover](#cover))."
required: false
type: string
lights:
description: List of your lights.
@ -329,7 +333,7 @@ Modules can be arranged in _segments_. Segments can be addressed by their numeri
LCN Modules within the _same_ segment can be grouped by their group id (5..254) or 3 (= target all groups.)
The LCN integration allows the connection to more than one hardware coupler. In this case it has to be specified which hardware coupler should be used for addressing the specified module.
The LCN integration allows the connection to more than one hardware coupler. In this case, it has to be specified which hardware coupler should be used for addressing the specified module.
Whenever the address of a module or a group has to be specified, it can be addressed using one of the following syntaxes:
@ -363,12 +367,12 @@ The platforms and service calls use several predefined constants as parameters.
| -------- | ------ |
| OUTPUT_PORT | `output1`, `output2`, `output3`, `output4` |
| RELAY_PORT | `relay1`, `relay2`, `relay3`, `relay4`, `relay5`, `relay6`, `relay7`, `relay8` |
| MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4` |
| MOTOR_PORT | `motor1`, `motor2`, `motor3`, `motor4`, `outputs` |
| LED_PORT | `led1`, `led2`, `led3`, `led4`, `led5`, `led6`, `led7`, `led8`, `led9`, `led10`, `led11`, `led12` |
| LOGICOP_PORT | `logicop1`, `logicop2`, `logicop3`, `logicop4` |
| BINSENSOR_PORT | `binsensor1`, `binsensor2`, `binsensor3`, `binsensor4`, `binsensor5`, `binsensor6`, `binsensor7`, `binsensor8` |
The [MOTOR_PORT](#ports) values specify which hardware relay configuration will be used:
The [MOTOR_PORT](#ports) values specify which hardware relay or outputs configuration will be used:
| Motor | Relay on/off | Relay up/down |
| :------: | :----------: | :-----------: |
@ -377,6 +381,11 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will
| `motor3` | `relay5` | `relay6` |
| `motor4` | `relay7` | `relay8` |
| Motor | Output up | Output down |
| :-------: | :-------: | :---------: |
| `outputs` | `output1` | `output2` |
### Variables and Units
| Constant | Values |
@ -388,6 +397,7 @@ The [MOTOR_PORT](#ports) values specify which hardware relay configuration will
| VAR_UNIT | `native`, `°C`, `°K`, `°F`, `lux_t`, `lux_i`, `m/s`, `%`, `ppm`, `volt`, `ampere`, `degree` |
| TIME_UNIT | `seconds`, `minutes`, `hours`, `days` |
| RELVARREF | `current`, `prog` |
| REVERSE_TIME | `rt70`, `rt600`, `rt1200` |
### States:
@ -417,19 +427,30 @@ The binary sensor can be used in automation scripts or in conjunction with `temp
### Climate
The `lcn` climate platform allows the control of the [LCN](http://www.lcn.eu) climate regulators.
This platform depends on the correct configuration of the module's regulators which has to be done in the LCN-PRO programming software.
This platform depends on the correct configuration of the module's regulators, which has to be done in the LCN-PRO programming software.
You need to specify at least the variable for the current temperature and a setpoint variable for the target temperature.
If the control is set lockable, the regulator can be turned on/off.
<div class='note'>
If you intend to leave the regulation to home assistant, you should consider using the [Generic Thermostat](climate.generic_thermostat) in conjuction with [LCN Sensor](#sensor) and [LCN Switch](#switch).
If you intend to leave the regulation to Home Assistant, you should consider using the [Generic Thermostat](/components/generic_thermostat/) in conjunction with [LCN Sensor](#sensor) and [LCN Switch](#switch).
</div>
### Cover
The `lcn` cover platform allows the control of [LCN](http://www.lcn.eu) relays which have been configured as motor controllers.
The `lcn` cover platform allows the control of [LCN](http://www.lcn.eu) relays and output ports which have been configured as motor controllers.
Only for the module with firmware earlier than 190C:<br>
The configuration allows the optional definition of reverse time. This is the time which is waited during the switching of the motor currents.
The reverse time should only be defined when using the [MOTOR_PORT](#ports) value `OUTPUTS`. For all other configuration, the reverse time has to be defined in the LCN Pro software.
For the reverse time, you may choose one of the following constants: `RT70` (70ms), `RT600` (600ms), `RT1200` (1,2s).
<p class='note'>
If you are using the module's output ports for motor control, ensure that you have configured the output ports as motor controllers in the LCN Pro software!
Otherwise, the output ports are not mutually interlocked and you run the risk of destroying the motor.
</p>
### Light
@ -457,7 +478,7 @@ The sensor can be used in automation scripts or in conjunction with `template` p
<div class='note'>
Ensure that the LCN module is configured properly to provide the requested value.
Otherwise the module might show unexpected behavior or return error messages.
Otherwise, the module might show unexpected behavior or return error messages.
</div>
### Switch
@ -488,7 +509,7 @@ Example:
```yaml
service: output_abs
data:
addres: myhome.0.7
address: myhome.0.7
output: output1
brightness: 100
transition: 0
@ -682,7 +703,7 @@ data:
Send keys (which executes bound commands).
The keys attribute is a string with one or more key identifiers. Example: `a1a5d8`
If `state` is not defined, it is assumed to be `hit`.
The command allow the sending of keys immediately or deferred. For a deferred sendig the attributes `time` and `time_unit` have to be specified. For deferred sending the only key state allowed is `hit`.
The command allows the sending of keys immediately or deferred. For a deferred sending the attributes `time` and `time_unit` have to be specified. For deferred sending, the only key state allowed is `hit`.
If `time_unit` is not defined, it is assumed to be `seconds`.
| Service data attribute | Optional | Description | Values |
@ -717,9 +738,9 @@ data:
### Service `lock_keys`
Locks keys.
If table is not defined, it is assumend to be table `a`.
If the table is not defined, it is assumed to be table `a`.
The key lock states are defined as a string with eight characters. Each character represents the state change of a key lock (1=on, 0=off, t=toggle, -=nochange).
The command allows the locking of keys for a specified time period. For a time period the attributes `time` and `time_unit` have to be specified. For a time period only table `a` is allowed.
The command allows the locking of keys for a specified time period. For a time period, the attributes `time` and `time_unit` have to be specified. For a time period, only table `a` is allowed.
If `time_unit` is not defined, it is assumed to be `seconds`.
| Service data attribute | Optional | Description | Values |

View File

@ -3,6 +3,7 @@ title: "Life360"
description: "Instructions how to use Life360 to track devices in Home Assistant."
logo: life360.png
ha_release: 0.95
ha_config_flow: true
ha_category:
- Presence Detection
ha_iot_class: Cloud Polling

View File

@ -66,12 +66,7 @@ color_temperature_state_address:
required: false
type: string
color_temperature_mode:
description: Color temperature group address data type.
keys:
absolute:
description: color temperature in Kelvin. *color_temperature_address -> DPT 7.600*
relative:
description: color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001*
description: Color temperature group address data type. `absolute` color temperature in Kelvin. *color_temperature_address -> DPT 7.600*. `relative` color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001*
required: false
type: string
default: absolute

View File

@ -109,7 +109,7 @@ effect_value_template:
effect_list:
description: The list of effects the light supports.
required: false
type: string list
type: [string, list]
hs_command_topic:
description: "The MQTT topic to publish commands to change the light's color state in HS format (Hue Saturation).
Range for Hue: 0° .. 360°, Range of Saturation: 0..100.
@ -421,7 +421,7 @@ effect:
effect_list:
description: The list of effects the light supports.
required: false
type: string list
type: [string, list]
flash_time_long:
description: The duration, in seconds, of a “long” flash.
required: false
@ -691,7 +691,7 @@ unique_id:
effect_list:
description: List of possible effects.
required: false
type: string list
type: [string, list]
command_topic:
description: The MQTT topic to publish commands to change the lights state.
required: true
@ -771,6 +771,7 @@ json_attributes_topic:
json_attributes_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/components/sensor.mqtt/#json-attributes-template-configuration) documentation."
required: false
type: template
device:
description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.'
required: false

View File

@ -11,7 +11,7 @@ ha_release: 0.7
The logbook integration provides a different perspective on the history of your
house by showing all the changes that happened to your house in reverse
chronological order. [See the demo for a live example](/demo/). It depends on
chronological order. It depends on
the `recorder` integration for storing the data. This means that if the
[`recorder`](/components/recorder/) integration is set up to use e.g., MySQL or
PostgreSQL as data store, the `logbook` integration does not use the default

View File

@ -57,9 +57,9 @@ logger:
{% configuration %}
default:
description: Default log level.
description: Default log level. See [log_level](#log-levels).
required: false
type: '[log_level](#log-levels)'
type: string
default: debug
logs:
description: List of integrations and their log level.
@ -67,8 +67,8 @@ logger:
type: map
keys:
'&lt;component_namespace&gt;':
description: Logger namespace of the component.
type: '[log_level](#log-levels)'
description: Logger namespace of the component. See [log_level](#log-levels).
type: string
{% endconfiguration %}
### Log Levels

View File

@ -70,7 +70,7 @@ For single-action buttons (scene selection, etc.), `action` will be `single`, an
## Scene
This integration uses keypad programming to identify scenes. Currently, it only works with SeeTouch keypads.
This integration uses keypad programming to identify scenes. Currently, it works with seeTouch, hybrid seeTouch, main repeater, homeowner, and seeTouch RF tabletop keypads.
The Lutron scene platform allows you to control scenes programmed into your SeeTouch keypads.
After setup, scenes will appear in Home Assistant using the area, keypad and button name.

View File

@ -78,17 +78,10 @@ monitored_conditions:
max_breaking_swell:
description: The maximum wave height as the state with a detailed list of forecast attributes.
units:
description: Specify the unit system.
description: Specify the unit system. Either `uk`, `eu` or `us`.
required: false
default: Default to `uk` or `us` based on the temperature preference in Home Assistant.
type: string
keys:
uk:
description: Use UK units.
eu:
description: Use EU units.
us:
description: Use US units.
{% endconfiguration %}
Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api).

View File

@ -65,6 +65,7 @@ disarm_after_trigger:
description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
required: false
type: boolean
default: false
armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered:
description: State specific settings
required: false
@ -213,59 +214,57 @@ Sending a Notification when the Alarm is Armed (Away/Home), Disarmed and in Pend
{% raw %}
```yaml
- alias: 'Send notification when alarm is Disarmed'
initial_state: 'on'
trigger:
- platform: state
entity_id: alarm_control_panel.home_alarm
to: 'disarmed'
action:
- service: notify.notify
data:
message: "ALARM! The alarm is Disarmed at {{ states('sensor.date__time') }}"
data_template:
message: "ALARM! The alarm is Disarmed at {{ states('sensor.date_time') }}"
```
{% endraw %}
{% raw %}
```yaml
- alias: 'Send notification when alarm is in pending status'
initial_state: 'on'
trigger:
- platform: state
entity_id: alarm_control_panel.home_alarm
to: 'pending'
action:
- service: notify.notify
data:
message: "ALARM! The alarm is in pending status at {{ states('sensor.date__time') }}"
data_template:
message: "ALARM! The alarm is in pending status at {{ states('sensor.date_time') }}"
```
{% endraw %}
{% raw %}
```yaml
- alias: 'Send notification when alarm is Armed in Away mode'
initial_state: 'on'
trigger:
- platform: state
entity_id: alarm_control_panel.home_alarm
to: 'armed_away'
action:
- service: notify.notify
data:
message: "ALARM! The alarm is armed in Away mode {{ states('sensor.date__time') }}"
data_template:
message: "ALARM! The alarm is armed in Away mode {{ states('sensor.date_time') }}"
```
{% endraw %}
{% raw %}
```yaml
- alias: 'Send notification when alarm is Armed in Home mode'
initial_state: 'on'
trigger:
- platform: state
entity_id: alarm_control_panel.home_alarm
to: 'armed_home'
action:
- service: notify.notify
data:
message: "ALARM! The alarm is armed in Home mode {{ states('sensor.date__time') }}"
data_template:
# Using multi-line notation allows for easier quoting
message: >
ALARM! The alarm is armed in Home mode {{ states('sensor.date_time') }}
```
{% endraw %}

View File

@ -88,6 +88,7 @@ disarm_after_trigger:
description: If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
required: false
type: boolean
default: false
armed_home/armed_away/armed_night/disarmed/triggered:
description: State specific settings
required: false

View File

@ -24,20 +24,21 @@ To add Met.no to your installation, go to Configuration >> Integrations in the U
name:
description: Manually specify Name.
required: true
type: string
default: Provided by Home Assistant configuration
latitude:
description: Manually specify latitude.
required: true
type: number
type: float
default: Provided by Home Assistant configuration
longitude:
description: Manually specify longitude.
required: true
type: number
type: float
default: Provided by Home Assistant configuration
altitude:
description: Manually specify altitude.
required: false
type: number
type: integer
default: Provided by Home Assistant configuration
{% endconfiguration %}

View File

@ -60,4 +60,4 @@ Then (after a reboot): you can setup the sensor using:
## Calibration
The MH-Z19B version of the sensor has Automatic Baseline Calibration enabled by default, which will calibrate the 400PPM level to the lowest measured PPM in the last 24h cycle. Currently the integration does not allow turning this functionaly off.
The MH-Z19B version of the sensor has Automatic Baseline Calibration enabled by default, which will calibrate the 400PPM level to the lowest measured PPM in the last 24h cycle. Currently the integration does not allow turning this functionality off.

View File

@ -91,6 +91,7 @@ force_update:
description: Sends update events even if the value hasn't changed.
required: false
type: boolean
default: false
median:
description: "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."
required: false
@ -118,7 +119,8 @@ sensor:
- platform: miflora
mac: 'xx:xx:xx:xx:xx:xx'
name: Flower 1
force_up median: 3
force_update: true
median: 3
monitored_conditions:
- moisture
- light

View File

@ -53,6 +53,12 @@ password:
description: The password of the given user account on the MikroTik device.
required: true
type: string
login_method:
description: The login method to use on the MikroTik device. The `plain` method is used by default, if you have an older RouterOS Version than 6.43, use `token` as the login method.
required: false
type: string
options: plain, token
default: plain
port:
description: RouterOS API port.
required: false
@ -69,6 +75,15 @@ method:
type: string
{% endconfiguration %}
<div class='note info'>
As of version 6.43 of RouterOS Mikrotik introduced a new login method (plain) in addition to the old login method (token). With Version 6.45.1 the old token login method got deprecated.
In order to support both login mechanisms, the new config option `login_method` has been introduced. If this option is not set, the component will try to login with the plain method first and the token method if that fails.
That can cause log entries on the router like `login failure for user homeassistant from 192.168.23.10 via api` but doesn't keep the component from working.
To get rid of these entries, set the `login_method` to `plain` for Routers with OS versions > 6.43 or `token` for routers with OS versions < 6.43.
</div>
## Use a certificate
To use SSL to connect to the API (via `api-ssl` instead of `api` service) further configuration is required at RouterOS side. You have to upload or generate a certificate and configure `api-ssl` service to use it. Here is an example of a self-signed certificate:

View File

@ -44,7 +44,7 @@ lines:
products:
description: One or more modes of transport.
required: false
default: all 4 modes ['U-Bahn', 'Tram', 'Bus', 'S-Bahn']
default: all 5 modes ['U-Bahn', 'Tram', 'Bus', 'S-Bahn', 'Nachteule']
type: list
timeoffset:
description: Do not display departures leaving sooner than this number of minutes. Useful if you are a couple of minutes away from the stop.

View File

@ -18,9 +18,12 @@ The `mystrom` light platform allows you to control your [myStrom](https://mystro
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Light](#light)
- [Binary Sensor](#binary-sensor)
- [Setup of myStrom Buttons](#setup-of-mystrom-buttons)
- [Switch](#switch)
- [Setup](#setup)
- [Get the current power consumption](#get-the-current-power-consumption)
## Light
@ -159,7 +162,7 @@ The `mystrom` switch platform allows you to control the state of your [myStrom](
Make sure that you have enabled the REST API under **Advanced** in the web frontend of the switch.
<p class='img'>
<img src='{{site_root}}/images/components/mystrom/mystrom-advanced.png' />
<img src='{{site_root}}/images/components/mystrom/switch-advanced.png' />
</p>
To use your myStrom switch in your installation, add the following to your `configuration.yaml` file:

View File

@ -25,6 +25,17 @@ n26:
password: YOUR_PASSWORD
```
It is possible to add more than one account:
```yaml
# Example configuration.yaml entry
n26:
- username: YOUR_EMAIL1
password: YOUR_PASSWORD1
- username: YOUR_EMAIL2
password: YOUR_PASSWORD2
```
{% configuration %}
username:
description: The account username.

View File

@ -33,6 +33,11 @@ password:
description: Password for the Neato account.
required: true
type: string
vendor:
description: Support for additional vendors. Set to `vorwerk` for Vorwerk robots.
required: false
type: string
default: neato
{% endconfiguration %}
<div class='note'>

View File

@ -60,7 +60,7 @@ password:
required: true
type: string
discovery:
description: Whether to discover Netatmo devices. Set it to False, if you want to choose which Netatmo device you want to add.
description: Whether to discover Netatmo devices automatically. Set it to False, if you want to choose which Netatmo device you want to add. Do not use discovery and manual configuration at the same time.
required: false
type: boolean
default: true

View File

@ -92,7 +92,7 @@ port:
name:
description: Name of the monitored Netdata instance.
required: false
type: number
type: string
default: Netdata
resources:
description: List of details to monitor.

View File

@ -171,6 +171,7 @@ This service can set modem configuration options (otherwise available in the mod
The following automation example processes incoming SMS messages with the [Conversation](/components/conversation/) integration and then deletes the message from the inbox.
{% raw %}
```yaml
automation:
- alias: SMS conversation
@ -186,3 +187,4 @@ automation:
host: '{{ trigger.event.data.host }}'
sms_id: '{{ trigger.event.data.sms_id }}'
```
{% endraw %}

View File

@ -23,34 +23,34 @@ air_quality:
```
{% configuration %}
latitude:
description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration.
required: false
type: number
default: Provided by Home Assistant configuration.
longitude:
description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration.
required: false
type: number
default: Provided by Home Assistant configuration.
name:
description: Name of the sensor to use in the frontend.
required: false
default: NILU
type: string
area:
description: Name of an area to get sensor stations from. See available areas below.
required: exclusive
type: string
stations:
description: Name of a specific station to get measurements from.
required: exclusive
type: string
show_on_map:
description: Option to show the position of the sensor station on the map.
required: false
default: false
type: boolean
latitude:
description: Manually specify latitude. By default, the value will be taken from the Home Assistant configuration.
required: false
type: float
default: Provided by Home Assistant configuration.
longitude:
description: Manually specify longitude. By default, the value will be taken from the Home Assistant configuration.
required: false
type: float
default: Provided by Home Assistant configuration.
name:
description: Name of the sensor to use in the frontend.
required: false
default: NILU
type: string
area:
description: Name of an area to get sensor stations from. See available areas below.
required: exclusive
type: string
stations:
description: Name of a specific station to get measurements from.
required: exclusive
type: string
show_on_map:
description: Option to show the position of the sensor station on the map.
required: false
default: false
type: boolean
{% endconfiguration %}
## Health risk index explainations
@ -59,7 +59,7 @@ Under the attributes from a NILU station, there will be a `nilu pollution index`
### Low
Low or no health risk linked to measured air pollution. Outdoor activites are recommended.
Low or no health risk linked to measured air pollution. Outdoor activities are recommended.
### Moderate

View File

@ -44,9 +44,10 @@ region:
required: true
type: string
nissan_connect:
description: If your car has the updated head unit (NissanConnect rather than Carwings) then the location can be aquired and exposed via a device tracker. If you have Carwings then this should be set to false. The easiest way to identify NissanConnect is if the T&C buttons are orange and blue, for CarWings they're both blue, or just look for anything saying "CarWings" in Settings area of the infotainment system.
description: If your car has the updated head unit (NissanConnect rather than Carwings) then the location can be acquired and exposed via a device tracker. If you have Carwings then this should be set to false. The easiest way to identify NissanConnect is if the T&C buttons are orange and blue, for CarWings they're both blue, or just look for anything saying "CarWings" in Settings area of the infotainment system.
required: false
type: boolean
default: true
update_interval:
description: The interval between updates if the climate control is off and the car is not charging. Set in any time unit (e.g. minutes, hours, days!).
required: false

View File

@ -37,6 +37,6 @@ no_ip:
timeout:
description: Timeout (in seconds) for the API calls.
required: false
type: number
type: integer
default: 10
{% endconfiguration %}

View File

@ -49,13 +49,8 @@ time_zone:
lst_ldt:
description: Local Standard/Local Daylight Time. The time local to the requested station.
unit_system:
description: Specify the unit system.
description: Specify the unit system. Use `metric` (Celsius, meters, cm/s) or `english` (fahrenheit, feet, knots) units.
required: false
default: Defaults to `metric` or `imperial` based on the Home Assistant configuration.
type: string
keys:
metric:
description: Metric (Celsius, meters, cm/s) units.
english:
description: English (fahrenheit, feet, knots) units.
{% endconfiguration %}

View File

@ -31,11 +31,11 @@ forecast:
latitude:
description: Manually specify latitude.
required: false
type: number
type: float
default: Provided by Home Assistant configuration
longitude:
description: Manually specify longitude.
required: false
type: number
type: float
default: Provided by Home Assistant configuration
{% endconfiguration %}

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