{%- else -%}
- 
+ 
{%- endif -%}
diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html
index 9ad89018186..ae72edaa8de 100644
--- a/source/_includes/asides/docs_navigation.html
+++ b/source/_includes/asides/docs_navigation.html
@@ -9,7 +9,7 @@
-
-
- {% active_link /hassio/ Hass.io %} +
- {% active_link /hassio/ Home Assistant %}
- {% active_link /docs/installation/updating/ Updating %}
-
{% active_link /docs/installation/troubleshooting/ Troubleshooting
diff --git a/source/_includes/asides/hassio_navigation.html b/source/_includes/asides/hassio_navigation.html
index ffb99b948b0..c30771e6e65 100644
--- a/source/_includes/asides/hassio_navigation.html
+++ b/source/_includes/asides/hassio_navigation.html
@@ -3,7 +3,7 @@
Topics
-
- {% active_link /hassio/ Hass.io %}
+ {% active_link /hassio/ Home Assistant %}
- {% active_link /hassio/installation/ Installation %}
- {% active_link /addons/ Available add-ons %} diff --git a/source/_includes/edit_github.html b/source/_includes/edit_github.html index b5fa2329b84..3b6c57980eb 100644 --- a/source/_includes/edit_github.html +++ b/source/_includes/edit_github.html @@ -1,4 +1,4 @@ {% assign url_parts = page.url | split: '/' %} {% if page.hide_github_edit != true %} - + {% endif %} diff --git a/source/_integrations/airly.markdown b/source/_integrations/airly.markdown index 6dee218c8fd..922b78da408 100644 --- a/source/_integrations/airly.markdown +++ b/source/_integrations/airly.markdown @@ -11,7 +11,7 @@ ha_codeowners: ha_domain: airly --- -The `airly` integration uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location. +The `airly` integration uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location. ## Setup @@ -19,26 +19,10 @@ To generate an Airly API key, go to [Airly for developers](https://developer.air ## Configuration -To add Airly to your installation, go to **Configuration** >> **Integrations** in the UI and enable the Airly integration. By default, the values will be taken from the Home Assistant configuration. +To add Airly to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Airly**. By default, the values will be taken from the Home Assistant configuration. -{% configuration %} -api_key: - description: The Airly API key. - required: true - type: string -name: - description: Manually specify Name. - required: false - type: string - default: Airly -latitude: - description: Manually specify latitude. - required: false - type: float - default: Provided by Home Assistant configuration -longitude: - description: Manually specify longitude. - required: false - type: float - default: Provided by Home Assistant configuration -{% endconfiguration %} +
+ +Airly allows 100 data updates per day. For this reason, the more Airly instances configured, the less frequent updates will be. For one configured Airly instance, data will be updated every 15 minutes, for two configured instances, data will be updated every 30 minutes, for three configured instances, data will be updated every 45 minutes, etc. + +diff --git a/source/_integrations/airvisual.markdown b/source/_integrations/airvisual.markdown index ce182395af7..11251cc5d58 100644 --- a/source/_integrations/airvisual.markdown +++ b/source/_integrations/airvisual.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_codeowners: - '@bachya' ha_domain: airvisual +ha_config_flow: true --- 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](https://www.clm.com/publication.cfm?ID=366) are created. @@ -80,7 +81,6 @@ airvisual: geographies: latitude: 42.81212 longitude: 108.12422 - scan_interval: 300 ``` Configuration using multiple custom latitude and longitude pairs: diff --git a/source/_integrations/alarm_control_panel.template.markdown b/source/_integrations/alarm_control_panel.template.markdown index 896be69bd45..ebaa5efcad6 100644 --- a/source/_integrations/alarm_control_panel.template.markdown +++ b/source/_integrations/alarm_control_panel.template.markdown @@ -73,7 +73,7 @@ panels: type: string default: Template Alarm Control Panel value_template: - description: "Defines a template to set the state of the alarm panel. Only the states `armed_away`, `armed_home`, `armed_night`, `disarmed`, `triggered` and `unavailable` are used." + description: "Defines a template to set the state of the alarm panel. Only the states `armed_away`, `armed_home`, `armed_night`, `disarmed`, `pending`, `triggered` and `unavailable` are used." required: false type: template disarm: diff --git a/source/_integrations/alarmdecoder.markdown b/source/_integrations/alarmdecoder.markdown index 4f34e36f8a8..2e4902eeb76 100644 --- a/source/_integrations/alarmdecoder.markdown +++ b/source/_integrations/alarmdecoder.markdown @@ -82,10 +82,15 @@ panel_display: default: false type: boolean autobypass: - description: "If this is set to `true`, then when arming (home or away), it will automatically bypass all open zones (sending '6#')." + description: "If this is set to `true`, then when arming (home or away), it will automatically bypass all open zones (sending '6#'). This will require your code to be entered even if `code_arm_required` is set to `false`." required: false default: false type: boolean +code_arm_required: + description: "If this is set to `false`, you will not need to enter your code to arm the system." + required: false + default: true + type: boolean zones: description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/alarmdecoder) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*" required: false @@ -131,6 +136,7 @@ There are several attributes available on the alarm panel to give you more infor - `programming_mode`: Set to `true` if your system is in programming mode. - `ready`: Set to `true` if your system is ready to be armed. Any faults, including motions sensors, will make this value `false`. - `zone_bypassed`: Set to `true` if your system is currently bypassing a zone. +- `code_arm_required`: Set to the value specified in your configuration. ## Services diff --git a/source/_integrations/alarmdotcom.markdown b/source/_integrations/alarmdotcom.markdown deleted file mode 100644 index 691b952bfe4..00000000000 --- a/source/_integrations/alarmdotcom.markdown +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Alarm.com -description: Instructions on how to integrate Alarm.com into Home Assistant. -logo: alarmdotcom.png -ha_category: - - Alarm -ha_release: 0.11 -ha_domain: alarmdotcom ---- - -The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/). - -## Configuration - -To enable this, add the following lines to your `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -alarm_control_panel: - platform: alarmdotcom - username: YOUR_USERNAME - password: YOUR_PASSWORD -``` - -{% configuration %} -username: - description: Username for the Alarm.com account. - required: true - type: string -password: - description: Password for the Alarm.com account. - required: true - type: string -name: - description: The name of the alarm. - required: false - default: Alarm.com - type: string -code: - description: Specifies a code to enable or disable the alarm in the frontend. - required: false - type: integer -{% endconfiguration %} - -- Please make sure that your alarm.com language is set to English before open any issue. -diff --git a/source/_integrations/alexa.flash_briefings.markdown b/source/_integrations/alexa.flash_briefings.markdown index 966a80f001c..9caa646bb27 100644 --- a/source/_integrations/alexa.flash_briefings.markdown +++ b/source/_integrations/alexa.flash_briefings.markdown @@ -13,7 +13,7 @@ As of version [0.31][zero-three-one] Home Assistant supports the new [Alexa Flas ### Requirements -Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230). +Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. Using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230). Additionally, note that at the time of this writing, your Alexa skill endpoint *must* accept requests over port 443 (Home Assistant default to 8123). There are two ways you can handle this: diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index 1e6d5b8b9db..a82e4791bd3 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -412,6 +412,7 @@ The following integrations are currently supported: - [Binary Sensor](#binary-sensor) - [Doorbell Announcement](#doorbell-announcement) - [Presence Detection](#presence-detection-with-binary-sensor) +- [Camera](#camera) - [Climate](#climate) - [Cover](#cover) - [Garage Doors](#garage-doors) @@ -424,6 +425,9 @@ The following integrations are currently supported: - [Input Number](#input-number) - [Image Processing](#image-processing) - [Light](#light) + - [Brightness](#brightness) + - [Color Temperature](#color-temperature) + - [Color](#color) - [Lock](#lock) - [Media Player](#media-player) - [Channels](#change-channel) @@ -566,6 +570,18 @@ Each Echo device will need the communication and Announcements setting enabled, [Image Processing](#image-processing) entities also support this notification. +### Camera + +View a camera stream on an Amazon echo device. + +- _"Alexa, show the front door camera."_ + +The [`stream`](/integrations/stream/) integration is required to stream cameras to Amazon echo devices. + +The Amazon echo device will request the camera stream from Home Assistant. The Home Assistant URL must be accessible from the network the Amazon echo device is connected to and must support HTTPS on port 443 with a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport). These requirements can be satisfied with Home Assistant Cloud, or LetsEncrypt/DuckDNS. + +Enable preload stream option for cameras used with echo devices to reduce response time, and prevent timing out before the 6 second limit. + ### Climate Single, double, and triple set-point thermostats are supported. The temperature value from the thermostat will also be exposed at a separate [temperature sensor](#sensor). @@ -760,8 +776,57 @@ The following table lists the possible friendly name synonyms available for a In ### Light -- _"Alexa, dim the bathroom light."_ +Control lights with _"turn on"_ and _"turn off"_ utterances, adjust brightness, color, and temperature. + +- _"Alexa, turn on the bathroom light."_ +- _"Alexa, turn off the patio light."_ + +#### Brightness + +Lights that support brightness can be adjusted with percentages ranging from 0 to 100 percent. + - _"Alexa, set the bedroom light to fifty percent."_ +- _"Alexa, living room lights to one hundred percent."_ + +The _"dim"_ utterance will decrease the brightness of a light 25 percentage points. + +- _"Alexa, dim the bathroom light."_ + +#### Color Temperature + +Adjust lights that support color temperature using the following friendly names: + +- _"Alexa, set the dining room softer."_ +- _"Alexa, make the living room warmer."_ +- _"Alexa, set the dining room cooler."_ +- _"Alexa, make the living room light whiter."_ +- _"Alexa, make the living room warm white."_ +- _"Alexa, set the kitchen to daylight."_ + +The following table lists the possible friendly name synonyms available to lights that support color temperature. + +| Color Temperature in Kelvin | Friendly Name Synonyms | +| -----| ---------------------------------------------- | +| 2200 | _"warm"_, _"warm white"_ | +| 2700 | _"incandescent"_, _"soft white"_ | +| 4000 | _"white"_ | +| 5500 | _"daylight"_, _"daylight white"_ | +| 7000 | _"cool"_, _"cool white"_ | + +Use _"warmer"_, _"softer"_, _"cooler_, _"whiter"_ utterances to adjust color temperature by 50 `mired` (approximately 300-500 degree kelvin change). + +- _"Alexa, set the dining room softer."_ +- _"Alexa, make the living room warmer."_ +- _"Alexa, set the dining room cooler."_ +- _"Alexa, make the living room light whiter."_ + +#### Color + +Set the light color using the CSS [basic color keywords](https://drafts.csswg.org/css-color-3/#html4) or [extended color keywords](https://drafts.csswg.org/css-color-3/#svg-color) as the friendly color name. + +- _"Alexa, set the front porch light to blue."_ +- _"Alexa, set the bedroom light to red."_ +- _"Alexa, change the kitchen to the color crimson."_ ### Lock diff --git a/source/_integrations/amcrest.markdown b/source/_integrations/amcrest.markdown index a12798a46e1..b74cc6a8cfb 100644 --- a/source/_integrations/amcrest.markdown +++ b/source/_integrations/amcrest.markdown @@ -1,6 +1,6 @@ --- title: Amcrest -description: Instructions on how to integrate Amcrest IP cameras within Home Assistant. +description: Instructions on how to integrate Amcrest (or Dahua) IP cameras within Home Assistant. logo: amcrest.png ha_category: - Hub @@ -14,7 +14,7 @@ ha_codeowners: ha_domain: amcrest --- -The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant. +The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) or Dahua IP camera in Home Assistant. There is currently support for the following device types within Home Assistant: @@ -153,7 +153,8 @@ Available services: `enable_motion_recording`, `disable_motion_recording`, `enable_recording`, `disable_recording`, `goto_preset`, `set_color_bw`, -`start_tour` and `stop_tour` +`start_tour`, `stop_tour`, and +`ptz_control` #### Service `enable_audio`/`disable_audio` @@ -161,7 +162,7 @@ These services enable or disable the camera's audio stream. Service data attribute | Optional | Description -|-|- -`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. +`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. #### Service `enable_motion_recording`/`disable_motion_recording` @@ -169,7 +170,7 @@ These services enable or disable the camera to record a clip to its configured s Service data attribute | Optional | Description -|-|- -`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. +`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. #### Service `enable_recording`/`disable_recording` @@ -177,7 +178,7 @@ These services enable or disable the camera to continuously record to its config Service data attribute | Optional | Description -|-|- -`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. +`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. #### Service `goto_preset` @@ -185,7 +186,7 @@ This service will cause the camera to move to one of the PTZ locations configure Service data attribute | Optional | Description -|-|- -`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. +`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. `preset` | no | Preset number, starting from 1. #### Service `set_color_bw` @@ -194,7 +195,7 @@ This service will set the color mode of the camera. Service data attribute | Optional | Description -|-|- -`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. +`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. `color_bw` | no | One of `auto`, `bw` or `color`. #### Service `start_tour`/`stop_tour` @@ -203,7 +204,153 @@ These services start or stop the camera's PTZ tour function. Service data attribute | Optional | Description -|-|- -`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. +`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. + +#### Service `ptz_control` + +If your Amcrest or Dahua camera supports PTZ, you will be able to pan, tilt or zoom your camera. + +Service data attribute | Optional | Description +-|-|- + `entity_id` | no| The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. + `movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down` + `travel_time` | yes |Travel time in fractional seconds. Allowed values: `0` to `1`. Default: `0.2`. + +#### Notes + +- PTZ zoom capability does not control VariFocal lens adjustments. +- There can be several seconds of lag before the video (snapshot or live) reflects the camera movement. + +### Example card with controls + ++
+ +Using the following picture-elements card code, you can display a live video feed from an Amcrest camera with controls for moving or zooming the camera. + +```yaml +type: picture-elements +entity: camera.lakehouse +camera_image: camera.lakehouse +camera_view: live # or auto for snapshot view +elements: + - type: icon + icon: 'mdi:arrow-up' + style: + background: 'rgba(255, 255, 255, 0.25)' + right: 25px + bottom: 50px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: up + - type: icon + icon: 'mdi:arrow-down' + style: + background: 'rgba(255, 255, 255, 0.25)' + right: 25px + bottom: 0px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: down + - type: icon + icon: 'mdi:arrow-left' + style: + background: 'rgba(255, 255, 255, 0.25)' + right: 50px + bottom: 25px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: left + - type: icon + icon: 'mdi:arrow-right' + style: + background: 'rgba(255, 255, 255, 0.25)' + right: 0px + bottom: 25px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: right + - type: icon + icon: 'mdi:arrow-top-left' + style: + background: 'rgba(255, 255, 255, 0.25)' + right: 50px + bottom: 50px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: left_up + - type: icon + icon: 'mdi:arrow-top-right' + style: + background: 'rgba(255, 255, 255, 0.25)' + right: 0px + bottom: 50px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: right_up + - type: icon + icon: 'mdi:arrow-bottom-left' + style: + background: 'rgba(255, 255, 255, 0.25)' + right: 50px + bottom: 0px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: left_down + - type: icon + icon: 'mdi:arrow-bottom-right' + style: + background: 'rgba(255, 255, 255, 0.25)' + right: 0px + bottom: 0px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: right_down + - type: icon + icon: 'mdi:magnify' + style: + background: 'rgba(255, 255, 255, 0.25)' + bottom: 25px + right: 25px + tap_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: zoom_in + hold_action: + action: call-service + service: amcrest.ptz_control + service_data: + entity_id: camera.lakehouse + movement: zoom_out +``` ## Advanced Configuration diff --git a/source/_integrations/android_ip_webcam.markdown b/source/_integrations/android_ip_webcam.markdown index 4350bb8db79..412772d3cd4 100644 --- a/source/_integrations/android_ip_webcam.markdown +++ b/source/_integrations/android_ip_webcam.markdown @@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant: ## Setup -Download [the IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen. +Download [the Android IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen. ## Configuration @@ -53,11 +53,11 @@ name: default: IP Webcam type: string username: - description: The username to access the phone. + description: The username to access the phone. If username is specified then password must be also. required: inclusive type: string password: - description: The password to access the phone. + description: The password to access the phone. If password is specified then username must be also. required: inclusive type: string scan_interval: @@ -66,7 +66,7 @@ scan_interval: default: 10 type: integer sensors: - description: Conditions to display sensor in the frontend. See the list of supported sensors. + description: List of sensor entities to be created by this component. required: false type: list keys: @@ -81,17 +81,17 @@ sensors: light: description: The light level motion: - description: Motion detection + description: Analog (not binary) amount of motion detected pressure: description: The current pressure proximity: description: The proximity sound: - description: The sound detection + description: The sound level video_connections: description: The video connections switches: - description: Conditions to display settings in the frontend. See the list of supported switches. + description: List of switch entities to be created by this component. required: false type: list keys: @@ -103,6 +103,8 @@ switches: description: Control the focus. gps_active: description: Control the GPS. + motion_detection: + description: Control the motion detector. night_vision: description: Control the night vision. overlay: @@ -114,7 +116,7 @@ switches: video_recording: description: Control the video recording. motion_sensor: - description: Activate motion sensor if `auto_discovery` is disabled. + description: Create a binary_sensor.
+ Example showing an Amcrest IP2M-841 PT camera with controls for Pan and Tilt.
+_motion_active entity. Note that `auto_discovery` may also create this sensor. required: false type: boolean default: false @@ -162,13 +164,13 @@ android_ip_webcam: - torch ``` -## Binary Sensor +## Alternate Configuration Method -The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP Webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically. +The configuration described above will cause the `android_ip_webcam` binary sensor platform to automatically create and configure the devices automatically. Alternatively you can omit the `android_ip_webcam` component from your `configuration.yaml` file and add individual devices instead. -## Examples +### Binary Sensor -You can also setup the binary motion sensor with the following script: +You can setup the binary motion sensor with the following in your `configuration.yaml` file: {% raw %} @@ -177,17 +179,13 @@ binary_sensor: - platform: rest name: Kitchen Motion sensor_class: motion - resource: http://IP:8080/sensors.json?sense=motion_active + resource: http://IP_ADDRESS:PORT/sensors.json?sense=motion_active value_template: '{{ value_json.motion_active.data[0][1][0] | round(0) }}' ``` {% endraw %} -## Camera - -The `android_ip_webcam` integration adds a camera by default if you choose not to use the integration but still want to see the video feed then the [`mjpeg` camera](/integrations/mjpeg) platform can be used. - -## Configuration +### Camera To enable only the camera in your installation, add the following to your `configuration.yaml` file: @@ -195,11 +193,9 @@ To enable only the camera in your installation, add the following to your `confi # Example configuration.yaml entry camera: - platform: mjpeg - mjpeg_url: http://IP_ADDRESS:8080/video + mjpeg_url: http://IP_ADDRESS:PORT/video ``` -## Sensor - -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. +### Other Sensors You can setup your own sensors by examining the JSON file from the webcam server: `http://IP:8080/sensors.json` diff --git a/source/_integrations/asuswrt.markdown b/source/_integrations/asuswrt.markdown index 78ee129a359..3198d58435f 100644 --- a/source/_integrations/asuswrt.markdown +++ b/source/_integrations/asuswrt.markdown @@ -1,7 +1,6 @@ --- title: ASUSWRT description: Instructions on how to integrate ASUSWRT into Home Assistant. -logo: asus.png ha_category: - Hub - Presence Detection diff --git a/source/_integrations/august.markdown b/source/_integrations/august.markdown index e13fc70d6eb..4f1de45e2ae 100644 --- a/source/_integrations/august.markdown +++ b/source/_integrations/august.markdown @@ -1,11 +1,10 @@ --- title: August description: Instructions on how to integrate your August devices into Home Assistant. -logo: august.png ha_category: - Doorbell - Binary Sensor - - Sensor + - Sensor - Camera - Lock ha_release: 0.64 @@ -101,7 +100,7 @@ If you have an August Keypad, once you have enabled the August component, you sh ### Presence Detection with Lock Operation -Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below example will trigger when the user named “John Doe” in August locks or unlocks the door from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by August. +Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below automation example (added to `automations.yaml`) will trigger when the user named “John Doe” in August locks or unlocks the door from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by August. {% raw %} diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown index 1b551075472..6154fd3c550 100644 --- a/source/_integrations/binary_sensor.mqtt.markdown +++ b/source/_integrations/binary_sensor.mqtt.markdown @@ -8,9 +8,9 @@ ha_iot_class: Configurable ha_domain: mqtt --- -The `mqtt` binary sensor platform uses an MQTT message payload to set the binary sensor to one of two states: `on` or `off`. +The `mqtt` binary sensor platform uses an MQTT message received to set the binary sensor's state to `on` or `off`. -The binary sensor state will be updated only after a new message is published on `state_topic` matching `payload_on` or `payload_off`. If these messages are published with the `retain` flag set, +The state will be updated only after a new message is published on `state_topic` matching `payload_on` or `payload_off`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`. @@ -19,7 +19,7 @@ Stateless devices such as buttons, remote controls etc are better represented by ## Configuration The `mqtt` binary sensor platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT sensor device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability_topic` -is defined, Home Assistant will consider the MQTT device to be available. +is defined, Home Assistant will consider the MQTT device to be `available` and will display its state. To use an MQTT binary sensor in your installation, add the following to your `configuration.yaml` file: @@ -33,7 +33,7 @@ binary_sensor: {% configuration %} availability_topic: - description: "The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor availability state will always be `available`. If `availability_topic` is defined, the binary sensor availability state will be `unavailable` by default." + description: "The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor will always be considered `available` and its state will be `on`, `off` or `unknown`. If `availability_topic` is defined, the binary sensor will be considered as `unavailable` by default and the sensor's state will be `unavailable`." required: false type: string device: @@ -70,11 +70,11 @@ device_class: required: false type: string expire_after: - description: "Defines the number of seconds after the value expires if it's not updated. After expiry, the value is cleared, and the availability is set to false" + description: "Defines the number of seconds after the sensor's state expires if it's not updated. After expiry, the sensor's state becomes `unavailable` if `availability_topic` is defined and `unknown` otherwise." required: false type: integer force_update: - description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history. + description: Sends update events (which results in update of [state object](/docs/configuration/state_object/)'s `last_changed`) even if the sensor's state hasn't changed. Useful if you want to have meaningful value graphs in history or want to create an automation that triggers on *every* incoming state message (not only when the sensor's new state is different to the current one). required: false type: boolean default: false @@ -92,26 +92,26 @@ name: type: string default: MQTT Binary Sensor off_delay: - description: "For sensors that only sends `On` state updates, this variable sets a delay in seconds after which the sensor state will be updated back to `Off`." + description: "For sensors that only send `on` state updates (like PIRs), this variable sets a delay in seconds after which the sensor's state will be updated back to `off`." required: false type: integer payload_available: - description: The payload that represents the online state. + description: The string that represents the `online` state. required: false type: string default: online payload_not_available: - description: The payload that represents the offline state. + description: The string that represents the `offline` state. required: false type: string default: offline payload_off: - description: The payload that represents the off state. + description: The string that represents the `off` state. It will be compared to the message in the `state_topic` (see `value_template` for details) required: false type: string default: "OFF" payload_on: - description: The payload that represents the on state. + description: The string that represents the `on` state. It will be compared to the message in the `state_topic` (see `value_template` for details) required: false type: string default: "ON" @@ -121,7 +121,7 @@ qos: type: integer default: 0 state_topic: - description: The MQTT topic subscribed to receive sensor values. + description: The MQTT topic subscribed to receive sensor's state. required: true type: string unique_id: @@ -129,7 +129,7 @@ unique_id: required: false type: string value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads." + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) that returns a string to be compared to `payload_on`/`payload_off`. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads (i.e no pre-processing of original message is required)." required: false type: string {% endconfiguration %} diff --git a/source/_integrations/binary_sensor.rest.markdown b/source/_integrations/binary_sensor.rest.markdown index eaa3d8f2e5c..f3a433442b4 100644 --- a/source/_integrations/binary_sensor.rest.markdown +++ b/source/_integrations/binary_sensor.rest.markdown @@ -108,10 +108,6 @@ headers: type: [list, string] {% endconfiguration %} - -Make sure that the URL exactly matches your endpoint or resource. -- ## Examples In this section you find some real-life examples of how to use this sensor. diff --git a/source/_integrations/bmp280.markdown b/source/_integrations/bmp280.markdown new file mode 100644 index 00000000000..6007b19c613 --- /dev/null +++ b/source/_integrations/bmp280.markdown @@ -0,0 +1,48 @@ +--- +title: Bosch BMP280 Environmental Sensor +description: Instructions on how to integrate a BMP280 sensor into Home Assistant. +ha_release: 0.108 +logo: raspberry-pi.png +ha_category: + - DIY +ha_iot_class: Local Polling +ha_quality_scale: silver +ha_code_owners: + - '@belidzs' +--- + +The `bmp280` sensor platform allows you to read temperature and pressure values of a [Bosch BMP280 Environmental sensor](https://www.bosch-sensortec.com/products/environmental-sensors/pressure-sensors/pressure-sensors-bmp280-1.html) connected via [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). + +This integration has been tested on a Raspberry Pi 4B, but it should work on any device which is supported by [CircuitPython](https://circuitpython.org/). + +## Configuration + +To use a BMP280 sensor in your installation, you have to enable I2C on your host device then configure the integration using the following example: + +```yaml +sensor: + - platform: bmp280 + - i2c_address: 0x77 +``` + +{% configuration %} +name: + description: The name of the sensor. + required: false + default: BMP280 + type: string +i2c_address: + description: I2C address of the sensor. It is either 0x76 or 0x77, depending on your actual wiring configuration. + required: true + type: integer +{% endconfiguration %} + +## Setting up the I2C interface on the host device + +To get more information on how to set up the I2C interface on your Raspberry Pi, please refer to the [BME680 sensor integration](/integrations/bme680/#directions-for-installing-smbus-support-on-raspberry-pi). + +## Choosing the appropriate I2C address + +Please note that the I2C address of this device depends on the state of the `SDO` pin. If it is pulled down (to the `GND` rail) it will be `0x76`, if it's pulled up (to the `VCC` rail) it will be `0x77`. + +If you leave it floating then the address will be unpredictable or even worse, it can change over time. So it is recommended to hook up this pin to either the positive or the negative rail of your host device. diff --git a/source/_integrations/bom.markdown b/source/_integrations/bom.markdown index 9068b3910f1..12cc48d91dc 100644 --- a/source/_integrations/bom.markdown +++ b/source/_integrations/bom.markdown @@ -9,6 +9,8 @@ ha_category: ha_release: 0.36 ha_iot_class: Cloud Polling ha_domain: bom +ha_codeowners: + - '@maddenp' --- 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/_integrations/brother.markdown b/source/_integrations/brother.markdown index 1102eba19e0..33ce95074f8 100644 --- a/source/_integrations/brother.markdown +++ b/source/_integrations/brother.markdown @@ -1,7 +1,6 @@ --- title: Brother Printer description: Instructions on how to integrate a Brother printer into Home Assistant. -logo: brother.png ha_category: - System Monitor ha_release: 0.104 @@ -10,6 +9,7 @@ ha_config_flow: true ha_codeowners: - '@bieniu' ha_domain: brother +ha_quality_scale: platinum --- The `Brother Printer` integration allows you to read current data from your local Brother printer. diff --git a/source/_integrations/calendar.google.markdown b/source/_integrations/calendar.google.markdown index 9c539bbdb79..ffc93a0f3eb 100644 --- a/source/_integrations/calendar.google.markdown +++ b/source/_integrations/calendar.google.markdown @@ -27,7 +27,7 @@ Generate a Client ID and Client Secret on 1. Set the 'Application Name' (the name of the application asking for consent) to anything you want. We suggest "Home-Assistant". 1. Save this page. You don't have to fill out anything else here. 1. Click on the menu item, Credentials, then click 'Create credentials' > OAuth client ID. -1. Set the Application type to 'Other' and give this credential set a name (like "Home Assistant Credentials") then click 'Create'. +1. Set the Application type to 'Other' (if not present, choose 'TV and Limited Input') and give this credential set a name (like "Home Assistant Credentials") then click 'Create'. 1. Copy the client ID and client secret from the page that follows into a text editor temporarily as you will need to put these in your `configuration.yaml` file. 1. Click on the menu item, Library, then search for "Google Calendar API" and enable it (if it isn't already enabled automatically through this process). diff --git a/source/_integrations/camera.mqtt.markdown b/source/_integrations/camera.mqtt.markdown index d5ddcc1d462..ef8082632dd 100644 --- a/source/_integrations/camera.mqtt.markdown +++ b/source/_integrations/camera.mqtt.markdown @@ -24,6 +24,10 @@ camera: ``` {% configuration %} +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. + required: false + type: string device: description: "Information about the device this camera is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set." required: false @@ -53,6 +57,14 @@ device: description: The firmware version of the device. required: false type: string +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Implies `force_update` of the current sensor state when a message is received on this topic. + required: false + type: string name: description: The name of the camera. required: false diff --git a/source/_integrations/cert_expiry.markdown b/source/_integrations/cert_expiry.markdown index 92141d2ff65..3f378dcf03d 100644 --- a/source/_integrations/cert_expiry.markdown +++ b/source/_integrations/cert_expiry.markdown @@ -49,7 +49,3 @@ The Certificate Expiry entities provide extra attributes to represent the state | ---- | ----------- | | `is_valid` | If the certificate is able to be validated: `True` / `False`. | `error` | A human-readable error description if the certificate is considered invalid, "None" otherwise. - --Make sure that the URL exactly matches your endpoint or resource. -diff --git a/source/_integrations/coolmaster.markdown b/source/_integrations/coolmaster.markdown index f8b54c59fa3..d43b16f7659 100644 --- a/source/_integrations/coolmaster.markdown +++ b/source/_integrations/coolmaster.markdown @@ -1,7 +1,6 @@ --- title: CoolMasterNet description: Instructions on how to integrate CoolMasterNet within Home Assistant. -logo: coolautomation.png ha_category: - Climate ha_release: 0.88 diff --git a/source/_integrations/deconz.markdown b/source/_integrations/deconz.markdown index bc8398dde9a..e35dcbdd4b2 100644 --- a/source/_integrations/deconz.markdown +++ b/source/_integrations/deconz.markdown @@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant: ## Recommended way of running deCONZ -If you are running Hass.io, an official add-on for deCONZ is available in the add-on store. +An official add-on for deCONZ is available in the Home Assistant add-on store. Otherwise, use [community container](https://hub.docker.com/r/marthoc/deconz/) by Marthoc for your deCONZ needs. ### Supported devices diff --git a/source/_integrations/digital_ocean.markdown b/source/_integrations/digital_ocean.markdown index 08453ef1383..912c30a8ec7 100644 --- a/source/_integrations/digital_ocean.markdown +++ b/source/_integrations/digital_ocean.markdown @@ -6,7 +6,6 @@ ha_category: - Binary Sensor - Switch ha_release: '0.30' -logo: digital_ocean.png ha_iot_class: Local Polling ha_codeowners: - '@fabaff' diff --git a/source/_integrations/directv.markdown b/source/_integrations/directv.markdown index 6bb2a847db5..6b8c3ae2d70 100644 --- a/source/_integrations/directv.markdown +++ b/source/_integrations/directv.markdown @@ -1,17 +1,28 @@ --- title: DirecTV description: Instructions on how to integrate DirecTV receivers into Home Assistant. -logo: directv.png ha_category: - Media Player ha_release: 0.25 ha_iot_class: Local Polling ha_domain: directv ha_config_flow: true +ha_codeowners: + - '@ctalkington' --- The DirecTV platform allows you to control a [DirecTV](https://www.directv.com) receiver and its client devices. +### Requirements + +For proper integration with Home Assistant, your DirecTV device settings should allow "External Access". + +This is done via series of settings found via "Menu > Settings & Help > Settings > Whole Home > External Device": + +- External Access: Allow +- Current Program: Allow +- Recordings: Allow + ### Configuration Go to the integrations page in your configuration and click on new integration -> DirecTV. diff --git a/source/_integrations/discovery.markdown b/source/_integrations/discovery.markdown index fa4c8d2c67f..929d55d6096 100644 --- a/source/_integrations/discovery.markdown +++ b/source/_integrations/discovery.markdown @@ -25,7 +25,6 @@ Home Assistant can discover and automatically configure [zeroconf](https://en.wi * [NETGEAR routers](/integrations/netgear) * [Panasonic Viera](/integrations/panasonic_viera) * [Philips Hue](/integrations/hue) - * [Plex Media Server](/integrations/plex#media-player) * [Roku media player](/integrations/roku#media-player) * [SABnzbd downloader](/integrations/sabnzbd) * [Samsung SyncThru Printer](/integrations/syncthru) @@ -86,7 +85,6 @@ Valid values for ignore are: * `openhome`: Linn / Openhome * `panasonic_viera`: Panasonic Viera * `philips_hue`: Philips Hue - * `plex_mediaserver`: Plex Media Server * `roku`: Roku media player * `sabnzbd`: SABnzbd downloader * `samsung_printer`: Samsung SyncThru Printer diff --git a/source/_integrations/doorbird.markdown b/source/_integrations/doorbird.markdown index b15675ab5b8..c2f39708de3 100644 --- a/source/_integrations/doorbird.markdown +++ b/source/_integrations/doorbird.markdown @@ -1,15 +1,16 @@ --- title: DoorBird description: Instructions on how to integrate your DoorBird video doorbell with Home Assistant. -logo: doorbird.png ha_category: - Doorbell - Camera - Switch ha_release: 0.54 ha_iot_class: Local Push +ha_config_flow: true ha_codeowners: - '@oblogic7' + - '@bdraco' ha_domain: doorbird --- @@ -31,7 +32,9 @@ It is recommended to set up a new account on your Doorbird App for use with Home ## Configuration -To connect your device, add the following to your `configuration.yaml` file: +To add `DoorBird` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **DoorBird**. + +Alternatively, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/dsmr.markdown b/source/_integrations/dsmr.markdown index 7d8dcf43006..2f0a52bc262 100644 --- a/source/_integrations/dsmr.markdown +++ b/source/_integrations/dsmr.markdown @@ -54,17 +54,24 @@ sensor: {% configuration %} port: - description: "Serial port to which Smartmeter is connected (default: /dev/ttyUSB0 (connected to USB port)). For remote (i.e., ser2net) connections, use TCP port number to connect to (i.e., 2001)." + description: "Serial port to which Smartmeter is connected via USB. For remote (i.e., ser2net) connections, use TCP port number to connect to (i.e., 2001)." required: false type: string + default: "/dev/ttyUSB0" host: - description: "Host to which Smartmeter is connected (default: '' (connected via serial or USB, see **port**)). For remote connections, use IP address of host to connect to (i.e., 192.168.1.13)." + description: "Host to which Smartmeter is connected via serial or USB, see **port**. For remote connections, use IP address of host to connect to (i.e., 192.168.1.13)." required: false type: string dsmr_version: - description: "Version of DSMR used by meter. Choices: 2.2, 4, 5, 5B (For Belgian Meter). Defaults to 2.2." + description: "Version of DSMR used by meter. Choices: `2.2`, `4`, `5`, `5B` (For Belgian Meter)." required: false type: string + default: "2.2" + reconnect_interval: + description: The reconnect interval in seconds when the connection is lost with the Smartmeter. + required: false + type: integer + default: 30 precision: description: Defines the precision of the calculated values, through the argument of round(). required: false diff --git a/source/_integrations/dynalite.markdown b/source/_integrations/dynalite.markdown index b5a87b91f93..f5dd81be41e 100755 --- a/source/_integrations/dynalite.markdown +++ b/source/_integrations/dynalite.markdown @@ -1,7 +1,6 @@ --- -title: "Philips Dynalite" -description: "Instructions on setting up Philips Dynalite within Home Assistant." -logo: dynalite.png +title: Philips Dynalite +description: Instructions on setting up Philips Dynalite within Home Assistant. ha_category: - Hub - Light diff --git a/source/_integrations/edl21.markdown b/source/_integrations/edl21.markdown index b6aad5c2676..e8b0ab8abbf 100644 --- a/source/_integrations/edl21.markdown +++ b/source/_integrations/edl21.markdown @@ -1,10 +1,12 @@ --- -title: "EDL21 smart meter" -description: "Instructions on how to integrate SML-based EDL21 smart meters into Home Assistant." +title: EDL21 +description: Instructions on how to integrate SML-based EDL21 smart meters into Home Assistant. ha_category: - Sensor ha_release: 0.107 ha_domain: edl21 +ha_codeowners: + - '@mtdcr' --- The `edl21` integration lets you read German EDL21 smart meters using [SML](https://de.wikipedia.org/wiki/Smart_Message_Language) from Home Assistant. diff --git a/source/_integrations/elkm1.markdown b/source/_integrations/elkm1.markdown index 603603fcb33..c9ed4200ad5 100644 --- a/source/_integrations/elkm1.markdown +++ b/source/_integrations/elkm1.markdown @@ -13,6 +13,9 @@ ha_category: - Switch ha_iot_class: Local Push ha_domain: elkm1 +ha_config_flow: true +ha_codeowners: + - '@bdraco' --- The Elk-M1 is a home security and automation controller that is capable of alarm control panel functions and automation. @@ -30,8 +33,9 @@ There is currently support for the following device types within Home Assistant: ## Configuration -To integrate one or more Elk-M1 controllers with Home Assistant, add the following -section to your `configuration.yaml` file: +To add `ElkM1` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Elk-M1 Control**. + +Alternatively, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -64,6 +68,11 @@ temperature_unit: required: false type: string default: F +auto_configure: + description: Auto configure `area`, `counter`, `keypad`, `output`, `setting`, `task`, `thermostat`, `plc`, and `zone` by only adding elements that ElkM1 reports on the initial sync. + required: false + type: boolean + default: False area: description: Elk areas to include in Home Assistant. required: false @@ -271,6 +280,16 @@ elkm1: exclude: [b12-d5] ``` +Example configuration using `auto_configure`: + +```yaml +elkm1: + host: elks://IP_ADDRESS + username: USERNAME + password: PASSWORD + auto_configure: true +``` + Example for a serial port instance on /dev/ttyUSB0 at 115200 baud: ```yaml diff --git a/source/_integrations/emoncms.markdown b/source/_integrations/emoncms.markdown index 43f0caf2cd3..1d1e874ab69 100644 --- a/source/_integrations/emoncms.markdown +++ b/source/_integrations/emoncms.markdown @@ -7,6 +7,8 @@ ha_category: ha_release: 0.29 ha_iot_class: Local Polling ha_domain: emoncms +ha_codeowners: + - '@borpin' --- The `emoncms` sensor platform creates sensors for the feeds available in your local or cloud based version of [Emoncms](https://emoncms.org). diff --git a/source/_integrations/environment_canada.markdown b/source/_integrations/environment_canada.markdown index 39ff7c889a7..a7b949a7d3b 100644 --- a/source/_integrations/environment_canada.markdown +++ b/source/_integrations/environment_canada.markdown @@ -1,7 +1,6 @@ --- title: Environment Canada description: Weather data from Environment Canada. -logo: environment_canada.png ha_category: - Weather - Sensor diff --git a/source/_integrations/epsonworkforce.markdown b/source/_integrations/epsonworkforce.markdown index f52d484d892..5a8ab2f6159 100644 --- a/source/_integrations/epsonworkforce.markdown +++ b/source/_integrations/epsonworkforce.markdown @@ -60,6 +60,7 @@ Supported devices: Tested devices: +- Epson WF2660 - Epson WF3540 - Epson WF3620 - Epson WF3640 diff --git a/source/_integrations/ezviz.markdown b/source/_integrations/ezviz.markdown index 232e139e102..8c76eb83e17 100644 --- a/source/_integrations/ezviz.markdown +++ b/source/_integrations/ezviz.markdown @@ -1,12 +1,14 @@ --- -title: "Ezviz Camera" -description: "Integrate Ezviz camera within Home Assistant." +title: Ezviz +description: Integrate Ezviz camera within Home Assistant. logo: ezviz.png ha_release: 0.107 ha_category: - Camera ha_iot_class: Cloud Polling ha_domain: ezviz +ha_codeowners: + - '@baqs' --- The `ezviz` sensor platform uses the EzvizLife API to interact with the devices. diff --git a/source/_integrations/filesize.markdown b/source/_integrations/filesize.markdown index b71079ea6d2..50613cb1ef9 100644 --- a/source/_integrations/filesize.markdown +++ b/source/_integrations/filesize.markdown @@ -8,7 +8,13 @@ ha_release: 0.64 ha_domain: filesize --- -The `filesize` sensor for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). +The `filesize` sensor is for displaying the size in MB of a file. + ++ +File paths must also be added to [whitelist_external_dirs](/docs/configuration/basic/) in your `configuration.yaml`. + +## Configuration diff --git a/source/_integrations/free_mobile.markdown b/source/_integrations/free_mobile.markdown index 4cc588007b9..0d5af30f4d1 100644 --- a/source/_integrations/free_mobile.markdown +++ b/source/_integrations/free_mobile.markdown @@ -1,7 +1,6 @@ --- title: Free Mobile description: Instructions on how to add user notifications to Home Assistant. -logo: free_mobile.png ha_category: - Notifications ha_release: 0.11 diff --git a/source/_integrations/freebox.markdown b/source/_integrations/freebox.markdown index 226b9ea1e19..e12e7e4f2a5 100644 --- a/source/_integrations/freebox.markdown +++ b/source/_integrations/freebox.markdown @@ -10,6 +10,8 @@ ha_release: 0.85 ha_iot_class: Local Polling ha_codeowners: - '@snoof85' + - '@Quentame' +ha_config_flow: true ha_domain: freebox --- @@ -17,15 +19,26 @@ The `freebox` integration allows you to observe and control [Freebox router](htt There is currently support for the following device types within Home Assistant: -* [Sensor](#sensor) with traffic metrics +* [Sensor](#sensor) with traffic and temperature metrics * [Device tracker](#presence-detection) for connected devices * [Switch](#switch) to control Wi-Fi ## Configuration -If you have enabled the [discovery component](/integrations/discovery/), -your Freebox should be detected automatically. Otherwise, you can set it -up manually in your `configuration.yaml` file: +If you have enabled the [discovery integration](/integrations/discovery/), your Freebox should be detected automatically. +Otherwise, you can set it up manually via the frontend or via your `configuration.yaml` file. + +You can find out your Freebox host and port by opening this address-If you change your Freebox router for a new one, you need to delete the `freebox.conf` file located in your Home Assistant configuration directory to make the association again. + If you change your Freebox router for a new one, go into your Home Assistant configuration `.storage` folder and delete the "freebox" folder, then add the integration again.### Initial setup-You must have set a password for your Freebox router web administration page. Enable the option "Permettre les nouvelles demandes d'associations" and check that the option "Accès à distance sécurisé à Freebox OS" is active in "Gestion des ports" > "Connexions entrantes". + + You must have set a password for your Freebox router web administration page. Enable the option "Permettre les nouvelles demandes d'associations" and check that the option "Accès à distance sécurisé à Freebox OS" is active in "Gestion des ports" > "Connexions entrantes". +-The first time Home Assistant will connect to your Freebox, you will need to -authorize it by pressing the right arrow on the facade of the Freebox when -prompted to do so. +The first time Home Assistant will connect to your Freebox, you will need to authorize it by pressing the right arrow on the facade of the Freebox when prompted to do so. -To make the Wi-Fi switch and the reboot service working you will have to add "Modification des réglages de la Freebox -" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications". +To make the Wi-Fi switch and the reboot service working you will have to add "Modification des réglages de la Freebox" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications". ### Supported routers @@ -77,8 +85,7 @@ Only the routers with Freebox OS are supported: ## Presence Detection -This platform offers presence detection by keeping track of the -devices connected to a [Freebox](https://www.free.fr/) router. +This platform offers presence detection by keeping track of the devices connected to a [Freebox](https://www.free.fr/) router. ### Notes @@ -93,8 +100,8 @@ refreshes the devices states. ## Sensor -This platform offers you sensors to monitor a Freebox router. The monitored conditions are -instant upload and download rates in KB/s. +This platform offers you sensors to monitor a Freebox router. +The monitored conditions are internal temperature and upload and download rates in KB/s. ## Service diff --git a/source/_integrations/fritzbox_netmonitor.markdown b/source/_integrations/fritzbox_netmonitor.markdown index 5eb68db473b..feac908879d 100644 --- a/source/_integrations/fritzbox_netmonitor.markdown +++ b/source/_integrations/fritzbox_netmonitor.markdown @@ -51,7 +51,3 @@ The following statistics will be exposed as attributes. |max_byte_rate_down |Maximum downstream-rate in bytes/s | The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost). - --This integration does not support "FRITZ!Box 6490 Cable" with FritzOS 6.87 installed. -diff --git a/source/_integrations/garmin_connect.markdown b/source/_integrations/garmin_connect.markdown index efa7f6692ba..aac4d4f8be9 100644 --- a/source/_integrations/garmin_connect.markdown +++ b/source/_integrations/garmin_connect.markdown @@ -105,4 +105,14 @@ Latest Respiration Update Highest Respiration Lowest Respiration Latest Respiration + +Weight +BMI +Body Fat +Body Water +Body Mass +Muscle Mass +Physique Rating +Visceral Fat +Metabolic Age ``` diff --git a/source/_integrations/gdacs.markdown b/source/_integrations/gdacs.markdown index bcc229c229a..5ba90e242cd 100644 --- a/source/_integrations/gdacs.markdown +++ b/source/_integrations/gdacs.markdown @@ -135,7 +135,3 @@ gdacs: latitude: -41.2 longitude: 174.7 ``` - -## Locations NOT supported: - -- Ireland diff --git a/source/_integrations/griddy.markdown b/source/_integrations/griddy.markdown index c01a0967d37..6ebc9080d11 100644 --- a/source/_integrations/griddy.markdown +++ b/source/_integrations/griddy.markdown @@ -1,5 +1,5 @@ --- -title: Griddy +title: Griddy Power description: Instructions on how to integrate griddy prices into Home Assistant. ha_category: - Sensor diff --git a/source/_integrations/growatt_server.markdown b/source/_integrations/growatt_server.markdown index eb11a162375..24f57f8116c 100644 --- a/source/_integrations/growatt_server.markdown +++ b/source/_integrations/growatt_server.markdown @@ -1,7 +1,6 @@ --- title: Growatt description: Instructions on how to integrate your Growatt server solar inverter within Home Assistant. -logo: growatt.png ha_category: - Sensor - Energy diff --git a/source/_integrations/harmony.markdown b/source/_integrations/harmony.markdown index bf442ed432d..e06c50b1313 100644 --- a/source/_integrations/harmony.markdown +++ b/source/_integrations/harmony.markdown @@ -6,8 +6,11 @@ ha_category: - Remote ha_iot_class: Local Push ha_release: 0.34 +ha_config_flow: true ha_codeowners: - '@ehendrix23' + - '@bramkragten' + - '@bdraco' ha_domain: harmony --- @@ -19,10 +22,13 @@ Supported units: - Harmony Companion - Harmony Pro - Harmony Elite +- Harmony Pro 2400 -The preferred way to setup the Harmony remote is by enabling the [discovery component](/integrations/discovery/). +The preferred way to setup the Harmony remote for your installation is via **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Logitech Harmony Hub**. -However, if you want to manually configure the device, you will need to add its settings to your `configuration.yaml` file: +Once `Logitech Harmony Hub` has been configured, the default activity and duration in seconds between sending commands to a device can be adjusted in the settings via **Configuration** >> **Integrations** >> **Your Logitech Harmony Hub** + +Alternatively, if you want to manually configure the device, you will need to add its settings to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -30,14 +36,6 @@ remote: - platform: harmony name: Bedroom host: 10.168.1.13 -``` - -You can override some default configuration values on a discovered hub (e.g., the `port` or `activity`) by adding a `configuration.yaml` setting. In this case leave the `host` setting empty so the platform will discover the host IP automatically, but set the `name` in the configuration to match exactly the name you have set for your Hub so the platform knows what Hub you are trying to configure. - -```yaml -# Example configuration.yaml entry with discovery - - platform: harmony - name: Living Room activity: Watch TV ``` @@ -48,13 +46,8 @@ name: type: string host: description: The Harmony device's IP address. Leave empty for the IP to be discovered automatically. - required: false + required: true type: string -port: - description: The Harmony device's port. - required: false - type: integer - default: 5222 activity: description: Activity to use when `turn_on` service is called without any data. Overrides the `activity` setting for this discovered hub. required: false @@ -64,16 +57,11 @@ delay_secs: required: false type: float default: 0.4 -hold_secs: - description: Default duration in seconds between sending the "press" command and sending the "release" command. - required: false - type: integer - default: 0 {% endconfiguration %} ### Configuration file -Upon startup one file will be written to your Home Assistant configuration directory per device in the following format: `harmony_REMOTENAME.conf`. The file will contain: +Upon startup one file will be written to your Home Assistant configuration directory per device in the following format: `harmony_UNIQUE_ID.conf`. The file will contain: - List of all programmed activity names and ID numbers - List of all programmed device names and ID numbers diff --git a/source/_integrations/haveibeenpwned.markdown b/source/_integrations/haveibeenpwned.markdown index 2acd832aa6f..f931c6c3365 100644 --- a/source/_integrations/haveibeenpwned.markdown +++ b/source/_integrations/haveibeenpwned.markdown @@ -13,12 +13,6 @@ The `haveibeenpwned` sensor platform creates sensors that check for breached ema ## Configuration -- - The HaveIBeenPwned API is no longer a free API. For more information about this change read the HIBP creator's [blogpost regarding the change](https://www.troyhunt.com/authentication-and-the-have-i-been-pwned-api/). - -- In order to use this integration you need to purchase an API key. Visit the [API key page](https://haveibeenpwned.com/API/Key) on the HIBP website to purchase one. ## Configuration diff --git a/source/_integrations/heos.markdown b/source/_integrations/heos.markdown index 3c9b67b8227..d077e4d7962 100644 --- a/source/_integrations/heos.markdown +++ b/source/_integrations/heos.markdown @@ -47,17 +47,15 @@ A connection to a single device enables control for all devices on the network. Use the sign-in service to sign the connected controller into a HEOS account so that it can retrieve and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload: -```json -{ - "username": "example@example.com", - "password": "password" -} +```yaml +username: "example@example.com" +password: "password" ``` -| Attribute | Description -| ---------------------- | ---------------------------------------------------------| -| `username` | The username or email of the HEOS account. [Required] -| `password` | The password of the HEOS account. [Required] +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `username` | no | The username or email of the HEOS account. +| `password` | no | The password of the HEOS account. ### Service `heos.sign_out` @@ -69,73 +67,65 @@ Use the sign-out service to sign the connected controller out of a HEOS account. You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload: -```json -{ - "entity_id": "media_player.office", - "media_content_type": "favorite", - "media_content_id": "1" -} +```yaml +entity_id: media_player.office +media_content_type: "favorite" +media_content_id: "1" ``` -| Attribute | Description -| ---------------------- | ---------------------------------------------------------| -| `entity_id` | `entity_id` of the player -| `media_content_type` | Set to the value `favorite` -| `media_content_id` | The nubmer (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | `entity_id` of the player(s) +| `media_content_type` | no | Set to the value `favorite` +| `media_content_id` | no | (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite #### Play Playlist You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload: -```json -{ - "entity_id": "media_player.office", - "media_content_type": "playlist", - "media_content_id": "Awesome Music" -} +```yaml +entity_id: media_player.office +media_content_type: "playlist" +media_content_id: "Awesome Music" ``` -| Attribute | Description -| ---------------------- | ---------------------------------------------------------| -| `entity_id` | `entity_id` of the player -| `media_content_type` | Set to the value `playlist` -| `media_content_id` | The name of the HEOS playlist +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | `entity_id` of the player(s) +| `media_content_type` | no | Set to the value `playlist` +| `media_content_id` | no | The name of the HEOS playlist #### Play Quick Select You can play a HEOS Quick Select by nubmer or name with the `media_player.play_media` service. Example service data payload: -```json -{ - "entity_id": "media_player.office", - "media_content_type": "quick_select", - "media_content_id": "1" -} +```yaml +entity_id: media_player.office +media_content_type: "quick_select" +media_content_id": "1" ``` -| Attribute | Description -| ---------------------- | ---------------------------------------------------------| -| `entity_id` | `entity_id` of the player -| `media_content_type` | Set to the value `quick_select` -| `media_content_id` | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`) +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | `entity_id` of the player(s) +| `media_content_type` | no | Set to the value `quick_select` +| `media_content_id` | no | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`) #### Play URL You can play a URL through a HEOS media player using the `media_player.play_media` service. The HEOS player must be able to reach the URL. Example service data payload: -```json -{ - "entity_id": "media_player.office", - "media_content_type": "url", - "media_content_id": "http://path.to/stream.mp3" -} +```yaml +entity_id: media_player.office +media_content_type: "url" +media_content_id: "http://path.to/stream.mp3" ``` -| Attribute | Description -| ---------------------- | ---------------------------------------------------------| -| `entity_id` | `entity_id` of the player to play the URL -| `media_content_type` | Set to the value `url` -| `media_content_id` | The full URL to the stream +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | `entity_id` of the player(s) to play the URL +| `media_content_type` | no | Set to the value `url` +| `media_content_id` | no | The full URL to the stream ## Notes diff --git a/source/_integrations/here_travel_time.markdown b/source/_integrations/here_travel_time.markdown index a9c3576a26f..fc28c2f3785 100644 --- a/source/_integrations/here_travel_time.markdown +++ b/source/_integrations/here_travel_time.markdown @@ -89,6 +89,15 @@ traffic_mode: required: false type: boolean default: false +arrival: + description: "Time when travel is expected to end. A 24 hour time string like `08:00:00`. On a sensor update it will be combined with the current date to get travel time for that moment. Cannot be used in combination with `departure`. Can only be used in combination with `mode: publicTransportTimeTable`" + required: false + type: time +departure: + description: "Time when travel is expected to end. A 24 hour time string like `08:00:00`. On a sensor update it will be combined with the current date to get travel time for that moment. Cannot be used in combination with `arrival`. The default is now (the current date and time)" + required: false + type: time + default: "now" unit_system: description: "You can choose between `metric` or `imperial`." required: false @@ -125,9 +134,8 @@ sensor: route_mode: fastest traffic_mode: false unit_system: imperial + departure: "17:00:00" scan_interval: 2678400 # 1 month - - ``` ## Entity Tracking diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown index 203969b0b1d..f7ead7e9eae 100644 --- a/source/_integrations/homekit_controller.markdown +++ b/source/_integrations/homekit_controller.markdown @@ -36,7 +36,7 @@ There is currently support for the following device types within Home Assistant: - Cover (HomeKit garage door openers, windows, or window coverings) - Light (HomeKit lights) - Lock (HomeKit lock) -- Switch (HomeKit switches) +- Switch (HomeKit switches, outlets and valves) - Binary Sensor (HomeKit motion, contact, occupancy and smoke sensors) - Sensor (HomeKit humidity, temperature, co2 and light level sensors) - Fan diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown index b7ea20cca01..ee22deabef7 100644 --- a/source/_integrations/homematic.markdown +++ b/source/_integrations/homematic.markdown @@ -477,7 +477,7 @@ The `homematic` notification platform enables invoking Homematic devices. To use this notification platform in your installation, add the following to your `configuration.yaml` file: -## Configuration +### Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/http.markdown b/source/_integrations/http.markdown index fb15340d193..fae6ab3e9e5 100644 --- a/source/_integrations/http.markdown +++ b/source/_integrations/http.markdown @@ -154,7 +154,7 @@ Please note, that sources from `trusted_networks` won't be banned automatically. ## Hosting files -If you want to use Home Assistant to host or serve static files then create a directory called `www` under the configuration path (`/config` on Hass.io, `.homeassistant` elsewhere). The static files in `www/` can be accessed by the following URL `http://your.domain:8123/local/`, for example `audio.mp3` would be accessed as `http://your.domain:8123/local/audio.mp3`. +If you want to use Home Assistant to host or serve static files then create a directory called `www` under the configuration path (`/config`). The static files in `www/` can be accessed by the following URL `http://your.domain:8123/local/`, for example `audio.mp3` would be accessed as `http://your.domain:8123/local/audio.mp3`.diff --git a/source/_integrations/hue.markdown b/source/_integrations/hue.markdown index f0d49984b4c..764620f7a22 100644 --- a/source/_integrations/hue.markdown +++ b/source/_integrations/hue.markdown @@ -14,20 +14,20 @@ ha_codeowners: ha_domain: hue --- -Philips Hue support is integrated into Home Assistant as a hub that can drive the light and sensor platforms. The preferred way to set up the Philips Hue platform is by enabling the [discovery component](/integrations/discovery/). +The Philips Hue integration allows you to control and monitor the lights and motion sensors connected to your Hue bridge. The preferred way to set up the Philips Hue integration is by enabling [discovery](/integrations/discovery/). There is currently support for the following device types within Home Assistant: - Lights - Motion sensors (including temperature and light level sensors) -The hub can be set up by navigating to the Configuration tab in the sidebar and selecting Integrations. You will see "Philips Hue" in the discovered section. Click configure and you will be presented with the initiation dialog. This will prompt you to press the Hue button on your bridge to register the hub in Home Assistant. After you click submit, you will have the opportunity to select the area that your bridge is located. +To set up this integration, click Configuration in the sidebar and then click Integrations. You should see "Philips Hue" in the discovered section (if you do not, click the + icon in the lower right and find Philips Hue). Click configure and you will be presented with the initiation dialog. This will prompt you to press the button on your Hue bridge to register the hub with Home Assistant. After you click submit, you will have the opportunity to select the area that your bridge is located. When you configure the Hue bridge from Home Assistant, it writes a token to a file in your Home Assistant [configuration directory](/docs/configuration/). That token authenticates the communication with the Hue bridge. This token uses the IP address of the bridge. If the IP address for the bridge changes, you will need to register it with Home Assistant again. To avoid this, you may set up a DHCP reservation on your router for your Hue bridge so that it always has the same IP address. Once registration is complete you should see the Hue lights listed as `light` entities, the Hue motion sensors listed as `binary_sensor` entities, and the Hue temperature and light level sensors (which are built in to the motion sensors) listed as `sensor` entities. If you don't, you may have to restart Home Assistant once more. -If you want to enable the integration without relying on the [discovery component](/integrations/discovery/), add the following lines to your `configuration.yaml` file: +If you want to enable the integration without relying on [discovery](/integrations/discovery/), add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -50,7 +50,7 @@ allow_hue_groups: description: Disable this to stop Home Assistant from importing the groups defined on the Hue bridge. required: false type: boolean - default: true + default: false {% endconfiguration %} ## Examples @@ -92,7 +92,7 @@ To create a `LightGroup` named `Ceiling lights` that contains the lights 1, 2, a $ curl -XPOST -d '{"name": "Ceiling lights", "lights": ["1", "2", "3"]}' http:///api/ /groups ``` -The ` ` is the string that is used to register Home Assistant on the bridge. You can find it in the `core.config_entries` file in your configuration\.storage path. ` ` is the IP address or hostname of your Hue bridge. +The ` ` is the string that is used to register Home Assistant with the bridge. You can find it in the `core.config_entries` file in `/PATH-TO-YOUR-CONFIGURATION/.storage/`. ` ` is the IP address or hostname of your Hue bridge. You can find the IDs of your lights by executing the following command: @@ -110,9 +110,9 @@ More information can be found on the [Philips Hue API documentation](https://www ### Using Hue Scenes in Home Assistant -The Hue platform has its own concept of scenes for setting the colors of a group of lights at once. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them—many that you've never used, and almost all very poorly named. +The Hue platform has its own concept of scenes for setting the colors of a group of lights simultaneously. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them—many that you've never used, and almost all very poorly named. -To avoid user interface overload, we don't expose scenes directly. Instead there is a hue.hue_activate_scene service which can be used by `automation` or `script` components. +To avoid user interface overload, we don't expose scenes directly. Instead there is a `hue.hue_activate_scene` service which can be used in an automation or script. This will have all the bulbs transitioned at once, instead of one at a time like when using standard scenes in Home Assistant. For instance: @@ -136,15 +136,13 @@ _Note_: `group_name` is not a reference to a Home Assistant group name. It can o ### Finding Group and Scene Names -How do you find these names? +The easiest way to find Hue scene names is to only use the scenes from the 2nd generation Hue app, which are organized by room (group) and scene name. Use the room name and scene name that you see in the app. You can test that these work at Developer Tools > Services in your Home Assistant instance. -The easiest way to do this is to only use the scenes from the 2nd generation Hue app, which is organized by room (group) and scene name. Use the values of room name and scene name that you see in the app. You can test that these work by using the `dev-service` console of your Home Assistant instance. - -Alternatively, you can dump all rooms and scene names using this [gist](https://gist.github.com/sdague/5479b632e0fce931951c0636c39a9578). This does **not** tell you which groups and scenes work together, but it is sufficient to get values that you can test in the `dev-service` console. +Alternatively, you can dump all rooms and scene names using this [gist](https://gist.github.com/sdague/5479b632e0fce931951c0636c39a9578). This does **not** tell you which groups and scenes work together, but it is sufficient to get values that you can test at Developer Tools > Services. ### Caveats -The Hue API doesn't activate scenes directly; rather, they must be associated with a Hue group (typically rooms, especially if using the 2nd gen app). But Hue scenes don't actually reference their group. So heuristic matching is used. +The Hue API doesn't activate scenes directly; rather, they must be associated with a Hue group (typically rooms, especially if using the 2nd generation Hue app). But Hue scenes don't actually reference their group, so heuristic matching is used. Neither group names nor scene names are guaranteed unique in Hue. If you are observing unexpected behavior from calling Hue scenes in Home Assistant, make the names of your Hue scenes more specific in the Hue app. diff --git a/source/_integrations/iammeter.markdown b/source/_integrations/iammeter.markdown index a799893f78e..f2dd913ac29 100644 --- a/source/_integrations/iammeter.markdown +++ b/source/_integrations/iammeter.markdown @@ -1,6 +1,6 @@ --- -title: "iammeter" -description: "Instructions on how to integrate IAMMETER sensor within Home Assistant." +title: IamMeter +description: Instructions on how to integrate IAMMETER sensor within Home Assistant. logo: iammeter-logo.png ha_category: - Energy @@ -8,6 +8,8 @@ ha_category: ha_release: 0.107 ha_iot_class: Local Polling ha_domain: iammeter +ha_codeowners: + - '@lewei50' --- `iammeter` provides real-time readings of single-phase (WEM3080, WEM3162) and three-phase (WEM3080T) meters from [IAMMETER](https://www.iammeter.com) over Wi-Fi. diff --git a/source/_integrations/imap_email_content.markdown b/source/_integrations/imap_email_content.markdown index 859e995035f..343ae525e98 100644 --- a/source/_integrations/imap_email_content.markdown +++ b/source/_integrations/imap_email_content.markdown @@ -73,7 +73,7 @@ value_template: description: The date and time the email was sent. {% endconfiguration %} -## Example +## Example - keyword spotting The following example shows the usage of the IMAP email content sensor to scan the subject of an email for text, in this case, an email from the APC SmartConnect service which tells whether the UPS is running on battery or not. @@ -98,3 +98,46 @@ sensor: {% endraw %} The same template structure can scan the date, body or sender for matching text before setting the state of the sensor. + +## Example - extracting formatted text from an email using template sensors + +This example shows how to extract numbers or other formatted data from an email to change the value of a template sensor to a value extracted from the email. In this example, we will be extracting energy use, cost, and billed amount from an email (from Georgia Power) and putting it into sensor values using a template sensor that runs against our IMAP email sensor already set up. A sample of the body of the email used is below: + +```text +Yesterday's Energy Use: 76 kWh +Yesterday's estimated energy cost: $8 +Monthly Energy use-to-date for 23 days: 1860 kWh +Monthly estimated energy cost-to-date for 23 days: $198 + +To view your account for details about your energy use, please click here. +``` + +Below is the template sensor which extracts the information from the body of the email in our IMAP email sensor (named sensor.energy_email) into 3 sensors for the energy use, daily cost, and billing cycle total. + +{% raw %} +```yaml +sensor: + - platform: template + sensors: + previous_day_energy_use: + friendly_name: Previous Day Energy Use + unit_of_measurement: kWh + value_template: > + {{ state_attr('sensor.energy_email','body') + |regex_findall_index("\*Yesterday's Energy Use:\* ([0-9]+) kWh") }} + previous_day_cost: + friendly_name: Previous Day Cost + unit_of_measurement: $ + value_template: > + {{ state_attr('sensor.energy_email', 'body') + |regex_findall_index("\*Yesterday's estimated energy cost:\* \$([0-9.]+)") }} + billing_cycle_total: + friendly_name: Billing Cycle Total + unit_of_measurement: $ + value_template: > + {{ state_attr('sensor.energy_email', 'body') + |regex_findall_index("\ days:\* \$([0-9.]+)") }} +``` +{% endraw %} + +By making small changes to the regular expressions defined above, a similar structure can parse other types of data out of the body of other emails. diff --git a/source/_integrations/influxdb.markdown b/source/_integrations/influxdb.markdown index 9f944b7df70..636852852f2 100644 --- a/source/_integrations/influxdb.markdown +++ b/source/_integrations/influxdb.markdown @@ -12,7 +12,7 @@ ha_codeowners: ha_domain: influxdb --- -The `influxdb` integration makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or if you're using Hass.io, [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available. +The `influxdb` integration makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available. There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown index 144b5a4c138..598fb08b552 100644 --- a/source/_integrations/input_number.markdown +++ b/source/_integrations/input_number.markdown @@ -56,7 +56,7 @@ input_number: type: float default: The value at shutdown step: - description: Step value for the slider. Smallest value `0.001`. + description: Step value. Smallest value `0.001`. required: false type: float default: 1 diff --git a/source/_integrations/iperf3.markdown b/source/_integrations/iperf3.markdown index 84f04b742f4..b00362a38c7 100644 --- a/source/_integrations/iperf3.markdown +++ b/source/_integrations/iperf3.markdown @@ -118,7 +118,3 @@ Example Service data: ```json {"host": "192.168.0.121"} ``` - -## Notes - -- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. diff --git a/source/_integrations/ipp.md b/source/_integrations/ipp.md new file mode 100644 index 00000000000..9b1e5929e93 --- /dev/null +++ b/source/_integrations/ipp.md @@ -0,0 +1,21 @@ +--- +title: Internet Printing Protocol (IPP) +description: Instructions on how to integrate printers that support the Internet Printing Protocol (IPP) into Home Assistant. +ha_category: + - System Monitor +ha_release: 0.108 +ha_iot_class: Local Polling +ha_config_flow: true +ha_quality_scale: platinum +ha_codeowners: + - '@ctalkington' +ha_domain: ipp +--- + +The `Internet Printing Protocol (IPP)` integration allows you to read current data from your networked printer that supports the [Internet Printing Protocol](https://www.pwg.org/ipp/everywhere.html). + +It provides information about the printer's state and remaining ink levels. + +## Configuration + +To add `Internet Printing Protocol (IPP)` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Internet Printing Protocol (IPP)**. diff --git a/source/_integrations/iqvia.markdown b/source/_integrations/iqvia.markdown index b64bd5ecfbb..805ebd272a1 100644 --- a/source/_integrations/iqvia.markdown +++ b/source/_integrations/iqvia.markdown @@ -23,8 +23,7 @@ Data measured includes: ## Configuring the Platform To integrate `iqvia` into Home Assistant, add the following section to your -`configuration.yaml` file (adjusting the `monitored_conditions` list to your -liking): +`configuration.yaml` file: ```yaml iqvia: diff --git a/source/_integrations/kef.markdown b/source/_integrations/kef.markdown index fddf9941b9b..01f3c1348e6 100644 --- a/source/_integrations/kef.markdown +++ b/source/_integrations/kef.markdown @@ -74,7 +74,7 @@ supports_on: type: integer {% endconfiguration %} -## Advanced configuration example +## Advanced - configuration example ```yaml # Example configuration.yaml entry @@ -87,7 +87,90 @@ media_player: volume_step: 0.05 ``` -Notes: +## Services + +Just like in the KEF Control app, we can change the digital signal processing (DSP) settings. + +The speaker's current DSP settings are updated automatically each hour and after each service call. +To update the settings manually, use `kef.update_dsp`. + +### Service `kef.update_dsp` + +Update all DSP settings. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| entity_id | No | The entity_id of the KEF speaker. | + +### Service `kef.set_mode` + +Set the mode of the speaker. When optional attributes are left out, the setting will be unchanged. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| entity_id | No | The entity_id of the KEF speaker. | +| desk_mode | Yes | "Desk mode" (`true` or `false`) | +| wall_mode | Yes | "Wall mode" (`true` or `false`) | +| phase_correction | Yes | "Phase correction" (`true` or `false`) | +| high_pass | Yes | "High-pass mode" (`true` or `false`) | +| sub_polarity | Yes | "Sub polarity" (`-` or `+`) | +| bass_extension | Yes | "Bass extension" selector (`Less`, `Standard`, or `Extra`) | + +### Service `kef.set_desk_db` + +Set the "Desk mode" slider of the speaker in dB. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| entity_id | No | The entity_id of the KEF speaker. | +| db_value | No | Value of the slider (-6 to 0 with steps of 0.5) | + +### Service `kef.set_wall_db` + +Set the "Wall mode" slider of the speaker in dB. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| entity_id | No | The entity_id of the KEF speaker. | +| db_value | No | Value of the slider (-6 to 0 with steps of 0.5) | + +### Service `kef.set_treble_db` + +Set desk the "Treble trim" slider of the speaker in dB. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| entity_id | No | The entity_id of the KEF speaker. | +| db_value | No | Value of the slider (-2 to 2 with steps of 0.5) | + +### Service `kef.set_high_hz` + +Set the "High-pass mode" slider of the speaker in Hz. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| entity_id | No | The entity_id of the KEF speaker. | +| hz_value | No | Value of the slider (50 to 120 with steps of 5) | + +### Service `kef.set_low_hz` + +Set the "Sub out low-pass frequency" slider of the speaker in Hz. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| entity_id | No | The entity_id of the KEF speaker. | +| hz_value | No | Value of the slider (40 to 250 with steps of 5) | + +### Service `kef.set_sub_db` + +Set the "Sub gain" slider of the speaker in dB. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| entity_id | No | The entity_id of the KEF speaker. | +| db_value | No | Value of the slider (-10 to 10 with steps of 1) | + +## Notes - The LS50 Wireless was tested with the latest firmware of 19-11-2019: `p6.3001902221.105039422` and older firmware: `p6.2101809171.105039422` - The LSX Wireless was tested with the latest firmware of 10-10-2019 v4.1: `p20.4101909240.105243` diff --git a/source/_integrations/konnected.markdown b/source/_integrations/konnected.markdown index 8849ee4be7a..f079ec0216d 100644 --- a/source/_integrations/konnected.markdown +++ b/source/_integrations/konnected.markdown @@ -66,23 +66,33 @@ The settings UI starts by having you configure the general behavior of each zone ##### Binary Sensor: **Binary Sensor Type:** The type of sensor connected to the zone. + **Name (optional)** The friendly name for the entity associated with the zone. + **Invert the open/close state:** Inverts the open/closed meaning of a binary sensor circuit. Commonly needed for normally open wired smoke alarm circuits. ##### Digital Sensor: **Sensor Type:** The type of sensor connected to the zone - either `dht` or `ds18b20`. + **Name (optional)** The friendly name for the entities associated with the zone. + **Poll Interval (optional):** How often in minutes to poll the sensor for updates. ##### Switchable Output: **Name: (optional)** The friendly name for the entity associated with the zone. + **Output when on:** The state of the switch when activated. + **Pulse Duration (optional):** The duration in ms to pulse the switch once activated. + **Pause between pulses (optional):** The duration in ms to wait between pulses when activated. + **Times to repeat (optional):** The number of times to repeat the pulse each time the switch is activated. +**Configure additional states for this zone:** Selecting "No" will complete configuration for the zone and proceed to options for the next zone. Select "Yes" if you need to create additional output states for this zone. + ### YAML Configuration If you prefer you can utilize a `konnected` section in the `configuration.yaml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them. If using `configuration.yaml` the configuration will be one-time imported when going through the Configuration Flow for the panel. **Note that you must still complete the UI based setup before the integration will be configured and entities created/accessible.** @@ -314,6 +324,10 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use ## Revision History +### 0.108 + +- Multiple output states for a zone. + ### 0.106 - Added information on configuration and options flow. Mention that alarm panel FW should be updated before connecting. diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown index d39547064dc..ecad4a4297a 100644 --- a/source/_integrations/lcn.markdown +++ b/source/_integrations/lcn.markdown @@ -1,7 +1,6 @@ --- title: LCN description: Instructions on how to integrate LCN components with Home Assistant. -logo: lcn.png ha_category: - Hub - Binary Sensor diff --git a/source/_integrations/linode.markdown b/source/_integrations/linode.markdown index cefdb5e8a7f..885aa55f0f5 100644 --- a/source/_integrations/linode.markdown +++ b/source/_integrations/linode.markdown @@ -5,7 +5,6 @@ ha_category: - System Monitor - Binary Sensor - Switch -logo: linode.png ha_release: 0.57 ha_iot_class: Cloud Polling ha_domain: linode diff --git a/source/_integrations/luci.markdown b/source/_integrations/luci.markdown index 61383e46d71..f5b25501e19 100644 --- a/source/_integrations/luci.markdown +++ b/source/_integrations/luci.markdown @@ -11,8 +11,6 @@ ha_codeowners: ha_domain: luci --- -_This is one of multiple ways we support OpenWrt. For an overview, see [OpenWrt](/integrations/openwrt/)._ - This is a presence detection scanner for OpenWrt using [luci](https://openwrt.org/docs/techref/luci). Before this scanner can be used you have to install the luci RPC package on OpenWRT: diff --git a/source/_integrations/lutron.markdown b/source/_integrations/lutron.markdown index 32237caff57..f07a1aadda3 100644 --- a/source/_integrations/lutron.markdown +++ b/source/_integrations/lutron.markdown @@ -1,7 +1,6 @@ --- title: Lutron description: Instructions on how to use Lutron devices with Home Assistant. -logo: lutron.png ha_category: - Hub - Cover @@ -75,7 +74,7 @@ After setup, scenes will appear in Home Assistant using the area, keypad and but ## Occupancy Sensors -Any configured Powr Savr occuancy sensors will be added as occupancy binary sensors. Lutron reports occupancy for an area, rather than reporting individual sensors. Sensitivity and timeouts are controlled on the sensors themselves, not in software. +Any configured Powr Savr occupancy sensors will be added as occupancy binary sensors. Lutron reports occupancy for an area, rather than reporting individual sensors. Sensitivity and timeouts are controlled on the sensors themselves, not in software. ## Example Automations diff --git a/source/_integrations/lutron_caseta.markdown b/source/_integrations/lutron_caseta.markdown index f087344f856..a815ef68e44 100644 --- a/source/_integrations/lutron_caseta.markdown +++ b/source/_integrations/lutron_caseta.markdown @@ -9,22 +9,24 @@ ha_category: - Scene - Switch - Fan + - Binary Sensor ha_release: 0.41 ha_iot_class: Local Polling ha_domain: lutron_caseta --- -[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](https://www.casetawireless.com/) product line of dimmers, switches and shades. +[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](https://www.casetawireless.com/) product line of dimmers, switches, shades, and sensors. It will also communicate with the Lutron Radio RA2 Main Repeater for the [RA2 Select](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RA2Select/Overview.aspx) product line of dimmers, switches, shades, and sensors. -This integration only supports the [Caseta](https://www.casetawireless.com/) line of products. Both Smart Bridge (L-BDG2-WH) and Smart Bridge PRO (L-BDGPRO2-WH) models are supported. For the RadioRA 2 product line, see the [Lutron component](/integrations/lutron/). +This integration only supports the [Caseta](https://www.casetawireless.com/) line of products. The Smart Bridge (L-BDG2-WH), Smart Bridge PRO (L-BDGPRO2-WH), and RA2 Select (RR-SEL-REP2-BL) models are supported. For the RadioRA 2 and HomeWorks QS product lines, see the [Lutron component](/integrations/lutron/). -The currently supported Caseta devices are: +The currently supported Caseta and RA2 Select devices are: - Wall and plug-in dimmers as [lights](#light) - Wall switches as [switches](#switch) - Scenes as [scenes](#scene) - Lutron shades as [covers](#cover) - Lutron smart [fan](#fan) speed control +- Lutron Occupancy/Vacancy [sensors](#sensor) When configured, the `lutron_caseta` integration will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Lamp' in a room called 'Bedroom' becomes `light.bedroom_lamp` in Home Assistant. @@ -115,3 +117,17 @@ After setup, fans will appear in Home Assistant using an `entity_id` based on th For more information on working with fans in Home Assistant, see the [Fans component](/components/fan/). Available services: `fan.turn_on`, `fan.turn_off`, and `fan.set_speed`. + +## Sensor + +Occupancy sensors can be added to a Lutron Caseta system to trigger events when an area becomes vacant and, optionally, occupied. However, Lutron systems report occupancy and vacancy statuses only in *occupancy groups* -- that is, groups of one or more sensors. + +Occupancy groups will appear in Home Assistant using an `entity_id` based on the area name in which the first sensor of the group is located. For example, one or more sensors in the Master Bathroom will appear in Home Assistant as `binary_sensor.master_bathroom_occupancy`. + +An occupancy group is considered occupied if any of the sensors in the group are currently in an "occupied" state. Specifically, this means that motion has been detected more recently than that sensor's particular timeout setting. Only after all sensors in an occupancy group report being vacant does the occupancy group itself report being vacant. + +Lutron Caseta occupancy sensors support 4 different timeouts and 3 different sensitivity levels, but those are only controllable from the devices themselves and cannot be set from either Home Assistant or even the Caseta mobile app. + +Because Lutron Caseta devices automatically report state to Home Assistant (rather than relying on polling), occupancy status updates occur almost instantaneously. + +For more information on working with binary sensors in Home Assistant, see the [Binary Sensors Component](/components/binary_sensor/) diff --git a/source/_integrations/met.markdown b/source/_integrations/met.markdown index 433bd0450bb..6a1340ccc3d 100644 --- a/source/_integrations/met.markdown +++ b/source/_integrations/met.markdown @@ -13,33 +13,4 @@ ha_domain: met 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. - - Configuration of the Met.no platform via configuration.yaml is deprecated from version 0.95 -- -## Configuration - -To add Met.no to your installation, go to Configuration >> Integrations in the UI and enable the Met.no integration. By default the values will be taken from the Home Assistant configuration. - -{% configuration %} -name: - description: Manually specify Name. - required: true - type: string - default: Provided by Home Assistant configuration -latitude: - description: Manually specify latitude. - required: true - type: float - default: Provided by Home Assistant configuration -longitude: - description: Manually specify longitude. - required: true - type: float - default: Provided by Home Assistant configuration -altitude: - description: Manually specify altitude. - required: false - type: integer - default: Provided by Home Assistant configuration -{% endconfiguration %} +To add Met.no to your installation, go to Configuration >> Integrations in the UI and enable the Met.no integration. diff --git a/source/_integrations/miflora.markdown b/source/_integrations/miflora.markdown index 162dbd89979..e1037cca244 100644 --- a/source/_integrations/miflora.markdown +++ b/source/_integrations/miflora.markdown @@ -103,6 +103,11 @@ adapter: required: false default: hci0 type: string +go_unavailable_timeout: + description: "Timeout to report this device as unavailable. This option hides a bad link quality" + required: false + default: 7200 + type: integer {% endconfiguration %}@@ -123,6 +128,7 @@ sensor: name: Flower 1 force_update: true median: 3 + go_unavailable_timeout: 43200 monitored_conditions: - moisture - light @@ -130,3 +136,18 @@ sensor: - conductivity - battery ``` +An automation example to report a battery failure: + +```yaml +- id: flower1_moisture_unavailable_check + alias: Flower 1 sensors available + trigger: + - entity_id: sensor.flower1_moisture + for: 24:00:00 + platform: state + to: unavailable + action: + - data_template: + message: "Flower 1 moisture is unavailable for more than 24 hours" + service: notify.notifier_telegram_someone +``` diff --git a/source/_integrations/modbus.markdown b/source/_integrations/modbus.markdown index fa6950f7ecc..3960ab054cb 100644 --- a/source/_integrations/modbus.markdown +++ b/source/_integrations/modbus.markdown @@ -53,6 +53,11 @@ timeout: required: false default: 3 type: integer +delay: + description: Time to sleep in seconds after connecting and before sending messages. Some modbus-tcp servers need a short delay typically 1-2 seconds in order to prepare the communication. If a server accepts connecting, but there is no response to the requests send, this parameter might help. + required: false + default: 0 + type: integer {% endconfiguration %} ### Serial connection diff --git a/source/_integrations/monoprice.markdown b/source/_integrations/monoprice.markdown index a0214da2b0f..7afb9dcafaf 100644 --- a/source/_integrations/monoprice.markdown +++ b/source/_integrations/monoprice.markdown @@ -4,6 +4,7 @@ description: Instructions on how to integrate Monoprice 6-Zone Home Audio Contro ha_category: - Media Player ha_release: 0.56 +ha_config_flow: true ha_iot_class: Local Polling ha_codeowners: - '@etsinko' @@ -12,53 +13,23 @@ ha_domain: monoprice The `monoprice` platform allows you to control [Monoprice 6-Zone Amplifier](https://www.monoprice.com/product?p_id=10761) using a serial connection. -To add a Monoprice device to your installation, add the following to your `configuration.yaml` file: +## Configuration -```yaml -# Example configuration.yaml entry -media_player: - - platform: monoprice - port: /dev/ttyUSB0 - zones: - 11: - name: Main Bedroom - 12: - name: Living Room - 13: - name: Kitchen - 14: - name: Bathroom - 15: - name: Dining Room - 16: - name: Guest Bedroom - sources: - 1: - name: Sonos - 5: - name: Chromecast -``` +Menu: **Configuration** -> **Integrations**. -{% configuration %} -port: - description: The serial port to which Monoprice amplifier is connected. - required: true - type: string -zones: - description: This is the list of zones available. Valid zones are 11, 12, 13, 14, 15 or 16. In case multiple Monoprice devices are stacked together the list of valid zones is extended by 21, 22, 23, 24, 25 or 26 for the second device and 31, 32, 33, 34, 35 or 36 for the third device. Each zone must have a name assigned to it. - required: true - type: integer -sources: - description: The list of sources available. Valid source numbers are 1, 2, 3, 4, 5 or 6. Each source number corresponds to the input number on the Monoprice amplifier. Similar to zones, each source must have a name assigned to it. - required: true - type: integer -{% endconfiguration %} +Click on the `+` sign to add an integration and click on **Monoprice**. +Select the serial port to which Monoprice amplifier is connected, and name the six sources (leave sources you're not using empty). + +Sources can also be later edited from the integration options (gear icon in the top right when selecting the integration). In order to remove an existing source, you'll need to replace it with a space (simply removing its name will still keep it in place). Note that editing sources will remove the snapshot you may have saved. + +## Services ### Service `monoprice.snapshot` -Take a snapshot of one or more zones' states. This service, and the following one are useful if you want to play a doorbell or notification sound and resume playback afterward. If no `entity_id` is provided, all zones are snapshotted. +Take a snapshot of one or more zones' states. This service, and the following one are useful if you want to play a doorbell or notification sound and resume playback afterward. If `entity_id` is `all`, all zones are snapshotted. The following attributes are stored in a snapshot: + - Power status (On/Off) - Mute status (On/Off) - Volume level @@ -70,7 +41,7 @@ The following attributes are stored in a snapshot: ### Service `monoprice.restore` -Restore a previously taken snapshot of one or more speakers. If no `entity_id` is provided, all zones are restored. +Restore a previously taken snapshot of one or more speakers. If `entity_id` is `all`, all zones are restored. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_integrations/mopar.markdown b/source/_integrations/mopar.markdown deleted file mode 100644 index 4662f83085b..00000000000 --- a/source/_integrations/mopar.markdown +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Mopar -description: Instructions on how to integrate Mopar vehicles into Home Assistant. -ha_category: - - Car - - Sensor - - Switch - - Lock -ha_release: 0.53 -ha_iot_class: Cloud Polling -ha_domain: mopar ---- - -The `mopar` integration provides the following for owners of FCA vehicles with a uConnect subscription: - -- Sensor per vehicle with vehicle health report and other meta-data -- Lock per vehicle allowing to lock/unlock the vehicle -- Switch per vehicle allowing to turn the engine on and off -- A service for running the horn & lights - -## Setup - -Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription. - -## Configuration - -To enable this component, add the following lines to your `configuration.yaml`. All platforms will be automatically loaded. - -```yaml -# Example configuration.yaml entry -mopar: - username: YOUR_USERNAME - password: YOUR_PASSWORD - pin: YOUR_UCONNECT_PIN -``` - -{% configuration %} -username: - description: Your mopar.com username. - required: true - type: string -password: - description: Your mopar.com password. - required: true - type: string -pin: - description: The pin for your account. - required: true - type: string -{% endconfiguration %} - -## Service - -Call the `mopar.sound_horn` service to sound the horn and flash the lights on your vehicle. - -| Service data attribute | Description | -| `vehicle_index` | The index of the vehicle to trigger. This is exposed in the sensor's device attributes. | - -Example data: - -```json -{ - "vehicle_index": 0 -} -``` diff --git a/source/_integrations/myq.markdown b/source/_integrations/myq.markdown index 36624971423..f0a0a105add 100644 --- a/source/_integrations/myq.markdown +++ b/source/_integrations/myq.markdown @@ -6,6 +6,9 @@ ha_category: - Cover ha_release: 0.39 ha_iot_class: Cloud Polling +ha_config_flow: true +ha_codeowners: + - '@bdraco' ha_domain: myq --- @@ -13,7 +16,9 @@ The `myq` cover platform lets you control MyQ-Enabled garage doors through Home ## Configuration -To use your MyQ cover in your installation, add the following to your `configuration.yaml` file: +To add `MyQ` cover to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **MyQ**. + +Alternatively, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/namecheapdns.markdown b/source/_integrations/namecheapdns.markdown index b9c8e20f29e..e22d5fa6586 100644 --- a/source/_integrations/namecheapdns.markdown +++ b/source/_integrations/namecheapdns.markdown @@ -1,7 +1,6 @@ --- title: Namecheap FreeDNS description: Keep your namecheap dynamic DNS up to date -logo: namecheap.png ha_category: - Network ha_release: 0.56 diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index ec1412cda1d..2e5c00f73a6 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -1,12 +1,10 @@ --- title: Netatmo description: Instructions on how to integrate Netatmo integration into Home Assistant. -logo: netatmo.png ha_category: - Hub - Environment - Weather - - Binary Sensor - Sensor - Climate - Camera @@ -22,10 +20,10 @@ The `netatmo` integration platform is the main integration to integrate all Neta There is currently support for the following device types within Home Assistant: -- [Binary Sensor](#binary-sensor) - [Camera](#camera) - [Climate](#climate) - [Sensor](#sensor) +- [Webhooks](#webhooks) ## Configuration @@ -71,22 +69,124 @@ That's it. You can copy and paste your new `client id` and `client secret` in yo
-## Binary Sensor
-
-This integration allows you to get the latest event seen by the camera.
-
-If multiple cameras are available then each monitored condition
-will create a specific sensor for each camera
-
## Camera
-The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This integration allows you to view the current live stream created by the Camera.
+The `netatmo` camera platform is consuming the information provided by a [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) camera. This integration allows you to view the current live stream created by the camera.
## Climate
-The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This integration allows you to view the current temperature and setpoint.
+The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) or [Netatmo Smart Radiator Valve](https://www.netatmo.com/en-gb/energy/additional-valve). This integration allows you to view the current temperature and control the setpoint.
## Sensor
-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) device.
+The `netatmo` sensor platform is consuming the information provided by a [Netatmo Smart Home Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) or a
+[Netatmo Smart Indoor Air Quality Monitor](https://www.netatmo.com/en-us/aircare/homecoach) device.
+
+## Webhooks
+
+The [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) cameras, [Smart Door and Window Sensors](https://www.netatmo.com/en-gb/security/cam-indoor/tag), as well as the [Netatmo Smart Smoke Alarm](https://www.netatmo.com/en-gb/security/smoke-alarm), send instant events to Home Assistant by using webhooks. It is required to have your camera enabled in Home Assistant.
+
+To be able to receive events from [Netatmo](https://www.netatmo.com/en-gb/), your Home Assistant instance needs to be accessible from the web over port `80` or `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)). You also need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)).
+
+Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations.
+
+You can find the available event types at the [official Netatmo API documentation](https://dev.netatmo.com/apidocumentation/security#events).
+
+Example:
+
+{% raw %}
+
+```yaml
+# Example automation for webhooks based Netatmo events
+- alias: Netatmo event example
+ description: "Count all events pushed by the Netatmo API"
+ trigger:
+ - event_data: {}
+ event_type: netatmo_event
+ platform: event
+ action:
+ - data: {}
+ entity_id: counter.event_counter
+ service: counter.increment
+```
+
+{% endraw %}
+
+Example:
+
+{% raw %}
+
+```yaml
+# Example automation for Netatmo Welcome
+- alias: Motion at home
+ description: 'Motion detected at home'
+ trigger:
+ - event_type: netatmo_event
+ platform: event
+ event_data:
+ type: movement
+ action:
+ - data_template:
+ message: >
+ {{ trigger.event.data["data"]["message"] }}
+ at {{ trigger.event.data["data"]["home_name"] }}
+ title: Netatmo event
+ service: persistent_notification.create
+```
+
+{% endraw %}
+
+Example:
+
+{% raw %}
+
+```yaml
+# Example automation for Netatmo Presence
+- alias: Motion at home
+ description: 'Motion detected at home'
+ trigger:
+ - event_type: netatmo_event
+ platform: event
+ event_data:
+ type: human # other possible types: animal, vehicle
+ action:
+ - data_template:
+ message: >
+ {{ trigger.event.data["data"]["message"] }}
+ at {{ trigger.event.data["data"]["home_name"] }}
+ title: Netatmo event
+ service: persistent_notification.create
+```
+
+{% endraw %}
+
+Example:
+
+{% raw %}
+
+```yaml
+# Example automation
+- alias: door or window open or movement
+ description: 'Notifies which door or window is open or was moved'
+ trigger:
+ - event_type: netatmo_event
+ platform: event
+ event_data:
+ type: tag_open
+ - event_type: netatmo_event
+ platform: event
+ event_data:
+ type: tag_big_move
+ - event_type: netatmo_event
+ platform: event
+ event_data:
+ type: tag_small_move
+ action:
+ - data_template:
+ message: >
+ {{ trigger.event.data["data"]["message"] }}
+ title: Netatmo event
+ service: persistent_notification.create
+```
+
+{% endraw %}
diff --git a/source/_integrations/nexia.markdown b/source/_integrations/nexia.markdown
new file mode 100644
index 00000000000..685b41b3dd1
--- /dev/null
+++ b/source/_integrations/nexia.markdown
@@ -0,0 +1,101 @@
+---
+title: Nexia
+description: Instructions on how to integrate Nexia Thermostats (Trane/American Standard) into Home Assistant.
+ha_category:
+ - Binary Sensor
+ - Sensor
+ - Climate
+ - Scene
+ha_release: 0.108
+ha_iot_class: Cloud Polling
+ha_config_flow: true
+ha_codeowners:
+ - '@bdraco'
+ - '@ryannazaretian'
+ha_domain: nexia
+---
+
+The `nexia` integration allows you to integrate your [Nexia](https://mynexia.com/) thermostats into Home Assistant.
+
+There is currently support for the following device types within Home Assistant:
+
+- [Binary Sensor](#binary-sensor)
+- [Climate](#climate)
+- [Sensor](#sensor)
+- [Scene](#scene)
+
+## Configuration
+
+You will need your mynexia.com username and password to use this module.
+
+To add `Nexia` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Nexia**.
+
+Alternatively, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+nexia:
+ username: YOUR_NEXIA_USERNAME
+ password: YOUR_NEXIA_PASSWORD
+```
+
+{% configuration %}
+username:
+ description: The username for accessing your Nexia account.
+ required: true
+ type: string
+password:
+ description: The password for accessing your Nexia account.
+ required: true
+ type: string
+{% endconfiguration %}
+
+### Binary Sensor
+
+The following binary sensors are added for each thermostat:
+
+- Blower Active
+
+### Sensor
+
+The following binary sensors are added for each thermostat:
+
+- Air Cleaner Mode
+- Current Compressor Speed
+- Requested Compressor Speed
+- Outdoor Temperature
+- Relative Humidity
+- System Status
+
+The following binary sensors are added for each thermostat zone:
+
+- Zone Temperature
+- Zone Setpoint Status
+- Zone Status
+
+### Climate
+
+The `nexia` climate platform lets you control a thermostat.
+
+### Scene
+
+The `nexia` scene platform lets you activate a nexia automation.
+
+### Service `nexia.set_aircleaner_mode`
+
+Sets the air cleaner mode. Options include 'auto', 'quick', and
+'allergy'. This setting will affect all zones on the same thermostat.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | no | String or list of strings that point at `entity_id`'s of climate devices to control.
+| `aircleaner_mode` | no | 'auto', 'quick', or 'allergy'
+
+### Service `nexia.set_humidify_setpoint`
+
+Sets the humidify setpoint. This setting will affect all zones on the same thermostat.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | no | String or list of strings that point at `entity_id`'s of climate devices to control.
+| `humidity` | no | Humidify setpoint level, from 35 to 65.
diff --git a/source/_integrations/nextcloud.markdown b/source/_integrations/nextcloud.markdown
new file mode 100644
index 00000000000..0e4b9f2a4e6
--- /dev/null
+++ b/source/_integrations/nextcloud.markdown
@@ -0,0 +1,44 @@
+---
+title: Nextcloud Sensor
+description: Instructions on how to integrate Nextcloud monitor api data into Home Assistant.
+ha_category:
+ - Sensor
+ha_iot_class: Cloud Polling
+ha_release: 0.108
+---
+
+The `nextcloud` integration pulls summary [Nextcloud](https://nextcloud.com/) information into Home Assistant.
+
+
+
+## Configuration
+
+This integration requires access to the monitor API of a Nextcloud instance (This is generally an admin user).
+
+You should also generate an App password from the Nextcloud web UI: **Settings** > **Security** > **Devices & sessions** > **Create new app password**.
+
+Once you have generated the App password, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+nextcloud:
+ url: Https://YOUR_NEXTCLOUD_URL
+ username: YOUR_USERNAME
+ password: YOUR_APP_PASSWORD
+
+```
+
+{% configuration %}
+url:
+ description: The full URL to your Nextcloud instance.
+ required: true
+ type: string
+username:
+ description: The username of a Nextcloud user that has access to the Nextcloud monitor API.
+ required: true
+ type: string
+password:
+ description: The app password generated from the Nextcloud security settings page.
+ required: true
+ type: string
+{% endconfiguration %}
diff --git a/source/_integrations/nilu.markdown b/source/_integrations/nilu.markdown
index 9dfce24be8c..bb1a0ca4e96 100644
--- a/source/_integrations/nilu.markdown
+++ b/source/_integrations/nilu.markdown
@@ -1,7 +1,6 @@
---
title: Norwegian Institute for Air Research (NILU)
description: Instructions on how to integrate air pollution data from NILU within Home Assistant.
-logo: nilu_logo.png
ha_category:
- Health
ha_iot_class: Cloud Polling
diff --git a/source/_integrations/nuheat.markdown b/source/_integrations/nuheat.markdown
index 76ec7bb89ef..f737b6a42d7 100644
--- a/source/_integrations/nuheat.markdown
+++ b/source/_integrations/nuheat.markdown
@@ -6,6 +6,9 @@ ha_category:
ha_release: 0.61
ha_iot_class: Cloud Polling
ha_domain: nuheat
+ha_config_flow: true
+ha_codeowners:
+ - '@bdraco'
---
The `nuheat` integration lets control your connected [NuHeat Signature](https://www.nuheat.com/products/thermostats/signature-thermostat) floor heating thermostats from [NuHeat](https://www.nuheat.com/).
@@ -16,7 +19,9 @@ There is currently support for the following device types within Home Assistant:
First, you will need to obtain your thermostat's numeric serial number or ID by logging into [MyNuHeat.com](https://mynuheat.com/) and selecting your thermostat(s).
-Once you have the Thermostat ID(s), add the following information to your `configuration.yaml` file:
+Once you have the Thermostat ID(s), to add `NuHeat` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **NuHeat**.
+
+Alternatively, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -134,35 +139,18 @@ Returns the maximum supported temperature by the thermostat
## Services
-The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hvac_mode`, `set_preset_mode`, `resume_program`.
+The following services are provided by the NuHeat Thermostat: `set_temperature`, `set_hvac_mode`, `set_preset_mode`.
-The services `fan_min_on_time`, `set_aux_heat`, `set_away_mode`, `set_humidity`, `set_fan_mode`, and `set_swing_mode` offered by the [Climate component](/integrations/climate/) are not implemented for this thermostat.
+### Service `climate.set_hvac_mode` ([Climate integration](/integrations/climate/))
-### Service `set_temperature`
+NuHeat Thermostats do not have an off concept. Setting the temperature to `min_temp` and changing the mode to `heat` will cause the device to enter a `Permanent Hold` preset and will stop the thermostat from turning on unless you happen to live in a freezing climate.
-Puts the thermostat into an indefinite hold at the given temperature.
+### Service `climate.set_temperature` ([Climate integration](/integrations/climate/))
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Use `entity_id: all` to target all.
-| `temperature` | no | Desired target temperature (when not in auto mode)
+If the thermostat is in auto mode, it puts the thermostat into a temporary hold at the given temperature.
-Only the target temperatures relevant for the current operation mode need to
-be provided.
+If the thermostat is in heat mode, it puts the thermostat into a permanent hold at the given temperature.
-### Service `set_preset_mode`
+### Service `climate.set_preset_mode` ([Climate integration](/integrations/climate/))
-Sets the thermostat's preset mode. Without a preset mode set it run the thermostat's programmed schedule, "temperature" (to indefinitely hold the thermostat's current target temperature), or "temporary_temperature" (to hold the thermostat's current target temperature until the thermostat's next scheduled event).
-
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Use `entity_id: all` to target all.
-| `hold_mode` | no | New value of hold mode.
-
-### Service `nuheat.resume_program`
-
-Resumes the currently active schedule.
-
-| Service data attribute | Optional | Description |
-| ---------------------- | -------- | ----------- |
-| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Use `entity_id: all` to target all.
+The following presets are available: `Run Schedule`, `Temporary Hold`, `Permanent Hold`.
\ No newline at end of file
diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown
index 4ac96c9aea8..cfafe9eeafd 100644
--- a/source/_integrations/onvif.markdown
+++ b/source/_integrations/onvif.markdown
@@ -51,6 +51,11 @@ profile:
required: false
type: integer
default: 0
+rtsp_transport:
+ description: "RTSP transport protocols. The possible options are: `tcp`, `udp`, `udp_multicast`, `http`."
+ required: false
+ type: string
+ default: tcp
extra_arguments:
description: "Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [`ffmpeg` component](/integrations/ffmpeg)."
required: false
diff --git a/source/_integrations/opnsense.markdown b/source/_integrations/opnsense.markdown
index df643f73c88..8a59c1c6080 100644
--- a/source/_integrations/opnsense.markdown
+++ b/source/_integrations/opnsense.markdown
@@ -32,6 +32,11 @@ Where the `api_key` and `api_secret` values are acquired from your OPNsense
router using the web interface. For more information on this procedure, refer
to the OPNsense [documentation](https://docs.opnsense.org/development/how-tos/api.html#creating-keys).
+User with API Key requires privileges for Type:
+
+- GUI Name: Diagnostics: ARP Table
+- GUI Name: Diagnostics: Network Insight
+
{% configuration %}
url:
description: The URL for the OPNsense API endpoint of your router.
diff --git a/source/_integrations/panasonic_viera.markdown b/source/_integrations/panasonic_viera.markdown
index 1186b4e91e3..d8185528e23 100644
--- a/source/_integrations/panasonic_viera.markdown
+++ b/source/_integrations/panasonic_viera.markdown
@@ -13,6 +13,7 @@ The `panasonic_viera` platform allows you to control a Panasonic Viera TV.
Currently known supported models:
+- TC-P60S60
- TC-P65VT30
- TX-32AS520E
- TX-32DSX609
diff --git a/source/_integrations/pocketcasts.markdown b/source/_integrations/pocketcasts.markdown
index 6b19fa321da..97d4690314e 100644
--- a/source/_integrations/pocketcasts.markdown
+++ b/source/_integrations/pocketcasts.markdown
@@ -8,16 +8,10 @@ ha_iot_class: Cloud Polling
ha_domain: pocketcasts
---
-The `pocketcasts` sensor platform lets you monitor how many unplayed episodes you have of your favorite podcasts at [Pocket Casts](https://play.pocketcasts.com/).
+The `pocketcasts` sensor platform lets you monitor how many unplayed episodes you have of your favorite podcasts at [Pocket Casts](https://play.pocketcasts.com/). This integration requires a [Pocket Casts + Plus](https://www.pocketcasts.com/plus/) subscription to work!
## Configuration
-- - This integration requires a [Pocket Casts + Plus](https://www.pocketcasts.com/plus/) subscription to work! - -- To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_integrations/powerwall.markdown b/source/_integrations/powerwall.markdown new file mode 100644 index 00000000000..bb95e0c53d0 --- /dev/null +++ b/source/_integrations/powerwall.markdown @@ -0,0 +1,62 @@ +--- +title: Telsa Powerwall +description: Instructions on how to integrate Tesla Power Walls into Home Assistant. +ha_category: + - Binary Sensor + - Sensor +ha_release: 0.108 +ha_iot_class: Local Polling +ha_config_flow: true +ha_codeowners: + - '@bdraco' +ha_domain: powerwall +--- + +The `powerwall` integration allows you to integrate your [Tesla Powerwall](https://www.tesla.com/powerwall) into Home Assistant. + +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](#binary-sensor) +- [Sensor](#sensor) + +## Configuration + +You will need the IP Address of your Powerwall to use this module. + +To add `Tesla Powerwall` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Tesla Powerwall**. + +Alternatively, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +powerwall: + ip_address: YOUR_POWERWALL_IP +``` + +{% configuration %} +ip_address: + description: The IP address of your Powerwall. + required: true + type: string +{% endconfiguration %} + +### Binary Sensor + +The following binary sensors are added for each Powerwall: + +- Powerwall Status +- Powerwall Connected to Tesla +- Grid Status + +### Sensor + +The following binary sensors are added for each Powerwall: + +- Powerwall Charge +- Powerwall Site Now +- Powerwall Load Now +- Powerwall Battery Now +- Powerwall Frequency Now (if applicable) +- Powerwall Busway Now (if applicable) +- Powerwall Solar Now (if applicable) +- Powerwall Generator Now (if applicable) diff --git a/source/_integrations/pvpc_hourly_pricing.markdown b/source/_integrations/pvpc_hourly_pricing.markdown new file mode 100644 index 00000000000..c9caf550bde --- /dev/null +++ b/source/_integrations/pvpc_hourly_pricing.markdown @@ -0,0 +1,82 @@ +--- +title: PVPC Hourly Pricing +description: Instructions on how to set up the PVPC Hourly Pricing sensor in Home Assistant. +ha_category: + - Energy +ha_release: '0.108' +ha_iot_class: Cloud Polling +ha_quality_scale: platinum +ha_config_flow: true +ha_codeowners: + - '@azogue' +ha_domain: pvpc_hourly_pricing +--- + +This sensor uses the official API to get the hourly price of electricity in Spain from https://www.esios.ree.es/en/pvpc. + +Specifically, it shows the current __active energy invoicing price (FEU)__ in €/kWh, +which is the energy term hourly price applied in the consumers' electrical bill +with a contracted power not exceeding 10 kW and which are under the PVPC +(Voluntary Price for Small Consumer). + +It includes the energy term of the access tolls, the charges and the production cost. It does not include taxes. +The hourly prices are the same throughout the Spanish territory regardless of the time zone. + +It can be set up via the integrations panel in the configuration screen. + + + +More information available at http://www.cnmc.es/en/ and http://www.omie.es/en/ + +## Configuration + +To configure PVPC Hourly Pricing, you can set it up via the integrations panel in the configuration screen. + +Set a name for the price sensor (default is `sensor.pvpc`) and select one of the three tariffs, +corresponding to your contracted rate, according to the number of billing periods per day +(one / peak + valley / shifted peak + valley). + +- 1 period: `normal`, for the "Default PVPC tariff, (2.0 A)". +- 2 periods: `discrimination`, for the "Efficiency 2 periods (2.0 DHA)", with 10h peak interval from 11:00 UTC to 21:00 UTC. +- 3 periods: `electric_car`, for the "Electric vehicle tariff (2.0 DHS)", optimized for electric car owners to charge at night. + +The default is `discrimination`, with 2 periods, as it is usually the cheapest one for home consumers. + +You can add multiple sensors (up to 3, one per tariff) by adding them again through the integrations panel. + +### Advanced configuration + +PVPC Hourly Pricing allows manual configuration by adding a section to your `configuration.yaml`. + +```yaml +# Set up electricity price sensors as a component: +pvpc_hourly_pricing: + - name: PVPC manual ve + tariff: electric_car + - name: PVPC manual nocturna + tariff: discrimination +``` + +{% configuration %} +name: + description: Custom name for the sensor. + required: true + type: string +tariff: + description: Contracted electric tariff. + required: true + default: discrimination + type: string +{% endconfiguration %} + + ++ +The sensor provides an hourly price for energy consumed, but the variable cost of energy is only one of the factors that add up to the electricity bill: +* Fixed cost of contracted power +* Fixed cost of energy consumed +* Variable cost of energy consumed (the sensor's value) +* Other fixed expenses, such as the rental of the electric meter +* Multiple taxes applied + +diff --git a/source/_integrations/qvr_pro.markdown b/source/_integrations/qvr_pro.markdown index 206eb2ef1b1..567fe1ce963 100644 --- a/source/_integrations/qvr_pro.markdown +++ b/source/_integrations/qvr_pro.markdown @@ -1,11 +1,13 @@ --- -title: "QVR Pro" -description: "Instructions on how to integrate QVR Pro within Home Assistant." +title: QVR Pro +description: Instructions on how to integrate QVR Pro within Home Assistant. logo: qvr_pro.png ha_category: - Camera ha_release: 0.107 ha_domain: qvr_pro +ha_codeowners: + - '@oblogic7' --- [QVR Pro](https://www.qnap.com/solution/qvr-pro-official) allows you to create @@ -33,13 +35,17 @@ host: required: true type: string username: - description: The username for accessing your Ring account. + description: The username for accessing your QVR account. required: true type: string password: - description: The password for accessing your Ring account. + description: The password for accessing your QVR account. required: true type: string +port: + description: The port where QVR accepts connections. + required: false + type: integer exclude_channels: description: Comma separated list of channel numbers to be excluded. required: false diff --git a/source/_integrations/rachio.markdown b/source/_integrations/rachio.markdown index 469bfba989a..9e9fa0b5d8e 100644 --- a/source/_integrations/rachio.markdown +++ b/source/_integrations/rachio.markdown @@ -29,7 +29,9 @@ They will be automatically added if the Rachio integration integration is loaded ## Configuration -To add this platform to your installation, add the following to your `configuration.yaml` file: +To add `Rachio` go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Rachio**. + +Alternatively, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/recorder.markdown b/source/_integrations/recorder.markdown index 5396e2c1aeb..11e39f16ada 100644 --- a/source/_integrations/recorder.markdown +++ b/source/_integrations/recorder.markdown @@ -18,7 +18,7 @@ This integration constantly saves data. If you use the default configuration, th Home Assistant uses [SQLAlchemy](https://www.sqlalchemy.org/), which is an Object Relational Mapper (ORM). This means that you can use **any** SQL backend for the recorder that is supported by SQLAlchemy, like [MySQL](https://www.mysql.com/), [MariaDB](https://mariadb.org/), [PostgreSQL](https://www.postgresql.org/), or [MS SQL Server](https://www.microsoft.com/en-us/sql-server/). -The default database engine is [SQLite](https://www.sqlite.org/) which doesn't require any configuration. The database is stored in your Home Assistant configuration directory (`.homeassistant` or '/config/' in Hass.io) and called `home-assistant_v2.db`. +The default database engine is [SQLite](https://www.sqlite.org/) which does not require any configuration. The database is stored in your Home Assistant configuration directory ('/config/') and is named `home-assistant_v2.db`. To change the defaults for the `recorder` integration in your installation, add the following to your `configuration.yaml` file: @@ -137,8 +137,8 @@ recorder: - media_player exclude: entities: - - sensor.last_boot - - sensor.date + - sensor.last_boot + - sensor.date ``` If you only want to hide events from your history, take a look at the [`history` integration](/integrations/history/). The same goes for the [logbook](/integrations/logbook/). But if you have privacy concerns about certain events or want them in neither the history or logbook, you should use the `exclude`/`include` options of the `recorder` integration. That way they aren't even in your database, you can reduce storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`). diff --git a/source/_integrations/rest.markdown b/source/_integrations/rest.markdown index 7aa7b332deb..c5e130b79a8 100644 --- a/source/_integrations/rest.markdown +++ b/source/_integrations/rest.markdown @@ -119,10 +119,6 @@ force_update: default: false {% endconfiguration %} --Make sure that the URL exactly matches your endpoint or resource. --Use either `resource` or `resource_template`. @@ -414,7 +410,7 @@ sensor: value_template: '{{ states.sensor.steam_system_data.attributes["time0"] }}' unit_of_measurement: "minutes" -switch: +switch: - platform: template switches: steam: @@ -441,7 +437,7 @@ switch: - service: homeassistant.update_entity data: entity_id: sensor.steam_system_data - friendly_name: Steam + friendly_name: Steam rest_command: set_steam_led: @@ -454,7 +450,7 @@ For reference, the XML content of endpoint shown above example is below: ```xml - +0 12556 diff --git a/source/_integrations/rfxtrx.markdown b/source/_integrations/rfxtrx.markdown index 98bf36747b9..d85a80d6060 100644 --- a/source/_integrations/rfxtrx.markdown +++ b/source/_integrations/rfxtrx.markdown @@ -55,7 +55,7 @@ dummy: ## Supported protocols -Not all protocols as advertised are enabled on the initial setup of your transceiver. Enabling all protocols is not recommended either. Your 433.92 product not showing in the logs? Visit the RFXtrx website to [download RFXmgmr](http://www.rfxcom.com/epages/78165469.sf/nl_NL/?ObjectPath=/Shops/78165469/Categories/Downloads) and enable the required protocol. +Not all protocols as advertised are enabled on the initial setup of your transceiver. Enabling all protocols is not recommended either. Your 433.92 product not showing in the logs? Visit the RFXtrx website to [download RFXmgmr](http://www.rfxcom.com/epages/78165469.sf/en_GB/?ViewObjectPath=%2FShops%2F78165469%2FCategories%2FDownloads) and enable the required protocol. ### ser2net diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown index dbc1bdaa62d..5ebf71dd003 100644 --- a/source/_integrations/ring.markdown +++ b/source/_integrations/ring.markdown @@ -1,7 +1,6 @@ --- title: Ring description: Instructions on how to integrate your Ring.com devices within Home Assistant. -logo: ring.png ha_category: - Doorbell - Binary Sensor diff --git a/source/_integrations/rmvtransport.markdown b/source/_integrations/rmvtransport.markdown index ae5ca0cab3f..67c97889e44 100644 --- a/source/_integrations/rmvtransport.markdown +++ b/source/_integrations/rmvtransport.markdown @@ -1,7 +1,6 @@ --- title: RMV description: Instructions on how to integrate Rhein-Main public transport departure times into Home Assistant. -logo: RMV.png ha_category: - Transport ha_release: 0.76 diff --git a/source/_integrations/roku.markdown b/source/_integrations/roku.markdown index 262cfa2f13b..7050fefb749 100644 --- a/source/_integrations/roku.markdown +++ b/source/_integrations/roku.markdown @@ -1,7 +1,6 @@ --- title: Roku description: Instructions how to integrate Roku devices into Home Assistant. -logo: roku.png ha_category: - Hub - Media Player @@ -9,16 +8,27 @@ ha_category: ha_iot_class: Local Polling ha_release: 0.86 ha_domain: roku +ha_config_flow: true +ha_quality_scale: silver +ha_codeowners: + - '@ctalkington' --- -The [Roku](https://www.roku.com/) integration allows integration of Roku, which will be automatically discovered if you enable the [discovery component](/integrations/discovery/). +The Roku integration allows you to control a [Roku](https://www.roku.com/) device. + +### Configuration + +Go to the integrations page in your configuration and click on new integration -> Roku. +If your Roku device is on, it has likely been discovered already and you just have to confirm the detected device. There is currently support for the following device types within Home Assistant: - Media Player - Remote -The `roku` integration can also be forced to load by adding the following lines to your `configuration.yaml`: +### YAML Configuration + +Manual configuration of your Roku device is also possible, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -33,12 +43,6 @@ host: type: string {% endconfiguration %} -## Services - -### Service `roku_scan` - -Scans the local network for Rokus. All found devices are presented as a persistent notification. - ## Remote The `roku` remote platform allows you to send remote control buttons to a Roku device. It is automatically set up when a Roku is configured. @@ -89,7 +93,7 @@ data: ## Media Player -When the Home Assistant Roku integration is enabled and has found a Roku device, in the Home Assistant GUI the Roku media player will show a listing of the installed channels, or apps, under “source”. Select one and it will attempt to launch the channel on your Roku device. This action can also be automated, but it requires you to acquire an extra piece of information; the ```appID``` for the channel specific to your Roku. Although this information is gathered by the Roku integration, at the moment it is not exposed to the end user. This item might be added in a future release. For now though, you can easily get the information yourself. All you need to do is a simple GET API call on the same network as your device. +When the Home Assistant Roku integration is enabled and a Roku device has been configured, in the Home Assistant UI the Roku media player will show a listing of the installed channels, or apps, under “source”. Select one and it will attempt to launch the channel on your Roku device. This action can also be automated, but it requires you to acquire an extra piece of information; the ```appID``` for the channel specific to your Roku. Although this information is gathered by the Roku integration, at the moment it is not exposed to the end user. This item might be added in a future release. For now though, you can easily get the information yourself. All you need to do is a simple GET API call on the same network as your device. The API calls are like this: diff --git a/source/_integrations/rtorrent.markdown b/source/_integrations/rtorrent.markdown index cbef77ef873..d95803cb5b3 100644 --- a/source/_integrations/rtorrent.markdown +++ b/source/_integrations/rtorrent.markdown @@ -21,6 +21,12 @@ sensor: - 'current_status' - 'download_speed' - 'upload_speed' + - 'all_torrents' + - 'stopped_torrents' + - 'complete_torrents' + - 'uploading_torrents' + - 'downloading_torrents' + - 'active_torrents' ``` This sensor requires the rTorrent XML-RPC API exposed on an HTTP interface. @@ -49,4 +55,16 @@ monitored_variables: description: The current download speed. upload_speed: description: The current upload speed. + all_torrents: + description: The number of all torrents. + stopped_torrents: + description: The number of torrents that are stopped. + complete_torrents: + description: The number of torrents that are fully downloaded. + uploading_torrents: + description: The number of torrents that are seeding. + downloading_torrents: + description: The number of torrents that are leeching. + active_torrents: + description: The number of torrents that are actively ( measurable speed ) leeching, seeding or both. {% endconfiguration %} diff --git a/source/_integrations/samsungtv.markdown b/source/_integrations/samsungtv.markdown index b56288376bd..ba5ff01429c 100644 --- a/source/_integrations/samsungtv.markdown +++ b/source/_integrations/samsungtv.markdown @@ -17,14 +17,14 @@ The `samsungtv` platform allows you to control a [Samsung Smart TV](https://www. ### Setup Go to the integrations page in your configuration and click on new integration -> Samsung TV. -If you have enabled [ssdp](/integrations/ssdp) discovery and your TV is on, it's likely that you just have to confirm the detected device. +If your TV is on and you have enabled [SSDP](/integrations/ssdp) discovery, it's likely that you just have to confirm the detected device. When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication. ### YAML Configuration YAML configuration is around for people that prefer YAML. -To use a TV add the following to your `configuration.yaml` file: +To use this integration, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -47,6 +47,8 @@ turn_on_action: type: list {% endconfiguration %} +After saving the YAML configuration, the TV must be turned on _before_ launching Home Assistant in order for the TV to be registered the first time. + #### Wake up TV To wake up the TV when switched off you can use the [wake-on-lan](/integrations/wake_on_lan/) integration and call a service. This is not possible with every device. @@ -74,7 +76,7 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am #### Models tested and working -- C7700 +- C7700 (on doesn't work) - D5500 - D6100 - D6300SF @@ -97,11 +99,11 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am - F6500 - F7000 - F8000BF -- K5579 (On/Off, Forward/Backward, Volume control, but no Play button) +- K5579 - K5600AK (partially supported, turn on works but state is not updated) - K6500AF -- KS7005 (MAC address must be provided, On/Off, Volume are OK, no channel change) -- KS7502 (turn on doesn't work, turn off works fine) +- KS7005 (no channel change) +- KS7502 (On doesn't work, Off works fine) - KS8000 - KS8005 - KS8500 @@ -109,18 +111,19 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am - KU6100 - KU6290 - KU6400U +- KU6470 - KU7000 - M5620 - MU6170UXZG -- NU7090 (On/Off, MAC must be specified for Power On) +- MU6179 +- MU6199 +- NU7090 (On/Off) - NU7400 - NU8000 +- NU8070 - U6000 - U6300 -- UE6199UXZG (On/Off, Forward/Backward, Volume control, but no Play button) -- UE65KS8005 (On/Off, Forward/Backward, Volume are OK, but no Play button) -- UE49KU6470 (On/Off, Forward/Backward, Volume are OK, but no Play button) -- UE46ES5500 (partially supported, turn on doesn't work) +- RU7172 #### Models tested but not yet working @@ -138,11 +141,11 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am - MU6125 - Unable to see state and unable to control (Tested on UE58MU6125 on port 8001 and 8801) - MU6300 - Port set to 8001, turning on works, status not working reliably, turning off is not permanent (it comes back on) - MU6400 - Unable to see state and unable to control (using latest 1270 firmware. Had limited functionality on previous firmware) -- RU8000 - Turning on works, turning off does not work. State is correct but says on periodically but in reality is not. Nothing else works via port 8001. - Q60 – Turning on works, turning off does not work, State is always "off". - Q6F – Port set to 8001, turning on works, turning off does not work, status not working reliably. - Q7F - State is always "off" and unable to control via port 8001. - Q9F - Turning on works, turning off does not work. State is correct. Nothing else works. Port 8001. +- RU8000 - Turning on works, turning off does not work. State is correct but says on periodically but in reality is not. Nothing else works via port 8001. None of the 2014 (H) and 2015 (J) model series (e.g., J5200) will work, since Samsung have used a different (encrypted) type of interface for these. diff --git a/source/_integrations/schluter.markdown b/source/_integrations/schluter.markdown new file mode 100644 index 00000000000..706928af9fc --- /dev/null +++ b/source/_integrations/schluter.markdown @@ -0,0 +1,49 @@ +--- +title: Schluter +description: Instructions on how to integrate your Schluter DITRA-HEAT-E-WiFi thermostat into Home Assistant. +ha_category: + - Climate +ha_release: 0.108 +ha_iot_class: Cloud Polling +--- + +The `schluter` integration allows you to integrate your [Schluter-DITRA-HEAT-E-WiFi](https://www.schluter.com/schluter-us/en_US/ditra-heat-wifi) electric floor heating thermostat in Home Assistant. + ++You will need to create a Schluter DITRA-HEAT account and register your thermostat with it. This can be done via the thermostat touchscreen, where an email will be sent to you to confirm your account. ++ +## Configuration + +You will need your Schluter login information (email and password) to use this module. + +To set it up, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +schluter: + username: YOUR_SCHLUTER_EMAIL + password: YOUR_SCHLUTER_PASSWORD +``` + +{% configuration %} +username: + description: The email for accessing your Schluter account. + required: true + type: string +password: + description: The password for accessing your Schluter account. + required: true + type: string +{% endconfiguration %} + +Once Home Assistant is started, you will have access to any thermostats registered with your account. + +### Supported Features + +Currently, this integration supports the following features: + +- Retrieving current temperature & target temperature +- Setting target temperature + +When adjusting the temperature via Home Assistant, it will place the thermostat in "permanent mode", meaning schedules programmed within the thermostat will be ignored. You can return to scheduled mode by pressing the "Return to Schedule" button on the thermostat. diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index 3a9ca27d2a3..d82da2d8232 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -74,10 +74,6 @@ icon: description: The icon for the sensor. required: false type: icon -json_attributes: - description: (Deprecated, replaced by json_attributes_topic) A list of keys to extract values from a JSON dictionary payload and then set as sensor attributes. - required: false - type: [string, list] json_attributes_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`." required: false diff --git a/source/_integrations/slack.markdown b/source/_integrations/slack.markdown index d9e099061eb..190feaebb4f 100644 --- a/source/_integrations/slack.markdown +++ b/source/_integrations/slack.markdown @@ -75,77 +75,65 @@ The following attributes can be placed inside `data` for extended functionality. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `file` | yes | Groups the attributes for file upload. If present, either `url` or `path` have to be provided. -| `path ` | yes | Local path of file, photo etc to post to Slack. Is placed inside `file`. -| `url` | yes | URL of file, photo etc to post to Slack. Is placed inside `file`. -| `username` | yes | Username if the URL requires authentication. Is placed inside `file`. -| `password` | yes | Password if the URL requires authentication. Is placed inside `file`. -| `auth` | yes | If set to `digest` HTTP-Digest-Authentication is used. If missing HTTP-BASIC-Authentication is used. Is placed inside `file`. -| `attachments` | yes | Array of [Slack attachments](https://api.slack.com/docs/message-attachments). See [the attachment documentation](https://api.slack.com/docs/message-attachments) for how to format. *NOTE*: if using `attachments`, they are shown **in addition** to `message` +| `file` | yes | Local path of file, photo, etc. to post to Slack. +| `attachments` | yes | Array of [Slack attachments](https://api.slack.com/messaging/composing/layouts#attachments) (legacy). *NOTE*: if using `attachments`, they are shown **in addition** to `message`. +| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in addition** to `message`. -Example for posting file from URL: +Example for posting a file from local path: -```json -{ - "message":"Message that will be added as a comment to the file.", - "title":"Title of the file.", - "target": ["#channelname"], - "data":{ - "file":{ - "url":"http://[url to file, photo, security camera etc]", - "username":"optional user, if necessary", - "password":"optional password, if necessary", - "auth":"digest" - } - } -} +```yaml +message: Message that will be added as a comment to the file. +title: Title of the file. +data: + file: "/path/to/file.ext" ``` -Example for posting file from local path: +Please note that `file` is validated against the `whitelist_external_dirs` in the `configuration.yaml`. -```json -{ - "message":"Message that will be added as a comment to the file.", - "title":"Title of the file.", - "data":{ - "file":{ - "path":"/path/to/file.ext" - } - } -} +Example for using the block framework: + +```yaml +message: Message that will be added as a comment to the file. +title: Title of the file. +data: + attachments: + - type: section + text: + type: mrkdwn + text: 'Danny Torrence left the following review for your property:' + - type: section + block_id: section567 + text: + type: mrkdwn + text: ": https://data.tankutility.com/api/getToken` + ``` + + The JSON response structure should resemble: + + ```json + {"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0MzgyMjQwODE0NjIsInYiOjAsImQiOnsidWleejoic2ltcGxlbG9naW46MzM1In0sImlhdCI6wwDIyMzk5NX0.kbYzxRtbGB2ke3IBgQTVMNQprHOWJZFgQQnPK6Wyas4"} + ``` + +2. Receive the list of devices you have in your account: + + ```bash + curl https://data.tankutility.com/api/devices?token= + ``` + + The JSON response structure should resemble: + + ```json + {"devices":["54df6a066667531535371367","54ff69057492666782350667"]} + ``` + ## Configuration To enable the component, add the following lines to your `configuration.yaml` file: diff --git a/source/_integrations/tankerkoenig.markdown b/source/_integrations/tankerkoenig.markdown index 49fa15387a9..d789a99bdd6 100755 --- a/source/_integrations/tankerkoenig.markdown +++ b/source/_integrations/tankerkoenig.markdown @@ -1,13 +1,14 @@ --- -title: "Tankerkoenig Sensor" -description: "Instructions on how to integrate Tankerkoenig sensors within Home Assistant." -logo: tankerkoenig.png +title: Tankerkoenig +description: Instructions on how to integrate Tankerkoenig sensors within Home Assistant. ha_category: - Energy - Sensor ha_release: 0.107 ha_iot_class: Cloud Polling ha_domain: tankerkoenig +ha_codeowners: + - '@guillempages' --- The `tankerkoenig` platform allows you to monitor the fuel prices with [tankerkoenig.de](https://www.tankerkoenig.de/) from within Home Assistant and setup automations based on the information. @@ -17,7 +18,9 @@ You can also add additional stations manually, referencing them via their IDs. T ## Setup -To use this sensor you need an API key from [tankerkoenig](https://creativecommons.tankerkoenig.de). Go to [api-key](https://creativecommons.tankerkoenig.de/api-key), fill out the form and request a key. The API is free, but requests should be limited to less than once every 5 minutes. +To use this sensor you need an API key from tankerkoenig. Go to [tankerkoenig API](https://creativecommons.tankerkoenig.de) and click on API-KEY in the top right, fill out the form and request a key. The API is free, but requests should be limited to less than once every 5 minutes. + +It is recommended to choose a radius that doesn't return too many fuel stations. The Terms & Conditions of tankerkoenig.de specify that the API is not meant for massive data fetching, but it does not explicitly mention a limit. Having a maximum of 10 monitored fuel stations is recommended, and a warning will be issued otherwise. ## Configuration @@ -28,7 +31,7 @@ To enable this platform, add the following lines to your `configuration.yaml`: tankerkoenig: api_key: YOUR_API_KEY radius: 1 - fuel_type: + fuel_types: - "diesel" ``` @@ -58,9 +61,9 @@ radius: default: 2 type: integer scan_interval: - description: The time interval to poll the server for new data. You should not put values lower than 5 minutes here; otherwise you risk your API key being blocked. + description: The time interval in seconds to poll the server for new data. You should not put values lower than 5 minutes here; otherwise you risk your API key being blocked. required: false - default: 0:30 + default: 1800 (30min) type: time stations: description: List of additional fuel stations to create entities for. @@ -86,10 +89,10 @@ tankerkoenig: - 8531b393-1e42-423b-cb4d-e4b98cff8a0c ``` -Assuming there are two fuel stations within the specified range and location, you would get six sensor entities: +Assuming there are only two fuel stations within the specified range and location, you would get six sensor entities: * sensor.tankerkoenig_berlin_paulstrasse_20_diesel * sensor.tankerkoenig_berlin_paulstrasse_20_e10 * sensor.tankerkoenig_aral_tankstelle_diesel * sensor.tankerkoenig_aral_tankstelle_e10 - * sensor.tankerkoenig_svg_hamburg_strassen>_diesel + * sensor.tankerkoenig_svg_hamburg_strassen_diesel * sensor.tankerkoenig_svg_hamburg_strassen_e10 diff --git a/source/_integrations/tellduslive.markdown b/source/_integrations/tellduslive.markdown index cbb188f5469..fc99d063d2a 100644 --- a/source/_integrations/tellduslive.markdown +++ b/source/_integrations/tellduslive.markdown @@ -19,12 +19,6 @@ ha_domain: tellduslive The `tellduslive` integration let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home. - - -If you are upgrading from 0.58 or older, you need to remove all Telldus configuration from your `configuration.yaml` file before continuing. - -- Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/integrations/discovery/) integration is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API. ## Configuration diff --git a/source/_integrations/tellstick.markdown b/source/_integrations/tellstick.markdown index 2d144805521..ac421a253cb 100644 --- a/source/_integrations/tellstick.markdown +++ b/source/_integrations/tellstick.markdown @@ -37,7 +37,7 @@ tellstick: There is a [TellStick add-on](/addons/tellstick/) available in the Home Assistant add-on store. ```yaml -# Example configuration.yaml entry for Hass.io with the TellStick add-on +# Example configuration.yaml entry with the TellStick add-on tellstick: host: core-tellstick port: [50800, 50801] diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown index f8a857f5693..01fd2e40560 100644 --- a/source/_integrations/template.markdown +++ b/source/_integrations/template.markdown @@ -298,7 +298,7 @@ sensor: {% if is_state('device_tracker.my_device_nmap','home') %} {{ state_attr('zone.home','latitude') }} {% else %} - state_attr('device_tracker.my_device_gps','latitude') + {{ state_attr('device_tracker.my_device_gps','latitude') }} {% endif %} longitude: >- {% if is_state('device_tracker.my_device_nmap','home') %} diff --git a/source/_integrations/tesla.markdown b/source/_integrations/tesla.markdown index d5cdae6d051..bb9873eb3cd 100644 --- a/source/_integrations/tesla.markdown +++ b/source/_integrations/tesla.markdown @@ -25,9 +25,9 @@ This integration provides the following platforms: - Binary sensors - such as parking and charger connection. - Sensors - such as Battery level, Inside/Outside temperature, odometer, estimated range, and charging rate. - Device tracker - to track location of your car -- Lock - Door lock. Enables you to control Tesla's door lock +- Lock - Door lock and charger door lock. Enables you to control Tesla's door and charger door lock - Climate - HVAC control. Allow you to control (turn on/off, set target temperature) your Tesla's HVAC system. -- Switch - Charger and max range switch to allow you to start/stop charging and set max range charging. Update switch to allow you to disable polling of vehicles to conserve battery +- Switch - Charger and max range switch to allow you to start/stop charging and set max range charging. Update switch to allow you to disable polling of vehicles to conserve battery. Sentry mode switch to enable or disable Sentry mode. ## Configuration @@ -59,3 +59,9 @@ scan_interval: type: integer default: 660 {% endconfiguration %} + +## Options + +Tesla options are set via **Configuration** -> **Integrations** -> **Tesla** -> **Options**. + +* Wake cars on start - Whether to wake sleeping cars on Home Assistant startup. This allows a user to choose whether cars should continue to sleep (and not update information) or to wake up the cars potentially interrupting long term hibernation and increasing vampire drain. diff --git a/source/_integrations/thinkingcleaner.markdown b/source/_integrations/thinkingcleaner.markdown index a375506d4f3..2b0c92945b7 100644 --- a/source/_integrations/thinkingcleaner.markdown +++ b/source/_integrations/thinkingcleaner.markdown @@ -68,4 +68,3 @@ switch: - platform: thinkingcleaner host: 10.0.0.55 ``` - diff --git a/source/_integrations/todoist.markdown b/source/_integrations/todoist.markdown index 7ae7a723e76..e04ef65df32 100644 --- a/source/_integrations/todoist.markdown +++ b/source/_integrations/todoist.markdown @@ -1,7 +1,6 @@ --- title: Todoist description: Instructions on how to integrate Todoist into Home Assistant. -logo: todoist.png ha_category: - Calendar ha_iot_class: Cloud Polling diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown index 1b0ac783fb9..bfe2e596fbf 100644 --- a/source/_integrations/tplink.markdown +++ b/source/_integrations/tplink.markdown @@ -140,7 +140,7 @@ Devices that are confirmed to support Consumption Reading; 1. HS110 2. HS300 -In order to get the power consumption readings from a TP-Link HS110 device, you'll have to create a [template sensor](/integrations/switch.template/). +In order to get the power consumption readings from a TP-Link HS110 device, you'll have to create a [template sensor](/integrations/template/). In the example below, change all of the `my_tp_switch`'s to match your device's entity ID. {% raw %} diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown index c4658b64ff3..d3fdcbd1c18 100644 --- a/source/_integrations/tradfri.markdown +++ b/source/_integrations/tradfri.markdown @@ -47,6 +47,10 @@ allow_tradfri_groups: ## Troubleshooting +### Incorrect security key + +`Fatal DTLS error: code 20` might indicate a missing or incorrect security key. Pay close attention as e.g., "I" and "l" can easily be confused. + ### Firmware updates After updating your IKEA Trådfri Gateway firmware it might be necessary to repeat the configuration process. One error you might experience after a firmware update is `Fatal DTLS error: code 115`. If you encounter problems: @@ -58,7 +62,7 @@ Then restart Home Assistant. When prompted, enter the security key and click *co ### Compilation issues- This does not apply to Hass.io or Docker. + This does not apply to Home Assistant running in Docker Containers, including the default Home Assistant install.Please make sure you have `autoconf` installed (`$ sudo apt-get install autoconf`) if you want to use this component. Also, installing some dependencies might take considerable time (more than one hour) on slow devices. diff --git a/source/_integrations/tts.markdown b/source/_integrations/tts.markdown index e1132d25f7f..ce1d463da84 100644 --- a/source/_integrations/tts.markdown +++ b/source/_integrations/tts.markdown @@ -3,7 +3,7 @@ title: Text-to-Speech (TTS) description: Instructions on how to set up Text-to-Speech (TTS) with Home Assistant. ha_release: 0.35 ha_codeowners: - - '@robbiet480' + - '@pvizeli' ha_domain: tts --- diff --git a/source/_integrations/ubee.markdown b/source/_integrations/ubee.markdown index 3549c574cd8..51683c4eeb3 100644 --- a/source/_integrations/ubee.markdown +++ b/source/_integrations/ubee.markdown @@ -44,12 +44,14 @@ password: {% endconfiguration %} Supported models: -- EVW3200-Wifi -- EVW320B -- EVW321B -- EVW32C-0N -- EVW3226@UPC -- DVW32CB + +- Ambit EVW320B +- Ambit EVW321B +- Ubee DDW36C +- Ubee DVW32CB +- Ubee EVW3200-Wifi +- Ubee EVW3226 (UPC) +- Ubee EVW32C-0Ndiff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown index 6604efa3c96..79ffd41b488 100644 --- a/source/_integrations/ubus.markdown +++ b/source/_integrations/ubus.markdown @@ -8,8 +8,6 @@ ha_release: 0.7.6 ha_domain: ubus --- -_This is one of multiple ways we support OpenWrt. For an overview, see [OpenWrt](/integrations/openwrt)._ - This is a presence detection scanner for [OpenWrt](https://openwrt.org/) using [ubus](https://wiki.openwrt.org/doc/techref/ubus). It scans for changes in `hostapd.*`, which will detect and report changes in devices connected to the access point on the router. Before this scanner can be used you have to install the ubus RPC package on OpenWRT: diff --git a/source/_integrations/unifi.markdown b/source/_integrations/unifi.markdown index 510e4191eb7..70c16212a2b 100644 --- a/source/_integrations/unifi.markdown +++ b/source/_integrations/unifi.markdown @@ -6,8 +6,9 @@ ha_category: - Hub - Presence Detection - Switch + - Sensor ha_release: 0.81 -ha_iot_class: Local Polling +ha_iot_class: Local Push ha_config_flow: true ha_quality_scale: platinum ha_codeowners: @@ -21,70 +22,17 @@ There is currently support for the following device types within Home Assistant: - [Presence Detection](#presence-detection) - [Switch](#switch) +- [Sensor](#sensor) ## Configuration -Home Assistant offers UniFi integration through **Configuration** -> **Integrations** -> **UniFi Controller**. +Home Assistant offers UniFi integration through **Configuration** -> **Integrations** -> **UniFi Controller**. Follow the instructions to get it set up. -Enter `host address`, `user name` and `password` and then continue to select which `site` you want to connect to Home Assistant. The user needs administrator privileges in order to control POE switches. +The user needs administrator privileges in order to control switches. -### Extra configuration for device tracker +### Extra configuration of the integration -You can augment the behavior of UniFi device tracker by adding - -```yaml -# Example configuration.yaml entry -unifi: - controllers: - - host: unifi - site: My site - ssid_filter: - - 'HomeSSID' - - 'IoTSSID' -``` - -{% configuration %} -host: - description: Same address as relevant configuration entry, needed to identify configuration entry. - type: string - required: true - default: None -site: - description: Same site as relevant configuration entry, needed to identify configuration entry. - type: string - required: true - default: None -block_client: - description: A list of Clients MAC Addresses that can be blocked from the network. - type: list - required: false - default: None -detection_time: - description: How long since the last seen time before the device is marked away, specified in seconds. - type: integer - required: false - default: 300 -dont_track_clients: - description: enable to not allow device tracker to track clients. - type: boolean - required: false - default: false -dont_track_devices: - description: enable to not allow device tracker to track devices. - type: boolean - required: false - default: false -dont_track_wired_clients: - description: enable to not allow device tracker to track wired clients. - type: boolean - required: false - default: false -ssid_filter: - description: Filter the SSIDs that tracking will occur on. - type: list - required: false - default: None -{% endconfiguration %} +All configuration options are offered from the front end. Enter what UniFi integration you want to change options on and press the cog wheel. ### Configuring Users @@ -112,7 +60,7 @@ If Home Assistant and the UniFi controller are running on separate machines or V ### Block network access for clients -Allow control of network access to clients configured in the `configuration.yaml` file by adding a list of the MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking. +Allow control of network access to clients configured in the integration options by adding MAC addresses. Items in this list will have a Home Assistant switch created, using the UniFi Device name, allowing for blocking and unblocking. ### Control clients powered by POE @@ -120,6 +68,12 @@ Entities appear automatically for each connected POE client. If no POE client de Note that POE control actually configures the network port of the switch which the client is connected to. +## Sensor + +### Bandwidth sensor + +Get entities reporting receiving and transmitting bandwidth per network client. + ## Debugging integration If you have problems with UniFi or the integration you can add debug prints to the log. diff --git a/source/_integrations/upnp.markdown b/source/_integrations/upnp.markdown index cdf4535bb39..d169c21989c 100644 --- a/source/_integrations/upnp.markdown +++ b/source/_integrations/upnp.markdown @@ -9,7 +9,7 @@ ha_release: 0.18 ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - - '@robbiet480' + - '@StevenLooman' ha_domain: upnp --- diff --git a/source/_integrations/uscis.markdown b/source/_integrations/uscis.markdown index d44a345b295..7b842c60b25 100644 --- a/source/_integrations/uscis.markdown +++ b/source/_integrations/uscis.markdown @@ -8,11 +8,11 @@ ha_iot_class: Cloud Polling ha_domain: uscis --- -The `uscis` sensor integration 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) +The `uscis` sensor integration allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from the [USCIS Website](https://egov.uscis.gov/casestatus/landing.do). ## Configuration -To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file: +To use this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml sensor: @@ -28,9 +28,9 @@ name: default: USCIS type: string case_id: - description: Case/receipt number used to get the case details from USCIS web client. + description: Case/receipt number used to get the case details from the USCIS web client. required: true type: string {% endconfiguration %} -All the data will be fetch from [USCIS](https://egov.uscis.gov/casestatus/mycasestatus.do). +All the data will be fetched from [USCIS](https://egov.uscis.gov/casestatus/mycasestatus.do). diff --git a/source/_integrations/velbus.markdown b/source/_integrations/velbus.markdown index fbc73816bde..54d4e75eb20 100644 --- a/source/_integrations/velbus.markdown +++ b/source/_integrations/velbus.markdown @@ -58,6 +58,37 @@ port: type: string {% endconfiguration %} +## Services + +- `velbus.sync clock`: Synchronize Velbus time to local clock. +- `velbus.set_memo_text`: Show memo text on Velbus display modules. + +### Service `velbus.sync_clock` + +You can use the service `velbus.sync clock` to synchronize the clock of the Velbus modules to the clock of the machine running Home Assistant. This is the same as the 'sync clock' button at the VelbusLink software. + +### Service `velbus.set_memo_text` + +You can use the service `velbus.set_memo_text` to provide the memo text to be displayed at Velbus modules like VMBGPO(D) and VMBELO. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ---------------------------------------- | +| `address` | no | The module address in decimal format, which is displayed at the device list at the integration page. | +| `memo_text` | yes | Text to be displayed on module. When no memo text is supplied the memo text will be cleared. | + +Example: + +```yaml +script: + trash_memo: + alias: Trash memo text + sequence: + - data: + address: 65 + memo_text: "It's trash day" + service: velbus.set_memo_text +``` + ## Example automation The Velbus integration allows you to link a Velbus button (i.e., a button of a [VMBGPOD](https://www.velbus.eu/products/view/?id=416302&lang=en) module) to a controllable entity of Home Assistant. diff --git a/source/_integrations/vicare.markdown b/source/_integrations/vicare.markdown index 075ad9406b5..40a7ab4af25 100644 --- a/source/_integrations/vicare.markdown +++ b/source/_integrations/vicare.markdown @@ -51,11 +51,25 @@ heating_type: required: false type: string default: generic +scan_interval: + description: The update frequency of this component in seconds. See [Viessmann API limits](#viessmann-api-limits) + default: 60 + required: false + type: integer {% endconfiguration %} Two components will be created: `climate.vicare_heating` and `water_heater.vicare_water` (for domestic hot water). Unless you specify a `circuit` parameter, it will pick up the first heating circuit of your installation. +## Viessmann API limits + +Recently Viessmann has introduced a rate limit on their REST API. If you exceed one of the limits below you will be banned for 24 hours: + +- Limit 1: 120 calls for a time window of 10 minutes +- Limit 2: 1450 calls for a time window of 24 hours + +The default `scan_interval` of 60 seconds will work within these limits. Note however that any additional requests to the API, e.g., by setting the temperature via the integration but also by interacting with the ViCare app also counts into those limits. It is therefore advised to adjust the scan_interval to your usage scenario. + ## Climate A note about the current temperature attribute: Viessmann devices with room temperature sensing will show the current room temperature via `current_temperature`. All other devices will show the current supply temperature of the heating circuit. @@ -94,12 +108,13 @@ The `climate.vicare_heating` component has the following mapping of HVAC modes t #### Service `set_preset_mode` -Sets the preset mode. Supported preset modes are *eco* and *comfort*. These are identical to the respective Viessmann programs and are only temporary. Please consult your heating device manual for more information. +Sets the preset mode. Supported preset modes are *eco* and *comfort*. These are identical to the respective Viessmann programs and are only active temporarily for 8 hours. +Eco mode reduces the target temperature by 3°C, whereas Comfort mode sets the target temperature to a configurable value. Please consult your heating device manual for more information. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id. -| `preset_mode` | no | New value of hold mode. +| `preset_mode` | no | New value of preset mode. ## Water Heater diff --git a/source/_integrations/vizio.markdown b/source/_integrations/vizio.markdown index a80f4fd314b..6baed3abd32 100644 --- a/source/_integrations/vizio.markdown +++ b/source/_integrations/vizio.markdown @@ -9,7 +9,6 @@ ha_config_flow: true ha_quality_scale: platinum ha_codeowners: - '@raman325' -ha_quality_scale: platinum ha_domain: vizio --- @@ -42,11 +41,11 @@ Write down its IP address and port number. If you have trouble finding a device ## Pairing -This integration requires an access token in order to communicate with TVs (speakers do not need an access token). An access token can be obtained by going through a pairing process, either manually, or through the HA frontend. +This integration requires an access token in order to communicate with TVs (speakers do not need an access token). An access token can be obtained by going through a pairing process, either manually, or through the Home Assistant frontend. -### Pair using the HA frontend +### Pair using the Home Assistant frontend - - **Using `configuration.yaml`:** If you have a `vizio` entry in `configuration.yaml` but don't provide an access token value in your configuration, after you initialize HomeAssistant, you will see a Vizio SmartCast device ready to be configured. When you open the configuration window, you will be guided through the pairing process. While HA will store the access token for the life of your `vizio` entity, it is a good idea to note the access token value displayed in the window and add it to your `configuration.yaml`. This will ensure that you will not have to go through the pairing process again in the future if you decide to rebuild your HA instance. + - **Using `configuration.yaml`:** If you have a `vizio` entry in `configuration.yaml` but don't provide an access token value in your configuration, after you initialize Home Assistant, you will see a Vizio SmartCast device ready to be configured. When you open the configuration window, you will be guided through the pairing process. While Home Assistant will store the access token for the life of your `vizio` entity, it is a good idea to note the access token value displayed in the window and add it to your `configuration.yaml`. This will ensure that you will not have to go through the pairing process again in the future if you decide to rebuild your Home Assistant instance. - **Using discovery or manual setup through the Integrations menu:** To initiate the pairing process, submit your initial configuration with an empty Access Token value. ### Pair manually using the CLI @@ -121,7 +120,7 @@ name: type: string default: Vizio SmartCast access_token: - description: Authentication token you received in the last step of the pairing process. This token is only needed if your device is a TV, and you can opt not to provide it in your configuration and instead go through the pairing process via the HA frontend. + description: Authentication token you received in the last step of the pairing process. This token is only needed if your device is a TV, and you can opt not to provide it in your configuration and instead go through the pairing process via the Home Assistant frontend. required: false type: string device_class: @@ -178,16 +177,10 @@ apps: ### Obtaining an app configuration -If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in `configuration.yaml`. In order to determine the values to specify for each configuration parameter, launch the app you want to configure on your device, and run the following command (requires `pyvizio` to be installed locally): - -```bash -pyvizio --ip={IP:PORT} get-current-app-config -``` - -`pyvizio` will return the value of the three parameters (`APP_ID`, `NAME_SPACE`, `MESSAGE`) for the currently running app which you can then include in your configuration. +If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in `configuration.yaml`. This configuration can be obtained from the `app_id` state attribute when an unknown app is running on your device. ### Obtaining a list of valid apps to include or exclude -To get the list of apps that can be excluded or included, run the following command (requires `pyvizio` to be installed locally): +The list of apps that are provided by default is statically defined [here](https://github.com/vkorn/pyvizio/blob/master/pyvizio/const.py#L23). If you'd prefer a more concise list, you can either view the source list of a Vizio Smart TV in the Home Assistant frontend, or run the following command (requires `pyvizio` to be installed locally): ```bash pyvizio --ip=0 get-apps-list diff --git a/source/_integrations/weather.darksky.markdown b/source/_integrations/weather.darksky.markdown index 49a2b403087..e24e45e2bca 100644 --- a/source/_integrations/weather.darksky.markdown +++ b/source/_integrations/weather.darksky.markdown @@ -1,7 +1,7 @@ --- title: "Dark Sky" description: "Instructions on how to integrate Dark Sky within Home Assistant." -featured: true +featured: false logo: dark_sky.png ha_category: - Weather @@ -14,7 +14,13 @@ The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as ## Configuration -You need an API key which is free but requires [registration](https://darksky.net/dev/register). The free tier allows up to 1000 calls per day, this platform updates at most every 3 minutes, using up to 480 of those calls. ++ +On March 31, 2020 Dark Sky was [acquired by Apple](https://blog.darksky.net/dark-sky-has-a-new-home/) and is no longer allowing new API registrations. The Dark Sky API will continue to function for existing users through the end of 2021, but it is no longer possible to obtain an API key for new users. + ++ +The free tier allows up to 1000 calls per day, this platform updates at most every 3 minutes, using up to 480 of those calls.diff --git a/source/_integrations/wled.markdown b/source/_integrations/wled.markdown index 7a5136c68ac..52186c783c7 100644 --- a/source/_integrations/wled.markdown +++ b/source/_integrations/wled.markdown @@ -45,13 +45,17 @@ entity. Only native supported features of a light in Home Assistant are supported (which includes effects). -## Sensors +## Sensors -This integration provides sensors for the following information from WLED: +This integration provides sensors for the following information from WLED: -- Estimated current. -- Uptime. -- Free memory. +- Estimated current (in mA). +- Uptime (disabled by default) +- Free memory (in bytes, disabled by default). +- Wi-Fi Signal Strength (in %m disabled by default). +- Wi-Fi Signal Strength (RSSI in dBm). +- Wi-Fi Channel (disabled by default). +- Wi-Fi BSSID (disabled by default). ## Switches @@ -63,4 +67,20 @@ The integration will create a number of switches: ## Services -This integration currently does not offer any additional services. +Currently, the WLED integration provides one service for controlling effect. +More services for other WLED features are expected to be added in the future. + +### Service `wled.effect` + +This service allows for controlling the WLED effect. + +| Service Data Attribute | Required | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | +| `entity_id` | no | A WLED entity ID, or list entity IDs, to apply the effect to. Use `entity_id: all` to target all WLED entities. | +| `effect` | no | Name or ID of the WLED light effect. | +| `intensity` | no | Intensity of the effect. | +| `speed` | no | Speed of the effect. Number between `0` (slow) and `255` (fast). | +| `reverse` | no | Reverse the effect. Either `true` to reverse or `false` otherwise. | + +A list of all available effects (and the behavior of the intensity for each +effect) [is documented in the WLED Wiki](https://github.com/Aircoookie/WLED/wiki/List-of-effects-and-palettes#effects). diff --git a/source/_integrations/yeelight.markdown b/source/_integrations/yeelight.markdown index 6ff7f6258ae..11f96266756 100644 --- a/source/_integrations/yeelight.markdown +++ b/source/_integrations/yeelight.markdown @@ -81,7 +81,7 @@ devices: required: false type: string model: - description: "Yeelight model. Possible values are `mono1`, `color1`, `color2`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`. The setting is used to enable model specific features f.e. a particular color temperature range. Its also used to setup device, if its not available and discovery if disabled, during Home Assistant startup. If model is not specified, it will be guessed, by integration by looking at supported properties, reported by device." + description: "Yeelight model. Possible values are `mono1`, `color1`, `color2`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`, `ceiling13`. The setting is used to enable model specific features f.e. a particular color temperature range. Its also used to setup device, if its not available and discovery if disabled, during Home Assistant startup. If model is not specified, it will be guessed, by integration by looking at supported properties, reported by device." required: false type: string custom_effects: @@ -151,6 +151,7 @@ This integration is tested to work with the following models. If you have a diff | `ceiling3` | YLXD05YL | Yeelight Ceiling Light (Jiaoyue 480) | | `ceiling4` | YLXD02YL | Yeelight Ceiling Light (Jiaoyue 650) | | `mono` | YLTD03YL | Yeelight Serene Eye-Friendly Desk Lamp | +| `ceiling13` | YLXD01YL | Yeelight LED Ceiling Light | ## Services diff --git a/source/_lovelace/button.markdown b/source/_lovelace/button.markdown index 4250db8e1f2..858bbb81a88 100644 --- a/source/_lovelace/button.markdown +++ b/source/_lovelace/button.markdown @@ -22,7 +22,7 @@ type: description: button type: string entity: - required: true + required: false description: Home Assistant entity ID. type: string name: @@ -94,7 +94,6 @@ tap_action: service: script.turn_on service_data: entity_id: script.turn_off_lights -entity: script.turn_off_lights ```diff --git a/source/_lovelace/entities.markdown b/source/_lovelace/entities.markdown index d36977174c6..59a2282da5f 100644 --- a/source/_lovelace/entities.markdown +++ b/source/_lovelace/entities.markdown @@ -264,6 +264,36 @@ icon: default: "`mdi:link`" {% endconfiguration %} +### Buttons + +{% configuration %} +type: + required: true + description: buttons + type: string +entities: + required: true + description: A list of entities to show. Each entry is either an entity ID or a map. + type: list + keys: + entity: + required: true + description: The entity to render. + type: string + icon: + required: false + description: Override the entity icon. + type: string + image: + required: false + description: Override the entity image. + type: string + name: + required: false + description: Label for the button + type: string +{% endconfiguration %} + ## Example Entity rows: diff --git a/source/_lovelace/entity.markdown b/source/_lovelace/entity.markdown new file mode 100644 index 00000000000..737fd6e3265 --- /dev/null +++ b/source/_lovelace/entity.markdown @@ -0,0 +1,66 @@ +--- +title: "Entity Card" +sidebar_label: Entity +description: "The Entity card gives you a quick overview of your entity's state" +--- + +The Entity card gives you a quick overview of your entity's state. + +
+
+ +{% configuration %} +type: + required: true + description: entity + type: string +entity: + required: true + description: Home Assistant entity ID. + type: string +name: + required: false + description: Name of Entity + type: string + default: Entity Name +icon: + required: false + description: Overwrites icon. + type: string +attribute: + required: false + description: An attribute associated with the `entity` + type: string +unit: + required: false + description: Unit of Measurement given to data + type: string + default: "Unit Of Measurement given by entity" +theme: + required: false + description: Set to any theme within `themes.yaml` + type: string +footer: + required: false + description: Footer widget to render. See [footer documentation](/lovelace/header-footer/). + type: map +{% endconfiguration %} + +## Example + +```yaml +- type: entity + entity: cover.kitchen_window +- type: entity + entity: light.bedroom + attribute: brightness + unit: '%' +- type: entity + entity: vacuum.downstairs + name: Vacuum + icon: 'mdi:battery' + attribute: battery_level + unit: '%' +``` \ No newline at end of file diff --git a/source/_lovelace/media-control.markdown b/source/_lovelace/media-control.markdown index 17378ed4012..960fdfad15f 100644 --- a/source/_lovelace/media-control.markdown +++ b/source/_lovelace/media-control.markdown @@ -4,7 +4,7 @@ sidebar_label: Media Control description: "The Media Control card is used to display media player entities on an interface with easy to use controls." --- -The Media Control card is used to display [Media Player](/integrations/#search/media-player) entities on an interface with easy to use controls. +The Media Control card is used to display [Media Player](/integrations/#media-player) entities on an interface with easy to use controls.
+ Screenshot of the entity card.
+
diff --git a/source/_lovelace/picture-glance.markdown b/source/_lovelace/picture-glance.markdown
index b1f538974f4..bd99a9c2505 100644
--- a/source/_lovelace/picture-glance.markdown
+++ b/source/_lovelace/picture-glance.markdown
@@ -90,6 +90,18 @@ entity:
required: true
description: Home Assistant entity ID.
type: string
+attribute:
+ required: false
+ description: Attribute of the entity to display instead of the state
+ type: string
+prefix:
+ required: false
+ description: Prefix to display before the attribute's value
+ type: string
+suffix:
+ required: false
+ description: Suffix to display after the attribute's value
+ type: string
icon:
required: false
description: Overwrites default icon.
diff --git a/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown b/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown
index 48d3b1e7e61..6cdce85ed42 100644
--- a/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown
+++ b/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown
@@ -13,7 +13,7 @@ First release of 2016 and we are on 🔥! The [main repository][github-ha] has p
[github-ha]: https://github.com/home-assistant/home-assistant/
[release-pr]: https://github.com/home-assistant/home-assistant/pull/883#partial-users-participants
-
+
- [MySensors] revamped and switch support added ([@MartinHjelmare][@MartinHjelmare])
- Full refactor of RPi GPIO. Now includes [binary sensor][rpi-bs] and [switch][rpi-s] ([@sfam])
@@ -53,7 +53,6 @@ First release of 2016 and we are on 🔥! The [main repository][github-ha] has p
[Cast]: /integrations/cast
[Universal media player]: /integrations/universal
[Netatmo]: /integrations/netatmo#sensor
-[Alarm.com]: /integrations/alarmdotcom
[Proliphix]: /integrations/proliphix/
[rpi-bs]: /integrations/rpi_gpio#binary-sensor
[rpi-s]: /integrations/rpi_gpio#switch
diff --git a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
index deb6f410341..d03d206803d 100644
--- a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
+++ b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown
@@ -132,7 +132,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- Bump pywemo version. ([@pavoni] - [#7004])
- Fix Synology camera content type ([@balloob] - [#7010]) ([camera.synology docs])
- Fix two more instances of JSON parsing synology ([@balloob] - [#7014])
-- Bump pyalarmdotcom to support new version of aiohttp ([@Xorso] - [#7021]) ([alarm_control_panel.alarmdotcom docs])
+- Bump pyalarmdotcom to support new version of aiohttp ([@Xorso] - [#7021])
- Fix US states check (fixes #7015) ([@fabaff] - [#7017])
- Remove deprecated remote classes ([@balloob] - [#7011]) (breaking change)
- Replace 'vendor_id' with 'arch' (fixes #7003) ([@fabaff] - [#7023])
@@ -417,7 +417,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
[@turbokongen]: https://github.com/turbokongen
[@viswa-swami]: https://github.com/viswa-swami
-[alarm_control_panel.alarmdotcom docs]: /integrations/alarmdotcom
[arduino docs]: /integrations/arduino/
[automation docs]: /integrations/automation/
[binary_sensor.ping docs]: /integrations/ping#binary-sensor
diff --git a/source/_posts/2017-09-09-release-53.markdown b/source/_posts/2017-09-09-release-53.markdown
index d0c05471051..60b0cf9b522 100644
--- a/source/_posts/2017-09-09-release-53.markdown
+++ b/source/_posts/2017-09-09-release-53.markdown
@@ -62,7 +62,7 @@ This release ships a new KNX implementation thanks to @Julius2342. It will insta
- Bayesian Binary Sensor ([@jlmcgehee21] - [#8810]) ([binary_sensor.bayesian docs]) (new-platform)
- Add Tank Utility sensor ([@krismolendyke] - [#9132]) ([sensor.tank_utility docs]) (new-platform)
- Tesla platform ([@zabuldon] - [#9211]) ([tesla docs]) ([binary_sensor.tesla docs]) ([climate.tesla docs]) ([device_tracker.tesla docs]) ([lock.tesla docs]) ([sensor.tesla docs]) (new-platform)
-- mopar sensor ([@happyleavesaoc] - [#9136]) ([sensor.mopar docs]) (new-platform)
+- mopar sensor ([@happyleavesaoc] - [#9136]) (new-platform)
- Add Geofency device tracker ([@gunnarhelgason] - [#9106]) ([device_tracker.geofency docs]) (new-platform)
- Added DWD WarnApp Sensor ([@runningman84] - [#8657]) ([sensor.dwdwarnapp docs]) (new-platform)
- Add input_text component ([@BioSehnsucht] - [#9112]) ([input_text docs]) (new-platform)
@@ -147,7 +147,7 @@ frontend:
- Allow panels with external URL ([@andrey-git] - [#9214])
- Use ZCL mandatory attribute to determine ZHA light capabilities ([@jkl1337] - [#9232]) ([light.zha docs])
- A bugfix for pushbullet ([@danielhiversen] - [#9237]) ([notify.pushbullet docs])
-- mopar sensor ([@happyleavesaoc] - [#9136]) ([sensor.mopar docs]) (new-platform)
+- mopar sensor ([@happyleavesaoc] - [#9136]) (new-platform)
- Upgrade discord.py to 0.16.11 ([@fabaff] - [#9239]) ([notify.discord docs])
- Skip automatic events older than latest data ([@armills] - [#9230]) ([device_tracker.automatic docs])
- title and message was swapped in pushbullet ([@danielhiversen] - [#9241]) ([notify.pushbullet docs])
@@ -419,7 +419,6 @@ frontend:
[sensor.dwdwarnapp docs]: /integrations/dwd_weather_warnings/
[sensor.fitbit docs]: /integrations/fitbit
[sensor.homematic docs]: /integrations/homematic
-[sensor.mopar docs]: /integrations/mopar
[sensor.radarr docs]: /integrations/radarr
[sensor.season docs]: /integrations/season
[sensor.shodan docs]: /integrations/shodan
diff --git a/source/_posts/2017-09-23-release-54.markdown b/source/_posts/2017-09-23-release-54.markdown
index b9cd78296f5..74f96dcd0c2 100644
--- a/source/_posts/2017-09-23-release-54.markdown
+++ b/source/_posts/2017-09-23-release-54.markdown
@@ -60,7 +60,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- Allow multiple observations of same entity ([@jlmcgehee21] - [#9391]) ([binary_sensor.bayesian docs])
- Break up Alexa per functionality ([@balloob] - [#9400]) ([alexa docs])
- Upgrade psutil to 5.3.1 ([@fabaff] - [#9403]) ([sensor.systemmonitor docs])
-- fix mopar sensor ([@happyleavesaoc] - [#9389]) ([sensor.mopar docs])
+- fix mopar sensor ([@happyleavesaoc] - [#9389])
- Support specifying no Apple TVs ([@postlund] - [#9394]) ([apple_tv docs])
- Update netdisco to 1.2.0 ([@balloob] - [#9408])
- components/xiaomi: Add initial discovery using NetDisco. ([@pfalcon] - [#9283])
@@ -329,7 +329,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
[sensor.fitbit docs]: /integrations/fitbit
[sensor.homematic docs]: /integrations/homematic
[sensor.knx docs]: /integrations/sensor.knx/
-[sensor.mopar docs]: /integrations/mopar
[sensor.onewire docs]: /integrations/onewire
[sensor.swiss_public_transport docs]: /integrations/swiss_public_transport
[sensor.systemmonitor docs]: /integrations/systemmonitor
diff --git a/source/_posts/2018-01-14-release-61.markdown b/source/_posts/2018-01-14-release-61.markdown
index eed5ed65952..ca46f72339d 100644
--- a/source/_posts/2018-01-14-release-61.markdown
+++ b/source/_posts/2018-01-14-release-61.markdown
@@ -56,7 +56,7 @@ broadlink.send_packet_192_168_0_107 -> switch.broadlink_send_packet_192_168_0_10
## Release 0.61.1 - January 16
- Fix zha color probe ([@rcloran] - [#11670]) ([zha docs]) ([light.zha docs])
-- Move several local services to their right domain ([@amelchio] - [#11677]) ([calendar.todoist docs]) ([media_player.snapcast docs]) ([media_player.soundtouch docs]) ([sensor.mopar docs]) ([switch.broadlink docs]) ([switch.scsgate docs]) (breaking change)
+- Move several local services to their right domain ([@amelchio] - [#11677]) ([calendar.todoist docs]) ([media_player.snapcast docs]) ([media_player.soundtouch docs]) ([switch.broadlink docs]) ([switch.scsgate docs]) (breaking change)
- Rfxtrx fix ([@danielhiversen] - [#11678]) ([rfxtrx docs]) ([binary_sensor.rfxtrx docs])
- History order bugfix and opt-in option ([@rwa] - [#11686]) ([history docs])
- Fix purge with MariaDB / MySQL ([@tinloaf] - [#11713])
@@ -155,7 +155,7 @@ Note however, that this feature was replaced by a new ignore_string config optio
broadlink.learn_command_192_168_0_107 -> switch.broadlink_learn_command_192_168_0_107
broadlink.send_packet_192_168_0_107 -> switch.broadlink_send_packet_192_168_0_107
```
- ([@amelchio] - [#11677]) ([calendar.todoist docs]) ([media_player.snapcast docs]) ([media_player.soundtouch docs]) ([sensor.mopar docs]) ([switch.broadlink docs]) ([switch.scsgate docs]) (breaking change)
+ ([@amelchio] - [#11677]) ([calendar.todoist docs]) ([media_player.snapcast docs]) ([media_player.soundtouch docs]) ([switch.broadlink docs]) ([switch.scsgate docs]) (breaking change)
## All changes
@@ -789,7 +789,6 @@ Note however, that this feature was replaced by a new ignore_string config optio
[media_player.snapcast docs]: /integrations/snapcast
[media_player.soundtouch docs]: /integrations/soundtouch
[rfxtrx docs]: /integrations/rfxtrx/
-[sensor.mopar docs]: /integrations/mopar
[switch.broadlink docs]: /integrations/broadlink#switch
[switch.scsgate docs]: /integrations/scsgate#switch
[zha docs]: /integrations/zha/
diff --git a/source/_posts/2018-03-09-release-65.markdown b/source/_posts/2018-03-09-release-65.markdown
index a4aa5d24de9..244df69467d 100644
--- a/source/_posts/2018-03-09-release-65.markdown
+++ b/source/_posts/2018-03-09-release-65.markdown
@@ -318,7 +318,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- IMAP sensor async/await conversion ([@amelchio] - [#12988]) ([sensor.imap docs])
- Refactor Google Assistant ([@balloob] - [#12959]) ([google_assistant docs]) ([light docs]) (breaking change)
- Bump pyEmby version to support aiohttp => 3 ([@mezz64] - [#12986]) ([media_player.emby docs])
-- Update pyalarmdotcom version ([@koolsb] - [#12987]) ([alarm_control_panel.alarmdotcom docs])
+- Update pyalarmdotcom version ([@koolsb] - [#12987])
- Show the error message when Zabbix fails to log in ([@cyberjacob] - [#12985]) ([zabbix docs])
- Script/gen_requirements: Ignore package families ([@cdce8p] - [#12963])
- Fix Sonos group discovery ([@amelchio] - [#12970]) ([media_player.sonos docs])
@@ -540,7 +540,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
[@teharris1]: https://github.com/teharris1
[@thejta]: https://github.com/thejta
[@turbokongen]: https://github.com/turbokongen
-[alarm_control_panel.alarmdotcom docs]: /integrations/alarmdotcom
[alarm_control_panel.concord232 docs]: /integrations/concord232#alarm-control-panel
[alarm_control_panel.egardia docs]: /integrations/egardia
[api docs]: /integrations/api/
diff --git a/source/_posts/2018-05-11-release-69.markdown b/source/_posts/2018-05-11-release-69.markdown
index 73fb677f3a9..74770657e33 100644
--- a/source/_posts/2018-05-11-release-69.markdown
+++ b/source/_posts/2018-05-11-release-69.markdown
@@ -172,7 +172,7 @@ rainmachine:
- Sensor device classes ([@cdce8p] - [#14282]) ([sensor docs]) (breaking change)
- Matrix Chatbot ([@tinloaf] - [#13355]) ([matrix docs]) ([notify docs]) (breaking change) (new-platform)
- deCONZ add new device without restart ([@Kane610] - [#14221]) ([deconz docs]) ([binary_sensor.deconz docs]) ([light.deconz docs]) ([sensor.deconz docs])
-- Add alarmdotcom sensor status ([@jnewland] - [#14254]) ([alarm_control_panel.alarmdotcom docs])
+- Add alarmdotcom sensor status ([@jnewland] - [#14254])
- Add domain to labels and count state changes to Prometheus ([@jnewland] - [#14253]) ([prometheus docs])
- Add support for max_volume ([@relvacode] - [#13822]) ([media_player.onkyo docs])
- Refactor ImageProcessingFaceEntity ([@robmarkcole] - [#14296]) ([image_processing docs]) ([image_processing.dlib_face_detect docs]) ([image_processing.dlib_face_identify docs]) ([image_processing.microsoft_face_detect docs]) ([image_processing.microsoft_face_identify docs])
@@ -372,7 +372,6 @@ rainmachine:
[@thelittlefireman]: https://github.com/thelittlefireman
[@tinloaf]: https://github.com/tinloaf
[abode docs]: /integrations/abode/
-[alarm_control_panel.alarmdotcom docs]: /integrations/alarmdotcom
[auth docs]: /integrations/auth/
[binary_sensor docs]: /integrations/binary_sensor/
[binary_sensor.deconz docs]: /integrations/deconz#binary-sensor
diff --git a/source/_posts/2018-07-16-release-73-2.markdown b/source/_posts/2018-07-16-release-73-2.markdown
index 1e828f16c56..f288fa7470f 100644
--- a/source/_posts/2018-07-16-release-73-2.markdown
+++ b/source/_posts/2018-07-16-release-73-2.markdown
@@ -14,7 +14,6 @@ A man in the middle attack is when an attacker is able to inject itself between
After research, the following integrations have been impacted. Although the odds are extremely small, we still suggest that if you use any of these integrations, to create new API keys or change your password.
-- [alarm_control_panel.alarmdotcom](/integrations/alarmdotcom)
- [climate.sensibo](/integrations/sensibo)
- [cloud](/integrations/cloud/) (only short lived tokens impacted)
- [device_tracker.automatic](/integrations/automatic)
diff --git a/source/_posts/2019-01-23-release-86.markdown b/source/_posts/2019-01-23-release-86.markdown
index 3851d2f357b..bcace0a82a3 100644
--- a/source/_posts/2019-01-23-release-86.markdown
+++ b/source/_posts/2019-01-23-release-86.markdown
@@ -279,7 +279,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- Lowercase code format ([@balloob] - [#20077]) ([alarm_control_panel docs]) (breaking change)
- fix logic error in dubln bus ([@ttroy50] - [#20075]) ([sensor.dublin_bus_transport docs])
- Bump abode to 0.15.0 ([@shred86] - [#20064]) ([abode docs])
-- Change return text code for alarm control panels ([@arsaboo] - [#20055]) ([alarm_control_panel.alarmdotcom docs])
+- Change return text code for alarm control panels ([@arsaboo] - [#20055])
- Adjust OpenUV integration for upcoming API limit changes ([@bachya] - [#19949]) ([openuv docs]) (breaking change)
- Fix ihc issues caused by update to defusedxml ([@mopolus] - [#20091]) ([ihc docs])
- Move ESPHome Source Files ([@OttoWinter] - [#20092]) ([esphome docs])
@@ -596,7 +596,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
[abode docs]: /integrations/abode/
[ads docs]: /integrations/ads/
[alarm_control_panel docs]: /integrations/alarm_control_panel/
-[alarm_control_panel.alarmdotcom docs]: /integrations/alarmdotcom
[alarm_control_panel.arlo docs]: /integrations/arlo
[alarm_control_panel.elkm1 docs]: /integrations/elkm1
[alarm_control_panel.homekit_controller docs]: /integrations/homekit_controller
diff --git a/source/_posts/2019-03-20-release-90.markdown b/source/_posts/2019-03-20-release-90.markdown
index 0e5310b1341..3ce287d3d2d 100644
--- a/source/_posts/2019-03-20-release-90.markdown
+++ b/source/_posts/2019-03-20-release-90.markdown
@@ -227,7 +227,7 @@ Users will need to change `- platform: firetv` to `- platform: androidtv` in the
- ZHA fixes ([@dmulcahey] - [#21592]) ([zha docs])
- Update pyhomematic ([@danielperna84] - [#21600]) ([homematic docs])
- Add parameter hold_secs for Harmony remote send command ([@ehendrix23] - [#19650]) ([remote docs]) ([remote.harmony docs])
-- Upgrade motorparts to 1.1.0 ([@rohankapoorcom] - [#21602]) ([sensor.mopar docs])
+- Upgrade motorparts to 1.1.0 ([@rohankapoorcom] - [#21602])
- Further Yale ZWave lock device mapping cleanup ([@mw-white] - [#21128]) ([zwave docs])
- Added support for multiple Netatmo thermostats/valves ([@shanbs] - [#19407]) ([netatmo docs]) ([climate.netatmo docs]) (breaking change)
- Add the velbus sync clock service ([@Cereal2nd] - [#21308]) ([velbus docs])
@@ -792,7 +792,6 @@ Users will need to change `- platform: firetv` to `- platform: androidtv` in the
[sensor.dsmr docs]: /integrations/dsmr
[sensor.flunearyou docs]: /integrations/flunearyou
[sensor.loopenergy docs]: /integrations/loopenergy
-[sensor.mopar docs]: /integrations/mopar
[sensor.mqtt_room docs]: /integrations/mqtt_room
[sensor.netdata docs]: /integrations/netdata
[sensor.nmbs docs]: /integrations/nmbs
diff --git a/source/_posts/2019-04-03-release-91.markdown b/source/_posts/2019-04-03-release-91.markdown
index 907e0548259..8ea193bece9 100644
--- a/source/_posts/2019-04-03-release-91.markdown
+++ b/source/_posts/2019-04-03-release-91.markdown
@@ -105,7 +105,7 @@ If you run hass.io on an Intel NUC and haven't seen it yet, check out the VS Cod
## Release 0.91.2 - April 8
-- Correctly load Mopar's config ([@rohankapoorcom] - [#22771]) ([mopar docs])
+- Correctly load Mopar's config ([@rohankapoorcom] - [#22771])
- Fix konnected unique_id computation for switches ([@heythisisnate] - [#22777]) ([konnected docs]) (breaking change)
- make the custom polling actually request state ([@dmulcahey] - [#22778]) ([zha docs])
- ZHA Light debug logging. ([@Adminiuga] - [#22776]) ([zha docs])
@@ -153,7 +153,6 @@ If you run hass.io on an Intel NUC and haven't seen it yet, check out the VS Cod
[hassio docs]: /integrations/hassio/
[konnected docs]: /integrations/konnected/
[mobile_app docs]: /integrations/mobile_app/
-[mopar docs]: /integrations/mopar/
[tado docs]: /integrations/tado/
[yeelight docs]: /integrations/yeelight/
[zha docs]: /integrations/zha/
@@ -212,7 +211,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
- __Dark Sky__ - Dark Sky provides hourly forecasts for various monitored conditions. This change creates new sensors for each hourly forecasted condition with suffix `_h` while adding the suffix `_ d` to the daily forecasted conditions. For example, now a `sensor.dark_sky_summary_ d` and `sensor.dark_sky_summary_ h` will be created if the forecast and hourly_forecast parameters are populated. ([@rtclauss] - [#21820]) ([darksky docs]) - __Konnected__ - This will change the internal unique_id for Konnected switches (i.e., siren, buzzer, generic switch). Users will need to manually remove the orphaned switch entities from the entity registry after updating and re-configure any changes stored in the entity registry (i.e., name and entity_id), as their unique IDs will change. ([@heythisisnate] - [#22389]) ([konnected docs]) -- __Mopar__ - The mopar sensor platform has been broken up into a base component with sensor, switch, and lock platforms. The sensor.mopar_remote_command service has been removed since the functionality has been folded into the new platforms and the new mopar.sound_horn service. Please view the documentation to see the new setup instructions. ([@rohankapoorcom] - [#21526]) ([mopar docs]) +- __Mopar__ - The mopar sensor platform has been broken up into a base component with sensor, switch, and lock platforms. The sensor.mopar_remote_command service has been removed since the functionality has been folded into the new platforms and the new mopar.sound_horn service. Please view the documentation to see the new setup instructions. ([@rohankapoorcom] - [#21526]) ## Beta Fixes @@ -415,7 +414,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - Move HKDevice into connection ([@Jc2k] - [#22430]) ([homekit_controller docs]) - Incoming SMS handling for netgear_lte ([@amelchio] - [#22402]) ([netgear_lte docs]) - Entur upgrade to v0.2.0: async polling, number of departures, omit non boarding departures ([@hfurubotten] - [#22001]) ([entur_public_transport docs]) -- Mopar split ([@rohankapoorcom] - [#21526]) ([mopar docs]) (breaking change) +- Mopar split ([@rohankapoorcom] - [#21526]) (breaking change) - Fix too-abrubt SimpliSafe data refresh termination on error ([@bachya] - [#22466]) ([simplisafe docs]) - Great migration notify ([@robbiet480] - [#22406]) - Print error instead of warning for custom platforms in legacy format ([@balloob] - [#22486]) @@ -795,7 +794,6 @@ Experiencing issues introduced by this release? Please report them in our [issue [microsoft docs]: /integrations/microsoft/ [mold_indicator docs]: /integrations/mold_indicator/ [moon docs]: /integrations/moon/ -[mopar docs]: /integrations/mopar/ [mqtt docs]: /integrations/mqtt/ [nanoleaf docs]: /integrations/nanoleaf/ [ness_alarm docs]: /integrations/ness_alarm/ diff --git a/source/_posts/2019-10-30-release-101.markdown b/source/_posts/2019-10-30-release-101.markdown index b92b1f5692a..88d569ae846 100644 --- a/source/_posts/2019-10-30-release-101.markdown +++ b/source/_posts/2019-10-30-release-101.markdown @@ -574,7 +574,7 @@ The **holiday name** sensor has been renamed to **holiday**. ([@tsvi] - [#27654] - Move imports in nest component ([@Quentame] - [#27778]) ([nest docs]) - moved imports to top level ([@Bouni] - [#27781]) ([airvisual docs]) - Move imports in netgear component ([@Quentame] - [#27776]) ([netgear docs]) -- moved imports to top level ([@Bouni] - [#27784]) ([alarmdotcom docs]) +- moved imports to top level ([@Bouni] - [#27784]) - Generate ADB key for Android TV integration ([@JeffLIrion] - [#27344]) ([androidtv docs]) - moved imports to top level ([@Bouni] - [#27782]) ([aladdin_connect docs]) - Move imports in android_ip_webcam component ([@Bouni] - [#27797]) ([android_ip_webcam docs]) @@ -709,7 +709,7 @@ The **holiday name** sensor has been renamed to **holiday**. ([@tsvi] - [#27654] - Move imports in eliqonline component ([@djpremier] - [#27980]) ([eliqonline docs]) - Move imports in frontend component ([@djpremier] - [#27988]) ([frontend docs]) - Move imports in message_bird component ([@djpremier] - [#28022]) ([message_bird docs]) -- Move imports in mopar component ([@djpremier] - [#28028]) ([mopar docs]) +- Move imports in mopar component ([@djpremier] - [#28028]) - Move imports in mvglive component ([@djpremier] - [#28031]) ([mvglive docs]) - Move imports in mpd component ([@djpremier] - [#28030]) ([mpd docs]) - Move imports in namecheapdns component ([@djpremier] - [#28034]) ([namecheapdns docs]) @@ -1527,7 +1527,6 @@ The **holiday name** sensor has been renamed to **holiday**. ([@tsvi] - [#27654] [aladdin_connect docs]: /integrations/aladdin_connect/ [alarm_control_panel docs]: /integrations/alarm_control_panel/ [alarmdecoder docs]: /integrations/alarmdecoder/ -[alarmdotcom docs]: /integrations/alarmdotcom/ [alexa docs]: /integrations/alexa/ [alpha_vantage docs]: /integrations/alpha_vantage/ [amazon_polly docs]: /integrations/amazon_polly/ @@ -1735,7 +1734,6 @@ The **holiday name** sensor has been renamed to **holiday**. ([@tsvi] - [#27654] [miflora docs]: /integrations/miflora/ [mitemp_bt docs]: /integrations/mitemp_bt/ [mobile_app docs]: /integrations/mobile_app/ -[mopar docs]: /integrations/mopar/ [mpd docs]: /integrations/mpd/ [mqtt docs]: /integrations/mqtt/ [msteams docs]: /integrations/msteams/ diff --git a/source/_posts/2020-02-05-release-105.markdown b/source/_posts/2020-02-05-release-105.markdown index 69cca2c0277..c4e1c1515a6 100644 --- a/source/_posts/2020-02-05-release-105.markdown +++ b/source/_posts/2020-02-05-release-105.markdown @@ -755,7 +755,7 @@ Hats over your heart for these shuttered integrations. Pour one out for: - Removes Cisco Spark integration ([@frenck] - [#30738]) (breaking change) - Fix translation from HA playlist to UPnP playlistItem ([@StevenLooman] - [#30743]) ([dlna_dmr docs]) - Fix 'NewIPAddress' error in component fritz ([@basdelfos] - [#30210]) ([fritz docs]) ([fritzbox_netmonitor docs]) (breaking change) -- Fix small typo in alarmdotcom component ([@akinomeroglu] - [#30758]) ([alarmdotcom docs]) +- Fix small typo in alarmdotcom component ([@akinomeroglu] - [#30758]) - Fix supported_features in MQTT fan ([@springstan] - [#28680]) ([mqtt docs]) (breaking change) - Add support for the voltage sensor on the greeneye GEM ([@garbled1] - [#30484]) ([greeneye_monitor docs]) - Add Safe Mode ([@balloob] - [#30723]) ([frontend docs]) ([http docs]) ([safe_mode docs]) (breaking change) (new-integration) @@ -1413,7 +1413,6 @@ Hats over your heart for these shuttered integrations. Pour one out for: [adguard docs]: /integrations/adguard/ [airly docs]: /integrations/airly/ [alarmdecoder docs]: /integrations/alarmdecoder/ -[alarmdotcom docs]: /integrations/alarmdotcom/ [alexa docs]: /integrations/alexa/ [almond docs]: /integrations/almond/ [amcrest docs]: /integrations/amcrest/ diff --git a/source/_posts/2020-03-15-community-highlights.markdown b/source/_posts/2020-03-15-community-highlights.markdown new file mode 100644 index 00000000000..cf196fea07d --- /dev/null +++ b/source/_posts/2020-03-15-community-highlights.markdown @@ -0,0 +1,102 @@ +--- +title: "Community Highlights: 5th edition" +description: "DIY Smart key holder, Marine aquariums and Live energy consumption" +date: 2020-03-15 00:00:00 +date_formatted: "March 15, 2020" +author: Franck Nijhof +author_twitter: frenck +categories: Community +og_image: /images/blog/2020-03-15-community-highlights/social.png +--- + +Time for the fifth enactment of the Community Highlights! + +We've received quite a few recommendations, but also closely monitored +social media and found some gems to share again! + +## Controlling 7! marine aquariums with Home Assistant + +Let's start with showcasing a highly unusual, but impressive, Home Assistant setup. +It is shared on our [Facebook group][facebook-group] by Kevin McPeake. Kevin's +setup has a total of 5 Home Assistant instances, controlling 7x marine aquariums! + + + +
+ +Those are some big views Kevin! I bet you will be happy with the new Lovelace +features that are coming in Home Assistant Core 0.107. It will help +you to trim down that a bit, into multiple Lovelace Dashboards (now in +[beta, sneak peak?](https://rc.home-assistant.io/latest-release-notes/)). + +[Click here to check out Kevin's post on our Facebook group.](https://www.facebook.com/groups/HomeAssistant/permalink/2597624533842234/) + +_Thanks, Walt_H for [sending in](/suggest-community-highlight) this item! đź‘Ť_ + +## Live energy consumption screen + +Energy saving is good for the environment (and your wallet). However, to do that, +you have to become aware of your actual usage. `/u/Lau-ie` shared his energy +consumption screen on our [subreddit][reddit]. + +This gives insight into the current usage, but also in the usage & costs of the +consumed energy of the last 24 hours. + +
+
+ Kevin's impressive setup for his 7 aquariums.
+New energyconsumption screen, still tweaking it. from r/homeassistant +
+ + +Do you actively monitor your energy usage? What does your dashboard look like? + +## A DIY smart magnetic key holder + +And here is one from [James Callaghan](https://twitter.com/jamescallaghan), who +created really smart and easy to replicate magnet key holder, using a Xiaomi +Aqara Door/Window sensor. Yes, this key holder works on Zigbee. + +
+ +## Consumer Reports: Open call for non-resident technologist fellows + +Consumer Reports is an American non-profit organization that does independent, +(product) testing and research for consumers to provide truth, transparency and +fairness. Their results are published in a monthly magazine and on their website. + +The Consumer Reports Digital Lab offers paid, non-resident fellowships to study +the effects of connected (IoT) products and services. They welcome anyone +interested in public technology research to apply for the fellowship. + +If you are interested in this, more information can be found here: + +- [Consumer Reports Digital Lab - Fellows](https://digital-lab.consumerreports.org/fellows/) +- [Blog: An open call for non-resident technologist fellows](https://medium.com/cr-digital-lab/coming-soon-an-open-call-for-non-resident-technologist-fellows-95de2f3399fe) + +## Got a tip for the next edition? + +Have you seen (or made) something awesome, interesting, unique, amazing, inspirational, unusual or funny, using Home Assistant? + +[Click here to send us your Community Highlight suggestion](/suggest-community-highlight). + +Also, don't forget to share your creations with us via Social Media: + +- Twitter it! Be sure to mention [@home_assistant][twitter] +- Share it on our [Facebook group][facebook-group] +- Post it to our [subreddit][reddit] +- Tag [@homeasssistant][instagram] on Instagram +- Or via chat, drop us a line in the [#lounge at Discord][chat] + +See you next edition! + +[chat]: https://www.home-assistant.io/join-chat +[facebook-group]: https://www.facebook.com/groups/HomeAssistant/ +[instagram]: https://www.instagram.com/homeassistant/ +[reddit]: https://www.reddit.com/r/homeassistant +[twitter]: https://www.twitter.com/home_assistant diff --git a/source/_posts/2020-03-18-release-107.markdown b/source/_posts/2020-03-18-release-107.markdown index 7baba12d4e5..db6469b319e 100644 --- a/source/_posts/2020-03-18-release-107.markdown +++ b/source/_posts/2020-03-18-release-107.markdown @@ -70,7 +70,7 @@ Lovelace configuration panel, and YAML dashboards can be set up in `configuration.yaml`, see [the documentation](/lovelace/yaml-mode/). This awesome new feature comes with a deprecation if you use Lovelace in -manual YAML mode: You need to move the `resource` section from +manual YAML mode: You need to move the `resources` section from your `ui-lovelace.yaml` to the `lovelace:` section in `configuration.yaml`. It is not a breaking change yet; we still load them from the previous location if we didn't find anything in the `lovelace:` section, however, this fallback @@ -169,7 +169,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - The `view` and `control` configuration options for a group. - The `group.set_visibility` service call - The `control`, `visible`, `view` options on the `group.set` service call - + Please ensure your configuration and automations do not use these anymore. - ([@frenck] - [#32021]) ([group docs]) - **Input Number** - Adds an entity ID to input_number warning. Passing an out of range value to `input_number.set_value` will now raise a validation error. Incrementing/decrementing an `input_number` will no longer cause warnings. - ([@balloob] - [#32012]) ([input_number docs]) @@ -211,7 +211,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - **Automation** - The `hide_entity` configuration option on an automation was deprecated in Home Assistant 0.105 and is removed in this release. It was used for the old states UI, which is no longer available, making this option obsolete. Please ensure your configuration is not using this option. - ([@frenck] - [#32038]) ([automation docs]) - **IQVIA** - When configuring IQVIA via `configuration.yaml`, the `monitored_conditions` key has been deprecated and will be removed in 0.114.0. All sensors are now created by default. (ADR-0003) - ([@bachya] - [#32223]) ([iqvia docs]) - + Example YAML configuration: ```yaml @@ -375,6 +375,167 @@ Experiencing issues introduced by this release? Please report them in our [issue - Updated frontend to 20200318.0 ([@bramkragten] - [#32931]) ([frontend docs]) (beta fix) - Fix flaky tests for HMIPC ([@SukramJ] - [#32806]) (beta fix) +## Release 0.107.1 - March 18 + +- Updated frontend to 20200318.1 ([@bramkragten] - [#32957]) ([frontend docs]) +- Add device automation as frontend dependency ([@balloob] - [#32962]) ([frontend docs]) +- Fix zone config ([@balloob] - [#32963]) ([zone docs]) + +[#32957]: https://github.com/home-assistant/core/pull/32957 +[#32962]: https://github.com/home-assistant/core/pull/32962 +[#32963]: https://github.com/home-assistant/core/pull/32963 +[@balloob]: https://github.com/balloob +[@bramkragten]: https://github.com/bramkragten +[frontend docs]: /integrations/frontend/ +[zone docs]: /integrations/zone/ + +## Release 0.107.2 - March 20 + +- 0.107.2 - Bump aiohomekit to fix Insignia NS-CH1XGO8 and Lenno… ([@Jc2k] - [#33016]) ([homekit_controller docs]) +- Fix camera.options to camera.stream_options. ([@ochlocracy] - [#32767]) ([camera docs]) +- Fix velbus in the 107 release ([@Cereal2nd] - [#32936]) ([velbus docs]) +- Refactor ZHA setup ([@Adminiuga] - [#32959]) ([zha docs]) +- Fix somfy optimistic mode when missing in conf ([@tetienne] - [#32995]) ([somfy docs]) +- Axis - Fix char in stream url ([@Kane610] - [#33004]) ([axis docs]) +- Fix sighthound dependency issue ([@robmarkcole] - [#33010]) ([sighthound docs]) +- Bump simplisafe-python to 9.0.3 ([@bachya] - [#33013]) ([simplisafe docs]) +- 0.107.2 - Bump aiohomekit to fix Insignia NS-CH1XGO8 and Lenno… ([@Jc2k] - [#33016]) ([homekit_controller docs]) +- Handle zigpy clusters without ep_attribute attribute. ([@Adminiuga] - [#33028]) ([zha docs]) +- Fix zones in packages ([@balloob] - [#33027]) +- Fix RainMachine not properly storing data in the config entry ([@bachya] - [#33002]) ([rainmachine docs]) + +[#32767]: https://github.com/home-assistant/core/pull/32767 +[#32936]: https://github.com/home-assistant/core/pull/32936 +[#32959]: https://github.com/home-assistant/core/pull/32959 +[#32995]: https://github.com/home-assistant/core/pull/32995 +[#33002]: https://github.com/home-assistant/core/pull/33002 +[#33004]: https://github.com/home-assistant/core/pull/33004 +[#33010]: https://github.com/home-assistant/core/pull/33010 +[#33013]: https://github.com/home-assistant/core/pull/33013 +[#33016]: https://github.com/home-assistant/core/pull/33016 +[#33027]: https://github.com/home-assistant/core/pull/33027 +[#33028]: https://github.com/home-assistant/core/pull/33028 +[@Adminiuga]: https://github.com/Adminiuga +[@Cereal2nd]: https://github.com/Cereal2nd +[@Jc2k]: https://github.com/Jc2k +[@Kane610]: https://github.com/Kane610 +[@bachya]: https://github.com/bachya +[@balloob]: https://github.com/balloob +[@ochlocracy]: https://github.com/ochlocracy +[@robmarkcole]: https://github.com/robmarkcole +[@tetienne]: https://github.com/tetienne +[axis docs]: /integrations/axis/ +[camera docs]: /integrations/camera/ +[homekit_controller docs]: /integrations/homekit_controller/ +[rainmachine docs]: /integrations/rainmachine/ +[sighthound docs]: /integrations/sighthound/ +[simplisafe docs]: /integrations/simplisafe/ +[somfy docs]: /integrations/somfy/ +[velbus docs]: /integrations/velbus/ +[zha docs]: /integrations/zha/ + +## Release 0.107.3 - March 20 + +- Fix netatmo webhook registration issue ([@cgtobi] - [#32994]) ([netatmo docs]) +- Fix discovery issue with netatmo climate devices ([@cgtobi] - [#33040]) ([netatmo docs]) +- Fix packages for schemas without a default ([@frenck] - [#33045]) ([person docs]) + +[#32994]: https://github.com/home-assistant/core/pull/32994 +[#33040]: https://github.com/home-assistant/core/pull/33040 +[#33045]: https://github.com/home-assistant/core/pull/33045 +[@cgtobi]: https://github.com/cgtobi +[@frenck]: https://github.com/frenck +[netatmo docs]: /integrations/netatmo/ +[person docs]: /integrations/person/ + +## Release 0.107.4 - March 20 + +- Add negative tests for identify schema for packages ([@balloob] - [#33050]) +- Bump simplisafe-python to 9.0.4 ([@bachya] - [#33059]) ([simplisafe docs]) +- Bump aioasuswrt to 1.2.3 and fix asuswrt sensor ([@Knapoc] - [#33064]) ([asuswrt docs]) +- Fix package default extraction ([@balloob] - [#33071]) + +[#33050]: https://github.com/home-assistant/core/pull/33050 +[#33059]: https://github.com/home-assistant/core/pull/33059 +[#33064]: https://github.com/home-assistant/core/pull/33064 +[#33071]: https://github.com/home-assistant/core/pull/33071 +[@Knapoc]: https://github.com/Knapoc +[@bachya]: https://github.com/bachya +[@balloob]: https://github.com/balloob +[asuswrt docs]: /integrations/asuswrt/ +[simplisafe docs]: /integrations/simplisafe/ + +## Release 0.107.5 - March 21 + +- Upgrade huawei-lte-api to 1.4.11 ([@scop] - [#32791]) ([huawei_lte docs]) +- Validate UUID for tankerkoenig ([@guillempages] - [#32805]) ([tankerkoenig docs]) +- Try all Samsung TV websocket ports ([@escoand] - [#33001]) ([samsungtv docs]) +- Split ZHA device loading and entities adding ([@Adminiuga] - [#33075]) ([zha docs]) +- Fix totalconnect AttributeError introduced in 0.107 ([@austinmroczek] - [#33079]) ([totalconnect docs]) +- Fix tankerkoenig with more than 10 stations ([@guillempages] - [#33098]) ([tankerkoenig docs]) +- Fix Extend ONVIF unique ID with profile index ([@frenck] - [#33103]) ([onvif docs]) + +[#32791]: https://github.com/home-assistant/core/pull/32791 +[#32805]: https://github.com/home-assistant/core/pull/32805 +[#33001]: https://github.com/home-assistant/core/pull/33001 +[#33075]: https://github.com/home-assistant/core/pull/33075 +[#33079]: https://github.com/home-assistant/core/pull/33079 +[#33098]: https://github.com/home-assistant/core/pull/33098 +[#33103]: https://github.com/home-assistant/core/pull/33103 +[@Adminiuga]: https://github.com/Adminiuga +[@austinmroczek]: https://github.com/austinmroczek +[@escoand]: https://github.com/escoand +[@frenck]: https://github.com/frenck +[@guillempages]: https://github.com/guillempages +[@scop]: https://github.com/scop +[huawei_lte docs]: /integrations/huawei_lte/ +[onvif docs]: /integrations/onvif/ +[samsungtv docs]: /integrations/samsungtv/ +[tankerkoenig docs]: /integrations/tankerkoenig/ +[totalconnect docs]: /integrations/totalconnect/ +[zha docs]: /integrations/zha/ + +## Release 0.107.6 - March 24 + +- Integrate dockerbuild ([@pvizeli] - [#33168]) +- Fix script logging with name ([@balloob] - [#33120]) +- Fix minut point updating frozen config entry data ([@frenck] - [#33148]) ([point docs]) +- Bump OZW fork to 0.1.10 ([@pvizeli] - [#33205]) ([zwave docs]) + +[#33120]: https://github.com/home-assistant/core/pull/33120 +[#33148]: https://github.com/home-assistant/core/pull/33148 +[#33168]: https://github.com/home-assistant/core/pull/33168 +[#33205]: https://github.com/home-assistant/core/pull/33205 +[@balloob]: https://github.com/balloob +[@frenck]: https://github.com/frenck +[@pvizeli]: https://github.com/pvizeli +[point docs]: /integrations/point/ +[zwave docs]: /integrations/zwave/ + +## Release 0.107.7 - March 25 + +- Fix velbus dimming control ([@brefra] - [#33139]) ([velbus docs]) +- Increase timeout setting up IPMA ([@dgomes] - [#33194]) ([ipma docs]) +- Refactor ZHA platform setup ([@Adminiuga] - [#33226]) ([zha docs]) +- Ensure recorder event loop recovers if the database server dis… ([@bdraco] - [#33253]) ([recorder docs]) +- Schedule Unifi shutdown callback earlier ([@jjlawren] - [#33257]) ([unifi docs]) + +[#33139]: https://github.com/home-assistant/core/pull/33139 +[#33194]: https://github.com/home-assistant/core/pull/33194 +[#33226]: https://github.com/home-assistant/core/pull/33226 +[#33253]: https://github.com/home-assistant/core/pull/33253 +[#33257]: https://github.com/home-assistant/core/pull/33257 +[@Adminiuga]: https://github.com/Adminiuga +[@bdraco]: https://github.com/bdraco +[@brefra]: https://github.com/brefra +[@dgomes]: https://github.com/dgomes +[@jjlawren]: https://github.com/jjlawren +[ipma docs]: /integrations/ipma/ +[recorder docs]: /integrations/recorder/ +[unifi docs]: /integrations/unifi/ +[velbus docs]: /integrations/velbus/ +[zha docs]: /integrations/zha/ + ## All changes - Nuki: add support for unique id ([@pvizeli] - [#31824]) ([nuki docs]) diff --git a/source/_redirects b/source/_redirects index 321aa5292db..eb4f219f9c3 100644 --- a/source/_redirects +++ b/source/_redirects @@ -83,7 +83,6 @@ /components/air_quality.opensensemap /integrations/opensensemap /components/alarm_control_panel.abode /integrations/abode /components/alarm_control_panel.alarmdecoder /integrations/alarmdecoder#alarm-control-panel -/components/alarm_control_panel.alarmdotcom /integrations/alarmdotcom /components/alarm_control_panel.arlo /integrations/arlo /components/alarm_control_panel.blink /integrations/blink /components/alarm_control_panel.canary /integrations/canary @@ -349,7 +348,6 @@ /components/device_tracker.mqtt_json /integrations/mqtt_json /components/device_tracker.netgear /integrations/netgear /components/device_tracker.nmap_tracker /integrations/nmap_tracker -/components/device_tracker.openwrt /integrations/openwrt /components/device_tracker.owntracks /integrations/owntracks /components/device_tracker.owntracks_http /integrations/owntracks /components/device_tracker.ping /integrations/ping @@ -784,7 +782,6 @@ /components/sensor.modem_callerid /integrations/modem_callerid /components/sensor.mold_indicator /integrations/mold_indicator /components/sensor.moon /integrations/moon -/components/sensor.mopar /integrations/mopar /components/sensor.mqtt_room /integrations/mqtt_room /components/sensor.mvglive /integrations/mvglive /components/sensor.mychevy /integrations/mychevy @@ -1100,7 +1097,6 @@ /components/alarm_control_panel.ifttt /integrations/alarm_control_panel.ifttt /components/alarm_control_panel.mqtt /integrations/alarm_control_panel.mqtt /components/alarmdecoder /integrations/alarmdecoder -/components/alarmdotcom /integrations/alarmdotcom /components/alert /integrations/alert /components/alexa /integrations/alexa /components/alexa.flash_briefings /integrations/alexa.flash_briefings @@ -1581,7 +1577,6 @@ /components/mold_indicator /integrations/mold_indicator /components/monoprice /integrations/monoprice /components/moon /integrations/moon -/components/mopar /integrations/mopar /components/mpchc /integrations/mpchc /components/mpd /integrations/mpd /components/mqtt /integrations/mqtt @@ -1659,7 +1654,6 @@ /components/opentherm_gw /integrations/opentherm_gw /components/openuv /integrations/openuv /components/openweathermap /integrations/openweathermap -/components/openwrt /integrations/openwrt /components/opple /integrations/opple /components/orangepi_gpio /integrations/orangepi_gpio /components/orvibo /integrations/orvibo diff --git a/source/addons/index.html b/source/addons/index.html index b8a3ca0390a..2cfbc5099a8 100644 --- a/source/addons/index.html +++ b/source/addons/index.html @@ -1,17 +1,17 @@ --- -title: "Hass.io Add-ons" +title: "Home Assistant Add-ons" description: "Find add-ons to install with Home Assistant." regenerate: false ---My mind goes crazy at the number of problems a single sensor can solve. For me, this was for reassurance using @****home_assistant**** but when you think how this could be applied elsewhere concierge services to those with memory issues etc.. #smarthome #inclusivity #accessibility #IoT pic.twitter.com/sirygbCE7p
— James Callaghan #Microsoft (@jamescallaghan) March 9, 2020 +- Add-ons for Hass.io allow the user to extend the functionality around Home + Add-ons allow the user to extend the functionality around Home Assistant by installing additional applications.
This can be running an application that Home Assistant can integrate with (like an MQTT broker) or to share the configuration via Samba for easy editing - from other computers. Add-ons can be configured via the Hass.io panel in Home + from other computers. Add-ons can be configured via the Supervisor panel in Home Assistant.
@@ -21,18 +21,18 @@ regenerate: false- To install add-ons, navigate to the Hass.io panel in your Home Assistant + To install add-ons, navigate to the Supervisor panel in your Home Assistant frontend, and click on the "ADD-ON STORE" tab. All add-ons, including their documentation, are available right from the store. Click on a add-on you are interested in, to read the documentation or to install the add-on.
- Add-ons are only available if you've used the Hass.io installer. If you + Add-ons are only available if you've used the Home Assistant installer. If you installed Home Assistant using any other method then you cannot use add-ons (but you can achieve the same result manually).
- Check the Hass.io forums for + Check the Home Assistant forums for add-on repositories managed by the community.
diff --git a/source/docs/index.markdown b/source/docs/index.markdown index 489af81e433..4ccf6afac68 100644 --- a/source/docs/index.markdown +++ b/source/docs/index.markdown @@ -10,7 +10,7 @@ The documentation covers beginner to advanced topics around the installation, se-
Hass.io+Installationdiff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 33109490214..9b4191bb644 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -106,82 +106,59 @@ You can also install Home Assistant on a Linux operating system of choice, calle Home Assistant Supervised, will still give you access to most features Home Assistant has to offer, including add-ons. -The packages you need to have available on your system needed to Home Assistant may vary. +### Supported systems and limitations -### Debian/Ubuntu +While Home Assistant Supervised can be run on practically any Linux systems, +the Home Assistant project limits support for this installation method. -- `apparmor-utils` -- `apt-transport-https` -- `avahi-daemon` -- `ca-certificates` -- `curl` -- `dbus` -- `jq` -- `socat` -- `software-properties-common` +Only the use of Debian or Ubuntu is supported. Other Linux-based system may work +but is not part of our testing and thus not supported. -Optional: +Furthermore, if you choose to run Home Assistant Supervised, the operating +system of your choosing (including Debian/Ubuntu) is **your** responsibility. +Both in terms of systems upgrade and system configuration. -- `network-manager` +Customizations to your custom operating system may interfere with Home Assistant. +For that reason, please be sure you have to knowledge to manage, configure and +maintain the operating system of your choosing. -- - Without the NetworkManager, you will be not able to control your host network setup over the UI. The `modemmanager` package will interfere with any Z-Wave or Zigbee stick and should be removed or disabled. Failure to do so will result in random failures of those integrations. For example, you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` - -- -### Arch Linux - -- `apparmor` -- `avahi` -- `ca-certificates` -- `curl` -- `dbus` -- `docker` -- `jq` -- `socat` - -You also need to have Docker-CE installed. There are well-documented procedures for installing Docker on Ubuntu at [Docker.com](https://docs.docker.com/install/linux/docker-ce/ubuntu/), you can find installation steps for your Linux distribution in the menu on the left. - -- - Some distributions, like Ubuntu, have a `docker.io` package available. Using that package will cause issues! - Be sure to install the official Docker-CE from the above-listed URL. - - Docker is not always ready with a release when a new Ubuntu version is out. Check if your version of Ubuntu is supported by Docker [here](https://docs.docker.com/install/linux/docker-ce/ubuntu/). - -+When in doubt, we highly recommend using the regular installation of Home +Assistant as provided above. In that case, Home Assistant will manage and update +the Home Assistant Operating System for you. ### Preparation To prepare your machine for the Home Assistant installation, run the following commands: -For Ubuntu: +If you run Ubuntu, first run this command: ```bash -add-apt-repository universe +sudo add-apt-repository universe ``` -Debian/Ubuntu: +Next run the following commands (for both Debian and Ubuntu): ```bash sudo -i apt-get update apt-get install -y software-properties-common apparmor-utils apt-transport-https avahi-daemon ca-certificates curl dbus jq network-manager socat systemctl disable ModemManager +systemctl stop ModemManager curl -fsSL get.docker.com | sh ``` +### Installation of Home Assistant Supervised + The following script will then install Home Assistant on a variety of operating systems and machine types. ```bash -curl -sL "https://raw.githubusercontent.com/home-assistant/hassio-installer/master/hassio_install.sh" | bash -s +curl -sL "https://raw.githubusercontent.com/home-assistant/supervised-installer/master/installer.sh" | bash -s ``` -Some installation types require flags to identify the computer type, for example, when using a Raspberry Pi 3, the flag `-- -m raspberrypi3` is required. The install script would then look like this: +Some installation types require flags to identify the computer type, for example, when using a Raspberry Pi 4, the flag `-- -m raspberrypi4` is required. The install script would then look like this: ```bash -curl -sL "https://raw.githubusercontent.com/home-assistant/hassio-installer/master/hassio_install.sh" | bash -s -- -m raspberrypi3 +curl -sL "https://raw.githubusercontent.com/home-assistant/supervised-installer/master/installer.sh" | bash -s -- -m raspberrypi4 ``` #### Other machine types @@ -194,7 +171,7 @@ curl -sL "https://raw.githubusercontent.com/home-assistant/hassio-installer/mast - `raspberrypi4` - `raspberrypi4-64` - `odroid-c2` -- `odroid-cu2` +- `odroid-n2` - `odroid-xu` - `tinker` - `qemuarm` @@ -202,16 +179,10 @@ curl -sL "https://raw.githubusercontent.com/home-assistant/hassio-installer/mast - `qemux86` - `qemux86-64` -See the [hassio-installer](https://github.com/home-assistant/hassio-installer) GitHub page for an up-to-date listing of supported machine types. +See the [installer](https://github.com/home-assistant/supervised-installer) GitHub page for an up-to-date listing of supported machine types. If you can not find your machine type in the list, you should pick the `qemu` release. i.e., `qemux86-64` for a normal 64-bit Linux distribution, or `qemuarm-64` for most modern ARM-based target like Raspberry Pi clones, or TV boxes. --When you use this installation method, the core SSH add-on may not function correctly. If that happens, use the community SSH add-on. Some of the documentation might not work for your installation either. -- -A detailed guide about running Home Assistant as a virtual machine is available in the [blog][hassio-vm]. - [balenaEtcher]: https://www.balena.io/etcher [Virtual Appliance]: https://github.com/home-assistant/operating-system/blob/dev/Documentation/boards/ova.md [hassos-network]: https://github.com/home-assistant/operating-system/blob/dev/Documentation/network.md @@ -230,10 +201,9 @@ A detailed guide about running Home Assistant as a virtual machine is available [vmdk]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_ova-3.12.vmdk.gz [vhdx]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_ova-3.12.vhdx.gz [vdi]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_ova-3.12.vdi.gz -[linux]: https://github.com/home-assistant/hassio-installer +[linux]: https://github.com/home-assistant/supervised-installer [local]: http://homeassistant.local:8123 [samba]: /addons/samba/ [ssh]: /addons/ssh/ [pi-power]: https://www.raspberrypi.org/help/faqs/#powerReqs -[hassio-vm]: /blog/2017/11/29/hassio-virtual-machine/ [configure]: /getting-started/configuration/ diff --git a/source/images/blog/2020-03-15-community-highlights/marine-aquariums.png b/source/images/blog/2020-03-15-community-highlights/marine-aquariums.png new file mode 100644 index 00000000000..e75dc5fbbc8 Binary files /dev/null and b/source/images/blog/2020-03-15-community-highlights/marine-aquariums.png differ diff --git a/source/images/blog/2020-03-15-community-highlights/social.png b/source/images/blog/2020-03-15-community-highlights/social.png new file mode 100644 index 00000000000..49a54df6ef1 Binary files /dev/null and b/source/images/blog/2020-03-15-community-highlights/social.png differ diff --git a/source/images/integrations/amcrest/amcrest_ptz.jpg b/source/images/integrations/amcrest/amcrest_ptz.jpg new file mode 100644 index 00000000000..3e925340ceb Binary files /dev/null and b/source/images/integrations/amcrest/amcrest_ptz.jpg differ diff --git a/source/images/lovelace/header-footer/graph.png b/source/images/lovelace/header-footer/graph.png new file mode 100644 index 00000000000..8e529cb6cc1 Binary files /dev/null and b/source/images/lovelace/header-footer/graph.png differ diff --git a/source/images/lovelace/lovelace_entity_card.png b/source/images/lovelace/lovelace_entity_card.png new file mode 100644 index 00000000000..3a375d0610a Binary files /dev/null and b/source/images/lovelace/lovelace_entity_card.png differ diff --git a/source/images/screenshots/nextcloud-sample-sensor.png b/source/images/screenshots/nextcloud-sample-sensor.png new file mode 100644 index 00000000000..dcb30a000a4 Binary files /dev/null and b/source/images/screenshots/nextcloud-sample-sensor.png differ diff --git a/source/images/supported_brands/alarmdotcom.png b/source/images/supported_brands/alarmdotcom.png deleted file mode 100644 index cc94de3a537..00000000000 Binary files a/source/images/supported_brands/alarmdotcom.png and /dev/null differ diff --git a/source/images/supported_brands/directv.png b/source/images/supported_brands/directv.png deleted file mode 100644 index aa0fe2da921..00000000000 Binary files a/source/images/supported_brands/directv.png and /dev/null differ diff --git a/source/images/supported_brands/nextcloud.png b/source/images/supported_brands/nextcloud.png new file mode 100644 index 00000000000..1c9558a1301 Binary files /dev/null and b/source/images/supported_brands/nextcloud.png differ diff --git a/source/images/supported_brands/roku.png b/source/images/supported_brands/roku.png deleted file mode 100644 index 5e964140c95..00000000000 Binary files a/source/images/supported_brands/roku.png and /dev/null differ diff --git a/source/images/supported_brands/schluter.png b/source/images/supported_brands/schluter.png new file mode 100644 index 00000000000..8026045e31e Binary files /dev/null and b/source/images/supported_brands/schluter.png differ diff --git a/source/integrations/index.html b/source/integrations/index.html index ae02ee938d9..1fc6a130790 100644 --- a/source/integrations/index.html +++ b/source/integrations/index.html @@ -144,7 +144,7 @@ allComponents.pop(); // remove placeholder element at the end components: [], image: function () { if (this.logo === '') { - return '
';
+ return '
';
} else {
return ''; } diff --git a/source/lovelace/actions.markdown b/source/lovelace/actions.markdown index f714ec8eb2b..7d49c9e912e 100644 --- a/source/lovelace/actions.markdown +++ b/source/lovelace/actions.markdown @@ -161,8 +161,11 @@ double_tap_action: If you define confirmation as an object instead of boolean, you can add more customization and configurations. ```yaml -hold_action: - action: toggle +double_tap_action: + action: call-service + confirmation: + text: Are you sure you want to restart? + service: script.restart ``` {% configuration confirmation%} diff --git a/source/lovelace/header-footer.markdown b/source/lovelace/header-footer.markdown index 655ddd17cdc..e0dcd885f3a 100644 --- a/source/lovelace/header-footer.markdown +++ b/source/lovelace/header-footer.markdown @@ -14,8 +14,9 @@ Screenshot of an entities card with a picture header and buttons footer. Widget to show a picture as a header or a footer. A picture can have touch actions associated with it. ```yaml -type: picture -image: 'https://www.home-assistant.io/images/lovelace/header-footer/balloons-header.png' +header: + type: picture + image: 'https://www.home-assistant.io/images/lovelace/header-footer/balloons-header.png' ``` {% configuration header-footer %} @@ -37,7 +38,7 @@ hold_action: type: map double_tap_action: required: false - description: Action to take on tap-and-hold. See [action documentation](/lovelace/actions/#double-tap-action). + description: Action to take on double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map {% endconfiguration %} @@ -46,13 +47,14 @@ double_tap_action: Widget to show entities as buttons in the header or footer. ```yaml -type: buttons -entities: - - script.launch_confetti - - entity: script.swirl_lights - icon: 'mdi:track-light' - - entity: script.run_siren - icon: 'mdi:alarm-light' +footer: + type: buttons + entities: + - script.launch_confetti + - entity: script.swirl_lights + icon: 'mdi:track-light' + - entity: script.run_siren + icon: 'mdi:alarm-light' ``` {% configuration header-footer %} @@ -73,4 +75,41 @@ entities: required: false description: Override the entity image. type: string + name: + required: false + description: Label for the button + type: string +{% endconfiguration %} + +## Graph header & footer + +Widget to show an entity in the sensor domain as a graph in the header or footer. + +
+ +```yaml +footer: + type: graph + entity: sensor.outside_temperature + hours_to_show: 24 + detail: 1 +``` + +{% configuration header-footer %} +entity: + required: true + description: Entity id of `sensor` domain + type: string +detail: + required: false + description: Detail of the graph `1` or `2`, `1` equals one point/hour, `2` equals six points/hour + type: integer + default: 1 +hours_to_show: + required: false + description: Hours to show in graph + type: integer + default: 24 {% endconfiguration %} diff --git a/source/lovelace/yaml-mode.markdown b/source/lovelace/yaml-mode.markdown index d1c0369e1b1..871a35b5eb7 100644 --- a/source/lovelace/yaml-mode.markdown +++ b/source/lovelace/yaml-mode.markdown @@ -60,7 +60,7 @@ lovelace: mode: storage # Add yaml dashboards dashboards: - yaml: + lovelace-yaml: mode: yaml title: YAML icon: mdi:script
+Screenshot of an entities card with a graph footer.
+
-
- {% active_link /hassio/ Hass.io %}
+ {% active_link /hassio/ Home Assistant %}
';
}
diff --git a/source/lovelace/actions.markdown b/source/lovelace/actions.markdown
index f714ec8eb2b..7d49c9e912e 100644
--- a/source/lovelace/actions.markdown
+++ b/source/lovelace/actions.markdown
@@ -161,8 +161,11 @@ double_tap_action:
If you define confirmation as an object instead of boolean, you can add more customization and configurations.
```yaml
-hold_action:
- action: toggle
+double_tap_action:
+ action: call-service
+ confirmation:
+ text: Are you sure you want to restart?
+ service: script.restart
```
{% configuration confirmation%}
diff --git a/source/lovelace/header-footer.markdown b/source/lovelace/header-footer.markdown
index 655ddd17cdc..e0dcd885f3a 100644
--- a/source/lovelace/header-footer.markdown
+++ b/source/lovelace/header-footer.markdown
@@ -14,8 +14,9 @@ Screenshot of an entities card with a picture header and buttons footer.
Widget to show a picture as a header or a footer. A picture can have touch actions associated with it.
```yaml
-type: picture
-image: 'https://www.home-assistant.io/images/lovelace/header-footer/balloons-header.png'
+header:
+ type: picture
+ image: 'https://www.home-assistant.io/images/lovelace/header-footer/balloons-header.png'
```
{% configuration header-footer %}
@@ -37,7 +38,7 @@ hold_action:
type: map
double_tap_action:
required: false
- description: Action to take on tap-and-hold. See [action documentation](/lovelace/actions/#double-tap-action).
+ description: Action to take on double tap. See [action documentation](/lovelace/actions/#double-tap-action).
type: map
{% endconfiguration %}
@@ -46,13 +47,14 @@ double_tap_action:
Widget to show entities as buttons in the header or footer.
```yaml
-type: buttons
-entities:
- - script.launch_confetti
- - entity: script.swirl_lights
- icon: 'mdi:track-light'
- - entity: script.run_siren
- icon: 'mdi:alarm-light'
+footer:
+ type: buttons
+ entities:
+ - script.launch_confetti
+ - entity: script.swirl_lights
+ icon: 'mdi:track-light'
+ - entity: script.run_siren
+ icon: 'mdi:alarm-light'
```
{% configuration header-footer %}
@@ -73,4 +75,41 @@ entities:
required: false
description: Override the entity image.
type: string
+ name:
+ required: false
+ description: Label for the button
+ type: string
+{% endconfiguration %}
+
+## Graph header & footer
+
+Widget to show an entity in the sensor domain as a graph in the header or footer.
+
+