mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 08:46:51 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
244480dc8e
2
Gemfile
2
Gemfile
@ -24,7 +24,7 @@ gem 'nokogiri', '1.10.5'
|
||||
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
# and associated library
|
||||
install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
|
||||
gem 'tzinfo', '~> 1.2'
|
||||
gem 'tzinfo', '~> 2.0'
|
||||
gem 'tzinfo-data'
|
||||
end
|
||||
|
||||
|
||||
@ -104,10 +104,9 @@ GEM
|
||||
stringex (2.8.5)
|
||||
terminal-table (1.8.0)
|
||||
unicode-display_width (~> 1.1, >= 1.1.1)
|
||||
thread_safe (0.3.6)
|
||||
tilt (2.0.10)
|
||||
tzinfo (1.2.5)
|
||||
thread_safe (~> 0.1)
|
||||
tzinfo (2.0.0)
|
||||
concurrent-ruby (~> 1.0)
|
||||
tzinfo-data (1.2019.3)
|
||||
tzinfo (>= 1.0.0)
|
||||
unicode-display_width (1.6.0)
|
||||
@ -129,7 +128,7 @@ DEPENDENCIES
|
||||
sass-globbing (= 1.1.5)
|
||||
sinatra (= 2.0.7)
|
||||
stringex (= 2.8.5)
|
||||
tzinfo (~> 1.2)
|
||||
tzinfo (~> 2.0)
|
||||
tzinfo-data
|
||||
|
||||
RUBY VERSION
|
||||
|
||||
@ -104,7 +104,7 @@ Other state examples:
|
||||
|
||||
{% if states('sensor.temperature') | float > 20 %}
|
||||
It is warm!
|
||||
{%endif %}
|
||||
{% endif %}
|
||||
|
||||
{{ as_timestamp(states.binary_sensor.garage_door.last_changed) }}
|
||||
|
||||
@ -377,7 +377,7 @@ Nested JSON in a response is supported as well:
|
||||
},
|
||||
"values": {
|
||||
"temp": 26.09,
|
||||
"hum": 56.73,
|
||||
"hum": 56.73
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -22,7 +22,7 @@ One of the most common problems with Home Assistant is an invalid `configuration
|
||||
|
||||
- You can test your configuration using the command line with: `hass --script check_config`.
|
||||
- On Hass.io you can use the [hassio command](/hassio/commandline/#home-assistant): `hassio homeassistant check`.
|
||||
- On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `homeassistant` is the name of the container.
|
||||
- On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `home-assistant` is the name of the container.
|
||||
- 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](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/).
|
||||
- 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).
|
||||
|
||||
@ -57,7 +57,7 @@ import appdaemon.plugins.hass.hassapi as hass
|
||||
class FlashyMotionLights(hass.Hass):
|
||||
|
||||
def initialize(self):
|
||||
self.listen_state(self.motion, "binary_sensor.drive", new = "on")
|
||||
self.listen_state(self.motion, "binary_sensor.drive", new="on")
|
||||
|
||||
def motion(self, entity, attribute, old, new, kwargs):
|
||||
if self.sun_down():
|
||||
@ -78,7 +78,7 @@ import appdaemon.plugins.hass.hassapi as hass
|
||||
class MotionLights(hass.Hass):
|
||||
|
||||
def initialize(self):
|
||||
self.listen_state(self.motion, "binary_sensor.drive", new = "on")
|
||||
self.listen_state(self.motion, "binary_sensor.drive", new="on")
|
||||
|
||||
def motion(self, entity, attribute, old, new, kwargs):
|
||||
if self.self.sun_down():
|
||||
|
||||
@ -60,7 +60,13 @@ The discovery topic need to follow a specific format:
|
||||
|
||||
The payload must be a JSON dictionary and will be checked like an entry in your `configuration.yaml` file if a new device is added. This means that missing variables will be filled with the platform's default values. All configuration variables which are *required* must be present in the initial payload send to `/config`.
|
||||
|
||||
If the integration is `alarm_control_panel`, `binary_sensor`, or `sensor` and the mandatory `state_topic` is not present in the payload, `state_topic` will be automatically set to <discovery_prefix>/<component>/[<node_id>/]<object_id>/state. The automatic setting of `state_topic` is deprecated and may be removed in a future version of Home Assistant.
|
||||
If the integration is `alarm_control_panel`, `binary_sensor`, or `sensor` and the mandatory `state_topic` is not present in the payload, `state_topic` will be automatically set to:
|
||||
|
||||
```text
|
||||
<discovery_prefix>/<component>/[<node_id>/]<object_id>/state
|
||||
```
|
||||
|
||||
The automatic setting of `state_topic` is deprecated and may be removed in a future version of Home Assistant.
|
||||
|
||||
An empty payload will cause a previously discovered device to be deleted.
|
||||
|
||||
|
||||
@ -10,8 +10,8 @@ The command-line part of Home Assistant is `hass`.
|
||||
$ hass -h
|
||||
usage: hass [-h] [--version] [-c path_to_config_dir] [--demo-mode] [--debug]
|
||||
[--open-ui] [--skip-pip] [-v] [--pid-file path_to_pid_file]
|
||||
[--log-rotate-days LOG_ROTATE_DAYS] [--runner] [--script ...]
|
||||
[--daemon]
|
||||
[--log-rotate-days LOG_ROTATE_DAYS] [--log-file LOG_FILE]
|
||||
[--log-no-color] [--runner] [--script ...] [--daemon]
|
||||
|
||||
Home Assistant: Observe, Control, Automate.
|
||||
|
||||
|
||||
@ -27,6 +27,8 @@ It's totally normal for your Z-Wave stick to cycle through its LEDs (Yellow, Blu
|
||||
|
||||
Use the following example commands from a terminal session on your Pi where your Z-Wave stick is connected.
|
||||
|
||||
**Note:** You should only do this when Home Assistant has been stopped.
|
||||
|
||||
Turn off "Disco lights":
|
||||
|
||||
```bash
|
||||
|
||||
@ -75,7 +75,7 @@ get_sources:
|
||||
default: true
|
||||
type: boolean
|
||||
apps:
|
||||
description: A dictionary where the keys are app IDs and the values are app names that will be displayed in the UI; see example below.
|
||||
description: A dictionary where the keys are app IDs and the values are app names that will be displayed in the UI; see example below. ([These app names](https://github.com/JeffLIrion/python-androidtv/blob/5c39196ade3f88ab453b205fd15b32472d3e0482/androidtv/constants.py#L267-L283) are configured in the backend package and do not need to be included in your configuration.)
|
||||
required: false
|
||||
default: {}
|
||||
type: map
|
||||
|
||||
@ -10,12 +10,6 @@ ha_release: 0.7
|
||||
|
||||
The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` integration](/integrations/http/).
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
|
||||
|
||||
</div>
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
api:
|
||||
|
||||
@ -6,7 +6,6 @@ ha_category:
|
||||
- DIY
|
||||
- Sensor
|
||||
- Switch
|
||||
featured: true
|
||||
ha_release: pre 0.7
|
||||
ha_iot_class: Local Polling
|
||||
---
|
||||
|
||||
@ -13,7 +13,7 @@ You can enable the Cast integration by going to the Integrations page inside the
|
||||
|
||||
## Home Assistant Cast
|
||||
|
||||
Home Assistant has its own Cast application to show the Home Assistant UI on any Chromecast device. You can use it by adding the [Cast entity row](/lovelace/entities/#cast) to your Lovelace UI, or by calling the `cast.show_lovelace_view` service. The service takes the path of a Lovelace view and an entity ID of a Cast device to show the view on.
|
||||
Home Assistant has its own Cast application to show the Home Assistant UI on any Chromecast device. You can use it by adding the [Cast entity row](/lovelace/entities/#cast) to your Lovelace UI, or by calling the `cast.show_lovelace_view` service. The service takes the path of a Lovelace view and an entity ID of a Cast device to show the view on. A `path` has to be defined in your Lovelace YAML for each view, as outlined in the [views documentation](/lovelace/views/#path).
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
@ -29,7 +29,7 @@ device_tracker:
|
||||
The following optional parameters can be used with any platform:
|
||||
|
||||
<div class='note'>
|
||||
Device tracker will only look for global settings under the configuration of the first configured platform.
|
||||
Device tracker will only look for global settings under the configuration of the first configured platform. These 3 are the global settings:
|
||||
</div>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
|
||||
@ -15,7 +15,7 @@ Be aware that `emulated_hue` doesn't work for new users of **Google Home** with
|
||||
|
||||
</div>
|
||||
|
||||
The `emulated_hue` integration provides a virtual Philips Hue bridge, written entirely in software, which allows services that work with the Hue API to interact with Home Assistant
|
||||
The `emulated_hue` integration provides a virtual Philips Hue bridge, written entirely in software that allows services that work with the Hue API to interact with Home Assistant
|
||||
entities. The driving use case behind for functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no setup cost outside of configuration changes.
|
||||
The virtual bridge can turn entities on/off or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness.
|
||||
|
||||
|
||||
@ -46,6 +46,12 @@ You can find out your Freebox host and port by opening the address <http://mafre
|
||||
returned json should contain an api_domain (`host`) and a https_port (`port`).
|
||||
Please consult the [api documentation](https://dev.freebox.fr/sdk/os/) for more information.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
If you change your Freebox router for a new one, you need to delete the `freebox.conf` file located in your Home Assistant configuration directory to make the association again.
|
||||
|
||||
</div>
|
||||
|
||||
### Initial setup
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
@ -111,6 +111,12 @@ Within this delay the device registration should be completed in the App, otherw
|
||||
* Radiator thermostat (*HmIP-eTRV,-2,-C*) - should also work with (*HmIP-eTRV-2-UK, -B, -B1*)
|
||||
* Temperature and humidity sensor (*HmIP-STH*)
|
||||
* Temperature and humidity Sensor with display (*HmIP-STHD*)
|
||||
* There is no need to directly support the following devices by Home Assistant, because their integration is done by the required wall thermostats:
|
||||
* Floor Heating Actuator – 6x channels, 230V (*HMIP-FAL230-C6*)
|
||||
* Floor Heating Actuator – 10x channels, 230V (*HMIP-FAL230-C10*)
|
||||
* Floor Heating Actuator – 6x channels, 24V (*HMIP-FAL24-C6*)
|
||||
* Floor Heating Actuator – 10x channels, 24V (*HMIP-FAL24-C10*)
|
||||
* Floor Heating Actuator – 12x channels, motorised (*HMIP-FALMOT-C12*)
|
||||
|
||||
* homematicip_cloud.cover
|
||||
* Shutter actuator for brand-mount (*HmIP-BROLL*)
|
||||
|
||||
@ -23,6 +23,12 @@ Since the sensor change their ID after each powercycle/battery change you can ch
|
||||
sudo pylacrosse -d /dev/ttyUSB0 scan
|
||||
```
|
||||
|
||||
Or, when using Docker containers:
|
||||
|
||||
```bash
|
||||
docker exec -it <containername> pylacrosse -d /dev/ttyUSB0 scan
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
To use your `lacrosse` compatible sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -24,7 +24,7 @@ sensor:
|
||||
|
||||
{% configuration %}
|
||||
station:
|
||||
description: Name of the stop or station. Visit [the MVG live web site](https://www.mvg-live.de/) to find valid names.
|
||||
description: Name of the stop or station. Visit [the MVG live web site](https://www.mvg-live.de/ims/dfiStaticAuswahl.svc) to find valid names. Be aware, that not all data of interest might be available (i.e. bus departure-times in Haar).
|
||||
required: true
|
||||
type: string
|
||||
destinations:
|
||||
|
||||
@ -7,6 +7,7 @@ ha_category:
|
||||
- Sensor
|
||||
- Switch
|
||||
- Vacuum
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: 0.33
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
@ -9,10 +9,6 @@ ha_release: 0.52
|
||||
ha_iot_class: Cloud Polling
|
||||
---
|
||||
|
||||
<div class="note warning">
|
||||
Locumi Labs, the manufacturer of Nello, went bankrupt on 2 October 2019. Since Nello One locks require this cloud service, the locks will no longer work if the Nello shuts down the servers, which according to the official announcement should not happen for the time being. Nello has promised existing users via email that they will work on an alternative to use the lock without a server.
|
||||
</div>
|
||||
|
||||
The `nello` platform allows you to control [Nello](https://www.nello.io) intercoms.
|
||||
|
||||
To get started you need to create a secondary Nello account and authorize it to access your lock(s).
|
||||
|
||||
@ -43,6 +43,10 @@ name:
|
||||
required: false
|
||||
default: Web scrape
|
||||
type: string
|
||||
value_template:
|
||||
description: Defines a template to get the state of the sensor.
|
||||
required: false
|
||||
type: template
|
||||
unit_of_measurement:
|
||||
description: Defines the units of measurement of the sensor, if any.
|
||||
required: false
|
||||
|
||||
@ -104,11 +104,11 @@ switch:
|
||||
turn_on:
|
||||
service: switch.turn_on
|
||||
data:
|
||||
entity_id: switch.source
|
||||
entity_id: switch.target
|
||||
turn_off:
|
||||
service: switch.turn_off
|
||||
data:
|
||||
entity_id: switch.source
|
||||
entity_id: switch.target
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
@ -311,7 +311,7 @@ sensor:
|
||||
|
||||
The `template` sensors are not limited to use attributes from other entities but can also work with [Home Assistant's template extensions](/docs/configuration/templating/#home-assistant-template-extensions).
|
||||
|
||||
This template contains no entities that will trigger an update, so we add an `entity_id:` line with an entity that will force an update - here we're using a [date sensor](/integrations/time_date) to get a daily update:
|
||||
This template contains no entities that will trigger an update (as `now()` is a function), so we add an `entity_id:` line with an entity that will force an update - here we're using a [date sensor](/integrations/time_date) to get a daily update:
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -328,7 +328,24 @@ sensor:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
Useful entities to choose might be `sensor.date` which update once per day or `sensor.time` which updates once per minute.
|
||||
In this case it is also possible to convert the entity-less template above into one that will be updated automatically:
|
||||
|
||||
{% raw %}
|
||||
|
||||
````yaml
|
||||
sensor:
|
||||
- platform: template
|
||||
sensors:
|
||||
nonsmoker:
|
||||
value_template: "{{ (( as_timestamp(strptime(states('sensor.date'), '%Y-%m-%d')) - as_timestamp(strptime('06.07.2018', '%d.%m.%Y')) ) / 86400 ) | round(2) }}"
|
||||
friendly_name: 'Not smoking'
|
||||
unit_of_measurement: "Days"
|
||||
````
|
||||
|
||||
{% endraw %}
|
||||
|
||||
Useful entities to choose might be `sensor.date` which update once per day or `sensor.time`, which updates once per minute.
|
||||
Please note that the resulting template will be evaluated by Home Assistant state engine on every state change of these sensors, which in case of `sensor.time` happens every minute and might have a negative impact on performance.
|
||||
|
||||
An alternative to this is to create an interval-based automation that calls the service `homeassistant.update_entity` for the entities requiring updates. This modified example updates every 5 minutes:
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ This integration provides the following platforms:
|
||||
- Device tracker - to track location of your car
|
||||
- Lock - Door lock. Enables you to control Tesla's door lock
|
||||
- Climate - HVAC control. Allow you to control (turn on/off, set target temperature) your Tesla's HVAC system.
|
||||
- Switch - Charger and max range switch. Allow you to start/stop charging and set max range charging.
|
||||
- Switch - Charger and max range switch to allow you to start/stop charging and set max range charging. Update switch to allow you to disable polling of vehicles to conserve battery
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -208,11 +208,13 @@ The following table shows the units of measurement for each attribute:
|
||||
|
||||
As per Version 5.4.49 the Android Mi Home app stores the token readable in the log files. It can easily be retrieved in the folder Smarthome on in the Android device. Just open the text file inside the Smarthome/logs folder and search for the token.
|
||||
<br/> <br/>
|
||||
The iPhone app still stores the token in the SQLite db as of v4.10.2 (Dec 22, 2018).
|
||||
The iPhone app still stores the token in the SQLite db as of v4.23.4 (Nov 17, 2019).
|
||||
<br/> <br/>
|
||||
This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained
|
||||
easily via a hidden menu item at the Mi-Home app or using the `miio` command line tool.
|
||||
|
||||
After resetting the WiFi settings of the Xiaomi robot vacuum, a new Access Token will be generated and therefore these instructions need to be followed again.
|
||||
<br/> <br/>
|
||||
These instructions are written for the Mi Home app - not for the new RoboRock app.
|
||||
<br/> <br/>
|
||||
This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained easily via a hidden menu item at the Mi-Home app or using the `miio` command line tool.
|
||||
</div>
|
||||
|
||||
### Miio command line tool
|
||||
@ -252,7 +254,7 @@ The information output is:
|
||||
|
||||
To fetch the token follow these instructions depending on your mobile phone platform.
|
||||
|
||||
1. Configure the robot with [Mi Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/).
|
||||
1. Configure the robot with [Mi Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/). Make sure to select the correct region, as Xiaomi uses different product names for different geographical areas.
|
||||
2. Download and extract the [MiToolKit.zip](https://github.com/ultrara1n/MiToolkit/releases).
|
||||
3. Enable developer mode and USB debugging on the Android phone and plug it into the computer.
|
||||
4. Change the MiToolKit language to English if you need to.
|
||||
@ -280,7 +282,7 @@ source /srv/homeassistant/bin/activate
|
||||
|
||||
To fetch the token follow these instructions depending on your mobile phone platform.
|
||||
|
||||
1. Configure the robot with [Mi Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/).
|
||||
1. Configure the robot with [Mi Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/). Make sure to select the correct region, as Xiaomi uses different product names for different geographical areas.
|
||||
2. Enable developer mode, USB debugging and plug the Android phone into the computer.
|
||||
3. Get ADB by running `apt-get install android-tools-adb` or `apt-get install adb`.
|
||||
4. `adb devices` should list your device. Consult the ADB manual if necessary.
|
||||
@ -315,7 +317,7 @@ source /srv/homeassistant/bin/activate
|
||||
|
||||
To fetch the token follow these instructions depending on your mobile phone platform.
|
||||
|
||||
1. Configure the robot with [Mi Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/).
|
||||
1. Configure the robot with [Mi Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/). Make sure to select the correct region, as Xiaomi uses different product names for different geographical areas.
|
||||
2. Enable developer mode, USB debugging and root permission only for ADB on the Android phone and plug it into the computer.
|
||||
3. Get ADB (e.g, using `apt-get install android-tools-adb`).
|
||||
4. The command `adb devices` should list your device.
|
||||
@ -328,12 +330,12 @@ To fetch the token follow these instructions depending on your mobile phone plat
|
||||
|
||||
### iOS
|
||||
|
||||
1. Configure the robot with the Mi Home app.
|
||||
1. Configure the robot with the Mi Home app. Make sure to select the correct region, as Xiaomi uses different product names for different geographical areas. Note that the new RoboRock app is currently not supported for this method.
|
||||
2. Using iTunes, create an unencrypted backup of your iPhone.
|
||||
3. Install [iBackup Viewer](https://www.imactools.com/iphonebackupviewer/), open it, and open your backup.
|
||||
4. Open the "Raw Data" module.
|
||||
5. Navigate to `com.xiaomi.mihome`.
|
||||
6. Search for a file that looks like this: `123456789_mihome.sqlite` (Note: `_mihome.sqlite` is *not* the correct file).
|
||||
6. Search for a file that looks like this: `123456789_mihome.sqlite` (Note: `_mihome.sqlite` is *not* the correct file. Most likely, you will find this file in the `Documents` folder.)
|
||||
7. Save this file to your filesystem.
|
||||
8. Install [DB Browser for SQLite](https://sqlitebrowser.org/).
|
||||
9. Open DB Browser and load the `.sqlite` file you saved from your backup.
|
||||
@ -351,7 +353,7 @@ To fetch the token follow these instructions depending on your mobile phone plat
|
||||
|
||||
### Bluestacks
|
||||
|
||||
1. Configure the robot with the Mi-Home app.
|
||||
1. Configure the robot with the Mi-Home app. Make sure to select the correct region, as Xiaomi uses different product names for different geographical areas. Note that the new RoboRock app is currently not supported for this method.
|
||||
2. Install [BlueStacks](https://www.bluestacks.com).
|
||||
3. Set up [Mi Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) in BlueStacks and login to synchronize devices.
|
||||
4. Use [BlueStacks Tweaker](https://forum.xda-developers.com/general/general/bluestacks-tweaker-2-tool-modifing-t3622681) to access the filesystem and retrieve the token.
|
||||
@ -372,7 +374,7 @@ Software Required:
|
||||
- [Android Backup Extractor](https://sourceforge.net/projects/adbextractor/)
|
||||
- [SQLite Browser](https://sqlitebrowser.org/)
|
||||
1. Install an old Version of MiHome (e.g. Mi Home version 5.0.30) on your Android-Device
|
||||
2. Open MiHome, log-in and add your devices
|
||||
2. Open MiHome, log-in and add your devices. Make sure to select the correct region, as Xiaomi uses different product names for different geographical areas.
|
||||
3. Enable USB-Debugging on your Android
|
||||
4. Create a backup from your MiHome App, by using adb
|
||||
```bash
|
||||
|
||||
@ -10,8 +10,16 @@ ha_iot_class: Cloud Polling
|
||||
|
||||
The `waqi` sensor platform will query [World Air Quality Index](https://aqicn.org/city/beijing/) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs.
|
||||
|
||||
## Setup
|
||||
|
||||
This sensor requires an API token. Please obtain one at [AQICN API token](https://aqicn.org/data-platform/token/#/).
|
||||
|
||||
The locations field is a search for a location. E.g., "brisbane" or "Brisban" would find Brisbane, Australia and all associated stations in the area.
|
||||
|
||||
The format for station fields is exactly from the website, e.g., you would provide the location string "[South Brisbane, Australia](http://aqicn.org/city/australia/queensland/south-brisbane/)" for the linked location.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -8,7 +8,6 @@ ha_category:
|
||||
- Fan
|
||||
- Light
|
||||
- Switch
|
||||
featured: true
|
||||
ha_release: pre 0.7
|
||||
---
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ Please also make sure to connect your Xbox account on that site.
|
||||
The configuration requires you to specify XUIDs which are the unique identifiers
|
||||
for profiles. These can be determined on [XboxAPI.com](https://xboxapi.com/) by
|
||||
either looking at your own profile page or using their interactive documentation
|
||||
to search for gamertags.
|
||||
to search for gamertags. Sensor names default to the gamertag associated with an XUID.
|
||||
|
||||
To use the Xbox Live sensor in your installation,
|
||||
add the following to your `configuration.yaml` file:
|
||||
@ -42,3 +42,4 @@ xuid:
|
||||
required: true
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
@ -46,10 +46,10 @@ The custom quirks implementations for zigpy implemented as ZHA Device Handlers f
|
||||
- Digi XBee Series 3 (xbee3-24) modules
|
||||
- Digi XBee Series 2C (S2C) modules
|
||||
- Digi XBee Series 2 (S2) modules (Note! This first have to be flashed with Zigbee Coordinator API firmware)
|
||||
- Dresden-Elektronik deCONZ based Zigbee radios (via the [zigpy-deconz](https://github.com/zigpy/zigpy-deconz) library for zigpy)
|
||||
- [ConBee II (a.k.a. ConBee 2) USB adapter from Dresden-Elektronik](https://shop.dresden-elektronik.de/conbee-2.html)
|
||||
- [ConBee USB adapter from Dresden-Elektronik](https://www.dresden-elektronik.de/conbee/)
|
||||
- [RaspBee Raspberry Pi Shield from Dresden-Elektronik](https://www.dresden-elektronik.de/raspbee/)
|
||||
- dresden elektronik deCONZ based Zigbee radios (via the [zigpy-deconz](https://github.com/zigpy/zigpy-deconz) library for zigpy)
|
||||
- [ConBee II (a.k.a. ConBee 2) USB adapter from dresden elektronik](https://phoscon.de/conbee2)
|
||||
- [ConBee USB adapter from dresden elektronik](https://phoscon.de/conbee)
|
||||
- [RaspBee Raspberry Pi Shield from dresden elektronik](https://phoscon.de/raspbee)
|
||||
- ZiGate based radios (via the [zigpy-zigate](https://github.com/doudz/zigpy-zigate) library for zigpy and require firmware 3.1a or later)
|
||||
- [ZiGate USB-TTL](https://zigate.fr/produit/zigate-ttl/)
|
||||
- [ZiGate USB-DIN](https://zigate.fr/produit/zigate-usb-din/)
|
||||
@ -102,6 +102,8 @@ enable_quirks:
|
||||
|
||||
To add new devices to the network, call the `permit` service on the `zha` domain. Do this by clicking the Service icon in Developer tools and typing `zha.permit` in the **Service** dropdown box. Next, follow the device instructions for adding, scanning or factory reset.
|
||||
|
||||
Alternatively you can trigger a scan for devices through the Web UI via `Configuration > ZHA > Add Devices`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Add Philips Hue bulbs that have previously been added to another bridge
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -85,12 +85,12 @@ hassio ha update --version=0.XX.X
|
||||
|
||||
## Run the beta version on Hass.io
|
||||
|
||||
If you would like to test next release before anyone else, you can install the beta version released every two weeks:
|
||||
If you would like to test next release before anyone else, you can install the beta version released every three weeks:
|
||||
|
||||
1. Backup your installation, using the snapshot functionality Hass.io offers.
|
||||
2. Check the RC release notes for breaking changes on [Home Assistant release notes](https://rc--home-assistant-docs.netlify.com/latest-release-notes/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**.
|
||||
3. Select _System_ from the _Hass.io_ menu, then select _Join Beta Channel_ under _Hass.io supervisor_, then select _Reload_.
|
||||
4. Select _Dashboard_ from the _Hass.io_ menu, and then select _Update_.
|
||||
2. Check the [Home Assistant RC release notes](https://rc.home-assistant.io/latest-release-notes/) for breaking changes. Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**.
|
||||
3. Select _System_ tab from the _Hass.io_ menu, then select _Join Beta Channel_ under _Hass.io supervisor_, then select _Reload_.
|
||||
4. Select _Dashboard_ tab from the _Hass.io_ menu, and then select _Update_.
|
||||
|
||||
## Alternative: install on a generic Linux host
|
||||
|
||||
@ -182,10 +182,19 @@ curl -sL "https://raw.githubusercontent.com/home-assistant/hassio-installer/mast
|
||||
- `raspberrypi2`
|
||||
- `raspberrypi3`
|
||||
- `raspberrypi3-64`
|
||||
- `raspberrypi4`
|
||||
- `raspberrypi4-64`
|
||||
- `odroid-c2`
|
||||
- `odroid-cu2`
|
||||
- `odroid-xu`
|
||||
- `orangepi-prime`
|
||||
- `tinker`
|
||||
- `qemuarm`
|
||||
- `qemuarm-64`
|
||||
- `qemux86`
|
||||
- `qemux86-64`
|
||||
|
||||
See the [hassio-installer](https://github.com/home-assistant/hassio-installer) Github page for an up-to-date listing of supported machine types.
|
||||
|
||||
<div class='note'>
|
||||
When you use this installation method, the core SSH add-on may not function correctly. If that happens, use the community SSH add-on. Some of the documentation might not work for your installation either.
|
||||
|
||||
@ -64,10 +64,125 @@ If you define `visible` as objects instead of a boolean to specify conditions fo
|
||||
{% configuration badges %}
|
||||
user:
|
||||
required: true
|
||||
description: User id that can see the view tab.
|
||||
description: User id that can see the view tab (unique hex value found on the Users configuration page).
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Example
|
||||
|
||||
View config:
|
||||
|
||||
```yaml
|
||||
- title: Living room
|
||||
badges:
|
||||
- device_tracker.demo_paulus
|
||||
- entity: light.ceiling_lights
|
||||
name: Ceiling Lights
|
||||
icon: mdi:bulb
|
||||
- entity: switch.decorative_lights
|
||||
image: /local/lights.png
|
||||
```
|
||||
|
||||
## Paths
|
||||
|
||||
You can link to one view from another view by its path. For this use cards that support navigation (`navigation_path`). Do not use special characters in paths.
|
||||
|
||||
### Example
|
||||
|
||||
View config:
|
||||
|
||||
```yaml
|
||||
- title: Living room
|
||||
# the final path is /lovelace/living_room
|
||||
path: living_room
|
||||
```
|
||||
|
||||
Picture card config:
|
||||
|
||||
```yaml
|
||||
- type: picture
|
||||
image: /local/living_room.png
|
||||
tap_action:
|
||||
action: navigate
|
||||
navigation_path: /lovelace/living_room
|
||||
```
|
||||
|
||||
## Icons
|
||||
|
||||
If you define an icon the title will be used as a tool-tip.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Garden
|
||||
icon: mdi:flower
|
||||
```
|
||||
|
||||
## Visible
|
||||
|
||||
You can specify the visibility of views as a whole or per-user. (Note: This is only for the display of the tabs. The url path is still accessible)
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
views:
|
||||
- title: Ian
|
||||
visible:
|
||||
- user: 581fca7fdc014b8b894519cc531f9a04
|
||||
cards:
|
||||
...
|
||||
- title: Chelsea
|
||||
visible:
|
||||
- user: 6e690cc4e40242d2ab14cf38f1882ee6
|
||||
cards:
|
||||
...
|
||||
- title: Admin
|
||||
visible: db34e025e5c84b70968f6530823b117f
|
||||
cards:
|
||||
...
|
||||
```
|
||||
|
||||
## Panel mode
|
||||
|
||||
This renders the first card on full width, other cards in this view will not be rendered. Good for cards like `map`, `stack` or `picture-elements`.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Map
|
||||
panel: true
|
||||
cards:
|
||||
- type: map
|
||||
entities:
|
||||
- device_tracker.demo_paulus
|
||||
- zone.home
|
||||
```
|
||||
|
||||
## Themes
|
||||
|
||||
Set a separate [theme](/integrations/frontend/#themes) for the view and its cards.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Home
|
||||
theme: happy
|
||||
```
|
||||
|
||||
### Background
|
||||
|
||||
You can style the background of your views with a [theme](/integrations/frontend/#themes). You can use the CSS variable `lovelace-background`. For wallpapers you probably want to use the example below, more options can be found [here](https://developer.mozilla.org/en-US/docs/Web/CSS/background).
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
frontend:
|
||||
themes:
|
||||
example:
|
||||
lovelace-background: center / cover no-repeat url("/local/background.png") fixed
|
||||
```
|
||||
|
||||
## Badges
|
||||
|
||||
### State Label Badge
|
||||
@ -242,21 +357,6 @@ user:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Example
|
||||
|
||||
View config:
|
||||
|
||||
```yaml
|
||||
- title: Living room
|
||||
badges:
|
||||
- device_tracker.demo_paulus
|
||||
- entity: light.ceiling_lights
|
||||
name: Ceiling Lights
|
||||
icon: mdi:bulb
|
||||
- entity: switch.decorative_lights
|
||||
image: /local/lights.png
|
||||
```
|
||||
|
||||
### Entity Filter Badge
|
||||
|
||||
This badge allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home.
|
||||
@ -358,79 +458,3 @@ entities:
|
||||
value: 50
|
||||
attribute: humidity
|
||||
```
|
||||
|
||||
## Paths
|
||||
|
||||
You can link to one view from another view by its path. For this use cards that support navigation (`navigation_path`). Do not use special characters in paths.
|
||||
|
||||
### Example
|
||||
|
||||
View config:
|
||||
|
||||
```yaml
|
||||
- title: Living room
|
||||
# the final path is /lovelace/living_room
|
||||
path: living_room
|
||||
```
|
||||
|
||||
Picture card config:
|
||||
|
||||
```yaml
|
||||
- type: picture
|
||||
image: /local/living_room.png
|
||||
tap_action:
|
||||
action: navigate
|
||||
navigation_path: /lovelace/living_room
|
||||
```
|
||||
|
||||
## Icons
|
||||
|
||||
If you define an icon the title will be used as a tool-tip.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Garden
|
||||
icon: mdi:flower
|
||||
```
|
||||
|
||||
## Panel mode
|
||||
|
||||
This renders the first card on full width, other cards in this view will not be rendered. Good for cards like `map`, `stack` or `picture-elements`.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Map
|
||||
panel: true
|
||||
cards:
|
||||
- type: map
|
||||
entities:
|
||||
- device_tracker.demo_paulus
|
||||
- zone.home
|
||||
```
|
||||
|
||||
## Themes
|
||||
|
||||
Set a separate [theme](/integrations/frontend/#themes) for the view and its cards.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
- title: Home
|
||||
theme: happy
|
||||
```
|
||||
|
||||
### Background
|
||||
|
||||
You can style the background of your views with a [theme](/integrations/frontend/#themes). You can use the CSS variable `lovelace-background`. For wallpapers you probably want to use the example below, more options can be found [here](https://developer.mozilla.org/en-US/docs/Web/CSS/background).
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
frontend:
|
||||
themes:
|
||||
example:
|
||||
lovelace-background: center / cover no-repeat url("/local/background.png") fixed
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user