diff --git a/Rakefile b/Rakefile index 10f2c5d8566..20aba5bf915 100644 --- a/Rakefile +++ b/Rakefile @@ -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) 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") - 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") rackupPid = Process.spawn("rackup --port #{server_port} --host #{listen_addr}") diff --git a/_config.yml b/_config.yml index 33b89bf248e..6fbceb62596 100644 --- a/_config.yml +++ b/_config.yml @@ -139,8 +139,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 89 -current_patch_version: 0 -date_released: 2019-03-06 +current_patch_version: 2 +date_released: 2019-03-12 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/plugins/filters.rb b/plugins/filters.rb index 9e3324252da..aa136bf2925 100644 --- a/plugins/filters.rb +++ b/plugins/filters.rb @@ -70,6 +70,63 @@ module Jekyll def canonical_url(input) full_url(input).sub(/index\.\w+$/i, '') 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 diff --git a/sass/custom/_component_page.scss b/sass/custom/_component_page.scss index e3830dc2f8f..5cc5f79c75a 100644 --- a/sass/custom/_component_page.scss +++ b/sass/custom/_component_page.scss @@ -1,11 +1,11 @@ #components-page{ .component-search{ margin-bottom: 24px; - + input{ width: 100%; padding: 10px; - + background-color: #fefefe; border-radius: 2px; border: 1px solid; @@ -50,12 +50,12 @@ margin: 12px 0; } - .added_in_current_version { - margin-top: 12px; + .version_select { + margin: 12px 0 12px 0; } - .added_two_versions_ago { - margin-bottom: 12px; + .version_select > select { + width: 100%; } .btn { @@ -76,18 +76,18 @@ // styles for the cards .hass-option-cards { - display: -ms-flexbox; - display: -webkit-box; - display: -webkit-flexbox; + display: -ms-flexbox; + display: -webkit-box; + display: -webkit-flexbox; display: -webkit-flex; - display: flex; - + display: flex; + flex-direction: row; flex-wrap: wrap; justify-content: flex-start; align-items: flex-start; margin: -4px; // grid trick, has to match option-card's margin - + p.note{ width: 100%; } @@ -139,7 +139,7 @@ color: #AAA; } } - + // fade-in animation &.show-items .option-card{ opacity:0; @@ -147,7 +147,7 @@ -o-animation:new-item-animation .2s linear forwards; animation:new-item-animation .2s linear forwards; } - + // fade-out animation &.remove-items .option-card{ -webkit-animation:removed-item-animation .2s cubic-bezier(.55,-0.04,.91,.94) forwards; diff --git a/source/_addons/duckdns.markdown b/source/_addons/duckdns.markdown index d1726880996..9a63a87dbd2 100644 --- a/source/_addons/duckdns.markdown +++ b/source/_addons/duckdns.markdown @@ -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. 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"], + ... +} +``` diff --git a/source/_addons/lets_encrypt.markdown b/source/_addons/lets_encrypt.markdown index fb00c62ecac..ae9cbb36811 100644 --- a/source/_addons/lets_encrypt.markdown +++ b/source/_addons/lets_encrypt.markdown @@ -7,7 +7,6 @@ sidebar: true comments: false sharing: true footer: true -featured: false ---

@@ -79,7 +78,7 @@ Use this in your `automations.yaml` to attempt certificate renewal each day at m 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 - id: letsencrypt-renewal diff --git a/source/_addons/tellstick.markdown b/source/_addons/tellstick.markdown index 5c9f9aebe74..42729674b4d 100644 --- a/source/_addons/tellstick.markdown +++ b/source/_addons/tellstick.markdown @@ -7,7 +7,6 @@ sidebar: true comments: false sharing: 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. @@ -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: `{"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. diff --git a/source/_components/abode.markdown b/source/_components/abode.markdown index 0f08154bfa7..23f0002f664 100644 --- a/source/_components/abode.markdown +++ b/source/_components/abode.markdown @@ -19,7 +19,7 @@ ha_category: - Sensor - Switch ha_release: 0.52 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push redirect_from: - /components/alarm_control_panel.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 also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations. \ No newline at end of file +This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations. diff --git a/source/_components/ads.markdown b/source/_components/ads.markdown index 599086ef75a..2d5c697d1c1 100644 --- a/source/_components/ads.markdown +++ b/source/_components/ads.markdown @@ -15,7 +15,7 @@ ha_category: - Sensor - Switch ha_release: "0.60" -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.ads/ - /components/light.ads/ @@ -49,7 +49,7 @@ device: required: true type: string 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 type: integer ip_address: @@ -137,7 +137,7 @@ name: ## {% 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` file: diff --git a/source/_components/air_quality.markdown b/source/_components/air_quality.markdown index 26d62f2f489..26318e9d27b 100644 --- a/source/_components/air_quality.markdown +++ b/source/_components/air_quality.markdown @@ -8,6 +8,7 @@ comments: false sharing: true footer: true redirect_from: /components/air_pollutants/ +ha_release: 0.85 --- The `air_quality` gather information about the air quality and pollution details. diff --git a/source/_components/air_quality.nilu.markdown b/source/_components/air_quality.nilu.markdown index 458429601a4..ee81c2fcd0e 100644 --- a/source/_components/air_quality.nilu.markdown +++ b/source/_components/air_quality.nilu.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: nilu_logo.png ha_category: Health -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.87 --- @@ -45,7 +45,7 @@ air_quality: description: Name of an area to get sensor stations from. See available areas below. required: exclusive type: string - stations: + stations: description: Name of a specific station to get measurements from. required: exclusive type: string @@ -58,11 +58,11 @@ air_quality: ## {% 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 %} -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 %} @@ -74,7 +74,7 @@ Health effects may occur in asthmatics and people with other respiratory disease ### {% 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) @@ -147,7 +147,7 @@ Example of a specific station. # Monitors stations 'Alnabru' air_quality: - platform: nilu - stations: + stations: - Alnabru ``` @@ -156,7 +156,7 @@ Example of getting stations from a specified area, giving the sensors a custom n ```yaml # Example configuration.yaml entry # Stations from specific area, 'Bergen' -# Custom name for the sensors. +# Custom name for the sensors. air_quality: - platform: nilu area: Bergen diff --git a/source/_components/air_quality.opensensemap.markdown b/source/_components/air_quality.opensensemap.markdown index 72c73883f05..25a942b3c6b 100644 --- a/source/_components/air_quality.opensensemap.markdown +++ b/source/_components/air_quality.opensensemap.markdown @@ -10,7 +10,7 @@ footer: true logo: opensensemap.png ha_category: Health ha_release: 0.85 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: /components/air_pollutants.opensensemap/ --- diff --git a/source/_components/alarm_control_panel.markdown b/source/_components/alarm_control_panel.markdown index ad8408cf92b..8ae3f922130 100644 --- a/source/_components/alarm_control_panel.markdown +++ b/source/_components/alarm_control_panel.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: 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: diff --git a/source/_components/alarm_control_panel.mqtt.markdown b/source/_components/alarm_control_panel.mqtt.markdown index dc35ef32963..5985f6e04c4 100644 --- a/source/_components/alarm_control_panel.mqtt.markdown +++ b/source/_components/alarm_control_panel.mqtt.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Alarm 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`. diff --git a/source/_components/alarmdecoder.markdown b/source/_components/alarmdecoder.markdown index 05f43d52b05..1ca8c276b12 100644 --- a/source/_components/alarmdecoder.markdown +++ b/source/_components/alarmdecoder.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor - Sensor ha_release: 0.43 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/alarm_control_panel.alarmdecoder/ - /components/binary_sensor.alarmdecoder/ diff --git a/source/_components/alexa.markdown b/source/_components/alexa.markdown index 9cabf5dccca..e41ce1cf951 100644 --- a/source/_components/alexa.markdown +++ b/source/_components/alexa.markdown @@ -10,7 +10,7 @@ footer: true logo: amazon-echo.png ha_category: Voice featured: true -ha_release: '0.10' +ha_release: "0.10" --- ## {% linkable_title Automatic setup via Home Assistant Cloud %} diff --git a/source/_components/ambient_station.markdown b/source/_components/ambient_station.markdown index 5dc01ea15b2..62191bc9d0f 100644 --- a/source/_components/ambient_station.markdown +++ b/source/_components/ambient_station.markdown @@ -7,8 +7,8 @@ sidebar: true comments: false logo: ambient_weather.png ha_category: Weather -ha_release: "0.85" -ha_iot_class: "Cloud Push" +ha_release: 0.85 +ha_iot_class: Cloud Push redirect_from: - /components/sensor.ambient_station/ --- diff --git a/source/_components/amcrest.markdown b/source/_components/amcrest.markdown index 5457697fbf4..dfd762330a7 100644 --- a/source/_components/amcrest.markdown +++ b/source/_components/amcrest.markdown @@ -13,7 +13,7 @@ ha_category: - Camera - Sensor - Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.49 redirect_from: - /components/camera.amcrest/ @@ -207,4 +207,4 @@ Switches will be configured automatically. Please refer to the [component](/comp

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. -

\ No newline at end of file +

diff --git a/source/_components/android_ip_webcam.markdown b/source/_components/android_ip_webcam.markdown index dcead93b80d..23db722ce76 100644 --- a/source/_components/android_ip_webcam.markdown +++ b/source/_components/android_ip_webcam.markdown @@ -15,7 +15,7 @@ ha_category: - Sensor - Switch ha_release: "0.40" -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.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. -You can setup your own sensors by examining the JSON file from the webcam server: http://IP:8080/sensors.json \ No newline at end of file +You can setup your own sensors by examining the JSON file from the webcam server: http://IP:8080/sensors.json diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown index 789b81c6a6c..b341b1b8168 100644 --- a/source/_components/apcupsd.markdown +++ b/source/_components/apcupsd.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor - Sensor ha_release: 0.13 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.apcupsd/ - /components/sensor.apcupsd/ diff --git a/source/_components/api.markdown b/source/_components/api.markdown index 5a8dd7585c4..df8b0124133 100644 --- a/source/_components/api.markdown +++ b/source/_components/api.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: "Other" 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/). diff --git a/source/_components/apple_tv.markdown b/source/_components/apple_tv.markdown index 94c89c1d28c..79da7887cf6 100644 --- a/source/_components/apple_tv.markdown +++ b/source/_components/apple_tv.markdown @@ -12,7 +12,7 @@ ha_category: - Multimedia - Media Player - Remote -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.49 redirect_from: - /components/media_player.apple_tv/ @@ -197,4 +197,4 @@ data: - left - menu - select -``` \ No newline at end of file +``` diff --git a/source/_components/aqualogic.markdown b/source/_components/aqualogic.markdown index f8a578fbcc4..dcfb0dc2814 100644 --- a/source/_components/aqualogic.markdown +++ b/source/_components/aqualogic.markdown @@ -13,7 +13,7 @@ ha_category: - Sensor - Switch ha_release: "0.80" -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/sensor.aqualogic/ - /components/switch.aqualogic/ @@ -127,4 +127,4 @@ monitored_conditions: description: Controls the Aux 6 relay. aux_7: description: Controls the Aux 7 relay. -{% endconfiguration %} \ No newline at end of file +{% endconfiguration %} diff --git a/source/_components/arduino.markdown b/source/_components/arduino.markdown index 522886639ac..d14cff62b29 100644 --- a/source/_components/arduino.markdown +++ b/source/_components/arduino.markdown @@ -11,7 +11,7 @@ logo: arduino.png ha_category: DIY featured: true 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. diff --git a/source/_components/arlo.markdown b/source/_components/arlo.markdown index f77d13a3f99..7093ead44b1 100644 --- a/source/_components/arlo.markdown +++ b/source/_components/arlo.markdown @@ -14,7 +14,7 @@ ha_category: - Camera - Sensor ha_release: 0.46 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/alarm_control_panel.arlo/ - /components/camera.arlo/ diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index 9d0c75b4d11..77fe435e615 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: asterisk.png ha_category: Mailbox -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.51 redirect_from: - /components/mailbox.asterisk_mbox/ diff --git a/source/_components/asuswrt.markdown b/source/_components/asuswrt.markdown index 12cb3390129..b887ca33fdf 100644 --- a/source/_components/asuswrt.markdown +++ b/source/_components/asuswrt.markdown @@ -13,7 +13,7 @@ ha_category: - Presence Detection - Sensor ha_release: 0.83 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/device_tracker.asuswrt/ - /components/sensor.asuswrt/ @@ -128,21 +128,21 @@ Follow these steps to setup the link. 2. Run the following command to find the file: ```bash -$ find / -name "dnsmasq.leases" +$ find / -name "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 $ 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 $ 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 $ /bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases diff --git a/source/_components/august.markdown b/source/_components/august.markdown index d4e0c63c966..e0465ae7c87 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -13,8 +13,8 @@ ha_category: - Binary Sensor - Camera - Lock -ha_release: "0.64" -ha_iot_class: "Cloud Polling" +ha_release: 0.64 +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.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 %} -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. \ No newline at end of file +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. diff --git a/source/_components/automation.markdown b/source/_components/automation.markdown index 4aaee44eec1..cc51419025d 100644 --- a/source/_components/automation.markdown +++ b/source/_components/automation.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Automation ha_qa_scale: internal +ha_release: 0.7 --- 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 itself. If you don't want to see the automation rule in your frontend use `hide_entity: true` to hide it. -You can also use `initial_state: 'off'` so that the automation +You can also use `initial_state: 'false'` so that the automation is not automatically turned on after a Home Assistant reboot. ```yaml automation: - alias: Door alarm hide_entity: true - initial_state: 'off' + initial_state: 'true' trigger: - platform: state ... diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown index 3ba52eba2dc..de48006f52e 100644 --- a/source/_components/axis.markdown +++ b/source/_components/axis.markdown @@ -11,8 +11,8 @@ logo: axis.png ha_category: - Camera - Binary Sensor -ha_release: "0.45" -ha_iot_class: "Local Polling" +ha_release: 0.45 +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.axis/ - /components/camera.axis/ diff --git a/source/_components/bbb_gpio.markdown b/source/_components/bbb_gpio.markdown index 285f6bcdb7c..9fcfe4b5169 100644 --- a/source/_components/bbb_gpio.markdown +++ b/source/_components/bbb_gpio.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor - Switch ha_release: 0.36 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.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. required: false type: string - default: UP + default: UP {% endconfiguration %} 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 {% endconfiguration %} -For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. \ No newline at end of file +For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. diff --git a/source/_components/binary_sensor.arest.markdown b/source/_components/binary_sensor.arest.markdown index 4192b8aab9c..e5c00a212ec 100644 --- a/source/_components/binary_sensor.arest.markdown +++ b/source/_components/binary_sensor.arest.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: arest.png ha_category: DIY -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.9 --- diff --git a/source/_components/binary_sensor.bayesian.markdown b/source/_components/binary_sensor.bayesian.markdown index 81424f7d666..e10e50e69b4 100644 --- a/source/_components/binary_sensor.bayesian.markdown +++ b/source/_components/binary_sensor.bayesian.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.53 ha_qa_scale: internal --- @@ -71,7 +71,7 @@ observations: value_template: description: Defines the template to be used. required: true (for `template`) - type: template + type: template prob_given_true: description: The probability of the observation occurring, given the event is `true`. required: true @@ -84,7 +84,7 @@ observations: to_state: description: The target state. required: true (for `state`) - type: string + type: string {% endconfiguration %} ## {% linkable_title Full examples %} diff --git a/source/_components/binary_sensor.command_line.markdown b/source/_components/binary_sensor.command_line.markdown index da5435b7d9f..d6115cf79aa 100644 --- a/source/_components/binary_sensor.command_line.markdown +++ b/source/_components/binary_sensor.command_line.markdown @@ -10,7 +10,7 @@ footer: true logo: command_line.png ha_category: Utility 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. diff --git a/source/_components/binary_sensor.flic.markdown b/source/_components/binary_sensor.flic.markdown index ef22b9b5e8e..ab4139d98b8 100644 --- a/source/_components/binary_sensor.flic.markdown +++ b/source/_components/binary_sensor.flic.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: flic.png ha_category: Binary Sensor -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.35 --- @@ -52,7 +52,7 @@ discovery: ignored_click_types: description: List of click types whose occurrence should not trigger a `flic_click` event. Click types are `single`, `double`, and `hold`. required: false - type: list + type: list timeout: description: The maximum time in seconds an event can be queued locally on a button before discarding the event. required: false @@ -105,7 +105,7 @@ automation: event_type: flic_click action: - service_template: notify.html5 - data_template: + data_template: title: "flic click" message: {% raw %}"flic {{ trigger.event.data.button_name }} was {{ trigger.event.data.click_type }} clicked"{% endraw %} ``` diff --git a/source/_components/binary_sensor.hikvision.markdown b/source/_components/binary_sensor.hikvision.markdown index 1a9dd7ce26f..3ea13824a6f 100644 --- a/source/_components/binary_sensor.hikvision.markdown +++ b/source/_components/binary_sensor.hikvision.markdown @@ -10,7 +10,7 @@ footer: true logo: hikvision.png ha_category: Binary Sensor 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 diff --git a/source/_components/binary_sensor.ihc.markdown b/source/_components/binary_sensor.ihc.markdown index 215b0d1bd64..3e53d343a5c 100644 --- a/source/_components/binary_sensor.ihc.markdown +++ b/source/_components/binary_sensor.ihc.markdown @@ -10,7 +10,7 @@ footer: true logo: ihc.png ha_category: Binary Sensor ha_release: 0.62 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- Before you can use the IHC Binary Sensor platform, diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index 9bb13677c13..74f531994ee 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -10,7 +10,7 @@ footer: true logo: knx.png ha_category: Binary Sensor 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. diff --git a/source/_components/binary_sensor.markdown b/source/_components/binary_sensor.markdown index fe8f4a51078..41193b16c9a 100644 --- a/source/_components/binary_sensor.markdown +++ b/source/_components/binary_sensor.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: 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. diff --git a/source/_components/binary_sensor.modbus.markdown b/source/_components/binary_sensor.modbus.markdown index e57f19b7581..f278a9edb3d 100644 --- a/source/_components/binary_sensor.modbus.markdown +++ b/source/_components/binary_sensor.modbus.markdown @@ -10,7 +10,7 @@ footer: true logo: modbus.png ha_category: Binary Sensor 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. diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 392f2af5af2..b766216f130 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Binary Sensor 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`. diff --git a/source/_components/binary_sensor.mysensors.markdown b/source/_components/binary_sensor.mysensors.markdown index 21e6df82d21..34c2559af8a 100644 --- a/source/_components/binary_sensor.mysensors.markdown +++ b/source/_components/binary_sensor.mysensors.markdown @@ -8,11 +8,11 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: +ha_category: - DIY - Binary Sensor 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. diff --git a/source/_components/binary_sensor.mystrom.markdown b/source/_components/binary_sensor.mystrom.markdown index 21b0d76216c..a80bcd0abe4 100644 --- a/source/_components/binary_sensor.mystrom.markdown +++ b/source/_components/binary_sensor.mystrom.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: mystrom.png ha_category: Binary Sensor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.45 --- diff --git a/source/_components/binary_sensor.nx584.markdown b/source/_components/binary_sensor.nx584.markdown index 88e77577dcc..5b66030d7ad 100644 --- a/source/_components/binary_sensor.nx584.markdown +++ b/source/_components/binary_sensor.nx584.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: networx.png ha_category: Binary Sensor -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.14 --- diff --git a/source/_components/binary_sensor.raincloud.markdown b/source/_components/binary_sensor.raincloud.markdown index 004c750bf57..a13fba09dd7 100644 --- a/source/_components/binary_sensor.raincloud.markdown +++ b/source/_components/binary_sensor.raincloud.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: raincloud.jpg ha_category: Irrigation -ha_release: "0.55" -ha_iot_class: "Cloud Polling" +ha_release: 0.55 +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). diff --git a/source/_components/binary_sensor.random.markdown b/source/_components/binary_sensor.random.markdown index 1a17bc91cb4..9b2079270fc 100644 --- a/source/_components/binary_sensor.random.markdown +++ b/source/_components/binary_sensor.random.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.57 ha_qa_scale: internal --- diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index 96a6db48a93..f7949e2771e 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -10,7 +10,7 @@ footer: true logo: restful.png ha_category: Binary Sensor 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 diff --git a/source/_components/binary_sensor.rflink.markdown b/source/_components/binary_sensor.rflink.markdown index b40c2a4a093..d15cee62bb7 100644 --- a/source/_components/binary_sensor.rflink.markdown +++ b/source/_components/binary_sensor.rflink.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: rflink.png ha_category: Binary Sensor -ha_iot_class: "Local Push" -ha_release: "0.81" +ha_iot_class: Local Push +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). diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index 99470e2be45..ab95973988d 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: rfxtrx.png ha_category: Binary Sensor +ha_release: 0.48 --- The `rfxtrx` platform support binary sensors that diff --git a/source/_components/binary_sensor.rpi_pfio.markdown b/source/_components/binary_sensor.rpi_pfio.markdown index 7dad33505d0..735f7cc4a16 100644 --- a/source/_components/binary_sensor.rpi_pfio.markdown +++ b/source/_components/binary_sensor.rpi_pfio.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY 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/) . diff --git a/source/_components/binary_sensor.tapsaff.markdown b/source/_components/binary_sensor.tapsaff.markdown index 8f7c512487e..31dadb0f6a8 100644 --- a/source/_components/binary_sensor.tapsaff.markdown +++ b/source/_components/binary_sensor.tapsaff.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: tapsaff.png ha_category: Weather -featured: false 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). diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 5fe812ac1e4..4fbb5a6bae4 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Binary Sensor ha_release: 0.12 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/binary_sensor.threshold.markdown b/source/_components/binary_sensor.threshold.markdown index f3a0a39bc4e..fecb913a6ae 100644 --- a/source/_components/binary_sensor.threshold.markdown +++ b/source/_components/binary_sensor.threshold.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.34 ha_qa_scale: internal --- diff --git a/source/_components/binary_sensor.tod.markdown b/source/_components/binary_sensor.tod.markdown index 4971fbf8015..00e1c9afec0 100644 --- a/source/_components/binary_sensor.tod.markdown +++ b/source/_components/binary_sensor.tod.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Binary Sensor ha_release: 0.89 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- @@ -32,6 +32,11 @@ binary_sensor: after: sunrise after_offset: '-02:00' before: '07:00' + + - platform: tod + name: Late Morning + after: '10:00' + before: '12:00' ``` {% configuration %} diff --git a/source/_components/binary_sensor.trend.markdown b/source/_components/binary_sensor.trend.markdown index 564d444f45f..c7c9f02deb5 100644 --- a/source/_components/binary_sensor.trend.markdown +++ b/source/_components/binary_sensor.trend.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Utility logo: home-assistant.png ha_release: 0.28 -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_qa_scale: internal --- diff --git a/source/_components/binary_sensor.uptimerobot.markdown b/source/_components/binary_sensor.uptimerobot.markdown index 759150fe332..0052fcf2cee 100644 --- a/source/_components/binary_sensor.uptimerobot.markdown +++ b/source/_components/binary_sensor.uptimerobot.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: uptimerobot.png ha_category: System Monitor -ha_release: "0.72" -ha_iot_class: "Cloud Polling" +ha_release: 0.72 +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). diff --git a/source/_components/binary_sensor.workday.markdown b/source/_components/binary_sensor.workday.markdown index d21550d0d92..d1dfdcb1f25 100644 --- a/source/_components/binary_sensor.workday.markdown +++ b/source/_components/binary_sensor.workday.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.41 ha_qa_scale: internal --- diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index 048611866db..27a5f1d946f 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Binary Sensor 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. diff --git a/source/_components/binary_sensor.zigbee.markdown b/source/_components/binary_sensor.zigbee.markdown index df7d273e209..79611eb37a2 100644 --- a/source/_components/binary_sensor.zigbee.markdown +++ b/source/_components/binary_sensor.zigbee.markdown @@ -10,7 +10,7 @@ footer: true logo: zigbee.png ha_category: Binary Sensor 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`. diff --git a/source/_components/blink.markdown b/source/_components/blink.markdown index 6275343f057..741f82d4519 100644 --- a/source/_components/blink.markdown +++ b/source/_components/blink.markdown @@ -15,8 +15,8 @@ ha_category: - Camera - Sensor ha_release: "0.40" -ha_iot_class: "Cloud Polling" -redirect_form: +ha_iot_class: Cloud Polling +redirect_from: - /components/alarm_control_panel.blink/ - /components/binary_sensor.blink/ - /components/camera.blink/ diff --git a/source/_components/bloomsky.markdown b/source/_components/bloomsky.markdown index e1746bd89dc..6f99dce63d5 100644 --- a/source/_components/bloomsky.markdown +++ b/source/_components/bloomsky.markdown @@ -14,7 +14,7 @@ ha_category: - Camera - Sensor ha_release: 0.14 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.bloomsky/ --- @@ -134,4 +134,4 @@ monitored_conditions: description: Voltage {% endconfiguration %} -More conditions are available using the [BloomSky binary sensor](#binary-sensor) component. \ No newline at end of file +More conditions are available using the [BloomSky binary sensor](#binary-sensor) component. diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index 82741ab6fe0..ddb68dda653 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Utility 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. diff --git a/source/_components/calendar.caldav.markdown b/source/_components/calendar.caldav.markdown index 01fe75d358d..e9d98b92580 100644 --- a/source/_components/calendar.caldav.markdown +++ b/source/_components/calendar.caldav.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Calendar -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: "0.60" --- diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index 888f52f1851..1e1f87ffb93 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: google_calendar.png ha_category: Calendar -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.33 --- @@ -131,7 +131,7 @@ entities: offset: description: > 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. required: false type: string diff --git a/source/_components/calendar.markdown b/source/_components/calendar.markdown index 4b69b5e6fe8..8c44c4c68e0 100644 --- a/source/_components/calendar.markdown +++ b/source/_components/calendar.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.33 --- The calendar component allows you to integrate your calendars into Home Assistant. diff --git a/source/_components/calendar.todoist.markdown b/source/_components/calendar.todoist.markdown index d738b4b0914..0521ee53551 100644 --- a/source/_components/calendar.todoist.markdown +++ b/source/_components/calendar.todoist.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: todoist.png ha_category: Calendar -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling 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_lang** (*Optional*): When `due_date_string` is set, it is posisble to set the language. - Valid languages are: `en`, `da`, `pl`, `zh`, `ko`, `de`, `pt`, `ja`, `it`, `fr`, `sv`, `ru`, `es`, `nl` +- **due_date_lang** (*Optional*): When `due_date_string` is set, it is posisble to set the language. + Valid languages are: `en`, `da`, `pl`, `zh`, `ko`, `de`, `pt`, `ja`, `it`, `fr`, `sv`, `ru`, `es`, `nl` - **due_date** (*Optional*): When the task should be due, in either YYYY-MM-DD format or YYYY-MM-DD HH:MM format. Mutually exclusive with `due_date_string`. diff --git a/source/_components/camera.dispatcher.markdown b/source/_components/camera.dispatcher.markdown index 05ceb99e2ca..251f2f619a4 100644 --- a/source/_components/camera.dispatcher.markdown +++ b/source/_components/camera.dispatcher.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Camera logo: camcorder.png ha_release: "0.40" -ha_iot_class: "depends" +ha_iot_class: Configurable ---

diff --git a/source/_components/camera.familyhub.markdown b/source/_components/camera.familyhub.markdown index 20f888a63d9..970e4355b11 100644 --- a/source/_components/camera.familyhub.markdown +++ b/source/_components/camera.familyhub.markdown @@ -10,7 +10,7 @@ footer: true logo: familyhub.png ha_category: Camera 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. diff --git a/source/_components/camera.ffmpeg.markdown b/source/_components/camera.ffmpeg.markdown index 09f2cffc814..3acf24ce84a 100644 --- a/source/_components/camera.ffmpeg.markdown +++ b/source/_components/camera.ffmpeg.markdown @@ -10,7 +10,7 @@ footer: true logo: ffmpeg.png ha_category: Camera 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. diff --git a/source/_components/camera.foscam.markdown b/source/_components/camera.foscam.markdown index 3a0cbb53fae..cef0b3031e6 100644 --- a/source/_components/camera.foscam.markdown +++ b/source/_components/camera.foscam.markdown @@ -9,7 +9,8 @@ sharing: true footer: true logo: foscam.png 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. diff --git a/source/_components/camera.generic.markdown b/source/_components/camera.generic.markdown index cbcbe27a6d2..03bcac97578 100644 --- a/source/_components/camera.generic.markdown +++ b/source/_components/camera.generic.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Camera logo: home-assistant.png 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. diff --git a/source/_components/camera.local_file.markdown b/source/_components/camera.local_file.markdown index c94de28a5b7..992394403ad 100644 --- a/source/_components/camera.local_file.markdown +++ b/source/_components/camera.local_file.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: file.png ha_category: Camera -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.22 --- diff --git a/source/_components/camera.logi_circle.markdown b/source/_components/camera.logi_circle.markdown index 20a742ffaef..43c939bf804 100644 --- a/source/_components/camera.logi_circle.markdown +++ b/source/_components/camera.logi_circle.markdown @@ -10,7 +10,7 @@ footer: true logo: logi_circle.png ha_category: Camera 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. diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index 4a91357d16f..0aee4c4e8dc 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: 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. diff --git a/source/_components/camera.mjpeg.markdown b/source/_components/camera.mjpeg.markdown index 912b180998d..90800d75823 100644 --- a/source/_components/camera.mjpeg.markdown +++ b/source/_components/camera.mjpeg.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_category: Camera 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 diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index 978243247dc..a058e15b055 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Camera 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. diff --git a/source/_components/camera.netatmo.markdown b/source/_components/camera.netatmo.markdown index bc38d19196a..0d9c6e98a80 100644 --- a/source/_components/camera.netatmo.markdown +++ b/source/_components/camera.netatmo.markdown @@ -10,7 +10,7 @@ footer: true logo: netatmo.png ha_category: Camera 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. diff --git a/source/_components/camera.push.markdown b/source/_components/camera.push.markdown index e422ab4c5ee..a25d7a683cc 100644 --- a/source/_components/camera.push.markdown +++ b/source/_components/camera.push.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: camcorder.png ha_category: Camera -ha_iot_class: "Local Push" -ha_release: 0.74 +ha_iot_class: Local Push +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. @@ -39,7 +39,7 @@ camera: name: MotionEye Outdoor buffer: 3 timeout: 5 - webhook_id: my_custom_webhook_id + webhook_id: my_custom_webhook_id ``` ## {% linkable_title Configuration %} @@ -51,7 +51,7 @@ To enable this camera in your installation, add the following to your `configura camera: - platform: push name: My Push Camera - webhook_id: my_custom_webhook_id + webhook_id: my_custom_webhook_id ``` {% configuration %} @@ -72,7 +72,7 @@ timeout: default: 5 seconds webhook_id: 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 field: description: HTTP POST field containing the image file diff --git a/source/_components/camera.rpi_camera.markdown b/source/_components/camera.rpi_camera.markdown index f7148f19775..0d08f1a66e3 100644 --- a/source/_components/camera.rpi_camera.markdown +++ b/source/_components/camera.rpi_camera.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: raspberry-pi.png ha_category: DIY -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.17 --- diff --git a/source/_components/camera.synology.markdown b/source/_components/camera.synology.markdown index 12f8f212f45..28ed19a1d68 100644 --- a/source/_components/camera.synology.markdown +++ b/source/_components/camera.synology.markdown @@ -10,7 +10,7 @@ footer: true logo: synology.png ha_category: Camera 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. diff --git a/source/_components/camera.uvc.markdown b/source/_components/camera.uvc.markdown index 63d773f0915..1edfd04148c 100644 --- a/source/_components/camera.uvc.markdown +++ b/source/_components/camera.uvc.markdown @@ -10,7 +10,7 @@ footer: true logo: ubiquiti.png ha_category: Camera 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. diff --git a/source/_components/camera.xeoma.markdown b/source/_components/camera.xeoma.markdown index afb89f1877d..428f7b4502b 100644 --- a/source/_components/camera.xeoma.markdown +++ b/source/_components/camera.xeoma.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: xeoma.png ha_category: Camera -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.62 --- diff --git a/source/_components/camera.xiaomi.markdown b/source/_components/camera.xiaomi.markdown index 0dc5777f35a..f241051ddc2 100644 --- a/source/_components/camera.xiaomi.markdown +++ b/source/_components/camera.xiaomi.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Camera 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. diff --git a/source/_components/camera.yi.markdown b/source/_components/camera.yi.markdown index 0fce50e8b96..3a02525ffc1 100644 --- a/source/_components/camera.yi.markdown +++ b/source/_components/camera.yi.markdown @@ -10,7 +10,7 @@ footer: true logo: yi.png ha_category: Camera 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: diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index 833302fe223..18ec9e71c7e 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -13,7 +13,7 @@ ha_category: - Camera - Sensor ha_release: "0.60" -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/alarm_control_panel.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 humidity. -- A sensor per camera that reports air quality. \ No newline at end of file +- A sensor per camera that reports air quality. diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index 7b67fe98aa8..d595b9e7741 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -11,7 +11,7 @@ logo: google_cast.png ha_category: Media Player featured: true ha_release: pre 0.7 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: /components/media_player.cast/ --- diff --git a/source/_components/climate.coolmaster.markdown b/source/_components/climate.coolmaster.markdown index ab68254c373..db9fa502df6 100644 --- a/source/_components/climate.coolmaster.markdown +++ b/source/_components/climate.coolmaster.markdown @@ -10,7 +10,7 @@ footer: true logo: coolautomation.png ha_category: Climate ha_release: 0.88 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/climate.ephember.markdown b/source/_components/climate.ephember.markdown index ebcdb1fccbe..d65a4bd33bd 100644 --- a/source/_components/climate.ephember.markdown +++ b/source/_components/climate.ephember.markdown @@ -10,7 +10,7 @@ footer: true logo: ephcontrolsember.png ha_category: Climate ha_release: 0.57 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/climate.eq3btsmart.markdown b/source/_components/climate.eq3btsmart.markdown index 292b58fdbf7..f61ee33481d 100644 --- a/source/_components/climate.eq3btsmart.markdown +++ b/source/_components/climate.eq3btsmart.markdown @@ -9,7 +9,8 @@ sharing: true footer: true logo: eq3.gif 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. diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown index 68b42151b67..4656d3a1683 100644 --- a/source/_components/climate.evohome.markdown +++ b/source/_components/climate.evohome.markdown @@ -10,7 +10,7 @@ footer: true logo: honeywell.png ha_category: Climate 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. diff --git a/source/_components/climate.flexit.markdown b/source/_components/climate.flexit.markdown index 4ef2ab70609..10360eeb2ed 100644 --- a/source/_components/climate.flexit.markdown +++ b/source/_components/climate.flexit.markdown @@ -10,7 +10,7 @@ footer: true logo: flexit.png ha_category: Climate 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. diff --git a/source/_components/climate.generic_thermostat.markdown b/source/_components/climate.generic_thermostat.markdown index 15207b93552..530547801af 100644 --- a/source/_components/climate.generic_thermostat.markdown +++ b/source/_components/climate.generic_thermostat.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_category: Climate 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. diff --git a/source/_components/climate.heatmiser.markdown b/source/_components/climate.heatmiser.markdown index 15aa2b99fe2..2a3858c5e8a 100644 --- a/source/_components/climate.heatmiser.markdown +++ b/source/_components/climate.heatmiser.markdown @@ -10,7 +10,7 @@ footer: true logo: heatmiser.png ha_category: Climate 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. diff --git a/source/_components/climate.honeywell.markdown b/source/_components/climate.honeywell.markdown index 844bfceed27..41195faddcc 100644 --- a/source/_components/climate.honeywell.markdown +++ b/source/_components/climate.honeywell.markdown @@ -10,7 +10,7 @@ footer: true logo: honeywell.png ha_category: Climate ha_release: pre 0.7 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index b25d43f21d3..6cfe8f565e4 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -10,7 +10,7 @@ footer: true logo: knx.png ha_category: Climate 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. @@ -136,7 +136,7 @@ controller_status_state_address: type: string controller_mode_address: description: KNX address for handling controller modes. - required: false + required: false type: string controller_mode_state_address: description: Explicit KNX address for reading HVAC Control Mode. diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown index fd41b437cd5..86b2d5e7ce9 100644 --- a/source/_components/climate.markdown +++ b/source/_components/climate.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.19 --- diff --git a/source/_components/climate.mill.markdown b/source/_components/climate.mill.markdown index 6f92a0a3443..77a3ea41a93 100644 --- a/source/_components/climate.mill.markdown +++ b/source/_components/climate.mill.markdown @@ -10,7 +10,7 @@ footer: true logo: mill.png ha_category: Climate ha_release: 0.81 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- Integrates Mill heater into Home Assistant. @@ -34,7 +34,7 @@ username: password: description: Your Mill password. required: true - type: string + type: string {% endconfiguration %} ## {% linkable_title Component services %} diff --git a/source/_components/climate.modbus.markdown b/source/_components/climate.modbus.markdown index 6aa4b250ad6..916bb77e312 100644 --- a/source/_components/climate.modbus.markdown +++ b/source/_components/climate.modbus.markdown @@ -10,7 +10,7 @@ footer: true logo: modbus.png ha_category: Climate ha_release: 0.68 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index 7e0cf3a0de5..fd34fb43702 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Climate 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. diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index 56d2e0714f4..31259de0e55 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -12,7 +12,7 @@ ha_category: - DIY - Climate 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. diff --git a/source/_components/climate.netatmo.markdown b/source/_components/climate.netatmo.markdown index d3c40c54fc4..6d71ba0b796 100644 --- a/source/_components/climate.netatmo.markdown +++ b/source/_components/climate.netatmo.markdown @@ -10,7 +10,7 @@ footer: true logo: netatmo.png ha_category: Climate ha_release: 0.31 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- diff --git a/source/_components/climate.oem.markdown b/source/_components/climate.oem.markdown index 98e9933cffc..86f7d93fd21 100644 --- a/source/_components/climate.oem.markdown +++ b/source/_components/climate.oem.markdown @@ -10,7 +10,7 @@ footer: true logo: oem.png ha_category: Climate ha_release: 0.39 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- This platform supports the ESP8266 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/). The underlying [library](http://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/). diff --git a/source/_components/climate.proliphix.markdown b/source/_components/climate.proliphix.markdown index 28748d520ca..71cecf0e8e8 100644 --- a/source/_components/climate.proliphix.markdown +++ b/source/_components/climate.proliphix.markdown @@ -10,7 +10,7 @@ footer: true logo: proliphix.png ha_category: Climate ha_release: 0.11 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/climate.radiotherm.markdown b/source/_components/climate.radiotherm.markdown index d7ffe2141ca..5a80198aaa7 100644 --- a/source/_components/climate.radiotherm.markdown +++ b/source/_components/climate.radiotherm.markdown @@ -9,7 +9,8 @@ sharing: true footer: true logo: radiotherm.png ha_category: Climate -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling +ha_release: 0.7.6 --- diff --git a/source/_components/climate.sensibo.markdown b/source/_components/climate.sensibo.markdown index f45c818e80a..4b55314d9f1 100644 --- a/source/_components/climate.sensibo.markdown +++ b/source/_components/climate.sensibo.markdown @@ -10,7 +10,7 @@ footer: true logo: sensibo.png ha_category: Climate ha_release: 0.44 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- Integrates [Sensibo](https://sensibo.com) Air Conditioning controller into Home Assistant. @@ -36,8 +36,8 @@ id: {% endconfiguration %}

-If you create the API key using a dedicated user (and not your main user), -then in the Sensibo app log you will be able to distinguish between actions +If you create the API key using a dedicated user (and not your main user), +then in the Sensibo app log you will be able to distinguish between actions done in the app and actions done by Home Assistant.

diff --git a/source/_components/climate.touchline.markdown b/source/_components/climate.touchline.markdown index 0f7f2719462..6e79192373f 100644 --- a/source/_components/climate.touchline.markdown +++ b/source/_components/climate.touchline.markdown @@ -10,10 +10,10 @@ footer: true logo: roth.png ha_category: Climate ha_release: 0.61 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- -The `touchline` climate platform let you control [ROTH Touchline](http://www.roth-nordic.dk/dk/roth-touchline-tradloes-gulvvarmeregulering-1475.htm) floor heating thermostats from Roth. +The `touchline` climate platform let you control [ROTH Touchline](http://www.roth-nordic.dk/dk/roth-touchline-tradloes-gulvvarmeregulering-1475.htm) floor heating thermostats from Roth. To set it up, add the following information to your `configuration.yaml` file: diff --git a/source/_components/climate.venstar.markdown b/source/_components/climate.venstar.markdown index 7337e19f62e..beb625ad060 100644 --- a/source/_components/climate.venstar.markdown +++ b/source/_components/climate.venstar.markdown @@ -10,7 +10,7 @@ footer: true logo: venstar.png ha_category: Climate ha_release: 0.62 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/climate.zhong_hong.markdown b/source/_components/climate.zhong_hong.markdown index 5d7d14d7919..d641ac2e59b 100644 --- a/source/_components/climate.zhong_hong.markdown +++ b/source/_components/climate.zhong_hong.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: zhong_hong.png ha_category: Climate -ha_release: "0.72" -ha_iot_class: "Local Push" +ha_release: 0.72 +ha_iot_class: Local Push --- diff --git a/source/_components/cloud.markdown b/source/_components/cloud.markdown index c66e755b434..0f7b2a61b7c 100644 --- a/source/_components/cloud.markdown +++ b/source/_components/cloud.markdown @@ -10,7 +10,7 @@ footer: true logo: nabu-casa.svg ha_release: "0.60" ha_category: Voice -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push --- The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa and Google Assistant. [Learn more.](/cloud) diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown index de36ccbe86f..c085413ad05 100644 --- a/source/_components/cloudflare.markdown +++ b/source/_components/cloudflare.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: cloudflare.png ha_category: Network -featured: false ha_release: 0.74 --- diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown index 226652d8d6a..42a289aadc4 100644 --- a/source/_components/coinbase.markdown +++ b/source/_components/coinbase.markdown @@ -12,7 +12,7 @@ ha_category: - Finance - Sensor ha_release: 0.61 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/sensor.coinbase/ --- diff --git a/source/_components/comfoconnect.markdown b/source/_components/comfoconnect.markdown index b2c3660ec80..7fe631538dc 100644 --- a/source/_components/comfoconnect.markdown +++ b/source/_components/comfoconnect.markdown @@ -11,7 +11,7 @@ logo: zehnder.png ha_category: - Fan - Sensor -ha_release: "0.48" +ha_release: 0.48 redirect_from: - /components/fan.comfoconnect/ - /components/sensor.comfoconnect/ diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown index 0d033105f77..27c9bfde146 100644 --- a/source/_components/configurator.markdown +++ b/source/_components/configurator.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Other ha_qa_scale: internal +ha_release: 0.7 ---

diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index ed949157290..a6a459873b3 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: "Voice" ha_qa_scale: internal +ha_release: 0.7 --- The conversation component allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text. diff --git a/source/_components/cover.aladdin_connect.markdown b/source/_components/cover.aladdin_connect.markdown index f0f35c71027..765e9b0f698 100644 --- a/source/_components/cover.aladdin_connect.markdown +++ b/source/_components/cover.aladdin_connect.markdown @@ -10,7 +10,7 @@ footer: true logo: aladdin_connect.png ha_category: Cover ha_release: 0.75 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `aladdin_connect` cover platform lets you control Genie Aladdin Connect garage doors through Home Assistant. @@ -32,7 +32,7 @@ cover: ``` {% configuration %} -username: +username: description: Your Aladdin Connect account username. required: true type: string diff --git a/source/_components/cover.brunt.markdown b/source/_components/cover.brunt.markdown index 536eb1c1802..b3c53c0b1f9 100644 --- a/source/_components/cover.brunt.markdown +++ b/source/_components/cover.brunt.markdown @@ -10,7 +10,7 @@ footer: true logo: brunt.png ha_category: Cover ha_release: 0.75 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `brunt` platform allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use this sensor, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app. diff --git a/source/_components/cover.command_line.markdown b/source/_components/cover.command_line.markdown index d72862e0af5..3d1429c223d 100644 --- a/source/_components/cover.command_line.markdown +++ b/source/_components/cover.command_line.markdown @@ -10,7 +10,7 @@ footer: true logo: command_line.png ha_category: Cover ha_release: 0.14 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- A `command_line`cover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line. diff --git a/source/_components/cover.garadget.markdown b/source/_components/cover.garadget.markdown index e232a615089..0ff17fb3d3d 100644 --- a/source/_components/cover.garadget.markdown +++ b/source/_components/cover.garadget.markdown @@ -10,7 +10,7 @@ footer: true logo: garadget.png ha_category: Cover ha_release: 0.32 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- @@ -22,14 +22,20 @@ To enable Garadget Covers in your installation, add the following to your `confi ```yaml # Example configuration.yaml entry -cover: + + cover: - platform: garadget covers: - 190028001947343412342341: + first_garage: + device: 190028001947343412342341 username: YOUR_USERNAME password: YOUR_PASSWORD - 4c003f001151353432134214: + name: first_garage + second_garage: + device: 4c003f001151353432134214 access_token: df4cc785ff818f2b01396c44142342fccdef + name: second_garage + ``` {% configuration %} @@ -37,12 +43,12 @@ covers: description: List of your doors. required: true type: list - keys: - device: - description: This is the device id from your Garadget portal. - required: true - type: string + covers: keys: + device: + description: This is the device id from your Garadget portal. + required: true + type: string username: description: Your Garadget account username. required: true @@ -76,7 +82,8 @@ If provided, the **access_token** will be used, otherwise the **username** and * cover: - platform: garadget covers: - 190028001947343412342341: + garadget: + device: 190028001947343412342341 access_token: !secret garadget_access_token name: Garage door diff --git a/source/_components/cover.group.markdown b/source/_components/cover.group.markdown index 93f50ab5785..581cddc4b1b 100644 --- a/source/_components/cover.group.markdown +++ b/source/_components/cover.group.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Cover ha_release: 0.66 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/cover.knx.markdown b/source/_components/cover.knx.markdown index 4e43d315cf1..d7861c41429 100644 --- a/source/_components/cover.knx.markdown +++ b/source/_components/cover.knx.markdown @@ -10,7 +10,7 @@ footer: true logo: knx.png ha_category: Cover ha_release: 0.48 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/cover.markdown b/source/_components/cover.markdown index dcb91354422..34674ff60dc 100644 --- a/source/_components/cover.markdown +++ b/source/_components/cover.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.27 --- Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors. diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index e47fbfc8c03..a235da33c7d 100644 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Cover -ha_iot_class: "depends" +ha_iot_class: Configurable ha_release: 0.18 --- diff --git a/source/_components/cover.mysensors.markdown b/source/_components/cover.mysensors.markdown index e4674164bb1..4e0fb43fa01 100644 --- a/source/_components/cover.mysensors.markdown +++ b/source/_components/cover.mysensors.markdown @@ -12,7 +12,7 @@ ha_category: - DIY - Cover ha_release: "0.30" -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- Integrates MySensors covers into Home Assistant. See the [main component] for configuration instructions. diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index b7118e97961..6c693c74201 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Cover ha_release: 0.48 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/cover.xiaomi_aqara.markdown b/source/_components/cover.xiaomi_aqara.markdown index 6f5353b9c83..ea54bf27449 100644 --- a/source/_components/cover.xiaomi_aqara.markdown +++ b/source/_components/cover.xiaomi_aqara.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Cover ha_release: "0.50" -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index 6945eb5c990..addd13452d7 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -12,7 +12,7 @@ ha_category: - Climate - Sensor ha_release: 0.59 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/climate.daikin/ - /components/sensor.daikin/ @@ -68,4 +68,4 @@ Current temperature is displayed. The `daikin` sensor platform integrates Daikin air conditioning systems into Home Assistant, enabling displaying the following parameters: - Inside temperature -- Outside temperature \ No newline at end of file +- Outside temperature diff --git a/source/_components/danfoss_air.markdown b/source/_components/danfoss_air.markdown index 2e45788d1d3..77dcba62a68 100644 --- a/source/_components/danfoss_air.markdown +++ b/source/_components/danfoss_air.markdown @@ -11,9 +11,9 @@ ha_category: - Climate - Binary Sensor - Sensor -ha_release: "0.87" +ha_release: 0.87 logo: danfoss_air.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.danfoss_air/ - /components/sensor.danfoss_air/ diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index 19621309a7b..aa04bd3228d 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -16,8 +16,8 @@ ha_category: - Scene - Sensor - Switch -ha_release: "0.61" -ha_iot_class: "Local Push" +ha_release: 0.61 +ha_iot_class: Local Push ha_qa_scale: platinum ha_config_flow: true redirect_from: diff --git a/source/_components/default_config.markdown b/source/_components/default_config.markdown index 852d8803c6e..ff2eb6b6fdd 100644 --- a/source/_components/default_config.markdown +++ b/source/_components/default_config.markdown @@ -10,7 +10,6 @@ footer: true logo: home-assistant.png ha_category: Other ha_release: 0.88 -featured: false --- This component is a meta-component and configures a default set of components for Home Assistant to load. The components that will be loaded can be found [here](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/default_config/__init__.py). diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown index 1107426877f..1048aa1c236 100644 --- a/source/_components/demo.markdown +++ b/source/_components/demo.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Other ha_qa_scale: internal +ha_release: 0.7 --- diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index ffb052445ea..fd037b48c40 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Automation ha_qa_scale: internal +ha_release: pre 0.7 --- Home Assistant has a built-in component called `device_sun_light_trigger` to help you automate your lights. The component will: diff --git a/source/_components/device_tracker.actiontec.markdown b/source/_components/device_tracker.actiontec.markdown index 524cc707a5d..fc7eddad7b9 100644 --- a/source/_components/device_tracker.actiontec.markdown +++ b/source/_components/device_tracker.actiontec.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: actiontec.png ha_category: Presence Detection +ha_release: 0.7 --- diff --git a/source/_components/device_tracker.automatic.markdown b/source/_components/device_tracker.automatic.markdown index e4d8880f57e..129f158cb88 100644 --- a/source/_components/device_tracker.automatic.markdown +++ b/source/_components/device_tracker.automatic.markdown @@ -10,7 +10,7 @@ footer: true logo: automatic.png ha_category: Car ha_release: 0.28 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push --- diff --git a/source/_components/device_tracker.bbox.markdown b/source/_components/device_tracker.bbox.markdown index 5efa022bad2..6247246d64d 100644 --- a/source/_components/device_tracker.bbox.markdown +++ b/source/_components/device_tracker.bbox.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: bbox.png ha_category: Presence Detection -ha_release: "0.31" -ha_iot_class: "Local Polling" +ha_release: 0.31 +ha_iot_class: Local Polling --- diff --git a/source/_components/device_tracker.bluetooth_le_tracker.markdown b/source/_components/device_tracker.bluetooth_le_tracker.markdown index 3cef5e1b2d2..ca14cce35d5 100644 --- a/source/_components/device_tracker.bluetooth_le_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_le_tracker.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: bluetooth.png ha_category: Presence Detection -ha_iot_class: "Local Poll" +ha_iot_class: Local Polling ha_release: 0.27 --- diff --git a/source/_components/device_tracker.bluetooth_tracker.markdown b/source/_components/device_tracker.bluetooth_tracker.markdown index 4811c61729b..3da5cc19802 100644 --- a/source/_components/device_tracker.bluetooth_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_tracker.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: bluetooth.png ha_category: Presence Detection -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.18 --- diff --git a/source/_components/device_tracker.bt_home_hub_5.markdown b/source/_components/device_tracker.bt_home_hub_5.markdown index 22c67170fab..86707d106e8 100644 --- a/source/_components/device_tracker.bt_home_hub_5.markdown +++ b/source/_components/device_tracker.bt_home_hub_5.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: bt.png ha_category: Presence Detection +ha_release: 0.22 --- This platform offers presence detection by looking at connected devices to a [BT Home Hub 5](https://en.wikipedia.org/wiki/BT_Home_Hub) based router. diff --git a/source/_components/device_tracker.bt_smarthub.markdown b/source/_components/device_tracker.bt_smarthub.markdown index 1f6f4f77f21..c1961395428 100644 --- a/source/_components/device_tracker.bt_smarthub.markdown +++ b/source/_components/device_tracker.bt_smarthub.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: bt.png ha_category: Presence Detection -ha_release: "0.82" -ha_iot_class: "Local Polling" +ha_release: 0.82 +ha_iot_class: Local Polling --- This platform offers presence detection by looking at connected devices to a [BT Smart Hub](https://en.wikipedia.org/wiki/BT_Smart_Hub) based router. @@ -28,7 +28,7 @@ device_tracker: {% configuration %} host: - description: The IP address of your router + description: The IP address of your router default: 192.168.1.254 required: false type: string diff --git a/source/_components/device_tracker.ee_brightbox.markdown b/source/_components/device_tracker.ee_brightbox.markdown index 8a0ef3b31fa..8fc30c29636 100644 --- a/source/_components/device_tracker.ee_brightbox.markdown +++ b/source/_components/device_tracker.ee_brightbox.markdown @@ -10,7 +10,7 @@ footer: true logo: ee.png ha_category: Presence Detection ha_release: 0.87 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- This platform offers presence detection by looking at connected devices to a [EE Bright Box 2](https://ee.co.uk/help/phones-and-device/home-broadband/bright-box-2-wireless-router/bright-box-2-wireless-router) router. @@ -40,7 +40,7 @@ username: password: description: Found at the back of the router in 'Router login details' section required: true - type: string + type: string version: description: Currently only version 2 of the router is supported default: 2 diff --git a/source/_components/device_tracker.geofency.markdown b/source/_components/device_tracker.geofency.markdown index 13f4a773e50..28ffae6161a 100644 --- a/source/_components/device_tracker.geofency.markdown +++ b/source/_components/device_tracker.geofency.markdown @@ -10,7 +10,7 @@ footer: true logo: geofency.png ha_category: Presence Detection ha_release: 0.53 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push --- This platform allows you to detect presence using [Geofency](http://www.geofency.com/). diff --git a/source/_components/device_tracker.google_maps.markdown b/source/_components/device_tracker.google_maps.markdown index d2a6a643121..e04d4130806 100644 --- a/source/_components/device_tracker.google_maps.markdown +++ b/source/_components/device_tracker.google_maps.markdown @@ -10,7 +10,7 @@ footer: true logo: google_maps.png ha_release: 0.67 ha_category: Presence Detection -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing). diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index ee06fbd6bba..f6f70973e57 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.7 --- Home Assistant can get information from your wireless router or third party services like iCloud or OwnTracks to track which devices are connected and considered "in home". Please check the sidebar for a list of brands of supported wireless routers and services. diff --git a/source/_components/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown index ca3415eafdd..a370e6f10e2 100644 --- a/source/_components/device_tracker.mqtt.markdown +++ b/source/_components/device_tracker.mqtt.markdown @@ -9,7 +9,8 @@ sharing: true footer: true logo: mqtt.png ha_category: Presence Detection -ha_iot_class: depends +ha_iot_class: Configurable +ha_release: 0.7.3 --- diff --git a/source/_components/device_tracker.mqtt_json.markdown b/source/_components/device_tracker.mqtt_json.markdown index 3ebee387274..c896651e2f3 100644 --- a/source/_components/device_tracker.mqtt_json.markdown +++ b/source/_components/device_tracker.mqtt_json.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: mqtt.png ha_category: Presence Detection -ha_iot_class: depends +ha_iot_class: Configurable ha_release: 0.44 --- diff --git a/source/_components/device_tracker.mysensors.markdown b/source/_components/device_tracker.mysensors.markdown index ac3cb137eeb..4f8fb3b92d8 100644 --- a/source/_components/device_tracker.mysensors.markdown +++ b/source/_components/device_tracker.mysensors.markdown @@ -11,8 +11,8 @@ logo: mysensors.png ha_category: - DIY - Presence Detection -ha_release: "0.38" -ha_iot_class: "Local Push" +ha_release: 0.38 +ha_iot_class: Local Push --- Integrates MySensors device trackers into Home Assistant. See the [main component] for configuration instructions. diff --git a/source/_components/device_tracker.netgear.markdown b/source/_components/device_tracker.netgear.markdown index 0f27e78ac1b..ae502478569 100644 --- a/source/_components/device_tracker.netgear.markdown +++ b/source/_components/device_tracker.netgear.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: netgear.png ha_category: Presence Detection -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: pre 0.7 --- diff --git a/source/_components/device_tracker.nmap_tracker.markdown b/source/_components/device_tracker.nmap_tracker.markdown index 27cbb88d448..b0b6b8894c8 100644 --- a/source/_components/device_tracker.nmap_tracker.markdown +++ b/source/_components/device_tracker.nmap_tracker.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: nmap.png ha_category: Presence Detection -featured: false +ha_release: 0.7 --- diff --git a/source/_components/device_tracker.thomson.markdown b/source/_components/device_tracker.thomson.markdown index 97decda817a..d3602ece2f0 100644 --- a/source/_components/device_tracker.thomson.markdown +++ b/source/_components/device_tracker.thomson.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: technicolor.png ha_category: Presence Detection +ha_release: 0.7 --- diff --git a/source/_components/device_tracker.tile.markdown b/source/_components/device_tracker.tile.markdown index db352e8ba6e..a07f6fbe264 100644 --- a/source/_components/device_tracker.tile.markdown +++ b/source/_components/device_tracker.tile.markdown @@ -10,7 +10,7 @@ footer: true logo: tile.png ha_release: 0.58 ha_category: Presence Detection -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `tile` platform allows Home Assistant to utilize [Tile® Bluetooth trackers](https://www.thetileapp.com). diff --git a/source/_components/device_tracker.traccar.markdown b/source/_components/device_tracker.traccar.markdown index 17da63ecc64..d76b6eb7d26 100644 --- a/source/_components/device_tracker.traccar.markdown +++ b/source/_components/device_tracker.traccar.markdown @@ -10,7 +10,7 @@ footer: true logo: traccar.png ha_release: 0.83 ha_category: Presence Detection -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- `Traccar` uses GPS for tracking and has support for over 1500 different types of devices. diff --git a/source/_components/device_tracker.trackr.markdown b/source/_components/device_tracker.trackr.markdown index 962300ed1ea..ee5373c0516 100644 --- a/source/_components/device_tracker.trackr.markdown +++ b/source/_components/device_tracker.trackr.markdown @@ -10,11 +10,11 @@ footer: true logo: trackr.png ha_release: 0.36 ha_category: Presence Detection -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- -The `trackr` platform allows you to detect presence using [TrackR](https://www.thetrackr.com/) devices. +The `trackr` platform allows you to detect presence using [TrackR](https://www.thetrackr.com/) devices. The official TrackR mobile app handles the tracking of the TrackR devices using your phones Bluetooth and GPS. diff --git a/source/_components/device_tracker.unifi_direct.markdown b/source/_components/device_tracker.unifi_direct.markdown index 9bc5ad22104..7595c129149 100644 --- a/source/_components/device_tracker.unifi_direct.markdown +++ b/source/_components/device_tracker.unifi_direct.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: ubiquiti.png ha_category: Presence Detection -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.59 --- diff --git a/source/_components/device_tracker.xiaomi_miio.markdown b/source/_components/device_tracker.xiaomi_miio.markdown index 850e2fee69d..5e8e6a2f431 100644 --- a/source/_components/device_tracker.xiaomi_miio.markdown +++ b/source/_components/device_tracker.xiaomi_miio.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: xiaomi.png ha_category: Presence Detection -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.67 --- diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index e81b69d7602..efef285aa7b 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: dialogflow.png ha_category: Voice -featured: false ha_release: 0.56 redirect_from: /components/apiai/ --- diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index 8826e929604..7449ceb98f0 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -13,7 +13,7 @@ ha_category: - Switch ha_release: "0.30" logo: digital_ocean.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.digital_ocean/ - /components/switch.digital_ocean/ diff --git a/source/_components/discoverable.markdown b/source/_components/discoverable.markdown deleted file mode 100644 index 03e2880a408..00000000000 --- a/source/_components/discoverable.markdown +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: page -title: "Discoverable" -description: "Instructions on how to setup the discoverable component with Home Assistant." -date: 2016-03-01 07:00 -sidebar: true -comments: false -sharing: true -footer: true ---- - -The Home Assistant discovery protocol is a lightweight feature that introduces support for Home Assistant servers to be discoverable. This will allow [Home Assistant instances](https://github.com/balloob/micropython-home-assistant) running with [MicroPython](https://micropython.org/) to get started without any required configuration (Example from the [MicroPython Home Assistant](https://github.com/balloob/micropython-home-assistant) documentation): - -```python -from homeassistant.discovery import get_instance() - -hass = get_instance() - -for state in hass.states(): - print(state) -``` - -To enable `discovery` in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -discoverable: - expose_password: true -``` - -{% configuration %} -expose_password: - description: It is up to the user to expose the password in the discovery response. If password not exposed, uHA instances will have to provide it (`get_instance('my password')`). - required: false - default: false - type: boolean -{% endconfiguration %} diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 4f2a4ed2810..eeb782a8b9c 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Other ha_qa_scale: internal +ha_release: 0.7 --- Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [uPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` component can detect: diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown index 4f1d1618915..20ea8157c4b 100644 --- a/source/_components/dominos.markdown +++ b/source/_components/dominos.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: dominos.png ha_category: Other -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.59 --- diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown index 42284722111..fe1e15b1413 100644 --- a/source/_components/doorbird.markdown +++ b/source/_components/doorbird.markdown @@ -12,8 +12,8 @@ ha_category: - Doorbell - Camera - Switch -ha_release: "0.54" -ha_iot_class: "Local Push" +ha_release: 0.54 +ha_iot_class: Local Push redirect_from: - /components/camera.doorbird/ - /components/switch.doorbird/ @@ -173,4 +173,4 @@ To enable this switch, add the following lines to your `configuration.yaml` file # Example configuration.yaml entry switch: - platform: doorbird -``` \ No newline at end of file +``` diff --git a/source/_components/dovado.markdown b/source/_components/dovado.markdown index d0f9705bd6b..10d73bc62b0 100644 --- a/source/_components/dovado.markdown +++ b/source/_components/dovado.markdown @@ -13,7 +13,7 @@ ha_category: - Sensor logo: dovado.png ha_release: 0.87 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/notify.dovado/ - /components/sensor.dovado/ @@ -116,4 +116,4 @@ sensors: description: Creates a sensor for download speed. sms: description: Creates a sensor for number of unread text messages. -{% endconfiguration %} \ No newline at end of file +{% endconfiguration %} diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index 9548049cf6d..cb1ef278c8a 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: duckdns.png ha_category: Network -featured: false ha_release: 0.55 --- @@ -38,5 +37,5 @@ duckdns: {% endconfiguration %}

-If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this component is not required. The add-on will keep your IP updated with DuckDNS. +If you are running the Hass.io [DuckDNS add-on](/addons/duckdns/) this component is not required. The add-on will keep your IP updated with DuckDNS.

diff --git a/source/_components/dweet.markdown b/source/_components/dweet.markdown index 41a45e6d6f5..5d17ce02f9c 100644 --- a/source/_components/dweet.markdown +++ b/source/_components/dweet.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: dweet.png ha_category: "History" -featured: false ha_release: 0.19 --- diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown index 94f8e916801..256cf982b9e 100644 --- a/source/_components/dyson.markdown +++ b/source/_components/dyson.markdown @@ -14,7 +14,7 @@ ha_category: - Fan - Sensor - Vacuum -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.47 redirect_from: - /components/vacuum.dyson/ @@ -156,4 +156,4 @@ The `dyson` sensor platform allows you to control your Dyson Purifier's filter l ### {% linkable_title Supported fan devices %} - Pure Cool link (desk and tower) -- Pure Hot+cool link (see climate part) for thermal control \ No newline at end of file +- Pure Hot+cool link (see climate part) for thermal control diff --git a/source/_components/ebusd.markdown b/source/_components/ebusd.markdown index 4ed01d16e2e..3d178f26eed 100644 --- a/source/_components/ebusd.markdown +++ b/source/_components/ebusd.markdown @@ -8,8 +8,8 @@ comments: false sharing: true footer: true ha_category: Sensor -ha_iot_class: "Local Polling" -ha_release: "0.88" +ha_iot_class: Local Polling +ha_release: 0.88 redirect_from: - /components/sensor.ebusd/ --- diff --git a/source/_components/ecoal_boiler.markdown b/source/_components/ecoal_boiler.markdown index 4eeb3a5f4b6..24f9ba1d49b 100644 --- a/source/_components/ecoal_boiler.markdown +++ b/source/_components/ecoal_boiler.markdown @@ -10,7 +10,7 @@ footer: true # logo: raspberry-pi.png ha_category: Water heater ha_release: 0.87 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/sensor.ecoal_boiler/ - /components/switch.ecoal_boiler/ @@ -50,7 +50,7 @@ username: type: string password: description: Password for username. - required: false + required: false default: admin type: string switches: @@ -72,7 +72,7 @@ sensors: description: controller available source of sensors required: false type: list - default: all (`outdoor_temp`, `indoor_temp`, `indoor2_temp`, `domestic_hot_water_temp`, `target_domestic_hot_water_temp`, + default: all (`outdoor_temp`, `indoor_temp`, `indoor2_temp`, `domestic_hot_water_temp`, `target_domestic_hot_water_temp`, `feedwater_in_temp`, `feedwater_out_temp`, `target_feedwater_temp`, `fuel_feeder_temp`, `exhaust_temp`) {% endconfiguration %} diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 7be04ae8246..83390c4adc2 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -16,7 +16,7 @@ ha_category: - Weather featured: true ha_release: 0.9 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push redirect_from: - /components/sensor.ecobee/ - /components/binary_sensor.ecobee/ @@ -29,7 +29,7 @@ The `ecobee` component lets you control a thermostats and view sensor data from ## {% linkable_title Configuration %} -You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that perform the following steps. +You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that perform the following steps. 1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/). 2. Login with your ecobee credentials. @@ -147,10 +147,10 @@ auto, and off. ## {% linkable_title Attributes %} The following attributes are provided by the Ecobee Thermostat: -`name`, `temperature_unit`, `current_temperature`, `target_temperature`, -`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`, +`name`, `temperature_unit`, `current_temperature`, `target_temperature`, +`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`, `fan`, `current_hold_mode`, `current_operation`, `operation_list`, -`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`, +`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`, `is_away_mode_on`, `vacation`, `climate_list`, `aux_heat`. The attributes `min_temp` and `max_temp` are meaningless constant values. @@ -302,7 +302,7 @@ Returns the current auxiliary heat state. ## {% linkable_title Services %} The following services are provided by the Ecobee Thermostat: -`set_away_mode`, `set_hold_mode`, `set_temperature`, `set_operation_mode`, +`set_away_mode`, `set_hold_mode`, `set_temperature`, `set_operation_mode`, `fan_min_on_time`, `resume_program`. The services `set_aux_heat`, `set_humidity`, `set_fan_mode`, and `set_swing_mode` offered by the [Climate component](/components/climate/) @@ -324,7 +324,7 @@ and any other hold based on a reference climate, the target temperature is taken from the reference climate. For 'temp', the current temperature is taken as the target temperature. When None is provided as parameter, the hold_mode is turned off. -It is not possible to set a vacation hold; such hold has to be +It is not possible to set a vacation hold; such hold has to be defined on the thermostat directly. However, a vacation hold can be canceled. diff --git a/source/_components/ecovacs.markdown b/source/_components/ecovacs.markdown index 1f5157073e1..150f53e7e3a 100644 --- a/source/_components/ecovacs.markdown +++ b/source/_components/ecovacs.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: ecovacs.png ha_category: Hub -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push ha_release: 0.77 --- diff --git a/source/_components/edp_redy.markdown b/source/_components/edp_redy.markdown index a32006cc74e..7f64aed9867 100644 --- a/source/_components/edp_redy.markdown +++ b/source/_components/edp_redy.markdown @@ -12,8 +12,8 @@ ha_category: - Hub - Sensor - Switch -ha_release: "0.79" -ha_iot_class: "Cloud Polling" +ha_release: 0.79 +ha_iot_class: Cloud Polling redirect_from: - /components/sensor.edp_redy/ - /components/switch.edp_redy/ diff --git a/source/_components/egardia.markdown b/source/_components/egardia.markdown index 6ddc126b24a..39d7a66a367 100644 --- a/source/_components/egardia.markdown +++ b/source/_components/egardia.markdown @@ -13,7 +13,7 @@ ha_category: - Alarm - Binary Sensor ha_release: 0.65 -ha_iot_class: "Polling" +ha_iot_class: Local Polling redirect_from: - /components/alarm_control_panel.egardia/ - /components/binary_sensor.egardia/ @@ -129,4 +129,4 @@ Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entere ## {% linkable_title Binary Sensor %} The `egardia` platform allows you to get data from your [Egardia](http://www.egardia.com)/[Woonveilig](http://www.woonveilig.nl) binary sensors from within Home Assistant. -Currently only door contacts are supported. IR sensors are not supported and will probably never be since their status cannot be read outside of the alarm control panel. Smoke sensors and others might be added but currently are not supported. \ No newline at end of file +Currently only door contacts are supported. IR sensors are not supported and will probably never be since their status cannot be read outside of the alarm control panel. Smoke sensors and others might be added but currently are not supported. diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 1103bc328a6..58f59a4c8ab 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -12,8 +12,8 @@ ha_category: - Health - Binary Sensor - Sensor -ha_release: "0.44" -ha_iot_class: "Cloud Polling" +ha_release: 0.44 +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.eight_sleep/ - /components/sensor.eight_sleep/ diff --git a/source/_components/elkm1.markdown b/source/_components/elkm1.markdown index 3593bce7fbc..61dc2e45acb 100644 --- a/source/_components/elkm1.markdown +++ b/source/_components/elkm1.markdown @@ -17,7 +17,7 @@ ha_category: - Scene - Sensor - Switch -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/alarm_control_panel.elkm1/ - /components/climate.elkm1/ diff --git a/source/_components/emoncms_history.markdown b/source/_components/emoncms_history.markdown index 00f978f7fd6..0cc83e62982 100644 --- a/source/_components/emoncms_history.markdown +++ b/source/_components/emoncms_history.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: emoncms.png ha_category: History -featured: false ha_release: 0.31 --- diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index fd7c73fe024..d766b0604db 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_category: Hub ha_release: 0.27 -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_qa_scale: internal --- diff --git a/source/_components/emulated_roku.markdown b/source/_components/emulated_roku.markdown index 78685959573..3a3bf3bd50a 100644 --- a/source/_components/emulated_roku.markdown +++ b/source/_components/emulated_roku.markdown @@ -9,24 +9,24 @@ sharing: true footer: true logo: home-assistant.png ha_category: Hub -ha_release: 0.86.0 -ha_iot_class: "Local Push" +ha_release: 0.86 +ha_iot_class: Local Push --- -This component integrates an emulated Roku API into Home Assistant, -so remotes such as Harmony and Android apps can connect to it through WiFi as if it were a Roku player. -Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations. -Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries. +This component integrates an emulated Roku API into Home Assistant, +so remotes such as Harmony and Android apps can connect to it through WiFi as if it were a Roku player. +Home Assistant will see key presses and app launches as Events, which you can use as triggers for automations. +Multiple Roku servers may be started if you run out of buttons by specifying multiple server entries. -

+

Windows is not supported because Home Assistant uses `ProactorEventLoop` which does not support UDP sockets. -

+

-

+

This component opens an unauthenticated API on the host, allowing anything on the local network to access your Home Assistant instance through the automations you create with emulated Roku as the trigger. Using a proxy with whitelisted IP addresses is recommended. (set `advertise_ip` to the proxy's ip or DNS name) -

+

## {% linkable_title Configuration %} @@ -83,7 +83,7 @@ Field | Description `source_name` | Name of the emulated Roku instance that sent the event. Only required when using multiple instances to filter event sources. `type` | The type of the event that was called on the API. `key` | the code of the pressed key when the command `type` is `keypress`, `keyup` or `keydown`. -`app_id` | the id of the app that was launched when command `type` is `launch`. +`app_id` | the id of the app that was launched when command `type` is `launch`. The available keys are listed here: [Roku key codes](https://sdkdocs.roku.com/display/sdkdoc/External+Control+API#ExternalControlAPI-KeypressKeyValues) @@ -120,6 +120,6 @@ Known limitations: * Harmony uses UPnP discovery (UPnP is not needed after pairing), which might not work in Docker. You can: * Change Docker to host networking temporarily, then revert after pairing. * Run the `advertise.py` helper script from the emulated_roku library directly somewhere else and point it to the emulated Roku API. -* Harmony cannot launch apps as it uses IR instead of the WiFi API and will not display the custom dummy app list. +* Harmony cannot launch apps as it uses IR instead of the WiFi API and will not display the custom dummy app list. * Home control buttons cannot be assigned to emulated Roku on the Harmony Hub Companion remote as they are limited to Hue (and possibly other APIs) within Harmony. * Harmony will not set the name of the added emulated Roku device to the specified `name`. diff --git a/source/_components/enocean.markdown b/source/_components/enocean.markdown index 5e49cd1d6fc..3166d601edd 100644 --- a/source/_components/enocean.markdown +++ b/source/_components/enocean.markdown @@ -15,7 +15,7 @@ ha_category: - Light - Switch ha_release: 0.21 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.enocean/ - /components/sensor.enocean/ diff --git a/source/_components/envisalink.markdown b/source/_components/envisalink.markdown index 3396d2ba5fa..3cd6efeb54c 100644 --- a/source/_components/envisalink.markdown +++ b/source/_components/envisalink.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor - Sensor ha_release: 0.23 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/alarm_control_panel.envisalink/ - /components/binary_sensor.envisalink/ diff --git a/source/_components/esphome.markdown b/source/_components/esphome.markdown index 736d2cc49e7..1374f5f3054 100644 --- a/source/_components/esphome.markdown +++ b/source/_components/esphome.markdown @@ -11,7 +11,7 @@ footer: true logo: esphome.png ha_category: DIY ha_release: 0.85 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.esphome/ - /components/cover.esphome/ diff --git a/source/_components/eufy.markdown b/source/_components/eufy.markdown index 7a7b7268df6..1a979bceaa9 100644 --- a/source/_components/eufy.markdown +++ b/source/_components/eufy.markdown @@ -13,7 +13,7 @@ ha_category: - Light - Switch ha_release: 0.68 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/light.eufy/ - /components/switch.eufy/ diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown index c789e2bda5d..7ac73150974 100644 --- a/source/_components/evohome.markdown +++ b/source/_components/evohome.markdown @@ -10,7 +10,7 @@ footer: true logo: honeywell.png ha_category: Hub ha_release: 0.80 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `evohome` component is the main component to set up and integrate all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, primarily the Honeywell evohome multi-zone CH/DHW system. It does not support the home security functionality of TCC. diff --git a/source/_components/fan.markdown b/source/_components/fan.markdown index aac9c8c7636..4b306d1ef68 100644 --- a/source/_components/fan.markdown +++ b/source/_components/fan.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.27 --- diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown index 0fa472b74fb..28c6649e9d9 100644 --- a/source/_components/fan.mqtt.markdown +++ b/source/_components/fan.mqtt.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Fan ha_release: 0.27 -ha_iot_class: depends +ha_iot_class: Configurable --- The `mqtt` fan platform lets you control your MQTT enabled fans. diff --git a/source/_components/fan.template.markdown b/source/_components/fan.template.markdown index a9f2420ec07..c0affecac78 100644 --- a/source/_components/fan.template.markdown +++ b/source/_components/fan.template.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Fan ha_release: 0.69 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/fan.xiaomi_miio.markdown b/source/_components/fan.xiaomi_miio.markdown index b5f98b37ae4..00f03b3d3f7 100644 --- a/source/_components/fan.xiaomi_miio.markdown +++ b/source/_components/fan.xiaomi_miio.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: xiaomi.png ha_category: Fan -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.57 --- diff --git a/source/_components/fastdotcom.markdown b/source/_components/fastdotcom.markdown index 6a9f1c32aa7..9c1f730bda4 100644 --- a/source/_components/fastdotcom.markdown +++ b/source/_components/fastdotcom.markdown @@ -11,9 +11,8 @@ logo: fastdotcom.png ha_category: - System Monitor - Sensor -featured: false ha_release: 0.88 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/sensor.fastdotcom/ --- diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown index c7d2bf7028b..642faa60818 100644 --- a/source/_components/ffmpeg.markdown +++ b/source/_components/ffmpeg.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: ffmpeg.png ha_category: Image Processing +ha_release: 0.29 --- The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update. diff --git a/source/_components/fibaro.markdown b/source/_components/fibaro.markdown index 74cc296aa04..eb38097daca 100644 --- a/source/_components/fibaro.markdown +++ b/source/_components/fibaro.markdown @@ -16,8 +16,8 @@ ha_category: - Sensor - Scene - Switch -ha_release: "0.83" -ha_iot_class: "Local Push" +ha_release: 0.83 +ha_iot_class: Local Push redirect_from: - /components/scene.fibaro/ - /components/binary_sensor.fibaro/ diff --git a/source/_components/folder_watcher.markdown b/source/_components/folder_watcher.markdown index 1616a285b03..94ef47a20ce 100644 --- a/source/_components/folder_watcher.markdown +++ b/source/_components/folder_watcher.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: System Monitor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.67 ha_qa_scale: internal --- diff --git a/source/_components/foursquare.markdown b/source/_components/foursquare.markdown index 5d06ddaa085..1c507ab63a2 100644 --- a/source/_components/foursquare.markdown +++ b/source/_components/foursquare.markdown @@ -8,10 +8,9 @@ comments: false sharing: true footer: true logo: foursquare.png -featured: false ha_category: Social ha_release: 0.26 -ha_iot_class: "Cloud Polling and Cloud Push" +ha_iot_class: Cloud Polling and Cloud Push --- The `foursquare` component accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm. @@ -37,14 +36,14 @@ push_secret: #### Getting the access token #### After you have registered your APP on your [My Apps Page](https://foursquare.com/developers/apps) you get a `CLIENT_ID` and you have specified a -`REDIRECT_URL` which can be any URL you like, but since it will get your access token via an HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant. +`REDIRECT_URL` which can be any URL you like, but since it will get your access token via an HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant. Visit the following URL in your browser: ``` https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=token&redirect_uri=YOUR_REGISTERED_REDIRECT_URI ``` -and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values. +and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values. You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes". After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`. diff --git a/source/_components/freebox.markdown b/source/_components/freebox.markdown index b8e3b8f1dd6..a2e8344c895 100644 --- a/source/_components/freebox.markdown +++ b/source/_components/freebox.markdown @@ -12,8 +12,8 @@ ha_category: - Network - Presence Detection - Sensor -ha_release: "0.85" -ha_iot_class: "Local Polling" +ha_release: 0.85 +ha_iot_class: Local Polling redirect_from: - /components/device_tracker.freebox/ - /components/sensor.freebox/ diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown index 3b0ffb95d5b..74df9cdc85b 100644 --- a/source/_components/fritzbox.markdown +++ b/source/_components/fritzbox.markdown @@ -14,7 +14,7 @@ ha_category: - Sensor - Switch ha_release: 0.68 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.fritzbox/ - /components/switch.fritzbox/ @@ -104,4 +104,4 @@ The are several attributes that can be useful for automations and templates. | `device_locked` | The state of the key lock at the device. | `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface. | `temperature_unit` | The unit of the temperature sensor. -| `temperature` | The current temperature sensor reading. \ No newline at end of file +| `temperature` | The current temperature sensor reading. diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index 5c8944c7a74..8b3ea235fe7 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: "Other" ha_qa_scale: internal +ha_release: 0.7 --- This offers the official frontend to control Home Assistant. diff --git a/source/_components/gc100.markdown b/source/_components/gc100.markdown index 78bff6a3735..91d92fd3c32 100644 --- a/source/_components/gc100.markdown +++ b/source/_components/gc100.markdown @@ -12,7 +12,7 @@ ha_category: - Binary Sensor - Switch ha_release: 0.57 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.gc100/ - /components/switch.gc100/ @@ -92,4 +92,4 @@ ports: description: "A list of module-address to name mappings in the format 'x:y': name, where x is module #, y is address." required: true type: list -{% endconfiguration %} \ No newline at end of file +{% endconfiguration %} diff --git a/source/_components/geo_location.geo_json_events.markdown b/source/_components/geo_location.geo_json_events.markdown index f17703b0f99..bfe7d652b36 100644 --- a/source/_components/geo_location.geo_json_events.markdown +++ b/source/_components/geo_location.geo_json_events.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: geo_location.png ha_category: Geolocation -ha_iot_class: "Cloud Polling" -ha_release: "0.79" +ha_iot_class: Cloud Polling +ha_release: 0.79 --- The `geo_json_events` platform lets you integrate GeoJSON feeds. It retrieves events from a feed and shows information of those events filtered by distance to Home Assistant's location. diff --git a/source/_components/geo_location.markdown b/source/_components/geo_location.markdown index a7cfd900c8a..99f9c3af2d7 100644 --- a/source/_components/geo_location.markdown +++ b/source/_components/geo_location.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: geo_location.png -ha_release: "0.78" +ha_release: 0.78 --- Geolocation aware entities are typically related to events in the real world in the vicinity of Home Assistant's location, like for example weather events, bush fires or earthquakes. diff --git a/source/_components/geo_location.nsw_rural_fire_service_feed.markdown b/source/_components/geo_location.nsw_rural_fire_service_feed.markdown index 6212e4873ee..87b0850e96e 100644 --- a/source/_components/geo_location.nsw_rural_fire_service_feed.markdown +++ b/source/_components/geo_location.nsw_rural_fire_service_feed.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: nsw-rural-fire-service.png ha_category: Geolocation -ha_iot_class: "Cloud Polling" -ha_release: "0.81" +ha_iot_class: Cloud Polling +ha_release: 0.81 --- The `nsw_rural_fire_service_feed` platform lets you integrate a GeoJSON feed provided by the [NSW Rural Fire Service](https://www.rfs.nsw.gov.au/fire-information/fires-near-me) with information about bush fires, grass fires, hazard reductions and more. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location. diff --git a/source/_components/geo_location.usgs_earthquakes_feed.markdown b/source/_components/geo_location.usgs_earthquakes_feed.markdown index e853fbc6699..094c5321a72 100644 --- a/source/_components/geo_location.usgs_earthquakes_feed.markdown +++ b/source/_components/geo_location.usgs_earthquakes_feed.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: us-geological-survey.png ha_category: Geolocation -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.84 --- diff --git a/source/_components/geofency.md b/source/_components/geofency.md index 5f4a904e42d..17287b34be3 100644 --- a/source/_components/geofency.md +++ b/source/_components/geofency.md @@ -10,7 +10,7 @@ footer: true logo: geofency.png ha_category: Presence Detection ha_release: 0.83 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push --- This component sets up integration with [Geofency](http://www.geofency.com/). Geofency is a [paid app](https://itunes.apple.com/app/id615538630) for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location. diff --git a/source/_components/googlehome.markdown b/source/_components/googlehome.markdown index c0644592aed..f1aa57feb75 100644 --- a/source/_components/googlehome.markdown +++ b/source/_components/googlehome.markdown @@ -13,7 +13,7 @@ ha_category: - Hub - Presence Detection - Sensor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/device_tracker.googlehome/ --- diff --git a/source/_components/gpslogger.md b/source/_components/gpslogger.md index b02344facc5..36288143a7f 100644 --- a/source/_components/gpslogger.md +++ b/source/_components/gpslogger.md @@ -10,7 +10,7 @@ footer: true logo: gpslogger.png ha_category: Presence Detection ha_release: 0.86 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push --- This component sets up integration with [GPSLogger](http://code.mendhak.com/gpslogger/). GPSLogger is an open source app for [Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) that allows users to set up a `POST` request to update GPS coordinates. This can be configured with Home Assistant to update your location. diff --git a/source/_components/greeneye_monitor.markdown b/source/_components/greeneye_monitor.markdown index 721e41c2867..0c0bd4cb7b9 100644 --- a/source/_components/greeneye_monitor.markdown +++ b/source/_components/greeneye_monitor.markdown @@ -12,7 +12,7 @@ ha_category: - Hub - Sensor ha_release: 0.82 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/sensor.greeneye_monitor/ --- diff --git a/source/_components/group.markdown b/source/_components/group.markdown index e52617c002b..84be9fe3dbf 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Organization ha_qa_scale: internal +ha_release: pre 0.7 --- Groups allow the user to combine multiple entities into one. A group can be promoted to a **view** by setting `view: true` under the group definition. This will make the group available as a new tab in the frontend. diff --git a/source/_components/habitica.markdown b/source/_components/habitica.markdown index 87d43951186..f6d5ecbfeef 100644 --- a/source/_components/habitica.markdown +++ b/source/_components/habitica.markdown @@ -11,8 +11,8 @@ logo: habitica.png ha_category: - Hub - Sensor -ha_version: 0.78 -ha_iot_class: "Cloud Polling" +ha_release: 0.78 +ha_iot_class: Cloud Polling redirect_from: - /components/sensor.habitica/ --- diff --git a/source/_components/harmony.markdown b/source/_components/harmony.markdown index 6a69ea302a1..764291714cd 100644 --- a/source/_components/harmony.markdown +++ b/source/_components/harmony.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: logitech.png ha_category: Remote -ha_iot_class: "Local Push" -ha_release: "0.34" +ha_iot_class: Local Push +ha_release: 0.34 redirect_from: - /components/remote.harmony/ --- @@ -41,7 +41,7 @@ You can override some default configuration values on a discovered hub (e.g., th ```yaml # Example configuration.yaml entry with discovery - platform: harmony - name: Living Room + name: Living Room activity: Watch TV ``` @@ -159,7 +159,7 @@ In the file 'harmony_REMOTENAME.conf' you can find the available devices and com "Mute" ], "id": "428297615" - } + } } } ``` @@ -190,7 +190,7 @@ data: ### {% linkable_title Service `remote.harmony_change_channel` %} -Sends the change channel command to the Harmony HUB +Sends the change channel command to the Harmony HUB | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index ca1dd4c1f42..9eae12c680f 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Automation logo: hdmi.png ha_release: 0.23 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/media_player.hdmi_cec/ - /components/switch.hdmi_cec/ diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index 79dd95361dd..58ba97e9947 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: History logo: home-assistant.png -ha_release: "0.55" +ha_release: 0.55 ha_qa_scale: internal --- @@ -27,7 +27,7 @@ history_graph: gr1: entities: - light.ceiling.lights - + ``` {% configuration %} @@ -40,7 +40,7 @@ name: required: false default: ID type: string -hours_to_show: +hours_to_show: description: Number of hours to show in the graph. required: false default: 24 diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown index 1c6b2183c3c..7241947def8 100644 --- a/source/_components/hive.markdown +++ b/source/_components/hive.markdown @@ -16,7 +16,7 @@ ha_category: - Sensor - Switch ha_release: 0.59 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.hive/ - /components/climate.hive/ diff --git a/source/_components/hlk_sw16.markdown b/source/_components/hlk_sw16.markdown index ce84b64f9a4..8c92f79a59e 100644 --- a/source/_components/hlk_sw16.markdown +++ b/source/_components/hlk_sw16.markdown @@ -12,7 +12,7 @@ ha_category: - DIY - Switch ha_release: 0.84 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/switch.hlk_sw16/ --- diff --git a/source/_components/homekit_controller.markdown b/source/_components/homekit_controller.markdown index 60a66137679..74d42d423ea 100644 --- a/source/_components/homekit_controller.markdown +++ b/source/_components/homekit_controller.markdown @@ -19,7 +19,7 @@ ha_category: - Binary Sensor - Sensor ha_release: 0.68 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/alarm_control_panel.homekit_controller/ - /components/climate.homekit_controller/ diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index cc57415ac40..eb7917fc9d7 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -18,9 +18,8 @@ ha_category: - Notifications - Sensor - Switch -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.23 -featured: false redirect_from: - /components/binary_sensor.homematic/ - /components/climate.homematic/ @@ -468,11 +467,11 @@ address: required: true type: string channel: - description: The channel of your Homematic device. + description: The channel of your Homematic device. required: true type: integer param: - description: An additional parameter for the Homematic device. + description: An additional parameter for the Homematic device. required: true type: string interface: diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index b49a30b44f4..e4032edc68a 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -17,10 +17,8 @@ ha_category: - Light - Sensor - Switch - - Weather -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push ha_release: 0.66 -featured: false redirect_from: - /components/alarm_control_panel.homematicip_cloud/ - /components/binary_sensor.homematicip_cloud/ @@ -101,7 +99,7 @@ authtoken: * homematicip_cloud.climate * Climate group (*HmIP-HeatingGroup*) - * This includes temperature/humidity measures for climate devices of a room delivered by: + * This includes temperature/humidity measures for climate devices of a room delivered by: * Wall-mounted thermostat (*HmIP-WTH, -2*) * Brand Wall-mounted thermostat (*HmIP-BWTH, -24*) * Radiator thermostat (*HmIP-eTRV, -2, -C*) @@ -135,7 +133,7 @@ authtoken: * Blind actuator for brand switches (*HmIP-BBL*) * Shutter actuator brand-mount (*HmIP-BROLL*) * Shutter actuator flush-mount (*HmIP-FROLL*) - + * homematicip_cloud.weather * Weather Sensor – basic (*HmIP-SWO-B*) * Weather Sensor – plus (*HmIP-SWO-PL*) diff --git a/source/_components/homeworks.markdown b/source/_components/homeworks.markdown index 7f0e2f3172e..2414a39019d 100644 --- a/source/_components/homeworks.markdown +++ b/source/_components/homeworks.markdown @@ -11,9 +11,8 @@ logo: lutron.png ha_category: - Hub - Light -featured: false ha_release: 0.85 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.homeworks/ - /components/light.homeworks/ diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 93e9cbff19f..8cab4fa7ed9 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: http.png ha_category: "Other" +ha_release: pre 0.7 --- The `http` component serves all files and data required for the Home Assistant @@ -90,6 +91,10 @@ ssl_profile: default: modern {% endconfiguration %} +

+Configuring trusted_networks via the `http` component will be deprecated and moved to `auth_providers` instead. For instructions, see trusted networks. In Home Assistant 0.89.0 and 0.89.1, you need place the trusted network under both `http` and `auth_providers` if you still want to use trusted networks features. You can remove it from `http` section starting from 0.89.2. +

+ The sample below shows a configuration entry with possible values: ```yaml diff --git a/source/_components/huawei_lte.markdown b/source/_components/huawei_lte.markdown index e40859b3446..e4b669e5159 100644 --- a/source/_components/huawei_lte.markdown +++ b/source/_components/huawei_lte.markdown @@ -14,7 +14,7 @@ ha_category: - Notifications - Sensor ha_release: 0.79 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/notify.huawei_lte/ - /components/device_tracker.huawei_lte/ @@ -168,4 +168,4 @@ monitored_conditions: description: Total bytes downloaded since last reset. traffic_statistics.TotalConnectTime: description: Total time connected since last reset. -{% endconfiguration %} \ No newline at end of file +{% endconfiguration %} diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index 7b7849bd423..b82aa3d584b 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -11,11 +11,10 @@ logo: philips_hue.png ha_category: - Hub - Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_qa_scale: platinum featured: true ha_release: "0.60" -ha_qa_scale: platinum redirect_from: - /components/light.hue/ --- diff --git a/source/_components/idteck_prox.markdown b/source/_components/idteck_prox.markdown index 36c8c2541f6..7899e7eb5f2 100644 --- a/source/_components/idteck_prox.markdown +++ b/source/_components/idteck_prox.markdown @@ -7,11 +7,10 @@ sidebar: true comments: false sharing: true footer: true -logo: idteck.jpg +logo: idteck.jpg ha_category: Other -featured: false ha_release: 0.85 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- [IDTECK](http://www.idteck.com) makes ID systems used to control access and identify users. This component works with [Proximity Readers](http://www.idteck.com/en/products/proximity-reader-__-card-%26-tag-__125khz) (RFID card readers). The device is connected to Home Assistant through a serial to ethernet converter (NPort). diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index 691a561305d..a440d36053e 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -10,7 +10,8 @@ footer: true logo: ifttt.png ha_category: Automation featured: true -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push +ha_release: 0.80 --- [IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT component, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel). diff --git a/source/_components/ihc.markdown b/source/_components/ihc.markdown index 2ec4eaaabbb..a19f602dcb3 100644 --- a/source/_components/ihc.markdown +++ b/source/_components/ihc.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: ihc.png ha_category: Hub -ha_release: "0.62" -ha_iot_class: "Local Push" +ha_release: 0.62 +ha_iot_class: Local Push --- IHC Controller integration for Home Assistant allows you to connect the LK IHC @@ -26,11 +26,11 @@ ihc: - url: 'http://192.168.1.3' username: YOUR_USERNAME password: YOUR_PASSWORD - info: true + info: true - url: 'http://192.168.1.4' username: YOUR_USERNAME2 password: YOUR_PASSWORD2 - info: true + info: true ``` {% configuration %} diff --git a/source/_components/image_processing.dlib_face_detect.markdown b/source/_components/image_processing.dlib_face_detect.markdown index 368d4c78ba4..ad987d418e2 100644 --- a/source/_components/image_processing.dlib_face_detect.markdown +++ b/source/_components/image_processing.dlib_face_detect.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: dlib.png ha_category: Image Processing -featured: false ha_release: 0.44 --- diff --git a/source/_components/image_processing.dlib_face_identify.markdown b/source/_components/image_processing.dlib_face_identify.markdown index 2a4752914d4..4d8a2e63633 100644 --- a/source/_components/image_processing.dlib_face_identify.markdown +++ b/source/_components/image_processing.dlib_face_identify.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: dlib.png ha_category: Image Processing -featured: false ha_release: 0.44 --- diff --git a/source/_components/image_processing.facebox.markdown b/source/_components/image_processing.facebox.markdown index d8253cc0408..ad5c8c6aba1 100644 --- a/source/_components/image_processing.facebox.markdown +++ b/source/_components/image_processing.facebox.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: machine-box.png ha_category: Image Processing -featured: false ha_release: 0.70 --- diff --git a/source/_components/image_processing.microsoft_face_detect.markdown b/source/_components/image_processing.microsoft_face_detect.markdown index 70d59e403c6..4de1df0e77d 100644 --- a/source/_components/image_processing.microsoft_face_detect.markdown +++ b/source/_components/image_processing.microsoft_face_detect.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: microsoft.png ha_category: Image Processing -featured: false ha_release: 0.38 --- diff --git a/source/_components/image_processing.microsoft_face_identify.markdown b/source/_components/image_processing.microsoft_face_identify.markdown index aad6ae072cd..557476d64c8 100644 --- a/source/_components/image_processing.microsoft_face_identify.markdown +++ b/source/_components/image_processing.microsoft_face_identify.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: microsoft.png ha_category: Image Processing -featured: false ha_release: 0.37 --- diff --git a/source/_components/image_processing.openalpr_cloud.markdown b/source/_components/image_processing.openalpr_cloud.markdown index 6576c55db3b..8f2c16bceb2 100644 --- a/source/_components/image_processing.openalpr_cloud.markdown +++ b/source/_components/image_processing.openalpr_cloud.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: openalpr.png ha_category: Image Processing -featured: false ha_release: 0.36 --- diff --git a/source/_components/image_processing.openalpr_local.markdown b/source/_components/image_processing.openalpr_local.markdown index e14caab135d..a9c70364757 100644 --- a/source/_components/image_processing.openalpr_local.markdown +++ b/source/_components/image_processing.openalpr_local.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: openalpr.png ha_category: Image Processing -featured: false ha_release: 0.36 redirect_from: /components/openalpr/ --- diff --git a/source/_components/image_processing.opencv.markdown b/source/_components/image_processing.opencv.markdown index 06fc9061fd1..feda5b513fc 100644 --- a/source/_components/image_processing.opencv.markdown +++ b/source/_components/image_processing.opencv.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: opencv.png ha_category: Image Processing -featured: false ha_release: 0.47 --- diff --git a/source/_components/image_processing.qrcode.markdown b/source/_components/image_processing.qrcode.markdown index 6bb56d462ed..1a70c26f425 100644 --- a/source/_components/image_processing.qrcode.markdown +++ b/source/_components/image_processing.qrcode.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: home-assistant.png ha_category: Image Processing -featured: false ha_release: 0.87 --- diff --git a/source/_components/image_processing.seven_segments.markdown b/source/_components/image_processing.seven_segments.markdown index fade0f0e082..eda7169810d 100644 --- a/source/_components/image_processing.seven_segments.markdown +++ b/source/_components/image_processing.seven_segments.markdown @@ -9,10 +9,9 @@ sharing: true footer: true logo: home-assistant.png ha_category: Image Processing -featured: false ha_release: 0.45 og_image: /images/screenshots/ssocr.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/components/camera/). diff --git a/source/_components/image_processing.tensorflow.markdown b/source/_components/image_processing.tensorflow.markdown index 96821aa6b78..204cfe6d89c 100644 --- a/source/_components/image_processing.tensorflow.markdown +++ b/source/_components/image_processing.tensorflow.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: tensorflow.png ha_category: Image Processing -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.82 --- diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 8093371b037..54785486fa8 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Automation ha_qa_scale: internal +ha_release: 0.11 --- The `input_boolean` component allows the user to define boolean values that can be controlled via the frontend and can be used within conditions of automation. This can for example be used to disable or enable certain automations. diff --git a/source/_components/insteon.markdown b/source/_components/insteon.markdown index 49b511479ba..b3539442a7d 100644 --- a/source/_components/insteon.markdown +++ b/source/_components/insteon.markdown @@ -16,8 +16,7 @@ ha_category: - Light - Sensor - Switch -ha_iot_class: "Local Push" -ha_version: 0.77 +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.insteon/ - /components/cover.insteon/ @@ -25,9 +24,10 @@ redirect_from: - /components/light.insteon/ - /components/sensor.insteon/ - /components/switch.insteon/ +ha_release: 0.39 --- -This component adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant. +This component adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant. There is currently support for the following device types within Home Assistant: @@ -311,4 +311,4 @@ The INSTEON Hub has three known issues that are inherent to the design of the Hu 2. You cannot use both Home Assistant and the INSTEON app. If you do, the changes made in the app will not appear in Home Assistant. Changes made in Home Assistant will appear in the app after a period of time, however. -3. The Hub response times can be very slow. This is due to the Hub polling devices frequently. Since only one INSTEON message can be broadcast at a time, messages to and from Home Assistant can be delayed. \ No newline at end of file +3. The Hub response times can be very slow. This is due to the Hub polling devices frequently. Since only one INSTEON message can be broadcast at a time, messages to and from Home Assistant can be delayed. diff --git a/source/_components/introduction.markdown b/source/_components/introduction.markdown index 83a39cc1612..aa5bc3ced48 100644 --- a/source/_components/introduction.markdown +++ b/source/_components/introduction.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Other ha_qa_scale: internal +ha_release: 0.7 --- The introduction component will show a card in the UI with 'Welcome Home!' and steps on how to get started. It will also print the same message to the console when starting up. diff --git a/source/_components/ios.markdown b/source/_components/ios.markdown index 44ac2fa88e3..213b7ac553a 100644 --- a/source/_components/ios.markdown +++ b/source/_components/ios.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: apple.png ha_category: Hub -featured: false ha_release: 0.31 -ha_iot_class: depends +ha_iot_class: Configurable --- The `ios` component is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. diff --git a/source/_components/iota.markdown b/source/_components/iota.markdown index 15bfacf142b..f7793f606a4 100644 --- a/source/_components/iota.markdown +++ b/source/_components/iota.markdown @@ -12,7 +12,7 @@ ha_category: - Finance - Sensor ha_release: 0.62 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/sensor.iota/ --- diff --git a/source/_components/iperf3.markdown b/source/_components/iperf3.markdown index 4b0e7f85883..49d5d515bb2 100644 --- a/source/_components/iperf3.markdown +++ b/source/_components/iperf3.markdown @@ -11,9 +11,8 @@ logo: iperf3.png ha_category: - System Monitor - Sensor -featured: false ha_release: 0.71 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/sensor.iperf3/ --- @@ -32,10 +31,9 @@ Once per hour, on the hour (default): ```yaml # Example configuration.yaml entry -sensor: - - platform: iperf3 - hosts: - - host: iperf.he.net +iperf3: + hosts: + - host: iperf.he.net ``` {% configuration %} diff --git a/source/_components/ipma.markdown b/source/_components/ipma.markdown index 943650cf320..901d6aa5f29 100644 --- a/source/_components/ipma.markdown +++ b/source/_components/ipma.markdown @@ -10,7 +10,7 @@ footer: true logo: ipma.png ha_category: Weather ha_release: 0.72 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/weather.ipma/ --- diff --git a/source/_components/isy994.markdown b/source/_components/isy994.markdown index 6ea7d8de01d..b6783c2b773 100644 --- a/source/_components/isy994.markdown +++ b/source/_components/isy994.markdown @@ -18,7 +18,7 @@ ha_category: - Sensor - Switch ha_release: 0.28 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.isy994/ - /components/cover.isy994/ diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown index f2f7d3f3abd..487e31baca6 100644 --- a/source/_components/joaoapps_join.markdown +++ b/source/_components/joaoapps_join.markdown @@ -11,7 +11,7 @@ logo: joaoapps_join.png ha_category: - Hub - Notifications -ha_release: "0.24" +ha_release: 0.24 redirect_from: - /components/notify.joaoapps_join/ --- diff --git a/source/_components/keyboard_remote.markdown b/source/_components/keyboard_remote.markdown index b486e00aa8d..dea4f38e672 100644 --- a/source/_components/keyboard_remote.markdown +++ b/source/_components/keyboard_remote.markdown @@ -10,7 +10,7 @@ footer: true logo: keyboard.png ha_category: Other ha_release: 0.29 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- Receive signals from a keyboard and use it as a remote control. diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 037e506688e..1cdf375dbd3 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -10,7 +10,7 @@ footer: true logo: knx.png ha_category: Hub ha_release: 0.24 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/lcn.markdown b/source/_components/lcn.markdown index d2862df27ae..e77ff08dbd8 100644 --- a/source/_components/lcn.markdown +++ b/source/_components/lcn.markdown @@ -14,7 +14,7 @@ ha_category: - Light - Switch ha_release: 0.85 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/light.lcn/ - /components/switch.lcn/ diff --git a/source/_components/lifx.markdown b/source/_components/lifx.markdown index 44c60ee7f2d..021bb195f79 100644 --- a/source/_components/lifx.markdown +++ b/source/_components/lifx.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: lifx.png ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.81 redirect_from: /components/light.lifx/ --- diff --git a/source/_components/light.avion.markdown b/source/_components/light.avion.markdown index 6abf6e2fd61..113cce0cdbf 100644 --- a/source/_components/light.avion.markdown +++ b/source/_components/light.avion.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Light -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State logo: avi-on.png ha_release: 0.37 --- diff --git a/source/_components/light.blinksticklight.markdown b/source/_components/light.blinksticklight.markdown index 405032f5e30..d9bbc6dcc52 100644 --- a/source/_components/light.blinksticklight.markdown +++ b/source/_components/light.blinksticklight.markdown @@ -10,7 +10,7 @@ footer: true logo: blinkstick.png ha_category: DIY ha_release: 0.7.5 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/light.blinkt.markdown b/source/_components/light.blinkt.markdown index cee02bd7118..2e9fe6c2170 100644 --- a/source/_components/light.blinkt.markdown +++ b/source/_components/light.blinkt.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: raspberry-pi.png ha_category: DIY -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.44 --- diff --git a/source/_components/light.decora.markdown b/source/_components/light.decora.markdown index 41b6d979081..5702e78d07d 100644 --- a/source/_components/light.decora.markdown +++ b/source/_components/light.decora.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling logo: leviton.png ha_release: 0.37 --- diff --git a/source/_components/light.decora_wifi.markdown b/source/_components/light.decora_wifi.markdown index 7fc68d0dcf8..079461afbf8 100644 --- a/source/_components/light.decora_wifi.markdown +++ b/source/_components/light.decora_wifi.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Light -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling logo: leviton.png ha_release: 0.51 --- diff --git a/source/_components/light.everlights.markdown b/source/_components/light.everlights.markdown index df6dca6034a..47ca2b9cdbe 100644 --- a/source/_components/light.everlights.markdown +++ b/source/_components/light.everlights.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: everlights.png ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.87 --- diff --git a/source/_components/light.flux_led.markdown b/source/_components/light.flux_led.markdown index ff4dfd92c8f..6f93555623c 100644 --- a/source/_components/light.flux_led.markdown +++ b/source/_components/light.flux_led.markdown @@ -9,8 +9,7 @@ sharing: true footer: true logo: magic_light.png ha_category: Light -ha_iot_class: "Local Polling" -featured: false +ha_iot_class: Local Polling ha_release: 0.25 --- diff --git a/source/_components/light.greenwave.markdown b/source/_components/light.greenwave.markdown index 16f8e160993..26fa57fd8db 100644 --- a/source/_components/light.greenwave.markdown +++ b/source/_components/light.greenwave.markdown @@ -10,7 +10,7 @@ footer: true logo: greenwavereality.png ha_category: Light ha_release: 0.61 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- This component communicates with the Greenwave Reality (TCP Connected) Gateway to allow control of all lights and fixtures registered to the gateway. Bulbs and Fixtures can be created and modified inside the TCP Lighting App for Android and iOS. diff --git a/source/_components/light.group.markdown b/source/_components/light.group.markdown index c70a6e7e78f..82a1361d668 100644 --- a/source/_components/light.group.markdown +++ b/source/_components/light.group.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Light ha_release: 0.65 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/light.hyperion.markdown b/source/_components/light.hyperion.markdown index 622fdca3720..9f3579cdc2e 100644 --- a/source/_components/light.hyperion.markdown +++ b/source/_components/light.hyperion.markdown @@ -10,7 +10,7 @@ footer: true logo: hyperion.png ha_category: Light ha_release: 0.7.6 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `hyperion` platform allows you to integrate your [Hyperion](https://hyperion-project.org/wiki) into Home Assistant. Hyperion is an open source Ambilight implementation which runs on many platforms. diff --git a/source/_components/light.iglo.markdown b/source/_components/light.iglo.markdown index 5bc12ba1d64..ae4d9a37b7f 100644 --- a/source/_components/light.iglo.markdown +++ b/source/_components/light.iglo.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: iglo.png ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.61 --- diff --git a/source/_components/light.ihc.markdown b/source/_components/light.ihc.markdown index 3b4ae606129..b5963e6c7dc 100644 --- a/source/_components/light.ihc.markdown +++ b/source/_components/light.ihc.markdown @@ -10,7 +10,7 @@ footer: true logo: ihc.png ha_category: Light ha_release: 0.62 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- Before you can use the IHC Light platform, you must setup the @@ -27,7 +27,7 @@ project and setup as light devices: - Wireless mobile dimmer - Dataline lamp outlet -To manually configure IHC lights insert the "light" section in +To manually configure IHC lights insert the "light" section in your IHC configuration: ```yaml @@ -35,7 +35,7 @@ ihc: - url: 'http://192.168.1.3' username: YOUR_USERNAME2 password: YOUR_PASSWORD2 - info: true + info: true light: - id: 12345 name: tablelight diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index b2c833b750a..93c53033a23 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -10,7 +10,7 @@ footer: true logo: knx.png ha_category: Light ha_release: 0.44 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `knx light` component is used as an interface to control knx actuators for lighting applications such as: @@ -73,7 +73,7 @@ color_temperature_state_address: color_temperature_mode: description: Color temperature group address data type. keys: - absolute: + 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* diff --git a/source/_components/light.limitlessled.markdown b/source/_components/light.limitlessled.markdown index 9d6e3d8d8ed..a5dab233e85 100644 --- a/source/_components/light.limitlessled.markdown +++ b/source/_components/light.limitlessled.markdown @@ -4,13 +4,12 @@ title: "LimitlessLED" description: "Instructions on how to setup LimitlessLED within Home Assistant." date: 2015-12-03 13:00 sidebar: true -layout: page comments: false sharing: true footer: true logo: limitlessled_logo.png ha_category: Light -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State ha_release: pre 0.7 --- diff --git a/source/_components/light.lw12wifi.markdown b/source/_components/light.lw12wifi.markdown index c1b01102873..cb9f588c0eb 100644 --- a/source/_components/light.lw12wifi.markdown +++ b/source/_components/light.lw12wifi.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling logo: lagute.png ha_release: 0.71 --- diff --git a/source/_components/light.markdown b/source/_components/light.markdown index 2d7bd0445f7..3bc98b8f682 100644 --- a/source/_components/light.markdown +++ b/source/_components/light.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: pre 0.7 --- This component allows you to track and control various light bulbs. Read the platform documentation for your particular light hardware to learn how to enable it. diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index 26104f2eed8..8975bd52682 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -9,10 +9,11 @@ sharing: true footer: true logo: mqtt.png ha_category: Light -ha_iot_class: depends +ha_iot_class: Configurable redirect_from: - /components/light.mqtt_json/ - /components/light.mqtt_template/ +ha_release: 0.8 --- The `mqtt` light platform with lets you control your MQTT enabled lights through one of the supported message schemas. @@ -116,7 +117,7 @@ effect_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. + Range for Hue: 0° .. 360°, Range of Saturation: 0..100. Note: Brightness is sent separately in the `brightness_command_topic`." required: false type: string diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown index d08a0a7f6f7..b5c8cae29f7 100644 --- a/source/_components/light.mysensors.markdown +++ b/source/_components/light.mysensors.markdown @@ -12,7 +12,7 @@ ha_category: - DIY - Light ha_release: 0.13 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- Integrates MySensors lights into Home Assistant. See the [main component] for configuration instructions. @@ -35,7 +35,7 @@ S_RGBW_LIGHT | V_RGBW*, [V_LIGHT\* or V_STATUS\*], [V_DIMMER or V_PERCENTAGE] V_TYPES with a star (\*) denote V_TYPES that should be sent at sketch startup. For an S_DIMMER, send both a V_DIMMER/V_PERCENTAGE and a V_LIGHT/V_STATUS message. For an S_RGB_LIGHT, send both a V_RGB and a V_LIGHT/V_STATUS message with a V_DIMMER/V_PERCENTAGE message being optional. Same principal applies for S_RGBW_LIGHT and V_RGBW. -Sketch should acknowledge a command sent from controller with the same type. If command invokes a change to off state (including a V_PERCENTAGE, V_RGB, or V_RGBW message of zero), only a V_STATUS of zero message should be sent. See sketches below for examples. +Sketch should acknowledge a command sent from controller with the same type. If command invokes a change to off state (including a V_PERCENTAGE, V_RGB, or V_RGBW message of zero), only a V_STATUS of zero message should be sent. See sketches below for examples. For more information, visit the [serial api] of MySensors. @@ -177,7 +177,7 @@ void presentation() void receive(const MyMessage &message) { //When receiving a V_STATUS command, switch the light between OFF - //and the last received dimmer value + //and the last received dimmer value if ( message.type == V_STATUS ) { Serial.println( "V_STATUS command received..." ); @@ -204,7 +204,7 @@ void receive(const MyMessage &message) //Update constroller with dimmer value & status send_dimmer_message(); - send_status_message(); + send_status_message(); } else { last_state = LIGHT_ON; last_dim = dim_value; diff --git a/source/_components/light.mystrom.markdown b/source/_components/light.mystrom.markdown index 9cc2555fb16..a3ad9e8c333 100644 --- a/source/_components/light.mystrom.markdown +++ b/source/_components/light.mystrom.markdown @@ -10,11 +10,11 @@ footer: true logo: mystrom.png ha_category: Light ha_release: 0.43 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- -The `mystrom` light platform allows you to control your [myStrom](https://mystrom.ch/en/) WiFi Bulbs. +The `mystrom` light platform allows you to control your [myStrom](https://mystrom.ch/en/) WiFi Bulbs. To use your myStrom WiFi Bulb in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/light.nanoleaf.markdown b/source/_components/light.nanoleaf.markdown index 37842ad67e2..88902b8e48d 100644 --- a/source/_components/light.nanoleaf.markdown +++ b/source/_components/light.nanoleaf.markdown @@ -9,8 +9,7 @@ sharing: true footer: true logo: nanoleaf_light.png ha_category: Light -ha_iot_class: "Local Polling" -featured: false +ha_iot_class: Local Polling ha_release: 0.67 --- diff --git a/source/_components/light.niko_home_control.markdown b/source/_components/light.niko_home_control.markdown index 6a513b90ac0..b626cc7b601 100644 --- a/source/_components/light.niko_home_control.markdown +++ b/source/_components/light.niko_home_control.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.82 --- diff --git a/source/_components/light.opple.markdown b/source/_components/light.opple.markdown index dd4572db2cd..952f28ff36f 100644 --- a/source/_components/light.opple.markdown +++ b/source/_components/light.opple.markdown @@ -10,7 +10,7 @@ footer: true logo: opple.png ha_category: Light ha_release: "0.80" -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/light.piglow.markdown b/source/_components/light.piglow.markdown index 919dbc298d6..eb8af9b40e6 100644 --- a/source/_components/light.piglow.markdown +++ b/source/_components/light.piglow.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY ha_release: 0.37 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index c181c93800f..bc2868f99cc 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -10,7 +10,7 @@ footer: true logo: rflink.png ha_category: Light ha_release: 0.38 -ha_iot_class: "Assumed state" +ha_iot_class: Assumed State --- 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). @@ -185,4 +185,4 @@ light: name: Kitchen Under Counter Lights Maclean_0d82_01: name: Bedroom Lamp -``` \ No newline at end of file +``` diff --git a/source/_components/light.rfxtrx.markdown b/source/_components/light.rfxtrx.markdown index 553ba93be33..131142b79e2 100644 --- a/source/_components/light.rfxtrx.markdown +++ b/source/_components/light.rfxtrx.markdown @@ -10,7 +10,7 @@ footer: true logo: rfxtrx.png ha_category: Light ha_release: 0.7.5 -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State --- The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz. @@ -81,6 +81,6 @@ signal_repetitions: {% endconfiguration %}

-If a device ID consists of only numbers, please make sure to surround it with quotes. +If a device ID consists of only numbers, please make sure to surround it with quotes. This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.

diff --git a/source/_components/light.rpi_gpio_pwm.markdown b/source/_components/light.rpi_gpio_pwm.markdown index 6d0fe793249..ef1bb0f5e8c 100644 --- a/source/_components/light.rpi_gpio_pwm.markdown +++ b/source/_components/light.rpi_gpio_pwm.markdown @@ -4,19 +4,18 @@ title: "PWM LED Light" description: "Instructions on how to setup PWM LEDs within Home Assistant." date: 2017-04-04 13:00 sidebar: true -layout: page comments: false sharing: true footer: true ha_category: DIY -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.43 logo: raspberry-pi.png --- The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width modulation, for example led strips. It supports one-color, RGB and RGBW LEDs driven by GPIOs of a Raspberry Pi or a PCA9685 controller. -For controlling the GPIOs, the platform connects to the [pigpio-daemon](http://abyz.co.uk/rpi/pigpio/pigpiod.html), which must be running. On Raspbian Jessie 2016-05-10 or newer the `pigpio` library is already included. On other operating systems it needs to be installed first (see [installation instructions](https://github.com/soldag/python-pwmled#installation)). +For controlling the GPIOs, the platform connects to the [pigpio-daemon](http://abyz.co.uk/rpi/pigpio/pigpiod.html), which must be running. On Raspbian Jessie 2016-05-10 or newer the `pigpio` library is already included. On other operating systems it needs to be installed first (see [installation instructions](https://github.com/soldag/python-pwmled#installation)). ## {% linkable_title Configuration %} diff --git a/source/_components/light.sensehat.markdown b/source/_components/light.sensehat.markdown index 30d9eb88c8d..ddbf1b2cbe8 100644 --- a/source/_components/light.sensehat.markdown +++ b/source/_components/light.sensehat.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: sense-hat.png ha_category: DIY -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State ha_release: 0.44 --- diff --git a/source/_components/light.switch.markdown b/source/_components/light.switch.markdown index 4e1eeb2135e..f187cef71f3 100644 --- a/source/_components/light.switch.markdown +++ b/source/_components/light.switch.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Light ha_release: 0.83 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown index 5ac3c4189b1..ce085f84866 100644 --- a/source/_components/light.template.markdown +++ b/source/_components/light.template.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Light ha_release: 0.46 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/light.tikteck.markdown b/source/_components/light.tikteck.markdown index 84e28673c76..bf671b7bbef 100644 --- a/source/_components/light.tikteck.markdown +++ b/source/_components/light.tikteck.markdown @@ -8,8 +8,8 @@ comments: false sharing: true footer: true ha_category: Light -ha_iot_class: "Local Polling" -ha_logo: tikteck.png +ha_iot_class: Local Polling +logo: tikteck.png ha_release: 0.36 --- diff --git a/source/_components/light.x10.markdown b/source/_components/light.x10.markdown index caa789f5632..617e756a74d 100644 --- a/source/_components/light.x10.markdown +++ b/source/_components/light.x10.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: x10.gif ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.25 --- diff --git a/source/_components/light.xiaomi_aqara.markdown b/source/_components/light.xiaomi_aqara.markdown index 48bf4fb1358..4dd1964a733 100644 --- a/source/_components/light.xiaomi_aqara.markdown +++ b/source/_components/light.xiaomi_aqara.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Light ha_release: "0.50" -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- diff --git a/source/_components/light.xiaomi_miio.markdown b/source/_components/light.xiaomi_miio.markdown index a4e95c3d424..ffd09fa8d1b 100644 --- a/source/_components/light.xiaomi_miio.markdown +++ b/source/_components/light.xiaomi_miio.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: philips.png ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.53 --- diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown index ef415475b07..08d7bbe420a 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -10,7 +10,7 @@ footer: true logo: yeelight.png ha_category: Light ha_release: 0.32 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `yeelight` light platform allows you to control your Yeelight Wifi bulbs with Home Assistant. There are two possible methods for configuration of the Yeelight: Manual or Automatic. diff --git a/source/_components/light.yeelightsunflower.markdown b/source/_components/light.yeelightsunflower.markdown index aee2c1d2852..c1c00caaa46 100644 --- a/source/_components/light.yeelightsunflower.markdown +++ b/source/_components/light.yeelightsunflower.markdown @@ -10,7 +10,7 @@ footer: true logo: yeelight.png ha_category: Light ha_release: 0.39 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `yeelightsunflower` light platform allows you to control your Yeelight Sunflower light bulbs with Home Assistant. diff --git a/source/_components/light.zengge.markdown b/source/_components/light.zengge.markdown index 6c84769f479..ba7768b7d11 100644 --- a/source/_components/light.zengge.markdown +++ b/source/_components/light.zengge.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: zengge.png ha_category: Light -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.36 --- diff --git a/source/_components/light.zigbee.markdown b/source/_components/light.zigbee.markdown index 9de952bd848..6db9104b43d 100644 --- a/source/_components/light.zigbee.markdown +++ b/source/_components/light.zigbee.markdown @@ -10,7 +10,7 @@ footer: true logo: zigbee.png ha_category: Light ha_release: 0.12 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- A Zigbee light in this context is a light connected to one of the digital output pins on a Zigbee module. It can simply be switched on and off. By default, a light is considered `on` when the Zigbee device's digital output 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`. diff --git a/source/_components/lightwave.markdown b/source/_components/lightwave.markdown index 72b38afdaf4..4caecd8e0e0 100644 --- a/source/_components/lightwave.markdown +++ b/source/_components/lightwave.markdown @@ -13,7 +13,7 @@ ha_category: - Light - Switch ha_release: 0.84 -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State redirect_from: - /components/light.lightwave/ - /components/switch.lightwave/ @@ -56,4 +56,4 @@ The first use of a light or switch will try to register with your Lightwave WiFi The Lightwave Home Assistant component currently supports the following Lightwave devices: - Lightwave lights -- Lightwave switches \ No newline at end of file +- Lightwave switches diff --git a/source/_components/linode.markdown b/source/_components/linode.markdown index 4dbd4f70136..f114b51c969 100644 --- a/source/_components/linode.markdown +++ b/source/_components/linode.markdown @@ -13,7 +13,7 @@ ha_category: - Switch logo: linode.png ha_release: 0.57 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.linode/ - /components/switch.linode/ diff --git a/source/_components/lirc.markdown b/source/_components/lirc.markdown index 7127b52caf7..409ef2b261a 100644 --- a/source/_components/lirc.markdown +++ b/source/_components/lirc.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: lirc.gif ha_category: Automation -featured: false ha_release: 0.21 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- [LIRC](http://www.lirc.org/) integration for Home Assistant allows you to receive signals from an infrared remote control and control actions based on the buttons you press. You can use them to set scenes or trigger any other [automation](/components/automation/). diff --git a/source/_components/litejet.markdown b/source/_components/litejet.markdown index 0aec4126924..df54a588a00 100644 --- a/source/_components/litejet.markdown +++ b/source/_components/litejet.markdown @@ -11,7 +11,7 @@ ha_category: - Light - Scene - Switch -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.32 redirect_from: - /components/light.litejet/ diff --git a/source/_components/locative.md b/source/_components/locative.md index 7ab8b47b20e..ddb862a5f6c 100644 --- a/source/_components/locative.md +++ b/source/_components/locative.md @@ -10,7 +10,7 @@ footer: true logo: locative.png ha_category: Presence Detection ha_release: 0.86 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push redirect_from: - /components/device_tracker.locative/ --- @@ -34,4 +34,4 @@ To configure Locative, you must set it up via the integrations panel in the conf When you enter a geofence, your location name in Home Assistant will be set to the name of the geofence in Locative. When you exit a geofence, your location name in Home Assistant will be set to "not home". -To use Locative in combination with another device tracker, such as [Nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last. \ No newline at end of file +To use Locative in combination with another device tracker, such as [Nmap](/components/device_tracker.nmap_tracker/) or [Netgear](/components/device_tracker.netgear/), fill in the `mac` field to the Locative entry in `known_devices.yaml` with the MAC address of the device you want to track. The state of the device will be determined by the source that reported last. diff --git a/source/_components/lock.kiwi.markdown b/source/_components/lock.kiwi.markdown index 08c3e9746b5..c033fada8fc 100644 --- a/source/_components/lock.kiwi.markdown +++ b/source/_components/lock.kiwi.markdown @@ -9,12 +9,11 @@ sharing: true footer: true logo: kiwi.png ha_category: Lock -featured: false ha_release: 0.72 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- -The `KIWI` platform allows you to open your KIWI Smart Locks and Smart Entry Devices. +The `KIWI` platform allows you to open your KIWI Smart Locks and Smart Entry Devices. All you need to get started is a KIWI account. Register at [the KIWI website](https://kiwi.ki/login/). ## {% linkable_title Configuration %} diff --git a/source/_components/lock.lockitron.markdown b/source/_components/lock.lockitron.markdown index c97eaf7eb78..f3bf0061f8c 100644 --- a/source/_components/lock.lockitron.markdown +++ b/source/_components/lock.lockitron.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: lockitron.png ha_category: Lock -ha_iot_class: "Cloud Polling" -ha_release: "0.42" +ha_iot_class: Cloud Polling +ha_release: 0.42 --- The `lockitron` platform allows you to control your [Lockitron](https://lockitron.com/) lock from within Home Assistant. diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown index 898a3fdc16b..f57fa53b0bb 100644 --- a/source/_components/lock.markdown +++ b/source/_components/lock.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.9 --- Keeps track which locks are in your environment, their state and allows you to control them. diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index 812675886dc..a457b54578a 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Lock ha_release: 0.15 -ha_iot_class: depends +ha_iot_class: Configurable --- The `mqtt` lock platform lets you control your MQTT enabled locks. diff --git a/source/_components/lock.nello.markdown b/source/_components/lock.nello.markdown index e1f5a704275..2236418066e 100644 --- a/source/_components/lock.nello.markdown +++ b/source/_components/lock.nello.markdown @@ -9,10 +9,9 @@ sharing: true footer: true logo: nello.png ha_category: Lock -featured: false ha_release: 0.52 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `nello` platform allows you to control [Nello](https://www.nello.io) intercoms. diff --git a/source/_components/lock.nuki.markdown b/source/_components/lock.nuki.markdown index bc5299d61ab..f8b759e33e7 100644 --- a/source/_components/lock.nuki.markdown +++ b/source/_components/lock.nuki.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: nuki.png ha_category: Lock -featured: false ha_release: 0.38 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `nuki` platform allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via either a [software bridge](https://play.google.com/store/apps/details?id=io.nuki.bridge) or a [physical bridge](https://nuki.io/en/bridge/). diff --git a/source/_components/lock.sesame.markdown b/source/_components/lock.sesame.markdown index affd029f63a..bda185a9f7d 100644 --- a/source/_components/lock.sesame.markdown +++ b/source/_components/lock.sesame.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: sesame.png ha_category: Lock -ha_iot_class: "Cloud Polling" -ha_release: "0.47" +ha_iot_class: Cloud Polling +ha_release: 0.47 --- The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc. diff --git a/source/_components/lock.template.markdown b/source/_components/lock.template.markdown index 155ba139001..03e884f600e 100644 --- a/source/_components/lock.template.markdown +++ b/source/_components/lock.template.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Lock ha_release: 0.81 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/lock.xiaomi_aqara.markdown b/source/_components/lock.xiaomi_aqara.markdown index 501e4899537..e98a8fb8be5 100644 --- a/source/_components/lock.xiaomi_aqara.markdown +++ b/source/_components/lock.xiaomi_aqara.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: xiaomi.png ha_category: Lock -ha_release: "0.71" -ha_iot_class: "Local Push" +ha_release: 0.71 +ha_iot_class: Local Push --- diff --git a/source/_components/logbook.markdown b/source/_components/logbook.markdown index eb3682fb339..f5cea083542 100644 --- a/source/_components/logbook.markdown +++ b/source/_components/logbook.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: logbook.png ha_category: "History" +ha_release: 0.7 --- diff --git a/source/_components/logentries.markdown b/source/_components/logentries.markdown index b365e57f63d..2b619593580 100644 --- a/source/_components/logentries.markdown +++ b/source/_components/logentries.markdown @@ -9,6 +9,7 @@ sharing: true logo: logentries.png footer: true ha_category: "History" +ha_release: 0.13 --- The `logentries` component makes it possible to log all state changes to [Logentries](http://logentries.com/) using Logentries Webhook endpoint. diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index a8ddfb70650..4f4daf1e73a 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: "Utility" ha_qa_scale: internal +ha_release: 0.8 --- The `logger` component lets you define the level of logging activities in Home diff --git a/source/_components/logi_circle.markdown b/source/_components/logi_circle.markdown index 5b891755da2..b937480bc2d 100644 --- a/source/_components/logi_circle.markdown +++ b/source/_components/logi_circle.markdown @@ -10,7 +10,7 @@ footer: true logo: logi_circle.png ha_category: Camera ha_release: 0.79 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `logi_circle` implementation allows you to integrate your [Logi Circle](https://circle.logi.com/) cameras in Home Assistant. diff --git a/source/_components/luftdaten.markdown b/source/_components/luftdaten.markdown index fe800393d68..17e7103ff3b 100644 --- a/source/_components/luftdaten.markdown +++ b/source/_components/luftdaten.markdown @@ -12,7 +12,7 @@ ha_category: - Health - Sensor ha_release: 0.82 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_qa_scale: gold redirect_from: - /components/sensor.luftdaten/ @@ -28,7 +28,7 @@ The `luftdaten` component will query the open data API of [luftdaten.info](http: ## {% linkable_title COnfiguration via the frontend %} Menu: **Configuration** -> **Integrations** - + Configure the integration: - Enter the **Sensor ID** diff --git a/source/_components/lupusec.markdown b/source/_components/lupusec.markdown index 8577f2bffe6..ad8027a720a 100644 --- a/source/_components/lupusec.markdown +++ b/source/_components/lupusec.markdown @@ -14,7 +14,7 @@ ha_category: - Binary Sensor - Switch ha_release: 0.83 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/alarm_control_panel.lupusec/ - /components/binary_sensor.lupusec/ diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index c8e8be66113..1b8496c5c6a 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -14,9 +14,8 @@ ha_category: - Light - Scene - Switch -featured: false ha_release: 0.37 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/cover.lutron/ - /components/light.lutron/ diff --git a/source/_components/lutron_caseta.markdown b/source/_components/lutron_caseta.markdown index 2889bc32526..b45e2da1771 100644 --- a/source/_components/lutron_caseta.markdown +++ b/source/_components/lutron_caseta.markdown @@ -14,9 +14,8 @@ ha_category: - Light - Scene - Switch -featured: false ha_release: 0.41 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/cover.lutron_caseta/ - /components/light.lutron_caseta/ @@ -113,4 +112,4 @@ For dimmable lights including wall and plug-in dimmers, see the light section on For more information on working with switches in Home Assistant, see the [Switches component](/components/switch/). -Available services: `switch.turn_on` and `switch.turn_off`. \ No newline at end of file +Available services: `switch.turn_on` and `switch.turn_off`. diff --git a/source/_components/map.markdown b/source/_components/map.markdown index c7a5e90eefe..7825caac884 100644 --- a/source/_components/map.markdown +++ b/source/_components/map.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: "Other" ha_qa_scale: internal +ha_release: 0.56 --- This offers a map on the frontend to display the location of tracked devices. To set up tracked devices, look at the [device tracker](/components/device_tracker/) documentation. diff --git a/source/_components/maxcube.markdown b/source/_components/maxcube.markdown index a95d1ce13bc..6ede1134ffe 100644 --- a/source/_components/maxcube.markdown +++ b/source/_components/maxcube.markdown @@ -12,7 +12,7 @@ ha_category: - Climate - Binary Sensor ha_release: "0.40" -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.maxcube/ - /components/climate.maxcube/ diff --git a/source/_components/media_player.anthemav.markdown b/source/_components/media_player.anthemav.markdown index 992edcb42e2..31242bdd56d 100644 --- a/source/_components/media_player.anthemav.markdown +++ b/source/_components/media_player.anthemav.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: anthemav.png ha_category: Media Player -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.37 --- diff --git a/source/_components/media_player.aquostv.markdown b/source/_components/media_player.aquostv.markdown index be6a68167c9..104c540c9cf 100644 --- a/source/_components/media_player.aquostv.markdown +++ b/source/_components/media_player.aquostv.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: sharp_aquos.png ha_category: Media Player -featured: false ha_release: 0.35 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `aquostv` platform allows you to control a [Sharp Aquos TV](http://www.sharp.ca/en-CA/ForHome/HomeEntertainment/LEDTV/QuattronPlus.aspx). diff --git a/source/_components/media_player.blackbird.markdown b/source/_components/media_player.blackbird.markdown index c118a83d9c9..b52a86ee407 100644 --- a/source/_components/media_player.blackbird.markdown +++ b/source/_components/media_player.blackbird.markdown @@ -10,7 +10,7 @@ footer: true logo: monoprice.svg ha_category: Media Player ha_release: 0.68 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `blackbird` platform allows you to control [Monoprice Blackbird Matrix Switch](https://www.monoprice.com/product?p_id=21819) using a serial connection. @@ -26,12 +26,12 @@ media_player: 1: name: Living Room sources: - 3: + 3: name: BluRay ``` {% configuration %} -port: +port: description: The serial port to which Blackbird matrix switch is connected. [`port`](#port) and [`host`](#host) cannot be specified concurrently. required: exclusive type: string @@ -57,7 +57,7 @@ sources: ### {% linkable_title Service `media_player.blackbird_set_all_zones` %} -Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated. +Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_components/media_player.bluesound.markdown b/source/_components/media_player.bluesound.markdown index aadb326f42c..7e28406813b 100644 --- a/source/_components/media_player.bluesound.markdown +++ b/source/_components/media_player.bluesound.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: bluesound.png ha_category: Media Player -featured: false ha_release: 0.51 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio components from Home Assistant. @@ -47,7 +46,7 @@ hosts: default: 11000 type: integer {% endconfiguration %} - + ## Advanced configuration example ```yaml diff --git a/source/_components/media_player.braviatv.markdown b/source/_components/media_player.braviatv.markdown index e8bb5bf6e4d..38f5ea77dfa 100644 --- a/source/_components/media_player.braviatv.markdown +++ b/source/_components/media_player.braviatv.markdown @@ -10,7 +10,7 @@ footer: true logo: bravia.png ha_category: Media Player ha_release: 0.23 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `braviatv` platform allows you to control a [Sony Bravia TV](http://www.sony.com). diff --git a/source/_components/media_player.channels.markdown b/source/_components/media_player.channels.markdown index 98d7f60b9a8..4bb6150822e 100644 --- a/source/_components/media_player.channels.markdown +++ b/source/_components/media_player.channels.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: channels.png ha_category: Media Player -ha_release: 0.65.0 -ha_iot_class: "Local Polling" +ha_release: 0.65 +ha_iot_class: Local Polling --- diff --git a/source/_components/media_player.clementine.markdown b/source/_components/media_player.clementine.markdown index add0d5b2a80..f37e4233d36 100644 --- a/source/_components/media_player.clementine.markdown +++ b/source/_components/media_player.clementine.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: clementine.png ha_category: Media Player -ha_iot_class: "Local Poll" -ha_release: "0.39" -ha_iot_class: "Local Polling" +ha_release: 0.39 +ha_iot_class: Local Polling --- The `clementine` platform allows you to control a [Clementine Music Player](https://www.clementine-player.org). diff --git a/source/_components/media_player.cmus.markdown b/source/_components/media_player.cmus.markdown index ce5406887b3..c512687a796 100644 --- a/source/_components/media_player.cmus.markdown +++ b/source/_components/media_player.cmus.markdown @@ -9,7 +9,8 @@ comments: false sharing: true footer: true ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling +ha_release: 0.23 --- diff --git a/source/_components/media_player.denon.markdown b/source/_components/media_player.denon.markdown index 61fc86002fe..577f66a895f 100644 --- a/source/_components/media_player.denon.markdown +++ b/source/_components/media_player.denon.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: denon.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.7.2 --- diff --git a/source/_components/media_player.denonavr.markdown b/source/_components/media_player.denonavr.markdown index fe38b28f20e..d39cfa723a1 100644 --- a/source/_components/media_player.denonavr.markdown +++ b/source/_components/media_player.denonavr.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: denon.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.7.2 --- diff --git a/source/_components/media_player.directv.markdown b/source/_components/media_player.directv.markdown index e7b82e80650..c2c39ac9d55 100644 --- a/source/_components/media_player.directv.markdown +++ b/source/_components/media_player.directv.markdown @@ -10,7 +10,7 @@ footer: true logo: directv.png ha_category: Media Player ha_release: 0.25 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- Master [DirecTV](http://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery component](/components/discovery/) and the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery. @@ -100,4 +100,4 @@ Available services: turn_on, turn_off, media_play, media_pause, media_stop, medi | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | yes | Target a specific media player. Defaults to all. | | `media_content_id` | no | The channel number to change to. | -| `media_content_type` | no | A media type. Has to be `channel`. +| `media_content_type` | no | A media type. Has to be `channel`. diff --git a/source/_components/media_player.dlna_dmr.markdown b/source/_components/media_player.dlna_dmr.markdown index 9404a031669..2b7227dc6ba 100644 --- a/source/_components/media_player.dlna_dmr.markdown +++ b/source/_components/media_player.dlna_dmr.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: dlna.png ha_category: Media Player -featured: false ha_release: 0.76 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios. diff --git a/source/_components/media_player.dunehd.markdown b/source/_components/media_player.dunehd.markdown index 5d22f2ad8d2..b53c942f05e 100644 --- a/source/_components/media_player.dunehd.markdown +++ b/source/_components/media_player.dunehd.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: dunehd.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.34 --- diff --git a/source/_components/media_player.emby.markdown b/source/_components/media_player.emby.markdown index bb10654c680..f7d1185dc80 100644 --- a/source/_components/media_player.emby.markdown +++ b/source/_components/media_player.emby.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: emby.png ha_category: Media Player -ha_release: "0.32" -ha_iot_class: "Local Push" +ha_release: 0.32 +ha_iot_class: Local Push --- diff --git a/source/_components/media_player.epson.markdown b/source/_components/media_player.epson.markdown index d35ff6e7da1..f962050d350 100644 --- a/source/_components/media_player.epson.markdown +++ b/source/_components/media_player.epson.markdown @@ -10,7 +10,7 @@ footer: true logo: epson.png ha_category: Media Player ha_release: 0.72 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `epson` platform allows you to control a Epson projector from Home diff --git a/source/_components/media_player.frontier_silicon.markdown b/source/_components/media_player.frontier_silicon.markdown index 9ab51e42d40..35d6badd47a 100644 --- a/source/_components/media_player.frontier_silicon.markdown +++ b/source/_components/media_player.frontier_silicon.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Media Player -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: "0.40" --- diff --git a/source/_components/media_player.gpmdp.markdown b/source/_components/media_player.gpmdp.markdown index b0cbb0d58fa..4c04d61ede6 100644 --- a/source/_components/media_player.gpmdp.markdown +++ b/source/_components/media_player.gpmdp.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: gpmdp.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: "0.20" -ha_iot_class: "Local Polling" --- diff --git a/source/_components/media_player.gstreamer.markdown b/source/_components/media_player.gstreamer.markdown index ad23c571d68..ad79dfa2126 100644 --- a/source/_components/media_player.gstreamer.markdown +++ b/source/_components/media_player.gstreamer.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Media Player logo: gstreamer.png ha_release: 0.39 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `gstreamer` platform allows you to play audio via a [gstreamer](https://gstreamer.freedesktop.org/) pipeline. Practically, this means you can play audio directly on the computer running Home Assistant. It is particularly suited for playing TTS. Advanced users can specify a pipeline to transform the audio stream and/or redirect it elsewhere. diff --git a/source/_components/media_player.harman_kardon_avr.markdown b/source/_components/media_player.harman_kardon_avr.markdown index 23b993c0a51..d29d6baf9a0 100644 --- a/source/_components/media_player.harman_kardon_avr.markdown +++ b/source/_components/media_player.harman_kardon_avr.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: harman_kardon.png ha_category: Media Player -ha_iot_class: "Local Polling" -ha_release: 0.85.0 +ha_iot_class: Local Polling +ha_release: 0.85 --- The `harman_kardon_avr` platform allows you to control Harman Kardon Network Receivers from Home Assistant. @@ -49,4 +49,4 @@ port: A few notes: - The newest firmware automatically shuts down the AVR after a certain amount of time. The AVR is then not available on the network anymore, so the 'on' command will not work. -- The AVR has no endpoints to determine the volume, muted, playing etc., so if the remote control is used, HA will not know the new states of the device. \ No newline at end of file +- The AVR has no endpoints to determine the volume, muted, playing etc., so if the remote control is used, HA will not know the new states of the device. diff --git a/source/_components/media_player.horizon.markdown b/source/_components/media_player.horizon.markdown index f8600e87144..d27fc231f28 100644 --- a/source/_components/media_player.horizon.markdown +++ b/source/_components/media_player.horizon.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: unitymedia.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.72 --- diff --git a/source/_components/media_player.itunes.markdown b/source/_components/media_player.itunes.markdown index 717307250a2..4fe90b56263 100644 --- a/source/_components/media_player.itunes.markdown +++ b/source/_components/media_player.itunes.markdown @@ -10,7 +10,7 @@ footer: true logo: itunes.png ha_category: Media Player ha_release: 0.7.3 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/media_player.kodi.markdown b/source/_components/media_player.kodi.markdown index 5985000f6fe..0d7cb2042ad 100644 --- a/source/_components/media_player.kodi.markdown +++ b/source/_components/media_player.kodi.markdown @@ -11,7 +11,7 @@ logo: kodi.png ha_category: Media Player featured: true ha_release: pre 0.7 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- diff --git a/source/_components/media_player.lg_netcast.markdown b/source/_components/media_player.lg_netcast.markdown index 135ffac5914..0cdd098bf11 100644 --- a/source/_components/media_player.lg_netcast.markdown +++ b/source/_components/media_player.lg_netcast.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: lg.png ha_category: Media Player -ha_iot_class: "Local Poll" +ha_iot_class: Local Polling ha_release: "0.20" -ha_iot_class: "Local Polling" --- The `lg_netcast` platform allows you to control a LG Smart TV running NetCast 3.0 (LG Smart TV models released in 2012) and NetCast 4.0 (LG Smart TV models released in 2013). For the new LG WebOS TV's use the [webostv](/components/media_player.webostv) platform. diff --git a/source/_components/media_player.lg_soundbar.markdown b/source/_components/media_player.lg_soundbar.markdown index ff8878e0dc8..9f529c3d0c4 100644 --- a/source/_components/media_player.lg_soundbar.markdown +++ b/source/_components/media_player.lg_soundbar.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: lg.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.81 --- diff --git a/source/_components/media_player.liveboxplaytv.markdown b/source/_components/media_player.liveboxplaytv.markdown index 368ae381777..1f1fd432b9f 100644 --- a/source/_components/media_player.liveboxplaytv.markdown +++ b/source/_components/media_player.liveboxplaytv.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: orange.png ha_category: Media Player -featured: false ha_release: 0.38 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `liveboxplaytv` platform allows you to control [Orange Livebox Play TV appliances](https://boutique.orange.fr/internet/decodeur-tv-livebox). diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index 23c397673c4..5bfb1c3fd08 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.7 --- Interacts with media players on your network. Please check the right sidebar for a full list of supported devices. @@ -14,7 +15,7 @@ Interacts with media players on your network. Please check the right sidebar for ## {% linkable_title Services %} ### {% linkable_title Media control services %} -Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `volume_set`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`, `shuffle_set` +Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `volume_set`, `volume_mute`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`, `shuffle_set` | Service data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------ | diff --git a/source/_components/media_player.mediaroom.markdown b/source/_components/media_player.mediaroom.markdown index 39a417a5f31..6586ca70d71 100644 --- a/source/_components/media_player.mediaroom.markdown +++ b/source/_components/media_player.mediaroom.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: mediaroom.png ha_category: Media Player -ha_iot_class: "Local Polling" -ha_release: "0.63" +ha_iot_class: Local Polling +ha_release: 0.63 --- The `mediaroom` component allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant. @@ -47,7 +47,7 @@ Notice that all parameters are optional, and discovery should configure everythi The component has been developed for Portuguese TV operators currently using the Mediaroom platform, but should also work in other deployments in which the STB can be controlled remotely through a socket on port 8082. -In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. +In most cases (single STB) you just need to setup the *platform* and discovery will do the rest. If the STB is on the same network segment as Home Assistant, it can determine whether the device is turned on or off. Without this, the component will fail to determine the Set-top box status, and you are required to add the *optimistic* configuration variable. diff --git a/source/_components/media_player.monoprice.markdown b/source/_components/media_player.monoprice.markdown index eda0f9e9f23..48a6a58d846 100644 --- a/source/_components/media_player.monoprice.markdown +++ b/source/_components/media_player.monoprice.markdown @@ -10,7 +10,7 @@ footer: true logo: monoprice.svg ha_category: Media Player ha_release: 0.56 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `monoprice` platform allows you to control [Monoprice 6-Zone Amplifier](https://www.monoprice.com/product?p_id=10761) using a serial connection. diff --git a/source/_components/media_player.mpchc.markdown b/source/_components/media_player.mpchc.markdown index a963faf5406..e43017e2e10 100644 --- a/source/_components/media_player.mpchc.markdown +++ b/source/_components/media_player.mpchc.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: mpchc.png ha_category: Media Player -featured: false ha_release: 0.25 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/media_player.mpd.markdown b/source/_components/media_player.mpd.markdown index da37e9c478b..819ffaa38c0 100644 --- a/source/_components/media_player.mpd.markdown +++ b/source/_components/media_player.mpd.markdown @@ -10,11 +10,11 @@ footer: true logo: mpd.png ha_category: Media Player ha_release: pre 0.7 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- -The `mpd` platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Unfortunately you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs. +The `mpd` platform allows you to control a [Music Player Daemon](http://www.musicpd.org/) from Home Assistant. Unfortunately you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs. Even though no playlist manipulation is possible, it is possible to use the play_media service to load an existing saved playlist as part of an automation or scene. diff --git a/source/_components/media_player.nad.markdown b/source/_components/media_player.nad.markdown index 2804632301f..04cd8ef3696 100644 --- a/source/_components/media_player.nad.markdown +++ b/source/_components/media_player.nad.markdown @@ -10,7 +10,7 @@ footer: true logo: nad.png ha_category: Media Player ha_release: 0.36 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `nad` platform allows you to control a [NAD receiver](http://nadelectronics.com) through RS232, TCP and Telnet from Home Assistant. diff --git a/source/_components/media_player.onkyo.markdown b/source/_components/media_player.onkyo.markdown index d934f92b1f2..3ae12a7ef57 100644 --- a/source/_components/media_player.onkyo.markdown +++ b/source/_components/media_player.onkyo.markdown @@ -10,7 +10,7 @@ footer: true logo: onkyo.png ha_category: Media Player ha_release: 0.17 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- @@ -130,5 +130,5 @@ script: service_data: entity_id: media_player.onkyo hdmi_output: out-sub - -``` \ No newline at end of file + +``` diff --git a/source/_components/media_player.openhome.markdown b/source/_components/media_player.openhome.markdown index ae10d32d3c6..d0ac49a654c 100644 --- a/source/_components/media_player.openhome.markdown +++ b/source/_components/media_player.openhome.markdown @@ -9,13 +9,12 @@ sharing: true footer: true logo: linn.png ha_category: Media Player -featured: false ha_release: 0.39 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- -The `openhome` platform allows you to connect an [Openhome Compliant Renderer](https://www.openhome.org) to Home Assistant such as a [Linn Products Ltd](https://www.linn.co.uk) HiFi streamer. It will allow you to control media playback, volume, source and see the current playing item. Openhome devices should be discovered by using the [the discovery component](/components/discovery/), their device names are taken from the name of the room configured on the device. +The `openhome` platform allows you to connect an [Openhome Compliant Renderer](https://www.openhome.org) to Home Assistant such as a [Linn Products Ltd](https://www.linn.co.uk) HiFi streamer. It will allow you to control media playback, volume, source and see the current playing item. Openhome devices should be discovered by using the [the discovery component](/components/discovery/), their device names are taken from the name of the room configured on the device. ```yaml # Example configuration.yaml entry diff --git a/source/_components/media_player.panasonic_bluray.markdown b/source/_components/media_player.panasonic_bluray.markdown index 4791e384a7e..73a52dd012a 100644 --- a/source/_components/media_player.panasonic_bluray.markdown +++ b/source/_components/media_player.panasonic_bluray.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: panasonic.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.83 --- diff --git a/source/_components/media_player.panasonic_viera.markdown b/source/_components/media_player.panasonic_viera.markdown index ac1a157c452..bf7e4ed32f1 100644 --- a/source/_components/media_player.panasonic_viera.markdown +++ b/source/_components/media_player.panasonic_viera.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: panasonic.png ha_category: Media Player -featured: false ha_release: 0.17 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `panasonic_viera` platform allows you to control a Panasonic Viera TV. diff --git a/source/_components/media_player.pandora.markdown b/source/_components/media_player.pandora.markdown index f84bfd41f14..e0ae0199036 100644 --- a/source/_components/media_player.pandora.markdown +++ b/source/_components/media_player.pandora.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: pandora.png ha_category: Media Player -featured: false ha_release: 0.22 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- If you have a Pandora account, you can control it from Home Assistant with this media player. diff --git a/source/_components/media_player.philips_js.markdown b/source/_components/media_player.philips_js.markdown index 75734debc67..c821060cb2a 100644 --- a/source/_components/media_player.philips_js.markdown +++ b/source/_components/media_player.philips_js.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: philips.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.34 --- @@ -51,7 +51,7 @@ When using api_version: 5 changing sources switches tv channels. Additionally th

```yaml -# Example configuration.yaml with turn_on_action +# Example configuration.yaml with turn_on_action media_player: - platform: philips_js host: 192.168.1.99 diff --git a/source/_components/media_player.pioneer.markdown b/source/_components/media_player.pioneer.markdown index 958cee2fe55..a3e05f2ae6c 100644 --- a/source/_components/media_player.pioneer.markdown +++ b/source/_components/media_player.pioneer.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: pioneer.png ha_category: Media Player -featured: false ha_release: 0.19 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `pioneer` platform allows you to control Pioneer Network Receivers. Please note, however, that the more recent Pioneer models work with [Onkyo](/components/media_player.onkyo/) platform instead. diff --git a/source/_components/media_player.pjlink.markdown b/source/_components/media_player.pjlink.markdown index 95f539731e6..57a5166cef8 100644 --- a/source/_components/media_player.pjlink.markdown +++ b/source/_components/media_player.pjlink.markdown @@ -10,7 +10,7 @@ footer: true logo: pjlink.png ha_category: Media Player ha_release: 0.76 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `pjlink` platform allows you to control from Home Assistant, projectors with support for the [PJLink protocol](http://pjlink.jbmia.or.jp/english/index.html). diff --git a/source/_components/media_player.plex.markdown b/source/_components/media_player.plex.markdown index ef76c47304d..39a194ac7e7 100644 --- a/source/_components/media_player.plex.markdown +++ b/source/_components/media_player.plex.markdown @@ -11,7 +11,7 @@ logo: plex.png ha_category: Media Player featured: true ha_release: 0.7.4 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/media_player.russound_rio.markdown b/source/_components/media_player.russound_rio.markdown index c431cbbec1d..9fb29c8fff9 100644 --- a/source/_components/media_player.russound_rio.markdown +++ b/source/_components/media_player.russound_rio.markdown @@ -10,7 +10,7 @@ footer: true logo: russound.png ha_category: Media Player ha_release: 0.49 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `russound_rio` platform allows you to control Russound devices that make use of the RIO protocol. diff --git a/source/_components/media_player.russound_rnet.markdown b/source/_components/media_player.russound_rnet.markdown index c8bd43a1739..42c1ad2775d 100644 --- a/source/_components/media_player.russound_rnet.markdown +++ b/source/_components/media_player.russound_rnet.markdown @@ -10,7 +10,7 @@ footer: true logo: russound.png ha_category: Media Player ha_release: 0.25 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `russound_rnet` platform allows you to control Russound devices that make use of the RNET protocol. diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 4d4e9d878df..799f21f7c5b 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: samsung.png ha_category: Media Player -featured: false ha_release: 0.13 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `samsungtv` platform allows you to control a diff --git a/source/_components/media_player.snapcast.markdown b/source/_components/media_player.snapcast.markdown index b889f5168ae..c0636f5b08f 100644 --- a/source/_components/media_player.snapcast.markdown +++ b/source/_components/media_player.snapcast.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: snapcast.png ha_category: Media Player -featured: false ha_release: 0.13 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `snapcast` platform allows you to control [Snapcast](https://github.com/badaix/snapcast) from Home Assistant. diff --git a/source/_components/media_player.songpal.markdown b/source/_components/media_player.songpal.markdown index 1dbfc0dd8a9..be99a05bb15 100644 --- a/source/_components/media_player.songpal.markdown +++ b/source/_components/media_player.songpal.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: sony.png ha_category: Media Player -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: 0.65 --- diff --git a/source/_components/media_player.soundtouch.markdown b/source/_components/media_player.soundtouch.markdown index c70eba92446..da20b48c644 100644 --- a/source/_components/media_player.soundtouch.markdown +++ b/source/_components/media_player.soundtouch.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: soundtouch.png ha_category: Media Player -ha_release: 0.34.0 -ha_iot_class: "Local Polling" +ha_release: 0.34 +ha_iot_class: Local Polling --- The `soundtouch` platform allows you to control your [Bose Soundtouch](https://www.soundtouch.com/) speakers from Home Assistant. @@ -54,7 +54,7 @@ name: default: Bose Soundtouch type: string port: - description: The port number. + description: The port number. required: false default: 8090 type: integer diff --git a/source/_components/media_player.spotify.markdown b/source/_components/media_player.spotify.markdown index 4a97efa22a7..982730bd33b 100644 --- a/source/_components/media_player.spotify.markdown +++ b/source/_components/media_player.spotify.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: spotify.png ha_category: Media Player -featured: false ha_release: 0.43 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `spotify` media player platform allows you to control diff --git a/source/_components/media_player.squeezebox.markdown b/source/_components/media_player.squeezebox.markdown index e119e97b42c..e215186b541 100644 --- a/source/_components/media_player.squeezebox.markdown +++ b/source/_components/media_player.squeezebox.markdown @@ -10,7 +10,7 @@ footer: true logo: squeezebox.png ha_category: Media Player ha_release: pre 0.7 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- @@ -60,14 +60,14 @@ transporter_toslink: data: entity_id: media_player.transporter media_content_id: "source:toslink" - media_content_type: "music" + media_content_type: "music" ``` ### {% linkable_title Service `squeezebox_call_method` %} Call a custom Squeezebox JSONRPC API. -See documentation for this interface on http://HOST:PORT/html/docs/cli-api.html?player= where HOST and PORT are the host name and port for your Logitech Media Server. +See documentation for this interface on http://HOST:PORT/html/docs/cli-api.html?player= where HOST and PORT are the host name and port for your Logitech Media Server. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | @@ -81,6 +81,6 @@ It can also be used to target a Squeezebox from IFTT (or DialogFlow, Alexa...). For example, to play an album from your collection, create an IFTT applet like this: - Trigger: Google assistant, with sentence: `I want to listen to album $` -- Action: JSON post query with such JSON body: -`{ "entity_id": "media_player.squeezebox_radio", "command": "playlist", "parameters": ["loadtracks", "album.titlesearch={{TextField}}"] }` +- Action: JSON post query with such JSON body: +`{ "entity_id": "media_player.squeezebox_radio", "command": "playlist", "parameters": ["loadtracks", "album.titlesearch={{TextField}}"] }` This can work with title search and basically any thing. The same wouldn't have worked by calling directly Squeezebox server as IFTT cannot escape the text field. diff --git a/source/_components/media_player.ue_smart_radio.markdown b/source/_components/media_player.ue_smart_radio.markdown index 0a250b6b860..cce3cde31ea 100644 --- a/source/_components/media_player.ue_smart_radio.markdown +++ b/source/_components/media_player.ue_smart_radio.markdown @@ -10,7 +10,7 @@ footer: true logo: ueradio.png ha_category: Media Player ha_release: "0.60" -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- diff --git a/source/_components/media_player.universal.markdown b/source/_components/media_player.universal.markdown index bd8d5a07386..4b1bdc12f58 100644 --- a/source/_components/media_player.universal.markdown +++ b/source/_components/media_player.universal.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Media Player ha_qa_scale: internal +ha_release: 0.11 --- Universal Media Players combine multiple existing entities in Home Assistant into one media player entity. This is used for creating a single entity that controls an entire media center. diff --git a/source/_components/media_player.vizio.markdown b/source/_components/media_player.vizio.markdown index e826693d6c3..234ed528955 100644 --- a/source/_components/media_player.vizio.markdown +++ b/source/_components/media_player.vizio.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: vizio-smartcast.png ha_category: Media Player -featured: false ha_release: 0.49 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `vizio` component will allow you to control [SmartCast](https://www.vizio.com/smartcast-app) compatible TVs (2016+ models). diff --git a/source/_components/media_player.vlc.markdown b/source/_components/media_player.vlc.markdown index 0037537535a..0ec61742d2f 100644 --- a/source/_components/media_player.vlc.markdown +++ b/source/_components/media_player.vlc.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: videolan.png ha_category: Media Player -featured: false ha_release: 0.35 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `vlc` platform allows you to control [VLC media player](http://www.videolan.org/vlc/index.html). diff --git a/source/_components/media_player.webostv.markdown b/source/_components/media_player.webostv.markdown index ed629734aac..e924badd9a8 100644 --- a/source/_components/media_player.webostv.markdown +++ b/source/_components/media_player.webostv.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: webos.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.18 --- diff --git a/source/_components/media_player.xiaomi_tv.markdown b/source/_components/media_player.xiaomi_tv.markdown index e9c3eeb601b..301ed1adeba 100644 --- a/source/_components/media_player.xiaomi_tv.markdown +++ b/source/_components/media_player.xiaomi_tv.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Media Player ha_release: 0.64 -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State --- The `xiaomi_tv` platform allows you to control a [Xiaomi TV](http://www.mi.com/en/mitv3s/65flat/). diff --git a/source/_components/media_player.ziggo_mediabox_xl.markdown b/source/_components/media_player.ziggo_mediabox_xl.markdown index 0581b320a26..f23894df14c 100644 --- a/source/_components/media_player.ziggo_mediabox_xl.markdown +++ b/source/_components/media_player.ziggo_mediabox_xl.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: ziggo.png ha_category: Media Player -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: "0.60" --- diff --git a/source/_components/melissa.markdown b/source/_components/melissa.markdown index 5a8145da286..17eafe9bd02 100644 --- a/source/_components/melissa.markdown +++ b/source/_components/melissa.markdown @@ -11,9 +11,8 @@ logo: mclimate.png ha_category: - Hub - Climate -featured: false ha_release: 0.63 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/climate.melissa/ --- diff --git a/source/_components/mercedesme.markdown b/source/_components/mercedesme.markdown index b323f75e9aa..e21c4adc556 100644 --- a/source/_components/mercedesme.markdown +++ b/source/_components/mercedesme.markdown @@ -14,7 +14,7 @@ ha_category: - Presence Detection - Sensor ha_release: 0.63 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.mercedesme/ - /components/device_tracker.mercedesme/ diff --git a/source/_components/meteo_france.markdown b/source/_components/meteo_france.markdown index 06fb6f606c2..aa66685875b 100644 --- a/source/_components/meteo_france.markdown +++ b/source/_components/meteo_france.markdown @@ -8,13 +8,12 @@ comments: false sharing: true footer: true logo: meteo-france.png -ha_category: Hub ha_release: 0.89 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_category: + - Hub - Sensor - Weather -ha_iot_class: "Local Push" redirect_from: - /components/sensor.meteo_france/ - /components/weather.meteo_france/ diff --git a/source/_components/microsoft_face.markdown b/source/_components/microsoft_face.markdown index 1375109e276..ee8554d0424 100644 --- a/source/_components/microsoft_face.markdown +++ b/source/_components/microsoft_face.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: microsoft.png ha_category: Image Processing -ha_release: "0.37" +ha_release: 0.37 --- The `microsoft_face` component platform is the main component for Microsoft diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index 6ed59bbed9e..86b9232747b 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -10,7 +10,7 @@ footer: true logo: modbus.png ha_category: Hub ha_release: pre 0.7 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- @@ -128,7 +128,7 @@ modbus: host: IP_ADDRESS_1 port: 2020 hub: hub1 - + - type: tcp host: IP_ADDRESS_2 port: 501 diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index c9d73254459..fe98b223e87 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -11,14 +11,14 @@ logo: mqtt.png ha_category: Hub featured: true ha_release: pre 0.7 -ha_iot_class: local push +ha_iot_class: Local Push --- MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things" connectivity protocol on top of TCP/IP. It allows extremely lightweight publish/subscribe messaging transport. Your first step to get MQTT and Home Assistant working is to choose a [broker](/docs/mqtt/broker). -To integrate MQTT into Home Assistant, add the following section to your `configuration.yaml` file. +To integrate MQTT into Home Assistant, add the following section to your `configuration.yaml` file. To connect to your [own MQTT broker](/docs/mqtt/broker#run-your-own): diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index 4946433e630..4ea0c5439ad 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Other ha_release: 0.11 -ha_iot_class: depends +ha_iot_class: Configurable --- The `mqtt_eventstream` component connects two Home Assistant instances via MQTT. diff --git a/source/_components/mqtt_statestream.markdown b/source/_components/mqtt_statestream.markdown index d1bcb8c642f..822187cbb48 100644 --- a/source/_components/mqtt_statestream.markdown +++ b/source/_components/mqtt_statestream.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Other ha_release: 0.54 -ha_iot_class: depends +ha_iot_class: Configurable --- The `mqtt_statestream` component publishes state changes in Home Assistant to individual MQTT topics. diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index 6be1ce7dbc5..3f91dbdc9e3 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -10,7 +10,7 @@ footer: true logo: chevy.png ha_category: Car ha_release: 0.62 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.mychevy/ - /components/sensor.mychevy/ diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index 855749eefa5..a373f5f04f9 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: mysensors.png ha_category: DIY -featured: false -ha_iot_class: "Local Push" +ha_iot_class: Local Push +ha_release: 0.73 --- The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This component will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified. diff --git a/source/_components/mythicbeastsdns.markdown b/source/_components/mythicbeastsdns.markdown index bb96e904097..b12e0b95ffc 100644 --- a/source/_components/mythicbeastsdns.markdown +++ b/source/_components/mythicbeastsdns.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Network ha_release: 0.85 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push logo: mythic_beasts.png --- diff --git a/source/_components/namecheapdns.markdown b/source/_components/namecheapdns.markdown index 6f156306d7c..95ebe8e032b 100644 --- a/source/_components/namecheapdns.markdown +++ b/source/_components/namecheapdns.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: namecheap.png ha_category: Network -featured: false ha_release: 0.56 --- diff --git a/source/_components/ness_alarm.markdown b/source/_components/ness_alarm.markdown index 9a3f36dbf7a..0d525674856 100644 --- a/source/_components/ness_alarm.markdown +++ b/source/_components/ness_alarm.markdown @@ -12,7 +12,7 @@ ha_category: - Alarm - Binary Sensor ha_release: 0.85 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/alarm_control_panel.ness_alarm/ - /components/binary_sensor.ness_alarm/ diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 86a86ba4873..c8b22981416 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -15,12 +15,13 @@ ha_category: - Climate - Sensor featured: true -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push redirect_from: - /components/binary_sensor.nest/ - /components/camera.nest/ - /components/climate.nest/ - /components/sensor.nest/ +ha_release: 0.7 --- The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`. @@ -339,4 +340,4 @@ If a Nest Cam detects the presence of a person (see `person_detected` in [binary A `deter` state is re-evaluated after several minutes and relaxed to `ok` if no further `person_detected` events have occurred. -The `security_state` automatically switches to `ok` when the structure state is `home`. \ No newline at end of file +The `security_state` automatically switches to `ok` when the structure state is `home`. diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index 8f856e9b691..9797d3f08fa 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -10,7 +10,7 @@ footer: true logo: netatmo.png ha_category: Hub ha_release: "0.20" -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `netatmo` component platform is the main component to integrate all Netatmo related platforms. @@ -128,4 +128,4 @@ There are two services to manually add and drop the webhooks. This might be usef | Service | Description | | ------- | ----------- | | addwebhook | Subscribe to webhooks. By default the automatically generated URL will be used. But you can pass `{"url": "https://yourdomain.com/yourwebhook/"}` as service data to the service call if you want to use a manually created [webhook trigger](https://www.home-assistant.io/docs/automation/trigger/#webhook-trigger). In this case you have to manually process the data that is sent by Netatmo. -| dropwebhook | Unsubscribe existing webhooks. \ No newline at end of file +| dropwebhook | Unsubscribe existing webhooks. diff --git a/source/_components/netgear_lte.markdown b/source/_components/netgear_lte.markdown index 92aaa747e54..c7fdac5a927 100644 --- a/source/_components/netgear_lte.markdown +++ b/source/_components/netgear_lte.markdown @@ -13,7 +13,7 @@ ha_category: - Network - Notifications - Sensor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/notify.netgear_lte/ - /components/sensor.netgear_lte/ diff --git a/source/_components/nissan_leaf.markdown b/source/_components/nissan_leaf.markdown index 2e9945f0a8b..d728b969d6b 100644 --- a/source/_components/nissan_leaf.markdown +++ b/source/_components/nissan_leaf.markdown @@ -10,7 +10,7 @@ footer: true logo: nissan.png ha_category: Car ha_release: 0.89 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.nissan_leaf/ - /components/sensor.nissan_leaf/ @@ -49,7 +49,7 @@ 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 a pre-2014 24 kWh Leaf then you will have Carwings and this should be set to false. + 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. required: false type: boolean update_interval: @@ -128,6 +128,7 @@ You can also use the `nissan_leaf.update` service to request an on-demand update * Responses from the Nissan servers are received separately for the battery/range, climate control and location. The `updated_on` attribute will show the last time the data was retrieved from the server. There are separate attributes for when the `next_update` is scheduled, and to indicate if `update_in_progress`. The `nissan_leaf.update` service will reset the `next_update` attribute. * The Nissan APIs do not allow charging to be stopped remotely. * The Nissan servers have a history of being unstable, therefore please confirm that the official Nissan Leaf app/website is working correctly before reporting bugs. +* In the UK the cut-off for Carwings was the 16 plate 24 kWh and the 65 plate 30 kWh. Cars after this have NissanConnect. Please report bugs using the following logger configuration. diff --git a/source/_components/norway_air.markdown b/source/_components/norway_air.markdown index 69ffa681ee0..fe72ae16b91 100644 --- a/source/_components/norway_air.markdown +++ b/source/_components/norway_air.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: metno.png ha_category: Health -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.88 --- diff --git a/source/_components/notify.discord.markdown b/source/_components/notify.discord.markdown index 6f296ea538e..f9214277748 100644 --- a/source/_components/notify.discord.markdown +++ b/source/_components/notify.discord.markdown @@ -88,6 +88,8 @@ This channel ID has to be used as the target when calling the notification servi ### {% linkable_title Notes %} +You can tag any user inside a channel by using their user ID in the message like so: `<@userid>` replacing `userid` with the ID you copied. To get the user ID right click on the user name to copy the ID like you did for the channel ID up above. + For more information about creating and authorizing bots, visit the [OAuth2 information page](https://discordapp.com/developers/docs/topics/oauth2) To use notifications effectively, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.hipchat.markdown b/source/_components/notify.hipchat.markdown index b4f81a989ce..628f0690fb7 100644 --- a/source/_components/notify.hipchat.markdown +++ b/source/_components/notify.hipchat.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: hipchat.png ha_category: Notifications -ha_release: "0.52" +ha_release: 0.52 ---

diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index 72c18e724d4..d83b0db54ac 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -10,7 +10,7 @@ footer: true logo: knx.png ha_category: Notifications ha_release: 0.53 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `knx` notify platform allows you to send notifications to [KNX](http://www.knx.org) devices. diff --git a/source/_components/notify.markdown b/source/_components/notify.markdown index b152139954b..bab55206cc5 100644 --- a/source/_components/notify.markdown +++ b/source/_components/notify.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.7 --- The `notify` component makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported. diff --git a/source/_components/notify.mycroft.markdown b/source/_components/notify.mycroft.markdown index d868b43331a..b427ee358e9 100644 --- a/source/_components/notify.mycroft.markdown +++ b/source/_components/notify.mycroft.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: mycroft.png ha_category: Notifications -ha_release: "0.53" +ha_release: 0.53 --- The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/). diff --git a/source/_components/notify.mysensors.markdown b/source/_components/notify.mysensors.markdown index 8a3ff799d39..0fe8e8318ab 100644 --- a/source/_components/notify.mysensors.markdown +++ b/source/_components/notify.mysensors.markdown @@ -12,7 +12,7 @@ ha_category: - DIY - Notifications ha_release: 0.36 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- Integrates MySensors notifications into Home Assistant. See the [main component] for configuration instructions. diff --git a/source/_components/notify.pushbullet.markdown b/source/_components/notify.pushbullet.markdown index ad52044e55b..0ea6a958c40 100644 --- a/source/_components/notify.pushbullet.markdown +++ b/source/_components/notify.pushbullet.markdown @@ -10,6 +10,7 @@ footer: true logo: pushbullet.png ha_category: Notifications featured: true +ha_release: 0.7 --- The `pushbullet` notification platform sends messages to [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. diff --git a/source/_components/notify.sendgrid.markdown b/source/_components/notify.sendgrid.markdown index c5f37d0d10f..5f92fc2d551 100644 --- a/source/_components/notify.sendgrid.markdown +++ b/source/_components/notify.sendgrid.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: sendgrid.png ha_category: Notifications +ha_release: 0.14 --- The `sendgrid` notification platform sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform. diff --git a/source/_components/notify.webostv.markdown b/source/_components/notify.webostv.markdown index 65603b7bb0c..16e8bb0112b 100644 --- a/source/_components/notify.webostv.markdown +++ b/source/_components/notify.webostv.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: webos.png ha_category: Notifications -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.18 --- diff --git a/source/_components/nuheat.markdown b/source/_components/nuheat.markdown index 4d7edc73d19..9af3508e092 100644 --- a/source/_components/nuheat.markdown +++ b/source/_components/nuheat.markdown @@ -11,7 +11,7 @@ logo: nuheat.png ha_category: - Climate ha_release: 0.61 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/climate.nuheat/ --- diff --git a/source/_components/nuimo_controller.markdown b/source/_components/nuimo_controller.markdown index cfbb5f66d89..7a844803f35 100644 --- a/source/_components/nuimo_controller.markdown +++ b/source/_components/nuimo_controller.markdown @@ -10,7 +10,7 @@ footer: true logo: nuimo.png ha_category: Hub ha_release: 0.29 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `nuimo_controller` component allows you to connect to a [Nuimo](http://www.senic.com/) device for receiving input events and displaying on the LED matrix via the [Nuimo SDK for Python on Linux](https://github.com/getSenic/nuimo-linux-python). diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index 5a9de6605b9..5d5f4f7dc63 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -12,9 +12,8 @@ ha_category: - Hub - Binary Sensor - Sensor -featured: false ha_release: 0.19 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.octoprint/ - /components/sensor.octoprint/ diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index be8ff5d7d2e..2cb03e5984e 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -14,7 +14,7 @@ ha_category: - Climate - Sensor ha_release: 0.81 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.opentherm_gw/ - /components/climate.opentherm_gw/ diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index 442315a407f..bccc8d3c049 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor - Sensor ha_release: 0.76 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_config_flow: true redirect_from: - /components/binary_sensor.openuv/ diff --git a/source/_components/owlet.markdown b/source/_components/owlet.markdown index b2f4dd3d4f8..4b4b3954cf0 100644 --- a/source/_components/owlet.markdown +++ b/source/_components/owlet.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: owlet.svg -ha_category: +ha_category: - Health - Binary Sensor - Sensor -ha_release: "0.89" -ha_iot_class: "Cloud Polling" +ha_release: 0.89 +ha_iot_class: Cloud Polling --- [Owlet Care](https://owletcare.com/) baby monitors check your baby's oxygen level and heart rate while sleeping. diff --git a/source/_components/owntracks.markdown b/source/_components/owntracks.markdown index 7d792c7f2bf..b48c1116893 100644 --- a/source/_components/owntracks.markdown +++ b/source/_components/owntracks.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: owntracks.png ha_category: Presence Detection -featured: false ha_release: 0.7.4 redirect_from: - /components/device_tracker.owntracks/ diff --git a/source/_components/person.markdown b/source/_components/person.markdown index e19dddec09a..db5bf96bbb9 100644 --- a/source/_components/person.markdown +++ b/source/_components/person.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Person" -description: "Instructions on how to setup people tracking within Home Assistant." +description: "Instructions on how to set up people tracking within Home Assistant." date: 2019-02-05 22:36 sidebar: true comments: false @@ -13,25 +13,26 @@ ha_qa_scale: internal ha_release: 0.88 --- -The person component allows to connect device tracker entities to one or more person entities. The state updates of a connected device trackers will set the state of the person. When multiple device tracers used, the state of berson will be determined next way: +The person component allows connecting device tracker entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers used, the state of person will be determined next way: -1. If there are stationary sources (which type is not 'gps') presenting status 'home', than latest of this sources will be taken. -2. If there are sources of type 'gps', than latest of this sources will be taken. -3. Otherwise will be taken latest source with status 'not_home'. +1. If there are stationary sources (which type is not 'gps') presenting status 'home', the latest of these sources will be taken. +2. If there are sources of type 'gps', then the latest of these sources will be taken. +3. Otherwise will be taken the latest source with status 'not_home'. -Lets say for example, that you have 3 trackers: 'tracker_gps', 'tracker_router' and 'tracker_ble'. +Let's say, for example, that you have 3 trackers: 'tracker_gps', 'tracker_router' and 'tracker_ble'. -1. You're at home, all 3 devices shows status 'home' - status of your Person entity will be 'home' with source 'tracker_router' or 'tracker_ble', whatever was latest. -2. You're going out. 'tracker_gps' shows status 'not_home', but other two trackers show status 'home' according to their setting 'consider_home'. You are still considered to be at home. +1. You're at home, all 3 devices show status 'home' - status of your Person entity will be 'home' with source 'tracker_router' or 'tracker_ble', whatever was latest. +2. You're going out. 'tracker_gps' shows status 'not_home', but the other two trackers show status 'home' according to their setting 'consider_home'. You are still considered to be at home. 3. After some time both stationary trackers show status 'not_home'. Now your Person entity has status 'not_home' with source 'tracker_gps'. -4. While you are outside your home, your Home Assistant was suddenly restarted. Until 'tracker_gps' receives update, your status will be determined by stationary tracker, which gets latest update after restart. Obviously the status will be 'not_home'. -5. Than you're going into area marked as 'zone1', 'tracker_gps' is getting update, and now your status is 'zone1' with source 'tracker_gps'. -6. You've returned home, and your mobile device has connected to router, but GPS update yet didn't occur. Your status will be 'home' with source 'tracker_router'. -7. After GPS update occurs, your status still be 'home' with source 'tracker_router' or 'tracker_ble', whatever updates later. +4. While you are outside your home, your Home Assistant was suddenly restarted. Until 'tracker_gps' receives an update, your status will be determined by stationary tracker, which gets the latest update after a restart. Obviously, the status will be 'not_home'. +5. Then you're going into the area marked as 'zone1', 'tracker_gps' is getting an update, and now your status is 'zone1' with source 'tracker_gps'. +6. You've returned home and your mobile device has connected to the router, but GPS update yet didn't occur. Your status will be 'home' with source 'tracker_router'. +7. After the GPS update occurs, your status will still be 'home' with source 'tracker_router' or 'tracker_ble', whatever updates latest. TL;DR: When you're at home, your position is determined firstly by stationary trackers (if any) and then by GPS. When you're outside your home, your position is determined firstly by GPS and then by stationary trackers. -**Hint**: When you use multiple device trackers together, especially stationary and GPS trackers, it's advisable to set `consider_home`for stationary trackers as low as possible. + +**Hint**: When you use multiple device trackers together, especially stationary and GPS trackers, it's advisable to set `consider_home` for stationary trackers as low as possible. You can manage persons via the UI from the person page inside the configuration panel or via `YAML`. diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 18dd9a659d9..8dfe42157b5 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -14,7 +14,7 @@ ha_category: - Sensor - Switch ha_release: 0.26 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.pilight/ - /components/sensor.pilight/ diff --git a/source/_components/plum_lightpad.markdown b/source/_components/plum_lightpad.markdown index 04f0865ef90..43105d8ebda 100644 --- a/source/_components/plum_lightpad.markdown +++ b/source/_components/plum_lightpad.markdown @@ -8,8 +8,7 @@ comments: false sharing: true footer: true ha_category: Switch -ha_iot_class: "Local Push" -featured: false +ha_iot_class: Local Push logo: plum.png ha_release: 0.85 redirect_from: diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 4cd792a0f1b..1fa0b60fdce 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -13,10 +13,9 @@ ha_category: - Alarm - Binary Sensor - Sensor -featured: false -ha_release: "0.83" +ha_release: 0.83 ha_config_flow: true -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_qa_scale: gold redirect_from: - /components/binary_sensor.point/ @@ -61,7 +60,7 @@ The integration supports the following device types within Home Assistant: - [Sensor](#sensor)

-The Point is just active occasionally so the [Sensors](#sensor) are only updated every hour or so. The [Binary Sensors](#binary-sensor) are however updated via [Cloud Push](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant. +The Point is just active occasionally so the [Sensors](#sensor) are only updated every hour or so. The [Binary Sensors](#binary-sensor) are however updated via [Cloud Push](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#cloud-pushing-new-state), making the changes close to instant.

## {% linkable_title Alarm %} @@ -69,7 +68,7 @@ The Point is just active occasionally so the [Sensors](#sensor) are only updated Each home configured in the Point mobile application will show up as a separate alarm control panel. The panels allow **arming** and **disarming** of the Point home alarm system.

-The Point only supports a Arm/Disarm action, so there is no difference between `Arm Home` and `Arm Away`. +The Point only supports a Arm/Disarm action, so it is only `Arm Away` that is implememented.

## {% linkable_title Binary Sensor %} diff --git a/source/_components/ps4.markdown b/source/_components/ps4.markdown index e4da489b382..126981ce59f 100644 --- a/source/_components/ps4.markdown +++ b/source/_components/ps4.markdown @@ -10,7 +10,7 @@ footer: true logo: ps4.png ha_category: Media Player ha_release: 0.89 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `ps4` component allows you to control a diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown index fc79c19274e..2f330d4693b 100644 --- a/source/_components/qwikswitch.markdown +++ b/source/_components/qwikswitch.markdown @@ -14,7 +14,6 @@ ha_category: - Light - Sensor - Switch -featured: false ha_release: "0.20" redirect_from: - /components/binary_sensor.qwikswitch/ @@ -151,4 +150,4 @@ qwikswitch: The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays as switches from within Home Assistant. -If the device name in the QS Mobile application ends with `Switch` it will be created as a switch, otherwise as a light. \ No newline at end of file +If the device name in the QS Mobile application ends with `Switch` it will be created as a switch, otherwise as a light. diff --git a/source/_components/rachio.markdown b/source/_components/rachio.markdown index 55b7cfc1239..637c2d37782 100644 --- a/source/_components/rachio.markdown +++ b/source/_components/rachio.markdown @@ -12,7 +12,7 @@ ha_category: - Irrigation - Binary Sensor - Switch -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push ha_release: 0.73 redirect_from: - /components/binary_sensor.rachio/ @@ -113,4 +113,4 @@ zones_back: entities: - switch.back_garden - switch.back_porch -``` \ No newline at end of file +``` diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index f58d7a1d9a9..5da5d99c906 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -13,7 +13,7 @@ ha_category: - Sensor - Switch ha_release: 0.61 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/sensor.rainbird/ - /components/switch.rainbird/ @@ -68,7 +68,7 @@ sensor: {% configuration %} monitored_conditions: - description: Conditions to be monitored. + description: Conditions to be monitored. keys: rainsensor: description: Returns the sensor level. @@ -113,4 +113,4 @@ scan_interval: description: How fast to refresh the switch. required: false type: integer -{% endconfiguration %} \ No newline at end of file +{% endconfiguration %} diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index eca1b4c2691..7bba33402bb 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -14,7 +14,7 @@ ha_category: - Sensor - Switch ha_release: 0.69 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.rainmachine/ - /components/sensor.rainmachine/ diff --git a/source/_components/raspihats.markdown b/source/_components/raspihats.markdown index 08b9a556420..fc266f4975c 100644 --- a/source/_components/raspihats.markdown +++ b/source/_components/raspihats.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor - Switch ha_release: 0.45 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.raspihats/ - /components/switch.raspihats/ @@ -235,4 +235,4 @@ It will output a table like this: 70: -- -- -- -- -- -- -- 77 ``` -For more details about the Raspihats add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/). \ No newline at end of file +For more details about the Raspihats add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/). diff --git a/source/_components/remote.itach.markdown b/source/_components/remote.itach.markdown index 35fcf4e200d..f9fbba040eb 100644 --- a/source/_components/remote.itach.markdown +++ b/source/_components/remote.itach.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: globalcache.png ha_category: Remote -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State ha_release: 0.39 --- diff --git a/source/_components/remote.markdown b/source/_components/remote.markdown index 7359fae9d25..004b1d9feb8 100644 --- a/source/_components/remote.markdown +++ b/source/_components/remote.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_release: "0.34" +ha_release: 0.34 --- Keeps track which remotes are in your environment, their state and allows you to control them. diff --git a/source/_components/remote.xiaomi_miio.markdown b/source/_components/remote.xiaomi_miio.markdown index af8fde86c80..31b3e45d135 100644 --- a/source/_components/remote.xiaomi_miio.markdown +++ b/source/_components/remote.xiaomi_miio.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Remote ha_release: 0.63 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `xiaomi miio` remote platform allows you to send IR commands from your Xiaomi IR Remote (ChuangmiIr). diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown index dd2c1619e7d..19dcf7049cd 100644 --- a/source/_components/rest_command.markdown +++ b/source/_components/rest_command.markdown @@ -10,7 +10,7 @@ footer: true logo: restful.png ha_category: Automation ha_release: 0.36 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- This component can expose regular REST commands as services. Services can be called from a [script] or in [automation]. diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index cf3142803b4..ef23e231d78 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -14,7 +14,7 @@ ha_category: - Camera - Sensor ha_release: 0.42 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.ring/ - /components/camera.ring/ diff --git a/source/_components/roku.markdown b/source/_components/roku.markdown index 906111b3b4d..6caf4c53e8d 100644 --- a/source/_components/roku.markdown +++ b/source/_components/roku.markdown @@ -12,7 +12,7 @@ ha_category: - Hub - Media Player - Remote -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.86 redirect_from: - /components/remote.roku/ @@ -93,4 +93,4 @@ data: - left - left - select -``` \ No newline at end of file +``` diff --git a/source/_components/route53.markdown b/source/_components/route53.markdown index 2324a3c9664..9eb7e2485cb 100644 --- a/source/_components/route53.markdown +++ b/source/_components/route53.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: route53.png ha_category: Network -ha_release: "0.81" +ha_release: 0.81 --- With the `route53` component can you keep your AWS Route53 DNS records up to date. diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown index e282d94a166..3bb34d35080 100644 --- a/source/_components/rpi_gpio.markdown +++ b/source/_components/rpi_gpio.markdown @@ -14,7 +14,7 @@ ha_category: - Cover - Switch ha_release: pre 0.7 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.rpi_gpio/ - /components/cover.rpi_gpio/ diff --git a/source/_components/rpi_pfio.markdown b/source/_components/rpi_pfio.markdown index c7003ef5f4d..451d00b3ff3 100644 --- a/source/_components/rpi_pfio.markdown +++ b/source/_components/rpi_pfio.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY ha_release: 0.45 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `rpi_pfio` component is the base for all related [PiFace Digital I/O (PFIO)](http://www.piface.org.uk/) platforms in Home Assistant. There is no setup needed for the component itself; for the platforms, please check their corresponding pages. diff --git a/source/_components/sabnzbd.markdown b/source/_components/sabnzbd.markdown index 2638b927826..b8a44c5f26f 100644 --- a/source/_components/sabnzbd.markdown +++ b/source/_components/sabnzbd.markdown @@ -12,7 +12,7 @@ ha_category: - Downloading - Sensor ha_release: 0.70 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/sensor.sabnzbd/ --- @@ -104,7 +104,7 @@ sabnzbd: - total_size ``` -This will attempt to access your SABnzbd instance at https://192.168.1.32:9090 and will create sensors named +This will attempt to access your SABnzbd instance at https://192.168.1.32:9090 and will create sensors named `sensor.sab_status`, `sensor.sab_speed`, etc. ## {% linkable_title Services %} diff --git a/source/_components/satel_integra.markdown b/source/_components/satel_integra.markdown index 392c0992818..22e53254346 100644 --- a/source/_components/satel_integra.markdown +++ b/source/_components/satel_integra.markdown @@ -13,7 +13,7 @@ ha_category: - Alarm - Binary Sensor ha_release: 0.54 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/alarm_control_panel.satel_integra/ - /components/binary_sensor.satel_integra/ diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index 95fe53698a7..80789b6a566 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: knx.png ha_category: Scene -ha_release: "0.63" +ha_release: 0.63 --- The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes. diff --git a/source/_components/scene.markdown b/source/_components/scene.markdown index 50863998222..ca1cd569cf9 100644 --- a/source/_components/scene.markdown +++ b/source/_components/scene.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Organization ha_qa_scale: internal +ha_release: 0.15 --- You can create scenes that capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red. diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 2df6e920d93..53ff27c05f5 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Automation ha_qa_scale: internal +ha_release: 0.7 --- The `script` component allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script component will create an entity for each script and allow them to be controlled via services. diff --git a/source/_components/scsgate.markdown b/source/_components/scsgate.markdown index e82fe352024..21d33a67047 100644 --- a/source/_components/scsgate.markdown +++ b/source/_components/scsgate.markdown @@ -14,7 +14,7 @@ ha_category: - Light - Switch ha_release: 0.13 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/cover.scsgate/ - /components/light.scsgate/ @@ -136,4 +136,4 @@ devices: description: A list of devices with their name to use in the frontend. required: true type: list -{% endconfiguration %} \ No newline at end of file +{% endconfiguration %} diff --git a/source/_components/sense.markdown b/source/_components/sense.markdown index c0eddd380a2..ea1f4e3b495 100644 --- a/source/_components/sense.markdown +++ b/source/_components/sense.markdown @@ -12,7 +12,7 @@ ha_category: - Energy - Binary Sensor - Sensor -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.82 redirect_from: - /components/sensor.sense/ diff --git a/source/_components/sensor.aftership.markdown b/source/_components/sensor.aftership.markdown index e3362bedcc8..54d95c76fe5 100644 --- a/source/_components/sensor.aftership.markdown +++ b/source/_components/sensor.aftership.markdown @@ -10,7 +10,7 @@ footer: true logo: aftership.png ha_category: Postal Service ha_release: 0.85 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `aftership` platform allows one to track deliveries by [AfterShip](https://www.aftership.com), a service that supports 490+ couriers worldwide. It is free to use up to 100 tracked packages per month, after that there is a fee. diff --git a/source/_components/sensor.airvisual.markdown b/source/_components/sensor.airvisual.markdown index bd1ce9912ab..b9b5f3ea33c 100644 --- a/source/_components/sensor.airvisual.markdown +++ b/source/_components/sensor.airvisual.markdown @@ -10,14 +10,14 @@ footer: true logo: airvisual.jpg ha_category: Health ha_release: 0.53 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality data. Data can be collected via latitude/longitude or by city/state/country. The resulting information creates sensors for the Air Quality Index (AQI), the human-friendly air quality level, and the main pollutant of that area. Sensors that conform to either/both the [U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366) can be created. This platform requires an AirVisual API key, which can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all). -The Community API key is valid for 12 months after which it will expire. You must then go back to the Airvisual website, delete your old key, create a new one following the same steps and update your configuration with the new key. +The Community API key is valid for 12 months after which it will expire. You must then go back to the Airvisual website, delete your old key, create a new one following the same steps and update your configuration with the new key.

The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes (600 seconds) by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated. diff --git a/source/_components/sensor.alpha_vantage.markdown b/source/_components/sensor.alpha_vantage.markdown index 66795d30e1d..72fbf0746ec 100644 --- a/source/_components/sensor.alpha_vantage.markdown +++ b/source/_components/sensor.alpha_vantage.markdown @@ -9,8 +9,7 @@ sharing: true footer: true logo: alpha_vantage.png ha_category: Finance -ha_iot_class: "Cloud Polling" -featured: false +ha_iot_class: Cloud Polling ha_release: "0.60" --- diff --git a/source/_components/sensor.api_streams.markdown b/source/_components/sensor.api_streams.markdown index ead045f7237..a264c4c41dd 100644 --- a/source/_components/sensor.api_streams.markdown +++ b/source/_components/sensor.api_streams.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_category: Utility ha_release: 0.33 -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_qa_scale: internal redirect_from: /components/sensor.api_stream/ --- diff --git a/source/_components/sensor.arduino.markdown b/source/_components/sensor.arduino.markdown index f7f686370a4..93978e4a3b9 100644 --- a/source/_components/sensor.arduino.markdown +++ b/source/_components/sensor.arduino.markdown @@ -10,11 +10,11 @@ footer: true logo: arduino.png ha_category: DIY ha_release: pre 0.7 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- -The `arduino` sensor platform allows you to get numerical values from an analog input pin of an [Arduino](https://www.arduino.cc/) board. Usually the value is between 0 and 1024. +The `arduino` sensor platform allows you to get numerical values from an analog input pin of an [Arduino](https://www.arduino.cc/) board. Usually the value is between 0 and 1024. To enable an Arduino sensor with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/sensor.arest.markdown b/source/_components/sensor.arest.markdown index b2707483d6a..70b094c33f8 100644 --- a/source/_components/sensor.arest.markdown +++ b/source/_components/sensor.arest.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: arest.png ha_category: DIY -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: pre 0.7 --- @@ -110,7 +110,7 @@ The root will give you a JSON response that contains all variables and their cur } ``` -`return_value` contains the sensor's data in a JSON response for a given pin (eg. http://192.168.1.10/analog/2/ or http://192.168.1.10/digital/7/). +`return_value` contains the sensor's data in a JSON response for a given pin (eg. http://192.168.1.10/analog/2/ or http://192.168.1.10/digital/7/). ```json {"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true} diff --git a/source/_components/sensor.arwn.markdown b/source/_components/sensor.arwn.markdown index 8a9eea544a7..30a8a3264ea 100644 --- a/source/_components/sensor.arwn.markdown +++ b/source/_components/sensor.arwn.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Sensor ha_release: 0.31 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `arwn` sensor platform is a client for the [Ambient Radio Weather Network](http://github.com/sdague/arwn) project. This collects weather station data and makes it available in an MQTT subtree. diff --git a/source/_components/sensor.awair.markdown b/source/_components/sensor.awair.markdown index 7b7e358f7d3..f3b92634aea 100644 --- a/source/_components/sensor.awair.markdown +++ b/source/_components/sensor.awair.markdown @@ -10,7 +10,7 @@ footer: true logo: awair.jpg ha_category: Health ha_release: 0.84 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `awair` sensor platform will fetch data from your [Awair device(s)](https://getawair.com). diff --git a/source/_components/sensor.bbox.markdown b/source/_components/sensor.bbox.markdown index 3f456901862..fee382f6457 100644 --- a/source/_components/sensor.bbox.markdown +++ b/source/_components/sensor.bbox.markdown @@ -10,7 +10,7 @@ footer: true logo: bbox.png ha_category: Network ha_release: 0.31 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- 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. diff --git a/source/_components/sensor.bh1750.markdown b/source/_components/sensor.bh1750.markdown index 1da1ae5eba3..305e253e76c 100644 --- a/source/_components/sensor.bh1750.markdown +++ b/source/_components/sensor.bh1750.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY ha_release: 0.48 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- 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. diff --git a/source/_components/sensor.bitcoin.markdown b/source/_components/sensor.bitcoin.markdown index dadf5ed96ad..34f2400ce42 100644 --- a/source/_components/sensor.bitcoin.markdown +++ b/source/_components/sensor.bitcoin.markdown @@ -10,7 +10,7 @@ footer: true logo: bitcoin.png ha_category: Finance ha_release: pre 0.7 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- diff --git a/source/_components/sensor.blockchain.markdown b/source/_components/sensor.blockchain.markdown index 8c441ff88b7..421aa88e939 100644 --- a/source/_components/sensor.blockchain.markdown +++ b/source/_components/sensor.blockchain.markdown @@ -10,7 +10,7 @@ footer: true logo: blockchain.png ha_category: Finance ha_release: 0.47 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- diff --git a/source/_components/sensor.bme280.markdown b/source/_components/sensor.bme280.markdown index 59612eb46d1..ea1de3c6cc1 100644 --- a/source/_components/sensor.bme280.markdown +++ b/source/_components/sensor.bme280.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY ha_release: 0.48 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. diff --git a/source/_components/sensor.bme680.markdown b/source/_components/sensor.bme680.markdown index 7ae238d268e..083311f9990 100644 --- a/source/_components/sensor.bme680.markdown +++ b/source/_components/sensor.bme680.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY ha_release: 0.62 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf) connected via an [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement. @@ -35,20 +35,20 @@ name: required: false default: BME680 Sensor type: string -i2c_bus: - description: I2C bus that the sensor is connected to. +i2c_bus: + description: I2C bus that the sensor is connected to. required: false default: 1 type: integer i2c_address: - description: I2C address of the sensor. It is 0x76 or 0x77. + description: I2C address of the sensor. It is 0x76 or 0x77. required: false default: 0x77 type: integer monitored_conditions: description: Conditions to monitor. required: false - default: + default: - temperature - humidity - pressure @@ -81,7 +81,7 @@ oversampling_humidity: default: 4 type: integer filter_size: - description: IIR filter size as described in the sensor datasheet. Can be 0 (off), 1, 3, 7, 15, 31, 63 or 127. + description: IIR filter size as described in the sensor datasheet. Can be 0 (off), 1, 3, 7, 15, 31, 63 or 127. required: false default: 3 type: integer @@ -96,17 +96,17 @@ gas_heater_duration: default: 150 type: integer aq_burn_in_time: - description: The duration to perform gas resistance measurements to establish a stable baseline measurements for Air Quality calculations in seconds. The burn in time is only performed when the sensor component is first initialized. + description: The duration to perform gas resistance measurements to establish a stable baseline measurements for Air Quality calculations in seconds. The burn in time is only performed when the sensor component is first initialized. required: false default: 300 type: integer aq_humidity_baseline: - description: The baseline *ideal* relative humidity value for the air quality calculations. + description: The baseline *ideal* relative humidity value for the air quality calculations. required: false default: 40 type: integer aq_humidity_bias: - description: The bias for humidity to the gas resistance measurement in the air quality calculations expressed as a percentage of the total calculation e.g., 25% humidity to 75% gas. + description: The bias for humidity to the gas resistance measurement in the air quality calculations expressed as a percentage of the total calculation e.g., 25% humidity to 75% gas. required: false default: 25 type: integer diff --git a/source/_components/sensor.bom.markdown b/source/_components/sensor.bom.markdown index b5dd07a02c8..81dc6991e7b 100644 --- a/source/_components/sensor.bom.markdown +++ b/source/_components/sensor.bom.markdown @@ -10,7 +10,7 @@ footer: true logo: bom.png ha_category: Weather ha_release: 0.29 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `bom` sensor platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data. @@ -113,9 +113,9 @@ monitored_conditions: description: Relative Humidity in %. sea_state: description: Sea state. - swell_dir_worded: + swell_dir_worded: description: Swell direction. - swell_height: + swell_height: description: Swell height in m. swell_period: description: Swell period. diff --git a/source/_components/sensor.broadlink.markdown b/source/_components/sensor.broadlink.markdown index 2b8e534ef30..94f766ebab5 100644 --- a/source/_components/sensor.broadlink.markdown +++ b/source/_components/sensor.broadlink.markdown @@ -10,7 +10,7 @@ footer: true logo: broadlink.png ha_category: Sensor ha_release: 0.35 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/sensor.brottsplatskartan.markdown b/source/_components/sensor.brottsplatskartan.markdown index 1ac65a3e481..14cd7290490 100644 --- a/source/_components/sensor.brottsplatskartan.markdown +++ b/source/_components/sensor.brottsplatskartan.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Social logo: brottsplatskartan.png ha_release: 0.85 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `brottsplatskartan` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Brottsplatskartan](https://brottsplatskartan.se). The sensor only counts incidents from the current day. diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index d7eaf0a6c69..e6c19423742 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -10,10 +10,10 @@ footer: true logo: buienradar.png ha_category: Weather ha_release: 0.47 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- -The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands. The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). +The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands. The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). The selected weather station will provide all weather data, with the exception of the forecasted precipitation. The forecasted precipitation data will be retrieved from buienradar using your actual gps-location (and not the location of the nearest weather station). diff --git a/source/_components/sensor.cert_expiry.markdown b/source/_components/sensor.cert_expiry.markdown index f65dc2acdd1..8519b3bcb72 100644 --- a/source/_components/sensor.cert_expiry.markdown +++ b/source/_components/sensor.cert_expiry.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_category: Network ha_release: 0.44 -ha_iot_class: "depends" +ha_iot_class: Configurable --- The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days. diff --git a/source/_components/sensor.co2signal.markdown b/source/_components/sensor.co2signal.markdown index c8d268db87c..2e74d5d083d 100644 --- a/source/_components/sensor.co2signal.markdown +++ b/source/_components/sensor.co2signal.markdown @@ -10,7 +10,7 @@ footer: true logo: co2signal.png ha_category: Environment ha_release: 0.87 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `co2signal` sensor platform queries the [CO2Signal](https://www.co2signal.com/) API for the CO2 intensity of a specific region. Data can be collected via latitude/longitude or by country code. This API uses the same data as https://www.electricitymap.org/. Not all countries/regions in the world are supported so please consult this website to check local availability. diff --git a/source/_components/sensor.coinmarketcap.markdown b/source/_components/sensor.coinmarketcap.markdown index a004c2c4240..131e9b5686e 100644 --- a/source/_components/sensor.coinmarketcap.markdown +++ b/source/_components/sensor.coinmarketcap.markdown @@ -10,7 +10,7 @@ footer: true logo: coinmarketcap.png ha_category: Finance ha_release: 0.28 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- diff --git a/source/_components/sensor.comed_hourly_pricing.markdown b/source/_components/sensor.comed_hourly_pricing.markdown index 4622d6b710f..34fb7dbf43d 100644 --- a/source/_components/sensor.comed_hourly_pricing.markdown +++ b/source/_components/sensor.comed_hourly_pricing.markdown @@ -10,7 +10,7 @@ footer: true logo: comed.png ha_category: Energy ha_release: "0.40" -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The ComEd Hourly Pricing program is an optional program available to ComEd electric subscribers which charges customers a variable rate for electricity supply based on current demand rather than a traditional fixed rate. Live prices are published [here](https://hourlypricing.comed.com/live-prices/) and also via an [API](https://hourlypricing.comed.com/hp-api/) which we can integrate as a sensor in Home Assistant. diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index 9e03ee8eae0..c18ed199c6c 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -10,7 +10,7 @@ footer: true logo: command_line.png ha_category: Utility ha_release: pre 0.7 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- @@ -32,7 +32,7 @@ command: description: The action to take to get the value. required: true type: string -name: +name: description: Name of the command sensor. required: false type: string @@ -40,7 +40,7 @@ unit_of_measurement: description: Defines the unit of measurement of the sensor, if any. required: false type: string -value_template: +value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." required: false type: string diff --git a/source/_components/sensor.cpuspeed.markdown b/source/_components/sensor.cpuspeed.markdown index f2e8a1596a5..fbff6484559 100644 --- a/source/_components/sensor.cpuspeed.markdown +++ b/source/_components/sensor.cpuspeed.markdown @@ -10,7 +10,7 @@ footer: true logo: cpu.png ha_category: System Monitor ha_release: pre 0.7 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- diff --git a/source/_components/sensor.crimereports.markdown b/source/_components/sensor.crimereports.markdown index d447005c33b..9facbec11f8 100644 --- a/source/_components/sensor.crimereports.markdown +++ b/source/_components/sensor.crimereports.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Social logo: crimereports.png ha_release: 0.42 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day. @@ -31,23 +31,23 @@ name: description: Custom name for the sensor. required: true type: string -radius: +radius: description: Radius in meters required: true type: float -latitude: +latitude: description: Latitude for sensor. required: false default: Your home zone latitude defined in your configuration. -longitude: +longitude: description: Longitude for sensor. required: false default: Your home zone longitude defined in your configuration. -include: +include: description: List of incident types to include. See below for a list of valid incidents. required: false type: list -exclude: +exclude: description: List of incident types to exclude. See below for a list of valid incidents. required: false type: list diff --git a/source/_components/sensor.cups.markdown b/source/_components/sensor.cups.markdown index 86966e192b6..7d69c395cbf 100644 --- a/source/_components/sensor.cups.markdown +++ b/source/_components/sensor.cups.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: cups.png ha_category: System Monitor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.32 --- diff --git a/source/_components/sensor.currencylayer.markdown b/source/_components/sensor.currencylayer.markdown index 2c59a2a8b9b..0b5d49d047f 100644 --- a/source/_components/sensor.currencylayer.markdown +++ b/source/_components/sensor.currencylayer.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Finance logo: currencylayer.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.32 --- diff --git a/source/_components/sensor.darksky.markdown b/source/_components/sensor.darksky.markdown index 71f7d10f668..16d4b160ff5 100644 --- a/source/_components/sensor.darksky.markdown +++ b/source/_components/sensor.darksky.markdown @@ -9,10 +9,9 @@ sharing: true footer: true logo: dark_sky.png ha_category: Weather -featured: false ha_release: "0.30" redirect_from: /components/sensor.forecast/ -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. The location is based on the `longitude` and `latitude` coordinates configured in your `configuration.yaml` file. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by Dark Sky, you can refine them down to your exact home address. GPS coordinates can be found by using [Google Maps](https://www.google.com/maps) and clicking on your home or [Openstreetmap](http://www.openstreetmap.org/). diff --git a/source/_components/sensor.deluge.markdown b/source/_components/sensor.deluge.markdown index e82d6a264e6..0d3e16ace1d 100644 --- a/source/_components/sensor.deluge.markdown +++ b/source/_components/sensor.deluge.markdown @@ -10,7 +10,7 @@ footer: true logo: deluge.png ha_category: Downloading ha_release: 0.57 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/sensor.deutsche_bahn.markdown b/source/_components/sensor.deutsche_bahn.markdown index fdba0b5e711..b7ec3b06bbe 100644 --- a/source/_components/sensor.deutsche_bahn.markdown +++ b/source/_components/sensor.deutsche_bahn.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Transport logo: db.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.14 --- diff --git a/source/_components/sensor.dht.markdown b/source/_components/sensor.dht.markdown index 7766643d8b8..5a0ab8d460c 100644 --- a/source/_components/sensor.dht.markdown +++ b/source/_components/sensor.dht.markdown @@ -10,7 +10,7 @@ footer: true ha_category: DIY ha_release: 0.7 logo: dht.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- diff --git a/source/_components/sensor.discogs.markdown b/source/_components/sensor.discogs.markdown index 9fa6012fe73..ebb30e243e5 100644 --- a/source/_components/sensor.discogs.markdown +++ b/source/_components/sensor.discogs.markdown @@ -7,11 +7,10 @@ sidebar: true comments: false sharing: true footer: true -logo: https://www.magneticmag.com/.image/t_share/MTQ5OTE1NzU4NTczMzk3OTYw/discogs-vinyl-record-mark.png ha_category: Multimedia ha_release: 0.61 logo: discogs.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection. diff --git a/source/_components/sensor.dnsip.markdown b/source/_components/sensor.dnsip.markdown index 7783504930d..a19aa29852c 100644 --- a/source/_components/sensor.dnsip.markdown +++ b/source/_components/sensor.dnsip.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Network -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: "0.40" --- diff --git a/source/_components/sensor.dsmr.markdown b/source/_components/sensor.dsmr.markdown index cc943d821b2..7a6f9eedd6c 100644 --- a/source/_components/sensor.dsmr.markdown +++ b/source/_components/sensor.dsmr.markdown @@ -10,7 +10,7 @@ footer: true logo: netbeheernederland.jpg ha_category: Energy ha_release: 0.34 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- A sensor platform for Dutch Smart Meters which comply to DSMR (Dutch Smart Meter Requirements), also known as 'Slimme meter' or 'P1 poort'. diff --git a/source/_components/sensor.dte_energy_bridge.markdown b/source/_components/sensor.dte_energy_bridge.markdown index 66428e62e25..d04953746b5 100644 --- a/source/_components/sensor.dte_energy_bridge.markdown +++ b/source/_components/sensor.dte_energy_bridge.markdown @@ -10,7 +10,7 @@ footer: true logo: dte_energy.png ha_category: Energy ha_release: 0.21 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- A sensor platform for the [DTE](https://www.dteenergy.com/) Energy Bridge. To find out which version of the DTE Energy Bridge sensor you have, find the status LED on your box. @@ -41,4 +41,4 @@ version: required: false type: string default: 1 -{% endconfiguration %} \ No newline at end of file +{% endconfiguration %} diff --git a/source/_components/sensor.dublin_bus_transport.markdown b/source/_components/sensor.dublin_bus_transport.markdown index f980877ba11..aec61aebcae 100644 --- a/source/_components/sensor.dublin_bus_transport.markdown +++ b/source/_components/sensor.dublin_bus_transport.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: dublin_bus.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.36 --- diff --git a/source/_components/sensor.duke_energy.markdown b/source/_components/sensor.duke_energy.markdown index 2e120441b3d..4abf903c146 100644 --- a/source/_components/sensor.duke_energy.markdown +++ b/source/_components/sensor.duke_energy.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: duke_energy.png ha_category: Energy -ha_release: "0.74" -ha_iot_class: "Cloud Polling" +ha_release: 0.74 +ha_iot_class: Cloud Polling --- The `duke_energy` sensor platform allows you get the previous days usage for all of your Duke Energy smart meters. diff --git a/source/_components/sensor.dwd_weather_warnings.markdown b/source/_components/sensor.dwd_weather_warnings.markdown index 2b24add44e3..218622e746e 100644 --- a/source/_components/sensor.dwd_weather_warnings.markdown +++ b/source/_components/sensor.dwd_weather_warnings.markdown @@ -10,7 +10,7 @@ footer: true #logo: dwdwarnapp.png ha_category: Weather ha_release: 0.51 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `dwd_weather_warnings` sensor platform uses the [Deutsche Wetter Dienst (DWD)](https://www.dwd.de) as a source for current and advance warnings. diff --git a/source/_components/sensor.dweet.markdown b/source/_components/sensor.dweet.markdown index 971c4e734bb..179e535e916 100644 --- a/source/_components/sensor.dweet.markdown +++ b/source/_components/sensor.dweet.markdown @@ -10,7 +10,7 @@ footer: true logo: dweet.png ha_category: Sensor ha_release: "0.10" -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/). diff --git a/source/_components/sensor.ebox.markdown b/source/_components/sensor.ebox.markdown index cbdad34af61..7442ec73623 100644 --- a/source/_components/sensor.ebox.markdown +++ b/source/_components/sensor.ebox.markdown @@ -10,7 +10,7 @@ footer: true logo: ebox.png ha_category: Network ha_release: 0.39 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant. diff --git a/source/_components/sensor.eddystone_temperature.markdown b/source/_components/sensor.eddystone_temperature.markdown index 68fd13503c7..ca8076bacc2 100644 --- a/source/_components/sensor.eddystone_temperature.markdown +++ b/source/_components/sensor.eddystone_temperature.markdown @@ -10,7 +10,7 @@ footer: true logo: eddystone.png ha_category: DIY ha_release: 0.42 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `eddystone_temperature` sensor platform reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature). diff --git a/source/_components/sensor.efergy.markdown b/source/_components/sensor.efergy.markdown index 3291644614e..1baa39015da 100644 --- a/source/_components/sensor.efergy.markdown +++ b/source/_components/sensor.efergy.markdown @@ -10,7 +10,7 @@ footer: true logo: efergy.png ha_category: Energy ha_release: pre 0.7 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- Integrate your [Efergy](https://efergy.com) meter information into Home Assistant. diff --git a/source/_components/sensor.eliqonline.markdown b/source/_components/sensor.eliqonline.markdown index 81f64598802..f568d61ea28 100644 --- a/source/_components/sensor.eliqonline.markdown +++ b/source/_components/sensor.eliqonline.markdown @@ -10,7 +10,7 @@ footer: true logo: eliq.png ha_category: Energy ha_release: "0.10" -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- Integrate your [ELIQ Online](http://eliq.io) smart meter information into Home Assistant. To get an [access token](https://my.eliq.io/user/settings/api) and the [Channel ID](https://my.eliq.io/user/settings/locations), log in to your account. diff --git a/source/_components/sensor.emoncms.markdown b/source/_components/sensor.emoncms.markdown index a15c5081990..a73892e9d90 100644 --- a/source/_components/sensor.emoncms.markdown +++ b/source/_components/sensor.emoncms.markdown @@ -10,7 +10,7 @@ sharing: true footer: true ha_category: Sensor ha_release: 0.29 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- @@ -66,7 +66,7 @@ sensor: - 105 ``` -Display all feeds except feeds with their feed id specified in `exclude_feed_id`. +Display all feeds except feeds with their feed id specified in `exclude_feed_id`. ```yaml # Example configuration.yaml entry @@ -75,7 +75,7 @@ sensor: api_key: API_KEY url: https://emoncms.org id: 1 - unit_of_measurement: "KWH" + unit_of_measurement: "KWH" exclude_feed_id: - 107 - 105 @@ -90,7 +90,7 @@ sensor: api_key: API_KEY url: https://emoncms.org id: 1 - unit_of_measurement: "KW" + unit_of_measurement: "KW" include_only_feed_id: - 5 - 120 @@ -127,7 +127,7 @@ sensor: url: https://emoncms.org scan_interval: 30 id: 1 - unit_of_measurement: "W" + unit_of_measurement: "W" include_only_feed_id: - 107 - 106 @@ -136,7 +136,7 @@ sensor: url: https://emoncms.org id: 2 scan_interval: 60 - unit_of_measurement: "A" + unit_of_measurement: "A" include_only_feed_id: - 108 - 61 diff --git a/source/_components/sensor.enphase_envoy.markdown b/source/_components/sensor.enphase_envoy.markdown index 13c1b5924b3..51c5d7801c1 100644 --- a/source/_components/sensor.enphase_envoy.markdown +++ b/source/_components/sensor.enphase_envoy.markdown @@ -10,10 +10,10 @@ footer: true logo: enphase-logo.svg ha_category: Energy ha_release: 0.76 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- -A sensor platform for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy) solar energy gateway. Works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). +A sensor platform for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy) solar energy gateway. Works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). ### {% linkable_title Configuration %} diff --git a/source/_components/sensor.entur_public_transport.markdown b/source/_components/sensor.entur_public_transport.markdown index 1e9477fc773..e7995882bc2 100644 --- a/source/_components/sensor.entur_public_transport.markdown +++ b/source/_components/sensor.entur_public_transport.markdown @@ -10,16 +10,16 @@ footer: true logo: entur.svg ha_category: Transport ha_release: 0.84 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- -The `entur_public_transport` sensor gives real-time departure information for the next two departures from any bus stop, car ferry quay, train station, airport and person ferries quay in Norway. +The `entur_public_transport` sensor gives real-time departure information for the next two departures from any bus stop, car ferry quay, train station, airport and person ferries quay in Norway. -For each stop place given in the configuration, a sensor will be mounted for that stop place. It will give remaining minutes until the nearest departure in the state, but also next departure in the attributes. Information about if the departure is monitored in real-time or is from scheduled times, and how many minutes there is in delays, are included as well. +For each stop place given in the configuration, a sensor will be mounted for that stop place. It will give remaining minutes until the nearest departure in the state, but also next departure in the attributes. Information about if the departure is monitored in real-time or is from scheduled times, and how many minutes there is in delays, are included as well. -Real-time data is fetched from [Entur](https://www.entur.org). Entur is a service which collects and delivers information about all public transport available in Norway under an [open source license](https://data.norge.no/nlod/no). +Real-time data is fetched from [Entur](https://www.entur.org). Entur is a service which collects and delivers information about all public transport available in Norway under an [open source license](https://data.norge.no/nlod/no). -

Note that the underlying API is rate limited and to avoid getting your instance blocked from entur the sensor is only fetching new information once a minute. It's recommended to only define one platform in the configuration at one time to not hit the rate limiting. +

Note that the underlying API is rate limited and to avoid getting your instance blocked from entur the sensor is only fetching new information once a minute. It's recommended to only define one platform in the configuration at one time to not hit the rate limiting.

## {% linkable_title Configuration %} @@ -39,22 +39,22 @@ stop_ids: required: true type: list name: - description: Override parts of the sensor name. + description: Override parts of the sensor name. required: false type: string default: Entur expand_platforms: - description: If additional sensors should be created for each platform under a stop place. + description: If additional sensors should be created for each platform under a stop place. required: false type: boolean default: true show_on_map: - description: If platform locations should be added to the sensor, and the map. + description: If platform locations should be added to the sensor, and the map. required: false type: boolean default: false -line_whitelist: - description: List of lines that should be whitelisted in the resulting sensors, and will only show when the defined lines are expected to leave the platform or station. All lines that you want on any of the sensors should be included in the list. +line_whitelist: + description: List of lines that should be whitelisted in the resulting sensors, and will only show when the defined lines are expected to leave the platform or station. All lines that you want on any of the sensors should be included in the list. required: false type: list {% endconfiguration %} @@ -74,8 +74,8 @@ sensor: - 'NSR:StopPlace:548' # Bergen train station - 'NSR:StopPlace:737' # Trondheim airport - 'NSR:StopPlace:5850' # Grorud T bus stop - - 'NSR:StopPlace:58652' # Mortavika ferry - - 'NSR:StopPlace:27639' # Sør-Hidle quay + - 'NSR:StopPlace:58652' # Mortavika ferry + - 'NSR:StopPlace:27639' # Sør-Hidle quay - 'NSR:Quay:48550' # Fiskepiren bus stop platform 1 ``` @@ -97,28 +97,28 @@ sensor: ## {% linkable_title Obtaining a stop id %} -[Entur's travel planer](https://en-tur.no) has a map of all stops used in Norway. Use the map to find the stops you're interested in. When you have found one of your stops, click on it. +[Entur's travel planer](https://en-tur.no) has a map of all stops used in Norway. Use the map to find the stops you're interested in. When you have found one of your stops, click on it. -Now the web browser should contain an URL with the id in it. Such as this: +Now the web browser should contain an URL with the id in it. Such as this: `https://en-tur.no/nearby-stop-place-detail?id=NSR:StopPlace:32376` -The stop id is the content after `id=` parameter in the url. Copy paste this into the configuration. +The stop id is the content after `id=` parameter in the url. Copy paste this into the configuration. ## {% linkable_title FAQ - Troubleshooting %} **Q:** I have multiple stop ids and have added whitelisting of a line. Now some of the stop places are showing `unknown`. -**A:** A whitelisting of lines takes affect on all of the stops. So you have to whitelist all lines you are interested in on all stop places. +**A:** A whitelisting of lines takes affect on all of the stops. So you have to whitelist all lines you are interested in on all stop places. --- -**Q:** I have added whitelisting of lines, and everything has worked as fine before, but now it has stopped updating all of a sudden. +**Q:** I have added whitelisting of lines, and everything has worked as fine before, but now it has stopped updating all of a sudden. **A:** Some transport companies, such as Kolumbus in Rogaland, have running numbers on the end of their line ids. These gets periodically updated and will make the whitelisting invalid. The new line ids needs to be added again. Most of the time it iterates by one. ---- +--- **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). \ No newline at end of file +**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). diff --git a/source/_components/sensor.envirophat.markdown b/source/_components/sensor.envirophat.markdown index 931eab001b1..aa86d11b73c 100644 --- a/source/_components/sensor.envirophat.markdown +++ b/source/_components/sensor.envirophat.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: raspberry-pi.png ha_category: DIY -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.44 --- @@ -121,7 +121,7 @@ Add something like the following to your [customize section](/docs/configuration sensor.pressure: icon: mdi:weight friendly_name: "Pressure" -``` +``` ### Create groups diff --git a/source/_components/sensor.etherscan.markdown b/source/_components/sensor.etherscan.markdown index 785ed42492a..3273b18ddb0 100644 --- a/source/_components/sensor.etherscan.markdown +++ b/source/_components/sensor.etherscan.markdown @@ -10,7 +10,7 @@ footer: true logo: etherscan.png ha_category: Finance ha_release: 0.47 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `Etherscan` sensor platform displays Ether and ERC-20 token balances from [Etherscan.io](https://etherscan.io). diff --git a/source/_components/sensor.fail2ban.markdown b/source/_components/sensor.fail2ban.markdown index fd0f239026d..ccef1ea8c14 100644 --- a/source/_components/sensor.fail2ban.markdown +++ b/source/_components/sensor.fail2ban.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Network -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling logo: fail2ban.png ha_release: 0.57 --- diff --git a/source/_components/sensor.fedex.markdown b/source/_components/sensor.fedex.markdown index d19e870756f..81ba91479cc 100644 --- a/source/_components/sensor.fedex.markdown +++ b/source/_components/sensor.fedex.markdown @@ -10,7 +10,7 @@ footer: true logo: fedex.png ha_category: Postal Service ha_release: 0.39 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `fedex` platform allows one to track deliveries by [FedEx](http://www.fedex.com/). To use this sensor, you need a [FedEx Delivery Manager](https://www.fedex.com/us/delivery/) account. diff --git a/source/_components/sensor.fido.markdown b/source/_components/sensor.fido.markdown index 62c55385344..dd45d2aa1ed 100644 --- a/source/_components/sensor.fido.markdown +++ b/source/_components/sensor.fido.markdown @@ -10,7 +10,7 @@ footer: true logo: fido.png ha_category: Network ha_release: 0.39 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant. diff --git a/source/_components/sensor.file.markdown b/source/_components/sensor.file.markdown index 7e426c5d979..aafb3aa203b 100644 --- a/source/_components/sensor.file.markdown +++ b/source/_components/sensor.file.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: file.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.45 --- diff --git a/source/_components/sensor.filesize.markdown b/source/_components/sensor.filesize.markdown index c52057294ee..25aad48d110 100644 --- a/source/_components/sensor.filesize.markdown +++ b/source/_components/sensor.filesize.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: file.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.64 --- diff --git a/source/_components/sensor.filter.markdown b/source/_components/sensor.filter.markdown index e916082f782..600cbf7fcb7 100644 --- a/source/_components/sensor.filter.markdown +++ b/source/_components/sensor.filter.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Utility ha_release: 0.65 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- @@ -66,7 +66,7 @@ name: type: string filters: description: Filters to be used. - required: true + required: true type: list keys: filter: @@ -77,18 +77,18 @@ filters: description: Size of the window of previous states. Time based filters such as `time_simple_moving_average` will require a time period (size in time), while other filters such as `outlier` will require an integer (size in number of states) required: false type: [int, time] - default: 1 + default: 1 precision: description: See [_lowpass_](#low-pass) filter. Defines the precision of the filtered state, through the argument of round(). required: false type: integer default: None - time_constant: + time_constant: description: See [_lowpass_](#low-pass) filter. Loosely relates to the amount of time it takes for a state to influence the output. required: false type: integer default: 10 - radius: + radius: description: See [_outlier_](#outlier) filter. Band radius from median of previous states. required: false type: float @@ -98,12 +98,12 @@ filters: required: false type: string default: last - lower_bound: + lower_bound: description: See [_range_](#range) filter. Lower bound for filter range. required: false type: float default: negative infinity - upper_bound: + upper_bound: description: See [_range_](#range) filter. Upper bound for filter range. required: false type: float @@ -130,7 +130,7 @@ The returned value is rounded to the number of decimals defined in (`precision`) The Outlier filter (`outlier`) is a basic Band-pass filter, as it cuts out any value outside a specific range. -The included Outlier filter will discard any value beyond a band centered on the median of the previous values, replacing it with the median value of the previous values. If inside the band, the +The included Outlier filter will discard any value beyond a band centered on the median of the previous values, replacing it with the median value of the previous values. If inside the band, the ```python distance = abs(state - median(previous_states)) @@ -147,7 +147,7 @@ The Throttle filter (`throttle`) will only update the state of the sensor for th To adjust the rate you need to set the window_size. To throttle a sensor down to 10%, the `window_size` should be set to 10, for 50% should be set to 2. -This filter is relevant when you have a sensor which produces states at a very high-rate, which you might want to throttle down for storing or visualization purposes. +This filter is relevant when you have a sensor which produces states at a very high-rate, which you might want to throttle down for storing or visualization purposes. ### {% linkable_title Time Throttle %} @@ -155,11 +155,11 @@ The Time Throttle filter (`time_throttle`) will only update the state of the sen To adjust the rate you need to set the window_size. To throttle a sensor down to 1 value per minute, the `window_size` should be set to 00:01. -This filter is relevant when you have a sensor which produces states at a very high inconstant rate, which you might want to throttle down to some constant rate for storing or visualization purposes. +This filter is relevant when you have a sensor which produces states at a very high inconstant rate, which you might want to throttle down to some constant rate for storing or visualization purposes. ### {% linkable_title Time Simple Moving Average %} -The Time SMA filter (`time_simple_moving_average`) is based on the paper [Algorithms for Unevenly Spaced Time Series: Moving Averages and Other Rolling Operators](http://www.eckner.com/papers/Algorithms%20for%20Unevenly%20Spaced%20Time%20Series.pdf) by Andreas Eckner. +The Time SMA filter (`time_simple_moving_average`) is based on the paper [Algorithms for Unevenly Spaced Time Series: Moving Averages and Other Rolling Operators](http://www.eckner.com/papers/Algorithms%20for%20Unevenly%20Spaced%20Time%20Series.pdf) by Andreas Eckner. The paper defines three types/versions of the Simple Moving Average (SMA): *last*, *next* and *linear*. Currently only *last* is implemented. diff --git a/source/_components/sensor.fints.markdown b/source/_components/sensor.fints.markdown index 986e84e7c79..52a6cbe6b41 100644 --- a/source/_components/sensor.fints.markdown +++ b/source/_components/sensor.fints.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Finance ha_release: "0.70" -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline. @@ -37,11 +37,11 @@ name: description: Name of the bank. required: false type: string -bank_identification_number: +bank_identification_number: description: Bank identification number, in most cases the "Bankleitzahl". required: true type: string -username: +username: description: Your FinTS username. required: true type: string @@ -49,15 +49,15 @@ pin: description: Your FinTS PIN or password. required: true type: string -url: +url: description: URL of your bank's FinTS server. required: true type: string accounts: - description: The balance accounts to show. If not set then all accounts will show up. + description: The balance accounts to show. If not set then all accounts will show up. required: false type: list - keys: + keys: account: description: The IBAN of the blance account. required: true @@ -70,7 +70,7 @@ holdings: description: The holding accounts of your bank. If not set then all accounts will show up. required: false type: list - keys: + keys: account: description: The classic account number. required: true @@ -78,5 +78,5 @@ holdings: name: description: Use this field to give the account a meaningful name. required: false - type: string + type: string {% endconfiguration %} diff --git a/source/_components/sensor.fitbit.markdown b/source/_components/sensor.fitbit.markdown index a2dbd4e2fdf..83fcf9dd273 100644 --- a/source/_components/sensor.fitbit.markdown +++ b/source/_components/sensor.fitbit.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: fitbit.png ha_category: Health -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.19 --- diff --git a/source/_components/sensor.fixer.markdown b/source/_components/sensor.fixer.markdown index 6bb80331e0a..b7039cfc331 100644 --- a/source/_components/sensor.fixer.markdown +++ b/source/_components/sensor.fixer.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Finance logo: fixer-io.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.23 --- diff --git a/source/_components/sensor.flunearyou.markdown b/source/_components/sensor.flunearyou.markdown index f7e85a46f54..7fa4aa1eab4 100644 --- a/source/_components/sensor.flunearyou.markdown +++ b/source/_components/sensor.flunearyou.markdown @@ -10,7 +10,7 @@ footer: true logo: flunearyou.png ha_category: Health ha_release: 0.83 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `flunearyou` sensor platform allows users in the United States and its diff --git a/source/_components/sensor.folder.markdown b/source/_components/sensor.folder.markdown index 878d8e45a0c..e71e5527785 100644 --- a/source/_components/sensor.folder.markdown +++ b/source/_components/sensor.folder.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: file.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.64 --- diff --git a/source/_components/sensor.foobot.markdown b/source/_components/sensor.foobot.markdown index cf300fa7ac1..fc0d0133879 100644 --- a/source/_components/sensor.foobot.markdown +++ b/source/_components/sensor.foobot.markdown @@ -10,7 +10,7 @@ footer: true logo: foobot.png ha_category: Health ha_release: 0.66 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `foobot` sensor platform will fetch air quality data from your or yours [Foobot device(s)](https://foobot.io/features/). diff --git a/source/_components/sensor.fritzbox_callmonitor.markdown b/source/_components/sensor.fritzbox_callmonitor.markdown index 867ed606016..95eaadf9424 100644 --- a/source/_components/sensor.fritzbox_callmonitor.markdown +++ b/source/_components/sensor.fritzbox_callmonitor.markdown @@ -10,7 +10,7 @@ footer: true logo: avm.png ha_category: System Monitor ha_release: 0.27 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes. @@ -26,7 +26,7 @@ $ sudo apt-get install libxml2-dev libxslt-dev \ python3-setuptools zlib1g-dev build-essential ``` -If you installed Home Assistant in a virtualenv, also run the following command inside it. +If you installed Home Assistant in a virtualenv, also run the following command inside it. Be patient this will take a while. ```bash pip3 install lxml diff --git a/source/_components/sensor.fritzbox_netmonitor.markdown b/source/_components/sensor.fritzbox_netmonitor.markdown index d00beddd060..b7053a4e929 100644 --- a/source/_components/sensor.fritzbox_netmonitor.markdown +++ b/source/_components/sensor.fritzbox_netmonitor.markdown @@ -10,7 +10,7 @@ footer: true logo: avm.png ha_category: System Monitor ha_release: 0.36 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `fritzbox_netmonitor` sensor monitors the network statistics exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers. diff --git a/source/_components/sensor.gearbest.markdown b/source/_components/sensor.gearbest.markdown index 069d942e84b..89460af2838 100644 --- a/source/_components/sensor.gearbest.markdown +++ b/source/_components/sensor.gearbest.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: gearbest.png ha_category: Sensor -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: "0.60" --- diff --git a/source/_components/sensor.geizhals.markdown b/source/_components/sensor.geizhals.markdown index c7a568530bf..f394f4c157d 100644 --- a/source/_components/sensor.geizhals.markdown +++ b/source/_components/sensor.geizhals.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: geizhals.png ha_category: Sensor -ha_iot_class: "Cloud Polling" -ha_release: "0.51" +ha_iot_class: Cloud Polling +ha_release: 0.51 --- The `geizhals` sensor will give you the best price of a product from [Geizhals](https://geizhals.de) or related site. With this information can be used in e.g., automations to notify you when a price drops. diff --git a/source/_components/sensor.geo_rss_events.markdown b/source/_components/sensor.geo_rss_events.markdown index bd1d773b0d7..03fc1733011 100644 --- a/source/_components/sensor.geo_rss_events.markdown +++ b/source/_components/sensor.geo_rss_events.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: rss.png ha_category: Sensor -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.55 --- diff --git a/source/_components/sensor.github.markdown b/source/_components/sensor.github.markdown index 2d4ddba2e0b..465539d17cd 100644 --- a/source/_components/sensor.github.markdown +++ b/source/_components/sensor.github.markdown @@ -10,7 +10,7 @@ footer: true logo: github.png ha_category: Sensor ha_release: 0.88 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The GitHub sensor integrates data from [GitHub](https://github.com/) to monitor your favorite repositories. diff --git a/source/_components/sensor.gitlab_ci.markdown b/source/_components/sensor.gitlab_ci.markdown index 82f3c16887d..56b6e9f64ba 100644 --- a/source/_components/sensor.gitlab_ci.markdown +++ b/source/_components/sensor.gitlab_ci.markdown @@ -10,7 +10,7 @@ footer: true logo: gitlab.png ha_category: Sensor ha_release: 0.80 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/). diff --git a/source/_components/sensor.glances.markdown b/source/_components/sensor.glances.markdown index a8a10feddea..f109c2ddf5c 100644 --- a/source/_components/sensor.glances.markdown +++ b/source/_components/sensor.glances.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: glances.png ha_category: System Monitor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.7.3 --- diff --git a/source/_components/sensor.google_travel_time.markdown b/source/_components/sensor.google_travel_time.markdown index 8fcc76f1572..0c4e4c40f97 100644 --- a/source/_components/sensor.google_travel_time.markdown +++ b/source/_components/sensor.google_travel_time.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: google_maps.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.19 --- @@ -160,7 +160,6 @@ You can also use the `homeassistant.update` service to update the sensor on-dema - thu - fri action: - - service: homeassistant.update - data: - entity_id: sensor.morning_commute + - service: homeassistant.update_entity + entity_id: sensor.morning_commute ``` diff --git a/source/_components/sensor.google_wifi.markdown b/source/_components/sensor.google_wifi.markdown index 1924ec2f29f..358265a266a 100644 --- a/source/_components/sensor.google_wifi.markdown +++ b/source/_components/sensor.google_wifi.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: System Monitor logo: google_wifi.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: "0.50" --- diff --git a/source/_components/sensor.gpsd.markdown b/source/_components/sensor.gpsd.markdown index 857a0d1c95e..16544356eb5 100644 --- a/source/_components/sensor.gpsd.markdown +++ b/source/_components/sensor.gpsd.markdown @@ -10,7 +10,7 @@ footer: true logo: gpsd.png ha_category: Utility ha_release: 0.26 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `gpsd` component is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. @@ -20,7 +20,7 @@ The `gpsd` component is using the GPS information collected by [gpsd](http://cat A requirement is that `gpsd` is installed (`$ sudo apt-get install gpsd` or `$ sudo dnf -y install gpsd`). `gpsd` uses the socket activation feature of systemd on recent Linux distributions for USB receivers. This means that if you plug your GPS receiver in, `gpsd` is started. Other GPS device may work too, but this was not tested. ```bash -$ sudo systemctl status gpsdctl@ttyUSB0.service +$ sudo systemctl status gpsdctl@ttyUSB0.service ● gpsdctl@ttyUSB0.service - Manage ttyUSB0 for GPS daemon Loaded: loaded (/usr/lib/systemd/system/gpsdctl@.service; static; vendor preset: disabled) Active: active (exited) since Sat 2016-07-16 09:30:33 CEST; 1 day 23h ago diff --git a/source/_components/sensor.gtfs.markdown b/source/_components/sensor.gtfs.markdown index b2b426fd48a..bc114c0e480 100644 --- a/source/_components/sensor.gtfs.markdown +++ b/source/_components/sensor.gtfs.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: train.png ha_category: Transport -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.17 --- diff --git a/source/_components/sensor.gtt.markdown b/source/_components/sensor.gtt.markdown index 1a439775a3e..465b60899f6 100644 --- a/source/_components/sensor.gtt.markdown +++ b/source/_components/sensor.gtt.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Transport logo: gtt.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.85 --- diff --git a/source/_components/sensor.haveibeenpwned.markdown b/source/_components/sensor.haveibeenpwned.markdown index 56cb497b2ad..d195017418b 100644 --- a/source/_components/sensor.haveibeenpwned.markdown +++ b/source/_components/sensor.haveibeenpwned.markdown @@ -10,7 +10,7 @@ footer: true logo: haveibeenpwned.png ha_category: Sensor ha_release: 0.31 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com). @@ -24,7 +24,7 @@ the number of breaches on that email account. # Example configuration.yaml entry using cloud based emoncms sensor: - platform: haveibeenpwned - email: + email: - your_email1@domain.com - your_email2@domain.com ``` diff --git a/source/_components/sensor.hddtemp.markdown b/source/_components/sensor.hddtemp.markdown index 4146109d07a..14e9701053c 100644 --- a/source/_components/sensor.hddtemp.markdown +++ b/source/_components/sensor.hddtemp.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: System Monitor ha_release: 0.32 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `hddtemp` sensor platform is using the data provided by [HDDTemp](http://savannah.nongnu.org/projects/hddtemp). diff --git a/source/_components/sensor.history_stats.markdown b/source/_components/sensor.history_stats.markdown index c2c99448962..65a8516aec4 100644 --- a/source/_components/sensor.history_stats.markdown +++ b/source/_components/sensor.history_stats.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.39 ha_qa_scale: internal --- diff --git a/source/_components/sensor.hp_ilo.markdown b/source/_components/sensor.hp_ilo.markdown index c7f8594cafb..e3a70e36d60 100644 --- a/source/_components/sensor.hp_ilo.markdown +++ b/source/_components/sensor.hp_ilo.markdown @@ -10,7 +10,7 @@ footer: true logo: hewlett_packard_enterprise.png ha_category: System Monitor ha_release: 0.27 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `hp_ilo` platform allows you to do an API call to the HP ILO (Integrated Lights-Out) sensor of your server, and use this data in Home Assistant sensors. diff --git a/source/_components/sensor.http.markdown b/source/_components/sensor.http.markdown index e01041b1a46..b56daa293f4 100644 --- a/source/_components/sensor.http.markdown +++ b/source/_components/sensor.http.markdown @@ -10,13 +10,13 @@ footer: true logo: http.png ha_category: Sensor ha_release: pre 0.7 -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_qa_scale: internal --- The HTTP sensor is dynamically created with the first request that is made to its URL. You don't have to define it in the configuration first. - + The sensor will then exist as long as Home Assistant is running. After a restart of Home Assistant the sensor will be gone until it is triggered again. The URL for a sensor looks like the example below: diff --git a/source/_components/sensor.htu21d.markdown b/source/_components/sensor.htu21d.markdown index 687bb02df60..ccae7d89875 100644 --- a/source/_components/sensor.htu21d.markdown +++ b/source/_components/sensor.htu21d.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY ha_release: 0.48 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `htu21d` sensor platform allows you to read the temperature and humidity from a [HTU21D sensor](http://www.datasheetspdf.com/PDF/HTU21D/779951/1) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). diff --git a/source/_components/sensor.hydroquebec.markdown b/source/_components/sensor.hydroquebec.markdown index a6fabbbb3cd..7ca1a9cc169 100644 --- a/source/_components/sensor.hydroquebec.markdown +++ b/source/_components/sensor.hydroquebec.markdown @@ -10,10 +10,9 @@ footer: true logo: hydroquebec.svg ha_category: Energy ha_release: 0.35 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- - Integrate your [Hydro-Québec](https://www.hydroquebec.com/portail/) consumption profile information into Home Assistant.

diff --git a/source/_components/sensor.ihc.markdown b/source/_components/sensor.ihc.markdown index e5fe8027ee0..771a9760afe 100644 --- a/source/_components/sensor.ihc.markdown +++ b/source/_components/sensor.ihc.markdown @@ -10,7 +10,7 @@ footer: true logo: ihc.png ha_category: Sensor ha_release: 0.62 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- Before you can use the IHC Sensor platform, you must setup the @@ -31,12 +31,12 @@ ihc: - url: 'http://192.168.1.3' username: YOUR_USERNAME2 password: YOUR_PASSWORD2 - info: true + info: true sensor: - id: 12345 name: Temperatur_living_room unit_of_measurement: '°C' - note: Floor and wall temp. + note: Floor and wall temp. position: On wall between windows - id: 23456 ... diff --git a/source/_components/sensor.iliad_italy.markdown b/source/_components/sensor.iliad_italy.markdown index 7c3c658e8e7..0da90fc8942 100644 --- a/source/_components/sensor.iliad_italy.markdown +++ b/source/_components/sensor.iliad_italy.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Sensor logo: iliad.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.87 --- diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown index 57fe0ec41b9..3f59b41bc83 100644 --- a/source/_components/sensor.imap.markdown +++ b/source/_components/sensor.imap.markdown @@ -10,10 +10,9 @@ footer: true logo: smtp.png ha_category: Mailbox ha_release: 0.25 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push --- - The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails. ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown index 6b198bb06ad..7b9027b55ee 100644 --- a/source/_components/sensor.imap_email_content.markdown +++ b/source/_components/sensor.imap_email_content.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: smtp.png ha_category: Mailbox -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push ha_release: 0.25 --- @@ -102,4 +102,4 @@ sensor: ``` {% endraw %} -The same template structure can scan the date, body, or sender for matching text before setting the state of the sensor. +The same template structure can scan the date, body, or sender for matching text before setting the state of the sensor. diff --git a/source/_components/sensor.influxdb.markdown b/source/_components/sensor.influxdb.markdown index 2e054847848..fd6d63279e0 100644 --- a/source/_components/sensor.influxdb.markdown +++ b/source/_components/sensor.influxdb.markdown @@ -10,7 +10,7 @@ footer: true logo: influxdb.png ha_category: Sensor ha_release: 0.32 -ha_iot_class: "depends" +ha_iot_class: Configurable --- The `influxdb` sensor allows you to use values from an [InfluxDB](https://influxdb.com/) database to populate a sensor state. This can be use to present statistic about home_assistant sensors if used with the `influxdb` history component. It can also be used with an external data source. @@ -34,7 +34,7 @@ host: default: localhost type: string port: - description: Port to use. + description: Port to use. required: false default: 8086 type: string @@ -47,12 +47,12 @@ password: required: false type: string ssl: - description: Use https instead of http to connect. + description: Use https instead of http to connect. required: false default: false type: boolean verify_ssl: - description: Verify SSL certificate for https request. + description: Verify SSL certificate for https request. required: false default: false type: boolean @@ -98,7 +98,6 @@ queries: default: value {% endconfiguration %} - ## {% linkable_title Examples %} ### {% linkable_title Full configuration %} diff --git a/source/_components/sensor.integration.markdown b/source/_components/sensor.integration.markdown index 30c18300146..805d36ba86f 100644 --- a/source/_components/sensor.integration.markdown +++ b/source/_components/sensor.integration.markdown @@ -7,11 +7,11 @@ sidebar: true comments: false sharing: true footer: true -ha_category: - - Utility - - Energy +ha_category: + - Utility + - Energy ha_release: 0.87 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: integral.png ha_qa_scale: internal --- @@ -25,13 +25,13 @@ To enable Integration Sensor in your installation, add the following to your `co ```yaml # Example configuration.yaml entry sensor: - - platform: integration + - platform: integration source: sensor.current_power ``` {% configuration %} source: - description: The entity ID of the sensor providing numeric readings + description: The entity ID of the sensor providing numeric readings required: true type: string name: diff --git a/source/_components/sensor.ios.markdown b/source/_components/sensor.ios.markdown index 213ccafa87c..42ccc3cbbe7 100644 --- a/source/_components/sensor.ios.markdown +++ b/source/_components/sensor.ios.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: apple.png ha_category: Sensor -featured: false ha_release: 0.31 -ha_iot_class: push +ha_iot_class: Local Push --- The `ios` sensor platform is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. diff --git a/source/_components/sensor.irish_rail_transport.markdown b/source/_components/sensor.irish_rail_transport.markdown index 120e887a657..4893fee9792 100644 --- a/source/_components/sensor.irish_rail_transport.markdown +++ b/source/_components/sensor.irish_rail_transport.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: irishrail.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.57 --- diff --git a/source/_components/sensor.islamic_prayer_times.markdown b/source/_components/sensor.islamic_prayer_times.markdown index 0bed6f3d636..de3b69a1fba 100644 --- a/source/_components/sensor.islamic_prayer_times.markdown +++ b/source/_components/sensor.islamic_prayer_times.markdown @@ -8,8 +8,8 @@ comments: false sharing: true footer: true ha_category: Sensor -ha_iot_class: "Cloud Polling" -ha_release: "0.85" +ha_iot_class: Cloud Polling +ha_release: 0.85 --- The Islamic Prayer Times (`islamic_prayer_times`) sensor platform displays the various prayer times for Muslims as sensors. @@ -19,7 +19,7 @@ This platform calculates prayer times using the following calculation methods: - University of Islamic Sciences in Karachi - Islamic Society of North America - Muslim World League -- Umm Al-Qura University in Makkah +- Umm Al-Qura University in Makkah ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.jewish_calendar.markdown b/source/_components/sensor.jewish_calendar.markdown index 6aa67ab5346..6b9c9560e40 100644 --- a/source/_components/sensor.jewish_calendar.markdown +++ b/source/_components/sensor.jewish_calendar.markdown @@ -8,8 +8,8 @@ comments: false sharing: true footer: true ha_category: Calendar -ha_iot_class: "Local Poll" -ha_release: "0.79" +ha_iot_class: Local Polling +ha_release: 0.79 --- The Jewish Calendar (`jewish_calendar`) sensor platform displays a variety of information related to the Jewish Calendar as a variety of sensors. diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index d558d1c3a15..6ccfb5f3521 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -10,7 +10,7 @@ footer: true logo: knx.png ha_category: Sensor ha_release: 0.29 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensors. @@ -29,7 +29,6 @@ sensor: address: '2/0/0' ``` - {% configuration %} address: description: KNX group address of the sensor. @@ -45,7 +44,6 @@ type: type: string {% endconfiguration %} - | type | unit | expected KNX DPT | |--------------------|------|------------------| | percent | % | 5.001 | @@ -79,8 +77,6 @@ type: | DPT-14 | | 14.* | | 4byte_float | | 14.* | - - ## {% linkable_title Full example %} ```yaml diff --git a/source/_components/sensor.kwb.markdown b/source/_components/sensor.kwb.markdown index 5ed109dff6a..42b28ebe094 100644 --- a/source/_components/sensor.kwb.markdown +++ b/source/_components/sensor.kwb.markdown @@ -9,15 +9,15 @@ sharing: true footer: true logo: kwb.png ha_category: Sensor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: "0.40" --- -The `kwb` component 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` component integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller () 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). -Since this serial protocol is proprietary and closed, only most temperature sensors and a few control relays are supported, the rest is still WIP (see https://www.mikrocontroller.net/topic/274137). +Since this serial protocol is proprietary and closed, only most temperature sensors and a few control relays are supported, the rest is still WIP (see ). Direct connection via serial port: diff --git a/source/_components/sensor.lacrosse.markdown b/source/_components/sensor.lacrosse.markdown index 3d69b6c39ed..1f78b902c34 100644 --- a/source/_components/sensor.lacrosse.markdown +++ b/source/_components/sensor.lacrosse.markdown @@ -10,12 +10,12 @@ footer: true logo: home-assistant.png ha_category: DIY ha_release: 0.58 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip). -### {% linkable_title Tested Devices %} +## {% linkable_title Tested Devices %} - Technoline TX 29 IT (temperature only) - Technoline TX 29 DTH-IT (including humidity) @@ -25,7 +25,7 @@ The `lacrosse` sensor platform is using the data provided by a [Jeelink](https:/ Since the sensor change their ID after each powercycle/battery change you can check what sensor IDs are available by using the command-line tool `pylacrosse` from the pylacrosse package. ```bash -$ sudo pylacrosse -d /dev/ttyUSB0 scan +sudo pylacrosse -d /dev/ttyUSB0 scan ``` ## {% linkable_title Configuration %} @@ -92,7 +92,6 @@ sensor: type: integer {% endconfiguration %} - ## {% linkable_title Examples %} To setup a lacrosse sensor with multiple sensors, add the following to your `configuration.yaml` file: @@ -119,4 +118,3 @@ sensor: id: 72 ``` {% endraw %} - diff --git a/source/_components/sensor.lastfm.markdown b/source/_components/sensor.lastfm.markdown index d76a8beba62..2580f632d67 100644 --- a/source/_components/sensor.lastfm.markdown +++ b/source/_components/sensor.lastfm.markdown @@ -9,11 +9,10 @@ sharing: true footer: true logo: lastfm.png ha_category: Social -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: "0.20" --- - The `lastfm` sensor platform will allow you to see whenever a user starts scrobbling, their play count, last song played, and top song played on [Last.fm](http://www.last.fm). ## {% linkable_title Setup %} diff --git a/source/_components/sensor.launch_library.markdown b/source/_components/sensor.launch_library.markdown index c1b76447048..12b57a796e9 100644 --- a/source/_components/sensor.launch_library.markdown +++ b/source/_components/sensor.launch_library.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: rocket.png ha_category: Sensor -ha_iot_class: "Cloud Polling" -ha_release: "0.83" +ha_iot_class: Cloud Polling +ha_release: 0.83 --- The `launch_library` sensor will provide you with information about the next planned space launch. diff --git a/source/_components/sensor.linky.markdown b/source/_components/sensor.linky.markdown index a6f60920053..efcefd1def4 100644 --- a/source/_components/sensor.linky.markdown +++ b/source/_components/sensor.linky.markdown @@ -10,10 +10,9 @@ footer: true logo: enedis.png ha_release: 0.79 ha_category: Energy -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- - The `linky` sensor platform is showing the last day consumption of your home from the [Linky electric meter](https://www.enedis.fr/english). ## {% linkable_title Configuration %} @@ -38,4 +37,3 @@ password: required: true type: string {% endconfiguration %} - diff --git a/source/_components/sensor.linux_battery.markdown b/source/_components/sensor.linux_battery.markdown index 4bc3ea6b7ca..dcaa5e4409e 100644 --- a/source/_components/sensor.linux_battery.markdown +++ b/source/_components/sensor.linux_battery.markdown @@ -10,7 +10,7 @@ footer: true logo: linux_battery.png ha_category: System Monitor ha_release: 0.28 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `linux_battery` sensor platform is using the information stored in `/sys/class/power_supply/` on your local Linux system to display details about the current state of your battery. @@ -38,5 +38,5 @@ system: description: "The local system type. Support `linux` and `android`." required: false default: linux - type: string + type: string {% endconfiguration %} diff --git a/source/_components/sensor.logi_circle.markdown b/source/_components/sensor.logi_circle.markdown index 80df3bc9ae4..b5b569d5902 100644 --- a/source/_components/sensor.logi_circle.markdown +++ b/source/_components/sensor.logi_circle.markdown @@ -10,7 +10,7 @@ footer: true logo: logi_circle.png ha_category: Camera ha_release: 0.79 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `logi_circle` sensor platform lets you monitor sensors connected to your [Logi Circle](https://circle.logi.com) cameras in Home Assistant. @@ -51,4 +51,4 @@ monitored_conditions: description: Return the streaming mode status from the camera. {% endconfiguration %} -Currently it supports all 1st and 2nd generation cameras. Cameras without an internal battery will not expose a `battery_level` sensor. \ No newline at end of file +Currently it supports all 1st and 2nd generation cameras. Cameras without an internal battery will not expose a `battery_level` sensor. diff --git a/source/_components/sensor.london_air.markdown b/source/_components/sensor.london_air.markdown index a96965fa25e..7b8e23f83da 100644 --- a/source/_components/sensor.london_air.markdown +++ b/source/_components/sensor.london_air.markdown @@ -9,18 +9,16 @@ sharing: true footer: true logo: waqi.png ha_category: Health -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.52 --- - The `london_air` component [queries](http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available. Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described [here](http://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json) and are Carbon Monoxide ([CO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx)), Nitrogen Dioxide ([NO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx)), Ozone ([O3](http://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx)), Sulfur Dioxide ([SO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx)), PM2.5 & PM10 [particulates](http://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx). The `latitude` and `longitude` of each site is accessible through a `data` attribute of the sensor, as are details about the pollutants monitored at that site. The `sites` attribute of a sensor displays how many monitoring sites that sensor covers. The `updated` attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes. To add sensors to Home-assistant for all possible areas/boroughs add the following to your `configuration.yaml` file: - ```yaml # Example configuration.yaml entry for a single sensor sensor: diff --git a/source/_components/sensor.london_underground.markdown b/source/_components/sensor.london_underground.markdown index 57a1a5c1a5f..53f1faee979 100644 --- a/source/_components/sensor.london_underground.markdown +++ b/source/_components/sensor.london_underground.markdown @@ -9,14 +9,12 @@ sharing: true footer: true logo: london_underground.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.49 --- - The `london_underground` sensor will display the status of London underground lines, as well as the Overground, DLR and Tfl rail. - ```yaml # Example configuration.yaml entry sensor: diff --git a/source/_components/sensor.loopenergy.markdown b/source/_components/sensor.loopenergy.markdown index 8288ea2b430..ff3ee1b0560 100644 --- a/source/_components/sensor.loopenergy.markdown +++ b/source/_components/sensor.loopenergy.markdown @@ -10,7 +10,7 @@ footer: true logo: loop.png ha_category: Energy ha_release: 0.17 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push redirect_from: /components/sensor.loop_energy/ --- diff --git a/source/_components/sensor.lyft.markdown b/source/_components/sensor.lyft.markdown index 49a40eac20b..1236dcbd560 100644 --- a/source/_components/sensor.lyft.markdown +++ b/source/_components/sensor.lyft.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: lyft.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.41 --- diff --git a/source/_components/sensor.magicseaweed.markdown b/source/_components/sensor.magicseaweed.markdown index abb277f7070..7b34f8687de 100644 --- a/source/_components/sensor.magicseaweed.markdown +++ b/source/_components/sensor.magicseaweed.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: magicseaweed.png ha_category: Sensor -featured: false -ha_release: "0.75" -ha_iot_class: "Cloud Polling" +ha_release: 0.75 +ha_iot_class: Cloud Polling --- The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. @@ -95,5 +94,4 @@ units: description: Use US units. {% endconfiguration %} - Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api). diff --git a/source/_components/sensor.markdown b/source/_components/sensor.markdown index 791be58a734..e7f50019b88 100644 --- a/source/_components/sensor.markdown +++ b/source/_components/sensor.markdown @@ -7,13 +7,14 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.7 --- Sensors are gathering information about states and conditions. Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home Assistant directly, are gathered from web services, and, of course, physical devices. Please check the sidebar for a full list of supported sensor platforms. -### {% linkable_title Device Class %} +## {% linkable_title Device Class %} The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for sensors: diff --git a/source/_components/sensor.metoffice.markdown b/source/_components/sensor.metoffice.markdown index de9f1eca3dc..04d8f610bc2 100644 --- a/source/_components/sensor.metoffice.markdown +++ b/source/_components/sensor.metoffice.markdown @@ -10,7 +10,7 @@ footer: true logo: metoffice.jpg ha_category: Weather ha_release: 0.42 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `metoffice` sensor platform uses the Met Office's [DataPoint API](https://www.metoffice.gov.uk/datapoint) for weather data. diff --git a/source/_components/sensor.mfi.markdown b/source/_components/sensor.mfi.markdown index 6f179909a3f..8d1d4628c51 100644 --- a/source/_components/sensor.mfi.markdown +++ b/source/_components/sensor.mfi.markdown @@ -9,11 +9,10 @@ sharing: true footer: true logo: ubiquiti.png ha_category: Network -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.32 --- - The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/). ## {% linkable_title Configuration %} @@ -35,7 +34,7 @@ host: required: true type: string port: - description: The port of your mFi controller. + description: The port of your mFi controller. required: false default: 6080 (6443 for TLS) type: integer diff --git a/source/_components/sensor.mhz19.markdown b/source/_components/sensor.mhz19.markdown index 142eeed155f..5acbe55ce58 100644 --- a/source/_components/sensor.mhz19.markdown +++ b/source/_components/sensor.mhz19.markdown @@ -10,7 +10,7 @@ footer: true logo: mhz19_logo.png ha_category: DIY ha_release: 0.27 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The MH-Z19 is a small non-dispersive infrared sensor that can measure CO2 level. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. The CO2 level outside is around 400ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation. @@ -33,7 +33,7 @@ sensor: - **monitored_conditions** (*Optional*, starting from version 0.40): Conditions to monitor. Supported conditions: - **co2** (*default*) - **temperature** - + Full example: ```yaml sensor: diff --git a/source/_components/sensor.miflora.markdown b/source/_components/sensor.miflora.markdown index c20f0155d58..07bb5191c78 100644 --- a/source/_components/sensor.miflora.markdown +++ b/source/_components/sensor.miflora.markdown @@ -10,7 +10,7 @@ footer: true logo: miflora.png ha_category: Environment ha_release: 0.29 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `miflora` sensor platform allows one to monitor plant soil and air conditions. The [Mi Flora plant sensor](https://www.huahuacaocao.com/product) is a small Bluetooth Low Energy device that monitors the moisture and conductivity of the soil as well as ambient light and temperature. Since only one BLE device can be polled at a time, the library implements locking to prevent polling more than one device at a time. diff --git a/source/_components/sensor.min_max.markdown b/source/_components/sensor.min_max.markdown index 0d389c88664..7498749fca0 100644 --- a/source/_components/sensor.min_max.markdown +++ b/source/_components/sensor.min_max.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" -ha_release: "0.31" +ha_iot_class: Local Polling +ha_release: 0.31 ha_qa_scale: internal --- @@ -20,7 +20,7 @@ This sensor is an alternative to the [template sensor](/components/sensor.templa {% raw %} ```yaml -{{ ((float(states.sensor.kitchen_temperature.state) + +{{ ((float(states.sensor.kitchen_temperature.state) + float(states.sensor.living_room_temperature.state) + float(states.sensor.office_temperature.state)) / 3) | round(2) }} diff --git a/source/_components/sensor.mitemp_bt.markdown b/source/_components/sensor.mitemp_bt.markdown index 5cf0f59fb12..897b76ac625 100644 --- a/source/_components/sensor.mitemp_bt.markdown +++ b/source/_components/sensor.mitemp_bt.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: DIY ha_release: 0.69 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `mitemp_bt` sensor platform allows one to monitor room temperature and humidity. The [Xiaomi Mijia BLE Temperature and Humidity sensor with LCD](https://www.amazon.com/Temperature-Humidity-Xiaomi-Bluetooth-Screen-Remote/dp/B079L6N6PC) is a small Bluetooth Low Energy device that monitors the room temperature and humidity. As only a single BLE device can be polled at the same time, the library employs locking to make sure this is the case. @@ -22,8 +22,8 @@ Depending on the operating system you're running, you have to configure the prop - On [Hass.io](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does). - On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. - On other Linux systems: - - Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one. - - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`. + - Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one. + - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`. - Windows and MacOS are currently not supported by the `btlewrap` library. ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index cc4cd589785..81ab438079b 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -10,10 +10,9 @@ footer: true logo: modbus.png ha_category: Sensor ha_release: pre 0.7 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- - The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers. ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.modem_callerid.markdown b/source/_components/sensor.modem_callerid.markdown index 4747aea5cf9..9e90a07343d 100644 --- a/source/_components/sensor.modem_callerid.markdown +++ b/source/_components/sensor.modem_callerid.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Sensor ha_release: "0.40" -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `modem_callerid` sensor platform uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1). @@ -21,13 +21,13 @@ When the sensor detects a new call, its state changes to 'ring' for each ring an To find the path of your USB modem, run: ```bash -$ ls /dev/ttyACM* +ls /dev/ttyACM* ``` If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with: ```bash -$ sudo usermod -a -G dialout homeassistant +sudo usermod -a -G dialout homeassistant ``` Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). @@ -55,7 +55,6 @@ device: default: "`/dev/ttyACM0`" {% endconfiguration %} - To find the path of your USB modem, run: `$ ls /dev/ttyACM*` @@ -66,8 +65,6 @@ If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hass Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). - - ## {% linkable_title Examples %} Some example automations: @@ -76,7 +73,7 @@ Some example automations: ```yaml automation: - alias: Notify CallerID - trigger: + trigger: platform: state entity_id: sensor.modem_callerid to: "callerid" @@ -85,7 +82,7 @@ automation: data: message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }} at {{ states.sensor.modem_callerid.attributes.cid_number }} ' - alias: Notify CallerID webui - trigger: + trigger: platform: state entity_id: sensor.modem_callerid to: "callerid" @@ -95,7 +92,7 @@ automation: title: "Call from" message: '{{ states.sensor.modem_callerid.attributes.cid_time.strftime("%I:%M %p") }} {{ states.sensor.modem_callerid.attributes.cid_name }} {{ states.sensor.modem_callerid.attributes.cid_number }} ' - alias: Say CallerID - trigger: + trigger: platform: state entity_id: sensor.modem_callerid to: "callerid" diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index f4f86197cc8..a60ce1cf238 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_category: Environment ha_release: "0.20" -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_qa_scale: internal --- @@ -41,7 +41,7 @@ indoor_temp_sensor: description: The entity ID of the indoor temperature sensor. required: true type: string -indoor_humidity_sensor: +indoor_humidity_sensor: description: The entity ID of the indoor humidity sensor. required: true type: string @@ -49,7 +49,7 @@ outdoor_temp_sensor: description: The entity ID of the outdoor temperature sensor. required: true type: string -calibration_factor: +calibration_factor: description: Needs to be calibrated to the critical point in the room. required: true type: float diff --git a/source/_components/sensor.moon.markdown b/source/_components/sensor.moon.markdown index 5e7aadde293..91bdc8af7af 100644 --- a/source/_components/sensor.moon.markdown +++ b/source/_components/sensor.moon.markdown @@ -9,12 +9,11 @@ sharing: true footer: true logo: home-assistant.png ha_category: Environment -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.38 ha_qa_scale: internal --- - The `moon` sensor platform is tracking the moon phases. ## {% linkable_title Configuration %} @@ -27,5 +26,5 @@ sensor: - platform: moon ``` -This sensor will return one of the following values: +This sensor will return one of the following values: `new_moon`, `waxing_crescent`, `first_quarter`, `waxing_gibbous`, `full_moon`, `waning_gibbous`, `last_quarter` or `waning_crescent` . diff --git a/source/_components/sensor.mopar.markdown b/source/_components/sensor.mopar.markdown index fc3396ab434..e3ef5772f8c 100644 --- a/source/_components/sensor.mopar.markdown +++ b/source/_components/sensor.mopar.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: mopar.png ha_category: Car -featured: false ha_release: 0.53 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `mopar` sensor provides the following for owners of FCA vehicles with a uConnect subscription: diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index f065d0dd55d..fe808d76995 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -10,10 +10,9 @@ footer: true logo: mqtt.png ha_category: Sensor ha_release: 0.7 -ha_iot_class: depends +ha_iot_class: Configurable --- - This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined. ## {% linkable_title Configuration %} @@ -152,7 +151,7 @@ sensor: ### {% linkable_title Get battery level %} -If you are using the [OwnTracks](/components/device_tracker.owntracks/) and enable the reporting of the battery level then you can use a MQTT sensor to keep track of your battery. A regular MQTT message from OwnTracks looks like this: +If you are using the [OwnTracks](/components/device_tracker.owntracks/) and enable the reporting of the battery level then you can use a MQTT sensor to keep track of your battery. A regular MQTT message from OwnTracks looks like this: ```bash owntracks/tablet/tablet {"_type":"location","lon":7.21,"t":"u","batt":92,"tst":144995643,"tid":"ta","acc":27,"lat":46.12} @@ -174,7 +173,7 @@ sensor: ### {% linkable_title Get temperature and humidity %} -If you are using a DHT sensor and a NodeMCU board (esp8266), you can retrieve temperature and humidity with a MQTT sensor. A code example can be found [here](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_sensor_dht22). A regular MQTT message from this example looks like this: +If you are using a DHT sensor and a NodeMCU board (esp8266), you can retrieve temperature and humidity with a MQTT sensor. A code example can be found [here](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_sensor_dht22). A regular MQTT message from this example looks like this: ```json office/sensor1 @@ -210,7 +209,7 @@ Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.c - **Controller Subscribe**: `home/%sysname%/#` (instead of `/%sysname%/#`) - **Controller Publish**: `home/%sysname%/%tskname%/%valname%` (instead of `/%sysname%/%tskname%/%valname%`) -Also, add a sensor in the "Devices" tap with the name "analog" and "brightness" as value. +Also, add a sensor in the "Devices" tap with the name "analog" and "brightness" as value. As soon as the unit is online, you will get the state of the sensor. diff --git a/source/_components/sensor.mqtt_room.markdown b/source/_components/sensor.mqtt_room.markdown index caaba3e668b..5ec6170fb2a 100644 --- a/source/_components/sensor.mqtt_room.markdown +++ b/source/_components/sensor.mqtt_room.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Presence Detection ha_release: 0.27 -ha_iot_class: depends +ha_iot_class: Configurable --- The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients. diff --git a/source/_components/sensor.mvglive.markdown b/source/_components/sensor.mvglive.markdown index c190359f53c..3ff7bf6d292 100644 --- a/source/_components/sensor.mvglive.markdown +++ b/source/_components/sensor.mvglive.markdown @@ -10,7 +10,7 @@ footer: true logo: mvg.png ha_category: Transport ha_release: 0.42 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes. @@ -89,6 +89,6 @@ sensor: directions: '1' ``` -The first sensor will return S-Bahn departures to Munich Airport or Markt Schwaben that are at least 2 minutes away. +The first sensor will return S-Bahn departures to Munich Airport or Markt Schwaben that are at least 2 minutes away. The second sensor returns U2 and U8 departures from Sendlinger Tor and stores a total of 5 departures in attributes. To retrieve the time until the second departure, you would use states.sensor.ENTITY_NAME.attributes.departures[1].time. The third sensor returns all south-bound U-Bahn trains from Scheidplatz. diff --git a/source/_components/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index a96d428af10..d58e2ee3f75 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -11,15 +11,17 @@ logo: mysensors.png ha_category: - DIY - Sensor -featured: false -ha_iot_class: "Local Push" +ha_iot_class: Local Push +ha_release: 0.7 --- Integrates MySensors sensors into Home Assistant. See the [main component] for configuration instructions. +## {% linkable_title Supported sensor types %} + The following sensor types are supported: -##### MySensors version 1.4 and higher +### {% linkable_title MySensors version 1.4 and higher %} S_TYPE | V_TYPE -------------------|--------------------------------------- @@ -40,7 +42,7 @@ S_CUSTOM | V_VAR1, V_VAR2, V_VAR3, V_VAR4, V_VAR5 S_DUST | V_DUST_LEVEL S_SCENE_CONTROLLER | V_SCENE_ON, V_SCENE_OFF -##### MySensors version 1.5 and higher +### {% linkable_title MySensors version 1.5 and higher %} S_TYPE | V_TYPE ---------------|---------------------------------- @@ -53,7 +55,7 @@ S_LIGHT_LEVEL | V_LEVEL S_AIR_QUALITY | V_LEVEL (replaces V_DUST_LEVEL) S_DUST | V_LEVEL (replaces V_DUST_LEVEL) -##### MySensors version 2.0 and higher +### {% linkable_title MySensors version 2.0 and higher %} S_TYPE | V_TYPE ----------------|-------------------------- @@ -62,7 +64,7 @@ S_GAS | V_FLOW, V_VOLUME S_GPS | V_POSITION S_WATER_QUALITY | V_TEMP, V_PH, V_ORP, V_EC -### {% linkable_title Custom unit of measurement %} +## {% linkable_title Custom unit of measurement %} Some sensor value types are not specific for a certain sensor type. These do not have a default unit of measurement in Home Assistant. For example, the V_LEVEL type can be used for different sensor types, dust, sound, vibration etc. @@ -70,6 +72,8 @@ By using V_UNIT_PREFIX, it's possible to set a custom unit for any sensor. The s For more information, visit the [serial api] of MySensors. +## {% linkable_title Example sketches %} + ### {% linkable_title MySensors 1.5 example sketch %} ```cpp @@ -81,7 +85,7 @@ For more information, visit the [serial api] of MySensors. */ #include -#include +#include #include #include @@ -96,7 +100,7 @@ MyMessage msg(CHILD_ID, V_LEVEL); MyMessage msgPrefix(CHILD_ID, V_UNIT_PREFIX); // Custom unit message. uint16_t lastlux = 0; -void setup() +void setup() { gw.begin(); gw.sendSketchInfo(SN, SV); @@ -106,8 +110,8 @@ void setup() gw.send(msgPrefix.set("lux")); // Set custom unit. } -void loop() -{ +void loop() +{ uint16_t lux = lightSensor.readLightLevel(); // Get Lux value if (lux != lastlux) { gw.send(msg.set(lux)); diff --git a/source/_components/sensor.nederlandse_spoorwegen.markdown b/source/_components/sensor.nederlandse_spoorwegen.markdown index ec40c7690d6..2bd9a5f343c 100644 --- a/source/_components/sensor.nederlandse_spoorwegen.markdown +++ b/source/_components/sensor.nederlandse_spoorwegen.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: nederlandse_spoorwegen.png ha_category: Transport -ha_iot_class: "Cloud Polling" -ha_release: "0.57" +ha_iot_class: Cloud Polling +ha_release: 0.57 --- This sensor will provide you with time table information of the [Nederlandse Spoorwegen](https://www.ns.nl/) train service in the Netherlands. diff --git a/source/_components/sensor.nest_weather.markdown b/source/_components/sensor.nest_weather.markdown deleted file mode 100644 index a8ab4c4c460..00000000000 --- a/source/_components/sensor.nest_weather.markdown +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: page -title: "Nest Weather Sensor" -description: "Instructions on how to integrate Nest sensors within Home Assistant." -date: 2016-01-13 19:59 -sidebar: true -comments: false -sharing: true -footer: true -logo: nest.png -ha_category: Weather -ha_iot_class: "Cloud Polling" ---- - -

-**This platform is currently not available. It's possible that `nest_weather` will be removed in the future.** -

- -The `nest` weather sensor platform let you monitor current weather conditions based on the location of your [Nest](https://nest.com) thermostat. - -

-You must have the [Nest component](/components/nest/) configured to use those sensors. -

- -To set it up, add the following information to your `configuration.yaml` file: - -```yaml -sensor: - - platform: nest - monitored_conditions: - - 'weather_temperature' -``` - -{% configuration %} -monitored_conditions: - description: States to monitor. - required: true - type: list - keys: - weather_temperature: - description: The current temperture - weather_humidity: - description: The current humidity - weather_condition: - description: The weather conditions - wind_speed: - description: The wind speed - wind_direction: - description: The wind direction -{% endconfiguration %} diff --git a/source/_components/sensor.netatmo.markdown b/source/_components/sensor.netatmo.markdown index 7e0c9827ac8..b7312eb8ba8 100644 --- a/source/_components/sensor.netatmo.markdown +++ b/source/_components/sensor.netatmo.markdown @@ -9,17 +9,16 @@ sharing: true footer: true logo: netatmo.png ha_category: Weather -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling +ha_release: 0.11 --- -### {% linkable_title Basic Configuration %} - -The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) or a +The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) or a [Netatmo Home Coach](https://www.netatmo.com/en-us/aircare/homecoach) [Netatmo](https://www.netatmo.com) devices. To enable the Netatmo sensor, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your sensor. -### {% linkable_title Advanced configuration %} +## {% linkable_title Advanced configuration %} If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: @@ -95,7 +94,7 @@ modules: description: Percentage of battery remaining per module. {% endconfiguration %} -### {% linkable_title Find your modules name %} +## {% linkable_title Find your modules name %} You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters. You have to provide these name in your Home Assistant `configuration.yaml` file. diff --git a/source/_components/sensor.netatmo_public.markdown b/source/_components/sensor.netatmo_public.markdown index 0f70887c115..26d5d64a636 100644 --- a/source/_components/sensor.netatmo_public.markdown +++ b/source/_components/sensor.netatmo_public.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: netatmo.png ha_category: Environment -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.77 --- diff --git a/source/_components/sensor.netdata.markdown b/source/_components/sensor.netdata.markdown index 67dc414b48b..192a6fa9d6d 100644 --- a/source/_components/sensor.netdata.markdown +++ b/source/_components/sensor.netdata.markdown @@ -10,10 +10,9 @@ footer: true logo: netdata.png ha_category: System Monitor ha_release: 0.35 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- - The `netdata` sensor platform allows you to display information collected by [Netdata](http://my-netdata.io/). ## {% linkable_title Setup %} @@ -41,7 +40,6 @@ $ curl -X GET "http://[Netdata_Instance]:19999/api/v1/data?chart=[data_group]&po - `dimension_names`: Names shown in the frontend. - `dimension_ids`: Names to use for `element`. - ## {% linkable_title Configuration %} To add this platform to your installation, add the following to your `configuration.yaml` file: @@ -86,7 +84,7 @@ resources: type: string keys: data_group: - description: "Name of the data group to monitor, e.g., `system.cpu`." + description: "Name of the data group to monitor, e.g., `system.cpu`." required: true type: string element: @@ -104,24 +102,3 @@ resources: type: boolean default: false {% endconfiguration %} - - -## {% linkable_title Full examples %} - -### {% linkable_title Network interface details %} - -Netdata returns all bandwidth related sensors as positive/negative numbers related to the interface. - -```yaml -# Example configuration.yaml entry -sensor: - - platform: netdata - resources: - network_downstream: - data_group: net.eth1 - element: received - network_upstream: - data_group: net.eth1 - element: sent - invert: true -``` diff --git a/source/_components/sensor.neurio_energy.markdown b/source/_components/sensor.neurio_energy.markdown index ea56901adba..f6e8d4c9294 100644 --- a/source/_components/sensor.neurio_energy.markdown +++ b/source/_components/sensor.neurio_energy.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: neurio.png ha_category: Energy -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.14 --- @@ -26,6 +26,7 @@ sensor: ``` Two sensors will be created with the following names: + - **Energy Usage**: Current active power usage in Watts. Updated every 10 seconds. - **Daily Energy Usage**: Daily power usage in kWh. Updated every 2.5 minutes. diff --git a/source/_components/sensor.nmbs.markdown b/source/_components/sensor.nmbs.markdown index 34395044768..98826d0cc71 100644 --- a/source/_components/sensor.nmbs.markdown +++ b/source/_components/sensor.nmbs.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: sncb_nmbs.gif ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.85 --- diff --git a/source/_components/sensor.noaa_tides.markdown b/source/_components/sensor.noaa_tides.markdown index 434d25dd621..aa6e7a6dbf5 100644 --- a/source/_components/sensor.noaa_tides.markdown +++ b/source/_components/sensor.noaa_tides.markdown @@ -31,7 +31,7 @@ sensor: {% configuration %} station_id: - description: ID of the station you'd like to track from https://tidesandcurrents.noaa.gov/tide_predictions.html. + description: ID of the station you'd like to track from . required: true type: string name: diff --git a/source/_components/sensor.nsw_fuel_station.markdown b/source/_components/sensor.nsw_fuel_station.markdown index 620e3a4082f..a62ce317ab7 100644 --- a/source/_components/sensor.nsw_fuel_station.markdown +++ b/source/_components/sensor.nsw_fuel_station.markdown @@ -10,7 +10,7 @@ footer: true logo: fuelcheck.png ha_category: Car ha_release: 0.72 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `nsw_fuel_station` sensor platform uses the [NSW Fuel Check App](https://www.fuelcheck.nsw.gov.au/app) data as a source for current fuel price data. @@ -32,7 +32,7 @@ To add the NSW fuel station price sensor to your installation, add the following sensor: - platform: nsw_fuel_station station_id: 291 -``` +``` {% configuration %} station_id: @@ -44,4 +44,4 @@ fuel_types: required: false default: "`['E10', 'U91']`" type: list -{% endconfiguration %} +{% endconfiguration %} diff --git a/source/_components/sensor.nut.markdown b/source/_components/sensor.nut.markdown index fc39be6e0f0..e7723263f6e 100644 --- a/source/_components/sensor.nut.markdown +++ b/source/_components/sensor.nut.markdown @@ -9,12 +9,14 @@ sharing: true footer: true logo: nut.png ha_category: System Monitor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.34 --- The `nut` sensor platform allows you to monitor a UPS (battery backup) by using data from a [NUT](http://networkupstools.org/) (Network UPS Tools) server. +## {% linkable_title Configuration %} + To use this sensor platform, you need to add the following to your `configuration.yaml` file: ```yaml @@ -65,7 +67,7 @@ sensor: type: list {% endconfiguration %} -### {% linkable_title Example %} +## {% linkable_title Example %} Given the following example output from NUT (your variables may differ): @@ -127,7 +129,7 @@ sensor: - battery.runtime ``` -### {% linkable_title UPS Status - human-readable version %} +## {% linkable_title UPS Status - human-readable version %} An additional virtual sensor type `ups.status.display` is available translating the UPS status value retrieved from `ups.status` into a human-readable version. diff --git a/source/_components/sensor.nzbget.markdown b/source/_components/sensor.nzbget.markdown index bd32c3a2142..020c6b95a93 100644 --- a/source/_components/sensor.nzbget.markdown +++ b/source/_components/sensor.nzbget.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Downloading logo: nzbget.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.17 --- diff --git a/source/_components/sensor.ohmconnect.markdown b/source/_components/sensor.ohmconnect.markdown index ed30d3f2664..9faf90363bd 100644 --- a/source/_components/sensor.ohmconnect.markdown +++ b/source/_components/sensor.ohmconnect.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: "ohmconnect.png" ha_category: Energy -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.26 --- @@ -21,8 +21,6 @@ OhmConnect monitors real-time conditions on the electricity grid. When dirty and You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`. -## {% linkable_title Configuration %} - To enable the OhMConnect sensor, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.onewire.markdown b/source/_components/sensor.onewire.markdown index 73633a4900c..4c3ed4dad87 100644 --- a/source/_components/sensor.onewire.markdown +++ b/source/_components/sensor.onewire.markdown @@ -10,7 +10,7 @@ footer: true logo: onewire.png ha_category: DIY ha_release: 0.12 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `onewire` platform supports sensors which are using the One wire (1-wire) bus for communication. @@ -90,4 +90,3 @@ sensor: names: GENERATED_ID: FRIENDLY_NAME ``` - diff --git a/source/_components/sensor.openevse.markdown b/source/_components/sensor.openevse.markdown index 99c3769357f..5f9c5097f4f 100644 --- a/source/_components/sensor.openevse.markdown +++ b/source/_components/sensor.openevse.markdown @@ -9,11 +9,10 @@ sharing: true footer: true logo: openevse.png ha_category: Car -ha_release: "0.38" -ha_iot_class: "Local Polling" +ha_release: 0.38 +ha_iot_class: Local Polling --- - This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection. ## {% linkable_title Configuration %} @@ -30,7 +29,7 @@ sensor: ``` {% configuration %} -host: +host: description: The IP address or hostname of your charger. required: true type: string diff --git a/source/_components/sensor.openexchangerates.markdown b/source/_components/sensor.openexchangerates.markdown index 14340a44711..74c8c0ff330 100644 --- a/source/_components/sensor.openexchangerates.markdown +++ b/source/_components/sensor.openexchangerates.markdown @@ -9,12 +9,11 @@ sharing: true footer: true ha_category: Finance logo: openexchangerates.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.23 --- - -The `openexchangerates` sensor will show you the current exchange rate from [Open Exchange Rates](https://openexchangerates.org) that provides realtime exchange rates for [170 currencies](https://openexchangerates.org/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour. +The `openexchangerates` sensor will show you the current exchange rate from [Open Exchange Rates](https://openexchangerates.org) that provides realtime exchange rates for [170 currencies](https://openexchangerates.org/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour. Obtain your API key [here](https://openexchangerates.org/signup) @@ -48,4 +47,3 @@ base: type: string default: USD {% endconfiguration %} - diff --git a/source/_components/sensor.openhardwaremonitor.markdown b/source/_components/sensor.openhardwaremonitor.markdown index 6710793515f..277d08c27a9 100644 --- a/source/_components/sensor.openhardwaremonitor.markdown +++ b/source/_components/sensor.openhardwaremonitor.markdown @@ -10,10 +10,9 @@ footer: true logo: openhardwaremonitor.png ha_category: System Monitor ha_release: 0.48 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- - The `openhardwaremonitor` platform uses your [Open Hardware Monitor](http://openhardwaremonitor.org/) installation as a source for sensors that will display system information. ## {% linkable_title Setup %} @@ -34,8 +33,8 @@ To open port (on Windows): To open port with `firewalld` (Linux): ```bash -$ sudo firewall-cmd --permanent --add-port=8085/tcp -$ sudo firewall-cmd --reload +sudo firewall-cmd --permanent --add-port=8085/tcp +sudo firewall-cmd --reload ``` ## {% linkable_title Configuration %} @@ -59,4 +58,3 @@ sensor: required: false type: integer {% endconfiguration %} - diff --git a/source/_components/sensor.opensky.markdown b/source/_components/sensor.opensky.markdown index f1e13674e70..2d657e30694 100644 --- a/source/_components/sensor.opensky.markdown +++ b/source/_components/sensor.opensky.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: opensky.png ha_category: Transport -featured: false ha_release: 0.43 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region. diff --git a/source/_components/sensor.openweathermap.markdown b/source/_components/sensor.openweathermap.markdown index 199aeed13d0..04a0c9e6ec8 100644 --- a/source/_components/sensor.openweathermap.markdown +++ b/source/_components/sensor.openweathermap.markdown @@ -10,11 +10,10 @@ footer: true logo: openweathermap.png ha_category: Weather ha_release: pre 0.7 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- - -The `openweathermap` platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location. The `forecast` will show you the condition in 3 h. +The `openweathermap` platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location. The `forecast` will show you the condition in 3 h. You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up). diff --git a/source/_components/sensor.otp.markdown b/source/_components/sensor.otp.markdown index 5e753501752..315e5aa7bfb 100644 --- a/source/_components/sensor.otp.markdown +++ b/source/_components/sensor.otp.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.49 ha_qa_scale: internal --- diff --git a/source/_components/sensor.pi_hole.markdown b/source/_components/sensor.pi_hole.markdown index 884cc1cf8a8..92a6b42823f 100644 --- a/source/_components/sensor.pi_hole.markdown +++ b/source/_components/sensor.pi_hole.markdown @@ -8,12 +8,11 @@ comments: false sharing: true footer: true ha_category: System Monitor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling logo: pi_hole.png ha_release: 0.28 --- - The `pi_hole` sensor platform displays the statistical summary of a [Pi-hole](https://pi-hole.net/) system. ## {% linkable_title Configuration %} @@ -73,4 +72,4 @@ monitored_conditions: description: Total number of seen clients. {% endconfiguration %} -This sensor platform was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform. `Pi-hole` is a registered trademark of Pi-hole LLC. +This sensor platform was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform. `Pi-hole` is a registered trademark of Pi-hole LLC. diff --git a/source/_components/sensor.plex.markdown b/source/_components/sensor.plex.markdown index 30646976192..1854dfedfb3 100644 --- a/source/_components/sensor.plex.markdown +++ b/source/_components/sensor.plex.markdown @@ -10,7 +10,7 @@ footer: true logo: plex.png ha_category: Media Player ha_release: 0.22 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `plex` sensor platform will monitor activity on a given [Plex Media Server](https://plex.tv/). It will create a sensor that shows the number of currently watching users as the state. If you click the sensor for more details it will show you who is watching what. diff --git a/source/_components/sensor.pocketcasts.markdown b/source/_components/sensor.pocketcasts.markdown index 10fcc6003e7..0cd5a16fb67 100644 --- a/source/_components/sensor.pocketcasts.markdown +++ b/source/_components/sensor.pocketcasts.markdown @@ -10,10 +10,10 @@ footer: true logo: pocketcasts.png ha_category: Multimedia ha_release: 0.39 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- -The `pocketcasts` sensor platform let one monitor the podcasts at [Pocket Casts](https://play.pocketcasts.com/). +The `pocketcasts` sensor platform let one monitor the podcasts at [Pocket Casts](https://play.pocketcasts.com/). ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.pollen.markdown b/source/_components/sensor.pollen.markdown index c3f781da50a..d04bae844a7 100644 --- a/source/_components/sensor.pollen.markdown +++ b/source/_components/sensor.pollen.markdown @@ -10,7 +10,7 @@ footer: true logo: pollen.jpg ha_category: Health ha_release: 0.63 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `pollen` sensor platform collects and displays allergy, asthma, and disease @@ -66,26 +66,17 @@ ZIP codes that start with 0 will cause errors. The following metrics can be monitored: -* Allergy Index: Forecasted Average (`allergy_average_forecasted`): the average -forecasted allergy index over the next 5 days -* Allergy Index: Historical Average (`allergy_average_historical`): the average -historical allergy index over the past 30 days +* Allergy Index: Forecasted Average (`allergy_average_forecasted`): the average forecasted allergy index over the next 5 days +* Allergy Index: Historical Average (`allergy_average_historical`): the average historical allergy index over the past 30 days * Allergy Index: Today (`allergy_index_today`): the allergy index for today -* Allergy Index: Tomorrow (`allergy_index_tomorrow`): the allergy index for -tomorrow -* Allergy Index: Yesterday (`allergy_index_yesterday`): the allergy index for -yesterday -* Asthma Index: Forecasted Average (`asthma_average_forecasted`): the average -forecasted asthma index over the next 5 days -* Asthma Index: Historical Average (`asthma_average_historical`): the average -historical asthma index over the past 30 days +* Allergy Index: Tomorrow (`allergy_index_tomorrow`): the allergy index for tomorrow +* Allergy Index: Yesterday (`allergy_index_yesterday`): the allergy index for yesterday +* Asthma Index: Forecasted Average (`asthma_average_forecasted`): the average forecasted asthma index over the next 5 days +* Asthma Index: Historical Average (`asthma_average_historical`): the average historical asthma index over the past 30 days * Asthma Index: Today (`asthma_index_today`): the asthma index for today -* Asthma Index: Tomorrow (`asthma_index_tomorrow`): the asthma index for -tomorrow -* Asthma Index: Yesterday (`asthma_index_yesterday`): the asthma index for -yesterday -* Cold & Flu: Forecasted Average (`disease_average_forecasted`): the average -forecasted cold/flu index over the next 5 days +* Asthma Index: Tomorrow (`asthma_index_tomorrow`): the asthma index for tomorrow +* Asthma Index: Yesterday (`asthma_index_yesterday`): the asthma index for yesterday +* Cold & Flu: Forecasted Average (`disease_average_forecasted`): the average forecasted cold/flu index over the next 5 days ## {% linkable_title Understanding the Indices %} @@ -108,8 +99,8 @@ Example values include: Pollutant | Symbol | More Info --------- | ------ | --------- -Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution) -Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution) +Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution) +Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution) Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution) Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution) Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution) diff --git a/source/_components/sensor.postnl.markdown b/source/_components/sensor.postnl.markdown index fdbd5ec8f1f..b2bda7ce479 100644 --- a/source/_components/sensor.postnl.markdown +++ b/source/_components/sensor.postnl.markdown @@ -10,7 +10,7 @@ footer: true logo: postnl.png ha_category: Postal Service ha_release: 0.69 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `postnl` platform allows one to track deliveries by [PostNL](https://www.postnl.nl) (Dutch Postal Services). To use this sensor, you need a [PostNL Account](https://jouw.postnl.nl). It is possible to add multiple accounts to your Home Assistant configuration. diff --git a/source/_components/sensor.prezzibenzina.markdown b/source/_components/sensor.prezzibenzina.markdown index a3cdc449132..d116b854802 100644 --- a/source/_components/sensor.prezzibenzina.markdown +++ b/source/_components/sensor.prezzibenzina.markdown @@ -10,7 +10,7 @@ footer: true logo: prezzibenzina.png ha_category: Energy ha_release: 0.85 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `prezzibenzina` platform allows you to monitor the fuel prices with [PrezziBenzina.it](https://www.prezzibenzina.it/) from within Home Assistant and setup automations based on the information. @@ -31,7 +31,7 @@ To enable this sensor, add the following lines to your `configuration.yaml`: # Example configuration.yaml entry sensor: - platform: prezzibenzina - station: STATION_ID + station: STATION_ID ``` {% configuration %} @@ -57,7 +57,7 @@ This is a full example of the sensor: sensor: - platform: prezzibenzina station: - fuel_types: + fuel_types: - "Benzina" - "GPL" name: "Station" diff --git a/source/_components/sensor.pushbullet.markdown b/source/_components/sensor.pushbullet.markdown index 8d516949e9e..5ff51bcac9e 100644 --- a/source/_components/sensor.pushbullet.markdown +++ b/source/_components/sensor.pushbullet.markdown @@ -10,7 +10,7 @@ footer: true logo: pushbullet.png ha_category: Sensor ha_release: 0.44 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `pushbullet` sensor platform reads messages from [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. This sensor platform provides sensors that show the properties of the latest received Pushbullet notification mirror. diff --git a/source/_components/sensor.pvoutput.markdown b/source/_components/sensor.pvoutput.markdown index 36e3f43ab6e..6cfcd6d9bf9 100644 --- a/source/_components/sensor.pvoutput.markdown +++ b/source/_components/sensor.pvoutput.markdown @@ -10,11 +10,10 @@ footer: true logo: pvoutput.png ha_category: Energy ha_release: 0.33 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- - -The `pvoutput` sensor platform consumes information from [PVOutput](http://pvoutput.org/) which were uploaded by your solar photovoltaic (PV) system. +The `pvoutput` sensor platform consumes information from [PVOutput](http://pvoutput.org/) which were uploaded by your solar photovoltaic (PV) system. To add PVOutput details to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.pyload.markdown b/source/_components/sensor.pyload.markdown index 221be40d59c..fe03104ef7c 100644 --- a/source/_components/sensor.pyload.markdown +++ b/source/_components/sensor.pyload.markdown @@ -10,7 +10,7 @@ footer: true logo: pyload.png ha_category: Downloading ha_release: 0.58 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `pyload` platform allows you to monitor your downloads with [pyLoad](https://pyload.net/) from within Home Assistant and setup automation based on the information. diff --git a/source/_components/sensor.qbittorrent.markdown b/source/_components/sensor.qbittorrent.markdown index 1dfdd2d9cf9..642ecd006af 100644 --- a/source/_components/sensor.qbittorrent.markdown +++ b/source/_components/sensor.qbittorrent.markdown @@ -10,7 +10,7 @@ footer: true logo: qbittorrent.png ha_category: Downloading ha_release: 0.84 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `qbittorrent` platform allows you to monitor your downloads with [qBittorrent](https://www.qbittorrent.org/) from within Home Assistant and setup automations based on the information. diff --git a/source/_components/sensor.qnap.markdown b/source/_components/sensor.qnap.markdown index c9bbe117708..668f6840a5d 100644 --- a/source/_components/sensor.qnap.markdown +++ b/source/_components/sensor.qnap.markdown @@ -10,7 +10,7 @@ footer: true logo: qnap.png ha_category: System Monitor ha_release: 0.38 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/). diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index 08bb928d472..12d954ea4b9 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -12,7 +12,6 @@ ha_category: Downloading ha_release: 0.47 --- - This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance. ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.raincloud.markdown b/source/_components/sensor.raincloud.markdown index 138eb20da16..375053cee5f 100644 --- a/source/_components/sensor.raincloud.markdown +++ b/source/_components/sensor.raincloud.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: raincloud.jpg ha_category: Irrigation -ha_release: "0.55" -ha_iot_class: "Cloud Polling" +ha_release: 0.55 +ha_iot_class: Cloud Polling --- To get your [Melnor RainCloud](https://wifiaquatimer.com) sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). diff --git a/source/_components/sensor.random.markdown b/source/_components/sensor.random.markdown index 91787f6777f..526276c40a5 100644 --- a/source/_components/sensor.random.markdown +++ b/source/_components/sensor.random.markdown @@ -9,12 +9,11 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.32 ha_qa_scale: internal --- - The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. This can be useful if you want to test automation rules. It generates a new value every time it is polled. ## {% linkable_title Configuration %} @@ -48,4 +47,3 @@ unit_of_measurement: required: false type: string {% endconfiguration %} - diff --git a/source/_components/sensor.recollect_waste.markdown b/source/_components/sensor.recollect_waste.markdown index d9fc685b5b6..1e162c6d5f3 100644 --- a/source/_components/sensor.recollect_waste.markdown +++ b/source/_components/sensor.recollect_waste.markdown @@ -10,7 +10,7 @@ footer: true logo: recollect-waste.png ha_category: Sensor ha_release: 0.87 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `Recollect Waste` platform allows you to track the next scheduled waste pickup and what type of waste from [Recollect](https://recollect.net/solutions/waste/). To use this sensor your city's waste company must be Recollect and you will need to find your place_id and service_id. diff --git a/source/_components/sensor.reddit.markdown b/source/_components/sensor.reddit.markdown index 33abd9c9b03..11a2bdc4f8e 100644 --- a/source/_components/sensor.reddit.markdown +++ b/source/_components/sensor.reddit.markdown @@ -10,7 +10,7 @@ footer: true logo: reddit.png ha_category: Sensor ha_release: 0.89 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor your favorite subreddits. diff --git a/source/_components/sensor.rejseplanen.markdown b/source/_components/sensor.rejseplanen.markdown index 0252a207769..e75ffa22adc 100644 --- a/source/_components/sensor.rejseplanen.markdown +++ b/source/_components/sensor.rejseplanen.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: rejseplanen.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.88 --- @@ -26,7 +26,7 @@ sensor: stop_id: 'YOUR_STOP_ID' ``` -The `stop_id` can be obtained by looking up the name of the stop at this link: +The `stop_id` can be obtained by looking up the name of the stop at this link: (Replace "STOP_NAME" with city or location you want id for) diff --git a/source/_components/sensor.rest.markdown b/source/_components/sensor.rest.markdown index d215d76d690..1ecb146eae8 100644 --- a/source/_components/sensor.rest.markdown +++ b/source/_components/sensor.rest.markdown @@ -10,10 +10,9 @@ footer: true logo: restful.png ha_category: Sensor ha_release: 0.7.4 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- - The `rest` sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The sensor has support for GET and POST requests. To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: diff --git a/source/_components/sensor.rflink.markdown b/source/_components/sensor.rflink.markdown index d1741c17afd..4138003aa60 100644 --- a/source/_components/sensor.rflink.markdown +++ b/source/_components/sensor.rflink.markdown @@ -10,11 +10,13 @@ footer: true logo: rflink.png ha_category: Sensor ha_release: 0.38 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- 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). +## {% linkable_title Configuration %} + First, you have to set up your [RFLink hub](/components/rflink/). After configuring the RFLink hub, sensors will be automatically discovered and added. @@ -72,7 +74,7 @@ devices: type: [list, string] {% endconfiguration %} -### {% linkable_title Sensors types%} +## {% linkable_title Sensors types %} Sensor type values: @@ -109,7 +111,7 @@ Sensor type values: - windspeed - windtemp -### {% linkable_title Hiding/ignoring sensors %} +## {% linkable_title Hiding/ignoring sensors %} Sensors are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods: @@ -117,11 +119,11 @@ Sensors are added automatically when the RFLink gateway intercepts a wireless co - Hide unwanted devices using [customizations](/getting-started/customizing-devices/) - [Ignore devices on a platform level](/components/rflink/#ignoring-devices) -### {% linkable_title Device support %} +## {% linkable_title Device support %} See [device support](/components/rflink/#device-support) -### {% linkable_title Additional configuration examples %} +## {% linkable_title Additional configuration examples %} Multiple sensors with `automatic_add` disabled and `aliases` @@ -148,4 +150,3 @@ sensor: aliases: - xiron_4001_bat ``` - diff --git a/source/_components/sensor.rfxtrx.markdown b/source/_components/sensor.rfxtrx.markdown index 2fbb9dbaf24..480bc7602c6 100644 --- a/source/_components/sensor.rfxtrx.markdown +++ b/source/_components/sensor.rfxtrx.markdown @@ -9,7 +9,8 @@ sharing: true footer: true logo: rfxtrx.png ha_category: Sensor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling +ha_release: 0.7 --- The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz. @@ -115,6 +116,6 @@ automatic_add: {% endconfiguration %}

-If a device ID consists of only numbers, please make sure to surround it with quotes. +If a device ID consists of only numbers, please make sure to surround it with quotes. This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.

diff --git a/source/_components/sensor.ripple.markdown b/source/_components/sensor.ripple.markdown index 2eda5415059..48bf42a060a 100644 --- a/source/_components/sensor.ripple.markdown +++ b/source/_components/sensor.ripple.markdown @@ -10,10 +10,9 @@ footer: true logo: ripple.png ha_category: Finance ha_release: 0.47 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- - The `ripple` sensor platform displays Ripple wallet balances from [Ripple.com](https://ripple.com). To add the Ripple sensor to your installation, specify a ripple address to watch in the `configuration.yaml` file: @@ -36,4 +35,3 @@ name: type: string default: Ripple Balance {% endconfiguration %} - diff --git a/source/_components/sensor.rmvtransport.markdown b/source/_components/sensor.rmvtransport.markdown index 0f96c7bfb69..5bcde6f84dc 100644 --- a/source/_components/sensor.rmvtransport.markdown +++ b/source/_components/sensor.rmvtransport.markdown @@ -10,7 +10,7 @@ footer: true logo: RMV.png ha_category: Transport ha_release: 0.76 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes. diff --git a/source/_components/sensor.rova.markdown b/source/_components/sensor.rova.markdown index 9894a97afe8..a87293ea107 100644 --- a/source/_components/sensor.rova.markdown +++ b/source/_components/sensor.rova.markdown @@ -10,7 +10,7 @@ footer: true logo: rova.jpg ha_category: Sensor ha_release: 0.87 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- [ROVA](https://rova.nl) is a waste collection company that operates in the center and east of the Netherlands. The `rova` platform uses an unofficial [ROVA](https://rova.nl) API to allow you to get your waste collection schedule and integrate this in your Home Assistant installation. diff --git a/source/_components/sensor.rtorrent.markdown b/source/_components/sensor.rtorrent.markdown index 03dc91fe300..ab74a8f5ad1 100644 --- a/source/_components/sensor.rtorrent.markdown +++ b/source/_components/sensor.rtorrent.markdown @@ -10,7 +10,7 @@ footer: true logo: rtorrent.png ha_category: Downloading ha_release: 0.81 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `rtorrent` platform allows you to monitor your downloads with [rtorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information. diff --git a/source/_components/sensor.ruter.markdown b/source/_components/sensor.ruter.markdown index a67bb96fa02..04020649b01 100644 --- a/source/_components/sensor.ruter.markdown +++ b/source/_components/sensor.ruter.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: ruter.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.83 --- diff --git a/source/_components/sensor.scrape.markdown b/source/_components/sensor.scrape.markdown index bb20562e14a..e354f4ba66b 100644 --- a/source/_components/sensor.scrape.markdown +++ b/source/_components/sensor.scrape.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_category: Sensor ha_release: 0.31 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `scrape` sensor platform is scraping information from websites. The sensor loads a HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section. diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown index e6000b37eb8..b8822a56f85 100644 --- a/source/_components/sensor.season.markdown +++ b/source/_components/sensor.season.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Utility logo: home-assistant.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.53 ha_qa_scale: internal --- diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown index f2440de1c71..f2f52d454b4 100644 --- a/source/_components/sensor.sensehat.markdown +++ b/source/_components/sensor.sensehat.markdown @@ -10,7 +10,7 @@ footer: true logo: sense-hat.png ha_category: DIY ha_release: 0.35 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `sensehat` sensor platform allows you to display information collected by a [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) add-on board for Raspberry Pi. diff --git a/source/_components/sensor.serial.markdown b/source/_components/sensor.serial.markdown index 5386914e1da..c73d27cca9e 100644 --- a/source/_components/sensor.serial.markdown +++ b/source/_components/sensor.serial.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_category: Sensor ha_release: 0.56 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `serial` sensor platform is using the data provided by a device connected to the serial port of the system where Home Assistant is running. With [`ser2net`](http://ser2net.sourceforge.net/) and [`socat`](http://www.dest-unreach.org/socat/) would it also work for sensors connected to a remote system. diff --git a/source/_components/sensor.serial_pm.markdown b/source/_components/sensor.serial_pm.markdown index 0d93a15cd0b..992da28e91d 100644 --- a/source/_components/sensor.serial_pm.markdown +++ b/source/_components/sensor.serial_pm.markdown @@ -10,7 +10,7 @@ footer: true logo: serial_pm.png ha_category: DIY ha_release: 0.26 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- Particulate matter sensors measure the amount of very small particles in the air. A short introduction how these sensors work can be found on [Open Home Automation](https://www.open-homeautomation.com/2016/07/19/measuring-air-quality/). diff --git a/source/_components/sensor.seventeentrack.markdown b/source/_components/sensor.seventeentrack.markdown index 922f952187b..78f039b5d4f 100644 --- a/source/_components/sensor.seventeentrack.markdown +++ b/source/_components/sensor.seventeentrack.markdown @@ -10,7 +10,7 @@ footer: true logo: 17track.png ha_category: Postal Service ha_release: 0.83 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `seventeentrack` sensor platform allows users to get package data tied to their [17track.net](https://www.17track.net/en) account. The platform creates both summary sensors, which show the number of packages in a current state (e.g., "In Transit"), as well as individual sensors for each package within the account. diff --git a/source/_components/sensor.shodan.markdown b/source/_components/sensor.shodan.markdown index 4634d7cba7f..9df0e9c05ba 100644 --- a/source/_components/sensor.shodan.markdown +++ b/source/_components/sensor.shodan.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Sensor -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling logo: shodan.png ha_release: 0.51 --- diff --git a/source/_components/sensor.sht31.markdown b/source/_components/sensor.sht31.markdown index 07d17e1305c..58c6f9f8e22 100644 --- a/source/_components/sensor.sht31.markdown +++ b/source/_components/sensor.sht31.markdown @@ -10,7 +10,7 @@ footer: true ha_category: DIY ha_release: 0.68 logo: sensirion.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `sht31` sensor platform allows you to get the current temperature and humidity from a Sensirion SHT31 device. diff --git a/source/_components/sensor.sigfox.markdown b/source/_components/sensor.sigfox.markdown index 8491f48ae3a..6abb8e3ba7c 100644 --- a/source/_components/sensor.sigfox.markdown +++ b/source/_components/sensor.sigfox.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: sigfox.png ha_category: Sensor -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.68 --- diff --git a/source/_components/sensor.simulated.markdown b/source/_components/sensor.simulated.markdown index b54ecd4234d..6df63b03eb7 100644 --- a/source/_components/sensor.simulated.markdown +++ b/source/_components/sensor.simulated.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.65 ha_qa_scale: internal --- diff --git a/source/_components/sensor.skybeacon.markdown b/source/_components/sensor.skybeacon.markdown index d0bcc5522b1..8c6bfcaf756 100644 --- a/source/_components/sensor.skybeacon.markdown +++ b/source/_components/sensor.skybeacon.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: DIY ha_release: 0.37 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `skybeacon` sensor platform supports [CR2477](http://cnsky9.en.alibaba.com)-powered [iBeacon](https://en.wikipedia.org/wiki/IBeacon)/eddystone sensors that come with temperature/sensor module. diff --git a/source/_components/sensor.sma.markdown b/source/_components/sensor.sma.markdown index 588377c1a87..28f587161c0 100644 --- a/source/_components/sensor.sma.markdown +++ b/source/_components/sensor.sma.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Energy logo: sma.png -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.36 --- diff --git a/source/_components/sensor.snmp.markdown b/source/_components/sensor.snmp.markdown index 7cf6868a93f..03a46143ae9 100644 --- a/source/_components/sensor.snmp.markdown +++ b/source/_components/sensor.snmp.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: network-snmp.png ha_category: System Monitor -ha_iot_class: "Local Polling" -ha_release: "0.22" +ha_iot_class: Local Polling +ha_release: 0.22 --- The `snmp` sensor platform displays information available through the [Simple Network Management Protocol (SNMP)](https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol). SNMP uses a tree-like hierarchy where each node is an object, and is mainly supported by network-oriented devices such as routers, modems, and printers. diff --git a/source/_components/sensor.sochain.markdown b/source/_components/sensor.sochain.markdown index 246a920ed22..53d4395826d 100644 --- a/source/_components/sensor.sochain.markdown +++ b/source/_components/sensor.sochain.markdown @@ -10,7 +10,7 @@ footer: true logo: sochain.png ha_category: Finance ha_release: 0.61 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `SoChain` sensor platform displays supported cryptocurrency wallet balances from [SoChain](https://chain.so). diff --git a/source/_components/sensor.socialblade.markdown b/source/_components/sensor.socialblade.markdown index 521e2f71375..f81f2d53aae 100644 --- a/source/_components/sensor.socialblade.markdown +++ b/source/_components/sensor.socialblade.markdown @@ -10,7 +10,7 @@ footer: true logo: socialblade.png ha_category: Multimedia ha_release: 0.69 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `socialblade` sensor platform allows you get updates on a Youtube channel using your social blade channel ID. The sensor gets the subscribers and total views count from [Social Blade Website](https://socialblade.com). diff --git a/source/_components/sensor.solaredge.markdown b/source/_components/sensor.solaredge.markdown index 4959807488b..bee090d13b5 100644 --- a/source/_components/sensor.solaredge.markdown +++ b/source/_components/sensor.solaredge.markdown @@ -10,7 +10,7 @@ footer: true logo: solaredge.png ha_category: Sensor ha_release: 0.85 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `solaredge` platform uses the [SolarEdge Monitoring API](https://www.solaredge.com/sites/default/files/se_monitoring_api.pdf) to allow you to get details from your SolarEdge solar power setup and integrate these in your Home Assistant installation. diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index 8f02530b192..a0ec0f5039e 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -10,7 +10,7 @@ footer: true logo: sonarr.png ha_category: Downloading ha_release: 0.34 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance. diff --git a/source/_components/sensor.spotcrime.markdown b/source/_components/sensor.spotcrime.markdown index deab6188fab..33a36f2d19b 100644 --- a/source/_components/sensor.spotcrime.markdown +++ b/source/_components/sensor.spotcrime.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Social ha_release: 0.65 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](http://spotcrime.com). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via configuration.yaml. diff --git a/source/_components/sensor.srp_energy.markdown b/source/_components/sensor.srp_energy.markdown index 6488f4dc257..4be55a14ed4 100644 --- a/source/_components/sensor.srp_energy.markdown +++ b/source/_components/sensor.srp_energy.markdown @@ -6,8 +6,8 @@ date: 2018-10-30 08:00 sidebar: true comments: false ha_category: Energy -ha_release: "0.83" -ha_iot_class: "Cloud Polling" +ha_release: 0.83 +ha_iot_class: Cloud Polling --- The `srp_energy` component shows information from Srp hourly energy usage report for their customers. The srpenergy module fetches the data found on the website. diff --git a/source/_components/sensor.starlingbank.markdown b/source/_components/sensor.starlingbank.markdown index 852fbbb8203..f0333b7c034 100644 --- a/source/_components/sensor.starlingbank.markdown +++ b/source/_components/sensor.starlingbank.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: starlingbank.png ha_category: Finance -featured: false -ha_release: "0.79" -ha_iot_class: "Cloud Polling" +ha_release: 0.79 +ha_iot_class: Cloud Polling --- The Starling Bank sensor platform allows you to monitor your account balance data as sensors in Home Assistant. diff --git a/source/_components/sensor.startca.markdown b/source/_components/sensor.startca.markdown index c91b0a5b709..7d3907b83b0 100644 --- a/source/_components/sensor.startca.markdown +++ b/source/_components/sensor.startca.markdown @@ -10,7 +10,7 @@ footer: true logo: startca.png ha_category: Network ha_release: 0.64 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- Integrate your [Start.ca](https://www.start.ca/) account information into Home Assistant. diff --git a/source/_components/sensor.statistics.markdown b/source/_components/sensor.statistics.markdown index 75a1d8cd8f9..5ee656d2bef 100644 --- a/source/_components/sensor.statistics.markdown +++ b/source/_components/sensor.statistics.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Utility -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: "0.30" ha_qa_scale: internal --- diff --git a/source/_components/sensor.steam_online.markdown b/source/_components/sensor.steam_online.markdown index 7914ab33826..27b0000e246 100644 --- a/source/_components/sensor.steam_online.markdown +++ b/source/_components/sensor.steam_online.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: steam.png ha_category: Social -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.14 --- diff --git a/source/_components/sensor.supervisord.markdown b/source/_components/sensor.supervisord.markdown index 2e0464e0484..715e7a814a4 100644 --- a/source/_components/sensor.supervisord.markdown +++ b/source/_components/sensor.supervisord.markdown @@ -10,7 +10,7 @@ footer: true logo: supervisord.png ha_category: System Monitor ha_release: "0.20" -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `supervisord` platform allows you to track the states of [Supervisord](http://supervisord.org/). diff --git a/source/_components/sensor.swiss_hydrological_data.markdown b/source/_components/sensor.swiss_hydrological_data.markdown index 03283941fda..6e549beda02 100644 --- a/source/_components/sensor.swiss_hydrological_data.markdown +++ b/source/_components/sensor.swiss_hydrological_data.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: swiss-hydrological-data.png ha_category: Environment -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.22 --- diff --git a/source/_components/sensor.swiss_public_transport.markdown b/source/_components/sensor.swiss_public_transport.markdown index f58ab765f2b..5ae2364c5e4 100644 --- a/source/_components/sensor.swiss_public_transport.markdown +++ b/source/_components/sensor.swiss_public_transport.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: train.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: pre 0.7 --- diff --git a/source/_components/sensor.syncthru.markdown b/source/_components/sensor.syncthru.markdown index f2238dda257..f3cf870e3fd 100644 --- a/source/_components/sensor.syncthru.markdown +++ b/source/_components/sensor.syncthru.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: samsung.png ha_category: System Monitor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.66 --- diff --git a/source/_components/sensor.synologydsm.markdown b/source/_components/sensor.synologydsm.markdown index ee39a0c854d..777d88e9070 100644 --- a/source/_components/sensor.synologydsm.markdown +++ b/source/_components/sensor.synologydsm.markdown @@ -10,7 +10,7 @@ footer: true logo: synology.png ha_category: System Monitor ha_release: 0.32 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com). diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index e174bdb29e8..f344b5ed5ea 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -10,7 +10,7 @@ footer: true logo: system_monitor.png ha_category: System Monitor ha_release: pre 0.7 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `systemmonitor` sensor platform allows you to monitor disk usage, diff --git a/source/_components/sensor.sytadin.markdown b/source/_components/sensor.sytadin.markdown index aa0eb2524ff..608cb7bcc61 100644 --- a/source/_components/sensor.sytadin.markdown +++ b/source/_components/sensor.sytadin.markdown @@ -10,7 +10,7 @@ footer: true logo: sytadin.png ha_release: 0.57 ha_category: Transport -ha_iot_class: "Clound Polling" +ha_iot_class: Cloud Polling --- The `sytadin` sensor platform allows you to monitor traffic details from [Sytadin](http://www.sytadin.fr). diff --git a/source/_components/sensor.tank_utility.markdown b/source/_components/sensor.tank_utility.markdown index a77dbc4f3a3..0860b5e07be 100644 --- a/source/_components/sensor.tank_utility.markdown +++ b/source/_components/sensor.tank_utility.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: tank_utility.png ha_category: Energy -ha_release: "0.53" +ha_release: 0.53 --- Add [Tank Utility](https://www.tankutility.com/) propane tank monitors to Home Assistant. diff --git a/source/_components/sensor.tautulli.markdown b/source/_components/sensor.tautulli.markdown index 696c3d9362c..9b091c1ec3f 100644 --- a/source/_components/sensor.tautulli.markdown +++ b/source/_components/sensor.tautulli.markdown @@ -10,7 +10,7 @@ footer: true logo: tautulli.png ha_category: Sensor ha_release: 0.82 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `tautulli` sensor platform will monitor activity on a given [Tautulli Server][tautulli]. It will create a sensor that shows the number of currently active streams as the state. If you click the sensor for more details it will show you more statistics, the following stats are available by default: diff --git a/source/_components/sensor.tcp.markdown b/source/_components/sensor.tcp.markdown index 526c6d85e1f..4a1005af7ca 100644 --- a/source/_components/sensor.tcp.markdown +++ b/source/_components/sensor.tcp.markdown @@ -10,7 +10,7 @@ footer: true logo: tcp_ip.png ha_category: Sensor ha_release: 0.14 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The TCP component allows the integration of some services for which a specific Home Assistant component does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this component will allow integration with it. diff --git a/source/_components/sensor.ted5000.markdown b/source/_components/sensor.ted5000.markdown index 23e82fc9e3f..de188380a3b 100644 --- a/source/_components/sensor.ted5000.markdown +++ b/source/_components/sensor.ted5000.markdown @@ -10,7 +10,7 @@ footer: true logo: ted.png ha_category: Energy ha_release: "0.30" -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `ted 5000` monitors electricity consumption/production by connecting to the [TED](http://www.theenergydetective.com/home) gateway, itself connected to one or several Measuring Transmitting Units (MTU). The platform creates up to two sensors per MTU, one for Wattage the other for Voltage. diff --git a/source/_components/sensor.teksavvy.markdown b/source/_components/sensor.teksavvy.markdown index 0cf50bdf67a..a55d694b4e5 100644 --- a/source/_components/sensor.teksavvy.markdown +++ b/source/_components/sensor.teksavvy.markdown @@ -10,7 +10,7 @@ footer: true logo: teksavvy.png ha_category: Network ha_release: 0.62 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- Integrate your [TekSavvy](https://myaccount.teksavvy.com/) account information into Home Assistant. diff --git a/source/_components/sensor.temper.markdown b/source/_components/sensor.temper.markdown index c2452bdd1a2..6018de11c59 100644 --- a/source/_components/sensor.temper.markdown +++ b/source/_components/sensor.temper.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: DIY -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: pre 0.7 --- diff --git a/source/_components/sensor.template.markdown b/source/_components/sensor.template.markdown index 238407e63f1..581ec0945e8 100644 --- a/source/_components/sensor.template.markdown +++ b/source/_components/sensor.template.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Sensor ha_release: 0.12 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/sensor.thermoworks_smoke.markdown b/source/_components/sensor.thermoworks_smoke.markdown index c50ddfb8c39..2b8350b100f 100644 --- a/source/_components/sensor.thermoworks_smoke.markdown +++ b/source/_components/sensor.thermoworks_smoke.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: thermoworks.png ha_category: Sensor -ha_release: 0.81.0 -ha_iot_class: "Cloud Polling" +ha_release: 0.81 +ha_iot_class: Cloud Polling --- The `thermoworks_smoke` sensor platform pulls data for your [ThermoWorks Smoke Thermometer](https://www.thermoworks.com/Smoke). diff --git a/source/_components/sensor.thethingsnetwork.markdown b/source/_components/sensor.thethingsnetwork.markdown index b5a27540f1e..14c6ba6c585 100644 --- a/source/_components/sensor.thethingsnetwork.markdown +++ b/source/_components/sensor.thethingsnetwork.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: thethingsnetwork.png ha_category: Sensor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.55 --- diff --git a/source/_components/sensor.thinkingcleaner.markdown b/source/_components/sensor.thinkingcleaner.markdown index af6979bed2a..ebf654dc92c 100644 --- a/source/_components/sensor.thinkingcleaner.markdown +++ b/source/_components/sensor.thinkingcleaner.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: thinkingcleaner.png ha_category: Sensor -ha_iot_class: "Local Poll" +ha_iot_class: Local Polling ha_release: 0.18 --- diff --git a/source/_components/sensor.time_date.markdown b/source/_components/sensor.time_date.markdown index 2f7d8d94981..69a49706e00 100644 --- a/source/_components/sensor.time_date.markdown +++ b/source/_components/sensor.time_date.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Calendar -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: pre 0.7 ha_qa_scale: internal --- diff --git a/source/_components/sensor.torque.markdown b/source/_components/sensor.torque.markdown index 0718190858d..fc8c3c13208 100644 --- a/source/_components/sensor.torque.markdown +++ b/source/_components/sensor.torque.markdown @@ -10,7 +10,7 @@ footer: true logo: torque.png ha_category: Car ha_release: "0.10" -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `torque` platform will allow you to monitor [Torque](http://torque-bhp.com/) data relayed from a Bluetooth OBD2 stick via the Torque mobile application. diff --git a/source/_components/sensor.trafikverket_weatherstation.markdown b/source/_components/sensor.trafikverket_weatherstation.markdown index e0cf88bf535..9fe7ef4d92a 100644 --- a/source/_components/sensor.trafikverket_weatherstation.markdown +++ b/source/_components/sensor.trafikverket_weatherstation.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: trafikverket.png ha_category: Weather -ha_release: 0.66.0 -ha_iot_class: "Cloud Polling" +ha_release: 0.66 +ha_iot_class: Cloud Polling --- Showing weather information provided by [Trafikverket](https://www.trafikverket.se/) weather stations in Sweden. @@ -42,36 +42,36 @@ sensor: ``` {% configuration %} -name: - description: Your unique name of the device in the frontend. - required: true +name: + description: Your unique name of the device in the frontend. + required: true + type: string +api_key: + description: Your personal API key from Trafikverket. + required: true + type: string +station: + description: Name of the weather station from Trafikverket. + required: true type: string -api_key: - description: Your personal API key from Trafikverket. - required: true - type: string -station: - description: Name of the weather station from Trafikverket. - required: true - type: string monitored_conditions: description: Specify what measurement data to retrieve from the weather station. - required: true - type: map + required: true + type: map keys: - air_temp: - description: Air temperature. - road_temp: - description: The temperature in the road. - humidity: - description: Relative humidity. - precipitation: - description: Type of precipitation (Swedish text). - wind_direction: - description: Wind direction in degrees. - wind_direction_text: - description: Rough wind direction in twelve variants (Swedish text). - wind_speed: + air_temp: + description: Air temperature. + road_temp: + description: The temperature in the road. + humidity: + description: Relative humidity. + precipitation: + description: Type of precipitation (Swedish text). + wind_direction: + description: Wind direction in degrees. + wind_direction_text: + description: Rough wind direction in twelve variants (Swedish text). + wind_speed: description: Average wind speed during the last 10 minutes. {% endconfiguration %} diff --git a/source/_components/sensor.transport_nsw.markdown b/source/_components/sensor.transport_nsw.markdown index fc72f408cdc..e1145400379 100644 --- a/source/_components/sensor.transport_nsw.markdown +++ b/source/_components/sensor.transport_nsw.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: transport_nsw.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.81 --- diff --git a/source/_components/sensor.travisci.markdown b/source/_components/sensor.travisci.markdown index 262f7359d71..dde3c037e59 100644 --- a/source/_components/sensor.travisci.markdown +++ b/source/_components/sensor.travisci.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: travisci.svg ha_category: Sensor -ha_release: "0.56" -ha_iot_class: "Cloud Polling" +ha_release: 0.56 +ha_iot_class: Cloud Polling --- With this sensor platform, you will be able to integrate the test build results reported by [Travis-CI](https://travis-ci.org/) working within Home Assistant. diff --git a/source/_components/sensor.twitch.markdown b/source/_components/sensor.twitch.markdown index 7d692ebbac1..f37ad619d68 100644 --- a/source/_components/sensor.twitch.markdown +++ b/source/_components/sensor.twitch.markdown @@ -10,7 +10,7 @@ footer: true logo: twitch.png ha_category: Social ha_release: "0.10" -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `twitch` platform will allow you to monitor [Twitch](http://www.twitch.tv/) channel status from within Home Assistant and setup automation based on the information. diff --git a/source/_components/sensor.uber.markdown b/source/_components/sensor.uber.markdown index 3f151040a92..c3129d48c45 100644 --- a/source/_components/sensor.uber.markdown +++ b/source/_components/sensor.uber.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: uber.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.16 --- diff --git a/source/_components/sensor.uk_transport.markdown b/source/_components/sensor.uk_transport.markdown index ce0d0e813b0..f1128acdd6d 100644 --- a/source/_components/sensor.uk_transport.markdown +++ b/source/_components/sensor.uk_transport.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: train.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: "0.50" --- diff --git a/source/_components/sensor.upnp.markdown b/source/_components/sensor.upnp.markdown index c38417a1b0e..4f0ab268aa7 100644 --- a/source/_components/sensor.upnp.markdown +++ b/source/_components/sensor.upnp.markdown @@ -10,7 +10,7 @@ footer: true logo: upnp.png ha_category: Network ha_release: 0.48 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `upnp` sensor platform allows one to get the network statistics from your router such as bytes in/out and packets in/out. diff --git a/source/_components/sensor.ups.markdown b/source/_components/sensor.ups.markdown index 2b57a0e2663..1298a7efdec 100644 --- a/source/_components/sensor.ups.markdown +++ b/source/_components/sensor.ups.markdown @@ -10,7 +10,7 @@ footer: true logo: ups.png ha_category: Postal Service ha_release: 0.39 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `ups` platform allows one to track deliveries by the [UPS](https://www.ups.com/). To use this sensor, you need a [My UPS Account](https://www.ups.com/mychoice). diff --git a/source/_components/sensor.uptime.markdown b/source/_components/sensor.uptime.markdown index 665cfe9bc43..87a00b3dfba 100644 --- a/source/_components/sensor.uptime.markdown +++ b/source/_components/sensor.uptime.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Utility -ha_iot_class: "Local Pushing" +ha_iot_class: Local Push logo: home-assistant.png ha_release: 0.56 ha_qa_scale: internal diff --git a/source/_components/sensor.uscis.markdown b/source/_components/sensor.uscis.markdown index 8dbedc2a3cb..21ce1dc30bb 100644 --- a/source/_components/sensor.uscis.markdown +++ b/source/_components/sensor.uscis.markdown @@ -10,7 +10,7 @@ footer: true logo: uscis.png ha_category: Sensor ha_release: 0.68 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `uscis` sensor component allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) diff --git a/source/_components/sensor.vasttrafik.markdown b/source/_components/sensor.vasttrafik.markdown index 76264932dec..0e1b520d571 100644 --- a/source/_components/sensor.vasttrafik.markdown +++ b/source/_components/sensor.vasttrafik.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: vasttrafik.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: "0.30" --- diff --git a/source/_components/sensor.version.markdown b/source/_components/sensor.version.markdown index edc8c29b572..955dd92d1e9 100644 --- a/source/_components/sensor.version.markdown +++ b/source/_components/sensor.version.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true ha_category: Utility -ha_iot_class: "Local Pushing" +ha_iot_class: Local Push logo: home-assistant.png ha_release: 0.52 ha_qa_scale: internal diff --git a/source/_components/sensor.viaggiatreno.markdown b/source/_components/sensor.viaggiatreno.markdown index a8c4c8c1678..713c228a9e6 100644 --- a/source/_components/sensor.viaggiatreno.markdown +++ b/source/_components/sensor.viaggiatreno.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: train.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.58 --- diff --git a/source/_components/sensor.volkszaehler.markdown b/source/_components/sensor.volkszaehler.markdown index 06bae90dc2c..3832ef4ab4a 100644 --- a/source/_components/sensor.volkszaehler.markdown +++ b/source/_components/sensor.volkszaehler.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: volkszaehler.png ha_category: System Monitor -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.78 --- diff --git a/source/_components/sensor.waqi.markdown b/source/_components/sensor.waqi.markdown index f428d28db64..ad17ace10b3 100644 --- a/source/_components/sensor.waqi.markdown +++ b/source/_components/sensor.waqi.markdown @@ -10,7 +10,7 @@ footer: true logo: waqi.png ha_category: Health ha_release: 0.34 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `waqi` sensor platform will query [World Air Quality Index](http://aqicn.org) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs. diff --git a/source/_components/sensor.waze_travel_time.markdown b/source/_components/sensor.waze_travel_time.markdown index ba24f4da73e..9be952e3bf0 100644 --- a/source/_components/sensor.waze_travel_time.markdown +++ b/source/_components/sensor.waze_travel_time.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: waze.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.67 --- diff --git a/source/_components/sensor.whois.markdown b/source/_components/sensor.whois.markdown index 596f12e802c..c77a166925d 100644 --- a/source/_components/sensor.whois.markdown +++ b/source/_components/sensor.whois.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: icann.png ha_category: Network -ha_release: "0.57" -ha_iot_class: "Cloud Polling" +ha_release: 0.57 +ha_iot_class: Cloud Polling --- The `whois` sensor platform allows you to perform daily WHOIS lookups against your owned domains. This provides you with information such as `expiration_date`, `name_servers` and `registrar` details. diff --git a/source/_components/sensor.worldclock.markdown b/source/_components/sensor.worldclock.markdown index d8236a2809b..926611c62b9 100644 --- a/source/_components/sensor.worldclock.markdown +++ b/source/_components/sensor.worldclock.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: home-assistant.png ha_category: Calendar -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: pre 0.7 ha_qa_scale: internal --- diff --git a/source/_components/sensor.worxlandroid.markdown b/source/_components/sensor.worxlandroid.markdown index d4ec6b401b8..f769e82e8e5 100644 --- a/source/_components/sensor.worxlandroid.markdown +++ b/source/_components/sensor.worxlandroid.markdown @@ -10,7 +10,7 @@ footer: true logo: worx.png ha_category: DIY ha_release: 0.54 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `worxlandroid` sensor platform allows you to get the current state, battery level and error status Worx Landroid WG796E.1 or WG797E. diff --git a/source/_components/sensor.wsdot.markdown b/source/_components/sensor.wsdot.markdown index f3f911a94bf..c19ef83041e 100644 --- a/source/_components/sensor.wsdot.markdown +++ b/source/_components/sensor.wsdot.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: wsdot.png ha_category: Transport -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.37 --- diff --git a/source/_components/sensor.wunderground.markdown b/source/_components/sensor.wunderground.markdown index ad6595b491c..7a304510cb8 100644 --- a/source/_components/sensor.wunderground.markdown +++ b/source/_components/sensor.wunderground.markdown @@ -10,7 +10,7 @@ footer: true logo: wunderground.png ha_category: Weather ha_release: 0.27 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `wunderground` platform uses [Weather Underground](http://www.wunderground.com) as a source for current weather information. diff --git a/source/_components/sensor.xbox_live.markdown b/source/_components/sensor.xbox_live.markdown index 3311c4f2023..79bc51317ab 100644 --- a/source/_components/sensor.xbox_live.markdown +++ b/source/_components/sensor.xbox_live.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: xbox-live.png ha_category: Social -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.28 --- diff --git a/source/_components/sensor.xiaomi_aqara.markdown b/source/_components/sensor.xiaomi_aqara.markdown index 5dfb310c1eb..5e25404c571 100644 --- a/source/_components/sensor.xiaomi_aqara.markdown +++ b/source/_components/sensor.xiaomi_aqara.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Sensor ha_release: "0.50" -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `xiaomi aqara` sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) sensors. diff --git a/source/_components/sensor.xiaomi_miio.markdown b/source/_components/sensor.xiaomi_miio.markdown index c5a1bebe3bf..2634250a37e 100644 --- a/source/_components/sensor.xiaomi_miio.markdown +++ b/source/_components/sensor.xiaomi_miio.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: xiaomi.png ha_category: Health -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.66 --- diff --git a/source/_components/sensor.yr.markdown b/source/_components/sensor.yr.markdown index c08417e32bf..fd6e0446721 100644 --- a/source/_components/sensor.yr.markdown +++ b/source/_components/sensor.yr.markdown @@ -10,7 +10,7 @@ footer: true logo: yr.png ha_category: Weather ha_release: 0.11 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `yr` platform uses [YR.no](http://www.yr.no/) as a source for current diff --git a/source/_components/sensor.yweather.markdown b/source/_components/sensor.yweather.markdown index 9c28369fca4..7dee4d34a86 100644 --- a/source/_components/sensor.yweather.markdown +++ b/source/_components/sensor.yweather.markdown @@ -10,7 +10,7 @@ footer: true logo: yahooweather.png ha_category: Weather ha_release: 0.24 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ---

diff --git a/source/_components/sensor.zabbix.markdown b/source/_components/sensor.zabbix.markdown index 6ef21a99da8..bb5b3118114 100644 --- a/source/_components/sensor.zabbix.markdown +++ b/source/_components/sensor.zabbix.markdown @@ -10,7 +10,7 @@ footer: true logo: zabbix.png ha_category: System Monitor ha_release: 0.37 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `zabbix` sensor platform let you monitor the current count of active triggers for your [Zabbix](http://www.zabbix.com/) monitoring instance. diff --git a/source/_components/sensor.zamg.markdown b/source/_components/sensor.zamg.markdown index f1d25e0626b..1d87b5c434f 100644 --- a/source/_components/sensor.zamg.markdown +++ b/source/_components/sensor.zamg.markdown @@ -10,7 +10,7 @@ footer: true logo: zamg.png ha_category: Weather ha_release: 0.35 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `zamg` platform uses meteorological details published by the Austrian weather service [Zentralanstalt für Meteorologie und Geodynamik (ZAMG)](https://www.zamg.ac.at). diff --git a/source/_components/sensor.zestimate.markdown b/source/_components/sensor.zestimate.markdown index cba781e2330..c0f2bd54b69 100644 --- a/source/_components/sensor.zestimate.markdown +++ b/source/_components/sensor.zestimate.markdown @@ -10,7 +10,7 @@ footer: true ha_category: Sensor logo: zillow.png ha_release: 0.65 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `zestimate` sensor allows one to track the Zestimate® value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). According to Zillow's website, a Zestimate® home valuation is Zillow's estimated market value. It is not an appraisal. Use it as a starting point to determine a home's value. The Zestimate® is provided by [Zillow](https://www.zillow.com), a website primarily for listing homes to buy/sell/rent in the United States. diff --git a/source/_components/sensor.zigbee.markdown b/source/_components/sensor.zigbee.markdown index 4eabd0b71d2..bebac96417d 100644 --- a/source/_components/sensor.zigbee.markdown +++ b/source/_components/sensor.zigbee.markdown @@ -10,7 +10,7 @@ footer: true logo: zigbee.png ha_category: Sensor ha_release: 0.12 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- There are two types of [Zigbee](http://www.zigbee.org/) sensor available to Home Assistant: diff --git a/source/_components/shell_command.markdown b/source/_components/shell_command.markdown index 15f81dea59d..df69ac00364 100644 --- a/source/_components/shell_command.markdown +++ b/source/_components/shell_command.markdown @@ -10,6 +10,7 @@ footer: true ha_category: Automation logo: home-assistant.png ha_qa_scale: internal +ha_release: 0.7.6 --- This component can expose regular shell commands as services. Services can be called from a [script] or in [automation]. diff --git a/source/_components/shiftr.markdown b/source/_components/shiftr.markdown index 77997625dec..96f5aa2c548 100644 --- a/source/_components/shiftr.markdown +++ b/source/_components/shiftr.markdown @@ -9,7 +9,6 @@ sharing: true footer: true logo: shiftr.png ha_category: "History" -featured: false ha_release: 0.48 --- diff --git a/source/_components/sisyphus.markdown b/source/_components/sisyphus.markdown index 1bdaed901f9..6b7476276a9 100644 --- a/source/_components/sisyphus.markdown +++ b/source/_components/sisyphus.markdown @@ -12,9 +12,8 @@ ha_category: - Hub - Light - Media Player -featured: false ha_release: 0.75 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/light.sisyphus/ - /components/media_player.sisyphus/ diff --git a/source/_components/skybell.markdown b/source/_components/skybell.markdown index 0d5f2e02973..f63575388a8 100644 --- a/source/_components/skybell.markdown +++ b/source/_components/skybell.markdown @@ -16,7 +16,7 @@ ha_category: - Sensor - Switch ha_release: 0.56 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.skybell/ - /components/camera.skybell/ diff --git a/source/_components/sleepiq.markdown b/source/_components/sleepiq.markdown index 6baf6193649..5676a4bc4f8 100644 --- a/source/_components/sleepiq.markdown +++ b/source/_components/sleepiq.markdown @@ -13,7 +13,7 @@ ha_category: - Sensor - Binary Sensor ha_release: 0.29 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.sleepiq/ - /components/sensor.sleepiq/ diff --git a/source/_components/smappee.markdown b/source/_components/smappee.markdown index ec4c9cf372b..84d4cec5973 100644 --- a/source/_components/smappee.markdown +++ b/source/_components/smappee.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: smappee.png -ha_release: "0.64" +ha_release: 0.64 ha_category: - Hub - Energy - Sensor - Switch -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/sensor.smappee/ - /components/switch.smappee/ diff --git a/source/_components/smartthings.markdown b/source/_components/smartthings.markdown index c48fce6e8d6..273324bccb7 100644 --- a/source/_components/smartthings.markdown +++ b/source/_components/smartthings.markdown @@ -20,8 +20,8 @@ ha_category: - Sensor - Scene - Switch -ha_release: "0.87" -ha_iot_class: "Cloud Push" +ha_release: 0.87 +ha_iot_class: Cloud Push redirect_from: - /components/smartthings.binary_sensor/ - /components/binary_sensor.smartthings/ @@ -56,7 +56,6 @@ See it in action, with a step-by-step setup guide, thanks to a fan! (v0.87 featu - ## {% linkable_title Basic requirements %} The SmartThings integration utilizes a webhook to receive push updates from the SmartThings cloud through either a cloudhook or an internet accessible webhook based on whether Home Assistant Cloud is configured and logged in with a non-expired subscription (this is not configurable at this time). @@ -140,11 +139,12 @@ Event data payloads are logged at the debug level, see [debugging](#debugging) f ## {% linkable_title Platforms %} SmartThings represents devices as a set of [capabilities](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html) and the SmartThings component maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms. + - [Binary Sensor](#binary-sensor) - [Climate](#climate) - [Cover](#cover) -- [Fan](#fan) -- [Light](#light) +- [Fan](#fan) +- [Light](#light) - [Lock](#lock) - [Sensor](#sensor) - [Scene](#scene) @@ -307,7 +307,6 @@ The SmartThings Switch platform lets you control devices that have the [`switch` | [`energyMeter`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Energy-Meter) | energy consumption (`today_energy_kwh` state attribute) | [`powerMeter`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Power-Meter) | power consumption (`current_power_w` state attribute) - ## {% linkable_title Troubleshooting %} ### {% linkable_title Setup %} diff --git a/source/_components/smhi.markdown b/source/_components/smhi.markdown index d9f03f22d95..24564fc4e5e 100644 --- a/source/_components/smhi.markdown +++ b/source/_components/smhi.markdown @@ -12,7 +12,7 @@ ha_category: - Hub - Weather ha_release: 0.81 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/weather.smhi/ --- diff --git a/source/_components/sonos.markdown b/source/_components/sonos.markdown index e78ecb0a220..3c9d4e4c688 100644 --- a/source/_components/sonos.markdown +++ b/source/_components/sonos.markdown @@ -11,7 +11,7 @@ logo: sonos.png ha_category: Media Player featured: true ha_release: 0.7.3 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: /components/media_player.sonos/ --- diff --git a/source/_components/spc.markdown b/source/_components/spc.markdown index 2b2de62dc00..a91ac7078f0 100644 --- a/source/_components/spc.markdown +++ b/source/_components/spc.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor ha_release: 0.47 logo: vanderbilt_spc.png -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.spc/ - /components/alarm_control_panel.spc/ diff --git a/source/_components/speedtestdotnet.markdown b/source/_components/speedtestdotnet.markdown index a6386845bb3..6ff3c58da95 100644 --- a/source/_components/speedtestdotnet.markdown +++ b/source/_components/speedtestdotnet.markdown @@ -11,9 +11,8 @@ logo: speedtest.png ha_category: - System Monitor - Sensor -featured: false ha_release: 0.13 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/sensor.speedtest/ - /components/sensor.speedtestdotnet/ @@ -27,8 +26,7 @@ By default, a speed test will be run every hour. The user can change the update ## {% linkable_title Configuration %} -For the `server_id` check the list of -[available servers](https://www.speedtest.net/speedtest-servers.php). +For the `server_id` check the list of [available servers](https://www.speedtest.net/speedtest-servers.php). To add Speedtest.net sensors to your installation, add the following to your `configuration.yaml` file: @@ -40,36 +38,35 @@ speedtestdotnet: ``` {% configuration %} - monitored_conditions: - description: Sensors to display in the frontend. - required: false - default: All keys - type: list - keys: - ping: - description: Reaction time in ms of your connection (how fast you get a response after you've sent out a request). - download: - description: Download speed (Mbit/s) - upload: - description: Upload speed (Mbit/s) - server_id: - description: Specify the speed test server to perform the test against. - required: false - type: integer - scan_interval: - description: "Minimum time interval between updates. Supported formats: `scan_interval: 'HH:MM:SS'`, `scan_interval: 'HH:MM'` and Time period dictionary (see example below)." - required: false - default: 60 minutes - type: time - manual: - description: > - `true` or `false` to turn manual mode on or off. Manual mode will disable scheduled speed tests. - required: false - type: boolean - default: false +monitored_conditions: + description: Sensors to display in the frontend. + required: false + default: All keys + type: list + keys: + ping: + description: "Reaction time in ms of your connection (how fast you get a response after you've sent out a request)." + download: + description: "The download speed (Mbit/s)." + upload: + description: "The upload speed (Mbit/s)." +server_id: + description: Specify the speed test server to perform the test against. + required: false + type: integer +scan_interval: + description: "Minimum time interval between updates. Supported formats: `scan_interval: 'HH:MM:SS'`, `scan_interval: 'HH:MM'` and Time period dictionary (see example below)." + required: false + default: 60 minutes + type: time +manual: + description: "`true` or `false` to turn manual mode on or off. Manual mode will disable scheduled speed tests." + required: false + type: boolean + default: false {% endconfiguration %} -#### {% linkable_title Time period dictionary example %} +### {% linkable_title Time period dictionary example %} ```yaml scan_interval: @@ -90,16 +87,10 @@ action: service: speedtestdotnet.speedtest ``` -This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to -gather network performance data from Speedtest.net. -Please be aware of the potential -[inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that -this component may display. +This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. +Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display. -When Home Assistant first starts up, the values of the speed test will show as -`Unknown`. You can use the service `sensor.update_speedtest` to run a manual -speed test and populate the data or just wait for the next regularly scheduled -test. You can turn on manual mode to disable the scheduled speed tests. +When Home Assistant first starts up, the values of the speed test will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests. ## {% linkable_title Examples %} @@ -144,7 +135,7 @@ automation: ## {% linkable_title Notes %} -- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. +- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. The Raspberry Pi 3+ models comes with a Gigabit LAN adapter which supports a [maximum throughput](https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus/) of 300 Mbit/s. - Running this component can have negative effects on the system's performance as it requires a fair amount of memory. - Entries under `monitored_conditions` only control what entities are available in Home Assistant, it does not disable the condition from running. - If ran frequently, this component has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections. diff --git a/source/_components/spider.markdown b/source/_components/spider.markdown index 272ddba9238..244e0e33416 100644 --- a/source/_components/spider.markdown +++ b/source/_components/spider.markdown @@ -12,7 +12,7 @@ ha_category: - Hub - Climate - Switch -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.75 redirect_from: - /components/switch.spider/ @@ -59,4 +59,4 @@ This component is not affiliated with Itho Daalderop Spider and retrieves data f

Although this component lets you change the operation mode to heating or cooling, it doesn't necessarily mean your boiler can. Spider is not aware of your current situation. -

\ No newline at end of file +

diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index 94da2e561c4..90b2597b266 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Environment ha_qa_scale: internal +ha_release: pre 0.7 --- The sun component will use your current location to track if the sun is above or diff --git a/source/_components/switch.acer_projector.markdown b/source/_components/switch.acer_projector.markdown index 8e29186e2e8..a5914b46a18 100644 --- a/source/_components/switch.acer_projector.markdown +++ b/source/_components/switch.acer_projector.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: acer.png ha_category: Multimedia -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.19 --- diff --git a/source/_components/switch.anel_pwrctrl.markdown b/source/_components/switch.anel_pwrctrl.markdown index 9b851f5dfbe..395ee4bf8e8 100644 --- a/source/_components/switch.anel_pwrctrl.markdown +++ b/source/_components/switch.anel_pwrctrl.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: anel.png ha_category: Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: "0.30" --- diff --git a/source/_components/switch.arduino.markdown b/source/_components/switch.arduino.markdown index 5cc9f87d9b1..d78b535d4d8 100644 --- a/source/_components/switch.arduino.markdown +++ b/source/_components/switch.arduino.markdown @@ -10,7 +10,7 @@ footer: true logo: arduino.png ha_category: DIY ha_release: pre 0.7 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `arduino` switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3, 5, 6, 9, 10, and 11 on an Arduino Uno) is not supported yet. diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index 4b27e680d44..d34d5da2223 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: arest.png ha_category: DIY -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.16 --- diff --git a/source/_components/switch.broadlink.markdown b/source/_components/switch.broadlink.markdown index 760aee5d295..7e0c4d82a42 100644 --- a/source/_components/switch.broadlink.markdown +++ b/source/_components/switch.broadlink.markdown @@ -10,7 +10,7 @@ footer: true logo: broadlink.png ha_category: Switch ha_release: 0.35 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- This `Broadlink` switch platform allow to you control Broadlink [devices](http://www.ibroadlink.com/). @@ -234,14 +234,14 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro sudo python setup.py install ``` -7. Test the codes - Use the `sendcode` script you have already downloaded to test the codes you got from the device. - You need to edit the script with your RM Pro IP Address and MAC Address and with the code in HEX format. - When run the script, you know the code works when get message. - Code sent... - Not every code works. +7. Test the codes + Use the `sendcode` script you have already downloaded to test the codes you got from the device. + You need to edit the script with your RM Pro IP Address and MAC Address and with the code in HEX format. + When run the script, you know the code works when get message. + Code sent... + Not every code works. -8. Convert the HEX codes to base64. +8. Convert the HEX codes to base64. Use [this](http://tomeko.net/online_tools/hex_to_base64.php?lang=en1) tool to convert the hex codes to base64 for use with Home Assistant. ## {% linkable_title Using iOS and Windows to Obtain Codes %} diff --git a/source/_components/switch.command_line.markdown b/source/_components/switch.command_line.markdown index 5811eb9a6e4..24ad7147c01 100644 --- a/source/_components/switch.command_line.markdown +++ b/source/_components/switch.command_line.markdown @@ -10,7 +10,7 @@ footer: true logo: command_line.png ha_category: Switch ha_release: pre 0.7 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `command_line` switch platform issues specific commands when it is turned on diff --git a/source/_components/switch.danfoss_air.markdown b/source/_components/switch.danfoss_air.markdown index 6203a9a1041..fa42feb6fce 100644 --- a/source/_components/switch.danfoss_air.markdown +++ b/source/_components/switch.danfoss_air.markdown @@ -10,13 +10,13 @@ footer: true logo: danfoss_air.png ha_category: Switch ha_release: 0.89 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ---

To get your Danfoss Air sensors working with Home Assistant, follow the instructions for the general [Danfoss Air component](/components/danfoss_air/).

- The following switches. + * **Boost:** Switch to manually activate boost. diff --git a/source/_components/switch.deluge.markdown b/source/_components/switch.deluge.markdown index 0d6b41864c2..b07d7abb23b 100644 --- a/source/_components/switch.deluge.markdown +++ b/source/_components/switch.deluge.markdown @@ -10,7 +10,7 @@ footer: true logo: deluge.png ha_category: Downloading ha_release: 0.57 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `deluge` switch platform allows you to control your [Deluge](http://deluge-torrent.org/) client from within Home Assistant. The platform enables you switch all your torrents in pause, and then unpause them all. diff --git a/source/_components/switch.digitalloggers.markdown b/source/_components/switch.digitalloggers.markdown index 6b75f331da9..00c8522ae68 100644 --- a/source/_components/switch.digitalloggers.markdown +++ b/source/_components/switch.digitalloggers.markdown @@ -10,7 +10,7 @@ footer: true logo: digitalloggers.png ha_category: Switch ha_release: 0.35 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](http://www.digital-loggers.com/dinfaqs.html) switches. diff --git a/source/_components/switch.dlink.markdown b/source/_components/switch.dlink.markdown index ea148580b77..39014950382 100644 --- a/source/_components/switch.dlink.markdown +++ b/source/_components/switch.dlink.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: dlink.png ha_category: Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.14 --- diff --git a/source/_components/switch.fritzdect.markdown b/source/_components/switch.fritzdect.markdown index 269cc207b4c..32a74970601 100644 --- a/source/_components/switch.fritzdect.markdown +++ b/source/_components/switch.fritzdect.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: avm.png ha_category: Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.38 --- diff --git a/source/_components/switch.hook.markdown b/source/_components/switch.hook.markdown index 71ef1bc45c6..d9ababf9ff9 100644 --- a/source/_components/switch.hook.markdown +++ b/source/_components/switch.hook.markdown @@ -8,7 +8,7 @@ sharing: true footer: true logo: hook.png ha_category: Switch -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State ha_release: 0.34 --- diff --git a/source/_components/switch.ihc.markdown b/source/_components/switch.ihc.markdown index 14958dd106d..1a56406e408 100644 --- a/source/_components/switch.ihc.markdown +++ b/source/_components/switch.ihc.markdown @@ -10,7 +10,7 @@ footer: true logo: ihc.png ha_category: Switch ha_release: 0.62 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- Before you can use the IHC Switch platform, you must setup the diff --git a/source/_components/switch.kankun.markdown b/source/_components/switch.kankun.markdown index 68e715784a5..d9192cd6b12 100644 --- a/source/_components/switch.kankun.markdown +++ b/source/_components/switch.kankun.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Switch ha_release: 0.36 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `kankun` switch platform allows you to toggle customized Kankun SP3 Wifi switches. Switches are diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index 5b712dc043a..6e23cbed541 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -10,7 +10,7 @@ footer: true logo: knx.png ha_category: Switch ha_release: 0.24 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `knx` switch component is used as in interface to switching actuators. diff --git a/source/_components/switch.markdown b/source/_components/switch.markdown index 0ea76993aaa..097a394df9b 100644 --- a/source/_components/switch.markdown +++ b/source/_components/switch.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.7 --- Keeps track which switches are in your environment, their state and allows you to control them. diff --git a/source/_components/switch.mfi.markdown b/source/_components/switch.mfi.markdown index 19a5f58d8d4..83614f77826 100644 --- a/source/_components/switch.mfi.markdown +++ b/source/_components/switch.mfi.markdown @@ -9,7 +9,8 @@ sharing: true footer: true logo: ubiquiti.png ha_category: Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling +ha_release: 0.13 --- The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/). diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown index c31dc5c458a..1b0c5bda964 100644 --- a/source/_components/switch.modbus.markdown +++ b/source/_components/switch.modbus.markdown @@ -10,7 +10,7 @@ footer: true logo: modbus.png ha_category: Switch ha_release: pre 0.7 -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers. diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index 8e45fba36ce..ca62ceb039d 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -10,7 +10,7 @@ footer: true logo: mqtt.png ha_category: Switch ha_release: 0.7 -ha_iot_class: depends +ha_iot_class: Configurable --- The `mqtt` switch platform lets you control your MQTT enabled switches. diff --git a/source/_components/switch.mysensors.markdown b/source/_components/switch.mysensors.markdown index d4a360f87ec..bdd54a95c93 100644 --- a/source/_components/switch.mysensors.markdown +++ b/source/_components/switch.mysensors.markdown @@ -11,8 +11,8 @@ logo: mysensors.png ha_category: - DIY - Switch -featured: false -ha_iot_class: "Local Push" +ha_iot_class: Local Push +ha_release: 0.11 --- Integrates MySensors switches into Home Assistant. See the [main component] for configuration instructions. diff --git a/source/_components/switch.mystrom.markdown b/source/_components/switch.mystrom.markdown index 1d7627af32f..86d96813386 100644 --- a/source/_components/switch.mystrom.markdown +++ b/source/_components/switch.mystrom.markdown @@ -10,7 +10,7 @@ footer: true logo: mystrom.png ha_category: Switch ha_release: 0.9 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/en/) switches. The built-in sensor is measuring the power consumption while the switch is on. diff --git a/source/_components/switch.netio.markdown b/source/_components/switch.netio.markdown index c50157850d0..a66131c5f65 100644 --- a/source/_components/switch.netio.markdown +++ b/source/_components/switch.netio.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: netio.png ha_category: Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.24 --- diff --git a/source/_components/switch.orvibo.markdown b/source/_components/switch.orvibo.markdown index fb94b023439..0430047849a 100644 --- a/source/_components/switch.orvibo.markdown +++ b/source/_components/switch.orvibo.markdown @@ -9,6 +9,7 @@ sharing: true footer: true logo: orvibo.png ha_category: Switch +ha_release: 0.8 --- The `orvibo` switch platform allows you to toggle your Orvibo S20 Wifi Smart Sockets. diff --git a/source/_components/switch.pencom.markdown b/source/_components/switch.pencom.markdown index 7718b88d2a7..e0ef7f91de5 100644 --- a/source/_components/switch.pencom.markdown +++ b/source/_components/switch.pencom.markdown @@ -8,9 +8,9 @@ comments: false sharing: true footer: true logo: pencom.png -ha_category: Switch +ha_category: Switch ha_release: 0.85 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- [Pencom Design](http://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards/) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read. diff --git a/source/_components/switch.pulseaudio_loopback.markdown b/source/_components/switch.pulseaudio_loopback.markdown index 9603337f58a..fd860ac073b 100644 --- a/source/_components/switch.pulseaudio_loopback.markdown +++ b/source/_components/switch.pulseaudio_loopback.markdown @@ -10,7 +10,7 @@ footer: true logo: pulseaudio.png ha_category: Switch ha_release: 0.16 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The goal behind this switch is to allow a very flexible whole home audio system based upon [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/). diff --git a/source/_components/switch.raincloud.markdown b/source/_components/switch.raincloud.markdown index a13f100e08c..8141b718ad6 100644 --- a/source/_components/switch.raincloud.markdown +++ b/source/_components/switch.raincloud.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: raincloud.jpg ha_category: Irrigation -ha_release: "0.55" -ha_iot_class: "Cloud Polling" +ha_release: 0.55 +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/). diff --git a/source/_components/switch.raspyrfm.markdown b/source/_components/switch.raspyrfm.markdown index 0bbd4ac403e..fbb5df87fca 100644 --- a/source/_components/switch.raspyrfm.markdown +++ b/source/_components/switch.raspyrfm.markdown @@ -10,7 +10,7 @@ footer: true logo: seegelsysteme.png ha_category: Switch ha_release: 0.85 -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State --- The `raspyrfm` component adds support for cheap RC 433 MHz outlets via one of the supported gateways. diff --git a/source/_components/switch.recswitch.markdown b/source/_components/switch.recswitch.markdown index 04cda5bcea8..bb100b3b7a1 100644 --- a/source/_components/switch.recswitch.markdown +++ b/source/_components/switch.recswitch.markdown @@ -1,7 +1,6 @@ --- layout: page title: "Ankuoo Rec Switch" -logo: ankuoo_recswitch.png description: "Instructions on how to integrate Ankuoo Rec Switch into Home Assistant." date: 2018-10-05 08:00 sidebar: true @@ -9,9 +8,9 @@ comments: false sharing: true footer: true logo: "ankuoo_recswitch.png" -ha_release: "0.81" +ha_release: 0.81 ha_category: Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `recswitch` switch platform allows you to control the Ankuoo Rec Switch devices. diff --git a/source/_components/switch.rest.markdown b/source/_components/switch.rest.markdown index 8ba4f4584b9..01cd704e6db 100644 --- a/source/_components/switch.rest.markdown +++ b/source/_components/switch.rest.markdown @@ -10,7 +10,7 @@ footer: true logo: restful.png ha_category: Switch ha_release: 0.7.6 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `rest` switch platform allows you to control a given endpoint that supports a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). The switch can get the state via GET and set the state via POST on a given REST resource. diff --git a/source/_components/switch.rpi_pfio.markdown b/source/_components/switch.rpi_pfio.markdown index 3efa04537f4..94a7022ac2a 100644 --- a/source/_components/switch.rpi_pfio.markdown +++ b/source/_components/switch.rpi_pfio.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY ha_release: 0.45 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `rpi_pfio` switch platform allows you to control the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) module. diff --git a/source/_components/switch.rpi_rf.markdown b/source/_components/switch.rpi_rf.markdown index 1bc16d72f7f..9d8b758ed58 100644 --- a/source/_components/switch.rpi_rf.markdown +++ b/source/_components/switch.rpi_rf.markdown @@ -10,7 +10,7 @@ footer: true logo: raspberry-pi.png ha_category: DIY ha_release: 0.19 -ha_iot_class: "Assumed state" +ha_iot_class: Assumed State --- The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/SRD signals with generic low-cost GPIO RF modules on a [Raspberry Pi](https://www.raspberrypi.org/). diff --git a/source/_components/switch.snmp.markdown b/source/_components/switch.snmp.markdown index 0d2cb6fd0fa..d75cada1767 100644 --- a/source/_components/switch.snmp.markdown +++ b/source/_components/switch.snmp.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: network-snmp.png ha_category: Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.57 --- diff --git a/source/_components/switch.sony_projector.markdown b/source/_components/switch.sony_projector.markdown index 298454f3443..2c18da47df3 100644 --- a/source/_components/switch.sony_projector.markdown +++ b/source/_components/switch.sony_projector.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: sony.png ha_category: Multimedia -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.89 --- diff --git a/source/_components/switch.switchbot.markdown b/source/_components/switch.switchbot.markdown index a87273de79c..0278516239e 100644 --- a/source/_components/switch.switchbot.markdown +++ b/source/_components/switch.switchbot.markdown @@ -10,22 +10,24 @@ footer: true logo: switchbot.png ha_category: Switch ha_release: 0.78 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- -This `Switchbot` switch platform allows you to control Switchbot [devices]( https://www.switch-bot.com/). +The `switchbot` switch platform allows you to control Switchbot [devices](https://www.switch-bot.com/). + +## {% linkable_title Manual Configuration %} To enable it, add the following lines to your `configuration.yaml`: ```yaml switch: - platform: switchbot - mac: 'cb:25:0b......' + mac: 'MAC_ADDRESS' ``` {% configuration %} mac: - description: Device MAC address. + description: The device MAC address with lower-case letters. required: true type: string name: diff --git a/source/_components/switch.switchmate.markdown b/source/_components/switch.switchmate.markdown index 03e67161ca6..23ff7f966f3 100644 --- a/source/_components/switch.switchmate.markdown +++ b/source/_components/switch.switchmate.markdown @@ -10,7 +10,7 @@ footer: true logo: switchmate-logo-rgb.png ha_category: Switch ha_release: 0.78 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- This `Switchmate` switch platform allows you to control Switchmate [devices]( https://www.mysimplysmarthome.com/products/switchmate-switches/). diff --git a/source/_components/switch.telnet.markdown b/source/_components/switch.telnet.markdown index 7a11cff4cf1..6441243d761 100644 --- a/source/_components/switch.telnet.markdown +++ b/source/_components/switch.telnet.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Switch ha_release: 0.54 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `telnet` switch platform allows you to control devices with telnet commands. diff --git a/source/_components/switch.template.markdown b/source/_components/switch.template.markdown index 2107a7280b9..69dc4392bfc 100644 --- a/source/_components/switch.template.markdown +++ b/source/_components/switch.template.markdown @@ -9,7 +9,7 @@ sharing: true footer: true ha_category: Switch ha_release: 0.13 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: home-assistant.png ha_qa_scale: internal --- diff --git a/source/_components/switch.thinkingcleaner.markdown b/source/_components/switch.thinkingcleaner.markdown index 30a937f2124..a16f6041c1c 100644 --- a/source/_components/switch.thinkingcleaner.markdown +++ b/source/_components/switch.thinkingcleaner.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: thinkingcleaner.png ha_category: Switch -ha_iot_class: "Local Poll" +ha_iot_class: Local Polling ha_release: 0.18 --- diff --git a/source/_components/switch.wake_on_lan.markdown b/source/_components/switch.wake_on_lan.markdown index 3d77f533463..2dd668d9e05 100644 --- a/source/_components/switch.wake_on_lan.markdown +++ b/source/_components/switch.wake_on_lan.markdown @@ -10,7 +10,7 @@ footer: true logo: ethernet.png ha_category: Network ha_release: 0.16 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `wake_on_lan` (WOL) switch platform allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer. diff --git a/source/_components/switch.xiaomi_aqara.markdown b/source/_components/switch.xiaomi_aqara.markdown index b19adf44314..b4c01732435 100644 --- a/source/_components/switch.xiaomi_aqara.markdown +++ b/source/_components/switch.xiaomi_aqara.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Switch ha_release: "0.50" -ha_iot_class: "Local Push" +ha_iot_class: Local Push --- The `xiaomi_aqara` switch platform allows you to get data from your [Xiaomi aqara](http://www.mi.com/en/) switches. diff --git a/source/_components/switch.xiaomi_miio.markdown b/source/_components/switch.xiaomi_miio.markdown index 0b88bcf5294..9e163ef2a5f 100644 --- a/source/_components/switch.xiaomi_miio.markdown +++ b/source/_components/switch.xiaomi_miio.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: xiaomi.png ha_category: Switch -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_release: 0.56 --- diff --git a/source/_components/switch.zigbee.markdown b/source/_components/switch.zigbee.markdown index 912b0e5bb30..b53b178fae2 100644 --- a/source/_components/switch.zigbee.markdown +++ b/source/_components/switch.zigbee.markdown @@ -10,7 +10,7 @@ footer: true logo: zigbee.png ha_category: Switch ha_release: 0.12 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- A Zigbee switch in this context is a device connected to one of the digital output pins on a Zigbee module. It can simply be switched on and off. By default, a switch is considered `on` when the Zigbee device's digital output 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`. diff --git a/source/_components/system_log.markdown b/source/_components/system_log.markdown index e3fe547d930..b8d77fd378c 100644 --- a/source/_components/system_log.markdown +++ b/source/_components/system_log.markdown @@ -65,7 +65,7 @@ Traceback (most recent call last): [...] ``` -The message ("Unable to find component system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present. +The message ("Unable to find component system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present. ## {% linkable_title Examples %} diff --git a/source/_components/tado.markdown b/source/_components/tado.markdown index efd8c821113..733f48f215c 100644 --- a/source/_components/tado.markdown +++ b/source/_components/tado.markdown @@ -14,7 +14,7 @@ ha_category: - Presence Detection - Sensor ha_release: 0.41 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/climate.tado/ - /components/device_tracker.tado/ @@ -112,4 +112,4 @@ Find your `home_id` by browsing to `https://my.tado.com/api/v2/me?username=YOUR_ } ``` -In this example `12345` is the `home_id` you'll need to configure. \ No newline at end of file +In this example `12345` is the `home_id` you'll need to configure. diff --git a/source/_components/tahoma.markdown b/source/_components/tahoma.markdown index 2d030091900..bfb36124078 100644 --- a/source/_components/tahoma.markdown +++ b/source/_components/tahoma.markdown @@ -16,7 +16,7 @@ ha_category: - Switch - Sensor ha_release: 0.59 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.tahoma/ - /components/cover.tahoma/ diff --git a/source/_components/telegram_bot.markdown b/source/_components/telegram_bot.markdown index 343ed59f25d..0ec8fd7abec 100644 --- a/source/_components/telegram_bot.markdown +++ b/source/_components/telegram_bot.markdown @@ -10,7 +10,7 @@ footer: true logo: telegram.png ha_category: Hub ha_release: 0.42 -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push --- Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant. diff --git a/source/_components/tellduslive.markdown b/source/_components/tellduslive.markdown index 266cef58007..7e212988eed 100644 --- a/source/_components/tellduslive.markdown +++ b/source/_components/tellduslive.markdown @@ -15,11 +15,10 @@ ha_category: - Light - Sensor - Switch -featured: false ha_release: 0.11 ha_config_flow: true ha_qa_scale: gold -ha_iot_class: 'Cloud Polling' +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.tellduslive/ - /components/cover.tellduslive/ diff --git a/source/_components/tellstick.markdown b/source/_components/tellstick.markdown index 828b8ade735..4742b96c093 100644 --- a/source/_components/tellstick.markdown +++ b/source/_components/tellstick.markdown @@ -8,14 +8,14 @@ comments: false sharing: true footer: true logo: telldus_tellstick.png -ha_release: "pre 0.7" +ha_release: pre 0.7 ha_category: - Hub - Cover - Light - Sensor - Switch -ha_iot_class: "Assumed State" +ha_iot_class: Assumed State redirect_from: - /components/cover.tellstick/ - /components/light.tellstick/ diff --git a/source/_components/tesla.markdown b/source/_components/tesla.markdown index 5d64180c56d..c424f77acbe 100644 --- a/source/_components/tesla.markdown +++ b/source/_components/tesla.markdown @@ -17,7 +17,7 @@ ha_category: - Sensor - Switch ha_release: 0.53 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.tesla/ - /components/device_tracker.tesla/ diff --git a/source/_components/thethingsnetwork.markdown b/source/_components/thethingsnetwork.markdown index f7cc6574a3f..835c798cec9 100644 --- a/source/_components/thethingsnetwork.markdown +++ b/source/_components/thethingsnetwork.markdown @@ -10,7 +10,7 @@ footer: true logo: thethingsnetwork.png ha_category: Hub ha_release: 0.55 -ha_iot_class: depends +ha_iot_class: Configurable --- The `thethingsnetwork` component allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network. diff --git a/source/_components/tibber.markdown b/source/_components/tibber.markdown index 791bc560b02..1f56579e636 100644 --- a/source/_components/tibber.markdown +++ b/source/_components/tibber.markdown @@ -14,7 +14,7 @@ ha_category: - Notifications ha_release: 0.80 ha_qa_scale: silver -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/notify.tibber/ - /components/sensor.tibber/ @@ -70,7 +70,7 @@ action: The `tibber` sensor provides the current electricity price if you are a [Tibber](https://tibber.com/) customer. If you have a Tibber Pulse it will also show the electricity consumption in real time. -The requirement is that you have setup the [`tibber` component](#setup). +The requirement is that you have setup the [`tibber` component](#setup). The sensor will show once the transfer date to tibber has been confirmed. ## {% linkable_title Examples %} @@ -99,4 +99,4 @@ The electricity price can be used to make automations. The sensor has a `max_pri message: "The electricity price is now {{ states.sensor.electricity_price_hamretunet_10.state }}" ``` -{% endraw %} \ No newline at end of file +{% endraw %} diff --git a/source/_components/toon.markdown b/source/_components/toon.markdown index 4c6a5f40316..4effbc315f8 100644 --- a/source/_components/toon.markdown +++ b/source/_components/toon.markdown @@ -14,7 +14,7 @@ ha_category: - Sensor ha_release: 0.56 logo: toon.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/climate.toon/ - /components/sensor.toon/ @@ -73,7 +73,7 @@ The `toon` climate platform allows you to interact with your Toon thermostat. Fo | Home Assistant | Toon | |:---------------|:--------| -| Performance | Comfort | +| Auto | Comfort | | Heat | Thuis | | Eco | Weg | | Cool | Slapen | diff --git a/source/_components/tplink.markdown b/source/_components/tplink.markdown index e32f37d9ec4..094fe692275 100644 --- a/source/_components/tplink.markdown +++ b/source/_components/tplink.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: tp-link.png ha_category: Hub -featured: false ha_release: 0.89 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/switch.tplink/ - /components/light.tplink/ @@ -130,4 +129,3 @@ sensor: unit_of_measurement: 'kWh' ``` {% endraw %} - diff --git a/source/_components/tplink_lte.markdown b/source/_components/tplink_lte.markdown index 51967555164..db30a5c73ae 100644 --- a/source/_components/tplink_lte.markdown +++ b/source/_components/tplink_lte.markdown @@ -12,7 +12,7 @@ ha_release: 0.83 ha_category: - Network - Notifications -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/notify.tplink_lte/ --- diff --git a/source/_components/tradfri.markdown b/source/_components/tradfri.markdown index 60a7770011c..bc7307031c7 100644 --- a/source/_components/tradfri.markdown +++ b/source/_components/tradfri.markdown @@ -9,7 +9,7 @@ comments: false sharing: true footer: true logo: ikea.svg -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling ha_config_flow: true ha_release: 0.43 ha_category: diff --git a/source/_components/transmission.markdown b/source/_components/transmission.markdown index 03143c67cb7..e9bdc1d9a12 100644 --- a/source/_components/transmission.markdown +++ b/source/_components/transmission.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: transmission.png -ha_category: +ha_category: - Downloading - Switch - Sensor ha_release: 0.87 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/switch.transmission/ - /components/sensor.transmission/ diff --git a/source/_components/tts.markdown b/source/_components/tts.markdown index 3d4fceac5d4..5698f9a6b8f 100644 --- a/source/_components/tts.markdown +++ b/source/_components/tts.markdown @@ -63,6 +63,10 @@ tts: base_url: http://192.168.0.10:8123 ``` +

+In the above example, `base_url` is custom to this particular TTS platform configuration. It is not suggesting that you use the `base_url` that you have set for your core Home Assistant configuration. The reason you might need to do this is outlined in the next section. +

+ ## {% linkable_title When do you need to set `base_url` here? %} The general answer is "whenever the global `base_url` set in [http component](/components/http/) is not adequate to allow the `say` service to run". The `say` service operates by generating a media file that contains the speech corresponding to the text passed to the service. Then the `say` service sends a message to the media device with a URL pointing to the file. The device fetches the media file at the URL and plays the media. Some combinations of a media device, network configuration and Home Assistant configuration can make it so that the device cannot fetch the media file. diff --git a/source/_components/tuya.markdown b/source/_components/tuya.markdown index 52c79e31f4d..ddb2840d330 100644 --- a/source/_components/tuya.markdown +++ b/source/_components/tuya.markdown @@ -16,7 +16,7 @@ ha_category: - Light - Scene - Switch -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: 0.74 redirect_from: - /components/climate.tuya/ diff --git a/source/_components/unifi.markdown b/source/_components/unifi.markdown index 287412b057f..2be321f9cc2 100644 --- a/source/_components/unifi.markdown +++ b/source/_components/unifi.markdown @@ -12,8 +12,8 @@ ha_category: - Hub - Presence Detection - Switch -ha_release: "0.81" -ha_iot_class: "Local Polling" +ha_release: 0.81 +ha_iot_class: Local Polling redirect_from: - /components/device_tracker.unifi/ - /components/switch.unifi/ @@ -134,10 +134,9 @@ To obtain this value for your configuration file, you can take it from the URL o For example, this is what would be seen in the URL bar when inside the dashboard page of a site: -* https://127.0.0.1:8443/manage/s/ceb1m27d/dashboard - -And your `site_id` value would be ceb1m27d. +`https://127.0.0.1:8443/manage/s/ceb1m27d/dashboard` +And your `site_id` value would be `ceb1m27d`. ### {% linkable_title Troubleshooting and Time Synchronization %} @@ -152,52 +151,53 @@ If Home Assistant and the Unifi controller are running on separate machines or V The Unifi controller returns a number of additional attributes that can be used for tracking devices, including signal strength, rx/tx rates, and which AP it is connected to. The list of possible options may vary depending on your Unifi controller version and if a device is wired or wireless. Unifi Controller version 5.6.29 has the following options: - - _id - - _is_guest_by_uap - - _last_seen_by_uap - - _uptime_by_uap - - ap_mac - - assoc_time - - authorized - - bssid - - bytes-r - - ccq - - channel - - essid - - first_seen - - hostname - - idletime - - ip - - is_11r - - is_guest - - is_wired - - last_seen - - latest_assoc_time - - mac - - name - - noise - - noted - - oui - - powersave_enabled - - qos_policy_applied - - radio - - radio_proto - - rssi - - rx_bytes - - rx_bytes-r - - rx_packets - - rx_rate - - signal - - site_id - - tx_bytes - - tx_bytes-r - - tx_packets - - tx_power - - tx_rate - - uptime - - user_id - - usergroup_id - - vlan + +- _id +- _is_guest_by_uap +- _last_seen_by_uap +- _uptime_by_uap +- ap_mac +- assoc_time +- authorized +- bssid +- bytes-r +- ccq +- channel +- essid +- first_seen +- hostname +- idletime +- ip +- is_11r +- is_guest +- is_wired +- last_seen +- latest_assoc_time +- mac +- name +- noise +- noted +- oui +- powersave_enabled +- qos_policy_applied +- radio +- radio_proto +- rssi +- rx_bytes +- rx_bytes-r +- rx_packets +- rx_rate +- signal +- site_id +- tx_bytes +- tx_bytes-r +- tx_packets +- tx_power +- tx_rate +- uptime +- user_id +- usergroup_id +- vlan ## {% linkable_title Switch %} diff --git a/source/_components/updater.markdown b/source/_components/updater.markdown index 873fab8fef2..91019e670d2 100644 --- a/source/_components/updater.markdown +++ b/source/_components/updater.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Other ha_qa_scale: internal +ha_release: 0.8 --- The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this component on Hass.io. diff --git a/source/_components/usps.markdown b/source/_components/usps.markdown index 5d11f98817c..76773a005f1 100644 --- a/source/_components/usps.markdown +++ b/source/_components/usps.markdown @@ -13,7 +13,7 @@ ha_category: - Camera - Sensor ha_release: 0.52 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/camera.usps/ - /components/sensor.usps/ @@ -36,7 +36,7 @@ If you are using a Raspberry Pi, you must use PhantomJS.

-Hass.io containers are based on Alpine Linux. PhanthomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io. +Hass.io containers are based on Alpine Linux. PhantomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io.

### {% linkable_title PhantomJS %} @@ -119,4 +119,4 @@ To enable this camera in your installation, set up the USPS component first. The `usps` sensor component allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](#camera). -To enable this sensor in your installation, set up the USPS component first. \ No newline at end of file +To enable this sensor in your installation, set up the USPS component first. diff --git a/source/_components/utility_meter.markdown b/source/_components/utility_meter.markdown index 1f5bbdd8b59..3dfb3852605 100644 --- a/source/_components/utility_meter.markdown +++ b/source/_components/utility_meter.markdown @@ -7,9 +7,9 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Sensor ha_release: 0.87 -ha_iot_class: "Local Push" +ha_iot_class: Local Push logo: energy_meter.png ha_qa_scale: internal --- @@ -137,7 +137,7 @@ Assuming your energy provider tariffs are time based according to: a time based automation can be used: ```yaml -automation: +automation: trigger: - platform: time at: '09:00:00' diff --git a/source/_components/vacuum.ecovacs.markdown b/source/_components/vacuum.ecovacs.markdown index 85ce3230aca..100b0703de7 100644 --- a/source/_components/vacuum.ecovacs.markdown +++ b/source/_components/vacuum.ecovacs.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: ecovacs.png ha_category: Vacuum -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push ha_release: 0.77 --- diff --git a/source/_components/vacuum.markdown b/source/_components/vacuum.markdown index f0b3bb760b5..ffdf18dabf9 100644 --- a/source/_components/vacuum.markdown +++ b/source/_components/vacuum.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.51 --- The `vacuum` component enables the ability to control home cleaning robots within Home Assistant. diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 4a806f3298d..1fdbd89828a 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -10,7 +10,7 @@ footer: true logo: xiaomi.png ha_category: Vacuum ha_release: 0.51 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `xiaomi_miio` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](https://www.mi.com/roomrobot/). @@ -172,6 +172,7 @@ automation: - 26032 - 26496 ``` + ## {% linkable_title Attributes %} In addition to [all of the attributes provided by the `vacuum` component](/components/vacuum/#attributes), diff --git a/source/_components/velbus.markdown b/source/_components/velbus.markdown index 7751a97e416..8c01061b410 100644 --- a/source/_components/velbus.markdown +++ b/source/_components/velbus.markdown @@ -14,7 +14,7 @@ ha_category: - Climate - Sensor - Switch -ha_iot_class: "Local Push" +ha_iot_class: Local Push ha_release: "0.50" redirect_from: - /components/climate.velbus/ diff --git a/source/_components/velux.markdown b/source/_components/velux.markdown index 2f9d9f2d25c..a78a3490e48 100644 --- a/source/_components/velux.markdown +++ b/source/_components/velux.markdown @@ -12,7 +12,7 @@ ha_category: - Scene - Cover ha_release: 0.49 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/scene.velux/ - /components/cover.velux/ diff --git a/source/_components/verisure.markdown b/source/_components/verisure.markdown index 0deb2c115e4..e851a80edda 100644 --- a/source/_components/verisure.markdown +++ b/source/_components/verisure.markdown @@ -17,7 +17,7 @@ ha_category: - Sensor - Switch ha_release: pre 0.7 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/alarm_control_panel.verisure/ - /components/binary_sensor.verisure/ @@ -129,4 +129,4 @@ automation: {% raw %}Alarm changed from {{ trigger.from_state.state }} to {{ trigger.to_state.state }} by {{ trigger.to_state.attributes.changed_by }}{% endraw %} -``` \ No newline at end of file +``` diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown index 44d210d355d..b778d9e7c78 100644 --- a/source/_components/volvooncall.markdown +++ b/source/_components/volvooncall.markdown @@ -10,7 +10,7 @@ footer: true logo: volvo.png ha_category: Car ha_release: 0.39 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.volvooncall/ - /components/lock.volvooncall/ diff --git a/source/_components/vultr.markdown b/source/_components/vultr.markdown index d960c282972..0d445701761 100644 --- a/source/_components/vultr.markdown +++ b/source/_components/vultr.markdown @@ -7,15 +7,14 @@ sidebar: true comments: false sharing: true footer: true -featured: false ha_category: - System Monitor - Binary Sensor - Sensor - Switch -ha_release: "0.58" +ha_release: 0.58 logo: vultr.png -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling redirect_from: - /components/binary_sensor.vultr/ - /components/sensor.vultr/ @@ -199,4 +198,4 @@ switch: - platform: vultr name: Amazing Server subscription: 123456 -``` \ No newline at end of file +``` diff --git a/source/_components/w800rf32.markdown b/source/_components/w800rf32.markdown index 3a87e0b591a..f2b7cece328 100644 --- a/source/_components/w800rf32.markdown +++ b/source/_components/w800rf32.markdown @@ -12,7 +12,7 @@ ha_category: - Hub - Binary Sensor ha_release: 0.83 -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.w800rf32/ --- @@ -81,4 +81,4 @@ Binary sensors have only two states, "on" and "off". Many door or window opening - Most motion sensors send a signal each time they detect motion. They stay "on" for a few seconds and go back to sleep, ready to signal other motion events. Usually, they do not send a signal when they go back to sleep. -For those devices, use the *off_delay* parameter. It defines a delay after which a device will go back to an "Off" state. That "Off" state will be fired internally by Home Assistant, just as if the device fired it by itself. If a motion sensor can only send signals once every 5 seconds, sets the *off_delay* parameter to *seconds: 5*. \ No newline at end of file +For those devices, use the *off_delay* parameter. It defines a delay after which a device will go back to an "Off" state. That "Off" state will be fired internally by Home Assistant, just as if the device fired it by itself. If a motion sensor can only send signals once every 5 seconds, sets the *off_delay* parameter to *seconds: 5*. diff --git a/source/_components/wake_on_lan.markdown b/source/_components/wake_on_lan.markdown index da7e5831afb..62201899594 100644 --- a/source/_components/wake_on_lan.markdown +++ b/source/_components/wake_on_lan.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: ethernet.png ha_category: Network -ha_release: "0.49" -ha_iot_class: "Local Push" +ha_release: 0.49 +ha_iot_class: Local Push --- The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to turn them on. @@ -40,7 +40,7 @@ Send a _magic packet_ to wake up a device with 'Wake-On-LAN' capabilities. Sample service data: ```json -{ +{ "mac":"00:40:13:ed:f1:32" } ``` diff --git a/source/_components/water_heater.econet.markdown b/source/_components/water_heater.econet.markdown index 5e2c439d546..e5ad20e8a17 100644 --- a/source/_components/water_heater.econet.markdown +++ b/source/_components/water_heater.econet.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: econet.png ha_category: Water heater -ha_release: 0.61.0 -ha_iot_class: "Cloud Polling" +ha_release: 0.61 +ha_iot_class: Cloud Polling redirect_from: /components/climate.econet/ --- diff --git a/source/_components/water_heater.markdown b/source/_components/water_heater.markdown index 7e5d08687d6..13fb3b24e47 100644 --- a/source/_components/water_heater.markdown +++ b/source/_components/water_heater.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.81 --- The `water_heater` component is built for the controlling and monitoring of hot water heaters. diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index d260a96553b..face090bf46 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -10,8 +10,8 @@ footer: true logo: waterfurnace.png ha_category: Sensor ha_release: 0.62 -ha_iot_class: "Cloud Polling" -redirect_frome: +ha_iot_class: Cloud Polling +redirect_from: - /components/sensor.waterfurnace/ --- diff --git a/source/_components/weather.bom.markdown b/source/_components/weather.bom.markdown index 025dcd50dd1..5e237d81f53 100644 --- a/source/_components/weather.bom.markdown +++ b/source/_components/weather.bom.markdown @@ -10,7 +10,7 @@ footer: true logo: bom.png ha_category: Weather ha_release: 0.36 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `bom` weather platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data. diff --git a/source/_components/weather.buienradar.markdown b/source/_components/weather.buienradar.markdown index a6552408949..bd767e30a36 100644 --- a/source/_components/weather.buienradar.markdown +++ b/source/_components/weather.buienradar.markdown @@ -10,7 +10,7 @@ footer: true logo: buienradar.png ha_category: Weather ha_release: 0.47 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands. diff --git a/source/_components/weather.darksky.markdown b/source/_components/weather.darksky.markdown index 96ef461a9ed..3f199d33dbf 100644 --- a/source/_components/weather.darksky.markdown +++ b/source/_components/weather.darksky.markdown @@ -11,7 +11,7 @@ featured: true logo: dark_sky.png ha_category: Weather ha_release: 0.61 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. diff --git a/source/_components/weather.markdown b/source/_components/weather.markdown index fa199a2d666..0e0599f67db 100644 --- a/source/_components/weather.markdown +++ b/source/_components/weather.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +ha_release: 0.32 --- The `weather` platforms are gathering meteorological information from web services and display the conditions and other details about the weather at the given location. diff --git a/source/_components/weather.met.markdown b/source/_components/weather.met.markdown index 3cdd8145b8c..5b789525569 100644 --- a/source/_components/weather.met.markdown +++ b/source/_components/weather.met.markdown @@ -10,7 +10,7 @@ footer: true logo: metno.png ha_category: Weather ha_release: 0.79 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `met` platform uses the [Met.no](https://met.no/) web service as a source for meteorological data for your location. The weather forecast is delivered by the Norwegian Meteorological Institute and the NRK. diff --git a/source/_components/weather.metoffice.markdown b/source/_components/weather.metoffice.markdown index afadc9803ca..c255af78418 100644 --- a/source/_components/weather.metoffice.markdown +++ b/source/_components/weather.metoffice.markdown @@ -10,7 +10,7 @@ footer: true logo: metoffice.jpg ha_category: Weather ha_release: 0.42 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `metoffice` weather platform uses the Met Office's [DataPoint API](http://www.metoffice.gov.uk/datapoint) for weather data. diff --git a/source/_components/weather.openweathermap.markdown b/source/_components/weather.openweathermap.markdown index 6bebcff19f3..6ff677b8d32 100644 --- a/source/_components/weather.openweathermap.markdown +++ b/source/_components/weather.openweathermap.markdown @@ -10,7 +10,7 @@ footer: true logo: openweathermap.png ha_category: Weather ha_release: 0.32 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `openweathermap` weather platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location. diff --git a/source/_components/weather.zamg.markdown b/source/_components/weather.zamg.markdown index 1bf04508ba9..31dbe220558 100644 --- a/source/_components/weather.zamg.markdown +++ b/source/_components/weather.zamg.markdown @@ -10,7 +10,7 @@ footer: true logo: zamg.png ha_category: Weather ha_release: 0.39 -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling --- The `zamg` platform uses meteorological details published by the Austrian weather service [Zentralanstalt für Meteorologie und Geodynamik (ZAMG)](https://www.zamg.ac.at). diff --git a/source/_components/webhook.markdown b/source/_components/webhook.markdown index 5540a153410..f2c292f632c 100644 --- a/source/_components/webhook.markdown +++ b/source/_components/webhook.markdown @@ -1,5 +1,6 @@ --- date: 2018-10-05 00:01:00 +ha_release: 0.80 --- diff --git a/source/_components/websocket_api.markdown b/source/_components/websocket_api.markdown index ca35aeb0678..18c69dc07b9 100644 --- a/source/_components/websocket_api.markdown +++ b/source/_components/websocket_api.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: "Other" ha_qa_scale: internal +ha_release: 0.34 --- The `websocket_api` component set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/). diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index f854ce8c769..3ee8fd06985 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -22,7 +22,7 @@ ha_category: - Switch - Water heater featured: true -ha_iot_class: "Cloud Polling" +ha_iot_class: Cloud Polling ha_release: pre 0.7 redirect_from: - /components/alarm_control_panel.wink/ @@ -681,4 +681,4 @@ The requirement is that you have set up [Wink](/components/wink/) from above.

Wink water heaters use to live under the `climate` platform prior to release 0.81. -

\ No newline at end of file +

diff --git a/source/_components/wirelesstag.markdown b/source/_components/wirelesstag.markdown index 58fa2f4611b..37a5f305dab 100644 --- a/source/_components/wirelesstag.markdown +++ b/source/_components/wirelesstag.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor - Sensor - Switch -ha_iot_class: "Local Push and Cloud Polling" +ha_iot_class: Cloud Polling and Local Push ha_release: 0.68 redirect_from: - /components/binary_sensor.wirelesstag/ @@ -163,4 +163,4 @@ monitored_conditions: {% endconfiguration %} Arm/Disarm of motion switch is required to receive motion and door binary sensors events. -Others are only needed if you want to receive push notifications from tags on a specific range of changes in temperature, humidity, light or moisture. \ No newline at end of file +Others are only needed if you want to receive push notifications from tags on a specific range of changes in temperature, humidity, light or moisture. diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index f797f8f6b3e..b1b6f112e47 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: xiaomi.png ha_category: Hub -ha_release: "0.57" -ha_iot_class: "Local Push" +ha_release: 0.57 +ha_iot_class: Local Push redirect_from: /components/xiaomi/ --- diff --git a/source/_components/xs1.markdown b/source/_components/xs1.markdown index 99951e6ae2c..e77a3695096 100644 --- a/source/_components/xs1.markdown +++ b/source/_components/xs1.markdown @@ -14,8 +14,7 @@ ha_category: - Sensor - Switch ha_release: 0.88 -featured: false -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/climate.xs1/ - /components/sensor.xs1/ @@ -83,8 +82,7 @@ If you are using climate devices the "current temp" sensor will be automatically | `dimmer` | Partly | Dimmers are currently handled like switches so actual dimming is not supported :(| | `temperature` | Yes | | - -### {% linkable_title Climate Actuator/Sensor%} +### {% linkable_title Climate Actuator/Sensor %} Home Assistant can combine temperature sensors and climate actuators into a single device. The XS1 gateway does not allow this, but a sensor and actuator can be configured separately. To make Home Assistant register them in the same climate device just prefix the **sensor** name with the actuator name on the XS1 gateway configuration, f.ex: diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index decbd7437b8..75fce8fe3d7 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -9,9 +9,8 @@ sharing: true footer: true logo: zabbix.png ha_category: System Monitor -featured: false ha_release: 0.37 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- The `zabbix` component is the main component to connect to a [Zabbix](http://www.zabbix.com/) monitoring instance via the Zabbix API. diff --git a/source/_components/zha.markdown b/source/_components/zha.markdown index a48d20b2ecc..0e70bd5d966 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -15,7 +15,7 @@ ha_category: - Sensor - Switch ha_release: 0.44 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.zha/ - /components/fan.zha/ diff --git a/source/_components/zigbee.markdown b/source/_components/zigbee.markdown index 3c2022dbed7..40f21fcf64c 100644 --- a/source/_components/zigbee.markdown +++ b/source/_components/zigbee.markdown @@ -10,7 +10,7 @@ footer: true logo: zigbee.png ha_category: DIY ha_release: 0.12 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling --- [Zigbee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local Zigbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network. diff --git a/source/_components/zone.markdown b/source/_components/zone.markdown index 9b9d82c9572..20b6fe3b251 100644 --- a/source/_components/zone.markdown +++ b/source/_components/zone.markdown @@ -10,6 +10,7 @@ footer: true logo: home-assistant.png ha_category: Organization ha_qa_scale: internal +ha_release: 0.69 --- Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device to be within a zone, the state will take the name from the zone. Zones can also be used as a [trigger](/getting-started/automation-trigger/#zone-trigger) or [condition](/getting-started/automation-condition/#zone-condition) inside automation setups. diff --git a/source/_components/zoneminder.markdown b/source/_components/zoneminder.markdown index 8c25922db65..a8a67d635a6 100644 --- a/source/_components/zoneminder.markdown +++ b/source/_components/zoneminder.markdown @@ -14,9 +14,8 @@ ha_category: - Camera - Sensor - Switch -featured: false ha_release: 0.31 -ha_iot_class: "Local Polling" +ha_iot_class: Local Polling redirect_from: - /components/binary_sensor.zoneminder/ - /components/camera.zoneminder/ @@ -119,7 +118,7 @@ Each binary_sensor created will be named after the hostname used when configurin The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras. -## {% linkable_title Configuration %} +### {% linkable_title Configuration %} To set it up, add the following information to your `configuration.yaml` file: @@ -196,4 +195,4 @@ command_off:

The default functions installed by ZoneMinder are: None, Monitor, Modect, Record, Mocord, Nodect. -

\ No newline at end of file +

diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index afdf4538fe4..ba60c98e34b 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -19,7 +19,7 @@ ha_category: - Sensor - Switch featured: true -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.zwave/ - /components/climate.zwave/ @@ -29,6 +29,7 @@ redirect_from: - /components/lock.zwave/ - /components/sensor.zwave/ - /components/switch.zwave/ +ha_release: 0.7 --- The [Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Please see the [Z-Wave getting started section](/docs/z-wave/) for in-depth documentation on how to use and setup the Z-Wave component. @@ -149,4 +150,4 @@ Z-Wave locks will expose three services under the lock domain to manage usercode | ------- | ----------- | | clear_usercode | Clears a usercode at code_slot X. Valid code_slots are 1-254, but max is defined by the lock. | | get_usercode | Get a usercode from the lock at code_slot. Valid code_slots are 1-254, but max is defined by the lock. | -| set_usercode | Sets usercode to X at code_slot Y. Valid usercodes are at least 4 digits, and max defined by the lock. | \ No newline at end of file +| set_usercode | Sets usercode to X at code_slot Y. Valid usercodes are at least 4 digits, and max defined by the lock. | diff --git a/source/_components/ifttt.manything.markdown b/source/_cookbook/ifttt.manything.markdown similarity index 97% rename from source/_components/ifttt.manything.markdown rename to source/_cookbook/ifttt.manything.markdown index 84d0228bc15..7ebeb0631d7 100644 --- a/source/_components/ifttt.manything.markdown +++ b/source/_cookbook/ifttt.manything.markdown @@ -9,6 +9,8 @@ sharing: true footer: true logo: manything.png ha_category: Camera +redirect_from: + /components/ifttt.manything/ --- [Manything](https://manything.com) is a smart app that turns your Android device, iPhone, iPod, or iPad into a WiFi camera for monitoring your home, your pets, anything! Comes with live streaming, motion activated alerts, cloud video recording, and more. @@ -55,7 +57,7 @@ automation:

-You need to setup a unique trigger for each event you sent to IFTTT. +You need to setup a unique trigger for each event you sent to IFTTT. For ManyThing support, you need to set up an `on` and `off` event.

diff --git a/source/_components/notify.mqtt.markdown b/source/_cookbook/notify.mqtt.markdown similarity index 89% rename from source/_components/notify.mqtt.markdown rename to source/_cookbook/notify.mqtt.markdown index 04a40d2a110..8e21816b98e 100644 --- a/source/_components/notify.mqtt.markdown +++ b/source/_cookbook/notify.mqtt.markdown @@ -9,7 +9,9 @@ sharing: true footer: true logo: mqtt.png ha_category: Notifications -ha_iot_class: depends +ha_iot_class: Configurable +redirect_from: + /components/notify.mqtt/ --- The MQTT notification support is different than the other [notification](/components/notify/) platforms. It is a service. This means that you don't have to create a configuration entry but you need to provide more details when calling the service. @@ -52,16 +54,16 @@ Use as [`script`](/components/script/) in automations. {% raw %} ```yaml automation: - alias: Send me a message when I get home + alias: Send me a message when I get home trigger: - platform: state - entity_id: device_tracker.me - to: 'home' + platform: state + entity_id: device_tracker.me + to: 'home' action: service: script.notify_mqtt data: - target: "me" - message: "I'm home" + target: "me" + message: "I'm home" script: notify_mqtt: diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown index 508e09d8642..5380bb27c71 100644 --- a/source/_docs/automation/templating.markdown +++ b/source/_docs/automation/templating.markdown @@ -153,6 +153,13 @@ The following tables show the available trigger data per platform. | `trigger.platform` | Hardcoded: `time` | `trigger.now` | DateTime object that triggered the time trigger. +### {% linkable_title time pattern %} + +| Template variable | Data | +| ---- | ---- | +| `trigger.platform` | Hardcoded: `time_pattern` +| `trigger.now` | DateTime object that triggered the time_pattern trigger. + ### {% linkable_title webhook %} | Template variable | Data | diff --git a/source/_docs/ecosystem/ios/notifications/attachments.markdown b/source/_docs/ecosystem/ios/notifications/attachments.markdown index 73c8887f9e1..9bd56ae0633 100644 --- a/source/_docs/ecosystem/ios/notifications/attachments.markdown +++ b/source/_docs/ecosystem/ios/notifications/attachments.markdown @@ -23,7 +23,7 @@ To expand a notification on 3D Touch devices simply force touch any notification action: service: notify.ios_robbies_iphone_7_plus data: - message: "Something happened at home!"" + message: "Something happened at home!" data: attachment: url: "https://github.com/home-assistant/home-assistant-assets/blob/master/logo-round-192x192.png?raw=true" diff --git a/source/_docs/installation/hassbian/upgrading.markdown b/source/_docs/installation/hassbian/upgrading.markdown index 1a6b37d4968..c9eb4af4d81 100644 --- a/source/_docs/installation/hassbian/upgrading.markdown +++ b/source/_docs/installation/hassbian/upgrading.markdown @@ -20,7 +20,7 @@ $ sudo apt-get -y upgrade #### {% linkable_title Updating Home Assistant %}

-You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant` +You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade home-assistant`

To update the Home Assistant installation execute the following command as the `pi` user. diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown index 052845f3228..ed261f6c874 100644 --- a/source/_docs/scripts/conditions.markdown +++ b/source/_docs/scripts/conditions.markdown @@ -163,7 +163,7 @@ The template condition will test if the [given template][template] renders a val ```yaml condition: condition: template - value_template: "{% raw %}{{ state_attr('device_tracker.iphone', 'battery') > 50 }}{% endraw %}" + value_template: "{% raw %}{{ (state_attr('device_tracker.iphone', 'battery')|int) > 50 }}{% endraw %}" ``` Within an automation, template conditions also have access to the `trigger` variable as [described here][automation-templating]. diff --git a/source/_posts/2015-12-07-influxdb-and-grafana.markdown b/source/_posts/2015-12-07-influxdb-and-grafana.markdown index 64e51095bf9..fdd8f659ce5 100644 --- a/source/_posts/2015-12-07-influxdb-and-grafana.markdown +++ b/source/_posts/2015-12-07-influxdb-and-grafana.markdown @@ -6,15 +6,14 @@ description: "A step by step guide to start recording data from Home Assistant i comments: true date_formatted: "December 07, 2015" author: Fabian Affolter -comments: true categories: How-To og_image: /images/blog/2015-12-influxdb/grafana-graph.png --- -The [InfluxDB](https://influxdb.com/) database is a so-called time series database primarily designed to store sensor data and real-time analytics. +The [InfluxDB](https://influxdb.com/) database is a so-called time series database primarily designed to store sensor data and real-time analytics. -The `influxdb` component makes it possible to transfer all state changes from Home Assistant to an external [InfluxDB](https://influxdb.com/) database. +The `influxdb` component makes it possible to transfer all state changes from Home Assistant to an external [InfluxDB](https://influxdb.com/) database. diff --git a/source/_posts/2019-03-13-release-89.markdown b/source/_posts/2019-03-13-release-89.markdown index 368397e38ce..840121a9758 100644 --- a/source/_posts/2019-03-13-release-89.markdown +++ b/source/_posts/2019-03-13-release-89.markdown @@ -52,6 +52,65 @@ __Existing SmartThings configuration entries will be removed,__ including the Sm - mobile_app component ([@robbiet480] - [#21475]) ([mobile_app docs]) (beta fix) (new-platform) - Add component media player.ps4 ([@ktnrg45] - [#21074]) ([ps4 docs]) +## {% linkable_title Release 0.89.1 - March 8 %} + +- Upgrade blinkpy==0.13.1 (Fixes #21559) ([@fronzbot] - [#21578]) ([blink docs]) +- Fix Name of Homematic IP accesspoint in devices, if name is configured ([@SukramJ] - [#21617]) ([homematicip_cloud docs]) +- Fix group-switch availability for Homematic IP ([@SukramJ] - [#21640]) ([homematicip_cloud docs]) +- automated commit 07/03/2019 10:47:38 ([@ljmerza] - [#21749]) ([sensor.google_travel_time docs]) +- Fix botvac connected maps call as it is not a supported model ([@dshokouhi] - [#21752]) ([neato docs]) +- Fix colorlog import error ([@awarecan] - [#21754]) +- Fix script load module issue ([@awarecan] - [#21763]) +- Bump PyXiaomiGateway version to 0.12.2 (Closes: #21731) ([@syssi] - [#21764]) ([xiaomi_aqara docs]) +- adds missing SUPPORT_VOLUME_SET flag to webos media_player ([@dthulke] - [#21766]) ([webostv docs]) +- Updated to newest pyeconet ([@w1ll1am23] - [#21772]) ([water_heater docs]) + +[#21578]: https://github.com/home-assistant/home-assistant/pull/21578 +[#21617]: https://github.com/home-assistant/home-assistant/pull/21617 +[#21640]: https://github.com/home-assistant/home-assistant/pull/21640 +[#21749]: https://github.com/home-assistant/home-assistant/pull/21749 +[#21752]: https://github.com/home-assistant/home-assistant/pull/21752 +[#21754]: https://github.com/home-assistant/home-assistant/pull/21754 +[#21763]: https://github.com/home-assistant/home-assistant/pull/21763 +[#21764]: https://github.com/home-assistant/home-assistant/pull/21764 +[#21766]: https://github.com/home-assistant/home-assistant/pull/21766 +[#21772]: https://github.com/home-assistant/home-assistant/pull/21772 +[@SukramJ]: https://github.com/SukramJ +[@awarecan]: https://github.com/awarecan +[@dshokouhi]: https://github.com/dshokouhi +[@dthulke]: https://github.com/dthulke +[@fronzbot]: https://github.com/fronzbot +[@ljmerza]: https://github.com/ljmerza +[@syssi]: https://github.com/syssi +[@w1ll1am23]: https://github.com/w1ll1am23 +[blink docs]: /components/blink/ +[homematicip_cloud docs]: /components/homematicip_cloud/ +[neato docs]: /components/neato/ +[sensor.google_travel_time docs]: /components/sensor.google_travel_time/ +[water_heater docs]: /components/water_heater/ +[webostv docs]: /components/webostv/ +[xiaomi_aqara docs]: /components/xiaomi_aqara/ + +## {% linkable_title Release 0.89.2 - March 12 %} + +- Update dependencies to receive data on webhook callbacks ([@andrewsayre] - [#21838]) ([smartthings docs]) +- Override http.trusted_networks by auth_provider.trusted_networks ([@awarecan] - [#21844]) ([http docs]) +- Fix botvac when no map exists ([@dshokouhi] - [#21877]) ([neato docs]) +- Fixes issues #21821 and #21819 ([@kstaniek] - [#21911]) ([binary_sensor.tod docs]) + +[#21838]: https://github.com/home-assistant/home-assistant/pull/21838 +[#21844]: https://github.com/home-assistant/home-assistant/pull/21844 +[#21877]: https://github.com/home-assistant/home-assistant/pull/21877 +[#21911]: https://github.com/home-assistant/home-assistant/pull/21911 +[@andrewsayre]: https://github.com/andrewsayre +[@awarecan]: https://github.com/awarecan +[@dshokouhi]: https://github.com/dshokouhi +[@kstaniek]: https://github.com/kstaniek +[binary_sensor.tod docs]: /components/binary_sensor.tod/ +[http docs]: /components/http/ +[neato docs]: /components/neato/ +[smartthings docs]: /components/smartthings/ + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. diff --git a/source/cloud/index.markdown b/source/cloud/index.markdown index c3ab5cfe1f1..8c797896fca 100644 --- a/source/cloud/index.markdown +++ b/source/cloud/index.markdown @@ -10,7 +10,7 @@ footer: true logo: home-assistant.png ha_release: "0.60" ha_category: Voice -ha_iot_class: "Cloud Push" +ha_iot_class: Cloud Push --- Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [their website](https://www.nabucasa.com) For more information on features, pricing and [how to configure Home Assistant](https://www.nabucasa.com/config/). diff --git a/source/components/index.html b/source/components/index.html index a55d60425b6..61685b291c1 100644 --- a/source/components/index.html +++ b/source/components/index.html @@ -26,15 +26,8 @@ regenerate: false {%- endfor -%} {%- assign components = site.components | sort: 'title' -%} +{%- assign components_by_version = site.components | group_components_by_release -%} {%- assign categories = components | map: 'ha_category' | join: ',' | join: ',' | split: ',' | uniq | sort -%} -{%- capture current_version -%}{{ site.current_major_version }}.{{ site.current_minor_version }}{% endcapture -%} -{%- assign added_one_ago_minor_version = site.current_minor_version|minus: 1 -%} -{%- capture added_one_ago_version -%}{{ site.current_major_version }}.{{ added_one_ago_minor_version }}{% endcapture -%} -{%- assign added_two_ago_minor_version = site.current_minor_version|minus: 2 -%} -{%- capture added_two_ago_version -%}{{ site.current_major_version }}.{{ added_two_ago_minor_version }}{% endcapture -%} -{%- assign current_version_components_count = site.components | where: 'ha_release', current_version | size -%} -{%- assign one_ago_version_components_count = site.components | where: 'ha_release', added_one_ago_version | size -%} -{%- assign two_ago_version_components_count = site.components | where: 'ha_release', added_two_ago_version | size -%}

Support for these components is provided by the Home Assistant community. @@ -45,10 +38,15 @@ Support for these components is provided by the Home Assistant community.

All ({{tot}}) Featured - Added in {{ current_version }} ({{ current_version_components_count }}) - Added in {{ added_one_ago_version }} ({{ one_ago_version_components_count }}) - Added in {{ added_two_ago_version }} ({{ two_ago_version_components_count }}) - +
Added in:
{%- for category in categories -%} {%- assign components_count = components | where: 'ha_category', category | size -%} {%- if category and category != 'Other' and components_count != 0 -%} @@ -241,6 +239,14 @@ allComponents.pop(); // remove placeholder element at the end return false; }); + // update view on select change + jQuery('select').change(function() { + updateHash(this.value); + applyFilter(); + + return false; + }); + /** * Simple debounce implementation, based on http://davidwalsh.name/javascript-debounce-function */ diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index a62cf799cb7..a7d4b349f94 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -37,7 +37,7 @@ The following will take you through the steps required to install Hass.io. 2. Install Hass.io: - Flash the downloaded image to an SD card using [balenaEtcher][balenaEtcher]. We recommend at least a 32 GB SD card to avoid running out of space. - - Load the appliance image into your virtual machine software. + - Load the appliance image into your virtual machine software. Choose 64-bit Linux and UEFI boot. 3. Optional - set up the WiFi or static IP: On a USB stick, create the `network/my-network` file and follow the [HassOS howto][hassos-network].