mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
114e289ef1
60
.vscode/cSpell.json
vendored
60
.vscode/cSpell.json
vendored
@ -1,46 +1,92 @@
|
||||
// cSpell Settings
|
||||
// Contains additional words for our project
|
||||
{
|
||||
"version": "0.1",
|
||||
"version": "0.2",
|
||||
"language": "en",
|
||||
"words": [
|
||||
"aeotec",
|
||||
"Alexa",
|
||||
"arest",
|
||||
"autodiscovery",
|
||||
"autoheal",
|
||||
"automations",
|
||||
"balloob",
|
||||
"bloomsky",
|
||||
"bluesound",
|
||||
"Bluesound",
|
||||
"BTLE",
|
||||
"CEST",
|
||||
"Chromecast",
|
||||
"deCONZ",
|
||||
"Denon",
|
||||
"DSMR",
|
||||
"elif",
|
||||
"endcomment",
|
||||
"endconfiguration",
|
||||
"endfor",
|
||||
"endraw",
|
||||
"esphome",
|
||||
"Etekcity",
|
||||
"fitbit",
|
||||
"EventStream",
|
||||
"Everspring",
|
||||
"Fibaro",
|
||||
"Fitbit",
|
||||
"Flexit",
|
||||
"Frenck",
|
||||
"geolocation",
|
||||
"GPSLogger",
|
||||
"Harman",
|
||||
"hass",
|
||||
"Hass.io",
|
||||
"HassOS",
|
||||
"hcitool",
|
||||
"heos",
|
||||
"hikvision",
|
||||
"Hikvision",
|
||||
"HomeKit",
|
||||
"Homematic",
|
||||
"HVAC",
|
||||
"IBAN",
|
||||
"icloud",
|
||||
"IFTTT",
|
||||
"kardon",
|
||||
"Lutron",
|
||||
"macos",
|
||||
"Meteobridge",
|
||||
"Modbus",
|
||||
"Mosquitto",
|
||||
"Nabu Casa",
|
||||
"nginx",
|
||||
"Nijhof",
|
||||
"Nmap",
|
||||
"ohmconnect",
|
||||
"Onkyo",
|
||||
"paulus",
|
||||
"OpenZWave",
|
||||
"OwnTracks",
|
||||
"Paulus",
|
||||
"Powerwall",
|
||||
"Pushbullet",
|
||||
"Schoutsen",
|
||||
"SmartThings",
|
||||
"statestream",
|
||||
"templating",
|
||||
"timedelta",
|
||||
"TRÅDFRI",
|
||||
"Tuya",
|
||||
"UART",
|
||||
"utcnow",
|
||||
"wakeup",
|
||||
"waqi",
|
||||
"Webhook"
|
||||
"WLED",
|
||||
"worldclock",
|
||||
"Xiaomi",
|
||||
"Zigbee"
|
||||
],
|
||||
// flagWords - list of words to be always considered incorrect
|
||||
// This is useful for offensive words and common spelling errors.
|
||||
// For example "hte" should be "the"
|
||||
"flagWords": ["hte", "asssistant"],
|
||||
"flagWords": [
|
||||
"hte",
|
||||
"asssistant"
|
||||
],
|
||||
"enabledLanguageIds": [
|
||||
"asciidoc",
|
||||
"c",
|
||||
|
||||
@ -82,7 +82,7 @@ GEM
|
||||
pathutil (0.16.2)
|
||||
forwardable-extended (~> 2.6)
|
||||
public_suffix (4.0.6)
|
||||
racc (1.5.2)
|
||||
racc (1.6.0)
|
||||
rack (2.2.3)
|
||||
rack-protection (2.1.0)
|
||||
rack
|
||||
|
||||
2
Rakefile
2
Rakefile
@ -220,7 +220,7 @@ end
|
||||
|
||||
desc "Download data from the blueprint exchange @ community.home-assistant.io"
|
||||
task :blueprint_exchange_data do
|
||||
uri = URI('https://community.home-assistant.io/c/blueprints-exchange/53/l/top/all.json')
|
||||
uri = URI('https://community.home-assistant.io/c/blueprints-exchange/53/l/top.json?period=all')
|
||||
|
||||
remote_data = JSON.parse(Net::HTTP.get(uri))
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@
|
||||
- topic: Home Assistant Core
|
||||
description: Home Assistant Core is a Python program. It can be run on various operating systems and is the basis for Home Assistant. When people are talking about Home Assistant Core they usually refer to a standalone installation method that can be installed using a Virtual Environment or Docker. Home Assistant Core does not use the Home Assistant Supervisor.
|
||||
- topic: Home Assistant Supervised (Previously Hass.io)
|
||||
description: "[Home Assistant](/hassio/) is a full UI managed home automation ecosystem that runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes pre-installed on Home Assistant OS, but can be installed on any Linux system. It leverages Docker, which is managed by the Home Assistant Supervisor."
|
||||
description: "Home Assistant Supervised is a full UI managed home automation ecosystem that runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes pre-installed on Home Assistant OS, but can be installed on any Linux system. It leverages Docker, which is managed by the Home Assistant Supervisor."
|
||||
- topic: Home Assistant Supervisor
|
||||
description: "The Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, add-ons, itself and, if used, updating the Home Assistant Operating System."
|
||||
- topic: Home Assistant Operating System
|
||||
|
||||
@ -144,7 +144,7 @@ Assuming you have only the owner created though onboarding process, no other use
|
||||
|
||||
The Command Line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0).
|
||||
|
||||
This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. A compatible script for LDAP authentication is [this one](https://github.com/efficiosoft/ldap-auth-sh), for instance. Please note, this will only work when using the Home Assistant Core installation type.
|
||||
This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. A compatible script for LDAP authentication is [this one](https://github.com/bob1de/ldap-auth-sh), for instance. Please note, this will only work when using the Home Assistant Core installation type.
|
||||
|
||||
Here is a configuration example:
|
||||
|
||||
@ -202,6 +202,6 @@ If you don't specify any `auth_providers` section in the `configuration.yaml` fi
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
[Issue 16441](https://github.com/home-assistant/home-assistant/issues/16441): the legacy API password auth provider, won't be automatically configured if your API password is located in a package. This is because Home Assistant processes the `auth_provider` during the `core` section loading, which is earlier than the `packages` processing.
|
||||
[Issue 16441](https://github.com/home-assistant/core/issues/16441): the legacy API password auth provider, won't be automatically configured if your API password is located in a package. This is because Home Assistant processes the `auth_provider` during the `core` section loading, which is earlier than the `packages` processing.
|
||||
|
||||
</div>
|
||||
|
||||
@ -5,7 +5,7 @@ description: "Instructions on how to use the automation editor."
|
||||
|
||||
The automation editor is an easy way of creating and editing automations from the UI. This page uses the [Random sensor](/integrations/random#sensor) as an example, though any other sensor with a numeric value, can be used as well.
|
||||
|
||||
From the UI choose **{% my config %}** which is located in the sidebar, then click on **{% my automations %}** to go to the automation editor. Press the **+** sign in the lower right corner to get started. You will be presented with options to create the automation from a description or from a [blueprint](/automation/using_blueprints/).
|
||||
From the UI choose **{% my config %}** which is located in the sidebar, then click on **{% my automations %}** to go to the automation editor. Press the **+** sign in the lower right corner to get started. You will be presented with options to create the automation from a description or from a [blueprint](/docs/automation/using_blueprints/).
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/docs/automation-editor/create-automation.png' />
|
||||
|
||||
@ -16,8 +16,9 @@ Here's the summary of what you *must* do to secure your Home Assistant system:
|
||||
|
||||
If you want secure remote access, the easiest option is to use [Home Assistant cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about) the founders of Home Assistant.
|
||||
|
||||
Other options are to use TLS/SSL via the add-ons [Duck DNS integrating Let's Encrypt](/integrations/duckdns/) or [Let’s Encrypt](/docs/ecosystem/certificates/lets_encrypt/).
|
||||
To expose your instance to the internet, use a [VPN](https://pivpn.dev/), or an [SSH tunnel](/blog/2017/11/02/secure-shell-tunnel/). Make sure to expose the used port in your router.
|
||||
Another option is to use TLS/SSL via the add-on [Duck DNS](/integrations/duckdns/) integrating Let's Encrypt.
|
||||
|
||||
To expose your instance to the internet, use a [VPN](https://pivpn.io), or an [SSH tunnel](/blog/2017/11/02/secure-shell-tunnel/). Make sure to expose the used port in your router.
|
||||
|
||||
### Extras for manual installations
|
||||
|
||||
@ -26,4 +27,4 @@ As well as the above we advise that you consider the following to improve securi
|
||||
- For systems that use SSH set `PermitRootLogin no` in your sshd configuration (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. This is particularly important if you enable remote access to your SSH services.
|
||||
- Lock down the host following good practice guidance, for example:
|
||||
* [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-manual/index.en.html) (this also applies to Raspberry Pi OS)
|
||||
* [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/index), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf)
|
||||
* [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/security_guide/index), [CIS Red Hat Enterprise Linux 7 Benchmark](https://www.cisecurity.org/cis-benchmarks/)
|
||||
|
||||
@ -27,9 +27,9 @@ One of the most common problems with Home Assistant is an invalid `configuration
|
||||
|
||||
- The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8.
|
||||
- You can verify your configuration's YAML structure using [this online YAML parser](https://yaml-online-parser.appspot.com/) or [YAML Validator](https://codebeautify.org/yaml-validator/).
|
||||
- To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltstack.com/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well).
|
||||
- To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltproject.io/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well).
|
||||
|
||||
`configuration.yaml` does not allow multiple sections to have the same name. If you want to load multiple platforms for one component, you can append a [number or string](/getting-started/devices/#style-2-list-each-device-separately) to the name or nest them using [this style](/getting-started/devices/#style-1-collect-every-entity-under-the-parent):
|
||||
`configuration.yaml` does not allow multiple sections to have the same name. If you want to load multiple platforms for one component, you can append a [number or string](/docs/configuration/devices/#style-2-list-each-entity-separately) to the name or nest them using [this style](/docs/configuration/devices/#style-1-collect-every-entity-under-the-parent):
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
@ -49,11 +49,11 @@ If you find any errors or want to expand the documentation, please [let us know]
|
||||
|
||||
Almost all integrations have external dependencies to communicate with your devices and services. Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it should show up in `home-assistant.log`.
|
||||
|
||||
The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can't figure it out, please [report it](https://github.com/home-assistant/home-assistant/issues) so we can investigate what is going on.
|
||||
The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can't figure it out, please [report it](https://github.com/home-assistant/core/issues) so we can investigate what is going on.
|
||||
|
||||
#### Problems with integrations
|
||||
|
||||
It can happen that some integrations either do not work right away or stop working after Home Assistant has been running for a while. If this happens to you, please [report it](https://github.com/home-assistant/home-assistant/issues) so that we can have a look.
|
||||
It can happen that some integrations either do not work right away or stop working after Home Assistant has been running for a while. If this happens to you, please [report it](https://github.com/home-assistant/core/issues) so that we can have a look.
|
||||
|
||||
#### Multiple files
|
||||
|
||||
|
||||
@ -17,4 +17,6 @@ Home Assistant is an open platform and so home energy management is not restrict
|
||||
- [Integrate your gas consumption](/docs/energy/gas/)
|
||||
- [Integrate individual devices](/docs/energy/individual-devices/)
|
||||
|
||||
If you have a sensor that returns instantaneous power readings (W or kW), then to add a sensor that returns energy usage or generation (kWh) refer to [Riemann sum integral integration](/integrations/integration/#energy)
|
||||
|
||||
<img src='/images/docs/energy/energy-overview.png' alt='Visual representation of how all different energy forms relate.' style='border: 0;box-shadow: none;'>
|
||||
|
||||
@ -27,7 +27,7 @@ The best way to get this data is directly from your electricity meter that sits
|
||||
|
||||
The P1 port is a standardized port in the Netherlands, Belgium and Luxembourg. A P1 reader can connect to this port and receive real-time information.
|
||||
|
||||
We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to develop [SlimmeLezer](https://www.slimmelezer.nl). It's an affordable P1 reader powered by [ESPHome](https://esphome.io) that will seamlessly integrate this information in Home Assistant. It is being sold on [his website](https://www.slimmelezer.nl) and the firmware is open source [on GitHub](https://github.com/zuidwijk/dsmr).
|
||||
We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to develop [SlimmeLezer+](https://www.zuidwijk.com/product/slimmelezer-plus/). It's an affordable P1 reader powered by [ESPHome](https://esphome.io) that will seamlessly integrate this information in Home Assistant. It is being sold on [his website](https://www.zuidwijk.com/product/slimmelezer-plus/) and the firmware is open source [on GitHub](https://github.com/zuidwijk/dsmr).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ The best way to get this data is directly from your gas meter that sits between
|
||||
|
||||
The P1 port is a standardized port on electricity meters in the Netherlands, Belgium and Luxembourg which also provides gas consumption information. A P1 reader can connect to this port and receive real-time information.
|
||||
|
||||
We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to develop [SlimmeLezer](https://www.slimmelezer.nl). It's an affordable P1 reader powered by [ESPHome](https://esphome.io) that will seamlessly integrate this information in Home Assistant. It is being sold on [his website](https://www.slimmelezer.nl) and the firmware is open source [on GitHub](https://github.com/zuidwijk/dsmr).
|
||||
We have worked with creator [Marcel Zuidwijk](https://www.zuidwijk.com) to develop [SlimmeLezer+](https://www.zuidwijk.com/product/slimmelezer-plus/). It's an affordable P1 reader powered by [ESPHome](https://esphome.io) that will seamlessly integrate this information in Home Assistant. It is being sold on [his website](https://www.zuidwijk.com/product/slimmelezer-plus/) and the firmware is open source [on GitHub](https://github.com/zuidwijk/dsmr).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: "Integrating individual device energy usage"
|
||||
description: "Learn how to add information about individual device energy usage to Home Assistant home energy management."
|
||||
---
|
||||
|
||||
Home Assistant can integrate the energy usage of individual devices into Home Assistant. That way you can see the impact of individual devices on your total enery consumption.
|
||||
Home Assistant can integrate the energy usage of individual devices into Home Assistant. That way you can see the impact of individual devices on your total energy consumption.
|
||||
|
||||
## Hardware
|
||||
|
||||
@ -20,8 +20,8 @@ Smart relays sit behind your "normal" switches and make them smart. It allows yo
|
||||
{% comment %}
|
||||
We recommend the Shelly brand because they have a local API that updates Home Assistant as soon as something happens and it has a high quality integration:
|
||||
|
||||
- [Shelly 1PM](https://shop.shelly.cloud/shelly-1pm-wifi-smart-home-automation-1?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq)
|
||||
- [Shelly 2.5](https://shop.shelly.cloud/shelly-2.5-ce-ul-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq)
|
||||
- [Shelly 1PM](https://shop.shelly.cloud/shelly-1pm-wifi-smart-home-automation-1?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq)
|
||||
- [Shelly 2.5](https://shop.shelly.cloud/shelly-2.5-ce-ul-wifi-smart-home-automation?tracking=A7FsiPIfUWsFpnfKHa8SRyUYLXjr2hPq)
|
||||
{% endcomment %}
|
||||
|
||||
<img src='/images/docs/energy/devices.png' alt='Graphic showing energy flowing from the home to individual devices.' style='border: 0;box-shadow: none; display: block; max-height: 400px; margin: 0 auto;'>
|
||||
|
||||
@ -7,10 +7,11 @@ description: "Home Assistant's Glossary."
|
||||
|
||||
The glossary covers terms which are used around Home Assistant.
|
||||
|
||||
<ul>
|
||||
{% configuration_basic %}
|
||||
|
||||
{% for entry in entries %}
|
||||
<li>
|
||||
<b>{{ entry.topic }}</b>: {{ entry.description | markdownify }}
|
||||
</li>
|
||||
"{{ entry.topic }}":
|
||||
description: "{{ entry.description }}"
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
@ -304,7 +304,7 @@ Supported abbreviations for device registry configuration:
|
||||
|
||||
The following software has built-in support for MQTT discovery:
|
||||
|
||||
- [Arilux AL-LC0X LED controllers](https://github.com/mertenats/Arilux_AL-LC0X)
|
||||
- [Arilux AL-LC0X LED controllers](https://github.com/smrtnt/Arilux_AL-LC0X)
|
||||
- [ecowitt2mqtt](https://github.com/bachya/ecowitt2mqtt)
|
||||
- [ESPHome](https://esphome.io)
|
||||
- [ESPurna](https://github.com/xoseperez/espurna)
|
||||
|
||||
@ -17,18 +17,17 @@ ha_platforms:
|
||||
|
||||
The Rollease Acmeda Automate integration allows you to control and monitor covers via your Rolelase Acmeda Automate hub. The integrations communicates directly with hubs on the local network, rather than connecting via the cloud or via RS-485. Devices are represented as a cover for monitoring and control as well as a sensor for monitoring battery condition.
|
||||
|
||||
### Supported devices
|
||||
## Supported devices
|
||||
|
||||
- Automate Pulse Hub v1
|
||||
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
### Multiple hubs
|
||||
## Multiple hubs
|
||||
|
||||
Multiple hubs work transparently with discovery, so you don't have to do anything special to set them up.
|
||||
|
||||
### Caveats
|
||||
## Caveats
|
||||
|
||||
If the IP address for the hub changes, you will need to re-register it with Home Assistant again. To avoid this, you may set up a DHCP reservation on your router for your hub so that it always has the same IP address.
|
||||
|
||||
|
||||
@ -22,5 +22,4 @@ You'll need the Account ID (which can be found in the Adax Wifi app, pressing 'A
|
||||
3. Select “Add Credential”
|
||||
4. Give some name to the created credential and copy the generated password.
|
||||
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -38,7 +38,7 @@ Available services:
|
||||
`start_recording`, `stop_recording`,
|
||||
`turn_on`, `turn_off`, `toggle`, `enable_motion_detection`,`disable_motion_detection`
|
||||
|
||||
#### Service `enable_alerts`/`disable_alerts`
|
||||
### Service `enable_alerts`/`disable_alerts`
|
||||
|
||||
These services enable or disable the device's alert events within Agent DVR.
|
||||
|
||||
@ -46,7 +46,7 @@ Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
|
||||
|
||||
#### Service `start_recording`/`stop_recording`
|
||||
### Service `start_recording`/`stop_recording`
|
||||
|
||||
These services start or stop the device recording.
|
||||
|
||||
@ -54,7 +54,7 @@ Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
|
||||
|
||||
#### Service `turn_on`/`turn_off`/`toggle`
|
||||
### Service `turn_on`/`turn_off`/`toggle`
|
||||
|
||||
These services turn on, off or toggle the device enabled state within Agent DVR
|
||||
|
||||
@ -62,9 +62,9 @@ Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
|
||||
|
||||
|
||||
## IFrame
|
||||
- Using the Webpage Card you can embed the Agent DVR viewer directly in Home Assistant. Just point it to https://www.ispyconnect.com/app/
|
||||
|
||||
- Using the Webpage Card you can embed the Agent DVR viewer directly in Home Assistant. Just point it to <https://www.ispyconnect.com/app/>
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/agent_dvr.jpg' />
|
||||
|
||||
@ -6,9 +6,7 @@ ha_domain: air_quality
|
||||
ha_quality_scale: internal
|
||||
---
|
||||
|
||||
The `air_quality` base platform allows other integrations to process information
|
||||
about air quality and pollution details. It is used by integrations that provide
|
||||
an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).
|
||||
The `air_quality` base platform allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).
|
||||
|
||||
The platforms cover the following levels (if they are available):
|
||||
|
||||
|
||||
@ -18,7 +18,6 @@ Integrates Airthings sensors into Home Assistant.
|
||||
|
||||
[Airthings](https://www.airthings.com/) provide different sensors for measuring the air quality. The focus specially on Radon sensors.
|
||||
|
||||
|
||||
Login [here](https://dashboard.airthings.com/integrations/api-integration) to find your credentials.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -35,7 +35,7 @@ For example:
|
||||
|
||||
## Using an AirVisual Node/Pro Unit
|
||||
|
||||
The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; instructions here: https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba).
|
||||
The integration can communicate to Node/Pro units over the local network. You will need the IP address/hostname of the unit and its Samba password (which can be found on the unit; [instructions here](https://support.iqair.com/en/articles/3029331-download-the-airvisual-node-pro-s-data-using-samba)).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -45,9 +45,9 @@ In addition to using latitude and longitude, the AirVisual integration may be co
|
||||
|
||||
For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo > Sao Paulo`. Thus, the values to use in the UI would be:
|
||||
|
||||
* City: `Sao Paulo`
|
||||
* State: `Sao Paulo`
|
||||
* Country: `Brazil`
|
||||
- City: `Sao Paulo`
|
||||
- State: `Sao Paulo`
|
||||
- Country: `Brazil`
|
||||
|
||||
## Sensor Types
|
||||
|
||||
@ -96,12 +96,12 @@ Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](http
|
||||
|
||||
Node/Pro units will create a variety of sensors:
|
||||
|
||||
* Air Quality Index (AQI)
|
||||
* Battery Level
|
||||
* Carbon Dioxide (CO2)
|
||||
* Humidity
|
||||
* Particulate (<= 0.1 μm) (PM0.1)
|
||||
* Particulate (<= 2.5 μm) (PM2.5)
|
||||
* Particulate (<= 10 μm) (PM10)
|
||||
* Temperature
|
||||
* Volatile Organic Compounds (VOC)
|
||||
- Air Quality Index (AQI)
|
||||
- Battery Level
|
||||
- Carbon Dioxide (CO2)
|
||||
- Humidity
|
||||
- Particulate (<= 0.1 μm) (PM0.1)
|
||||
- Particulate (<= 2.5 μm) (PM2.5)
|
||||
- Particulate (<= 10 μm) (PM10)
|
||||
- Temperature
|
||||
- Volatile Organic Compounds (VOC)
|
||||
|
||||
@ -88,6 +88,7 @@ Next, you will need to set up the required IFTTT applets as listed below.
|
||||
This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm_home` and `alarm_arm_night`. For each of these services, an IFTTT webhook will be triggered.
|
||||
|
||||
For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those.
|
||||
|
||||
* **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system.
|
||||
* **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home.
|
||||
* **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away.
|
||||
|
||||
@ -191,7 +191,6 @@ The `chr(4)` and `chr(5)` sequences below are equivalent to pressing the <em>Sta
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
| Mode | Key Sequence |
|
||||
| ------------------------------------------------------- | ------------------------------ |
|
||||
| `alarm_arm_home` | `chr(4)` + `chr(4)` + `chr(4)` |
|
||||
|
||||
@ -269,6 +269,7 @@ alert:
|
||||
notifiers:
|
||||
- frank_telegram
|
||||
```
|
||||
|
||||
This particular example relies on the `inline_keyboard` functionality of
|
||||
Telegram, where the user is presented with buttons to execute certain actions.
|
||||
|
||||
|
||||
@ -101,7 +101,7 @@ First thing you need to do after sing in [AWS console](https://console.aws.amazo
|
||||
Next you need create a Lambda function.
|
||||
|
||||
- Click `Services` in top navigation bar, expand the menu to display all AWS services, click `Lambda` under `Compute` section to navigate to Lambda console. Or you may use this [link](https://console.aws.amazon.com/lambda/home)
|
||||
- **IMPORTANT - Alexa Skills are only supported in certain AWS reigons** Your current server location will be displayed on the top right corner (for example, Ohio), make sure you select the server closest to your location / region based on your Amazon account's country, whilst also ensuring that it is within one of the supported reigons for Alexa Skills otherwise this will not work!
|
||||
- **IMPORTANT - Alexa Skills are only supported in certain AWS regions** Your current server location will be displayed on the top right corner (for example, Ohio), make sure you select the server closest to your location / region based on your Amazon account's country, whilst also ensuring that it is within one of the supported regions for Alexa Skills otherwise this will not work!
|
||||
- **US East (N.Virginia)** region for English (US) or English (CA) skills
|
||||
- **EU (Ireland)** region for English (UK), English (IN), German (DE), Spanish (ES) or French (FR) skills
|
||||
- **US West (Oregon)** region for Japanese and English (AU) skills.
|
||||
@ -163,6 +163,7 @@ After your Home Assistant has restarted, go back to `AWS Lambda Console`, you ar
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- Click `Create` in the bottom right hand corner.
|
||||
|
||||
This test event is a `Discovery` directive, your Home Assistant instance will respond with a list of devices Alexa can interact with. This test data is lack of `token` in `payload.scope`, your Lambda function will read the `LONG_LIVED_ACCESS_TOKEN` from environment variable.
|
||||
|
||||
@ -23,7 +23,7 @@ Using this integration, customers can go a step further - setting up devices to
|
||||
|
||||
To use this integration, you will need to generate an API key.
|
||||
|
||||
1. Login to your Amber account at: https://app.amber.com.au
|
||||
1. Login to your Amber account at: <https://app.amber.com.au>
|
||||
2. Click _Settings_
|
||||
3. Enable _Developer Mode_
|
||||
4. Click _Generate API Key_
|
||||
|
||||
@ -162,7 +162,7 @@ If your system includes the Supervisor, this will also contain:
|
||||
|
||||
If enabled, a crash report will be collected when an unexpected error occurs and uploaded to [Sentry](https://sentry.io). These reports will help fix bugs and improve performance and stability.
|
||||
|
||||
Crash reports are only visible to the Home Assistant Core developers. This feature is currently limited to the Supervisor.
|
||||
Crash reports are only visible to the Home Assistant Core developers. This feature is currently limited to the [Supervisor](/docs/glossary/#home-assistant-supervisor) and [OS-Agent](https://github.com/home-assistant/os-agent).
|
||||
|
||||
## Data storage & processing
|
||||
|
||||
|
||||
@ -328,13 +328,13 @@ The Android TV integration works by polling the Android TV / Fire TV device at a
|
||||
|
||||
The solution to this problem is the `state_detection_rules` configuration parameter, which allows you to provide your own rules for state detection. The keys are app IDs, and the values are lists of rules that are evaluated in order. Valid rules are:
|
||||
|
||||
* `'standby'`, `'playing'`, `'paused'`, `'idle'`, or `'off'`
|
||||
* If this is not a map, then this state will always be reported when this app is the current app
|
||||
* If this is a map, then its entries are conditions that will be checked. If all of the conditions are true, then this state will be reported. Valid conditions pertain to 3 properties (see the example configuration above):
|
||||
- `'standby'`, `'playing'`, `'paused'`, `'idle'`, or `'off'`
|
||||
- If this is not a map, then this state will always be reported when this app is the current app
|
||||
- If this is a map, then its entries are conditions that will be checked. If all of the conditions are true, then this state will be reported. Valid conditions pertain to 3 properties (see the example configuration above):
|
||||
1. ``'media_session_state'``
|
||||
2. ``'audio_state'``
|
||||
3. ``'wake_lock_size'``
|
||||
* `'media_session_state'` = try to use the `media_session_state` property to determine the state
|
||||
* `'audio_state'` = try to use the `audio_state` property to determine the state
|
||||
- `'media_session_state'` = try to use the `media_session_state` property to determine the state
|
||||
- `'audio_state'` = try to use the `audio_state` property to determine the state
|
||||
|
||||
To determine what these rules should be, you can use the `androidtv.adb_command` service with the command `GET_PROPERTIES`, as described in the [androidtv.adb_command](#androidtvadb_command) section.
|
||||
|
||||
@ -22,7 +22,6 @@ Support is provided through the Python [anthemav] module. Older, RS-232 serial-b
|
||||
[Anthem]: https://www.anthemav.com/
|
||||
[anthemav]: https://github.com/nugget/python-anthemav
|
||||
|
||||
|
||||
To use your Anthem A/V Receiver in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -50,9 +49,9 @@ name:
|
||||
|
||||
## Notes and Limitations
|
||||
|
||||
- The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls.
|
||||
- Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
|
||||
- Only Zone 1 is currently supported.
|
||||
* The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls.
|
||||
* Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
|
||||
* Only Zone 1 is currently supported.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ This service will send messages to a registered device. The following parameters
|
||||
- **target**: The desired state of the device, only devices that match the state will receive messages. To enable state tracking a registered device must have a `tracking_device_id` attribute added to the `[NOTIFIER_NAME]_apns.yaml` file. If this ID matches a device in `known_devices.yaml` the device state will be tracked.
|
||||
|
||||
- **data**:
|
||||
* **badge**: The number to display as the badge of the app icon.
|
||||
* **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder.
|
||||
* **category**: Provide this key with a string value that represents the identifier property of the `UIMutableUserNotificationCategory`.
|
||||
* **content_available**: Provide this key with a value of 1 to indicate that new content is available.
|
||||
- **badge**: The number to display as the badge of the app icon.
|
||||
- **sound**: The name of a sound file in the app bundle or in the Library/Sounds folder.
|
||||
- **category**: Provide this key with a string value that represents the identifier property of the `UIMutableUserNotificationCategory`.
|
||||
- **content_available**: Provide this key with a value of 1 to indicate that new content is available.
|
||||
|
||||
@ -25,6 +25,7 @@ There is currently support for the following entities within the Apple TV device
|
||||
- [Remote](#remote)
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Media Player
|
||||
|
||||
The Apple TV media player platform will create a Media Player entity for each
|
||||
@ -63,7 +64,7 @@ The following commands are currently available:
|
||||
| `num_repeats` | yes | Number of times to repeat the commands |
|
||||
| `delay_secs` | yes | Interval in seconds between one send and another <br> This is a `float` value e.g. 1, 1.2 etc. |
|
||||
|
||||
**Examples**
|
||||
### Examples
|
||||
|
||||
Create a script to invoke the Netflix application based on the application icon
|
||||
being in a fixed place on the home screen:
|
||||
|
||||
@ -14,6 +14,8 @@ ha_platforms:
|
||||
|
||||
The [Apprise service](https://github.com/caronc/apprise/) is an all-in-one solution to open up Home Assistant to _just about_ every Notification platform (such as Amazon SNS, Discord, Telegram, Slack, MSTeams, Twilio, etc.)
|
||||
|
||||
## Configuration
|
||||
|
||||
To use Apprise supported notifications, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -59,7 +61,7 @@ config:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Example service call
|
||||
## Example service call
|
||||
|
||||
```yaml
|
||||
- service: notify.apprise
|
||||
@ -80,7 +82,7 @@ If you're using configuration files to store your Apprise URLs in, then you have
|
||||
|
||||
The tag `all` is reserved to notify absolutely everything, whether you have a tag associated with a URL or not.
|
||||
|
||||
### Notes
|
||||
## Notes
|
||||
|
||||
There are over 50 supported Notification services supported by Apprise. Each has their own tweaks and customizations you can leverage.
|
||||
|
||||
|
||||
@ -14,6 +14,8 @@ The `aquostv` platform allows you to control a [Sharp Aquos TV](http://www.sharp
|
||||
|
||||
When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication.
|
||||
|
||||
## Configuration
|
||||
|
||||
To add a TV to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -62,7 +64,7 @@ Also, with **power_on_enabled** as True, the Aquos logo on your TV will stay on
|
||||
|
||||
</div>
|
||||
|
||||
Currently known supported models:
|
||||
## Currently known supported models
|
||||
|
||||
- LC-40LE830U
|
||||
- LC-46LE830U
|
||||
@ -78,4 +80,4 @@ Currently known supported models:
|
||||
- LC-70LE650U
|
||||
- LC-70LE747E (no volume control)
|
||||
|
||||
If your model is not on the list then 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/aquostv.markdown).
|
||||
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/aquostv.markdown).
|
||||
|
||||
@ -34,17 +34,14 @@ Supported devices:
|
||||
|
||||
## Power state
|
||||
|
||||
Arcam FMJ receivers turn off their network port when in standby, the component will try to
|
||||
reconnect to the receiver every 5 seconds. This mean powering on the first zone is not
|
||||
possible over the builtin network connection. Two options for complete power control
|
||||
exists: IR or Serial gateway.
|
||||
Arcam FMJ receivers turn off their network port when in standby, the component will try to reconnect to the receiver every 5 seconds. This means powering on the first zone is not possible over the built-in network connection. Two options for complete power control exists: IR or Serial gateway.
|
||||
|
||||
### IR command
|
||||
|
||||
Use an IR blaster to send a command to turn the device on using these discrete codes:
|
||||
|
||||
- Zone 1: Protocol: RC5 Device: 16 Function: 123
|
||||
- Zone 2: Protocol: RC5 Device: 23 Function: 123
|
||||
- Zone 1: Protocol: RC5 Device: 16 Function: 123
|
||||
- Zone 2: Protocol: RC5 Device: 23 Function: 123
|
||||
|
||||
Turn on sometime requires two IR codes to be sent. You can generate the raw, broadlink or other IR format string using [irgen](https://github.com/elupus/irgen) tool like:
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ ha_platforms:
|
||||
This platform allows you to detect presence by looking at connected devices to an Arris TG2492LG router.
|
||||
|
||||
This is one of the routers provided by:
|
||||
|
||||
* [Ziggo](https://www.ziggo.nl/), a cable operator in the Netherlands, to their customers as the Ziggo Connectbox.
|
||||
* [Virgin Media](https://www.virginmedia.com/), a cable operator in the United Kingdom, to their customers as the Hub 3.
|
||||
|
||||
|
||||
@ -17,7 +17,8 @@ The `aten_pe` integration lets you control [ATEN Rack PDUs](https://www.aten.com
|
||||
In order to use it, SNMP must be enabled on your PDU. It is recommended to use SNMPv3 to protect your credentials from eavesdropping.
|
||||
|
||||
Tested devices:
|
||||
* [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/)
|
||||
|
||||
* [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/)
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@ The `august` integration allows you to integrate your [August](https://august.co
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
### Known Working Devices
|
||||
## Known Working Devices
|
||||
|
||||
- August Wi-Fi Smart Lock (Gen 4)
|
||||
- August Smart Lock Pro (Gen 3)
|
||||
@ -46,12 +46,13 @@ There is currently support for the following device types within Home Assistant:
|
||||
August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.
|
||||
</div>
|
||||
|
||||
### Known Unsupported Devices
|
||||
## Known Unsupported Devices
|
||||
|
||||
- The Yale Doorman L3
|
||||
|
||||
Other devices not listed above have not been tested and may not function as expected.
|
||||
|
||||
### Binary Sensor
|
||||
## Binary Sensor
|
||||
|
||||
If you have an August Doorbell, once you have enabled the August component, you should see following sensors:
|
||||
|
||||
@ -63,11 +64,11 @@ If you have an August Smart Lock with DoorSense, once you have enabled the Augus
|
||||
|
||||
- Door sensor
|
||||
|
||||
### Camera
|
||||
## Camera
|
||||
|
||||
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](https://august.com/) device in Home Assistant.
|
||||
|
||||
### Sensor
|
||||
## Sensor
|
||||
|
||||
If you have an August Doorbell with a battery, once you have enabled the August component, you should see the following sensors:
|
||||
|
||||
@ -82,7 +83,7 @@ If you have an August Keypad, once you have enabled the August component, you sh
|
||||
|
||||
- Keypad Battery
|
||||
|
||||
### Presence Detection with Lock Operation
|
||||
## Presence Detection with Lock Operation
|
||||
|
||||
Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below automation example (added to `automations.yaml`) will trigger when the user named “John Doe” in August locks or unlocks the door from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by August.
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_platforms:
|
||||
|
||||
[Elgato Avea](https://www.evehome.com/en/news/elgato-avea-transform-your-home) is a Bluetooth light bulb that is no longer supported by the manufacturer. The `avea` integration allows you to control all your Avea bulbs with Home Assistant.
|
||||
|
||||
### Configuration
|
||||
## Configuration
|
||||
|
||||
To enable Avea, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -24,14 +24,14 @@ You will need to request access to the Awair API and obtain an access token from
|
||||
|
||||
The integration will fetch data from each device linked to your Awair developer account. The following sensors are supported:
|
||||
|
||||
* Temperature
|
||||
* Humidity
|
||||
* Carbon dioxide
|
||||
* Total volatile organic compounds
|
||||
* PM2.5 density
|
||||
* PM10 density
|
||||
* Sound level
|
||||
* Luminescence
|
||||
* Temperature
|
||||
* Humidity
|
||||
* Carbon dioxide
|
||||
* Total volatile organic compounds
|
||||
* PM2.5 density
|
||||
* PM10 density
|
||||
* Sound level
|
||||
* Luminescence
|
||||
|
||||
Not all devices support all sensors; consult Awair's documentation to find out what sensors are present on your device. For first-generation Awair devices with a "dust" sensor, the integration will create identical PM2.5 and PM10 sensors (which reflects the capabilities of the sensor - it can detect dust between PM2.5 and PM10 but cannot differentiate between them).
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ There is no setup needed for the integration itself.
|
||||
|
||||
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
|
||||
|
||||
## Configuration
|
||||
### Configuration
|
||||
|
||||
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -73,7 +73,7 @@ For more details about the GPIO layout, visit the [article](https://elinux.org/B
|
||||
|
||||
The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
|
||||
|
||||
## Configuration
|
||||
### Configuration
|
||||
|
||||
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
||||
@ -82,6 +82,10 @@ sensor:
|
||||
scan_interval: 25
|
||||
```
|
||||
|
||||
## Directions for enabling I2C interface on the Home Assistant Operating System
|
||||
|
||||
Follow the instructions here to [enable I2C here.](/hassio/enable_i2c/).
|
||||
|
||||
## Directions for installing smbus support on Raspberry Pi
|
||||
|
||||
Enable I2c interface with the Raspberry Pi configuration utility:
|
||||
|
||||
@ -50,4 +50,3 @@ device_class:
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
@ -133,7 +133,7 @@ action:
|
||||
|
||||
## Services
|
||||
|
||||
The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN as attribute of all enties, e.g. (binary) sensors or the device tracker. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
|
||||
The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN as attribute of all entities, e.g. (binary) sensors or the device tracker. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
|
||||
|
||||
Using these services will impact the state of your vehicle. So use these services with care!
|
||||
|
||||
|
||||
@ -33,11 +33,11 @@ To ensure a clean re-configuration, please perform the following steps:
|
||||
- Perform the [TV does not generate new pin](#tv-does-not-generate-new-pin) steps.
|
||||
- Retry [configuration](#configuration).
|
||||
|
||||
### TV does not generate new pin:
|
||||
### TV does not generate new pin
|
||||
|
||||
If you have previously set up your TV with any Home Assistant instances, you must remove Home Assistant from your TV in order for your TV to generate a new pin. To do this, you must do **one** of the following:
|
||||
|
||||
- On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidiance.
|
||||
- On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance.
|
||||
- Reset your TV to factory condition.
|
||||
|
||||
## Remote
|
||||
@ -182,7 +182,6 @@ Users of TVs older than 2013 have another option for controlling their TV via Ho
|
||||
|
||||
If you have a Raspberry Pi connected to your TV:
|
||||
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
|
||||
@ -54,7 +54,7 @@ Home Assistant Cast requires your Home Assistant installation to be accessible v
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Chromecasts generally ignore DNS servers from DHCP and will instead use Google's DNS servers, 8.8.8.8 and 8.8.4.4. This means media URLs must either be specifying the IP-address of the server directly, e.g. `http://192.168.1.1:8123/movie.mp4`, or be publicly resolvable, e.g. `http://homeassistant.internal.mydomain.com:8123/movie.mp4` where `homeassistant.internal.mydomain.com` resolves to `129.168.1.1`. A hostname which can't be publicly resolved, e.g. `http://homeassistant.local:8123/movie.mp4` will fail to play.
|
||||
Chromecasts generally ignore DNS servers from DHCP and will instead use Google's DNS servers, 8.8.8.8 and 8.8.4.4. This means media URLs must either be specifying the IP-address of the server directly, e.g. `http://192.168.1.1:8123/movie.mp4`, or be publicly resolvable, e.g. `http://homeassistant.internal.mydomain.com:8123/movie.mp4` where `homeassistant.internal.mydomain.com` resolves to `192.168.1.1`. A hostname which can't be publicly resolved, e.g. `http://homeassistant.local:8123/movie.mp4` will fail to play.
|
||||
|
||||
This is important when casting TTS or local media sources; the cast integration will cast such media from the `external_url` if [configured](/docs/configuration/basic), otherwise from the Home Assistant Cloud if configured, otherwise from the [`internal_url`](/docs/configuration/basic). Note that the Home Assistant Cloud will not be used if an `external_url` is configured.
|
||||
|
||||
|
||||
@ -61,6 +61,7 @@ Supported devices:
|
||||
|
||||
Tested devices:
|
||||
|
||||
- Epson WF2630
|
||||
- Epson WF2660
|
||||
- Epson WF3540
|
||||
- Epson WF3620
|
||||
|
||||
@ -13,7 +13,11 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
The `fronius` sensor polls a [Fronius](https://www.fronius.com/) solar inverter, battery system or smart meter and present the values as sensors in Home Assistant.
|
||||
The `fronius` sensor polls a [Fronius](https://www.fronius.com/) solar inverter, battery system or smart meter and presents the values as sensors in Home Assistant. Data is gathered directly from a Fronius device connected to your local network, this integration doesn't access the cloud.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You will need to either set a static IP on the Fronius device or assign a static DHCP lease for it, or alternatively access it through the local DNS name if your network is properly configured for this.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -22,7 +26,7 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: fronius
|
||||
resource: FRONIUS_URL
|
||||
resource: FRONIUS_URL_OR_IP
|
||||
monitored_conditions:
|
||||
- sensor_type: logger_info
|
||||
- sensor_type: inverter
|
||||
@ -33,7 +37,7 @@ sensor:
|
||||
|
||||
{% configuration %}
|
||||
resource:
|
||||
description: "The URL of the Fronius device (e.g., `http://192.0.2.0` or `http://fronius.local`)"
|
||||
description: "The hostname or IP address of the Fronius device (e.g., `192.0.2.0` or `http://fronius.local`)"
|
||||
required: true
|
||||
type: string
|
||||
monitored_conditions:
|
||||
@ -51,7 +55,7 @@ monitored_conditions:
|
||||
type: string
|
||||
default: "device"
|
||||
device:
|
||||
description: "The id of the device to poll"
|
||||
description: "The ID of the device to poll"
|
||||
required: false
|
||||
default: "\"1\" for inverters and \"0\" for other devices such as storages in compliance with Fronius Specs"
|
||||
{% endconfiguration %}
|
||||
@ -102,6 +106,19 @@ there might be no sensor providing photovoltaic related data.
|
||||
This does not need to be problematic as the values will be added on sunrise,
|
||||
when the Fronius devices begins providing the needed data.
|
||||
|
||||
## Finding out devices IDs
|
||||
|
||||
To find out the device ID of the inverter visit the URL:
|
||||
`http://FRONIUS_IP/solar_api/v1/GetPowerFlowRealtimeData.fcgi`
|
||||
In the returned JSON, under the key Body > Data > Inverters you should see your inverters listed with IDs starting from 1.
|
||||
|
||||
To find out the device ID of the meter visit the URL:
|
||||
`http://FRONIUS_IP/solar_api/v1/GetMeterRealtimeData.cgi?Scope=System`
|
||||
In the returned JSON, under the key Body > Data you should see your meters listed with IDs starting from 0.
|
||||
|
||||
To find out which API version your system runs, visit the URL:
|
||||
`http://FRONIUS_IP/solar_api/GetAPIVersion.cgi`
|
||||
|
||||
## Examples
|
||||
|
||||
When including more of the components that one Fronius device offers,
|
||||
@ -121,3 +138,7 @@ sensor:
|
||||
device: 0
|
||||
- sensor_type: power_flow
|
||||
```
|
||||
|
||||
## Note
|
||||
|
||||
Fronius often provides firmware updates for the datamanager interfaces and the devices in their system, it's recommended to check and apply them regularly. This integration relies on functionality present in rather recent firmware.
|
||||
|
||||
@ -38,7 +38,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
### Extra configuration of the integration
|
||||
|
||||
Configuration of Netatmo public weather stations is offered from the front end. Enter the Netatmo integration and press the cogwheel.
|
||||
Configuration of Netatmo public weather stations is offered from the front end. Enter the Netatmo integration and press the "CONFIGURE", then set "Area name" for new area.
|
||||
|
||||
In the dialog, it is possible to create, edit and remove public weather sensors. For each area a unique name has to be set along with an area to be covered and whether to display average or maximum values.
|
||||
|
||||
|
||||
@ -152,6 +152,7 @@ The list with all known valid keys can be found [here](https://github.com/floria
|
||||
- TX-65FX720W
|
||||
- TX-L42ET50
|
||||
- TX-L47ET60E (can't power on)
|
||||
- TX LF37E30 (can't power on)
|
||||
- TX-P42STW50
|
||||
- TX-P42VT30E
|
||||
- TX-P50GT30Y
|
||||
|
||||
@ -65,6 +65,29 @@ The activity sensor provides a count of users currently watching media from the
|
||||
|
||||
The library sensors show a count of items in each library. Depending on the library contents, the sensor will show extra detail in its attributes. For example, a library sensor for TV shows will represent the total number of episodes in the library and its attributes will also report the number of shows and seasons it contains. The last added media item (movie, album, or episode) and a timestamp showing when it was added to its respective library are also provided.
|
||||
|
||||
In addition to the item count, the last added media item (movie, album, or episode) and a timestamp showing when it was added are also provided with each library sensor.
|
||||
|
||||
Example automation to use the `last_added_item` attribute on library sensors to notify when new media has been added:
|
||||
```yaml
|
||||
alias: Plex - New media added
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id: sensor.plex_library_movies
|
||||
id: movie
|
||||
- platform: state
|
||||
entity_id: sensor.plex_library_music
|
||||
id: album
|
||||
- platform: state
|
||||
entity_id: sensor.plex_library_tv_shows
|
||||
id: episode
|
||||
|
||||
action:
|
||||
- service: notify.mobile_app_phone
|
||||
data:
|
||||
title: "New {{ trigger.id }} added"
|
||||
message: "{{ trigger.to_state.attributes.last_added_item }}"
|
||||
```
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
The library sensors are disabled by default, but can be enabled via the Plex integration page.
|
||||
|
||||
@ -28,6 +28,8 @@ There is currently support for the following device types within Home Assistant:
|
||||
- Sensor
|
||||
- [Switch](#switch)
|
||||
|
||||
Note that some entities are disabled by default. If you are missing a sensor or binary sensor, check the configured integration!
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Services
|
||||
|
||||
@ -33,11 +33,10 @@ In case you would like to convert the values for example to kWh instead of the d
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for template platform
|
||||
sensor:
|
||||
platform: template
|
||||
sensors:
|
||||
solaredge_energy_this_year_template:
|
||||
value_template: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}"
|
||||
template:
|
||||
- sensor:
|
||||
- name: solaredge_energy_this_year_template:
|
||||
state: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}"
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
@ -69,13 +69,12 @@ In case you would like to convert the values for example to kWh instead of the d
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for sensor template platform
|
||||
sensor:
|
||||
- platform: template
|
||||
sensors:
|
||||
solaredge_energy_this_year_template:
|
||||
value_template: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}"
|
||||
template:
|
||||
- sensor:
|
||||
- name: solaredge_energy_this_year_template:
|
||||
state: "{{ (states('sensor.solaredge_energy_this_year') | float / 1000) | round(2) }}"
|
||||
unit_of_measurement: "KWh"
|
||||
icon_template: "mdi:solar-power"
|
||||
icon: "mdi:solar-power"
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
@ -29,7 +29,7 @@ In order to set up this integration, you need to get the BTLE MAC address of you
|
||||
1. Open the SwitchBot app.
|
||||
2. Open device settings.
|
||||
3. Click on "Device Info".
|
||||
4. Write down the BLTE MAC address of your device.
|
||||
4. Write down the BTLE MAC address of your device.
|
||||
|
||||
Please note, device names configured in the SwitchBot app are not transferred into Home Assistant.
|
||||
|
||||
|
||||
@ -22,7 +22,8 @@ ha_quality_scale: platinum
|
||||
---
|
||||
|
||||
The `tplink` integration allows you to control your [TP-Link Smart Home Devices](https://www.tp-link.com/kasa-smart/) such as plugs, power strips, wall switches and bulbs.
|
||||
In some instances it might be required to add the plug to the Kasa app before trying to add them to Home Assistant, if you cannot see your newly purchased device via the integration, please add it to the Kasa app first (do not upgrade the firmware if it presents the option).
|
||||
|
||||
You need to provision your newly purchased device to connect to your network before it can be added via the integration. This can be done either by using [kasa command-line tool](https://python-kasa.readthedocs.io/en/latest/cli.html#provisioning) or by adding it to the official Kasa app before trying to add them to Home Assistant. If you use the app, do not upgrade the firmware if it presents the option to avoid blocking the local access by potential firmware updates.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -3,6 +3,7 @@ title: Traccar
|
||||
description: Instructions how to use Traccar GPS tracker to track devices in Home Assistant.
|
||||
ha_release: 0.83
|
||||
ha_category:
|
||||
- Car
|
||||
- Presence Detection
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
|
||||
@ -23,7 +23,8 @@ There is currently support for the following device types within Home Assistant:
|
||||
|
||||
The following air conditioners are confirmed to be working, but other models that use the 6th Sense Live application may also work:
|
||||
|
||||
- SPIW312A2WF
|
||||
- SPIW309A2WF/SPIW312A2WF
|
||||
- SPIW409A2WF
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ ha_platforms:
|
||||
- switch
|
||||
---
|
||||
|
||||
[WLED](https://github.com/Aircoookie/WLED) is a fast and feature-rich
|
||||
[WLED](https://kno.wled.ge) is a fast and feature-rich
|
||||
implementation of an ESP8266/ESP32 webserver to control
|
||||
NeoPixel (WS2812B, WS2811, SK6812, APA102, and similar) LED's.
|
||||
|
||||
@ -87,7 +87,7 @@ Can be configured on the WLED itself under settings > LED Preferences > Timed li
|
||||
Toggles the synchronization between multiple WLED devices.
|
||||
Can be configured on the WLED itself under settings > Sync Interfaces > WLED Broadcast.
|
||||
|
||||
[WLED Sync documentation](https://github.com/Aircoookie/WLED/wiki/Sync-WLED-devices-(UDP-Notifier))
|
||||
[WLED Sync documentation](https://kno.wled.ge/interfaces/udp-realtime/)
|
||||
|
||||
{% include integrations/option_flow.md %}
|
||||
|
||||
@ -115,7 +115,7 @@ This service allows for controlling the WLED effect.
|
||||
| `reverse` | no | Reverse the effect. Either `true` to reverse or `false` otherwise. |
|
||||
|
||||
A list of all available effects (and the behavior of the intensity for each
|
||||
effect) [is documented in the WLED Wiki](https://github.com/Aircoookie/WLED/wiki/List-of-effects-and-palettes#effects).
|
||||
effect) [is documented in the WLED Knowledge base](https://kno.wled.ge/features/effects-palettes/).
|
||||
|
||||
## Example Automations
|
||||
|
||||
@ -141,7 +141,7 @@ Activating a random palette is a bit more complicated as there is currently no w
|
||||
To go around this issue, one solution is to leverage the fact that palettes can be activated by their IDs.
|
||||
As the IDs are based on an incrementing counter, picking a random number between zero and the number of palettes minus one works.
|
||||
|
||||
To do this, the first step is to use [WLED's JSON API](https://github.com/Aircoookie/WLED/wiki/JSON-API) find out how many palettes the device supports:
|
||||
To do this, the first step is to use [WLED's JSON API](https://kno.wled.ge/interfaces/json-api) find out how many palettes the device supports:
|
||||
|
||||
```bash
|
||||
$ curl --silent http://<ip address of the wled device>/json | jq ".palettes | length"
|
||||
|
||||
@ -53,7 +53,7 @@ There is currently support for the following device types within Home Assistant:
|
||||
- Sensor
|
||||
- Switch
|
||||
|
||||
There is also support for grouping of lights, switches, and fans (i.e. support for commanding device groups as entities). At least two entities must be added to a group before the group entity is created.
|
||||
There is also support for grouping of lights, switches, and fans (i.e. support for commanding device groups as entities). At least two entities must be added to a group before the group entity is created. As well as support for binding/unbinding (i.e. bind a remote to a lightbulb or group).
|
||||
|
||||
## Compatible hardware
|
||||
|
||||
@ -229,6 +229,9 @@ Note: `cluster_id: 25` may also be `cluster_id: 0x0019`. The two are synonymous.
|
||||
|
||||
### Defining Zigbee channel to use
|
||||
|
||||
ZHA prefers to use Zigbee channel 15 by default. You can change this using YAML configuration, but this only works
|
||||
if there's no existing network. To change the channel for an existing network, radio has to be factory reset and a new network to be formed. This requires re-pairing of all the devices.
|
||||
|
||||
```yaml
|
||||
zha:
|
||||
zigpy_config:
|
||||
@ -362,6 +365,17 @@ An example using the default CC2531 coordinator firmware + two CC2531 routers; Y
|
||||
- Router two: + 21 devices
|
||||
- Total device limit = **55 devices**
|
||||
|
||||
### Binding and unbinding
|
||||
|
||||
ZHA support for binding and unbinding. Binding is an action in Zigbee which defines relations between two Zigbee devices, specific endpoints, and cluster id. It provides a mechanism for attaching an endpoint on one Zigbee node to one or more endpoints on another Zigbee node or Zigbee group (a group of Zigbee devices).
|
||||
|
||||
Binding is a "target destination" in form of a device address or group ID, endpoint, and cluster. For example, binding a Zigbee device like a remote to a Zigbee lightbulb, switch or group of lightbulbs allows direct control of the "target" device (light, switch, shade) from the "remote" Zigbee device, bypassing ZHA. This means that the remote can control the lightbulb/group of lightbulbs even when the Zigbee coordinator is not available.
|
||||
Binding is only supported between the same cluster, for example, "output cluster id 6" (on/off cluster) of a remote, can be only bound to an "input cluster id 6" on the target device -- light, switch.
|
||||
|
||||
Note that not all devices support binding as it depends on the Zigbee implementation of the device itself. Also, by default ZHA bind remotes to the coordinator, so the coordinator could receive ZCL commands from the remotes and originate zha_events. However, some remotes, for example, the Philips RWL021 can only be bound to a single destination and it is not possible to make this switch to bind to other destinations like a device or groups unless you first unbind the remote from the coordinator. After you unbind the remote from the ZHA coordinator you can then bind it directly to any other Zigbee device or a group.
|
||||
|
||||
Binding a remote directly to a bulb or group has the benefit of faster response time and smoother control. This greatly improves user feedback experience functions like dimming as the remote then directly dims the lightbulb and thus does not have to make the software roundtrip via the ZHA coordinator.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
To help resolve any kinks or compatibility problems, report bugs as issues with debug logs. Please follow the instructions in this troubleshooting section.
|
||||
|
||||
@ -59,7 +59,7 @@ name:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Example
|
||||
## Examples
|
||||
|
||||
Alternatively, the card can be configured using YAML:
|
||||
|
||||
@ -71,3 +71,17 @@ entities:
|
||||
- entity: media_player.lounge_room
|
||||
name: Main player
|
||||
```
|
||||
|
||||
Or with longer time frame, and multiple entities (as long as they share the same unit_of_measurement) in one graph:
|
||||
|
||||
```yaml
|
||||
type: history-graph
|
||||
title: "Temperatures in the last 48 hours"
|
||||
hours_to_show: 48
|
||||
entities:
|
||||
- sensor.outside_temperature
|
||||
- entity: sensor.lounge_temperature
|
||||
name: "Lounge"
|
||||
- entity: sensor.attic_temperature
|
||||
name: "Attic"
|
||||
```
|
||||
|
||||
@ -2108,6 +2108,7 @@
|
||||
/cookbook /examples
|
||||
/common-tasks/os/#snapshots /common-tasks/os/#backups
|
||||
/common-tasks/supervised/#snapshots /common-tasks/supervised/#backups
|
||||
/more-info/unsupported/container /more-info/unsupported/software
|
||||
|
||||
# Migrated Community Guides
|
||||
/cookbook/apache_configuration https://community.home-assistant.io/t/reverse-proxy-with-apache/196942
|
||||
|
||||
@ -7,7 +7,7 @@ feedback: false
|
||||
The documentation covers beginner to advanced topics around the installation, setup, configuration, and usage of Home Assistant.
|
||||
|
||||
<div class="text-center hass-option-cards" markdown="0">
|
||||
<a class='option-card' href='/hassio/'>
|
||||
<a class='option-card' href='/getting-started/'>
|
||||
<div class='img-container'>
|
||||
<img src='https://brands.home-assistant.io/homeassistant/icon.png' />
|
||||
</div>
|
||||
|
||||
@ -220,7 +220,7 @@ toc: true
|
||||
<td>✅</td><td>✅</td><td>❌</td><td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Supervisor</td>
|
||||
<td><a href="/docs/glossary/#home-assistant-supervisor" target="_blank">Supervisor</a></td>
|
||||
<td>✅</td><td>❌</td><td>❌</td><td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -228,7 +228,7 @@ toc: true
|
||||
<td>✅</td><td>❌</td><td>❌</td><td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Backups</td>
|
||||
<td><a href="/common-tasks/supervised/#backups" target="_blank">Backups</a></td>
|
||||
<td>✅</td><td>❌</td><td>❌</td><td>✅</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
||||
@ -12,7 +12,7 @@ Included sections for this page is located under source/_includes/installation
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/documentation/faqs/#pi-power) with your Raspberry Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets. USB ports on your computer also will not supply enough power and must not be used.
|
||||
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.com/documentation/computers/raspberry-pi.html#power-supply) with your Raspberry Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets. USB ports on your computer also will not supply enough power and must not be used.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ Docker is at the core of most operations that the Supervisor does, it is importa
|
||||
|
||||
The Supervisor will be marked as unhealthy if any of these requirements are not met:
|
||||
|
||||
- [Running containers known to cause issues](/more-info/unsupported/container)
|
||||
- [Running unsupported software](/more-info/unsupported/software)
|
||||
- [Running an unsupported Docker version](/more-info/unsupported/docker_version)
|
||||
- [Running the Supervisor under LXC](/more-info/unsupported/lxc)
|
||||
- [Not running the Supervisor as privileged](/more-info/unsupported/privileged)
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
title: "Containers known to cause issues"
|
||||
description: "More information on why certain containers marks the installation as unsupported."
|
||||
---
|
||||
|
||||
## The issue
|
||||
|
||||
The Supervisor needs to be the only manager of the containers that it manages, unfortunately, some other containers also take on this role. Worst case, those will auto-update the existing containers to development builds without consideration of the channel you have chosen. Because of this, a few containers known to cause issues, have been added to a denylist that will flag your installation as unsupported.
|
||||
|
||||
As stated in [ADR-0014](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md), running additional software on the host is not supported,
|
||||
and more containers or other software can be added to the denylist without any notice.
|
||||
|
||||
## The solution
|
||||
|
||||
You will find a list of offending containers in your Supervisor log.
|
||||
|
||||
If you remove all offending containers from your host and then reload the Supervisor, it will no longer be marked as unsupported for this reason.
|
||||
14
source/more-info/unsupported/software.markdown
Normal file
14
source/more-info/unsupported/software.markdown
Normal file
@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "Unsupported software"
|
||||
description: "More information on why running unsupported software marks the installation as unsupported."
|
||||
---
|
||||
|
||||
## The issue
|
||||
|
||||
As stated in [ADR-0014](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md), no additional software, outside of the Home Assistant ecosystem, is installed. This includes but are not limited to standalone containers running on the same host.
|
||||
|
||||
Some containers will also conflict with the operations of the Supervisor, if you run any of those your system will also be marked as unhealthy. These containers will be shown in the Supervisor log as errors.
|
||||
|
||||
## The solution
|
||||
|
||||
Remove any additional software (including standalone containers) you have installed on your host and restart the Supervisor.
|
||||
Loading…
x
Reference in New Issue
Block a user