jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Paulus Schoutsen 2019-03-13 13:08:49 -07:00
commit d1efccfb25
771 changed files with 1491 additions and 1505 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Rakefile
View File

@ -92,7 +92,7 @@ task :preview, :listen do |t, args|
raise "### You haven't set anything up yet. First run `rake install` to set up an Octopress theme." unless File.directory?(source_dir) 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}" 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") system "compass compile --css-dir #{source_dir}/stylesheets" unless File.exist?("#{source_dir}/stylesheets/screen.css")
jekyllPid = Process.spawn({"OCTOPRESS_ENV"=>"preview"}, "jekyll build --watch --incremental") jekyllPid = Process.spawn({"OCTOPRESS_ENV"=>"preview"}, "jekyll build -t --watch --incremental")
compassPid = Process.spawn("compass watch") compassPid = Process.spawn("compass watch")
rackupPid = Process.spawn("rackup --port #{server_port} --host #{listen_addr}") rackupPid = Process.spawn("rackup --port #{server_port} --host #{listen_addr}")

4
_config.yml
View File

@ -139,8 +139,8 @@ social:
# Home Assistant release details # Home Assistant release details
current_major_version: 0 current_major_version: 0
current_minor_version: 89 current_minor_version: 89
current_patch_version: 0 current_patch_version: 2
date_released: 2019-03-06 date_released: 2019-03-12
# Either # or the anchor link to latest release notes in the blog post. # Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it. # Must be prefixed with a # and have double quotes around it.

57
plugins/filters.rb
View File

@ -70,6 +70,63 @@ module Jekyll
def canonical_url(input) def canonical_url(input)
full_url(input).sub(/index\.\w+$/i, '') full_url(input).sub(/index\.\w+$/i, '')
end end
# Sort an array of semvers
def group_components_by_release(input)
input.group_by { |v|
raise ArgumentError, "ha_release must be set in #{v.basename}" if v["ha_release"].nil?
release_str = v["ha_release"].to_s
if release_str == "pre 0.7"
release_str = "0.7"
end
release_str
}.map{ |v|
version = v[0]
begin
gem_ver = Gem::Version.new(version).to_s
rescue
raise ArgumentError, "Error when parsing ha_release #{version} in #{v.path}."
end
{ "label" => version, "new_components_count" => v[1].count, "sort_key" => gem_ver }
}.sort_by { |v| v["sort_key"] }.reverse.group_by { |v|
version = v["label"]
split_ver = version.split('.')
major = split_ver[0]
minor = split_ver[1]
if minor.length == 1
"#{major}.X"
else
"#{major}.#{minor[0]}X"
end
}.map { |v|
sort_key = v[1][-1]["sort_key"]
if v[0] == "0.X"
sort_key = "0.01" # Ensure 0.X is always sorted at bottom.
end
total_new_components = 0
v[1].each do |vers|
total_new_components += vers["new_components_count"]
end
{ "label" => v[0], "versions" => v[1], "new_components_count" => total_new_components, "sort_key" => sort_key }
}.sort_by { |v| v["sort_key"] }.reverse
end
# Get version N behind current
# input is output of group_components_by_release
def version_behind(input, n)
input.each do |group|
if group["versions"].length > n
return group["versions"][n]
end
end
end
end end
end end

28
sass/custom/_component_page.scss
View File

