mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Merge pull request #15677 from home-assistant/rc
This commit is contained in:
Franck Nijhof
GitHub
commit
92f4f6fd69
13
CODEOWNERS
13
CODEOWNERS
@ -72,6 +72,7 @@ source/_integrations/cisco_mobility_express.markdown @fbradyirl
|
||||
source/_integrations/cisco_webex_teams.markdown @fbradyirl
|
||||
source/_integrations/cloud.markdown @home-assistant/cloud
|
||||
source/_integrations/cloudflare.markdown @ludeeus @ctalkington
|
||||
source/_integrations/color_extractor.markdown @GenericStudent
|
||||
source/_integrations/comfoconnect.markdown @michaelarnauts
|
||||
source/_integrations/config.markdown @home-assistant/core
|
||||
source/_integrations/configurator.markdown @home-assistant/core
|
||||
@ -121,6 +122,7 @@ source/_integrations/enocean.markdown @bdurrer
|
||||
source/_integrations/entur_public_transport.markdown @hfurubotten
|
||||
source/_integrations/environment_canada.markdown @michaeldavie
|
||||
source/_integrations/ephember.markdown @ttroy50
|
||||
source/_integrations/epson.markdown @pszafer
|
||||
source/_integrations/epsonworkforce.markdown @ThaStealth
|
||||
source/_integrations/eq3btsmart.markdown @rytilahti
|
||||
source/_integrations/esphome.markdown @OttoWinter
|
||||
@ -180,7 +182,6 @@ source/_integrations/homekit.markdown @bdraco
|
||||
source/_integrations/homekit_controller.markdown @Jc2k
|
||||
source/_integrations/homematic.markdown @pvizeli @danielperna84
|
||||
source/_integrations/homematicip_cloud.markdown @SukramJ
|
||||
source/_integrations/honeywell.markdown @zxdavb
|
||||
source/_integrations/http.markdown @home-assistant/core
|
||||
source/_integrations/huawei_lte.markdown @scop @fphammerle
|
||||
source/_integrations/huawei_router.markdown @abmantis
|
||||
@ -248,7 +249,7 @@ source/_integrations/met.markdown @danielhiversen @thimic
|
||||
source/_integrations/meteo_france.markdown @hacf-fr @oncleben31 @Quentame
|
||||
source/_integrations/meteoalarm.markdown @rolfberkenbosch
|
||||
source/_integrations/metoffice.markdown @MrHarcombe
|
||||
source/_integrations/miflora.markdown @danielhiversen @ChristianKuehnel @basnijholt
|
||||
source/_integrations/miflora.markdown @danielhiversen @basnijholt
|
||||
source/_integrations/mikrotik.markdown @engrbm87
|
||||
source/_integrations/mill.markdown @danielhiversen
|
||||
source/_integrations/min_max.markdown @fabaff
|
||||
@ -302,7 +303,7 @@ source/_integrations/openerz.markdown @misialq
|
||||
source/_integrations/opengarage.markdown @danielhiversen
|
||||
source/_integrations/opentherm_gw.markdown @mvn23
|
||||
source/_integrations/openuv.markdown @bachya
|
||||
source/_integrations/openweathermap.markdown @fabaff @freekode
|
||||
source/_integrations/openweathermap.markdown @fabaff @freekode @nzapponi
|
||||
source/_integrations/opnsense.markdown @mtreinish
|
||||
source/_integrations/orangepi_gpio.markdown @pascallj
|
||||
source/_integrations/oru.markdown @bvlaicu
|
||||
@ -317,7 +318,6 @@ source/_integrations/pi4ioe5v9xxxx.markdown @antonverburg
|
||||
source/_integrations/pi_hole.markdown @fabaff @johnluetke @shenxn
|
||||
source/_integrations/pilight.markdown @trekky12
|
||||
source/_integrations/plaato.markdown @JohNan
|
||||
source/_integrations/plant.markdown @ChristianKuehnel
|
||||
source/_integrations/plex.markdown @jjlawren
|
||||
source/_integrations/plugwise.markdown @CoMPaTech @bouwew
|
||||
source/_integrations/plum_lightpad.markdown @ColinHarrington @prystupa
|
||||
@ -353,6 +353,7 @@ source/_integrations/rmvtransport.markdown @cgtobi
|
||||
source/_integrations/roku.markdown @ctalkington
|
||||
source/_integrations/roomba.markdown @pschmitt @cyr-ius @shenxn
|
||||
source/_integrations/roon.markdown @pavoni
|
||||
source/_integrations/rpi_gpio_pwm.markdown @soldag
|
||||
source/_integrations/rpi_power.markdown @shenxn @swetoast
|
||||
source/_integrations/ruckus_unleashed.markdown @gabe565
|
||||
source/_integrations/safe_mode.markdown @home-assistant/core
|
||||
@ -372,7 +373,7 @@ source/_integrations/seven_segments.markdown @fabaff
|
||||
source/_integrations/seventeentrack.markdown @bachya
|
||||
source/_integrations/sharkiq.markdown @ajmarks
|
||||
source/_integrations/shell_command.markdown @home-assistant/core
|
||||
source/_integrations/shelly.markdown @balloob @bieniu
|
||||
source/_integrations/shelly.markdown @balloob @bieniu @thecode
|
||||
source/_integrations/shiftr.markdown @fabaff
|
||||
source/_integrations/shodan.markdown @fabaff
|
||||
source/_integrations/sighthound.markdown @robmarkcole
|
||||
@ -421,7 +422,7 @@ source/_integrations/switchbot.markdown @danielhiversen
|
||||
source/_integrations/switcher_kis.markdown @tomerfi
|
||||
source/_integrations/switchmate.markdown @danielhiversen
|
||||
source/_integrations/syncthru.markdown @nielstron
|
||||
source/_integrations/synology_dsm.markdown @hacf-fr @Quentame
|
||||
source/_integrations/synology_dsm.markdown @hacf-fr @Quentame @mib1185
|
||||
source/_integrations/synology_srm.markdown @aerialls
|
||||
source/_integrations/syslog.markdown @fabaff
|
||||
source/_integrations/tado.markdown @michaelarnauts @bdraco
|
||||
|
||||
@ -100,9 +100,9 @@ social:
|
||||
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 117
|
||||
current_patch_version: 6
|
||||
date_released: 2020-11-11
|
||||
current_minor_version: 118
|
||||
current_patch_version: 0
|
||||
date_released: 2020-11-18
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
@ -404,7 +404,7 @@ which will evaluate to `True` if `YOUR.ENTITY` changed more than 300 seconds ago
|
||||
|
||||
### Time trigger
|
||||
|
||||
The time trigger is configured to fire once a day at a specific time, or at a specific time on a specific date. There are two allowed formats:
|
||||
The time trigger is configured to fire once a day at a specific time, or at a specific time on a specific date. There are three allowed formats:
|
||||
|
||||
#### Time String
|
||||
|
||||
@ -456,6 +456,20 @@ automation:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
#### Sensors of datetime device class
|
||||
|
||||
The Entity ID of a [sensor](/integrations/sensor/) with the "datetime" device class.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- trigger:
|
||||
platform: time
|
||||
at: sensor.phone_next_alarm
|
||||
action:
|
||||
service: light.turn_on
|
||||
entity_id: light.bedroom
|
||||
```
|
||||
|
||||
#### Multiple Times
|
||||
|
||||
Multiple times can be provided in a list. Both formats can be intermixed.
|
||||
|
||||
@ -37,49 +37,8 @@ The integration can communicate to Node/Pro units over the local network. You wi
|
||||
|
||||
## Configuration
|
||||
|
||||
Home Assistant offers AirVisual Node/Pro Unit integration through **Configuration -> Integrations -> AirVisual**. Choose "Integration Type: AirVisual Node/Pro" and follow the instructions to get it set up.
|
||||
|
||||
The Cloud API integration can be done via the Integrations UI at **Configuration -> Integrations -> AirVisual** (Choose "Integration Type: Geographical Location") or via YAML. To enable the integration and gather data via latitude/longitude using YAML, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
airvisual:
|
||||
api_key: YOUR_AIRVISUAL_API_KEY
|
||||
```
|
||||
|
||||
Note that an API key-based entry can be mixed with one or more Node/Pro-based entries
|
||||
(examples below).
|
||||
|
||||
{% configuration %}
|
||||
api_key:
|
||||
description: Your AirVisual API key.
|
||||
required: false
|
||||
type: string
|
||||
geographies:
|
||||
description: A list of geographical locations to monitor
|
||||
required: false
|
||||
type: [list, map]
|
||||
keys:
|
||||
latitude:
|
||||
description: The latitude of the location to monitor.
|
||||
required: inclusive
|
||||
type: float
|
||||
longitude:
|
||||
description: The longitude of the location to monitor.
|
||||
required: inclusive
|
||||
type: float
|
||||
city:
|
||||
description: The city to monitor.
|
||||
required: inclusive
|
||||
type: string
|
||||
state:
|
||||
description: The state the city belongs to.
|
||||
required: inclusive
|
||||
type: string
|
||||
country:
|
||||
description: The country the state belongs to.
|
||||
required: inclusive
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
This integration can be configured via the Home Assistant UI by navigating to
|
||||
**Configuration** -> **Integrations**.
|
||||
|
||||
## Example Configurations
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ The Broadlink integration allows you to control and monitor Broadlink universal
|
||||
|
||||
- Power Strips: `MP1-1K3S2U` and `MP1-1K4S`
|
||||
- Sensors: `e-Sensor`
|
||||
- Smart Plugs: `SP mini`, `SP mini+`, `SP mini 3`, `SP1`, `SP2`, `SP2-CL`, `SP2-UK/BR/IN`, `SP3`, `SP3-EU`, `SP3S-EU` and `SP3S-US`
|
||||
- Smart Plugs: `SP mini`, `SP mini+`, `SP mini 3`, `SP1`, `SP2`, `SP2-CL`, `SP2-UK/BR/IN`, `SP3`, `SP3-EU`, `SP3S-EU`, `SP3S-US`, `SP4L-EU` and `SP4M-US`
|
||||
- Universal Remotes: `RM mini`, `RM mini 3`, `RM pro`, `RM pro+`, `RM plus`, `RM4 mini`, `RM4 pro` and `RM4C mini`
|
||||
- Wi-Fi Controlled Switches: `SC1`
|
||||
|
||||
|
||||
94
source/_integrations/color_extractor.markdown
Normal file
94
source/_integrations/color_extractor.markdown
Normal file
@ -0,0 +1,94 @@
|
||||
---
|
||||
title: ColorExtractor
|
||||
description: Instructions how to integrate the Color Extractor into Home Assistant.
|
||||
ha_release: 0.118
|
||||
ha_category:
|
||||
- Image Processing
|
||||
ha_domain: color_extractor
|
||||
ha_codeowners:
|
||||
- '@GenericStudent'
|
||||
---
|
||||
|
||||
The `color_extractor` integration will extract the predominant color from a given image and apply that color to a target light.
|
||||
Useful as part of an automation.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable the `color_extractor` service in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
color_extractor:
|
||||
```
|
||||
|
||||
## Services
|
||||
|
||||
Because `color_extractor.turn_on` will then call `light.turn_on`, you can pass any valid [`light.turn_on`](/integrations/light#service-lightturn_on) parameters (`rgb_color` will be set for you though) as those will be passed along.
|
||||
|
||||
Passing the key `color_extract_url` to the service call will download the linked image and extract the predominant color from it. Passing the key `color_extract_path` to the service call will process the image file from local storage instead. `color_extract_url` and `color_extract_path` are exclusive and cannot be used together.
|
||||
|
||||
|Key | Example | Description |
|
||||
|---------------------|---------------------------------------|-------------------------------------------------------------------------------|
|
||||
|`color_extract_url` | `https://example.com/images/logo.png` | The full URL (including schema, `http://`, `https://`) of the image to process|
|
||||
|`color_extract_path` | `/tmp/album.png` | The full path to the image file on local storage we'll process |
|
||||
|`entity_id` | `light.shelf_leds` | The RGB capable light we'll set the color of |
|
||||
|
||||
<div class="note">
|
||||
|
||||
Please ensure any [external URLs](/docs/configuration/basic/#allowlist_external_urls) or [external files](/docs/configuration/basic/#allowlist_external_dirs) are authorized for use, you will receive error messages if this component is not allowed access to these external resources.
|
||||
|
||||
</div>
|
||||
|
||||
### URL Service Call
|
||||
|
||||
Add the parameter key `color_extract_url` to the service call.
|
||||
|
||||
This service allows you to pass in the URL of an image, have it downloaded, get the predominant color from it, and then set a light's RGB value to it.
|
||||
|
||||
### File Service Call
|
||||
|
||||
Add the parameter key `color_extract_path` to the service call.
|
||||
|
||||
This service is very similar to the URL service above, except it processes a file from the local file storage.
|
||||
|
||||
## Example Automations
|
||||
|
||||
Example usage in an automation, taking the album art present on a Chromecast and supplying it to `light.shelf_leds` whenever it changes:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
#automation.yaml
|
||||
- alias: Chromecast to Shelf Lights
|
||||
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id: media_player.chromecast
|
||||
|
||||
action:
|
||||
- service: color_extractor.turn_on
|
||||
data_template:
|
||||
color_extract_url: '{{ states.media_player.chromecast.attributes.entity_picture }}'
|
||||
entity_id: light.shelf_leds
|
||||
```
|
||||
|
||||
With a nicer transition period of 5 seconds and setting brightness to 100% each time (part of the [`light.turn_on`](/integrations/light#service-lightturn_on) service parameters):
|
||||
|
||||
```yaml
|
||||
#automation.yaml
|
||||
- alias: Nicer Chromecast to Shelf Lights
|
||||
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id: media_player.chromecast
|
||||
|
||||
action:
|
||||
- service: color_extractor.turn_on
|
||||
data_template:
|
||||
color_extract_url: '{{ states.media_player.chromecast.attributes.entity_picture }}'
|
||||
entity_id: light.shelf_leds
|
||||
brightness_pct: 100
|
||||
transition: 5
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
@ -137,6 +137,18 @@ Docker users have to allow Docker access to the device by adding `--device /dev/
|
||||
$ docker run --device /dev/ttyUSB0:/dev/ttyUSB0 -d --name="home-assistant" -v /home/USERNAME/hass:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/home-assistant
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
To configure options for DSMR integration go to **Configuration** >> **Integrations** and press **Options** on the DSMR card.
|
||||
|
||||
#### Time between updates
|
||||
|
||||
Typically the smart meter sends new data every 5-10 seconds. This value defines the minimum time between entity updates in seconds. Setting this value to 0 will update entities each time data is received from the smart meter.
|
||||
|
||||
<div class='note warning'>
|
||||
Reducing the default time between updates will increase the amount of events generated and can potentially flood the system with events.
|
||||
</div>
|
||||
|
||||
### Technical overview
|
||||
|
||||
DSMR is a standard to which Dutch smartmeters must comply. It specifies that the smartmeter must send out a 'telegram' every 10 seconds (every second for DSMR 5.0 devices) over a serial port.
|
||||
|
||||
@ -134,6 +134,8 @@ The `dyson` fan platform allows you to control your Dyson Purifier fans.
|
||||
- Pure Cool link (desk and tower)
|
||||
- Pure Hot+cool link (see climate part) for thermal control
|
||||
- Pure Cool 2018 (DP04 and TP04)
|
||||
- Pure Cool Cryptomic (TP06)
|
||||
- Pure Humidify+Cool (PH01)
|
||||
|
||||
### Attributes
|
||||
|
||||
@ -145,31 +147,23 @@ There are several attributes which can be used for automations and templates.
|
||||
| `auto_mode` | A boolean that indicates if the auto mode of the fan device is on.|
|
||||
| `angle_low` | Int (between 5 and 355) that indicates the low angle of oscillation (only for DP04 and TP04).|
|
||||
| `angle_high` | Int (between 5 and 355) that indicates the high angle of oscillation (only for DP04 and TP04).|
|
||||
| `flow_direction_front` | Boolean that indicates if the frontal flow direction is enabled (only for DP04 and TP04).|
|
||||
| `flow_direction_front` | Boolean that indicates if the frontal flow direction is enabled (only for DP04, TP04 and PH01).|
|
||||
| `timer` | Attribute that indicates the status of the auto power off timer, can be either 'OFF' or an integer representing the time remaining until shutdown in minutes (only for DP04 and TP04).|
|
||||
| `hepa filter` | State of the fan's HEPA filter in % (only for DP04 and TP04).|
|
||||
| `carbon filter` | State of the fan's carbon filter in % (only for DP04 and TP04).|
|
||||
| `hepa filter` | Remaining life of the fan's HEPA filter in % (only for DP04 and TP04 — Combi filter for PH01).|
|
||||
| `carbon filter` | Remaining life of the fan's carbon filter in % (only for DP04 and TP04).|
|
||||
|
||||
## Sensor
|
||||
|
||||
The `dyson` sensor platform provides temperature and humidity sensors.
|
||||
|
||||
For compatible models (i.e. DP04, TP04, PH01), remaining life percentage for the filters (HEPA and Carbon, or Combi) is provided as sensors.
|
||||
|
||||
## Air Quality
|
||||
|
||||
The `dyson` air quality platform provides the following levels:
|
||||
The `dyson` air quality platform provides the following levels (only for DP04, TP04, PH01):
|
||||
|
||||
- Particulate matter 2.5 (<= 2.5 μm) level.
|
||||
- Particulate matter 10 (<= 10 μm) level.
|
||||
- Air Quality Index (AQI).
|
||||
- NO2 (nitrogen dioxide) level.
|
||||
- VOC (Volatile organic compounds) level.
|
||||
|
||||
Note: currently only the 2018 dyson fans are supported(TP04 and DP04).
|
||||
|
||||
### Supported fan devices
|
||||
|
||||
- Pure Cool link (desk and tower)
|
||||
- Pure Hot+cool link (see climate part) for thermal control
|
||||
- Pure Hot+cool 2019 model (HP04)
|
||||
- Pure Cool 2018 Models (TP04 and DP04)
|
||||
- Pure Cool Cryptomic (TP06)
|
||||
|
||||
@ -6,13 +6,18 @@ ha_category:
|
||||
ha_release: 0.72
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: epson
|
||||
ha_codeowners:
|
||||
- '@pszafer'
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
The `epson` platform allows you to control a Epson projector from Home
|
||||
Assistant.
|
||||
The `epson` platform allows you to control a Epson projector from Home Assistant.
|
||||
|
||||
To add Epson to your installation,
|
||||
add the following to your `configuration.yaml` file:
|
||||
To add Epson to your installation go to Integration page and add Epson Projector or configure via `configuration.yaml`.
|
||||
|
||||
### Configuration
|
||||
|
||||
Add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -36,14 +41,10 @@ name:
|
||||
required: false
|
||||
type: string
|
||||
default: 'EPSON Projector'
|
||||
ssl:
|
||||
description: "Enable SSL. **Feature not tested.**"
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
Supported features of Epson projector:
|
||||
### Supported features
|
||||
|
||||
- turn on/off
|
||||
- set input
|
||||
- set/get color mode
|
||||
@ -51,10 +52,12 @@ Supported features of Epson projector:
|
||||
- mute/unmute audio
|
||||
- send next/previous track
|
||||
|
||||
Supported devices:
|
||||
### Supported devices
|
||||
|
||||
- Epson projectors supporting ESC/VP21 protocol.
|
||||
|
||||
Tested devices:
|
||||
### Tested devices
|
||||
|
||||
- Epson EH-TW5350
|
||||
- Epson EH-TW7000
|
||||
|
||||
|
||||
@ -18,31 +18,8 @@ Center for Disease Control (CDC).
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable the platform, add the following lines to your `configuration.yaml`
|
||||
file:
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: flunearyou
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
description: The sensor categories to display.
|
||||
required: false
|
||||
type: list
|
||||
default: ['cdc_report', 'user_report']
|
||||
latitude:
|
||||
description: The latitude of the location to monitor.
|
||||
required: false
|
||||
type: float
|
||||
default: The latitude defined under the `homeassistant` key in `configuration.yaml`.
|
||||
longitude:
|
||||
description: The longitude of the location to monitor.
|
||||
required: false
|
||||
type: float
|
||||
default: The longitude defined under the `homeassistant` key in `configuration.yaml`.
|
||||
{% endconfiguration %}
|
||||
This integration can be configured via the Home Assistant UI by navigating to
|
||||
**Configuration** -> **Integrations**.
|
||||
|
||||
## Sensor Types
|
||||
|
||||
|
||||
@ -25,10 +25,12 @@ host:
|
||||
description: The IP address of your router, e.g., `192.168.1.1`. It is optional since every FRITZ!Box is also reachable by using the IP address 169.254.1.1.
|
||||
required: false
|
||||
type: string
|
||||
default: 169.254.1.1
|
||||
username:
|
||||
description: The username of an user with administrative privileges, usually `admin`.
|
||||
required: false
|
||||
type: string
|
||||
default: admin
|
||||
password:
|
||||
description: The password for your given admin account.
|
||||
required: false
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: AVM FRITZ!Box
|
||||
description: Instructions on how to integrate the AVM Fritzbox Smart Home components.
|
||||
title: AVM FRITZ!SmartHome
|
||||
description: Instructions on how to integrate AVM Fritz!DECT components into Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Climate
|
||||
@ -12,13 +12,13 @@ ha_domain: fritzbox
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
The [AVM](https://en.avm.de) FRITZ!Box integration for Home Assistant allows you to integrate the switch and climate devices.
|
||||
The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [FRITZ!DECT](https://en.avm.de/products/fritzdect/) devices like switches, sensors and thermostats.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Binary Sensor
|
||||
- Climate
|
||||
- [Sensor](#sensor)
|
||||
- Sensor
|
||||
- Switch
|
||||
|
||||
#### Tested Devices
|
||||
@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
## Configuration
|
||||
|
||||
To add the AVM FRITZ!Box integration to your installation, go to **Configuration** -> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AVM FRITZ!Box**.
|
||||
To add the AVM FRITZ!SmartHome integration to your installation, go to **Configuration** -> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AVM FRITZ! SmartHome**.
|
||||
|
||||
If you have enabled SSDP discovery, it’s likely that you just have to confirm the detected device with username and password.
|
||||
|
||||
@ -48,18 +48,19 @@ fritzbox:
|
||||
- password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
|
||||
{% configuration %}
|
||||
devices:
|
||||
description: A list of FRITZ!Box devices.
|
||||
description: A list of FRITZ! devices.
|
||||
type: map
|
||||
keys:
|
||||
host:
|
||||
description: The hostname or IP address of the FRITZ!Box.
|
||||
description: The hostname or IP address of the FRITZ!Box. (e.g. fritz.box or 192.168.178.1)
|
||||
required: false
|
||||
type: string
|
||||
default: fritz.box
|
||||
username:
|
||||
description: The username for Smart Home access.
|
||||
description: The username for Smart Home access. **(User needs "Smart Home" persmission!)**
|
||||
required: false
|
||||
type: string
|
||||
default: admin
|
||||
@ -69,9 +70,10 @@ devices:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Switch & Thermostat
|
||||
|
||||
To get AVM FRITZ!Box switch and thermostat follow the instructions above.
|
||||
## Switches & Thermostats
|
||||
|
||||
To get AVM FRITZ!DECT switches (e.g. FRITZ!DECT 400/440) or thermostats (e.g. FRITZ!DECT 301) follow the [configuration instructions](#configuration) above.
|
||||
|
||||
### Attributes
|
||||
|
||||
@ -91,9 +93,9 @@ There are several attributes that can be useful for automations and templates.
|
||||
| `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function).
|
||||
| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function).
|
||||
|
||||
## Sensor
|
||||
## Sensors
|
||||
|
||||
To get AVM FRITZ!Box temperature sensor (e.g., FRITZ!DECT Repeater 100) follow the instructions for the [FRITZ!Box integration](#setup).
|
||||
To get AVM FRITZ!DECT sensors (e.g., FRITZ!DECT Repeater 100) follow the [configuration instructions](#configuration) above.
|
||||
|
||||
### Attributes
|
||||
|
||||
|
||||
@ -44,6 +44,7 @@ port:
|
||||
username:
|
||||
description: FRITZ!Box user's user name. This is required to use the phone book lookup feature. The user needs to have the "voice message, fax message, Fritz!App Fon and call list" permission.
|
||||
required: false
|
||||
default: admin
|
||||
type: string
|
||||
password:
|
||||
description: FRITZ!Box user's user password. This is required to use the phone book lookup feature.
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
---
|
||||
title: "Generic IP Camera"
|
||||
description: "Instructions on how to integrate IP cameras within Home Assistant."
|
||||
title: Generic
|
||||
description: Instructions on how to integrate IP cameras within Home Assistant.
|
||||
ha_category:
|
||||
- Camera
|
||||
logo: home-assistant.png
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: Configurable
|
||||
ha_domain: camera
|
||||
ha_domain: generic
|
||||
---
|
||||
|
||||
The `generic` camera platform allows you to integrate any IP camera or other URL into Home Assistant. Templates can be used to generate the URLs on the fly.
|
||||
|
||||
@ -156,6 +156,10 @@ homekit:
|
||||
description: The `entity_id` of a `binary_sensor` entity to use as the motion sensor of the camera accessory to enable motion notifications. HomeKit will cache an accessory's feature set on the first run so a device must be [reset](#resetting-accessories) for any change to take effect.
|
||||
required: false
|
||||
type: string
|
||||
linked_obstruction_sensor:
|
||||
description: The `entity_id` of a `binary_sensor` entity to use as the obstruction sensor of the garage door (cover) accessory to enable obstruction state tracking. HomeKit will cache an accessory's feature set on the first run so a device must be [reset](#resetting-accessories) for any change to take effect.
|
||||
required: false
|
||||
type: string
|
||||
low_battery_threshold:
|
||||
description: Minimum battery level before the accessory starts reporting a low battery.
|
||||
required: false
|
||||
|
||||
@ -109,6 +109,7 @@ Within this delay the device registration should be completed in the App, otherw
|
||||
* Alarm Siren (*HmIP-ASIR, -B1*) (battery only)
|
||||
* Remote Control for brand switches – 2-button (*HmIP-BRC2*) (battery only)
|
||||
* Pluggable Power Supply Monitoring (*HmIP-PMFS*)
|
||||
* Wired Inbound module – 32x channels (*HMIPW-DRI32*)
|
||||
|
||||
* homematicip_cloud.climate
|
||||
* Climate group (*HmIP-HeatingGroup*)
|
||||
@ -168,6 +169,7 @@ Within this delay the device registration should be completed in the App, otherw
|
||||
* Switch Circuit Board - 2x channels (*HmIP-PCBS2*)
|
||||
* Printed Circuit Board Switch Battery (*HmIP-PCBS-BAT*)
|
||||
* Switch Actuator for heating systems – 2 channels (*HmIP-WHS2*)
|
||||
* Wired Switch Actuator – 8x channels (*HMIPW-DRS8*)
|
||||
|
||||
* homematicip_cloud.weather
|
||||
* Weather Sensor – basic (*HmIP-SWO-B*)
|
||||
|
||||
@ -5,8 +5,6 @@ ha_category:
|
||||
- Climate
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_codeowners:
|
||||
- '@zxdavb'
|
||||
ha_domain: honeywell
|
||||
---
|
||||
|
||||
|
||||
@ -1,52 +0,0 @@
|
||||
---
|
||||
title: Antifurto365 iAlarm
|
||||
description: Instructions on how to integrate iAlarms alarms into Home Assistant.
|
||||
logo: antifurto365-ialarm.png
|
||||
ha_category:
|
||||
- Alarm
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: '0.60'
|
||||
ha_domain: ialarm
|
||||
---
|
||||
|
||||
The `ialarm` platform provides connectivity with the [Antifurto365](https://www.antifurtocasa365.it/) iAlarm alarm systems.
|
||||
|
||||
This platform supports the following services: `alarm_arm_away`, `alarm_arm_home` and `alarm_disarm`.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable this, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
alarm_control_panel:
|
||||
- platform: ialarm
|
||||
host: ALARM_SYSTEM_IP
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address of the iAlarm device on your home network.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: Username used to sign into the iAlarm web client (should be admin by default).
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Password used to sign into the iAlarm web client. If it has a leading zero you need to put the password within quotes.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: Name of device in Home Assistant.
|
||||
required: false
|
||||
type: string
|
||||
code:
|
||||
description: Specifies a code to enable or disable the alarm in the frontend.
|
||||
required: false
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
This platform has also been confirmed to work with the alarm system brands Meian and Emooluxr.
|
||||
@ -8,7 +8,7 @@ ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: image
|
||||
ha_quality_scale: internal
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The Image integration allows Home Assistant to handle image assets in Home Assistant, for example,
|
||||
|
||||
@ -5,7 +5,7 @@ ha_category:
|
||||
- Image Processing
|
||||
ha_release: 0.36
|
||||
ha_domain: image_processing
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Image processing enables Home Assistant to process images from [cameras](/integrations/#camera). Only camera entities are supported as sources.
|
||||
|
||||
@ -69,7 +69,6 @@ havdalah_minutes_after_sunset:
|
||||
*Note: Due to the variety of rabbinic opinions on how to calculate the different times, we do not take any responsibility on your religious reliance upon these calculations.*
|
||||
|
||||
Time sensor states are represented as ISO8601 formatted *UTC time*.
|
||||
For easier use in automations, all time sensors have a `timestamp` attribute, which returns the UNIX timestamp.
|
||||
|
||||
- `first_light`: First light of dawn (Alot Hashachar - עלות השחר)
|
||||
- `talit`: Earliest time for tallit and tefillin (Misheyakir - משיכיר)
|
||||
|
||||
@ -37,6 +37,9 @@ When a state topic is not available, the light will work in optimistic mode. In
|
||||
|
||||
Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation.
|
||||
|
||||
Home Assistant internally assumes that a light either has a color or a color temperature.
|
||||
The state of MQTT lights with default schema and support for both color and color temperature will include a color if `white_value` is 0 or None and a `color_temp` is white_value > 0.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
light:
|
||||
@ -94,7 +97,7 @@ color_temp_command_topic:
|
||||
required: false
|
||||
type: string
|
||||
color_temp_state_topic:
|
||||
description: The MQTT topic subscribed to receive color temperature state updates.
|
||||
description: "The MQTT topic subscribed to receive color temperature state updates. If the light also supports setting colors, also define a `white_value_state_topic`. "
|
||||
required: false
|
||||
type: string
|
||||
color_temp_value_template:
|
||||
|
||||
@ -7,7 +7,6 @@ ha_release: 0.29
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
- '@danielhiversen'
|
||||
- '@ChristianKuehnel'
|
||||
- '@basnijholt'
|
||||
ha_domain: miflora
|
||||
---
|
||||
|
||||
@ -16,23 +16,36 @@ ha_codeowners:
|
||||
ha_domain: nest
|
||||
---
|
||||
|
||||
The `nest` integration allows you to access all supported [Google Nest](https://store.google.com/us/category/connected_home?) devices. There are two APIs:
|
||||
|
||||
1. New [Device Access](https://developers.google.com/nest/device-access) program and [Smart Device Management](https://developers.google.com/nest/device-access/api) (SDM) API.
|
||||
1. Legacy [Works With Nest](https://developers.nest.com/) API. This API does not accept new users, but existing users can keep using it.
|
||||
|
||||
<div class='note warning'>
|
||||
The two APIs support different features and devices. The SDM API integration is currently under development and does not yet support everything in the API either.
|
||||
</div>
|
||||
The `nest` integration allows you to integrate your [Google Nest](https://store.google.com/us/category/connected_home?) devices in Home Assistant. This integration uses the [Smart Device Management](https://developers.google.com/nest/device-access/api) API and Google's Cloud Pubsub to efficiently listen for changes in device state or other events.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor-legacy-api-only) (Legacy API Only)
|
||||
- [Camera](#camera-legacy-api-only) (Legacy API Only)
|
||||
- [Climate](#climate-legacy-api-only) (Legacy API Only)
|
||||
- [Sensor](#sensor) (Both APIs)
|
||||
- [Camera](#camera)
|
||||
- [Climate](#climate)
|
||||
- [Sensor](#sensor)
|
||||
|
||||
## Device Access: Developer Account Setup
|
||||
<div class='note'>
|
||||
Note that this integration continues to support the Legacy Works With Nest API which is not accepting new users. The documentation for this API is at the bottom of this page so existing users can keep using it.
|
||||
</div>
|
||||
|
||||
## Overview: Supported Devices
|
||||
|
||||
Home Assistant is integrated with the following devices through the SDM API:
|
||||
|
||||
- Thermostat Devices
|
||||
- Every thermostat is exposed as a `climate` entity
|
||||
- Temperature and Humidity sensors each have a `sensor` entity
|
||||
- Example devices: All Google Nest Thermostat models
|
||||
- Display, Camera, and Doorbell Devices
|
||||
- The camera live stream is available as a `camera` entity
|
||||
- Example devices: All Google Nest Cam models, Google Nest Hello Video Doorbell, Google Nest Hub Max
|
||||
|
||||
You are in control of the information and capabilities exposed to Home Assistant. You can authorize a single device, multiple devices, or different levels of functionality such as motion events, live streams, for any particular device. The integration is flexible enough to adapt based on what you allow.
|
||||
|
||||
Others devices like Smoke and CO Alarms or Security systems are not currently
|
||||
supported by the SDM API.
|
||||
|
||||
## Account Setup
|
||||
|
||||
You will need to follow the instructions in [Device Access Registration](https://developers.google.com/nest/device-access/registration), which includes the following steps in the
|
||||
Quick Start Guide:
|
||||
@ -54,53 +67,19 @@ Follow all of the instructions in [Device Access: Quick Start Guide](https://dev
|
||||
|
||||
It may be easiest to create a [Pub/Sub subscription](https://console.cloud.google.com/cloudpubsub/subscription/list) from the Google Cloud console. Make sure to use the *topic name* from the device access console and a unique subscription ID. Note the message retention is how long messages will queue while offline, so keep that short (e.g., under an hour) to avoid a potentially large backlog of updates.
|
||||
|
||||
## Works With Nest: Developer Account Setup (Legacy)
|
||||
|
||||
<div class='note warning'>
|
||||
New users cannot set up a "Works With Nest Developer" account and instead should use the Device Access program. The instructions below only apply if you already have an account.
|
||||
</div>
|
||||
|
||||
1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already.
|
||||
2. Fill in account details:
|
||||
* The "Company Information" can be anything. We recommend using your name.
|
||||
3. Submit changes
|
||||
4. Click "[Products](https://developers.nest.com/products)" at the top of page.
|
||||
5. Click "[Create New Product](https://developers.nest.com/products/new)"
|
||||
6. Fill in details:
|
||||
* Product name must be unique. We recommend [email] - Home Assistant.
|
||||
* The description, users, URLs can all be anything you want.
|
||||
* Leave the "Redirect URI" Field blank
|
||||
7. For permissions, check every box and if it's an option, select the read/write option. Note: there are important permissions under the "Other Permissions" category. If you are only adding a thermostat, do not just select the permissions under "Thermostat". You still need to check the boxes under "Other Permissions" to give you access to features like away mode, ETA, structure read/write, and postal code.
|
||||
* The description requires a specific format to be accepted.
|
||||
* Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important.
|
||||
8. Click "Create Product"
|
||||
9. Once the new product page opens the "Product ID" and "Product Secret" are located on the right side. These will be used as `client_id` and `client_secret` below.
|
||||
10. Add the Nest integration to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to `Nest`. Click the link in the configurator pop up to log into your Nest account and complete the OAuth. Copy the resulting PIN code into the pop up.
|
||||
|
||||
Connecting to the Nest Developer API requires outbound port 9553 on your firewall. The configuration will fail if this is not accessible.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
nest:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CLIENT_SECRET
|
||||
# Fields required by Device Access (SDM) API. Otherwise, use legacy API.
|
||||
project_id: PROJECT_ID
|
||||
project_id: PROJECT_ID # ("Project ID" in the Device Access Console)
|
||||
subscriber_id: SUBSCRIBER_ID # ("Subscription ID" in Google Cloud Console)
|
||||
```
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry to show only devices at your vacation and primary homes
|
||||
nest:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CLIENT_SECRET
|
||||
structure:
|
||||
- Vacation
|
||||
- Primary
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
client_id:
|
||||
description: Your Device Access or Nest developer client ID.
|
||||
@ -118,28 +97,123 @@ subscriber_id:
|
||||
description: Your Pub/sub Subscription ID used to receive events. This is required to use the SDM API.
|
||||
type: string
|
||||
required: false
|
||||
{% endconfiguration %}
|
||||
|
||||
## Device Setup
|
||||
|
||||
Once your developer account is set up and you have a valid `nest` entry in `configuration.yaml` , you need to connect devices with the following steps:
|
||||
|
||||
1. From the Home Assistant front-end, navigate to **Configuration** then **Integrations**. Under **Set up a new integration** locate 'Nest'.
|
||||
1. You should get redirected to Google to choose an account. This should be the same developer account you configured above.
|
||||
1. The *Google Nest permissions* screen will allow you to choose which devices to configure. You can leave out any device that you do not wish to use with Home Assistant.
|
||||
1. You will get redirected back to another account selection page.
|
||||
1. Confirm you want to allow persistent access to Home Assistant.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- See [No URL Available](/more-info/no-url-available) for guidance on setup issues related to URLs.
|
||||
|
||||
- For trouble with the SDM API OAuth authorization flow with Google, see [Troubleshooting](https://developers.google.com/nest/device-access/authorize#troubleshooting) which includes guidance for errors like `redirect_uri_mismatch` where Google needs to know about your external URL
|
||||
|
||||
## Camera
|
||||
|
||||
All Google Nest Cam models, Google Nest Hello Video Doorbell, Google Nest Hub Max expose a [CameraLiveStream](https://developers.google.com/nest/device-access/traits/device/camera-live-stream) via the SDM API, which returns a RTSP live stream which can be viewed from Home Assistant.
|
||||
|
||||
Given a camera named `Front Yard` then the camera is created with a name such as `camera.front_yard`.
|
||||
|
||||
## Climate
|
||||
|
||||
All Google Nest Thermostat models are exposed as a `climate` entity that use the [Thermostat Traits](https://developers.google.com/nest/device-access/traits/device/thermostat-hvac) in the SDM API. State changes to the thermostat are reported to Home Assistant through the Cloud Pubsub subscriber.
|
||||
|
||||
Given a thermostat named `Upstairs` then the climate entity is created with a name such as `climate.upstairs`
|
||||
|
||||
## Sensor
|
||||
|
||||
All Google Nest Thermostat models have traits exposed from the SDM API. The initial values of the sensors are fetched on startup, then updated regularly using the Cloud Pubsub subscriber. The following traits are supported with sensors:
|
||||
|
||||
- [Temperature](https://developers.google.com/nest/device-access/traits/device/temperature)
|
||||
- [Humidity](https://developers.google.com/nest/device-access/traits/device/humidity)
|
||||
|
||||
Given a thermostat named `Upstairs` then sensors are created with names such as `sensor.upstairs_temperature` or `sensor.upstairs_humidity`.
|
||||
|
||||
# Legacy Works With Nest API
|
||||
|
||||
This section contains instructions for the Legacy [Works with Nest](https://developers.nest.com/) API.
|
||||
|
||||
<div class='note warning'>
|
||||
New users are not currently able to set up a Works With Nest Developer account. The documentation is preserved here for existing users of the API.
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>Click here for documentation for the Legacy Works with Nest API</summary>
|
||||
|
||||
The Nest integration is the main integration to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`.
|
||||
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Camera](#camera)
|
||||
- [Climate](#climate)
|
||||
- [Sensor](#sensor)
|
||||
|
||||
### Setting up developer account
|
||||
|
||||
|
||||
1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already.
|
||||
2. Fill in account details:
|
||||
* The "Company Information" can be anything. We recommend using your name.
|
||||
3. Submit changes
|
||||
4. Click "[Products](https://developers.nest.com/products)" at top of page.
|
||||
5. Click "[Create New Product](https://developers.nest.com/products/new)"
|
||||
6. Fill in details:
|
||||
* Product name must be unique. We recommend [email] - Home Assistant.
|
||||
* The description, users, URLs can all be anything you want.
|
||||
* Leave the "Redirect URI" Field blank
|
||||
7. For permissions check every box and if it's an option select the read/write option. Note: there are important permissions under the "Other Permissions" category. If you are only adding a thermostat, do not just select the permissions under "Thermostat". You still need to check the boxes under "Other Permissions" in order to give you access to features like away mode, ETA, structure read/write, and postal code.
|
||||
* The description requires a specific format to be accepted.
|
||||
* Use "[Home Assistant] [Edit] [For Home Automation]" as the description as it is not super important.
|
||||
8. Click "Create Product"
|
||||
9. Once the new product page opens the "Product ID" and "Product Secret" are located on the right side. These will be used as `client_id` and `client_secret` below.
|
||||
10. Add the Nest integration to your `configuration.yaml` and restart Home Assistant. Then, go to `Configuration > Integrations` and select `CONFIGURE` next to `Nest`. Click the link in the configurator pop up to log into your Nest account and complete the OAuth. Copy the resulting PIN code into the pop up.
|
||||
|
||||
Connecting to the Nest Developer API requires outbound port 9553 on your firewall. The configuration will fail if this is not accessible.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
nest:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CLIENT_SECRET
|
||||
```
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry to show only devices at your vacation and primary homes
|
||||
nest:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CLIENT_SECRET
|
||||
structure:
|
||||
- Vacation
|
||||
- Primary
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
client_id:
|
||||
description: Your Nest developer client ID.
|
||||
required: true
|
||||
type: string
|
||||
client_secret:
|
||||
description: Your Nest developer client secret.
|
||||
required: true
|
||||
type: string
|
||||
structure:
|
||||
description: The structure or structures you would like to include devices from. If not specified, this will include all structures in your Nest account. Not currently supported by the SDM API.
|
||||
description: The structure or structures you would like to include devices from. If not specified, this will include all structures in your Nest account.
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
## Device Setup (SDM API)
|
||||
|
||||
Once your developer account is set up and `nest` has been configured, you need to connect devices with the following steps:
|
||||
|
||||
1. From the Home Assistant front-end, navigate to **Configuration** then **Integrations**. Under **Set up a new integration** locate 'Nest'.
|
||||
1. You should get redirected to Google to choose an account. This should be the same developer account you configured above.
|
||||
1. The *Google Nest permissions* screen will allow you to choose which devices to configure.
|
||||
1. You will get redirected back to another account selection page.
|
||||
1. Confirm you want to allow persistent access to Home Assistant.
|
||||
|
||||
## Services (Legacy API Only)
|
||||
|
||||
They Legacy API supports additional services for home/away/eta that are not
|
||||
supported by the SDM API.
|
||||
|
||||
### Service `set_away_mode` (Legacy API Only)
|
||||
### Service `set_away_mode`
|
||||
|
||||
You can use the service `nest/set_away_mode` to set the structure(s) to "Home" or "Away".
|
||||
|
||||
@ -172,7 +246,7 @@ script:
|
||||
- Apartment
|
||||
```
|
||||
|
||||
### Service `set_eta` (Legacy API Only)
|
||||
### Service `set_eta`
|
||||
|
||||
You can use the service `nest/set_eta` to set or update the estimated time of arrival window. Calling this service will automatically set the structure(s) to "Away". Structures must have an associated Nest thermostat in order to use ETA function.
|
||||
|
||||
@ -210,7 +284,7 @@ script:
|
||||
- Apartment
|
||||
```
|
||||
|
||||
### Service `cancel_eta` (Legacy API Only)
|
||||
### Service `cancel_eta`
|
||||
|
||||
You can use the service `nest/cancel_eta` to cancel an existing estimated time of arrival window. Structures must have an associated Nest thermostat in order to use ETA function.
|
||||
|
||||
@ -243,7 +317,7 @@ script:
|
||||
- Apartment
|
||||
```
|
||||
|
||||
## Troubleshooting (Legacy API Only)
|
||||
### Troubleshooting
|
||||
|
||||
- For trouble with the SDM API OAuth authorization flow with Google, see [Troubleshooting](https://developers.google.com/nest/device-access/authorize#troubleshooting) which includes guidance for errors like `redirect_uri_mismatch` where Google needs to know about your external URL.
|
||||
|
||||
@ -257,13 +331,13 @@ You must have the [Nest component](/integrations/nest/) configured to use the pl
|
||||
|
||||
</div>
|
||||
|
||||
### Binary Sensor (Legacy API Only)
|
||||
### Binary Sensor
|
||||
|
||||
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
You must have the [Nest component](/integrations/nest/) configured to use these sensors. The binary sensors will be set up if the `nest` integration is configured and the required configuration for the `nest binary sensor` is set.
|
||||
You must have the [Nest component](/integrations/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` integration is configured and the required configuration for the `nest binary sensor` is set.
|
||||
|
||||
</div>
|
||||
|
||||
@ -280,7 +354,7 @@ nest:
|
||||
- 'target'
|
||||
```
|
||||
|
||||
By default, all binary sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all binary sensors for the [Nest component](/integrations/nest/).
|
||||
By default all binary sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all binary sensors for the [Nest component](/integrations/nest/).
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
@ -307,19 +381,19 @@ The following conditions are available by device:
|
||||
- person\_detected
|
||||
- sound\_detected
|
||||
|
||||
### Camera (Legacy API Only)
|
||||
### Camera
|
||||
|
||||
The `nest` platform allows you to watch still frames from a video stream (not live stream) of your [Nest](https://nest.com/camera/meet-nest-cam/) camera in Home Assistant.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
The `nest` camera will automatically be set up when you do.
|
||||
The Legacy API integration allows you to watch still frames from a video stream (not live stream). The Legacy API also supports the `camera.turn_on` and `camera.turn_off` services.
|
||||
|
||||
</div>
|
||||
|
||||
Nest Camera supports the `camera.turn_on` and `camera.turn_off` services since the 0.75 release.
|
||||
|
||||
### Climate (Legacy API Only)
|
||||
### Climate
|
||||
|
||||
The `nest` climate platform lets you control a thermostat from [Nest](https://nest.com).
|
||||
|
||||
@ -333,13 +407,12 @@ Please note due to limitations with the European Nest Thermostat E, integration
|
||||
|
||||
### Sensor
|
||||
|
||||
The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices. The SDM API supports these sensor traits:
|
||||
|
||||
- [Temperature](https://developers.google.com/nest/device-access/traits/device/temperature)
|
||||
- [Humidity](https://developers.google.com/nest/device-access/traits/device/humidity)
|
||||
The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.
|
||||
|
||||
<div class='note'>
|
||||
The SDM API will monitor all devices automatically once configured. The Legacy API has additional configuration for `nest sensor`.
|
||||
|
||||
The sensors will be setup if the `nest` integration is configured and the required configuration for the `nest sensor` is set.
|
||||
|
||||
</div>
|
||||
|
||||
#### Configuration
|
||||
@ -355,7 +428,7 @@ nest:
|
||||
- 'target'
|
||||
```
|
||||
|
||||
By default all, sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all sensors for the [Nest component](/integrations/nest/).
|
||||
By default all sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all sensors for the [Nest component](/integrations/nest/).
|
||||
|
||||
{% configuration %}
|
||||
monitored_conditions:
|
||||
@ -382,7 +455,7 @@ The following conditions are available by device:
|
||||
- `color_status`: `gray`, `green`, `yellow` or `red`. Indicates device status by color in the Nest app UI. It is an aggregate condition for battery+smoke+CO states, and reflects the actual color indicators displayed in the Nest app.
|
||||
- Nest Camera: none
|
||||
|
||||
### Security State (Legacy Only)
|
||||
### Security State
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
@ -407,3 +480,5 @@ If a Nest Cam detects the presence of a person (see `person_detected` in [binary
|
||||
A `deter` state is re-evaluated after several minutes and relaxed to `ok` if no further `person_detected` events have occurred.
|
||||
|
||||
The `security_state` automatically switches to `ok` when the structure state is `home`.
|
||||
|
||||
</details>
|
||||
|
||||
@ -19,6 +19,7 @@ sensor:
|
||||
platform: neurio_energy
|
||||
api_key: CLIENT_ID
|
||||
api_secret: CLIENT_SECRET
|
||||
sensor_id: SENSOR_ID
|
||||
```
|
||||
|
||||
Two sensors will be created with the following names:
|
||||
@ -36,7 +37,7 @@ api_secret:
|
||||
required: true
|
||||
type: string
|
||||
sensor_id:
|
||||
description: The sensor ID will be auto-detected but can be set if you have more then one sensor.
|
||||
required: false
|
||||
description: "The sensor ID, a hex number as shown on the [PWRView webpage](https://mypwrview.generac.com/#settings/sensors), e.g., `0x0000XXXXXXXXXXXX`."
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -18,23 +18,5 @@ home monitoring sensor kits.
|
||||
|
||||
## Configuration
|
||||
|
||||
To add your Notion kits to your Home Assistant installation, add the following to your
|
||||
`configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notion:
|
||||
username: YOUR_EMAIL_ADDRESS
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: An email address for an active Notion account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for the account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
This integration can be configured via the Home Assistant UI by navigating to
|
||||
**Configuration** -> **Integrations**.
|
||||
|
||||
@ -5,6 +5,7 @@ ha_category:
|
||||
- DIY
|
||||
ha_release: 0.12
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@garbled1'
|
||||
- '@epenet'
|
||||
@ -17,28 +18,48 @@ Every 1-wire device has a (globally) unique ID that identifies the device on the
|
||||
|
||||
Different families have different functionality and can measure different quantities.
|
||||
|
||||
Each 1-wire component data sheet describes the different properties the component provides. The [owfs software](https://github.com/owfs/owfs) adds some extra tools to make it easier for DIY implementers to use the component.
|
||||
|
||||
### Supported devices:
|
||||
|
||||
#### Binary sensors:
|
||||
|
||||
| Family | Device | Physical Quantity |
|
||||
| -------|:-----|:-----|
|
||||
| 12 | [DS2406](https://datasheets.maximintegrated.com/en/ds/DS2406.pdf) | 2 sensed (sensed.A/B) <sup>[4](#note_4)</sup> |
|
||||
| 29 | [DS2408](https://datasheets.maximintegrated.com/en/ds/DS2408.pdf) | 8 sensed (sensed.0-7) <sup>[4](#note_4)</sup> |
|
||||
|
||||
#### Sensors:
|
||||
|
||||
| Family | Device | Physical Quantity |
|
||||
| -------|:-----|:-----|
|
||||
| 10 | [DS18S20](https://www.maximintegrated.com/en/products/sensors/DS18S20.html) | Temperature |
|
||||
| 12 | [DS2406(TAI-8570)](https://datasheets.maximintegrated.com/en/ds/DS2406.pdf) | Temperature (pressure when using TAI-8570) |
|
||||
| 12 | [DS2406](https://datasheets.maximintegrated.com/en/ds/DS2406.pdf) | Temperature and pressure when using TAI-8570 <sup>[1](#note_1)</sup> |
|
||||
| 1D | [DS2423](https://datasheets.maximintegrated.com/en/ds/DS2423.pdf) | Counter |
|
||||
| 22 | [DS1822](https://datasheets.maximintegrated.com/en/ds/DS1822.pdf) | |
|
||||
| 26 | [DS2438](https://datasheets.maximintegrated.com/en/ds/DS2438.pdf) | Temperature, Voltage, Current (pressure when using B1-R1-A, illuminance when using S2-R1-A, humidity when using compatible Honeywell or Humirel sensor) |
|
||||
| 26 | [DS2438](https://datasheets.maximintegrated.com/en/ds/DS2438.pdf) | Temperature, Voltage, Current (pressure when using B1-R1-A, illuminance when using S2-R1-A, humidity when using compatible Honeywell or Humirel sensor) <sup>[2](#note_2)</sup> |
|
||||
| 28 | [DS18B20](https://datasheets.maximintegrated.com/en/ds/DS18B20.pdf) | Temperature |
|
||||
| 3B | [DS1825](https://datasheets.maximintegrated.com/en/ds/DS1825.pdf) | Temperature |
|
||||
| 42 | [DS28EA00](https://datasheets.maximintegrated.com/en/ds/DS28EA00.pdf) | Temperature |
|
||||
| EF | [HobbyBoard](https://hobbyboards.com/) | Temperature, Humidity, Moisture |
|
||||
| EF | [HobbyBoard](https://hobbyboards.com/) | Temperature, Humidity, Moisture, Wetness <sup>[3](#note_3)</sup> |
|
||||
|
||||
#### Switches:
|
||||
|
||||
| Family | Device | Physical Quantity |
|
||||
| -------|:-----|:-----|
|
||||
| 12 | [DS2406](https://datasheets.maximintegrated.com/en/ds/DS2406.pdf) | 2 latches (latch.A/B) and 2 PIOs (PIO.A/B) <sup>[4](#note_4)</sup> |
|
||||
| 29 | [DS2408](https://datasheets.maximintegrated.com/en/ds/DS2408.pdf) | 8 latches (latch.0-7) and 8 PIOs (PIO.0/7) <sup>[4](#note_4)</sup> |
|
||||
|
||||
Notes:
|
||||
|
||||
- The TAI-8570 Pressure Sensor is based on a 1-wire composite device by AAG Electronica. It contains, above 1-wire components, also a barometer, hygrometer and illuminance sensors. This onewire platform can read and present values from that device.
|
||||
- <a name="note_1">The TAI-8570</a> Pressure Sensor is based on a 1-wire composite device by AAG Electronica. It contains, above 1-wire components, also a barometer, hygrometer and illuminance sensors. This onewire platform can read and present values from that device, but the sensors will default to disabled <sup>[4](#note_4)</sup>.
|
||||
|
||||
- Each 1-wire component data sheet describes the different properties the component provides. The [owfs software](https://github.com/owfs/owfs) adds some extra tools to make it easier for DIY implementers to use the component. By hobbyists, it is quite common to use DS2438 Smart Battery Monitor as a multipurpose measurement node that can place temperature, humidity and luminosity on the 1-wire bus by just adding some standard components to the DS2438. For different component types, there are ready-made algorithms implemented in owfs. Those are exposed by the owfs software and can be read by this platform. The B1-R1-A/pressure is exposed as a barometric pressure sensor. S2-R1-A/illuminance is presented as an illuminance sensor. For a more detailed description of these properties, refer to the [owfs documentation](https://owfs.org/index_php_page_ds2438.html).
|
||||
For this component, the more basic quantities temperature, VAD, VDD and IAD is exported as separate sensors.
|
||||
- <a name="note_2">For hobbyists</a>, it is quite common to use DS2438 Smart Battery Monitor as a multipurpose measurement node that can place temperature, humidity and luminosity on the 1-wire bus by just adding some standard components to the DS2438. For different component types, there are ready-made algorithms implemented in owfs. Those are exposed by the owfs software and can be read by this platform. The B1-R1-A/pressure is exposed as a barometric pressure sensor. S2-R1-A/illuminance is presented as an illuminance sensor. For a more detailed description of these properties, refer to the [owfs documentation](https://owfs.org/index_php_page_ds2438.html).
|
||||
For this component, the more basic quantities (temperature, VAD, VDD and IAD) are exported as separate sensors. Please note that some of the sensors will default to disabled <sup>[4](#note_4)</sup>.
|
||||
|
||||
- Hobbyboards is a company that has been selling DIY boards of different kinds. The company has been away from the market for some time, so no reference to the boards can be made. This platform has an implementation for some of those.
|
||||
- <a name="note_3">Hobbyboards</a> is a company that has been selling DIY boards of different kinds. The company has been away from the market for some time, so no reference to the boards can be made. This platform has an implementation for some of those.
|
||||
|
||||
- <a name="note_4">Some sensors are disabled by default</a> to avoid overloading the bus. These can be activated by opening the integrations page in your configuration, listing your 1-Wire integration devices and updating the entity.
|
||||
|
||||
## Interfacing with the 1-wire bus
|
||||
|
||||
@ -93,29 +114,7 @@ The device IDs begin with `28-`.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable One wire sensors in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: onewire
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
names:
|
||||
description: ID and friendly name of your sensors.
|
||||
required: false
|
||||
type: string
|
||||
host:
|
||||
description: Remote or localhost running owserver.
|
||||
required: false
|
||||
type: string
|
||||
port:
|
||||
description: "The port number of the owserver (requires `host`)."
|
||||
required: false
|
||||
type: integer
|
||||
default: 4304
|
||||
{% endconfiguration %}
|
||||
Go to the integrations page in your configuration and click on new integration -> 1-Wire.
|
||||
|
||||
### Configuration Example
|
||||
|
||||
|
||||
@ -10,6 +10,7 @@ ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@fabaff'
|
||||
- '@freekode'
|
||||
- '@nzapponi'
|
||||
ha_domain: openweathermap
|
||||
---
|
||||
|
||||
@ -26,16 +27,17 @@ You need an API key, which is free, but requires a [registration](https://home.o
|
||||
|
||||
To add OpenWeatherMap integration go to **Configuration** >> **Integrations** and find the integration in the list.
|
||||
|
||||
| Parameter | Value |
|
||||
| :------------------- | :---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| API Key | API Key from the website |
|
||||
| Name | Name of the integration |
|
||||
| Latitude | Latitude for weather forecast and sensor |
|
||||
| Longitude | Longitude for weather forecast and sensor |
|
||||
| Mode | Forecast mode, `hourly` for a three-hour forecast, `daily` for daily forecast, or `freedaily` for a five-day forecast with the free tier. |
|
||||
| Language | Language for receiving data (only for `sensor`) |
|
||||
| Parameter | Value |
|
||||
| :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| API Key | API Key from the website |
|
||||
| Name | Name of the integration |
|
||||
| Latitude | Latitude for weather forecast and sensor |
|
||||
| Longitude | Longitude for weather forecast and sensor |
|
||||
| Mode | Forecast mode, `hourly` for a three-hour forecast, `daily` for daily forecast using a paid API tier, `onecall_hourly` for an hourly forecast up to 2 days, or `onecall_daily` for a daily forecast up to 7 days (ideal for the free tier). |
|
||||
| Language | Language for receiving data (only for `sensor`) |
|
||||
|
||||
The integration creates weather entity and also sensors for all available conditions.
|
||||
Selecting a `onecall` mode with the free tier leverages the One Call API, resulting in updates every 5 minutes and is recommended for both hourly and daily forecast.
|
||||
|
||||
For each condition `sensor` entity will be created with id:
|
||||
|
||||
@ -45,8 +47,8 @@ Sensor prints information in language which was selected for integration.
|
||||
|
||||
All conditions:
|
||||
|
||||
| Condition | Description |
|
||||
| :----------- | :------------------------------------- |
|
||||
| Condition | Description |
|
||||
| :------------- | :----------------------------------- |
|
||||
| `weather` | A human-readable text summary. |
|
||||
| `temperature` | Current temperature. |
|
||||
| `wind_speed` | Wind speed. |
|
||||
|
||||
@ -6,8 +6,6 @@ ha_category:
|
||||
ha_iot_class: Calculated
|
||||
ha_release: 0.44
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@ChristianKuehnel'
|
||||
ha_domain: plant
|
||||
---
|
||||
|
||||
|
||||
@ -16,16 +16,16 @@ ha_domain: plugwise
|
||||
---
|
||||
|
||||
This enables [Plugwise](https://www.plugwise.com) components with a central Smile gateway to be integrated. This integration talks locally to your **Smile** interface, and you will need its password and IP address.
|
||||
The platform supports [Anna](https://www.plugwise.com/en_US/products/anna), [Adam (zonecontrol)](https://www.plugwise.com/en_US/zonecontrol) and [P1](https://www.plugwise.com/en_US/products/smile-p1) Smile products. See below list for more details.
|
||||
The platform supports [Anna](https://www.plugwise.com/en_US/products/anna), [Adam (zonecontrol)](https://www.plugwise.com/en_US/zonecontrol), [P1](https://www.plugwise.com/en_US/products/smile-p1) Smile products and the [Stretch](https://www.plugwise.com/nl_NL/het-systeem) product. See below list for more details.
|
||||
|
||||
Platforms available - depending on your Smile and setup include:
|
||||
|
||||
- `climate` (for the Anna and Lisa products, or a single Tom)
|
||||
- `sensor` (for all relevant products including the Smile P1)
|
||||
- `binary_sensor` (for domestic hot water and secondary heater)
|
||||
- `switch` (for Plugs)
|
||||
- `switch` (for Plugs connected to Adam or Stealths and Circles connected to a Stretch)
|
||||
|
||||
The password can be found on the bottom of your Smile, it should consist of 6 characters. To find your IP address use the Plugwise App:
|
||||
The password can be found on the bottom of your Smile or Stretch, it should consist of 6 characters. To find your IP address use the Plugwise App:
|
||||
|
||||
- Open the Plugwise App and choose the 'Settings'-icon (☰) and choose 'HTML-interface'.
|
||||
- Go to the (lower) 'Settings'-icon (☰) and choose 'Preferences'.
|
||||
@ -41,7 +41,7 @@ Centralized measurements such as 'power' for a P1, 'outdoor_temperature' on Anna
|
||||
|
||||
## Configuration
|
||||
|
||||
The Plugwise Smile(s) present in your network will be automatically detected via Zeroconf discovery and will be shown on the Integrations-page. To set up an integration, click the "CONFIGURATION" button on the discovered integration and you will be presented with a dialog requesting your Smile password. After you click submit, you will have the opportunity to select the area(s) where individual Smile appliances are located.
|
||||
The Plugwise Smile(s) present in your network will be automatically detected via Zeroconf discovery and will be shown on the Integrations-page. To set up an integration, click the "CONFIGURATION" button on the discovered integration and you will be presented with a dialog requesting your Smile password. After you click submit, you will have the opportunity to select the area(s) where individual Smile appliances are located. The username `smile` is shown as a default, when configuring your Stretch change this to `stretch` accordingly.
|
||||
|
||||
Repeat the above procedure for each Smile gateway (i.e., if you have an Adam setup and a P1 DSMR you'll have to add two integrations).
|
||||
|
||||
@ -142,12 +142,17 @@ Adam (zone_control):
|
||||
|
||||
Anna (thermostat):
|
||||
|
||||
- v4.0
|
||||
- v3.1
|
||||
- v1.8
|
||||
- v4.x
|
||||
- v3.x
|
||||
- v1.x
|
||||
|
||||
Smile P1 (DSMR):
|
||||
|
||||
- v4.0
|
||||
- v3.3
|
||||
- v2.5
|
||||
- v4.x
|
||||
- v3.x
|
||||
- v2.x
|
||||
|
||||
Stretch (power switches):
|
||||
|
||||
- v3.x
|
||||
- v2.x
|
||||
|
||||
@ -35,3 +35,43 @@ The `cprof` file can be viewed with:
|
||||
Additionally, the profiler will generate a `callgrind.out` file that can be viewed with:
|
||||
|
||||
[kcachegrind](https://kcachegrind.github.io/) or qcachegrind
|
||||
|
||||
### Service `profiler.memory`
|
||||
|
||||
Start the memory profiler for the specified number of seconds.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `seconds` | yes | The number of seconds to run the profile. Defaults to 60.0
|
||||
|
||||
When the memory profile is complete, Profiler will generate a `.hpy` file in your configuration directory. The exact path to these files will appear in a persistent notification so they can be easily located and copied to your desktop.
|
||||
|
||||
The `hpy` file can be viewed with any text editor. A visual representation can be viewed using the [Heapy Profile Browser](http://guppy-pe.sourceforge.net/ProfileBrowser.html) which is a part of the guppy3 package and can be launched via the below script:
|
||||
|
||||
```python
|
||||
#! /usr/bin/python3
|
||||
from guppy import hpy
|
||||
hpy().pb()
|
||||
```
|
||||
|
||||
### Service `profiler.start_log_objects`
|
||||
|
||||
Start logging the growth of objects in memory.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0
|
||||
|
||||
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks.
|
||||
|
||||
### Service `profiler.stop_log_objects`
|
||||
|
||||
Stop logging the growth of objects in memory.
|
||||
|
||||
### Service `profiler.dump_log_objects`
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `type` | no | The type of object to dump to the log.
|
||||
|
||||
When `start_log_objects` highlights the growth of a collection of objects in memory, this service can help investigate. The `repr` of each object that matches `type` will be logged.
|
||||
|
||||
@ -34,6 +34,7 @@ The Proximity entity which is created has the following values:
|
||||
- 'km'
|
||||
- 'm'
|
||||
- 'mi'
|
||||
- 'yd'
|
||||
- 'ft'
|
||||
- `nearest`: The device which is nearest to the zone
|
||||
|
||||
@ -70,7 +71,7 @@ zone:
|
||||
required: false
|
||||
type: integer
|
||||
unit_of_measurement:
|
||||
description: The unit of measurement for distance. Valid values are (km, m, mi, ft) [kilometers, meters, miles and feet respectively].
|
||||
description: The unit of measurement for distance. Valid values are (km, m, mi, yd, ft) [kilometers, meters, miles, yards and feet respectively].
|
||||
required: false
|
||||
type: string
|
||||
default: km
|
||||
|
||||
@ -9,6 +9,13 @@ ha_codeowners:
|
||||
ha_domain: ptvsd
|
||||
---
|
||||
|
||||
<div class="note warning">
|
||||
|
||||
The PTVSD integration has been deprecated and will be removed in Home Assistant 0.120.0.
|
||||
A full-featured replacement is available, by using the [`debugpy` integration](/integrations/debugpy).
|
||||
|
||||
</div>
|
||||
|
||||
The `ptvsd` integration allows you to use the Visual Studio Code PTVSD debugger with Home Assistant.
|
||||
|
||||
This is useful in testing changes on a local development install, or connecting to a production server to debug issues.
|
||||
|
||||
@ -29,6 +29,8 @@ You need the Hostname or IP address of the machine that runs your Roon Core. Thi
|
||||
4. Roon core will then provide Home Assistant with the details of your media players.
|
||||
5. In Home Assistant you can then pick an area for each of your music players, and add them to Home Assistant.
|
||||
|
||||
## Services
|
||||
|
||||
#### Service `media_player.play_media`
|
||||
|
||||
Roon doesn't use file names or URLs to track media and so the roon integration is currently limited in how it supports this call.
|
||||
@ -39,5 +41,31 @@ Roon doesn't use file names or URLs to track media and so the roon integration i
|
||||
| `media_content_id` | no | The text for roon to search for in your library. |
|
||||
| `media_content_type` | no | A media type. Currently supported are `radio`, `playlist` and `genre` |
|
||||
|
||||
|
||||
For example to play BBC Radio 4 you would set `media_content_type` to `radio` and `media_content_id` to `BBC Radio 4`
|
||||
|
||||
### Service `roon.join`
|
||||
|
||||
Group players together.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | ID of the player that will be the master of the group.
|
||||
| `join_ids` | no | id(s) of the players that will join the master.
|
||||
|
||||
### Service `roon.unjoin`
|
||||
|
||||
Remove players from a group.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | ID of the player that is the master of the group.
|
||||
| `unlink_name` | yes | id(s) of the players that will be unjoined from the group. If not specified, all players will be unjoined from the master.
|
||||
|
||||
### Service `roon.transfer`
|
||||
|
||||
Transfer playback from one player to another.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | id of the source player.
|
||||
| `transfer_name` | no | id of the destination player.
|
||||
|
||||
@ -6,6 +6,8 @@ ha_category:
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.43
|
||||
ha_domain: rpi_gpio_pwm
|
||||
ha_codeowners:
|
||||
- '@soldag'
|
||||
---
|
||||
|
||||
The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width modulation, for example LED strips. It supports one-color, RGB and RGBW LEDs driven by GPIOs of a Raspberry Pi (same host or remote) or a PCA9685 controller.
|
||||
|
||||
@ -10,6 +10,7 @@ ha_release: 0.115
|
||||
ha_codeowners:
|
||||
- '@balloob'
|
||||
- '@bieniu'
|
||||
- '@thecode'
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: shelly
|
||||
featured: true
|
||||
|
||||
@ -20,8 +20,10 @@ There is currently support for the following device types within Home Assistant:
|
||||
- **CO Detector**: reports on the carbon monoxide sensor status*.
|
||||
- **Entry Sensor**: reports on the current entry sensor status*.
|
||||
- **Freeze Sensor**: reports on the freeze sensor temperature*.
|
||||
- **Glass Break Sensor**: reports on the glass breakage sensor status*.
|
||||
- **Lock**: reports on `Door Locks` and can be used to lock and unlock a lock.
|
||||
- **Motion Sensor**: triggers [events](#events) if the alarm is armed or if secret alerts are enabled in SimpliSafe.
|
||||
- **Siren**: reports on the siren status*.
|
||||
- **Smoke Detector**: reports on the smoke sensor status*.
|
||||
- **Water Sensor**: reports on water sensor status*.
|
||||
|
||||
|
||||
@ -10,6 +10,7 @@ ha_domain: synology_dsm
|
||||
ha_codeowners:
|
||||
- '@hacf-fr'
|
||||
- '@Quentame'
|
||||
- '@mib1185'
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
@ -50,6 +51,11 @@ ssl:
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
verify_ssl:
|
||||
description: Determine if SSL-Certificate should be verified.
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
username:
|
||||
description: The account username to connect to the Synology NAS. Using a separate account is advised, see the [Separate User Configuration](#separate-user-configuration) section below for details.
|
||||
required: true
|
||||
@ -139,6 +145,9 @@ For each volume:
|
||||
Security:
|
||||
- `security_status`: Displays safe to indicate if the NAS is safe.
|
||||
|
||||
Upgrade:
|
||||
- `update_available`: Displays on if a DSM update is available.
|
||||
|
||||
For each disk:
|
||||
- `disk_exceed_bad_sector_thr`: Displays on to indicate if the disk exceeded the maximum bad sector threshold. (Does not work with DSM 5.x)
|
||||
- `disk_below_remain_life_thr`: Displays on to indicate if the disk dropped below the remain life threshold. (Does not work with DSM 5.x)
|
||||
@ -150,3 +159,21 @@ For each disk:
|
||||
|
||||
## Cameras
|
||||
- `{camera_name}`: Displays cameras added in [Surveillance Station](https://www.synology.com/en-us/surveillance).
|
||||
|
||||
## Services
|
||||
|
||||
### Service `synology_dsm.reboot`
|
||||
|
||||
Reboot the specified NAS by `serial`. If only one DSM is configured, `serial` is optional.
|
||||
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `serial` | yes, when multiple NAS are configured | serial of DSM |
|
||||
|
||||
### Service `synology_dsm.shutdown`
|
||||
|
||||
Shutdown the specified NAS by `serial`. If only one DSM is configured, `serial` is optional.
|
||||
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `serial` | yes, when multiple NAS are configured | serial of DSM |
|
||||
|
||||
@ -22,15 +22,18 @@ This integration allows you to control [Tasmota](https://tasmota.github.io/docs/
|
||||
- Tasmota devices flashed with version 9.1, or later.
|
||||
- Tasmota devices configured for native discovery (`SetOption19 0`)
|
||||
|
||||
## Limitations
|
||||
## Supported Features
|
||||
|
||||
Lights, relays, sensors and switches are supported.
|
||||
Lights, relays, sensors, switches and buttons are supported.
|
||||
|
||||
- Lights will be added as Home Assistant `light` entities.
|
||||
- Lights will be added as Home Assistant `light` entities. Single channel Dimmers, RGB lights, RGB lights with Color Temperature control and RGB lights with White control are supported.
|
||||
- Relays will be added as Home Assistant `switch` entities, if `SetOption30 = 0`. If `SetOption30 = 1`, relays will be added as `light` entities.
|
||||
- Sensors will be added as Home Assistant `sensor` entities.
|
||||
- Switches will be added as Home Assistant `binary_sensor` entities or `automation triggers` depending by the `switchmode` used. To enable them, `switchtopic` needs to be set. If there are no corresponding power device (light, relay, etc.) the `switch` will be added automatically.
|
||||
- Switches will be added as Home Assistant `binary_sensor` entities or `automation triggers` depending by the `switchmode` used when `SetOption114` is enabled.
|
||||
- Buttons will be added as Home Assistant `automation triggers` when `SetOption73` is enabled.
|
||||
- The integration will also create up to eight Status Sensors, each one with a different information. Please note all the Status Sensors are disabled by default.
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -32,6 +32,7 @@ Send a notification.
|
||||
| `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. |
|
||||
| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
|
||||
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
|
||||
| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` |
|
||||
|
||||
### Service `telegram_bot.send_photo` and `telegram_bot.send_sticker`
|
||||
|
||||
@ -51,6 +52,7 @@ Send a photo.
|
||||
| `timeout` | yes | Timeout for send photo. Will help with timeout errors (poor internet connection, etc) |
|
||||
| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
|
||||
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
|
||||
| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` |
|
||||
|
||||
### Service `telegram_bot.send_video`
|
||||
|
||||
@ -70,6 +72,7 @@ Send a video.
|
||||
| `timeout` | yes | Timeout for send video. Will help with timeout errors (poor internet connection, etc) |
|
||||
| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
|
||||
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
|
||||
| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` |
|
||||
|
||||
### Service `telegram_bot.send_document`
|
||||
|
||||
@ -89,6 +92,7 @@ Send a document.
|
||||
| `timeout` | yes | Timeout for send document. Will help with timeout errors (poor internet connection, etc) |
|
||||
| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
|
||||
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
|
||||
| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` |
|
||||
|
||||
### Service `telegram_bot.send_location`
|
||||
|
||||
@ -102,6 +106,7 @@ Send a location.
|
||||
| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. |
|
||||
| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
|
||||
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
|
||||
| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: `{{trigger.event.data.message_tag}}` |
|
||||
|
||||
### Service `telegram_bot.edit_message`
|
||||
|
||||
@ -424,3 +429,27 @@ Telegram callbacks also support arguments and commands the same way as normal me
|
||||
{% endraw %}
|
||||
|
||||
In this case, having a callback with `/repeat 1 2 3` will pop a notification saying `I repeat: [1, 2, 3]`
|
||||
|
||||
Receiving `chat_id` and `message_id` identifiers of sent messages by the `telegram_bot`.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
- alias: 'Notifications about messages sent by Telegram bot'
|
||||
trigger:
|
||||
platform: event
|
||||
event_type: telegram_sent
|
||||
event_data:
|
||||
message_tag: "msg_start"
|
||||
action:
|
||||
- service: input_number.set_value
|
||||
data_template:
|
||||
entity_id: input_number.chat_id
|
||||
value: '{{ trigger.event.data.chat_id }}'
|
||||
- service: input_number.set_value
|
||||
data_template:
|
||||
entity_id: input_number.message_id
|
||||
value: '{{ trigger.event.data.message_id }}'
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
@ -339,3 +339,29 @@ sensor:
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Updating templates using `random`
|
||||
|
||||
If you use the `random` filter, you may want the template to select a different random element every now and then. If the template does not update automatically due to entity changes it can be updated periodically by using the `homeassistant.update_entity` service with a time pattern automation. For example, this will render a new random number every five minutes:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: template
|
||||
sensors:
|
||||
random_number:
|
||||
friendly_name: "Random number"
|
||||
value_template: "{{ range(0,100)|random }}"
|
||||
|
||||
automation:
|
||||
- alias: "Update random number template"
|
||||
trigger:
|
||||
- platform: time_pattern
|
||||
minutes: "/5"
|
||||
action:
|
||||
- service: homeassistant.update_entity
|
||||
entity_id: sensor.random_number
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
@ -17,7 +17,9 @@ ha_codeowners:
|
||||
- '@ollo69'
|
||||
---
|
||||
|
||||
The `tuya` integration is the main integration to integrate all [Tuya Smart](https://www.tuya.com) related platforms, except the Zigbee hub. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account.
|
||||
The `tuya` integration is the main integration to integrate [Tuya Smart](https://www.tuya.com) related platforms, except the Zigbee hub. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account.
|
||||
|
||||
**Important**: Not all Tuya devices are supported by the `tuya API` used by this integration. For more details refer to [TuyaHA Library](https://github.com/PaulAnnekov/tuyaha).
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
@ -69,6 +71,53 @@ platform:
|
||||
default: tuya
|
||||
{% endconfiguration %}
|
||||
|
||||
## Integration Options
|
||||
|
||||
It is possible to change various behaviors through the integration options, some common for integration and others specific to each `light` and `climate` devices. These can be changed at **Tuya** -> **Options** on the Integrations page.
|
||||
|
||||
### Common Options
|
||||
|
||||
- **Discovery device polling interval** (default=605): define the interval between 2 consecutive calls to the `API discovery method`, which is used to get the status for all registered devices with a single call. If you set interval value too low, Tuya API will return errors, so it is suggested to use the default value until
|
||||
you know that it is possible to use lower values.
|
||||
|
||||
- **Query device polling interval** (default=120): this option is available only if you have devices that can use the `API query method`.
|
||||
It defines the interval between 2 consecutive calls to the `API query method`, that is used to get the status for a specific device.
|
||||
This method is always used when it is available only one device that can use it. If you set interval value too low, Tuya API will return errors
|
||||
so it is suggested to use the default value until you know that is possible to use lower values.
|
||||
|
||||
- **Device that will use the query method**: this option is available only if you have devices that can use the `API query method`.
|
||||
Because it is not possible to make multiple calls to the `API query method`. If you have more than one device that can use it you can choose which one will use. This will give a better status refresh for this specific device.
|
||||
|
||||
- **Device to configure (multi-select list)**: this option is available only if you have a `light` or `climate` device. Selecting a device to
|
||||
configure to options page related to the device will be opened. You can also select more than one devices to configure them simultaneously,
|
||||
but all selected devices must be of the same type.
|
||||
|
||||
### Light Options
|
||||
|
||||
- **Force color support**: when checked force `color support` for devices that do not report this feature.
|
||||
|
||||
- **Brightness range**: change the `brightness range` used for the device. Possible options are:
|
||||
- range 1-255 (default)
|
||||
- range 10-1000
|
||||
|
||||
- **Min color temperature**: set minimum `color temperature` expressed in `kelvin` accepted by the light.
|
||||
|
||||
- **Max color temperature**: set maximum `color temperature` expressed in `kelvin` accepted by the light.
|
||||
|
||||
- **Max color temperature reported**: set the maximum `color temperature` value reported by the light.
|
||||
|
||||
### Climate Options
|
||||
|
||||
- **Temperature unit**: change the `temperature unit` used internally by the devices.
|
||||
|
||||
- **Temperature values divider**: `all temperatures` reported by device will be divided by this value.
|
||||
|
||||
- **Current Temperature value divider**: `current temperature` reported by device will be divided by this value.
|
||||
|
||||
- **Min target temperature**: set the minimum allowed `target temperature` for the entity.
|
||||
|
||||
- **Max target temperature**: set the maximum allowed `target temperature` for the entity.
|
||||
|
||||
## Service
|
||||
|
||||
These services are available for the `tuya` component:
|
||||
|
||||
@ -71,6 +71,10 @@ 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.
|
||||
|
||||
### Control DPI Traffic Restrictions
|
||||
|
||||
Entities appear automatically for each restriction group. If there are no restrictions in a group, no entity will be visible. Toggling the switch in Home Assistant will enable or disable all restrictions inside a group.
|
||||
|
||||
## Sensor
|
||||
|
||||
### Bandwidth sensor
|
||||
|
||||
@ -49,6 +49,7 @@ The port string used in the user interface or the configuration file can have 2
|
||||
|
||||
- For a serial device: /dev/ttyUSB00
|
||||
- For a TCP/IP device: 127.0.0.1:3678
|
||||
- For the VMBSIG module: tls://192.168.1.9:27015
|
||||
|
||||
{% configuration %}
|
||||
port:
|
||||
|
||||
@ -111,3 +111,14 @@ This service allows for controlling the WLED effect.
|
||||
|
||||
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).
|
||||
|
||||
### Service `wled.preset`
|
||||
|
||||
This service allows for loading a preset saved on the WLED device.
|
||||
|
||||
| Service Data Attribute | Required | Description |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | no | A WLED entity ID to load the preset from. |
|
||||
| `preset` | no | ID of the preset slot to load from. |
|
||||
|
||||
More information on presets [is documented in the WLED Wiki](https://github.com/Aircoookie/WLED/wiki/Presets)
|
||||
|
||||
@ -63,6 +63,10 @@ add_holidays:
|
||||
description: "Add custom holidays (such as company, personal holidays or vacations). Needs to formatted as `YYYY-MM-DD`."
|
||||
required: false
|
||||
type: list
|
||||
remove_holidays:
|
||||
description: "Remove holidays (treat holiday as workday). Needs to formatted as `YYYY-MM-DD`."
|
||||
required: false
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
Days are specified as follows: `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`.
|
||||
@ -107,6 +111,20 @@ binary_sensor:
|
||||
- '2020-02-24'
|
||||
```
|
||||
|
||||
This example excludes Saturdays, Sundays and holidays. Two holidays are removed: November 26, 2020 and December 25, 2020.
|
||||
|
||||
```yaml
|
||||
# Example 2 configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: workday
|
||||
country: US
|
||||
workdays: [mon, tue, wed, thu, fri]
|
||||
excludes: [sat, sun, holiday]
|
||||
remove_holidays:
|
||||
- '2020-11-26'
|
||||
- '2020-12-25'
|
||||
```
|
||||
|
||||
## Automation example
|
||||
|
||||
Example usage for automation:
|
||||
|
||||
@ -16,7 +16,7 @@ ha_config_flow: true
|
||||
|
||||
The Xbox integration allows you to control Xbox One (or newer) consoles from Home Assistant.
|
||||
|
||||
Home Assistant authenticates with Xbox Live through OAuth2 using the [Home Assistant Cloud account linking service](/integrations/cloud/). Set up the integration through **Configuration -> Integrations -> Xbox**. Ensure you login using the Microsoft account that is linked to your Xbox consoles. Note that for the media player and remote entities to be added your Xbox will need to have remote features enabled via Settings-Remote Features (you may need to uprade your controller firmware).
|
||||
Home Assistant authenticates with Xbox Live through OAuth2 using the Home Assistant Cloud account linking service. Set up the integration through **Configuration -> Integrations -> Xbox**. Ensure you login using the Microsoft account that is linked to your Xbox consoles. Note that for the media player and remote entities to be added your Xbox will need to have remote features enabled via Settings-Remote Features (you may need to uprade your controller firmware).
|
||||
|
||||
<div class='note'>
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@ image:
|
||||
type: string
|
||||
secondary_info:
|
||||
required: false
|
||||
description: "Show additional info. Values: `entity-id`, `last-changed`, `last-triggered` (only for automations and scripts), `position` or `tilt-position` (only for supported covers), `brightness` (only for lights)."
|
||||
description: "Show additional info. Values: `entity-id`, `last-changed`, `last-updated`, `last-triggered` (only for automations and scripts), `position` or `tilt-position` (only for supported covers), `brightness` (only for lights)."
|
||||
type: string
|
||||
format:
|
||||
required: false
|
||||
|
||||
77
source/_lovelace/grid.markdown
Normal file
77
source/_lovelace/grid.markdown
Normal file
@ -0,0 +1,77 @@
|
||||
---
|
||||
title: "Grid Card"
|
||||
sidebar_label: Grid
|
||||
description: "The Grid card allows you to show multiple cards in a grid."
|
||||
---
|
||||
|
||||
The Grid card allows you to show multiple cards in a grid. It will first fill the columns, automatically adding new rows as needed.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/lovelace/lovelace_grid.png' alt='Screenshot of the grid card'>
|
||||
Screenshot of the Grid card.
|
||||
</p>
|
||||
|
||||
To add the Grid card to your user interface, click the Lovelace menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the plus button in the bottom right corner and select **Grid Card** from the card picker.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
required: true
|
||||
description: grid
|
||||
type: string
|
||||
title:
|
||||
required: false
|
||||
description: Title of Grid
|
||||
type: string
|
||||
square:
|
||||
required: false
|
||||
description: Should the cards be shown square.
|
||||
type: boolean
|
||||
default: true
|
||||
columns:
|
||||
required: false
|
||||
description: Number of columns in the grid.
|
||||
type: integer
|
||||
default: 3
|
||||
cards:
|
||||
required: true
|
||||
description: List of cards.
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
### Examples
|
||||
|
||||
Alternatively, the card can be configured using YAML:
|
||||
|
||||
Basic example:
|
||||
|
||||
```yaml
|
||||
type: grid
|
||||
cards:
|
||||
- type: picture-entity
|
||||
entity: camera.demo_camera
|
||||
show_info: false
|
||||
- type: entities
|
||||
entities:
|
||||
- binary_sensor.movement_backyard
|
||||
```
|
||||
|
||||
Defining columns and disabling the square option:
|
||||
|
||||
```yaml
|
||||
type: grid
|
||||
title: Backyard
|
||||
columns: 2
|
||||
square: false
|
||||
cards:
|
||||
- type: picture-entity
|
||||
entity: group.all_lights
|
||||
image: /local/house.png
|
||||
- type: horizontal-stack
|
||||
cards:
|
||||
- type: picture-entity
|
||||
entity: light.ceiling_lights
|
||||
image: /local/bed_1.png
|
||||
- type: picture-entity
|
||||
entity: light.bed_light
|
||||
image: /local/bed_2.png
|
||||
```
|
||||
@ -29,7 +29,7 @@ Yahoo! has discontinued their financial service. To fill this gap we have now th
|
||||
|
||||
## New Platforms
|
||||
|
||||
- Add iAlarm support ([@RyuzakiKK] - [#10878]) ([alarm_control_panel.ialarm docs]) (new-platform)
|
||||
- Add iAlarm support ([@RyuzakiKK] - [#10878]) (new-platform)
|
||||
- Add Alpha Vantage sensor ([@fabaff] - [#10873]) ([sensor.alpha_vantage docs]) (new-platform)
|
||||
- Add ADS component ([@stlehmann] - [#10142]) ([ads docs]) ([binary_sensor.ads docs]) ([light.ads docs]) ([sensor.ads docs]) ([switch.ads docs]) (new-platform)
|
||||
- Gearbest sensor ([@HerrHofrat] - [#10556]) (new-platform)
|
||||
@ -85,7 +85,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
- Unpacking RESTful sensor JSON results into attributes. ([@nickovs] - [#10753]) ([sensor.rest docs])
|
||||
- Bump dev to 0.60.0.dev0 ([@fabaff] - [#10912])
|
||||
- Update eliqonline.py ([@molobrakos] - [#10914]) ([sensor.eliqonline docs])
|
||||
- Add iAlarm support ([@RyuzakiKK] - [#10878]) ([alarm_control_panel.ialarm docs]) (new-platform)
|
||||
- Add iAlarm support ([@RyuzakiKK] - [#10878]) (new-platform)
|
||||
- Correction of Samsung Power OFF behaviour ([@RiRomain] - [#10907]) ([media_player.samsungtv docs])
|
||||
- Add Alpha Vantage sensor ([@fabaff] - [#10873]) ([sensor.alpha_vantage docs]) (new-platform)
|
||||
- Don't repeat getting receiver name on each update / pushed to denonavr 0.5.5 ([@scarface-4711] - [#10915]) ([media_player.denonavr docs])
|
||||
@ -300,7 +300,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
[@ziotibia81]: https://github.com/ziotibia81
|
||||
[ads docs]: /integrations/ads/
|
||||
[alarm_control_panel.egardia docs]: /integrations/egardia
|
||||
[alarm_control_panel.ialarm docs]: /integrations/ialarm
|
||||
[alarm_control_panel.manual docs]: /integrations/manual
|
||||
[alarm_control_panel.manual_mqtt docs]: /integrations/manual_mqtt/
|
||||
[alarm_control_panel.totalconnect docs]: /integrations/totalconnect
|
||||
|
||||
@ -243,7 +243,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
- Allow alexa to simply turn on and off climate components. ([@Parlane] - [#16989]) ([alexa docs])
|
||||
- Enable config flow for Luftdaten ([@fabaff] - [#17700]) ([luftdaten docs]) ([sensor.luftdaten docs]) (breaking change)
|
||||
- Adding current_humidity to attributes if its not None. ([@kennedyshead] - [#18261]) ([climate docs])
|
||||
- Add iAlarm "triggered" support ([@RyuzakiKK] - [#18263]) ([alarm_control_panel.ialarm docs])
|
||||
- Add iAlarm "triggered" support ([@RyuzakiKK] - [#18263])
|
||||
- Add support for switches in homekit controller ([@drndos] - [#17916]) ([homekit_controller docs])
|
||||
- Move more MQTT platforms to config entries ([@emontnemery] - [#18180]) ([lock docs]) ([mqtt docs]) ([light.mqtt_json docs]) ([lock.mqtt docs])
|
||||
- Switch OwnTracks HTTP to use webhook component ([@kirichkov] - [#17034]) ([device_tracker docs]) (breaking change)
|
||||
@ -671,7 +671,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
[@ultrara1n]: https://github.com/ultrara1n
|
||||
[@vetegrodd]: https://github.com/vetegrodd
|
||||
[@w1ll1am23]: https://github.com/w1ll1am23
|
||||
[alarm_control_panel.ialarm docs]: /integrations/ialarm
|
||||
[alarm_control_panel.lupusec docs]: /integrations/lupusec
|
||||
[alarm_control_panel.manual_mqtt docs]: /integrations/manual_mqtt/
|
||||
[alarm_control_panel.totalconnect docs]: /integrations/totalconnect
|
||||
|
||||
@ -125,7 +125,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
- update edp_redy version ([@abmantis] - [#19078])
|
||||
- Update Google Assistant services description and request sync timeout ([@edif30] - [#19113])
|
||||
- Fixed doorbird config without events (empty list) ([@basschipper] - [#19121]) ([doorbird docs])
|
||||
- Add code support for iAlarm ([@RyuzakiKK] - [#19124]) ([alarm_control_panel.ialarm docs])
|
||||
- Add code support for iAlarm ([@RyuzakiKK] - [#19124])
|
||||
- Upgrade youtube_dl to 2018.12.03 ([@fabaff] - [#19139]) ([media_extractor docs])
|
||||
- Upgrade mypy to 0.650 ([@scop] - [#19150])
|
||||
- Update geizhals dependency ([@tinloaf] - [#19152]) ([sensor.geizhals docs])
|
||||
@ -718,7 +718,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
[ads docs]: /integrations/ads/
|
||||
[air_pollutants docs]: /integrations/air_quality
|
||||
[air_quality docs]: /integrations/air_quality/
|
||||
[alarm_control_panel.ialarm docs]: /integrations/ialarm
|
||||
[alarm_control_panel.mqtt docs]: /integrations/alarm_control_panel.mqtt/
|
||||
[alarm_control_panel.ness_alarm docs]: /integrations/ness_alarm
|
||||
[alarm_control_panel.nx584 docs]: /integrations/nx584
|
||||
|
||||
@ -789,7 +789,7 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
- Move imports to top for gogogate2 ([@springstan] - [#29411]) ([gogogate2 docs])
|
||||
- Move imports to top for hydrawise ([@springstan] - [#29421]) ([hydrawise docs])
|
||||
- Move imports to top for ihc ([@springstan] - [#29425]) ([ihc docs])
|
||||
- Move imports to top for ialarm ([@springstan] - [#29422]) ([ialarm docs])
|
||||
- Move imports to top for ialarm ([@springstan] - [#29422])
|
||||
- Move imports to top for gitter ([@springstan] - [#29412]) ([gitter docs])
|
||||
- Move imports to top for homeworks ([@springstan] - [#29418]) ([homeworks docs])
|
||||
- Move imports to top for gpmdp ([@springstan] - [#29413]) ([gpmdp docs])
|
||||
@ -1574,7 +1574,6 @@ Experiencing issues introduced by this release? Please report them in our [issue
|
||||
[hue docs]: /integrations/hue/
|
||||
[hunterdouglas_powerview docs]: /integrations/hunterdouglas_powerview/
|
||||
[hydrawise docs]: /integrations/hydrawise/
|
||||
[ialarm docs]: /integrations/ialarm/
|
||||
[icloud docs]: /integrations/icloud/
|
||||
[idteck_prox docs]: /integrations/idteck_prox/
|
||||
[ifttt docs]: /integrations/ifttt/
|
||||
|
||||
1569
source/_posts/2020-11-18-release-118.markdown
Normal file
1569
source/_posts/2020-11-18-release-118.markdown
Normal file
File diff suppressed because it is too large
Load Diff
@ -93,7 +93,6 @@
|
||||
/components/alarm_control_panel.envisalink /integrations/envisalink
|
||||
/components/alarm_control_panel.homekit_controller /integrations/homekit_controller
|
||||
/components/alarm_control_panel.homematicip_cloud /integrations/homematicip_cloud
|
||||
/components/alarm_control_panel.ialarm /integrations/ialarm
|
||||
/components/alarm_control_panel.lupusec /integrations/lupusec
|
||||
/components/alarm_control_panel.manual /integrations/manual
|
||||
/components/alarm_control_panel.manual_mqtt /integrations/manual_mqtt
|
||||
@ -1435,7 +1434,6 @@
|
||||
/components/hunterdouglas_powerview /integrations/hunterdouglas_powerview
|
||||
/components/hydrawise /integrations/hydrawise
|
||||
/components/hyperion /integrations/hyperion
|
||||
/components/ialarm /integrations/ialarm
|
||||
/components/iaqualink /integrations/iaqualink
|
||||
/components/icloud /integrations/icloud
|
||||
/components/idteck_prox /integrations/idteck_prox
|
||||
|
||||
BIN
source/images/blog/2020-11-0.118/grid-card.png
Normal file
BIN
source/images/blog/2020-11-0.118/grid-card.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
BIN
source/images/blog/2020-11-0.118/header-footer-editor.png
Normal file
BIN
source/images/blog/2020-11-0.118/header-footer-editor.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
source/images/blog/2020-11-0.118/logbook-card.png
Normal file
BIN
source/images/blog/2020-11-0.118/logbook-card.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 60 KiB |
BIN
source/images/blog/2020-11-0.118/quickbar-navigate.png
Normal file
BIN
source/images/blog/2020-11-0.118/quickbar-navigate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 51 KiB |
BIN
source/images/blog/2020-11-0.118/social.png
Normal file
BIN
source/images/blog/2020-11-0.118/social.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 79 KiB |
BIN
source/images/blog/2020-11-0.118/supervisor-network.png
Normal file
BIN
source/images/blog/2020-11-0.118/supervisor-network.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 73 KiB |
BIN
source/images/lovelace/lovelace_grid.png
Normal file
BIN
source/images/lovelace/lovelace_grid.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.8 KiB |
Loading…
x
Reference in New Issue
Block a user