mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
4047313cb3
17
.github/stale.yml
vendored
17
.github/stale.yml
vendored
@ -1,17 +0,0 @@
|
||||
# Number of days of inactivity before an issue becomes stale
|
||||
daysUntilStale: 60
|
||||
# Number of days of inactivity before a stale issue is closed
|
||||
daysUntilClose: 7
|
||||
# Issues with these labels will never be considered stale
|
||||
exemptLabels:
|
||||
- has-parent
|
||||
- Help wanted
|
||||
# Label to use when marking an issue as stale
|
||||
staleLabel: Stale
|
||||
# Comment to post when marking an issue as stale. Set to `false` to disable
|
||||
markComment: >
|
||||
This issue has been automatically marked as stale because it has not had
|
||||
recent activity. It will be closed if no further activity occurs. Thank you
|
||||
for your contributions.
|
||||
# Comment to post when closing a stale issue. Set to `false` to disable
|
||||
closeComment: false
|
||||
19
.github/workflows/lock.yml
vendored
Normal file
19
.github/workflows/lock.yml
vendored
Normal file
@ -0,0 +1,19 @@
|
||||
name: Lock
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 * * * *"
|
||||
|
||||
jobs:
|
||||
lock:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: dessant/lock-threads@v2.0.1
|
||||
with:
|
||||
github-token: ${{ github.token }}
|
||||
issue-lock-inactive-days: "30"
|
||||
issue-exclude-created-before: "2020-10-01T00:00:00Z"
|
||||
issue-lock-reason: ""
|
||||
pr-lock-inactive-days: "1"
|
||||
pr-exclude-created-before: "2020-11-01T00:00:00Z"
|
||||
pr-lock-reason: ""
|
||||
36
.github/workflows/stale.yml
vendored
Normal file
36
.github/workflows/stale.yml
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
name: Stale
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 * * * *"
|
||||
|
||||
jobs:
|
||||
stale:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/stale@v3.0.13
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 60
|
||||
days-before-close: 7
|
||||
operations-per-run: 30
|
||||
remove-stale-when-updated: true
|
||||
stale-issue-label: "stale"
|
||||
exempt-issue-labels: "no-stale,Help%20wanted,help-wanted"
|
||||
stale-issue-message: >
|
||||
There hasn't been any activity on this issue recently. Due to the high number
|
||||
of incoming GitHub notifications, we have to clean some of the old issues,
|
||||
as many of them have already been resolved.
|
||||
|
||||
If this issue is still relevant, please let us know by leaving a comment 👍
|
||||
|
||||
This issue has now has been marked as stale and will be closed if no further
|
||||
activity occurs. Thank you for your contributions.
|
||||
stale-pr-label: "stale"
|
||||
exempt-pr-labels: "has-parent"
|
||||
stale-pr-message: >
|
||||
There hasn't been any activity on this pull request recently. This pull
|
||||
request has been automatically marked as stale because of that and will
|
||||
be closed if no further activity occurs within 7 days.
|
||||
|
||||
Thank you for your contributions.
|
||||
20
CODEOWNERS
20
CODEOWNERS
@ -12,6 +12,7 @@ source/_integrations/abode.markdown @shred86
|
||||
source/_integrations/accuweather.markdown @bieniu
|
||||
source/_integrations/acmeda.markdown @atmurray
|
||||
source/_integrations/adguard.markdown @frenck
|
||||
source/_integrations/advantage_air.markdown @Bre77
|
||||
source/_integrations/agent_dvr.markdown @ispysoftware
|
||||
source/_integrations/airly.markdown @bieniu
|
||||
source/_integrations/airvisual.markdown @bachya
|
||||
@ -70,7 +71,7 @@ source/_integrations/cisco_ios.markdown @fbradyirl
|
||||
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
|
||||
source/_integrations/cloudflare.markdown @ludeeus @ctalkington
|
||||
source/_integrations/comfoconnect.markdown @michaelarnauts
|
||||
source/_integrations/config.markdown @home-assistant/core
|
||||
source/_integrations/configurator.markdown @home-assistant/core
|
||||
@ -155,8 +156,8 @@ source/_integrations/goalzero.markdown @tkdrob
|
||||
source/_integrations/gogogate2.markdown @vangorra
|
||||
source/_integrations/google_assistant.markdown @home-assistant/cloud
|
||||
source/_integrations/google_cloud.markdown @lufton
|
||||
source/_integrations/google_translate.markdown @awarecan
|
||||
source/_integrations/gpsd.markdown @fabaff
|
||||
source/_integrations/gree.markdown @cmroche
|
||||
source/_integrations/greeneye_monitor.markdown @jkeljo
|
||||
source/_integrations/griddy.markdown @bdraco
|
||||
source/_integrations/group.markdown @home-assistant/core
|
||||
@ -267,7 +268,7 @@ source/_integrations/neato.markdown @dshokouhi @Santobert
|
||||
source/_integrations/nederlandse_spoorwegen.markdown @YarmoM
|
||||
source/_integrations/nello.markdown @pschmitt
|
||||
source/_integrations/ness_alarm.markdown @nickw444
|
||||
source/_integrations/nest.markdown @awarecan
|
||||
source/_integrations/nest.markdown @awarecan @allenporter
|
||||
source/_integrations/netatmo.markdown @cgtobi
|
||||
source/_integrations/netdata.markdown @fabaff
|
||||
source/_integrations/nexia.markdown @ryannazaretian @bdraco
|
||||
@ -295,7 +296,7 @@ source/_integrations/ohmconnect.markdown @robbiet480
|
||||
source/_integrations/ombi.markdown @larssont
|
||||
source/_integrations/omnilogic.markdown @oliver84 @djtimca @gentoosu
|
||||
source/_integrations/onboarding.markdown @home-assistant/core
|
||||
source/_integrations/onewire.markdown @garbled1
|
||||
source/_integrations/onewire.markdown @garbled1 @epenet
|
||||
source/_integrations/onvif.markdown @hunterjm
|
||||
source/_integrations/openerz.markdown @misialq
|
||||
source/_integrations/opengarage.markdown @danielhiversen
|
||||
@ -307,7 +308,6 @@ source/_integrations/orangepi_gpio.markdown @pascallj
|
||||
source/_integrations/oru.markdown @bvlaicu
|
||||
source/_integrations/ovo_energy.markdown @timmo001
|
||||
source/_integrations/ozw.markdown @cgarwood @marcelveldt @MartinHjelmare
|
||||
source/_integrations/panasonic_viera.markdown @joogps
|
||||
source/_integrations/panel_custom.markdown @home-assistant/frontend
|
||||
source/_integrations/panel_iframe.markdown @home-assistant/frontend
|
||||
source/_integrations/pcal9535a.markdown @Shulyaka
|
||||
@ -324,6 +324,7 @@ source/_integrations/plum_lightpad.markdown @ColinHarrington @prystupa
|
||||
source/_integrations/point.markdown @fredrike
|
||||
source/_integrations/poolsense.markdown @haemishkyd
|
||||
source/_integrations/powerwall.markdown @bdraco @jrester
|
||||
source/_integrations/profiler.markdown @bdraco
|
||||
source/_integrations/progettihwsw.markdown @ardaseremet
|
||||
source/_integrations/prometheus.markdown @knyar
|
||||
source/_integrations/proxmoxve.markdown @k4ds3 @jhollowe
|
||||
@ -345,7 +346,7 @@ source/_integrations/rainmachine.markdown @bachya
|
||||
source/_integrations/random.markdown @fabaff
|
||||
source/_integrations/rejseplanen.markdown @DarkFox
|
||||
source/_integrations/repetier.markdown @MTrab
|
||||
source/_integrations/rfxtrx.markdown @danielhiversen @elupus
|
||||
source/_integrations/rfxtrx.markdown @danielhiversen @elupus @RobBie1221
|
||||
source/_integrations/ring.markdown @balloob
|
||||
source/_integrations/risco.markdown @OnFreund
|
||||
source/_integrations/rmvtransport.markdown @cgtobi
|
||||
@ -353,6 +354,7 @@ source/_integrations/roku.markdown @ctalkington
|
||||
source/_integrations/roomba.markdown @pschmitt @cyr-ius @shenxn
|
||||
source/_integrations/roon.markdown @pavoni
|
||||
source/_integrations/rpi_power.markdown @shenxn @swetoast
|
||||
source/_integrations/ruckus_unleashed.markdown @gabe565
|
||||
source/_integrations/safe_mode.markdown @home-assistant/core
|
||||
source/_integrations/saj.markdown @fredericvl
|
||||
source/_integrations/salt.markdown @bjornorri
|
||||
@ -426,6 +428,7 @@ source/_integrations/tado.markdown @michaelarnauts @bdraco
|
||||
source/_integrations/tag.markdown @balloob @dmulcahey
|
||||
source/_integrations/tahoma.markdown @philklei
|
||||
source/_integrations/tankerkoenig.markdown @guillempages
|
||||
source/_integrations/tasmota.markdown @emontnemery
|
||||
source/_integrations/tautulli.markdown @ludeeus
|
||||
source/_integrations/tellduslive.markdown @fredrike
|
||||
source/_integrations/template.markdown @PhracturedBlue @tetienne
|
||||
@ -440,7 +443,7 @@ source/_integrations/tmb.markdown @alemuro
|
||||
source/_integrations/todoist.markdown @boralyl
|
||||
source/_integrations/toon.markdown @frenck
|
||||
source/_integrations/totalconnect.markdown @austinmroczek
|
||||
source/_integrations/tplink.markdown @rytilahti
|
||||
source/_integrations/tplink.markdown @rytilahti @thegardenmonkey
|
||||
source/_integrations/traccar.markdown @ludeeus
|
||||
source/_integrations/tradfri.markdown @ggravlingen
|
||||
source/_integrations/trafikverket_train.markdown @endor-force
|
||||
@ -485,6 +488,7 @@ source/_integrations/wled.markdown @frenck
|
||||
source/_integrations/wolflink.markdown @adamkrol93
|
||||
source/_integrations/workday.markdown @fabaff
|
||||
source/_integrations/worldclock.markdown @fabaff
|
||||
source/_integrations/xbox.markdown @hunterjm
|
||||
source/_integrations/xbox_live.markdown @MartinHjelmare
|
||||
source/_integrations/xiaomi_aqara.markdown @danielhiversen @syssi
|
||||
source/_integrations/xiaomi_miio.markdown @rytilahti @syssi @starkillerOG
|
||||
@ -496,7 +500,7 @@ source/_integrations/yeelight.markdown @rytilahti @zewelor @shenxn
|
||||
source/_integrations/yeelightsunflower.markdown @lindsaymarkward
|
||||
source/_integrations/yessssms.markdown @flowolf
|
||||
source/_integrations/yi.markdown @bachya
|
||||
source/_integrations/zeroconf.markdown @Kane610
|
||||
source/_integrations/zeroconf.markdown @bdraco
|
||||
source/_integrations/zerproc.markdown @emlove
|
||||
source/_integrations/zha.markdown @dmulcahey @adminiuga
|
||||
source/_integrations/zodiac.markdown @JulienTant
|
||||
|
||||
@ -107,7 +107,7 @@ GEM
|
||||
terminal-table (1.8.0)
|
||||
unicode-display_width (~> 1.1, >= 1.1.1)
|
||||
tilt (2.0.10)
|
||||
tzinfo (2.0.2)
|
||||
tzinfo (2.0.3)
|
||||
concurrent-ruby (~> 1.0)
|
||||
tzinfo-data (1.2020.4)
|
||||
tzinfo (>= 1.0.0)
|
||||
|
||||
@ -99,9 +99,9 @@ social:
|
||||
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 116
|
||||
current_patch_version: 4
|
||||
date_released: 2020-10-15
|
||||
current_minor_version: 117
|
||||
current_patch_version: 5
|
||||
date_released: 2020-11-05
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
@ -22,6 +22,8 @@
|
||||
description: "[Device trackers](/integrations/device_tracker) are used to track the presence, or location, of a device."
|
||||
- topic: Discovery
|
||||
description: "[Discovery](/integrations/discovery/) is the automatic setup of zeroconf/mDNS and uPnP devices after they are discovered."
|
||||
- topic: Domain
|
||||
description: "Entities and services belong to a domain, which is the first part of the entity or service, before the `.`. For example `light.kitchen` is an entity in the `light` domain, while `homeassistant.turn_on` is the `turn_on` service for the `homeassistant` domain."
|
||||
- topic: Entity
|
||||
description: "An [entity](/docs/configuration/platform_options/) is the representation of a function of a single device, unit, or web service. There may be multiple entities for a single device, unit, or web service, or there may be only one."
|
||||
- topic: Event
|
||||
|
||||
@ -22,20 +22,19 @@ Supported by MQTT discovery:
|
||||
- [Tag Scanners](/integrations/tag.mqtt/)
|
||||
- [Vacuums](/integrations/vacuum.mqtt/)
|
||||
|
||||
To enable MQTT discovery, add the following to your `configuration.yaml` file:
|
||||
MQTT discovery is enabled by default. To disable MQTT discovery, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mqtt:
|
||||
discovery: true
|
||||
discovery_prefix: homeassistant
|
||||
discovery: false
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
discovery:
|
||||
description: If the MQTT discovery should be enabled or not.
|
||||
required: false
|
||||
default: false
|
||||
default: true
|
||||
type: boolean
|
||||
discovery_prefix:
|
||||
description: The prefix for the discovery topic.
|
||||
@ -277,6 +276,7 @@ The following software has built-in support for MQTT discovery:
|
||||
- [IOTLink](https://iotlink.gitlab.io) (starting with 2.0.0)
|
||||
- [WyzeSense2MQTT](https://github.com/raetha/wyzesense2mqtt)
|
||||
- [MiFlora MQTT Daemon](https://github.com/ThomDietrich/miflora-mqtt-daemon)
|
||||
- [OpenMQTTGateway](https://github.com/1technophile/OpenMQTTGateway)
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ The MQTT integration will register the service `mqtt.publish` which allows publi
|
||||
| `topic` | no | Topic to publish payload to.
|
||||
| `payload` | yes | Payload to publish.
|
||||
| `payload_template` | yes | Template to render as payload value. Ignored if payload given.
|
||||
| `qos` | yes | Quality of Service to use.
|
||||
| `qos` | yes | Quality of Service to use. (default: 0)
|
||||
| `retain` | yes | If message should have the retain flag set. (default: false)
|
||||
|
||||
<div class='note'>
|
||||
|
||||
@ -3,92 +3,60 @@ title: "Z-Wave Devices - Adding and Removing"
|
||||
description: "How to add and remove Z-Wave devices."
|
||||
---
|
||||
|
||||
## Recommendation before adding any devices
|
||||
## Adding Devices
|
||||
|
||||
Z-Wave devices behave as a mesh and can store network relationship details on the device itself. This means used devices or even brand new devices could already be enrolled in another network, for example, a test network for a brand new device or a previous network for devices that aren't new. This could cause headaches when you're attempting to add/enrol the device to your network. It is recommended that if possible, perform a factory reset AND device perform exclusion or disenroll for the device you're attempting to add to Home Assistant. Steps can found further below on this page under "Removing Devices".
|
||||
To add a [Z-Wave device](/docs/z-wave/devices/):
|
||||
|
||||
## Adding Non-Secure Devices
|
||||
1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/).
|
||||
2. Click **Add Node** in the *Z-Wave Network Management* card, or **Add Node Secure** for secure devices like locks. This puts your [Z-Wave controller](/docs/z-wave/controllers/) in "inclusion" mode.
|
||||
3. Activate your device by following the instructions provided with it. Usually, this involves pressing a button.
|
||||
4. Make sure the device is in its final location, then click **Heal Network**. This is optional but helps optimize network speed.
|
||||
|
||||
To add (include) a non-secure Z-Wave [device](/docs/z-wave/devices/) to your system:
|
||||
|
||||
1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend
|
||||
2. Click the **Add Node** button in the *Z-Wave Network Management* card - this will place the controller in inclusion mode
|
||||
3. Activate your device to be included by following the instructions provided with the device
|
||||
4. With the device in its final location, run a *Heal Network*
|
||||
|
||||
Don't use this for [secure devices](/docs/z-wave/adding/#adding-secure-devices), since this is likely to limit the features the device supports.
|
||||
When you add a device, it may initially appear without a specific entity ID (e.g., `zwave.__`) or other identifying information. *Heal Network* should speed the process of populating this information. You *might* need to restart Home Assistant for the entity ID to appear.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
Don't use the OpenZWave control panel (OZWCP), **or the physical button on a controller**, to add or remove devices. Many devices will only send the information about their capabilities at the time you include them. If you use the OpenZWave control panel, or the button on a device, then Home Assistant won't have that information. Using the physical button on a controller will also result in a non-security inclusion being performed, which may limit the features the device supports.
|
||||
Some Z-Wave USB sticks have a physical "inclusion" button to add devices; **don't use it**. Likewise, don't add devices directly through other tools like [OpenZWave control panel](https://github.com/OpenZWave/open-zwave-control-panel). Many devices only send capabilities information at the time you add them, so if you add them outside of Home Assistant this information will be missing.
|
||||
|
||||
</div>
|
||||
|
||||
When you add a device, it may initially appear without a specific entity ID (e.g., `zwave.__`) and without other identifying information. Running a *Heal* should help speed this process up, and you'll need to run a *Heal* anyway so that all the devices in your Z-Wave network learn about the new device. You *might* need to restart Home Assistant (not reboot the system) to have the entity ID fully visible.
|
||||
|
||||
## Network Key
|
||||
|
||||
Security Z-Wave devices require a network key. Some devices only expose their full capabilities when included this way. You should always read the manual for your device to find out the recommended inclusion method. Note, secure devices that had been connected to another hub/network in the past may have a "theft protection" feature which requires to first exclude the device successfully from the previous hub using the previous hub/Software setup before it can be enrolled in a new hub/network.
|
||||
|
||||
A valid network key will be a 16 byte value, defined in the Z-Wave section of your configuration, such as the following example:
|
||||
|
||||
```yaml
|
||||
zwave:
|
||||
usb_path: /dev/ttyACM0
|
||||
network_key: "0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10"
|
||||
```
|
||||
|
||||
Each individual value in the defined key can be anywhere from 0x00 to 0xFF. Define your own key by making changes to the above example key or for additional security try one of the two scripts mentioned below.
|
||||
|
||||
### Network Key
|
||||
|
||||
An easy Linux script to generate a random key:
|
||||
(remember you can run this in Home Assistant OS or Supervised, you can use the Terminal Add-on)
|
||||
|
||||
```bash
|
||||
cat /dev/urandom | tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0x\1, /g' -e 's/, $//'
|
||||
```
|
||||
|
||||
On macOS, this script will generate a random key:
|
||||
|
||||
```bash
|
||||
cat /dev/urandom | LC_CTYPE=C tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0x\1, /g' -e 's/, $//'
|
||||
```
|
||||
|
||||
If the above command doesn't work then replace `LC_CTYPE=C` with `LC_ALL=C`:
|
||||
|
||||
```bash
|
||||
cat /dev/urandom | LC_ALL=C tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0x\1, /g' -e 's/, $//'
|
||||
```
|
||||
|
||||
<div class='note warning'>
|
||||
Ensure you keep a backup of this key. If you have to rebuild your system and don't have a backup of this key, you won't be able to reconnect to any security devices. This may mean you have to do a factory reset on those devices, and your controller, before rebuilding your Z-Wave network.
|
||||
</div>
|
||||
|
||||
## Adding Secure Devices
|
||||
|
||||
After defining your network key, follow these steps to add (include) a secure Z-Wave device:
|
||||
|
||||
1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/) in the Home Assistant frontend
|
||||
2. Click the **Add Node Secure** button in the *Z-Wave Network Management* card - this will place the controller in inclusion mode
|
||||
3. Activate your device to be included by following the instructions provided with the device
|
||||
4. With the device in its final location, run a *Heal Network*
|
||||
|
||||
<div class='note warning'>
|
||||
Secure devices require additional bandwidth, and too many secure devices can slow down your Z-Wave network. We recommend only using secure inclusion for devices that require it, such as locks.
|
||||
Secure devices require additional bandwidth; too many secure devices can slow down your Z-Wave network. We recommend only using secure inclusion for devices that require it, like locks or garage door openers.
|
||||
</div>
|
||||
|
||||
## Removing Devices
|
||||
|
||||
To remove (exclude) a Z-Wave device from your system:
|
||||
To remove a [Z-Wave device](/docs/z-wave/devices/):
|
||||
|
||||
1. Go to the Z-Wave control panel in the Home Assistant frontend. (Home Assistant > Configuration > Integrations > Z-Wave > Configure)
|
||||
2. Click the **Remove Node** button in the *Z-Wave Network Management* card - this will place the controller in exclusion mode
|
||||
3. Activate your device to be excluded by following the instructions provided with the device
|
||||
4. The device should now be removed, but that won't show until you restart Home Assistant. Look for a confirmation signal on the device if available, or confirm on the Home Assistant logs.
|
||||
5. Run a *Heal Network* so all the other nodes learn about its removal
|
||||
1. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/).
|
||||
2. Click **Remove Node** in the *Z-Wave Network Management* card. This puts your [Z-Wave controller](/docs/z-wave/controllers/) in "exclusion" mode.
|
||||
3. Activate your device by following the instructions provided with it. Usually, this involves pressing a button.
|
||||
4. The device should now be removed, but that won't show until you restart Home Assistant. Look for a confirmation signal on the device if available, or confirm in the Home Assistant logs.
|
||||
5. Click **Heal Network**. This is optional but helps optimize network speed.
|
||||
|
||||
If your device isn't responding to this process, possibly because you've factory reset it or it has failed, you can remove it using **Remove Failed Node**. This only works for devices marked as `"is_failed": true`, but you can trick the system into thinking that this the case:
|
||||
If your device isn't responding to this process, possibly because you've factory reset it or it has failed, you can remove it using **Remove Failed Node**.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Problems adding or removing devices?
|
||||
|
||||
### Already Added
|
||||
|
||||
If your device was previously added to another controller but not removed from it, **you must remove it before adding it to Home Assistant**.
|
||||
|
||||
1. **Remove the device from the old controller**, if possible. If your device was added to a different system (SmartThings, Wink, etc.) follow that system's instructions to remove the device. Then try adding the device to Home Assistant again.
|
||||
2. If you can't remove it from the old controller, **try removing the device using Home Assistant**. Follow the instructions in [Removing Devices](#removing-devices); even though it hasn't been added to Home Assistant yet, most Z-Wave devices will respond to exclusion mode from *any* controller. Then try adding the device to Home Assistant again. (Secure devices with a theft protection feature may not allow this.)
|
||||
3. If removing the device doesn't help, **try a factory reset** as a last resort. Check your device's manual for instructions.
|
||||
|
||||
### Range Issues
|
||||
|
||||
Normally you can add and remove devices as long as they are within range of any Z-Wave Plus device in your network, using a feature called [network-wide inclusion](https://z-wavealliance.org/z-wave_plus_certification/).
|
||||
|
||||
If you are using older non-Z-Wave Plus devices, your device may need to be within the range of your [controller](/docs/z-wave/controllers/) to be added or removed. If you cannot move the device (e.g., wall switches), you can try temporarily relocating your controller to be near your device. See the [Z-Wave Alliance documentation on Z-Wave Plus](https://z-wavealliance.org/z-wave_plus_certification/) for more information on how to determine if your devices support Z-Wave Plus.
|
||||
|
||||
### Forcibly Removing Devices
|
||||
|
||||
You can use the **Remove Failed Node** button to remove a failed device (e.g., because it is broken). In rare cases, you may want to remove a device that has *not* failed. This is not recommended but can help when a device has not been recognized as failed.
|
||||
|
||||
1. Go to the *States* menu under *Developer tools* in the Home Assistant frontend
|
||||
2. Click on the name of the `zwave.` entity you want to remove
|
||||
@ -101,13 +69,6 @@ If your device isn't responding to this process, possibly because you've factory
|
||||
```
|
||||
|
||||
5. Click **Set State**
|
||||
6. Go to the Z-Wave control panel in the Home Assistant frontend
|
||||
7. Click the **Remove Failed Node** button in the *Z-Wave Node Management* card
|
||||
6. Go to the [Z-Wave control panel](/docs/z-wave/control-panel/)
|
||||
7. Click **Remove Failed Node** in the *Z-Wave Node Management* card
|
||||
8. The device will now be removed, but that won't show until you restart Home Assistant
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Sometimes devices won't add to Home Assistant. There are a couple of possible problems.
|
||||
|
||||
1. You're not using all Z-Wave Plus devices, in which case the device can't use the mesh to be added, and must be in the same room as your controller.
|
||||
2. The device was previously added to another controller, and not removed. You'll need to follow the process above for removing devices first, then try adding it again.
|
||||
|
||||
@ -3,14 +3,17 @@ title: "Z-Wave Control Panel"
|
||||
description: "How to use the Z-Wave control panel."
|
||||
---
|
||||
|
||||
The Z-Wave control panel is available via **Configuration** → **Integrations** → **Z-Wave** → **Configure**.
|
||||
|
||||
* **No Z-Wave integration?** Follow the [set up instructions](/docs/z-wave/installation/) to enable it.
|
||||
* **Missing the *Configuration* button?** See the [configuration documentation](/integrations/config/) for instructions on enabling it.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
If you don't see the **Configuration** menu on the menubar, where you'll find the Z-Wave menu, [see here](/integrations/config/).
|
||||
The current Z-Wave integration will eventually be deprecated and replaced with a [new implementation based on OpenZWave Daemon](https://developers.home-assistant.io/blog/2020/02/04/new-zwave/); it's currently in beta, and you can [try it now](/integrations/ozw/).
|
||||
|
||||
</div>
|
||||
|
||||
Renaming Z-Wave entities is now done using the same [customization options](/docs/configuration/customizing-devices/) as for any other entity.
|
||||
|
||||
## Z-Wave Network Management
|
||||
|
||||
Here is where you [include and exclude](/docs/z-wave/adding/) Z-Wave devices from your network.
|
||||
@ -85,6 +88,8 @@ The **Polling intensity** says how many poll intervals this device is polled on.
|
||||
|
||||
You can also exclude a Z-Wave devices from Home Assistant. You can do that if you have a device that you need to have on the Z-Wave network, but you don't want it to appear in Home Assistant, or if you've got a device that's failed and you're unable to exclude it.
|
||||
|
||||
Renaming Z-Wave entities is done with the same [customization options](/docs/configuration/customizing-devices/) as any other entity in Home Assistant.
|
||||
|
||||
### Node Values
|
||||
|
||||
Contains a list of available values of the selected node, and it's instances.
|
||||
@ -161,3 +166,4 @@ for c in sys.argv[1]:
|
||||
If you want to only retrieve some lines at the end of the log, you can specify that with the selection field. Max is the last 1000 lines and minimum is 0 which equals the whole log. If this is not specified, you will retrieve the whole log.
|
||||
Select **Load** to open a new window with the static log.
|
||||
Select **Tail** to open a new window with a tailing log with the last specified lines of the log. This is a self updating window.
|
||||
|
||||
|
||||
@ -177,7 +177,7 @@ To provide Central Scene support you need to **stop your Z-Wave network** and mo
|
||||
|
||||
### Inovelli Scene Capable On/Off and Dimmer Wall Switches
|
||||
|
||||
For Inovelli switches, you'll need to update (or possibly add) the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
|
||||
For Inovelli switches, you'll need to update (or possibly add) the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg_*.xml` file with the following:
|
||||
|
||||
```xml
|
||||
<CommandClass id="91" name="COMMAND_CLASS_CENTRAL_SCENE" version="1" request_flags="4" innif="true" scenecount="0">
|
||||
@ -188,18 +188,13 @@ For Inovelli switches, you'll need to update (or possibly add) the `COMMAND_CLAS
|
||||
</CommandClass>
|
||||
```
|
||||
|
||||
Once this is complete, you should see the follow `zwave.scene_activated` events:
|
||||
For Inovelli LZW30-SN and LZW31-SN switches with a third button for configuration, you'll need to add a third scene for that under the COMMAND_CLASS_CENTRAL_SCENE CommandClass:
|
||||
|
||||
**Action**|**scene\_id**|**scene\_data**
|
||||
:-----:|:-----:|:-----:
|
||||
Double tap off|1|3
|
||||
Double tap on|2|3
|
||||
Triple tap off|1|4
|
||||
Triple tap on|2|4
|
||||
4x tap off|1|5
|
||||
4x tap on|2|5
|
||||
5x tap off|1|6
|
||||
5x tap on|2|6
|
||||
```xml
|
||||
<Value type="int" genre="user" instance="1" index="3" label="Config Button Scene" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="-2147483648" max="2147483647" value="3" />
|
||||
```
|
||||
|
||||
Once this is complete, `zwave.scene_activated` events will fire according to which button press you perform. For information on what button press corresponds to what scene_id and scene_data in the event, see [Inovelli Knowledge Base > How To: Setting Up Scenes In Home Assistant](https://support.inovelli.com/portal/en/kb/articles/how-to-setting-up-scenes-in-home-assistant).
|
||||
|
||||
### Zooz Scene Capable On/Off and Dimmer Wall Switches (Zen21v3 & Zen22v2 - Firmware 3.0+, Zen26 & Zen27 - Firmware 2.0+, Zen30 Double Switch)
|
||||
|
||||
|
||||
@ -18,7 +18,6 @@
|
||||
Advanced
|
||||
<ul>
|
||||
<li>{% active_link /hassio/commandline/ Command line %}</li>
|
||||
<li>{% active_link /hassio/zwave/ Z-Wave %}</li>
|
||||
<li>{% active_link /hassio/enable_i2c/ Enable I2C %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -8,6 +8,7 @@ ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@Bre77'
|
||||
ha_domain: advantage_air
|
||||
ha_quality_scale: platinum
|
||||
---
|
||||
|
||||
The Advantage Air integration allows you to control [Advantage Air](https://www.advantageair.com.au/) Air Conditioning controllers into Home Assistant.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Air Quality
|
||||
description: Instructions on how to add air quality sensors with Home Assistant
|
||||
ha_release: 0.85
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_domain: air_quality
|
||||
---
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.7.3
|
||||
ha_quality_scale: internal
|
||||
ha_domain: alarm_control_panel
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Home Assistant can give you an interface which is similar to a classic alarm system.
|
||||
|
||||
@ -4,7 +4,7 @@ description: This integration is responsible for providing the authentication en
|
||||
ha_category:
|
||||
- Other
|
||||
ha_release: 0.73
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
|
||||
@ -7,7 +7,7 @@ ha_release: 0.7
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_domain: automation
|
||||
---
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how-to setup binary sensors with Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
ha_release: 0.9
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_domain: binary_sensor
|
||||
---
|
||||
|
||||
@ -65,8 +65,8 @@ Normally accessing the Bluetooth stack is reserved for root, but running program
|
||||
|
||||
```bash
|
||||
sudo apt-get install libcap2-bin
|
||||
sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\``
|
||||
sudo setcap 'cap_net_raw+ep' `readlink -f \`which hcitool\``
|
||||
sudo setcap 'cap_net_raw,cap_net_admin+eip' $(readlink -f $(which python3))
|
||||
sudo setcap 'cap_net_raw+ep' $(readlink -f $(which hcitool))
|
||||
```
|
||||
|
||||
A restart of Home Assistant is required.
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to setup the browser integration with Home Assi
|
||||
ha_category:
|
||||
- Utility
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_domain: browser
|
||||
---
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Calendar
|
||||
description: Instructions on how to integrate calendars within Home Assistant.
|
||||
ha_release: 0.33
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_domain: calendar
|
||||
---
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.7
|
||||
ha_quality_scale: internal
|
||||
ha_domain: camera
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The camera integration allows you to use IP cameras with Home Assistant.
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.19
|
||||
ha_quality_scale: internal
|
||||
ha_domain: climate
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The Climate integration allows you to control and monitor HVAC (heating, ventilating, and air conditioning) devices and thermostats.
|
||||
|
||||
@ -7,7 +7,6 @@ ha_category:
|
||||
- Binary Sensor
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.31
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: concord232
|
||||
---
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to setup the configuration panel for Home Assis
|
||||
ha_category:
|
||||
- Front End
|
||||
ha_release: 0.39
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate the configurator in your component
|
||||
ha_category:
|
||||
- Other
|
||||
ha_release: 0.7
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
|
||||
@ -5,6 +5,7 @@ ha_category:
|
||||
- Voice
|
||||
ha_release: 0.7
|
||||
ha_quality_scale: internal
|
||||
ha_iot_class: Calculated
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: conversation
|
||||
|
||||
@ -8,7 +8,7 @@ ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: cover
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors.
|
||||
|
||||
@ -13,6 +13,7 @@ This integration is a meta-component and configures a default set of integration
|
||||
- [Automation](/integrations/automation/) (`automation`)
|
||||
- [Home Assistant Cloud](/integrations/cloud/) (`cloud`)
|
||||
- [Configuration](/integrations/config/) (`config`)
|
||||
- [Counter](/integrations/counter/) (`counter`)
|
||||
- [Frontend](/integrations/frontend/) (`frontend`)
|
||||
- [History](/integrations/history/) (`history`)
|
||||
- [Image](/integrations/image/) (`image`)
|
||||
@ -32,6 +33,7 @@ This integration is a meta-component and configures a default set of integration
|
||||
- [Sun](/integrations/sun/) (`sun`)
|
||||
- [System Health](/integrations/system_health/) (`system_health`)
|
||||
- [Tag](/integrations/tag/) (`tag`)
|
||||
- [Timer](/integrations/timer/) (`timer`)
|
||||
- [Updater](/integrations/updater/) (`updater`)
|
||||
- [Zero-configuration networking (zeroconf)](/integrations/zeroconf/) (`zeroconf`)
|
||||
- [Zone](/integrations/zone/) (`zone`)
|
||||
|
||||
@ -17,6 +17,7 @@ The `denonavr` platform allows you to control [Denon Network Receivers](https://
|
||||
Known supported devices:
|
||||
|
||||
- Denon AVR-X1000
|
||||
- Denon AVR-X1100W
|
||||
- Denon AVR-X1200W
|
||||
- Denon AVR-X1300W
|
||||
- Denon AVR-X1400H
|
||||
@ -35,6 +36,7 @@ Known supported devices:
|
||||
- Denon AVR-X4100W
|
||||
- Denon AVR-X4300H
|
||||
- Denon AVR-X4500H
|
||||
- Denon AVR-X6500H
|
||||
- Denon AVR-1912
|
||||
- Denon AVR-2312CI
|
||||
- Denon AVR-3311CI
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to setup device tracking within Home Assistant.
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
ha_release: 0.7
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_domain: device_tracker
|
||||
---
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to setup Home Assistant to discover new devices
|
||||
ha_category:
|
||||
- Other
|
||||
ha_release: 0.7
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_domain: discovery
|
||||
---
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to setup Fan devices within Home Assistant.
|
||||
ha_category:
|
||||
- Fan
|
||||
ha_release: 0.27
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_domain: fan
|
||||
---
|
||||
|
||||
@ -26,7 +26,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
- [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/)
|
||||
- [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/)
|
||||
- [FRITZ!Box 7490](https://en.avm.de/service/fritzbox/fritzbox-7490/overview/)
|
||||
- [FRITZ!Box 7430](https://en.avm.de/products/fritzbox/fritzbox-7430/)
|
||||
- [FRITZ!Box 7430](https://en.avm.de/service/fritzbox/fritzbox-7430/overview/)
|
||||
- [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/)
|
||||
- [FRITZ!DECT 301](https://en.avm.de/products/fritzdect/fritzdect-301/)
|
||||
- [Eurotronic Comet DECT](https://eurotronic.org/produkte/elektronische-heizkoerperthermostate/sparmatic-comet/)
|
||||
|
||||
@ -4,7 +4,7 @@ description: Offers a frontend to Home Assistant.
|
||||
ha_category:
|
||||
- Other
|
||||
ha_release: 0.7
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/frontend'
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
logo: geo_location.png
|
||||
ha_release: 0.78
|
||||
ha_domain: geo_location
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Geolocation aware entities are typically related to events in the real world in the vicinity of Home Assistant's location, like for example weather events, bush fires or earthquakes.
|
||||
|
||||
@ -25,19 +25,18 @@ The Google Assistant integration (without Home Assistant Cloud) requires a bit m
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/). If you haven't already configured that, you should do so before continuing. If you make DNS changes to accomplish this, please ensure you have allowed up to the full 48 hours for DNS changes to propagate, otherwise Google may not be able to reach your server.
|
||||
To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/). If you haven't already configured that, you should do so before continuing. If you make DNS changes to accomplish this, please ensure you have allowed up to the full 48 hours for DNS changes to propagate, otherwise, Google may not be able to reach your server. Once you have confirmed you can reach your Home Assistant from outside your home network, you can set up the Google integration:
|
||||
|
||||
</div>
|
||||
|
||||
You will need to create a service account [Create Service account key](https://console.cloud.google.com/apis/credentials/serviceaccountkey) which allows you to update devices without unlinking and relinking an account (see [below](#troubleshooting)). If you don't provide the service account, the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have set up this component, you will need to call this service (or command) each time you add a new device in Home Assistant that you wish to control via the Google Assistant integration. See Step 2 after the note for more details.
|
||||
|
||||
1. Create a new project in the [Actions on Google console](https://console.actions.google.com/).
|
||||
1. Click `New Project` and give your project a name.
|
||||
2. Click on the `Smart Home` card, then click the `Start Building` button.
|
||||
3. Click `Build your Action`, then click `Add Action(s)`.
|
||||
4. Add your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant` in the `Fulfillment URL` box, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / IP address and the port under which your Home Assistant is reachable.
|
||||
5. Click `Save`.
|
||||
6. Click on the `Overview` tab, which will lead you back to the app details screen.
|
||||
3. Click `Name your Smart Home action` under `Quick Setup` to give your Action a name - Home Assistant will appear in the Google Home app as `[test] <Action Name>`
|
||||
4. Click `Build your Action`, then click `Add Action(s)`.
|
||||
5. Add your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant` in the `Fulfillment URL` box, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / IP address and the port under which your Home Assistant is reachable.
|
||||
6. Click `Save`.
|
||||
7. Click on the `Overview` tab, which will lead you back to the app details screen.
|
||||
2. `Account linking` is required for your app to interact with Home Assistant.
|
||||
1. Set this up by clicking on `Setup account linking` under the `Quick Setup` section of the `Overview` page.
|
||||
2. If asked, leave options as they default `No, I only want to allow account creation on my website` and select `Next`.
|
||||
@ -65,30 +64,37 @@ If you've added Home Assistant to your phone's home screen, you have to first re
|
||||
|
||||
</div>
|
||||
|
||||
1. If you want to allow other household users to control the devices:
|
||||
1. Open the project you created in the [Actions on Google console](https://console.actions.google.com/).
|
||||
2. Click `Test` on the top of the page, then click `Simulator` located to the page left, then click the three little dots (more) icon in the upper right corner of the console.
|
||||
3. Click Manage user access. This redirects you to the Google Cloud Platform IAM permissions page.
|
||||
4. Click ADD at the top of the page.
|
||||
### Allow Other Users
|
||||
|
||||
If you want to allow other household users to control the devices:
|
||||
|
||||
1. Open the project you created in the [Actions on Google console](https://console.actions.google.com/).
|
||||
2. Click `Test` on the top of the page, then click `Simulator` located to the page left, then click the three little dots (more) icon in the upper right corner of the console.
|
||||
3. Click Manage user access. This redirects you to the Google Cloud Platform IAM permissions page.
|
||||
4. Click ADD at the top of the page.
|
||||
1. Enter the email address of the user you want to add.
|
||||
2. Click Select a role and choose Project < Viewer.
|
||||
3. Click SAVE
|
||||
2. Copy and share the link with the new user.
|
||||
3. When the new user opens the link with their own Google account, it will enable your draft test app under their account.
|
||||
3. Have the new user go to their `Google Assistant` app to add `[test] your app name` to their account.
|
||||
2. If you want to support actively reporting of state to Google's server (configuration option `report_state`) and support `google_assistant.request_sync`, you need to generate a service account.
|
||||
1. In the GCP Console, go to the [Create Service account key](https://console.cloud.google.com/apis/credentials/serviceaccountkey) page.
|
||||
2. At the top left of the page next to "Google Cloud Platform" logo, select your project created in the Actions on Google console. Confirm this by reviewing the `project_id` and it ensure it matches.
|
||||
3. From the Service account list, select New service account.
|
||||
4. In the Service account name field, enter a name.
|
||||
5. In the Service account ID field, enter an ID.
|
||||
6. From the Role list, select Service Accounts > Service Account Token Creator.
|
||||
7. For the Key type, select the JSON option.
|
||||
8. Click Create. A JSON file that contains your key downloads to your computer.
|
||||
9. Use the information in this file or the file directly to add to the `service_account` key in the configuration.
|
||||
10. Go to the [Google API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview).
|
||||
11. Select your project and click Enable HomeGraph API.
|
||||
4. Copy and share the link with the new user.
|
||||
5. When the new user opens the link with their own Google account, it will enable your draft test app under their account.
|
||||
5. Have the new user go to their `Google Assistant` app to add `[test] your app name` to their account.
|
||||
|
||||
### Enable Device Sync
|
||||
|
||||
If you want to support active reporting of state to Google's server (configuration option `report_state`) and synchronize Home Assistant devices with the Google Home app (`google_assistant.request_sync` service), you will need to create a service account. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have set up this component, you will need to call this service (or command) each time you add a new device in Home Assistant that you wish to control via the Google Assistant integration. This allows you to update devices without unlinking and relinking an account (see [below](#troubleshooting)).
|
||||
|
||||
1. In the GCP Console, go to the [Create Service account key](https://console.cloud.google.com/apis/credentials/serviceaccountkey) page.
|
||||
2. At the top left of the page next to "Google Cloud Platform" logo, select your project created in the Actions on Google console. Confirm this by reviewing the `project_id` and it ensure it matches.
|
||||
3. From the Service account list, select New service account.
|
||||
4. In the Service account name field, enter a name.
|
||||
5. In the Service account ID field, enter an ID.
|
||||
6. From the Role list, select Service Accounts > Service Account Token Creator.
|
||||
7. For the Key type, select the JSON option.
|
||||
8. Click Create. A JSON file that contains your key downloads to your computer.
|
||||
9. Use the information in this file or the file directly to add to the `service_account` key in the configuration.
|
||||
10. Go to the [Google API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview).
|
||||
11. Select your project and click Enable HomeGraph API.
|
||||
12. Try "OK Google, sync my devices" - the Google Home app should import your exposed Home Assistant devices and prompt you to assign them to rooms
|
||||
|
||||
### Configuration
|
||||
|
||||
|
||||
@ -5,8 +5,6 @@ ha_category:
|
||||
- Text-to-speech
|
||||
ha_release: 0.35
|
||||
ha_iot_class: Cloud Push
|
||||
ha_codeowners:
|
||||
- '@awarecan'
|
||||
ha_domain: google_translate
|
||||
---
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Gree
|
||||
title: Gree Climate
|
||||
description: Instructions on how to integrate Gree Smart devices within Home Assistant.
|
||||
ha_category:
|
||||
- Climate
|
||||
|
||||
@ -6,6 +6,8 @@ ha_category:
|
||||
ha_release: 0.23
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: hdmi_cec
|
||||
ha_codeowners:
|
||||
- '@newAM'
|
||||
---
|
||||
|
||||
The `hdmi_cec` integration provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
|
||||
|
||||
@ -8,7 +8,7 @@ ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: history
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The `history` integration will track everything that is going on within Home
|
||||
|
||||
@ -89,7 +89,7 @@ You can use the service `hive.boost_hot_water` to set your hot water to boost fo
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------- |
|
||||
| `entity_id` | no | String, Name of entity e.g., `water_heater.hot_water` |
|
||||
| `time_period` | yes | Time Period, Period of time the boost should last for e.g., `01:30:00`. |
|
||||
| `on_off` | no | String, The mode to set the boost to on or odd e.g., `on` |
|
||||
| `on_off` | no | String, The mode to set the boost to on or off e.g., `on` |
|
||||
|
||||
Examples:
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Reads the configuration files and checks them for correctness, but **does not**
|
||||
|
||||
### Service `homeassistant.reload_core_config`
|
||||
|
||||
Loads the main configuration file (`configuration.yaml`) and all linked files. Once loaded the new configuration is applied.
|
||||
Reloads the core configuration under `homeassistant:` and all linked files. Once loaded the new configuration is applied. New `customize:` information will be applied the next time the state of the entity gets updated.
|
||||
|
||||
### Service `homeassistant.restart`
|
||||
|
||||
|
||||
@ -292,7 +292,7 @@ Currently, this integration uses the `entity_id` to generate a unique `accessory
|
||||
|
||||
### Device Limit
|
||||
|
||||
The HomeKit Accessory Protocol Specification only allow a maximum of 150 unique accessories (`aid`) per bridge. Be mindful of this when configuring the filter(s). If you plan on exceeding the 150 device limit, it is possible to create multiple bridges. If you need specific configuration for some entities via `entity_config` be sure to add them to a bridge configured via `YAML`.
|
||||
The HomeKit Accessory Protocol Specification only allows a maximum of 150 unique accessories (`aid`) per bridge. Be mindful of this when configuring the filter(s). If you plan on exceeding the 150 devices limit, it is possible to create multiple bridges. If you need specific configuration for some entities via `entity_config` be sure to add them to a bridge configured via `YAML`.
|
||||
|
||||
### Persistence Storage
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ ha_domain: huawei_router
|
||||
|
||||
The `huawei` device tracker platform offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm).
|
||||
|
||||
Currently, this was only tested with the Huawei HG8247H, HS8247W and HG8247Q Smart Router (used by Vodafone Portugal).
|
||||
Currently, this was only tested with the Huawei HG8245W5, HG8247H, HS8247W and HG8247Q Smart Router (used by Vodafone Portugal).
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -67,9 +67,7 @@ More information can be found on the [Philips Hue API documentation](https://www
|
||||
|
||||
## Using Hue Scenes in Home Assistant
|
||||
|
||||
The Hue platform has its own concept of scenes for setting the colors of a group of lights simultaneously. Hue Scenes are very cheap, get created by all kinds of apps (as it is the only way to have 2 or more lights change at the same time), and are rarely deleted. A typical Hue hub might have hundreds of scenes stored in them—many that you've never used, and almost all very poorly named.
|
||||
|
||||
To avoid user interface overload, we don't expose scenes directly. Instead there is a `hue.hue_activate_scene` service which can be used in an automation or script.
|
||||
The Hue platform has its own concept of scenes for setting the colors of a group of lights simultaneously. A Hue bridge could potentially have dozens of scenes stored on it, and many scenes across different rooms might share the same name (the default scenes, for example). To avoid user interface overload, we don't expose scenes directly. Instead there is a `hue.hue_activate_scene` service which can be used in an automation or script.
|
||||
This will have all the bulbs transitioned at once, instead of one at a time like when using standard scenes in Home Assistant.
|
||||
|
||||
For instance:
|
||||
|
||||
@ -9,7 +9,7 @@ ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
- '@Shulyaka'
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The `humidifier` integration is built for the controlling and monitoring of humidifiers, dehumidifiers, and hygrostat devices.
|
||||
|
||||
@ -8,6 +8,7 @@ ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: image
|
||||
ha_quality_scale: internal
|
||||
ha_iot_class: ~
|
||||
---
|
||||
|
||||
The Image integration allows Home Assistant to handle image assets in Home Assistant, for example,
|
||||
|
||||
@ -5,6 +5,7 @@ ha_category:
|
||||
- Image Processing
|
||||
ha_release: 0.36
|
||||
ha_domain: image_processing
|
||||
ha_iot_class: ~
|
||||
---
|
||||
|
||||
Image processing enables Home Assistant to process images from [cameras](/integrations/#camera). Only camera entities are supported as sources.
|
||||
|
||||
@ -568,3 +568,33 @@ sensor:
|
||||
Note that when working with Flux queries, the resultset is broken into tables, you can see how this works in the Data Explorer of the UI. If you are operating on data created by the InfluxDB history component, this means by default, you will have a table for each entity and each attribute of each entity (other then `unit_of_measurement` and any others you promoted to tags).
|
||||
|
||||
This is a lot more tables compared to 1.xx queries, where you essentially had one table per `unit_of_measurement` across all entities. You can still create aggregate metrics across multiple sensors though. As you can see in the example above, a good way to do this is with the [keep](https://v2.docs.influxdata.com/v2.0/reference/flux/stdlib/built-in/transformations/keep/) or [drop](https://v2.docs.influxdata.com/v2.0/reference/flux/stdlib/built-in/transformations/drop/) filters. When you remove key columns Influx merges tables, allowing you to make many tables that share a schema for `_value` into one.
|
||||
|
||||
## Querying your data in Influx
|
||||
|
||||
### Sensors
|
||||
|
||||
For sensors with a unit of measurement defined the unit of measurement is used as the measurement name and entries are tagged with the second part of the `entity_id`. Therefore you need to add a WHERE clause to the query to filter out values.
|
||||
|
||||
For example a query on a `%` battery for `sensor.multi_sensor_battery_level`:
|
||||
|
||||
```sql
|
||||
SELECT * FROM "%" WHERE time > now() - 12h AND "entity_id" = 'multi_sensor_battery_level';
|
||||
```
|
||||
|
||||
Or for temperatures represented in `°C`:
|
||||
|
||||
```sql
|
||||
SELECT * FROM "°C" WHERE time > now() - 1h;
|
||||
```
|
||||
|
||||
### Everything else
|
||||
|
||||
Everything else can be queried using the `entity_id` as its measurement name.
|
||||
|
||||
```sql
|
||||
SELECT * FROM "binary_sensor.front_doorbell" WHERE time > now() - 24h;
|
||||
```
|
||||
|
||||
```sql
|
||||
SELECT "temperature" FROM "climate.kitchen" WHERE time > now() - 24h;
|
||||
```
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate the Input Boolean integration into
|
||||
ha_category:
|
||||
- Automation
|
||||
ha_release: 0.11
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate the Input Datetime integration int
|
||||
ha_category:
|
||||
- Automation
|
||||
ha_release: 0.55
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate the Input Number integration into
|
||||
ha_category:
|
||||
- Automation
|
||||
ha_release: 0.55
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate the Input Select integration into
|
||||
ha_category:
|
||||
- Automation
|
||||
ha_release: 0.13
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to integrate the Input Text integration into Ho
|
||||
ha_category:
|
||||
- Automation
|
||||
ha_release: 0.53
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: pre 0.7
|
||||
ha_quality_scale: internal
|
||||
ha_domain: light
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
This integration allows you to track and control various light bulbs. Read the integration documentation for your particular light hardware to learn how to enable it.
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Lightwave
|
||||
description: Instructions on how to integrate Lightwave devices with Home Assistant.
|
||||
logo: lightwave.png
|
||||
ha_category:
|
||||
- Hub
|
||||
- Light
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.9
|
||||
ha_quality_scale: internal
|
||||
ha_domain: lock
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Keeps track which locks are in your environment, their state and allows you to control them.
|
||||
|
||||
@ -5,7 +5,7 @@ ha_category:
|
||||
- History
|
||||
ha_release: 0.7
|
||||
ha_domain: logbook
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
<img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" />
|
||||
|
||||
@ -3,7 +3,7 @@ title: Mailbox
|
||||
description: Instructions on how to setup your mailboxes with Home Assistant.
|
||||
ha_release: 0.51
|
||||
ha_domain: mailbox
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Mailboxes provide a list of messages with short information about each. Mailbox messages appear on a separate panel in the frontend.
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.56
|
||||
ha_quality_scale: internal
|
||||
ha_domain: map
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
This offers a map on the frontend to display the location of tracked devices. To set up tracked devices, look at the [device tracker](/integrations/device_tracker/) documentation. This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.7
|
||||
ha_quality_scale: internal
|
||||
ha_domain: media_player
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Interacts with media players on your network.
|
||||
|
||||
@ -8,8 +8,7 @@ ha_release: 0.57
|
||||
ha_domain: microsoft
|
||||
---
|
||||
|
||||
The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API.
|
||||
You will need an API key, which is free. You can use your [Azure subscription](https://azure.microsoft.com) or get an API key on the [Cognitive Services site](https://azure.microsoft.com/en-us/try/cognitive-services/).
|
||||
The `microsoft` text-to-speech platform uses the [TTS engine of the Microsoft Speech Service](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/text-to-speech) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Microsoft Speech API. For this integration to work, you need a free API key. You can use your [Azure subscription](https://azure.microsoft.com) to create an [Azure Speech resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices/).
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -12,6 +12,7 @@ ha_release: 0.7
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@awarecan'
|
||||
- '@allenporter'
|
||||
ha_domain: nest
|
||||
---
|
||||
|
||||
@ -110,7 +111,7 @@ Once your developer account is set up and you have a valid `nest` entry in `conf
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- See [No URL Available](https://www.home-assistant.io/more-info/no-url-available) for guidance on setup issues related to URLs.
|
||||
- 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
|
||||
|
||||
@ -318,7 +319,9 @@ script:
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
- If you're getting [rickrolled](https://www.youtube.com/watch?v=dQw4w9WgXcQ) instead of being able to see your Nest cameras, you may not have set up your developer account's permissions correctly. Go back through and make sure you've selected read/write under every category that it's an option.
|
||||
- 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.
|
||||
|
||||
- If you're getting [rickrolled](https://www.youtube.com/watch?v=dQw4w9WgXcQ) by the Legacy API instead of being able to see your Nest cameras, you may not have set up your developer account's permissions correctly. Go back through and make sure you've selected read/write under every category that it's an option.
|
||||
|
||||
## Platforms
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: notify
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The `notify` integration makes it possible to send notifications to a wide variety of platforms. To use it you have to setup at least one notification target (notifier), check the [integrations list](/integrations/#notifications) for one that fits your use case.
|
||||
|
||||
@ -21,6 +21,12 @@ To get the station ID for any NSW fuel station you will need to:
|
||||
- In the Fuel Check App, search for your postcode or click "Fuel Near Me".
|
||||
- In the developer console, you should see a request to `/FuelCheckApp/v1/fuel/prices/bylocation`. Open this request and preview the response. Find the station you wish to add, and copy down the `ServiceStationID` field.
|
||||
|
||||
Alternatively:
|
||||
|
||||
- Select a station you wish to find the ID for.
|
||||
- Select "Report this Station".
|
||||
- In the URL of the new page opened, locate `serviceStationId`.
|
||||
|
||||
## Configuration
|
||||
|
||||
To add the NSW fuel station price sensor to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: OhmConnect
|
||||
description: Documentation about the OhmConnect sensor.
|
||||
logo: ohmconnect.png
|
||||
ha_category:
|
||||
- Energy
|
||||
ha_iot_class: Cloud Polling
|
||||
|
||||
@ -8,7 +8,7 @@ ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: onboarding
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
This integration creates the endpoints for the onboarding that is built into Home Assistant. There are no configuration options for this integration directly.
|
||||
|
||||
@ -8,6 +8,7 @@ ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@garbled1'
|
||||
- '@epenet'
|
||||
ha_domain: onewire
|
||||
---
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ description: Instructions on how to integrate a ONVIF camera within Home Assista
|
||||
ha_category:
|
||||
- Camera
|
||||
ha_release: 0.47
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: onvif
|
||||
ha_codeowners:
|
||||
- '@hunterjm'
|
||||
|
||||
@ -8,23 +8,23 @@ ha_release: 0.36
|
||||
ha_domain: openalpr_local
|
||||
---
|
||||
|
||||
[OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
|
||||
to process license plates from a camera. You can use them to open a garage door
|
||||
or trigger any other [automation](/integrations/automation/).
|
||||
The [OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you
|
||||
to process vehicle license plates from a camera. You can use this information to
|
||||
trigger [automations](/integrations/automation/) like opening a garage door.
|
||||
|
||||
For using the result inside an automation rule, take a look at the
|
||||
[component](/integrations/image_processing) page.
|
||||
[image processing integration](/integrations/image_processing) page.
|
||||
|
||||
## Local installation
|
||||
|
||||
If you want process all data locally, you need version 2.3.1 or higher of the
|
||||
`alpr` commandline tool.
|
||||
If you want process all data locally, you will need version 2.3.1 or higher of the
|
||||
`alpr` command line tool.
|
||||
|
||||
If you don't find binaries for your distribution you can compile from source.
|
||||
If you don't find binaries for your distribution, you can compile the tool from source.
|
||||
Documentation of how to build OpenALPR is found
|
||||
[here](https://github.com/openalpr/openalpr/wiki).
|
||||
|
||||
On a Debian system you can use this `cmake` command to build only the command
|
||||
On a Debian system you can use the following `cmake` command to build only the command
|
||||
line tool:
|
||||
|
||||
```bash
|
||||
@ -32,10 +32,10 @@ cmake -DWITH_TEST=FALSE -DWITH_BINDING_JAVA=FALSE --DWITH_BINDING_PYTHON=FALSE \
|
||||
--DWITH_BINDING_GO=FALSE -DWITH_DAEMON=FALSE -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
|
||||
```
|
||||
|
||||
For other operating system please refer to the
|
||||
For other operating systems, please refer to the
|
||||
[OpenALPR wiki](https://github.com/openalpr/openalpr/wiki).
|
||||
|
||||
Verify your `alpr` installation with:
|
||||
Verify your `alpr` installation with a command like the following:
|
||||
|
||||
```bash
|
||||
wget -O- -q http://plates.openalpr.com/h786poj.jpg | alpr -
|
||||
@ -54,7 +54,7 @@ image_processing:
|
||||
|
||||
{% configuration %}
|
||||
region:
|
||||
description: Country or region. List of supported [values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
|
||||
description: Country or region. List of [supported values](https://github.com/openalpr/openalpr/tree/master/runtime_data/config).
|
||||
required: true
|
||||
type: string
|
||||
alpr_bin:
|
||||
@ -63,7 +63,7 @@ alpr_bin:
|
||||
type: string
|
||||
default: alpr
|
||||
confidence:
|
||||
description: The minimum of confidence in percent to process with Home Assistant.
|
||||
description: The minimum confidence in percent to process with Home Assistant.
|
||||
required: false
|
||||
type: integer
|
||||
default: 80
|
||||
@ -73,7 +73,7 @@ source:
|
||||
type: list
|
||||
keys:
|
||||
entity_id:
|
||||
description: A camera entity id to get picture from.
|
||||
description: A camera entity id to get the picture from.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
|
||||
@ -6,8 +6,6 @@ ha_category:
|
||||
ha_release: 0.17
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: panasonic_viera
|
||||
ha_codeowners:
|
||||
- '@joogps'
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
@ -98,31 +96,32 @@ script:
|
||||
|
||||
- TC-P50ST50
|
||||
- TC-P55ST50
|
||||
- TC-P60ST50 (can't power on)
|
||||
- TC-P60S60
|
||||
- TC-P60ST50 (can't power on)
|
||||
- TC-P65VT30
|
||||
- TH-32ES500
|
||||
- TH-P60ST50A
|
||||
- TX-32AS520E
|
||||
- TX-32DSX609
|
||||
- TX-40CXE720
|
||||
- TX-40DX600
|
||||
- TX-40DX700B
|
||||
- TX-42AS650
|
||||
- TX-49DX650B
|
||||
- TX-50DX700B
|
||||
- TX-55CX700E
|
||||
- TX-55ASM655
|
||||
- TX-55ASW654
|
||||
- TX-55CX680B
|
||||
- TX-55CX700E
|
||||
- TX-55EXW584
|
||||
- TX-55EXW604S
|
||||
- TX-55FX680W
|
||||
- TX-55FZ802B
|
||||
- TX-58DX700B
|
||||
- TX-65EXW784
|
||||
- TX-L42ET50
|
||||
- TX-P42STW50
|
||||
- TX-P50GT30Y
|
||||
- TX-P50GT60E
|
||||
- TH-32ES500
|
||||
- TX-42AS650
|
||||
- TX-55ASW654
|
||||
- TX-55FX680W
|
||||
- TX-55FZ802B
|
||||
- TX-55ASM655
|
||||
|
||||
If your model is not on the list, give it a test. If everything works correctly, then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/panasonic_viera.markdown).
|
||||
|
||||
@ -8,7 +8,7 @@ ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/frontend'
|
||||
ha_domain: panel_custom
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The `panel_custom` support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar if wished and can be highly customized. See the developer documentation on [instructions how to build your own panels](https://developers.home-assistant.io/docs/frontend/custom-ui/creating-custom-panels/).
|
||||
|
||||
@ -6,6 +6,9 @@ ha_category:
|
||||
ha_release: 0.117
|
||||
ha_quality_scale: internal
|
||||
ha_domain: profiler
|
||||
ha_codeowners:
|
||||
- '@bdraco'
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
The Profiler integration provides a profile which is a set of statistics that identifies how much time each part of Home Assistant is taking. It can help track down a performance issue or provide insight about a misbehaving integration.
|
||||
|
||||
@ -7,7 +7,7 @@ ha_category:
|
||||
ha_release: 0.13
|
||||
ha_quality_scale: internal
|
||||
ha_domain: proximity
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The `proximity` integration allows you to monitor the proximity of devices to a particular [zone](/integrations/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data.
|
||||
|
||||
@ -1,12 +1,10 @@
|
||||
---
|
||||
title: Pushsafer
|
||||
description: Instructions on how to add Pushsafer notifications to Home Assistant.
|
||||
logo: pushsafer.png
|
||||
ha_category:
|
||||
- Notifications
|
||||
ha_iot_class: Cloud Push
|
||||
ha_release: 0.39
|
||||
ha_iot_class: Cloud Push
|
||||
ha_domain: pushsafer
|
||||
---
|
||||
|
||||
|
||||
@ -25,8 +25,8 @@ They will be automatically added if the Rachio integration integration is loaded
|
||||
## Getting your Rachio API Key
|
||||
|
||||
1. Log in at [https://app.rach.io/](https://app.rach.io/).
|
||||
2. Click the "Account Settings" menu item at the bottom of the left sidebar
|
||||
3. Click "Get API Key"
|
||||
2. Go to **Settings**.
|
||||
3. Click **Get API Key**.
|
||||
4. Copy the API key from the dialog that opens.
|
||||
|
||||
<div class='note'>
|
||||
@ -53,7 +53,7 @@ api_key:
|
||||
required: true
|
||||
type: string
|
||||
manual_run_mins:
|
||||
description: For how long, in minutes, to turn on a station when the switch is enabled.
|
||||
description: Duration in minutes to run when activating a zone switch.
|
||||
required: false
|
||||
default: 10
|
||||
type: integer
|
||||
|
||||
@ -11,7 +11,7 @@ ha_domain: raspyrfm
|
||||
|
||||
The `raspyrfm` integration adds support for cheap RC 433 MHz outlets via one of the supported gateways.
|
||||
|
||||
Initially, this integration was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir though like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM/blob/master/connair.py) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi.
|
||||
Initially, this integration was created to support the Simple Solutions `ConnAir` gateway which has been discontinued. There are custom alternatives that reimplemented the protocol used by the ConnAir gateway like this [ConnAir emulator](https://github.com/Phunkafizer/RaspyRFM#connairpy) which can be used in conjunction with the [RaspyRFM-II](https://www.seegel-systeme.de/produkt/raspyrfm-ii) RC module for a Raspberry Pi.
|
||||
|
||||
Other vendors of 433 MHz RC outlets have also created gateways that use a very similar protocol and can also be used with this integration like the Intertechno [ITGW-433 LAN Gateway](https://www.intertechno24.de/LAN-Gateway/Gateway-ITGW-433.html).
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: Remote
|
||||
description: Instructions on how to setup your remotes with Home Assistant.
|
||||
ha_release: 0.34
|
||||
ha_domain: remote
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Keeps track which remotes are in your environment, their state and allows you to control them.
|
||||
|
||||
@ -14,7 +14,7 @@ ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@danielhiversen'
|
||||
- '@elupus'
|
||||
- '@Robbie1221'
|
||||
- '@RobBie1221'
|
||||
ha_domain: rfxtrx
|
||||
---
|
||||
|
||||
@ -36,10 +36,12 @@ To receive debug logging from the RFXCOM device, add the following lines to `con
|
||||
|
||||
```yaml
|
||||
logger:
|
||||
log:
|
||||
logs:
|
||||
RFXtrx: debug
|
||||
```
|
||||
|
||||
**Please note**: `RFXtrx` is case-sensitive.
|
||||
|
||||
## Supported protocols
|
||||
|
||||
Not all protocols as advertised are enabled on the initial setup of your transceiver. Enabling all protocols is not recommended either. Your 433.92 product not showing in the logs? Visit the RFXtrx website to [download RFXmgmr](http://www.rfxcom.com/epages/78165469.sf/en_GB/?ViewObjectPath=%2FShops%2F78165469%2FCategories%2FDownloads) and enable the required protocol.
|
||||
|
||||
@ -41,7 +41,6 @@ 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`
|
||||
|
||||
@ -11,11 +11,11 @@ ha_codeowners:
|
||||
ha_domain: ruckus_unleashed
|
||||
---
|
||||
|
||||
This platform allows you to connect to a [Ruckus Unleashed](https://support.ruckuswireless.com/product_families/19-ruckus-unleashed) router.
|
||||
This platform allows you to connect to a [Ruckus Unleashed](https://support.ruckuswireless.com/product_families/19-ruckus-unleashed) access point.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- **Presence Detection** - The platform will look at devices connected to the router and will create a `device_tracker` for each discovered device.
|
||||
- **Presence Detection** - The platform will look at devices connected to the access point and will create a `device_tracker` for each discovered device.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: scene
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
You can create scenes that capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red.
|
||||
|
||||
@ -8,7 +8,7 @@ ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: script
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The `script` integration allows users to specify a sequence of actions to be executed by Home Assistant. These are run when you turn the script on. The script integration will create an entity for each script and allow them to be controlled via services.
|
||||
@ -59,7 +59,7 @@ variables:
|
||||
type: map
|
||||
keys:
|
||||
PARAMETER_NAME:
|
||||
description: The value of the variable. Any YAML is valid.
|
||||
description: The value of the variable. Any YAML is valid. Templates can also be used to pass a value to the variable.
|
||||
type: any
|
||||
fields:
|
||||
description: Information about the parameters that the script uses; see the [Passing variables to scripts](#passing-variables-to-scripts) section below.
|
||||
|
||||
@ -4,11 +4,10 @@ description: Internal search module for Home Assistant.
|
||||
ha_category:
|
||||
- Other
|
||||
ha_release: 0.105
|
||||
ha_quality_scale: internal
|
||||
ha_codeowners:
|
||||
- '@home-assistant/core'
|
||||
ha_domain: search
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The `search` integration is an internally used integration by the
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.7
|
||||
ha_quality_scale: internal
|
||||
ha_domain: sensor
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Sensors are gathering information about states and conditions.
|
||||
|
||||
@ -85,7 +85,6 @@ The following attributes can be placed inside the `data` key of the service call
|
||||
| `username` | yes | The username of the Slack bot.
|
||||
| `icon` | yes | The icon of the Slack bot.
|
||||
| `file` | yes | A file to include with the message; see below.
|
||||
| `file` | yes | A file to include with the message; see below.
|
||||
| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in place of** the `message` (note that the `message` is required nonetheless).
|
||||
| `blocks_template` | yes | The same as `blocks`, but able to support [templates](https://www.home-assistant.io/docs/configuration/templating).
|
||||
|
||||
|
||||
@ -64,9 +64,9 @@ After completing the prerequisite steps above you are ready to setup the integra
|
||||
1. Select the SmartThings Location to add to Home Assistant.
|
||||
1. On the window that opens:
|
||||
1. Login with your SmartThings account (if not already logged in).
|
||||
1. Optionally change the display name and click 'Done' on the upper right of the screen.
|
||||
1. Optionally change the display name and click 'Done' at the bottom of the screen.
|
||||
1. Authorize the integration by clicking 'Allow' on the bottom right of the screen.
|
||||
1. Click 'Close Window' or close it manually if necessary.
|
||||
1. Click 'Close Window' or close it manually.
|
||||
1. Back in Home Assistant click 'Finish'.
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
@ -20,8 +20,8 @@ The Spotify media player integration allows you to control [Spotify](https://www
|
||||
- Spotify application configured for Home Assistant (see [below](#create-a-spotify-application))
|
||||
|
||||
<div class='note'>
|
||||
Spotify integrated media controls (pause, play, next, etc.) requires a Premium account.
|
||||
If you do not have a Premium account, the integration's frontend will not show the controls.
|
||||
Spotify integrated media controls (pause, play, next, etc.) require a Premium account.
|
||||
If you do not have a Premium account, the frontend will not show the controls.
|
||||
</div>
|
||||
|
||||
### Create a Spotify application
|
||||
@ -29,8 +29,8 @@ The Spotify media player integration allows you to control [Spotify](https://www
|
||||
- Login to [Spotify Developer](https://developer.spotify.com).
|
||||
- Visit the [My Applications](https://developer.spotify.com/my-applications/#!/applications) page.
|
||||
- Select **Create An App**. Enter any name and description.
|
||||
- Once your application is created, view it and copy your **Client ID** and **Client Secret**, which are used in the Home Assistant configuration file.
|
||||
- On the Spotify page, enter the **Edit Settings** dialog of your newly created application and add a *Redirect URI*:
|
||||
- Once your application is created, view it and copy your **Client ID** and **Client Secret**, which are used in the Home Assistant [configuration file below](#configuration).
|
||||
- Enter the **Edit Settings** dialog of your newly-created application and add a *Redirect URI*:
|
||||
- If you are not using SSL: `http://<your_home_assistant_url_or_local_ip>:<port>/auth/external/callback`
|
||||
- If you are using SSL: `https://<your_home_assistant_url_or_local_ip>:<port>/auth/external/callback`
|
||||
- Click **Save** after adding the URI.
|
||||
@ -52,18 +52,18 @@ spotify:
|
||||
|
||||
{% configuration %}
|
||||
client_id:
|
||||
description: Client ID from your Spotify application.
|
||||
description: Client ID from your Spotify Developer application.
|
||||
required: true
|
||||
type: string
|
||||
client_secret:
|
||||
description: Client Secret from your Spotify application.
|
||||
description: Client Secret from your Spotify Developer application.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Activating the Spotify integration
|
||||
|
||||
- Go to the **Configurations** page in the Home Assistant frontend.
|
||||
- Go to the **Configuration** page in the Home Assistant frontend.
|
||||
- Click on **Integrations**.
|
||||
- Click the orange **+** on the bottom-right.
|
||||
- Click on "Spotify".
|
||||
@ -72,7 +72,7 @@ client_secret:
|
||||
<div class='note'>
|
||||
|
||||
If you receive an `INVALID_CLIENT: Invalid redirect URI` error while trying to
|
||||
authenticate with your Spotify account, make sure to check the Redirect URI in
|
||||
authenticate with your Spotify account, check the Redirect URI in
|
||||
the address bar after adding the new integration. Compare this value with the
|
||||
Redirect URI defined in the Spotify Developer Portal.
|
||||
|
||||
@ -80,21 +80,32 @@ client_secret:
|
||||
|
||||
## Using multiple Spotify accounts
|
||||
|
||||
The integration support multiple Spotify accounts at once. You don't need to
|
||||
This integration supports multiple Spotify accounts at once. You don't need to
|
||||
create another Spotify application in the Spotify Developer Portal and no
|
||||
modification to the `configuration.yaml` file is needed. Multiple Spotify
|
||||
accounts can be linked to a _single_ Spotify application.
|
||||
|
||||
To add an additional Spotify account to Home Assistant, repeat _only_ the steps
|
||||
in the [Activating the Spotify integration](#activating-the-spotify-integration)
|
||||
section. However, make sure you go to the Spotify website and log out before
|
||||
you do so.
|
||||
To add an additional Spotify account to Home Assistant, go to the Spotify website and log out, then repeat _only_ the steps
|
||||
in the [Activating the Spotify integration](#activating-the-spotify-integration) section.
|
||||
|
||||
## URI Links for Playlists
|
||||
## Playing Spotify playlists
|
||||
|
||||
You can send playlists to Spotify using the `"media_content_type": "playlist"`, which is part of the
|
||||
[media_player.play_media](/integrations/media_player/#service-media_playerplay_media) service.
|
||||
The `media_content_id` can be obtained from the Spotify desktop-app by clicking on the more options ("...") next to the album art picture, selecting "share" and then "Copy Spotify URI" or "Copy Playlist Link" (also available in the Spotify phone and web app).
|
||||
[media_player.play_media](/integrations/media_player/#service-media_playerplay_media) service, for example:
|
||||
|
||||
```yaml
|
||||
# Example script to play playlist
|
||||
script:
|
||||
play_jazz_guitar:
|
||||
sequence:
|
||||
- service: media_player.play_media
|
||||
data:
|
||||
entity_id: media_player.spotify
|
||||
media_content_id: 'https://open.spotify.com/playlist/5xddIVAtLrZKtt4YGLM1SQ?si=YcvRqaKNTxOi043Qn4LYkg'
|
||||
media_content_type: playlist
|
||||
```
|
||||
|
||||
The `media_content_id` value can be obtained from the Spotify desktop app by clicking on the more options ("...") next to the album art picture, selecting "Share" and then "Copy Spotify URI" or "Copy Playlist Link" (also available in the Spotify phone and web app).
|
||||
|
||||
## Unsupported Devices
|
||||
|
||||
|
||||
@ -12,10 +12,9 @@ ha_codeowners:
|
||||
ha_domain: statistics
|
||||
---
|
||||
|
||||
The `statistics` sensor platform consumes the state from other sensors. It exports the `mean` value as state and the following values as attributes: `count`, `mean`, `median`, `stdev`, `variance`, `total`, `min_value`, `max_value`, `min_age`, `max_age`, `change`, `average_change` and `change_rate`. If it's a binary sensor then only state changes are counted.
|
||||
The `statistics` sensor platform consumes the state from other sensors. It exports the `mean` value as state and the following values as attributes: `count`, `mean`, `median`, `stdev`, `variance`, `total`, `min_value`, `max_value`, `min_age`, `max_age`, `change`, `average_change` and `change_rate`. If the source is a binary sensor then only state changes are counted.
|
||||
|
||||
If you are running the [recorder](/integrations/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/integrations/history/) component, this will automatically also start the `recorder` integration on startup.
|
||||
If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation.
|
||||
Assuming the [`recorder`](/integrations/recorder/) integration is running (either configured explicitly or as part of a meta-integration/dependency, e.g., [`default_config`](/integrations/default_config/), [`history`](/integrations/history/), etc.), historical sensor data is read from the database on startup and is available immediately after a restart of the platform. If the [`recorder`](/integrations/recorder/) integration is *not* running, it can take time for the sensor to start reporting data because some attribute calculations require more than one value.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.7
|
||||
ha_quality_scale: internal
|
||||
ha_domain: switch
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
Keeps track which switches are in your environment, their state and allows you to control them.
|
||||
|
||||
@ -6,7 +6,7 @@ ha_category:
|
||||
ha_release: 0.87
|
||||
ha_quality_scale: internal
|
||||
ha_domain: system_health
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
The System Health integration provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems.
|
||||
|
||||
@ -111,7 +111,7 @@ automation:
|
||||
event_type: system_log_event
|
||||
condition:
|
||||
condition: template
|
||||
value_template: '{{ "service" in trigger.event.data.message }}'
|
||||
value_template: '{{ "service" in trigger.event.data.message[0] }}'
|
||||
action:
|
||||
service: persistent_notification.create
|
||||
data:
|
||||
|
||||
@ -9,7 +9,7 @@ ha_codeowners:
|
||||
- '@dmulcahey'
|
||||
ha_domain: tag
|
||||
ha_quality_scale: internal
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
---
|
||||
|
||||
<p class='img'>
|
||||
|
||||
@ -14,12 +14,12 @@ ha_codeowners:
|
||||
ha_domain: tasmota
|
||||
---
|
||||
|
||||
This integration allows you to control Tasmota devices over MQTT.
|
||||
This integration allows you to control [Tasmota](https://tasmota.github.io/docs/) devices over MQTT.
|
||||
|
||||
## Requirements
|
||||
|
||||
- MQTT server and the [MQTT integration](/integrations/mqtt/) set up in Home Assistant.
|
||||
- Tasmota devices flashed with 9.0.0.3 or later
|
||||
- Tasmota devices flashed with pre-release version 9.0.0.3, or later.
|
||||
- Tasmota devices configured for native discovery (`SetOption19 0`)
|
||||
|
||||
## Limitations
|
||||
|
||||
@ -120,7 +120,7 @@ sensor:
|
||||
- platform: thethingsnetwork
|
||||
device_id: ha-demo
|
||||
values:
|
||||
sensor_value: unit of measurement
|
||||
current: ampere
|
||||
voltage: V
|
||||
```
|
||||
|
||||
|
||||
@ -10,6 +10,7 @@ ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@rytilahti'
|
||||
- '@thegardenmonkey'
|
||||
ha_domain: tplink
|
||||
---
|
||||
|
||||
@ -36,6 +37,7 @@ Plugs are type `switch` when autodiscovery has been disabled.
|
||||
- HS103
|
||||
- HS105
|
||||
- HS110 (This device is capable of reporting energy usage data to template sensors)
|
||||
- KP105
|
||||
|
||||
### Strip (Multi-Plug)
|
||||
|
||||
@ -140,7 +142,7 @@ Devices that are confirmed to support Consumption Reading;
|
||||
2. HS300
|
||||
|
||||
In order to get the power consumption readings from a TP-Link HS110 device, you'll have to create a [template sensor](/integrations/template/).
|
||||
In the example below, change all of the `my_tp_switch`'s to match your device's entity ID.
|
||||
In the example below, change all of the `my_tp_switch`'s to match your device's entity ID (without the domain). For example, if your entity is `switch.whale_heater` then replace `my_tp_switch` with `whale_heater`:
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
|
||||
@ -4,7 +4,7 @@ description: Instructions on how to set up Text-to-Speech (TTS) with Home Assist
|
||||
ha_category:
|
||||
- Text-to-speech
|
||||
ha_release: 0.35
|
||||
ha_iot_class: ~
|
||||
ha_iot_class:
|
||||
ha_codeowners:
|
||||
- '@pvizeli'
|
||||
ha_domain: tts
|
||||
|
||||
@ -8,7 +8,7 @@ ha_release: 0.59
|
||||
ha_domain: unifi_direct
|
||||
---
|
||||
|
||||
This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs form [Ubiquiti UniFi WAP](/integrations/unifi) because it doesn't require the UniFi controller software.
|
||||
This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ui.com/products/#unifi). This device tracker differs form [Ubiquiti UniFi](/integrations/unifi) because it doesn't require the UniFi controller software.
|
||||
|
||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user