@ -1,11 +1,11 @@
#components-page{ #components-page{
.component-search{ .component-search{
margin-bottom: 24px; margin-bottom: 24px;
input{ input{
width: 100%; width: 100%;
padding: 10px; padding: 10px;
background-color: #fefefe; background-color: #fefefe;
border-radius: 2px; border-radius: 2px;
border: 1px solid; border: 1px solid;
@ -50,12 +50,12 @@
margin: 12px 0; margin: 12px 0;
} }
.added_in_current_version { .version_select {
margin-top: 12px; margin: 12px 0 12px 0;
} }
.added_two_versions_ago { .version_select > select {
margin-bottom: 12px; width: 100%;
} }
.btn { .btn {
@ -76,18 +76,18 @@
// styles for the cards // styles for the cards
.hass-option-cards { .hass-option-cards {
display: -ms-flexbox; display: -ms-flexbox;
display: -webkit-box; display: -webkit-box;
display: -webkit-flexbox; display: -webkit-flexbox;
display: -webkit-flex; display: -webkit-flex;
display: flex; display: flex;
flex-direction: row; flex-direction: row;
flex-wrap: wrap; flex-wrap: wrap;
justify-content: flex-start; justify-content: flex-start;
align-items: flex-start; align-items: flex-start;
margin: -4px; // grid trick, has to match option-card's margin margin: -4px; // grid trick, has to match option-card's margin
p.note{ p.note{
width: 100%; width: 100%;
} }
@ -139,7 +139,7 @@
color: #AAA; color: #AAA;
} }
} }
// fade-in animation // fade-in animation
&.show-items .option-card{ &.show-items .option-card{
opacity:0; opacity:0;
@ -147,7 +147,7 @@
-o-animation:new-item-animation .2s linear forwards; -o-animation:new-item-animation .2s linear forwards;
animation:new-item-animation .2s linear forwards; animation:new-item-animation .2s linear forwards;
} }
// fade-out animation // fade-out animation
&.remove-items .option-card{ &.remove-items .option-card{
-webkit-animation:removed-item-animation .2s cubic-bezier(.55,-0.04,.91,.94) forwards; -webkit-animation:removed-item-animation .2s cubic-bezier(.55,-0.04,.91,.94) forwards;

12
source/_addons/duckdns.markdown
View File

@ -69,3 +69,15 @@ You'll need to forward the port you listed in your configuration (8123 in the ex
Ensure that you allocate the Home Assistant system a fixed IP on your network before you configure port forwarding. You can do this either on the computer itself (see the [install guide](/hassio/installation/) or via a static lease on your router. Ensure that you allocate the Home Assistant system a fixed IP on your network before you configure port forwarding. You can do this either on the computer itself (see the [install guide](/hassio/installation/) or via a static lease on your router.
Restart Home Assistant for the configured changes to take effect. When you access the Home Assistant frontend you will now need to use `https`, even when accessing local instances, for example at `https://192.168.0.1:8123`. Restart Home Assistant for the configured changes to take effect. When you access the Home Assistant frontend you will now need to use `https`, even when accessing local instances, for example at `https://192.168.0.1:8123`.
## {% linkable_title Generate Let's Encrypt certificate for Duck DNS sub sub domains %}
To generate certificates for nr.my-domain.duckdns.org update the domain JSON settings to:
```json
{
...
"domains": ["my-domain.duckdns.org","*.my-domain.duckdns.org"],
...
}
```

3
source/_addons/lets_encrypt.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
featured: false
--- ---
<p class='note'> <p class='note'>
@ -79,7 +78,7 @@ Use this in your `automations.yaml` to attempt certificate renewal each day at m
addon: core_letsencrypt addon: core_letsencrypt
``` ```
If you are using the [Nginx Proxy add-on] you will need need to stop this during the renewal process. This can be achieved by stopping the add-on whilst restarting the Let's Encrypt add-on. This can be achieved the following configuration: If you are using the [Nginx Proxy add-on] you will need need to stop this during the renewal process. This can be achieved by stopping the add-on whilst restarting the Let's Encrypt add-on. This can be achieved the following configuration:
```yaml ```yaml
- id: letsencrypt-renewal - id: letsencrypt-renewal

3
source/_addons/tellstick.markdown
View File

@ -7,7 +7,6 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
featured: false
--- ---
Setting up the [Tellstick](http://telldus.com) service and tools contained in the [telldus-core](http://developer.telldus.com/) package and adding configuration to enable Tellstick and Tellstick Duo to work on your Hass.io. Setting up the [Tellstick](http://telldus.com) service and tools contained in the [telldus-core](http://developer.telldus.com/) package and adding configuration to enable Tellstick and Tellstick Duo to work on your Hass.io.
@ -109,7 +108,7 @@ Replace `1` with the corresponding ID of the device in your TellStick configurat
You can also use this to list devices or sensors and read the output in the add-on log: You can also use this to list devices or sensors and read the output in the add-on log:
`{"addon":"core_tellstick","input":{"function":"list-sensors"}}` `{"addon":"core_tellstick","input":{"function":"list-sensors"}}`
### {% linkable_title Supported service commands %} ### {% linkable_title Supported service commands %}
- `"function":"list"`: List currently configured devices with name and device id and all discovered sensors. - `"function":"list"`: List currently configured devices with name and device id and all discovered sensors.

4
source/_components/abode.markdown
View File

@ -19,7 +19,7 @@ ha_category:
- Sensor - Sensor
- Switch - Switch
ha_release: 0.52 ha_release: 0.52
ha_iot_class: "Cloud Push" ha_iot_class: Cloud Push
redirect_from: redirect_from:
- /components/alarm_control_panel.abode/ - /components/alarm_control_panel.abode/
- /components/binary_sensor.abode/ - /components/binary_sensor.abode/
@ -171,4 +171,4 @@ This component will automatically add `Lights` configured in your Abode account.
This component will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration). This component will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration).
This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations. This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations.

6
source/_components/ads.markdown
View File

@ -15,7 +15,7 @@ ha_category:
- Sensor - Sensor
- Switch - Switch
ha_release: "0.60" ha_release: "0.60"
ha_iot_class: "Local Push" ha_iot_class: Local Push
redirect_from: redirect_from:
- /components/binary_sensor.ads/ - /components/binary_sensor.ads/
- /components/light.ads/ - /components/light.ads/
@ -49,7 +49,7 @@ device:
required: true required: true
type: string type: string
port: port:
description: The port that runs the AMS server on the device, typically this would be 801 or 851. description: The port that runs the AMS server on the device, typically this would be 801 or 851.
required: true required: true
type: integer type: integer
ip_address: ip_address:
@ -137,7 +137,7 @@ name:
## {% linkable_title Sensor %} ## {% linkable_title Sensor %}
The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*, *BYTE*, *DINT* or *UDINT*. The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*, *BYTE*, *DINT* or *UDINT*.
To use your ADS device, you first have to set up your [ADS hub](/components/ads/) and then add the following to your `configuration.yaml` To use your ADS device, you first have to set up your [ADS hub](/components/ads/) and then add the following to your `configuration.yaml`
file: file:

1
source/_components/air_quality.markdown
View File

@ -8,6 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
redirect_from: /components/air_pollutants/ redirect_from: /components/air_pollutants/
ha_release: 0.85
--- ---
The `air_quality` gather information about the air quality and pollution details. The `air_quality` gather information about the air quality and pollution details.

14
source/_components/air_quality.nilu.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: nilu_logo.png logo: nilu_logo.png
ha_category: Health ha_category: Health
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
ha_release: 0.87 ha_release: 0.87
--- ---
@ -45,7 +45,7 @@ air_quality:
description: Name of an area to get sensor stations from. See available areas below. description: Name of an area to get sensor stations from. See available areas below.
required: exclusive required: exclusive
type: string type: string
stations: stations:
description: Name of a specific station to get measurements from. description: Name of a specific station to get measurements from.
required: exclusive required: exclusive
type: string type: string
@ -58,11 +58,11 @@ air_quality:
## {% linkable_title Health risk index explainations %} ## {% linkable_title Health risk index explainations %}
Under the attributes from a NILU station, there will be a `nilu pollution index`. This indicates how polluted the air is in the area around the sensor station. Following is a longer explanation of what the indexes mean. Under the attributes from a NILU station, there will be a `nilu pollution index`. This indicates how polluted the air is in the area around the sensor station. Following is a longer explanation of what the indexes mean.
### {% linkable_title Low %} ### {% linkable_title 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 activites are recommended.
### {% linkable_title Moderate %} ### {% linkable_title Moderate %}
@ -74,7 +74,7 @@ Health effects may occur in asthmatics and people with other respiratory disease
### {% linkable_title Extremely high %} ### {% linkable_title Extremely high %}
Sensitive groups in the population can have health effects. Respiratory irritation and discomfort may occur in healthy subjects. People with heart or respiratory distress should reduce outdoor activity and not stay in the most polluted areas. Sensitive groups in the population can have health effects. Respiratory irritation and discomfort may occur in healthy subjects. People with heart or respiratory distress should reduce outdoor activity and not stay in the most polluted areas.
Source: [Explainations in Norwegian](http://www.luftkvalitet.info/home/Varslingsklasser.aspx) Source: [Explainations in Norwegian](http://www.luftkvalitet.info/home/Varslingsklasser.aspx)
@ -147,7 +147,7 @@ Example of a specific station.
# Monitors stations 'Alnabru' # Monitors stations 'Alnabru'
air_quality: air_quality:
- platform: nilu - platform: nilu
stations: stations:
- Alnabru - Alnabru
``` ```
@ -156,7 +156,7 @@ Example of getting stations from a specified area, giving the sensors a custom n
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
# Stations from specific area, 'Bergen' # Stations from specific area, 'Bergen'
# Custom name for the sensors. # Custom name for the sensors.
air_quality: air_quality:
- platform: nilu - platform: nilu
area: Bergen area: Bergen

2
source/_components/air_quality.opensensemap.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: opensensemap.png logo: opensensemap.png
ha_category: Health ha_category: Health
ha_release: 0.85 ha_release: 0.85
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
redirect_from: /components/air_pollutants.opensensemap/ redirect_from: /components/air_pollutants.opensensemap/
--- ---

1
source/_components/alarm_control_panel.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_release: 0.7.3
--- ---
Home Assistant can give you an interface with is similar to a classic alarm system. There are several panels supported: Home Assistant can give you an interface with is similar to a classic alarm system. There are several panels supported:

2
source/_components/alarm_control_panel.mqtt.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: mqtt.png logo: mqtt.png
ha_category: Alarm ha_category: Alarm
ha_release: 0.7.4 ha_release: 0.7.4
ha_iot_class: depends ha_iot_class: Configurable
--- ---
The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`. The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`.

2
source/_components/alarmdecoder.markdown
View File

@ -13,7 +13,7 @@ ha_category:
- Binary Sensor - Binary Sensor
- Sensor - Sensor
ha_release: 0.43 ha_release: 0.43
ha_iot_class: "Local Push" ha_iot_class: Local Push
redirect_from: redirect_from:
- /components/alarm_control_panel.alarmdecoder/ - /components/alarm_control_panel.alarmdecoder/
- /components/binary_sensor.alarmdecoder/ - /components/binary_sensor.alarmdecoder/

2
source/_components/alexa.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: amazon-echo.png logo: amazon-echo.png
ha_category: Voice ha_category: Voice
featured: true featured: true
ha_release: '0.10' ha_release: "0.10"
--- ---
## {% linkable_title Automatic setup via Home Assistant Cloud %} ## {% linkable_title Automatic setup via Home Assistant Cloud %}

4
source/_components/ambient_station.markdown
View File

@ -7,8 +7,8 @@ sidebar: true
comments: false comments: false
logo: ambient_weather.png logo: ambient_weather.png
ha_category: Weather ha_category: Weather
ha_release: "0.85" ha_release: 0.85
ha_iot_class: "Cloud Push" ha_iot_class: Cloud Push
redirect_from: redirect_from:
- /components/sensor.ambient_station/ - /components/sensor.ambient_station/
--- ---

4
source/_components/amcrest.markdown
View File

@ -13,7 +13,7 @@ ha_category:
- Camera - Camera
- Sensor - Sensor
- Switch - Switch
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.49 ha_release: 0.49
redirect_from: redirect_from:
- /components/camera.amcrest/ - /components/camera.amcrest/
@ -207,4 +207,4 @@ Switches will be configured automatically. Please refer to the [component](/comp
<p class='note warning'> <p class='note warning'>
In previous versions, switch devices in setups with multiple cameras, would not have specific entity ID causing them to change randomly after each Home Assistant restart. The current version adds the name of the camera at the end of the switch entity ID, making it more specific and consistent and causes the name option to be required in a multi-camera system. This behavior matches the sensor behavior of the Amcrest component. Because of this, older automations may require updates to the entity ID. In previous versions, switch devices in setups with multiple cameras, would not have specific entity ID causing them to change randomly after each Home Assistant restart. The current version adds the name of the camera at the end of the switch entity ID, making it more specific and consistent and causes the name option to be required in a multi-camera system. This behavior matches the sensor behavior of the Amcrest component. Because of this, older automations may require updates to the entity ID.
</p> </p>

4
source/_components/android_ip_webcam.markdown
View File

@ -15,7 +15,7 @@ ha_category:
- Sensor - Sensor
- Switch - Switch
ha_release: "0.40" ha_release: "0.40"
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
redirect_from: redirect_from:
- /components/binary_sensor.android_ip_webcam/ - /components/binary_sensor.android_ip_webcam/
- /components/camera.android_ip_webcam/ - /components/camera.android_ip_webcam/
@ -210,4 +210,4 @@ camera:
The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically. The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
You can setup your own sensors by examining the JSON file from the webcam server: http://IP:8080/sensors.json You can setup your own sensors by examining the JSON file from the webcam server: http://IP:8080/sensors.json

2
source/_components/apcupsd.markdown
View File

@ -13,7 +13,7 @@ ha_category:
- Binary Sensor - Binary Sensor
- Sensor - Sensor
ha_release: 0.13 ha_release: 0.13
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
redirect_from: redirect_from:
- /components/binary_sensor.apcupsd/ - /components/binary_sensor.apcupsd/
- /components/sensor.apcupsd/ - /components/sensor.apcupsd/

1
source/_components/api.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: "Other" ha_category: "Other"
ha_qa_scale: internal ha_qa_scale: internal
ha_release: 0.7
--- ---
The `api` component exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/). The `api` component exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/).

4
source/_components/apple_tv.markdown
View File

@ -12,7 +12,7 @@ ha_category:
- Multimedia - Multimedia
- Media Player - Media Player
- Remote - Remote
ha_iot_class: "Local Push" ha_iot_class: Local Push
ha_release: 0.49 ha_release: 0.49
redirect_from: redirect_from:
- /components/media_player.apple_tv/ - /components/media_player.apple_tv/
@ -197,4 +197,4 @@ data:
- left - left
- menu - menu
- select - select
``` ```

4
source/_components/aqualogic.markdown
View File

@ -13,7 +13,7 @@ ha_category:
- Sensor - Sensor
- Switch - Switch
ha_release: "0.80" ha_release: "0.80"
ha_iot_class: "Local Push" ha_iot_class: Local Push
redirect_from: redirect_from:
- /components/sensor.aqualogic/ - /components/sensor.aqualogic/
- /components/switch.aqualogic/ - /components/switch.aqualogic/
@ -127,4 +127,4 @@ monitored_conditions:
description: Controls the Aux 6 relay. description: Controls the Aux 6 relay.
aux_7: aux_7:
description: Controls the Aux 7 relay. description: Controls the Aux 7 relay.
{% endconfiguration %} {% endconfiguration %}

2
source/_components/arduino.markdown
View File

@ -11,7 +11,7 @@ logo: arduino.png
ha_category: DIY ha_category: DIY
featured: true featured: true
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection. The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection.

2
source/_components/arlo.markdown
View File

@ -14,7 +14,7 @@ ha_category:
- Camera - Camera
- Sensor - Sensor
ha_release: 0.46 ha_release: 0.46
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
redirect_from: redirect_from:
- /components/alarm_control_panel.arlo/ - /components/alarm_control_panel.arlo/
- /components/camera.arlo/ - /components/camera.arlo/

2
source/_components/asterisk_mbox.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: asterisk.png logo: asterisk.png
ha_category: Mailbox ha_category: Mailbox
ha_iot_class: "Local Push" ha_iot_class: Local Push
ha_release: 0.51 ha_release: 0.51
redirect_from: redirect_from:
- /components/mailbox.asterisk_mbox/ - /components/mailbox.asterisk_mbox/

10
source/_components/asuswrt.markdown
View File

@ -13,7 +13,7 @@ ha_category:
- Presence Detection - Presence Detection
- Sensor - Sensor
ha_release: 0.83 ha_release: 0.83
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
redirect_from: redirect_from:
- /components/device_tracker.asuswrt/ - /components/device_tracker.asuswrt/
- /components/sensor.asuswrt/ - /components/sensor.asuswrt/
@ -128,21 +128,21 @@ Follow these steps to setup the link.
2. Run the following command to find the file: 2. Run the following command to find the file:
```bash ```bash
$ find / -name "dnsmasq.leases" $ find / -name "dnsmasq.leases"
``` ```
3. Copy or remember the full path of, example: `/tmp/dnsmasq.leases` 3. Copy or remember the full path of, example: `/tmp/dnsmasq.leases`
4. Create the folder if it does not exist: 4. Create the folder if it does not exist:
```bash ```bash
$ mkdir -p /var/lib/misc $ mkdir -p /var/lib/misc
``` ```
5. Add the linking process to the routers started script (one line): 5. Add the linking process to the routers started script (one line):
```bash ```bash
$ echo "/bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases" >> /etc/storage/started_script.sh $ echo "/bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases" >> /etc/storage/started_script.sh
``` ```
6. Reboot the router or link the file: 6. Reboot the router or link the file:
```bash ```bash
$ /bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases $ /bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases

6
source/_components/august.markdown
View File

@ -13,8 +13,8 @@ ha_category:
- Binary Sensor - Binary Sensor
- Camera - Camera
- Lock - Lock
ha_release: "0.64" ha_release: 0.64
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
redirect_from: redirect_from:
- /components/binary_sensor.august/ - /components/binary_sensor.august/
- /components/camera.august/ - /components/camera.august/
@ -84,4 +84,4 @@ If you have August Smart Lock with DoorSense, once you have enabled the August c
### {% linkable_title Camera %} ### {% linkable_title Camera %}
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant. The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant.

5
source/_components/automation.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Automation ha_category: Automation
ha_qa_scale: internal ha_qa_scale: internal
ha_release: 0.7
--- ---
Please see the [docs section](/docs/automation/) for in-depth Please see the [docs section](/docs/automation/) for in-depth
@ -24,14 +25,14 @@ Starting with 0.28 your automation rules can be controlled with the frontend.
This allows one to reload the automation without restarting Home Assistant This allows one to reload the automation without restarting Home Assistant
itself. If you don't want to see the automation rule in your frontend use itself. If you don't want to see the automation rule in your frontend use
`hide_entity: true` to hide it. `hide_entity: true` to hide it.
You can also use `initial_state: 'off'` so that the automation You can also use `initial_state: 'false'` so that the automation
is not automatically turned on after a Home Assistant reboot. is not automatically turned on after a Home Assistant reboot.
```yaml ```yaml
automation: automation:
- alias: Door alarm - alias: Door alarm
hide_entity: true hide_entity: true
initial_state: 'off' initial_state: 'true'
trigger: trigger:
- platform: state - platform: state
... ...

4
source/_components/axis.markdown
View File

@ -11,8 +11,8 @@ logo: axis.png
ha_category: ha_category:
- Camera - Camera
- Binary Sensor - Binary Sensor
ha_release: "0.45" ha_release: 0.45
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
redirect_from: redirect_from:
- /components/binary_sensor.axis/ - /components/binary_sensor.axis/
- /components/camera.axis/ - /components/camera.axis/

6
source/_components/bbb_gpio.markdown
View File

@ -13,7 +13,7 @@ ha_category:
- Binary Sensor - Binary Sensor
- Switch - Switch
ha_release: 0.36 ha_release: 0.36
ha_iot_class: "Local Push" ha_iot_class: Local Push
redirect_from: redirect_from:
- /components/binary_sensor.bbb_gpio/ - /components/binary_sensor.bbb_gpio/
- /components/switch.bbb_gpio/ - /components/switch.bbb_gpio/
@ -70,7 +70,7 @@ pins:
description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor. description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
required: false required: false
type: string type: string
default: UP default: UP
{% endconfiguration %} {% endconfiguration %}
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.
@ -121,4 +121,4 @@ pins:
type: boolean type: boolean
{% endconfiguration %} {% endconfiguration %}
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.

2
source/_components/binary_sensor.arest.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: arest.png logo: arest.png
ha_category: DIY ha_category: DIY
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.9 ha_release: 0.9
--- ---

6
source/_components/binary_sensor.bayesian.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Utility ha_category: Utility
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.53 ha_release: 0.53
ha_qa_scale: internal ha_qa_scale: internal
--- ---
@ -71,7 +71,7 @@ observations:
value_template: value_template:
description: Defines the template to be used. description: Defines the template to be used.
required: true (for `template`) required: true (for `template`)
type: template type: template
prob_given_true: prob_given_true:
description: The probability of the observation occurring, given the event is `true`. description: The probability of the observation occurring, given the event is `true`.
required: true required: true
@ -84,7 +84,7 @@ observations:
to_state: to_state:
description: The target state. description: The target state.
required: true (for `state`) required: true (for `state`)
type: string type: string
{% endconfiguration %} {% endconfiguration %}
## {% linkable_title Full examples %} ## {% linkable_title Full examples %}

2
source/_components/binary_sensor.command_line.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: command_line.png logo: command_line.png
ha_category: Utility ha_category: Utility
ha_release: 0.12 ha_release: 0.12
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `command_line` binary sensor platform issues specific commands to get data. The `command_line` binary sensor platform issues specific commands to get data.

6
source/_components/binary_sensor.flic.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: flic.png logo: flic.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_iot_class: "Local Push" ha_iot_class: Local Push
ha_release: 0.35 ha_release: 0.35
--- ---
@ -52,7 +52,7 @@ discovery:
ignored_click_types: ignored_click_types:
description: List of click types whose occurrence should not trigger a `flic_click` event. Click types are `single`, `double`, and `hold`. description: List of click types whose occurrence should not trigger a `flic_click` event. Click types are `single`, `double`, and `hold`.
required: false required: false
type: list type: list
timeout: timeout:
description: The maximum time in seconds an event can be queued locally on a button before discarding the event. description: The maximum time in seconds an event can be queued locally on a button before discarding the event.
required: false required: false
@ -105,7 +105,7 @@ automation:
event_type: flic_click event_type: flic_click
action: action:
- service_template: notify.html5 - service_template: notify.html5
data_template: data_template:
title: "flic click" title: "flic click"
message: {% raw %}"flic {{ trigger.event.data.button_name }} was {{ trigger.event.data.click_type }} clicked"{% endraw %} message: {% raw %}"flic {{ trigger.event.data.button_name }} was {{ trigger.event.data.click_type }} clicked"{% endraw %}
``` ```

2
source/_components/binary_sensor.hikvision.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: hikvision.png logo: hikvision.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.35 ha_release: 0.35
ha_iot_class: "Local Push" ha_iot_class: Local Push
--- ---
The Hikvision Binary Sensor is a platform that parses the event stream of a The Hikvision Binary Sensor is a platform that parses the event stream of a

2
source/_components/binary_sensor.ihc.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: ihc.png logo: ihc.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.62 ha_release: 0.62
ha_iot_class: "Local Push" ha_iot_class: Local Push
--- ---
Before you can use the IHC Binary Sensor platform, Before you can use the IHC Binary Sensor platform,

2
source/_components/binary_sensor.knx.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: knx.png logo: knx.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.24 ha_release: 0.24
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors. The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors.

1
source/_components/binary_sensor.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_release: 0.9
--- ---
Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality. Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality.

2
source/_components/binary_sensor.modbus.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: modbus.png logo: modbus.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.28 ha_release: 0.28
ha_iot_class: "Local Push" ha_iot_class: Local Push
--- ---
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils. The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.

2
source/_components/binary_sensor.mqtt.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: mqtt.png logo: mqtt.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.9 ha_release: 0.9
ha_iot_class: "depends" ha_iot_class: Configurable
--- ---
The `mqtt` binary sensor platform uses an MQTT message payload to set the binary sensor to one of two states: `on` or `off`. The `mqtt` binary sensor platform uses an MQTT message payload to set the binary sensor to one of two states: `on` or `off`.

4
source/_components/binary_sensor.mysensors.markdown
View File

@ -8,11 +8,11 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: mysensors.png logo: mysensors.png
ha_category: ha_category:
- DIY - DIY
- Binary Sensor - Binary Sensor
ha_release: 0.14 ha_release: 0.14
ha_iot_class: "Local Push" ha_iot_class: Local Push
--- ---
Integrates MySensors binary sensors into Home Assistant. See the [main component] for configuration instructions. Integrates MySensors binary sensors into Home Assistant. See the [main component] for configuration instructions.

2
source/_components/binary_sensor.mystrom.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: mystrom.png logo: mystrom.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.45 ha_release: 0.45
--- ---

2
source/_components/binary_sensor.nx584.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: networx.png logo: networx.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_iot_class: "Local Push" ha_iot_class: Local Push
ha_release: 0.14 ha_release: 0.14
--- ---

4
source/_components/binary_sensor.raincloud.markdown
View File

@ -9,8 +9,8 @@ sharing: true
footer: true footer: true
logo: raincloud.jpg logo: raincloud.jpg
ha_category: Irrigation ha_category: Irrigation
ha_release: "0.55" ha_release: 0.55
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
--- ---
To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud).

2
source/_components/binary_sensor.random.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Utility ha_category: Utility
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.57 ha_release: 0.57
ha_qa_scale: internal ha_qa_scale: internal
--- ---

2
source/_components/binary_sensor.rest.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: restful.png logo: restful.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: "0.10" ha_release: "0.10"
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `rest` binary sensor platform is consuming a given endpoint which is exposed The `rest` binary sensor platform is consuming a given endpoint which is exposed

4
source/_components/binary_sensor.rflink.markdown
View File

@ -9,8 +9,8 @@ sharing: true
footer: true footer: true
logo: rflink.png logo: rflink.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_iot_class: "Local Push" ha_iot_class: Local Push
ha_release: "0.81" ha_release: 0.81
--- ---
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).

1
source/_components/binary_sensor.rfxtrx.markdown
View File

@ -9,6 +9,7 @@ sharing: true
footer: true footer: true
logo: rfxtrx.png logo: rfxtrx.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.48
--- ---
The `rfxtrx` platform support binary sensors that The `rfxtrx` platform support binary sensors that

2
source/_components/binary_sensor.rpi_pfio.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: DIY ha_category: DIY
ha_release: 0.45 ha_release: 0.45
ha_iot_class: "Local Push" ha_iot_class: Local Push
--- ---
The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) . The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) .

3
source/_components/binary_sensor.tapsaff.markdown
View File

@ -9,9 +9,8 @@ sharing: true
footer: true footer: true
logo: tapsaff.png logo: tapsaff.png
ha_category: Weather ha_category: Weather
featured: false
ha_release: 0.47 ha_release: 0.47
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](http://www.taps-aff.co.uk). The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](http://www.taps-aff.co.uk).

2
source/_components/binary_sensor.template.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.12 ha_release: 0.12
ha_iot_class: "Local Push" ha_iot_class: Local Push
logo: home-assistant.png logo: home-assistant.png
ha_qa_scale: internal ha_qa_scale: internal
--- ---

2
source/_components/binary_sensor.threshold.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Utility ha_category: Utility
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.34 ha_release: 0.34
ha_qa_scale: internal ha_qa_scale: internal
--- ---

7
source/_components/binary_sensor.tod.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.89 ha_release: 0.89
ha_iot_class: "Local Push" ha_iot_class: Local Push
logo: home-assistant.png logo: home-assistant.png
ha_qa_scale: internal ha_qa_scale: internal
--- ---
@ -32,6 +32,11 @@ binary_sensor:
after: sunrise after: sunrise
after_offset: '-02:00' after_offset: '-02:00'
before: '07:00' before: '07:00'
- platform: tod
name: Late Morning
after: '10:00'
before: '12:00'
``` ```
{% configuration %} {% configuration %}

2
source/_components/binary_sensor.trend.markdown
View File

@ -10,7 +10,7 @@ footer: true
ha_category: Utility ha_category: Utility
logo: home-assistant.png logo: home-assistant.png
ha_release: 0.28 ha_release: 0.28
ha_iot_class: "Local Push" ha_iot_class: Local Push
ha_qa_scale: internal ha_qa_scale: internal
--- ---

4
source/_components/binary_sensor.uptimerobot.markdown
View File

@ -9,8 +9,8 @@ sharing: true
footer: true footer: true
logo: uptimerobot.png logo: uptimerobot.png
ha_category: System Monitor ha_category: System Monitor
ha_release: "0.72" ha_release: 0.72
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
--- ---
The `uptimerobot` binary sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com). The `uptimerobot` binary sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com).

2
source/_components/binary_sensor.workday.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Utility ha_category: Utility
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.41 ha_release: 0.41
ha_qa_scale: internal ha_qa_scale: internal
--- ---

2
source/_components/binary_sensor.xiaomi_aqara.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: xiaomi.png logo: xiaomi.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: "0.50" ha_release: "0.50"
ha_iot_class: "Local Push" ha_iot_class: Local Push
--- ---
The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors. The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors.

2
source/_components/binary_sensor.zigbee.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: zigbee.png logo: zigbee.png
ha_category: Binary Sensor ha_category: Binary Sensor
ha_release: 0.12 ha_release: 0.12
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
A `zigbee` binary sensor in this context is a device connected to one of the digital input pins on a [Zigbee](http://www.zigbee.org/) module. The states reported by such a device are limited to `on` or `off`. By default, a binary sensor is considered `on` when the Zigbee device's digital input pin is held 'high' and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`. A `zigbee` binary sensor in this context is a device connected to one of the digital input pins on a [Zigbee](http://www.zigbee.org/) module. The states reported by such a device are limited to `on` or `off`. By default, a binary sensor is considered `on` when the Zigbee device's digital input pin is held 'high' and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`.

4
source/_components/blink.markdown
View File

@ -15,8 +15,8 @@ ha_category:
- Camera - Camera
- Sensor - Sensor
ha_release: "0.40" ha_release: "0.40"
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
redirect_form: redirect_from:
- /components/alarm_control_panel.blink/ - /components/alarm_control_panel.blink/
- /components/binary_sensor.blink/ - /components/binary_sensor.blink/
- /components/camera.blink/ - /components/camera.blink/

4
source/_components/bloomsky.markdown
View File

@ -14,7 +14,7 @@ ha_category:
- Camera - Camera
- Sensor - Sensor
ha_release: 0.14 ha_release: 0.14
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
redirect_from: redirect_from:
- /components/binary_sensor.bloomsky/ - /components/binary_sensor.bloomsky/
--- ---
@ -134,4 +134,4 @@ monitored_conditions:
description: Voltage description: Voltage
{% endconfiguration %} {% endconfiguration %}
More conditions are available using the [BloomSky binary sensor](#binary-sensor) component. More conditions are available using the [BloomSky binary sensor](#binary-sensor) component.

1
source/_components/browser.markdown
View File

@ -10,6 +10,7 @@ footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Utility ha_category: Utility
ha_qa_scale: internal ha_qa_scale: internal
ha_release: pre 0.7
--- ---
The `browser` component provides a service to open URLs in the default browser on the host machine. The `browser` component provides a service to open URLs in the default browser on the host machine.

2
source/_components/calendar.caldav.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: Calendar ha_category: Calendar
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
ha_release: "0.60" ha_release: "0.60"
--- ---

4
source/_components/calendar.google.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: google_calendar.png logo: google_calendar.png
ha_category: Calendar ha_category: Calendar
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
ha_release: 0.33 ha_release: 0.33
--- ---
@ -131,7 +131,7 @@ entities:
offset: offset:
description: > description: >
A set of characters that precede a number in the event title A set of characters that precede a number in the event title
for designating a pre-trigger state change on the sensor. for designating a pre-trigger state change on the sensor.
This should be in the format of HH:MM or MM. This should be in the format of HH:MM or MM.
required: false required: false
type: string type: string

1
source/_components/calendar.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_release: 0.33
--- ---
The calendar component allows you to integrate your calendars into Home Assistant. The calendar component allows you to integrate your calendars into Home Assistant.

6
source/_components/calendar.todoist.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: todoist.png logo: todoist.png
ha_category: Calendar ha_category: Calendar
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
ha_release: 0.54 ha_release: 0.54
--- ---
@ -161,8 +161,8 @@ Here are two example JSON payloads resulting in the same task:
- **due_date_string** (*Optional*): When the task should be due, in [natural language](https://support.todoist.com/hc/en-us/articles/205325931-Dates-and-Times). Mutually exclusive with `due_date` - **due_date_string** (*Optional*): When the task should be due, in [natural language](https://support.todoist.com/hc/en-us/articles/205325931-Dates-and-Times). Mutually exclusive with `due_date`
- **due_date_lang** (*Optional*): When `due_date_string` is set, it is posisble to set the language. - **due_date_lang** (*Optional*): When `due_date_string` is set, it is posisble to set the language.
Valid languages are: `en`, `da`, `pl`, `zh`, `ko`, `de`, `pt`, `ja`, `it`, `fr`, `sv`, `ru`, `es`, `nl` Valid languages are: `en`, `da`, `pl`, `zh`, `ko`, `de`, `pt`, `ja`, `it`, `fr`, `sv`, `ru`, `es`, `nl`
- **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format. Mutually exclusive with `due_date_string`. - **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format. Mutually exclusive with `due_date_string`.

2
source/_components/camera.dispatcher.markdown
View File

@ -10,7 +10,7 @@ footer: true
ha_category: Camera ha_category: Camera
logo: camcorder.png logo: camcorder.png
ha_release: "0.40" ha_release: "0.40"
ha_iot_class: "depends" ha_iot_class: Configurable
--- ---
<p class='note'> <p class='note'>

2
source/_components/camera.familyhub.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: familyhub.png logo: familyhub.png
ha_category: Camera ha_category: Camera
ha_release: "0.70" ha_release: "0.70"
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `familyhub` platform allows you to get images of the inside of your [Samsung Family Hub refrigerator](https://www.samsung.com/us/explore/family-hub-refrigerator/connected-hub/) in Home Assistant. The `familyhub` platform allows you to get images of the inside of your [Samsung Family Hub refrigerator](https://www.samsung.com/us/explore/family-hub-refrigerator/connected-hub/) in Home Assistant.

2
source/_components/camera.ffmpeg.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: ffmpeg.png logo: ffmpeg.png
ha_category: Camera ha_category: Camera
ha_release: 0.26 ha_release: 0.26
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `ffmpeg` platform allows you to use any video feed as a camera in Home Assistant via [FFmpeg](http://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem. The `ffmpeg` platform allows you to use any video feed as a camera in Home Assistant via [FFmpeg](http://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem.

3
source/_components/camera.foscam.markdown
View File

@ -9,7 +9,8 @@ sharing: true
footer: true footer: true
logo: foscam.png logo: foscam.png
ha_category: Camera ha_category: Camera
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.7.3
--- ---
The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant. The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant.

2
source/_components/camera.generic.markdown
View File

@ -10,7 +10,7 @@ footer: true
ha_category: Camera ha_category: Camera
logo: home-assistant.png logo: home-assistant.png
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: "depends" ha_iot_class: Configurable
--- ---
The `generic` camera platform allows you to integrate any IP camera or other URL into Home Assistant. Templates can be used to generate the URLs on the fly. The `generic` camera platform allows you to integrate any IP camera or other URL into Home Assistant. Templates can be used to generate the URLs on the fly.

2
source/_components/camera.local_file.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: file.png logo: file.png
ha_category: Camera ha_category: Camera
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.22 ha_release: 0.22
--- ---

2
source/_components/camera.logi_circle.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: logi_circle.png logo: logi_circle.png
ha_category: Camera ha_category: Camera
ha_release: 0.79 ha_release: 0.79
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
--- ---
The `logi_circle` camera platform allows you to watch the still frames of your [Logi Circle](https://circle.logi.com/) camera's live stream in Home Assistant. The `logi_circle` camera platform allows you to watch the still frames of your [Logi Circle](https://circle.logi.com/) camera's live stream in Home Assistant.

1
source/_components/camera.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_release: 0.7
--- ---
The camera component allows you to use IP cameras with Home Assistant. With a little additional work you could use [USB cameras](/blog/2016/06/23/usb-webcams-and-home-assistant/) as well. The camera component allows you to use IP cameras with Home Assistant. With a little additional work you could use [USB cameras](/blog/2016/06/23/usb-webcams-and-home-assistant/) as well.

2
source/_components/camera.mjpeg.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Camera ha_category: Camera
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: "depends" ha_iot_class: Configurable
--- ---
The `mjpeg` camera platform allows you to integrate IP cameras which are capable The `mjpeg` camera platform allows you to integrate IP cameras which are capable

2
source/_components/camera.mqtt.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: mqtt.png logo: mqtt.png
ha_category: Camera ha_category: Camera
ha_release: 0.43 ha_release: 0.43
ha_iot_class: depends 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. 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.

2
source/_components/camera.netatmo.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: netatmo.png logo: netatmo.png
ha_category: Camera ha_category: Camera
ha_release: 0.22 ha_release: 0.22
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera. The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera.

10
source/_components/camera.push.markdown
View File

@ -9,8 +9,8 @@ sharing: true
footer: true footer: true
logo: camcorder.png logo: camcorder.png
ha_category: Camera ha_category: Camera
ha_iot_class: "Local Push" ha_iot_class: Local Push
ha_release: 0.74 ha_release: 0.74
--- ---
The `push` camera platform allows you to integrate images sent over HTTP POST to Home Assistant as a camera. External applications/daemons/scripts are therefore able to "stream" images through Home Assistant. The `push` camera platform allows you to integrate images sent over HTTP POST to Home Assistant as a camera. External applications/daemons/scripts are therefore able to "stream" images through Home Assistant.
@ -39,7 +39,7 @@ camera:
name: MotionEye Outdoor name: MotionEye Outdoor
buffer: 3 buffer: 3
timeout: 5 timeout: 5
webhook_id: my_custom_webhook_id webhook_id: my_custom_webhook_id
``` ```
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
@ -51,7 +51,7 @@ To enable this camera in your installation, add the following to your `configura
camera: camera:
- platform: push - platform: push
name: My Push Camera name: My Push Camera
webhook_id: my_custom_webhook_id webhook_id: my_custom_webhook_id
``` ```
{% configuration %} {% configuration %}
@ -72,7 +72,7 @@ timeout:
default: 5 seconds default: 5 seconds
webhook_id: webhook_id:
description: User provided string acting as camera identifier and access control, should be a large string (more then 8 chars). description: User provided string acting as camera identifier and access control, should be a large string (more then 8 chars).
required: true required: true
type: string type: string
field: field:
description: HTTP POST field containing the image file description: HTTP POST field containing the image file

2
source/_components/camera.rpi_camera.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: DIY ha_category: DIY
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.17 ha_release: 0.17
--- ---

2
source/_components/camera.synology.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: synology.png logo: synology.png
ha_category: Camera ha_category: Camera
ha_release: 0.31 ha_release: 0.31
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant. The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.

2
source/_components/camera.uvc.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: ubiquiti.png logo: ubiquiti.png
ha_category: Camera ha_category: Camera
ha_release: 0.13 ha_release: 0.13
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `uvc` camera platform allows you to integrate [UniFi Video Camera (UVC)](https://www.ubnt.com/products/#unifivideo) into Home Assistant. The `uvc` camera platform allows you to integrate [UniFi Video Camera (UVC)](https://www.ubnt.com/products/#unifivideo) into Home Assistant.

2
source/_components/camera.xeoma.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
logo: xeoma.png logo: xeoma.png
ha_category: Camera ha_category: Camera
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.62 ha_release: 0.62
--- ---

2
source/_components/camera.xiaomi.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: xiaomi.png logo: xiaomi.png
ha_category: Camera ha_category: Camera
ha_release: 0.72 ha_release: 0.72
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant. The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant.

2
source/_components/camera.yi.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: yi.png logo: yi.png
ha_category: Camera ha_category: Camera
ha_release: 0.56 ha_release: 0.56
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `yi` camera platform allows you to utilize [Yi Home Cameras](https://www.yitechnology.com/) within Home Assistant. Specifically, this platform supports the line of Yi Home Cameras that are based on the Hi3518e Chipset. This includes: The `yi` camera platform allows you to utilize [Yi Home Cameras](https://www.yitechnology.com/) within Home Assistant. Specifically, this platform supports the line of Yi Home Cameras that are based on the Hi3518e Chipset. This includes:

4
source/_components/canary.markdown
View File

@ -13,7 +13,7 @@ ha_category:
- Camera - Camera
- Sensor - Sensor
ha_release: "0.60" ha_release: "0.60"
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
redirect_from: redirect_from:
- /components/alarm_control_panel.canary/ - /components/alarm_control_panel.canary/
- /components/camera.canary/ - /components/camera.canary/
@ -97,4 +97,4 @@ Once loaded, you will see following sensors:
- A sensor per camera that reports temperature. - A sensor per camera that reports temperature.
- A sensor per camera that reports humidity. - A sensor per camera that reports humidity.
- A sensor per camera that reports air quality. - A sensor per camera that reports air quality.

2
source/_components/cast.markdown
View File

@ -11,7 +11,7 @@ logo: google_cast.png
ha_category: Media Player ha_category: Media Player
featured: true featured: true
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
redirect_from: /components/media_player.cast/ redirect_from: /components/media_player.cast/
--- ---

2
source/_components/climate.coolmaster.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: coolautomation.png logo: coolautomation.png
ha_category: Climate ha_category: Climate
ha_release: 0.88 ha_release: 0.88
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---

2
source/_components/climate.ephember.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: ephcontrolsember.png logo: ephcontrolsember.png
ha_category: Climate ha_category: Climate
ha_release: 0.57 ha_release: 0.57
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---

3
source/_components/climate.eq3btsmart.markdown
View File

@ -9,7 +9,8 @@ sharing: true
footer: true footer: true
logo: eq3.gif logo: eq3.gif
ha_category: Climate ha_category: Climate
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
ha_release: 0.18
--- ---
The `eq3btsmart` climate platform allows you to integrate EQ3 Bluetooth Smart Thermostats. The `eq3btsmart` climate platform allows you to integrate EQ3 Bluetooth Smart Thermostats.

2
source/_components/climate.evohome.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: honeywell.png logo: honeywell.png
ha_category: Climate ha_category: Climate
ha_release: 0.80 ha_release: 0.80
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
--- ---
The `evohome` climate platform integrates your _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) system into Home Assistant. It has been tested with the Honeywell evohome multi-zone CH/DHW system, but other systems may also work. The `evohome` climate platform integrates your _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) system into Home Assistant. It has been tested with the Honeywell evohome multi-zone CH/DHW system, but other systems may also work.

2
source/_components/climate.flexit.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: flexit.png logo: flexit.png
ha_category: Climate ha_category: Climate
ha_release: 0.47 ha_release: 0.47
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
Integrates [Flexit](https://www.flexit.no/en/) Air Conditioning unit into Home Assistant. Integrates [Flexit](https://www.flexit.no/en/) Air Conditioning unit into Home Assistant.

2
source/_components/climate.generic_thermostat.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: home-assistant.png logo: home-assistant.png
ha_category: Climate ha_category: Climate
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler than the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter than the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities. The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler than the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter than the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities.

2
source/_components/climate.heatmiser.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: heatmiser.png logo: heatmiser.png
ha_category: Climate ha_category: Climate
ha_release: "0.10" ha_release: "0.10"
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
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/thermostats) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP.

2
source/_components/climate.honeywell.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: honeywell.png logo: honeywell.png
ha_category: Climate ha_category: Climate
ha_release: pre 0.7 ha_release: pre 0.7
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
--- ---

4
source/_components/climate.knx.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: knx.png logo: knx.png
ha_category: Climate ha_category: Climate
ha_release: 0.25 ha_release: 0.25
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `knx` climate platform is used as in interface with KNX thermostats. The `knx` climate platform is used as in interface with KNX thermostats.
@ -136,7 +136,7 @@ controller_status_state_address:
type: string type: string
controller_mode_address: controller_mode_address:
description: KNX address for handling controller modes. description: KNX address for handling controller modes.
required: false required: false
type: string type: string
controller_mode_state_address: controller_mode_state_address:
description: Explicit KNX address for reading HVAC Control Mode. description: Explicit KNX address for reading HVAC Control Mode.

1
source/_components/climate.markdown
View File

@ -7,6 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_release: 0.19
--- ---

4
source/_components/climate.mill.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: mill.png logo: mill.png
ha_category: Climate ha_category: Climate
ha_release: 0.81 ha_release: 0.81
ha_iot_class: "Cloud Polling" ha_iot_class: Cloud Polling
--- ---
Integrates Mill heater into Home Assistant. Integrates Mill heater into Home Assistant.
@ -34,7 +34,7 @@ username:
password: password:
description: Your Mill password. description: Your Mill password.
required: true required: true
type: string type: string
{% endconfiguration %} {% endconfiguration %}
## {% linkable_title Component services %} ## {% linkable_title Component services %}

2
source/_components/climate.modbus.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: modbus.png logo: modbus.png
ha_category: Climate ha_category: Climate
ha_release: 0.68 ha_release: 0.68
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---

2
source/_components/climate.mqtt.markdown
View File

@ -10,7 +10,7 @@ footer: true
logo: mqtt.png logo: mqtt.png
ha_category: Climate ha_category: Climate
ha_release: 0.55 ha_release: 0.55
ha_iot_class: "Local Polling" ha_iot_class: Local Polling
--- ---
The `mqtt` climate platform lets you control your MQTT enabled HVAC devices. The `mqtt` climate platform lets you control your MQTT enabled HVAC devices.

2
source/_components/climate.mysensors.markdown
View File

@ -12,7 +12,7 @@ ha_category:
- DIY - DIY
- Climate - Climate
ha_release: 0.29 ha_release: 0.29
ha_iot_class: "Local Push" ha_iot_class: Local Push
--- ---
Integrates MySensors HVAC into Home Assistant. See the [main component] for configuration instructions. Integrates MySensors HVAC into Home Assistant. See the [main component] for configuration instructions.

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