mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Merge remote-tracking branch 'origin/current' into rc
This commit is contained in:
Franck Nijhof
commit
8a545d98d1
@ -114,7 +114,7 @@ GEM
|
||||
tilt (2.0.10)
|
||||
tzinfo (2.0.4)
|
||||
concurrent-ruby (~> 1.0)
|
||||
tzinfo-data (1.2021.2)
|
||||
tzinfo-data (1.2021.3)
|
||||
tzinfo (>= 1.0.0)
|
||||
unicode-display_width (1.8.0)
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ description: "Details about the database used by Home Assistant."
|
||||
|
||||
Home Assistant uses database to store events and parametersis for history and tracking. The default database used is [SQLite](https://www.sqlite.org/) and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `<path to config dir>/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` component](/integrations/recorder/).
|
||||
|
||||
To work with SQLite database manually from the command-line, you will need an [installation](http://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](http://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands.
|
||||
To work with SQLite database manually from the command-line, you will need an [installation](https://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](https://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands.
|
||||
First load your database with `sqlite3`:
|
||||
|
||||
```bash
|
||||
|
||||
@ -57,7 +57,7 @@ temperature_unit:
|
||||
required: false
|
||||
type: string
|
||||
time_zone:
|
||||
description: "Pick your time zone from the column **TZ** of [Wikipedia's list of tz database time zones](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"
|
||||
description: "Pick your time zone from the column **TZ** of [Wikipedia's list of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)"
|
||||
required: false
|
||||
type: string
|
||||
currency:
|
||||
|
||||
@ -39,7 +39,7 @@ entity_picture:
|
||||
required: false
|
||||
type: string
|
||||
icon:
|
||||
description: "Any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix name with `mdi:`, ie `mdi:home`. Note: Newer icons may not yet be available in the current Home Assistant release. You can check when an icon was added to MaterialDesignIcons.com at [MDI History](https://materialdesignicons.com/history)."
|
||||
description: "Any icon from [MaterialDesignIcons.com](https://materialdesignicons.com). Prefix name with `mdi:`, ie `mdi:home`. Note: Newer icons may not yet be available in the current Home Assistant release. You can check when an icon was added to MaterialDesignIcons.com at [MDI History](https://materialdesignicons.com/history)."
|
||||
required: false
|
||||
type: string
|
||||
assumed_state:
|
||||
|
||||
@ -22,7 +22,7 @@ homeassistant:
|
||||
longitude: -121
|
||||
# 'metric' for Metric, 'imperial' for Imperial
|
||||
unit_system: imperial
|
||||
# Pick yours from here: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
# Pick yours from here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
time_zone: "America/Los_Angeles"
|
||||
customize: !include customize.yaml
|
||||
```
|
||||
|
||||
@ -26,7 +26,7 @@ One of the most common problems with Home Assistant is an invalid `configuration
|
||||
- [Supervised](/common-tasks/supervised/#configuration-check)
|
||||
|
||||
- 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/).
|
||||
- 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).
|
||||
|
||||
`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):
|
||||
|
||||
@ -25,7 +25,7 @@ Note that indentation is an important part of specifying relationships using YAM
|
||||
|
||||
Getting the right indentation can be tricky if you're not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.
|
||||
|
||||
You can use the online service [YAMLLint](http://www.yamllint.com/) to check if your YAML syntax is correct before loading it into Home Assistant which will save you some time. If you do so, be aware that this is a third-party service and is not maintained by the Home Assistant community.
|
||||
You can use the online service [YAML Validator](https://codebeautify.org/yaml-validator/) to check if your YAML syntax is correct before loading it into Home Assistant which will save you some time. If you do so, be aware that this is a third-party service and is not maintained by the Home Assistant community.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
|
||||
@ -78,7 +78,7 @@ If you are running a Mosquitto instance on a different server with proper SSL en
|
||||
|
||||
### Public broker
|
||||
|
||||
The Mosquitto project runs a [public broker](http://test.mosquitto.org). This is the easiest to set up, but there is no privacy as all messages are public. Use this only for testing purposes and not for real tracking of your devices or controlling your home.
|
||||
The Mosquitto project runs a [public broker](https://test.mosquitto.org). This is the easiest to set up, but there is no privacy as all messages are public. Use this only for testing purposes and not for real tracking of your devices or controlling your home.
|
||||
|
||||
```yaml
|
||||
mqtt:
|
||||
@ -88,7 +88,7 @@ mqtt:
|
||||
# Optional, replace port 1883 with following if you want encryption
|
||||
# (doesn't really matter because broker is public)
|
||||
port: 8883
|
||||
# Download certificate from http://test.mosquitto.org/ssl/mosquitto.org.crt
|
||||
# Download certificate from https://test.mosquitto.org/ssl/mosquitto.org.crt
|
||||
certificate: /home/paulus/downloads/mosquitto.org.crt
|
||||
```
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ description: "Instructions on how to test your MQTT setup."
|
||||
logo: mqtt.png
|
||||
---
|
||||
|
||||
The `mosquitto` broker package ships commandline tools (often as `*-clients` package) to send and receive MQTT messages. As an alternative have a look at [hbmqtt_pub](http://hbmqtt.readthedocs.org/en/latest/references/hbmqtt_pub.html) and [hbmqtt_sub](http://hbmqtt.readthedocs.org/en/latest/references/hbmqtt_sub.html) which are provided by HBMQTT. For sending test messages to a broker running on localhost check the example below:
|
||||
The `mosquitto` broker package ships commandline tools (often as `*-clients` package) to send and receive MQTT messages. As an alternative have a look at [hbmqtt_pub](https://hbmqtt.readthedocs.org/en/latest/references/hbmqtt_pub.html) and [hbmqtt_sub](https://hbmqtt.readthedocs.org/en/latest/references/hbmqtt_sub.html) which are provided by HBMQTT. For sending test messages to a broker running on localhost check the example below:
|
||||
|
||||
```bash
|
||||
mosquitto_pub -h 127.0.0.1 -t home-assistant/switch/1/on -m "Switch is ON"
|
||||
|
||||
@ -110,4 +110,4 @@ The Template Editor provides a way to quickly test templates prior to placing th
|
||||
|
||||
By default this will contain sample code that illustrates how templates can be written and tested. This sample code can be removed and replaced with your own. You can restore the default example by pressing the "Reset to Demo Template" button beneath the code editor.
|
||||
|
||||
For more information about Jinja2, visit [Jinja2 documentation](http://jinja.pocoo.org/docs/dev/templates/), and also read templating document [here](/topics/templating/).
|
||||
For more information about Jinja2, visit [Jinja2 documentation](https://jinja.palletsprojects.com/templates/), and also read templating document [here](/topics/templating/).
|
||||
|
||||
@ -144,7 +144,7 @@ If your node has user codes, you can set and delete them. The format is raw hex
|
||||
\x39 = 9
|
||||
```
|
||||
Some non compliant device like tag readers, have implemented to use raw hex code.
|
||||
Please refer to a hex ASCII table to set your code. Example: http://www.asciitable.com/
|
||||
Please refer to a hex ASCII table to set your code. Example: https://www.asciitable.com/
|
||||
|
||||
Here is a small Python program than will take numbers on the command line and print the correct sequence for compliant devices:
|
||||
|
||||
|
||||
@ -53,7 +53,7 @@ docker pull {{ site.installation.container.base }}:dev
|
||||
3. Download and install the version you want
|
||||
|
||||
```bash
|
||||
pip3 install --upgrade git+git://github.com/home-assistant/core.git@dev
|
||||
pip3 install --upgrade git+https://github.com/home-assistant/core.git@dev
|
||||
```
|
||||
|
||||
4. When that is complete restart the service for it to use the new files.
|
||||
|
||||
@ -15,7 +15,7 @@ The steps would be:
|
||||
- Set "Enable auto-restart" if you like
|
||||
- Within "Volume" click on "Add Folder" and choose either an existing folder or add a new folder. The "mount path" has to be "/config", so that Home Assistant will use it for the configs and logs. It is therefore recommended that the folder you choose should be named "config" or "homeassistant/config" to avoid confusion when referencing it within service calls.
|
||||
- Within "Network" select "Use same network as Docker Host"
|
||||
- To ensure that Home Assistant displays the correct timezone go to the "Environment" tab and click the plus sign then add `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
- To ensure that Home Assistant displays the correct timezone go to the "Environment" tab and click the plus sign then add `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
- Confirm the "Advanced Settings"
|
||||
- Click on "Next" and then "Apply"
|
||||
- Your Home Assistant within Docker should now run and will serve the web interface from port 8123 on your Docker host (this will be your Synology NAS IP address - for example `http://192.168.1.10:8123`)
|
||||
@ -37,7 +37,7 @@ Adjust the following Terminal command as follows :
|
||||
|
||||
- Replace `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration
|
||||
- Replace `/PATH_TO_YOUR_USB_STICK` matches the path for your USB stick (e.g., `/dev/ttyACM0` for most Synology users)
|
||||
- Replace "Australia/Melbourne" with [your timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
- Replace "Australia/Melbourne" with [your timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
|
||||
Run it in Terminal.
|
||||
|
||||
@ -83,7 +83,7 @@ The steps would be:
|
||||
- Click on "Advanced Settings"
|
||||
- Within "Shared Folders" click on "Volume from host" > "Add" and choose either an existing folder or add a new folder. The "mount point has to be `/config`, so that Home Assistant will use it for the configuration and logs.
|
||||
- Within "Network" and select Network Mode to "Host"
|
||||
- To ensure that Home Assistant displays the correct timezone go to the "Environment" tab and click the plus sign then add `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
- To ensure that Home Assistant displays the correct timezone go to the "Environment" tab and click the plus sign then add `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|
||||
- Click on "Create"
|
||||
- Wait for some time until your NAS has created the container
|
||||
- Your Home Assistant within Docker should now run and will serve the web interface from port 8123 on your Docker host (this will be your Qnap NAS IP address - for example `http://192.xxx.xxx.xxx:8123`)
|
||||
|
||||
@ -87,7 +87,7 @@ If you prefer to use a live operating system, follow the instructions of your Li
|
||||
{% endif %}
|
||||
2. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>
|
||||
3. Select "Flash from URL"
|
||||
|
||||
|
||||
|
||||
4. Get the URL for your {{site.installation.types[page.installation_type].board}}:
|
||||
{% if site.installation.types[page.installation_type].variants.size > 1 %}
|
||||
@ -121,15 +121,15 @@ If you prefer to use a live operating system, follow the instructions of your Li
|
||||
_Select and copy the URL or use the "copy" button that appear when you hover it._
|
||||
|
||||
1. Paste the URL for your {{site.installation.types[page.installation_type].board}} into Balena Etcher and click "OK"
|
||||
|
||||
|
||||
6. Balena Etcher will now download the image, when that is done click "Select target"
|
||||
|
||||
|
||||
7. Select the {{site.installation.types[page.installation_type].installation_media}} you want to use for your {{site.installation.types[page.installation_type].board}}
|
||||
|
||||
|
||||
8. Click on "Flash!" to start writing the image
|
||||
|
||||
|
||||
9. When Balena Etcher is finished writing the image you will get this confirmation
|
||||
|
||||
|
||||
|
||||
### Start up your {{site.installation.types[page.installation_type].board}}
|
||||
|
||||
|
||||
@ -13,17 +13,17 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
This implements a direct RS485 connection to a solar inverter in the
|
||||
This implements a direct RS485 connection to a solar inverter in the
|
||||
PVI-3.0/3.6/4.2-TL-OUTD ABB series, and may work on others.
|
||||
The inverter was formerly made by PowerOne who got taken over by ABB.
|
||||
|
||||
The TCP/IP method of communicating with inverters is supported by the
|
||||
The TCP/IP method of communicating with inverters is supported by the
|
||||
Python library, but not by this implementation in this integration.
|
||||
|
||||
This integration provides a single sensor which reports the live power output
|
||||
in watts.
|
||||
|
||||
Note the PV inverter will be unresponsive to communications when in darkness,
|
||||
Note the PV inverter will be unresponsive to communications when in darkness,
|
||||
so the value 'unknown' will be displayed during the night.
|
||||
|
||||
## Configuration
|
||||
@ -39,7 +39,7 @@ sensor:
|
||||
|
||||
{% configuration %}
|
||||
device:
|
||||
description: The serial port your RS485 adaptor is connected to.
|
||||
description: The serial port your RS485 adapter is connected to.
|
||||
required: true
|
||||
type: string
|
||||
address:
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Bluesound
|
||||
description: Instructions on how to integrate Bluesound devices into Home Assistant.
|
||||
logo: bluesound.png
|
||||
ha_category:
|
||||
- Media Player
|
||||
ha_release: 0.51
|
||||
|
||||
@ -15,7 +15,7 @@ ha_platforms:
|
||||
- sensor
|
||||
---
|
||||
|
||||
The `bmp280` sensor platform allows you to read temperature and pressure values of a [Bosch BMP280 Environmental sensor](https://www.bosch-sensortec.com/products/environmental-sensors/pressure-sensors/pressure-sensors-bmp280-1.html) connected via [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins).
|
||||
The `bmp280` sensor platform allows you to read temperature and pressure values of a [Bosch BMP280 Environmental sensor](https://www.bosch-sensortec.com/products/environmental-sensors/pressure-sensors/bmp280/) connected via [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins).
|
||||
|
||||
This integration has been tested on a Raspberry Pi 4B, but it should work on any device which is supported by [CircuitPython](https://circuitpython.org/).
|
||||
|
||||
|
||||
@ -125,7 +125,7 @@ So for example, the above command `/goform/formiPhoneAppDirect.xml?VSMONI2` will
|
||||
|
||||
<div class='note'>
|
||||
|
||||
The denonavr platform supports the standard media player controls such as `turn_on` and `volume_up`. Thus calling the service `media_player.turn_on` is equivalent to calling `denonavr.get_command` with the command `/goform/formiPhoneAppDirect.xml?PWON`. See [media_player](/integrations/meida_player/) for more details.
|
||||
The denonavr platform supports the standard media player controls such as `turn_on` and `volume_up`. Thus calling the service `media_player.turn_on` is equivalent to calling `denonavr.get_command` with the command `/goform/formiPhoneAppDirect.xml?PWON`. See [media_player](/integrations/media_player/) for more details.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Etherscan
|
||||
description: Instructions on how to integrate Etherscan.io data within Home Assistant.
|
||||
logo: etherscan.png
|
||||
ha_category:
|
||||
- Finance
|
||||
ha_release: 0.47
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: EverLights
|
||||
description: Instructions on how to set up EverLights within Home Assistant.
|
||||
logo: everlights.png
|
||||
ha_category:
|
||||
- Light
|
||||
ha_iot_class: Local Polling
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Graphite
|
||||
description: Instructions on how to record Home Assistant history in Graphite.
|
||||
logo: graphite.png
|
||||
ha_category:
|
||||
- History
|
||||
ha_release: 0.13
|
||||
|
||||
@ -42,7 +42,7 @@ homeworks:
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address of the ethernet to serial adapter. It is assumed that the adaptor has been preconfigured.
|
||||
description: The IP address of the ethernet to serial adapter. It is assumed that the adapter has been preconfigured.
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
|
||||
@ -20,7 +20,7 @@ ha_zeroconf: true
|
||||
ha_dhcp: true
|
||||
---
|
||||
|
||||
The `hunterdouglas_powerview` integration allows you to integrate your [Hunter Douglas PowerView](https://www.hunterdouglas.com/operating-systems/powerview-motorization/support) devices in Home Assistant.
|
||||
The `hunterdouglas_powerview` integration allows you to integrate your [Hunter Douglas PowerView](https://www.hunterdouglas.com/operating-systems/powerview-motorization/support) devices in Home Assistant. The product is also known by the brand name Luxaflex Powerview in Europe and Australia [as explained on their website](https://www.hunterdouglasgroup.com/company/brands-in-action/), however this integration should work for both brands.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ ha_platforms:
|
||||
|
||||
The `kodi` platform allows you to control a [Kodi](https://kodi.tv/) multimedia system from Home Assistant.
|
||||
|
||||
The preferred way to set up the Kodi platform is by through discovery, which requires an enabled [web interface](https://kodi.wiki/view/Web_interface) on your Kodi installation.
|
||||
The preferred way to set up the Kodi platform is through discovery, which requires an enabled [web interface](https://kodi.wiki/view/Web_interface) on your Kodi installation.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: LaMetric
|
||||
description: Instructions on how to integrate LaMetric with Home Assistant.
|
||||
logo: lametric.png
|
||||
ha_category:
|
||||
- Hub
|
||||
- Notifications
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Linux Battery
|
||||
description: Instructions on how to integrate Linux Battery information into Home Assistant.
|
||||
logo: linux_battery.png
|
||||
ha_category:
|
||||
- System Monitor
|
||||
ha_release: 0.28
|
||||
|
||||
@ -14,7 +14,7 @@ ha_platforms:
|
||||
- binary_sensor
|
||||
---
|
||||
|
||||
The Mullvad VPN integration pulls [Mullvad](https://mullvad.net/) VPN status information into Home Assistant.
|
||||
The Mullvad VPN integration uses the [Mullvad](https://mullvad.net/) VPN API to detect if your Home Assistant instance is connected to the Mullvad VPN service.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ ha_domain: recorder
|
||||
ha_iot_class: Local Push
|
||||
---
|
||||
|
||||
The `recorder` integration is responsible for storing details in a database, which then are handled by the [`history` ](/integrations/history/) integration.
|
||||
The `recorder` integration is responsible for storing details in a database, which then are handled by the [`history`](/integrations/history/) integration.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
@ -232,7 +232,7 @@ The following database engines are tested when major changes are made to the rec
|
||||
- SQLite 3.32.1+
|
||||
- MariaDB 10.3+
|
||||
- MySQL 5.7+
|
||||
- PostgresSQL 12+
|
||||
- PostgreSQL 12+
|
||||
|
||||
## Custom database engines
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ The `seventeentrack` sensor platform allows users to get package data tied to th
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
Although the 17track.net website states that account passwords cannot be longer than 16 characters, users can technically set long-than-16-character passwords. These passwords **will not** work with the used API. Therefore, please ensure that your 17track.net password does not exceed 16 characters.
|
||||
Although the 17track.net website states that account passwords cannot be longer than 16 characters, users can technically set longer-than-16-character passwords. These passwords **will not** work with the used API. Therefore, please ensure that your 17track.net password does not exceed 16 characters.
|
||||
|
||||
</div>
|
||||
|
||||
@ -55,7 +55,7 @@ show_delivered:
|
||||
|
||||
### Lovelace summary card
|
||||
|
||||
Use the following templated Markdown card to list all packages in transit along their status:
|
||||
Use the following templated Markdown card to list all packages in transit along with their status:
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ The integration uses the web interface of the device. Before you start, make sur
|
||||
|
||||
## Sensors
|
||||
|
||||
The SMA WebConnect module supports a wide variety of sensors, but not all of these have been mapped in the `pysma` library. Currently available sensors can be found below. Feel free to submit additional sensors to be added as standard sensors to the [pysma library](https://github.com/rklomp/pysma/blob/dev/pysma/definitions.py).
|
||||
The SMA WebConnect module supports a wide variety of sensors, but not all of these have been mapped in the `pysma` library. Currently available sensors can be found below. Feel free to submit additional sensors to be added as standard sensors to the [pysma library](https://github.com/rklomp/pysma/blob/master/pysma/definitions.py).
|
||||
|
||||
### Solar Inverter
|
||||
|
||||
|
||||
@ -19,4 +19,4 @@ system_health:
|
||||
|
||||
System Health integration data can be viewed at **Configuration** -> **Info**.
|
||||
|
||||
Data includes information about your system architecture, operating system and version, Home Assistant installation type and version, Python version, frontend version, the number of [Lovelace Dashboards and Views](/lovelace/dashboards-and-views/) you have, and more.
|
||||
Data includes information about your system architecture, operating system and version, Home Assistant installation type and version, Python version, frontend version, the number of Lovelace [Dashboards](/lovelace/dashboards/) and [Views](/lovelace/views/) you have, and more.
|
||||
|
||||
@ -22,7 +22,7 @@ The requirements are:
|
||||
|
||||
**Method 1:** You can get your `chat_id` by sending any message to the [GetIDs bot](https://t.me/getidsbot).
|
||||
|
||||
**Method 2:** To retrieve your `chat_id` you can visit `https://api.telegram.org/botYOUR_API_TOKEN/getUpdates` or to use `$ curl -X GET https://api.telegram.org/botYOUR_API_TOKEN/getUpdates` **after** you have sent the bot a message. Replace `YOUR_API_TOKEN` with your actual token.
|
||||
**Method 2:** To retrieve your `chat_id` you can visit `https://api.telegram.org/bot<YOUR_API_TOKEN>/getUpdates` or to use `$ curl -X GET https://api.telegram.org/bot<YOUR_API_TOKEN>/getUpdates` **after** you have sent the bot a message. Replace `<YOUR_API_TOKEN>` with your actual token.
|
||||
|
||||
The result set will include your chat ID as `id` in the `chat` section:
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ This platform allows you to connect to your [Todoist Projects](https://todoist.c
|
||||
|
||||
### Prerequisites
|
||||
|
||||
You need to determine your Todoist API token. This is fairly simple to do; just go [to the Integrations section on your Todoist settings page](https://todoist.com/Users/viewPrefs?page=authorizations) and find the section labeled "API token" at the bottom of the page. Copy that token and use it in your configuration file.
|
||||
You need to determine your Todoist API token. This is fairly simple to do; just go [to the Integrations section on your Todoist settings page](https://todoist.com/app/settings/integrations) and find the section labeled "API token" at the bottom of the page. Copy that token and use it in your configuration file.
|
||||
|
||||
### Basic Setup
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ ha_dhcp: true
|
||||
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 smart plugs and smart bulbs.
|
||||
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.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
@ -32,10 +32,6 @@ There is currently support for the following device types within Home Assistant:
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Supported Devices
|
||||
|
||||
This integration supports devices that are controllable with the [KASA app](https://www.tp-link.com/us/kasa-smart/kasa.html).
|
||||
The following devices are known to work with this component.
|
||||
|
||||
### Plugs
|
||||
|
||||
- HS100
|
||||
|
||||
@ -11,7 +11,7 @@ ha_platforms:
|
||||
- notify
|
||||
---
|
||||
|
||||
The TP-Link LTE integration for Home Assistant allows you to observe and control TP-Link LTE routers, currently only tested with TL-MR6400 (firmware 1.4.0).
|
||||
The TP-Link LTE integration for Home Assistant makes it possible to send SMS's from the TP-Link LTE router. Phone numbers have to be pre-defined as part of the YAML configuration, and each phone number will turn up as additional notify service in Home Assistant. The integration adds a new notify service for each adds a notification service to Home Assistant that can be used to send SMSs provides a notification service that will send an SMS. Tested only with TL-MR6400 v4.
|
||||
|
||||
The integration provides a notification service that will send an SMS.
|
||||
|
||||
@ -45,7 +45,7 @@ notify:
|
||||
required: false
|
||||
type: list
|
||||
keys:
|
||||
target:
|
||||
recipient:
|
||||
description: The phone number of a default recipient or a list with multiple recipients.
|
||||
required: true
|
||||
type: [string, list]
|
||||
|
||||
@ -94,7 +94,7 @@ It is also recommended that the command `volume_up`, the command `volume_down`,
|
||||
|
||||
When providing `select_source` as a command, it is recommended to also provide the attributes `source`, and `source_list`. The `source` attribute is the currently select source, while the `source_list` attribute is a list of all available sources.
|
||||
|
||||
When using `state_template`, if you use a template that depends on the current time or some other non-deterministic result not sourced from entities, the template won't repeatedly update but will only update when the state of a referenced entity updates. For ways to deal with this issue, see the [example](/integrations/binary_sensor.template/#working-without-entities) in the template binary_sensor.
|
||||
When using `state_template`, if you use a template that depends on the current time it is recommended to use `now()`. Using `now()` will cause templates to be refreshed at the start of every new minute. For more information see the [time](/docs/configuration/templating/#time) section in the template documentation.
|
||||
|
||||
## Usage examples
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ offset:
|
||||
type: integer
|
||||
cron:
|
||||
description: This option is *mutually exclusive* of `cycle` and `offset`. It provides an advanced method of defining when should the counter be reset. It follows common [crontab syntax](https://crontab.guru).
|
||||
required: true
|
||||
required: false
|
||||
type: string
|
||||
net_consumption:
|
||||
description: Set this to True if you would like to treat the source as a net meter. This will allow your counter to go both positive and negative.
|
||||
|
||||
@ -87,8 +87,7 @@ One other thing to watch is how the `holiday` keyword is used. Your first instin
|
||||
|
||||
## Full examples
|
||||
|
||||
This example excludes Saturdays, Sundays but not a holiday. Two custom holidays are added.
|
||||
Even though `sat` and `sun` was not included in `workdays` and in theory, it would not need to be excluded, but because we do not what holidays excluded, we add them so exclude would not default and skip the holidays. Therefore as the note above, 2/17/2020 in the US would still be a workday.
|
||||
This example excludes Saturdays and Sundays but not holidays. Two custom holidays are added.
|
||||
|
||||
```yaml
|
||||
# Example 1 configuration.yaml entry
|
||||
@ -97,9 +96,12 @@ binary_sensor:
|
||||
country: US
|
||||
workdays: [mon, tue, wed, thu, fri]
|
||||
excludes: [sat, sun]
|
||||
add_holidays:
|
||||
- "2020-02-24"
|
||||
- "2020-04-25"
|
||||
```
|
||||
|
||||
This example excludes Saturdays, Sundays and holidays. Two custom holidays are added.
|
||||
This example excludes Saturdays, Sundays and holidays. One custom holiday is added.
|
||||
The date February 24th, 2020 is a Monday but will be excluded because it was added to the `add_holidays` configuration.
|
||||
|
||||
```yaml
|
||||
|
||||
@ -465,7 +465,7 @@ trigger:
|
||||
|
||||
#### Available Trigger Data
|
||||
|
||||
In addition to the [standard automation trigger data](docs/automation/templating/#all), the `zwave_js.value_updated` trigger platform has additional trigger data available for use.
|
||||
In addition to the [standard automation trigger data](/docs/automation/templating/#all), the `zwave_js.value_updated` trigger platform has additional trigger data available for use.
|
||||
|
||||
| Template variable | Data |
|
||||
|------------------------------|--------------------------------------------------------------------------------------------|
|
||||
|
||||
@ -358,7 +358,7 @@ frontpage_image: /images/frontpage/blue-frontpage.jpg
|
||||
<div class="spec-content">
|
||||
No Wi-Fi or Bluetooth
|
||||
<div class="spec-content-additional">
|
||||
Support for Z-Wave and Zigbee by external USB adaptor
|
||||
Support for Z-Wave and Zigbee by external USB adapter
|
||||
(not included)
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -30,7 +30,7 @@ By making a contribution to this project, I certify that:
|
||||
|
||||
## Attribution
|
||||
|
||||
The text of this license is available under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/). It is based on the Linux [Developer Certificate Of Origin](http://elinux.org/Developer_Certificate_Of_Origin), but is modified to explicitly use the Apache 2.0 license
|
||||
The text of this license is available under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](https://creativecommons.org/licenses/by-sa/3.0/). It is based on the Linux [Developer Certificate Of Origin](https://elinux.org/Developer_Certificate_Of_Origin), but is modified to explicitly use the Apache 2.0 license
|
||||
and not mention sign-off.
|
||||
|
||||
## Signing
|
||||
|
||||
@ -67,8 +67,8 @@ Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/).
|
||||
- [The winners of the Thomas-Krenn-Awards 2018](https://www.thomas-krenn.com/de/tkmag/allgemein/die-gewinner-des-thomas-krenn-awards-2018-stehen-fest/) - March 2018
|
||||
- [Best of Open Source Smart Home: Home Assistant vs OpenHAB](https://smarthome.university/your-smart-home-platform-home-assistant-vs-openhab/) - February 2018
|
||||
- [Hausautomations-Schaltzentrale Home Assistant auf Python-Basis](https://www.heise.de/ct/ausgabe/2017-26-Hausautomations-Schaltzentrale-Home-Assistant-3909532.html) - December 2017
|
||||
- [Using Home Assistant the ARTIK Cloud](http://web.archive.org/web/20191028191303/https://developer.artik.io/documentation/developer-guide/wireless-iot/hass.html) - September 2017
|
||||
- [Control home automation hardware with Home Assistant](http://www.linux-magazine.com/Issues/2017/203/Home-Assistant) - August 2017
|
||||
- [Using Home Assistant the ARTIK Cloud](https://web.archive.org/web/20191028191303/https://developer.artik.io/documentation/developer-guide/wireless-iot/hass.html) - September 2017
|
||||
- [Control home automation hardware with Home Assistant](https://www.linux-magazine.com/Issues/2017/203/Home-Assistant) - August 2017
|
||||
- [Smart Home Home Assistant KNX Alexa Sprachsteuerung](https://onesmarthome.de/smart-home-home-assistant-knx-alexa-sprachsteuerung/) - August 2017
|
||||
- [Episode #122: Home Assistant: Pythonic Home Automation](https://talkpython.fm/episodes/show/122/home-assistant-pythonic-home-automation) - July 2017
|
||||
- [Smart Home Home Assistant Konfiguration mit YAML](https://onesmarthome.de/smart-home-home-assistant-konfiguration/) - July 2017
|
||||
@ -84,7 +84,7 @@ Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/).
|
||||
- [Episode #11](https://pythonbytes.fm/episodes/show/11/django-2.0-is-dropping-python-2-entirely-pipenv-for-profile-functionality-and-pythonic-home-automation) at minute 15:20 by [Python Bytes](https://pythonbytes.fm/) - January 2017
|
||||
- [Now you can hide your smart home on the darknet](https://www.wired.com/2016/07/now-can-hide-smart-home-darknet/) - July 2016
|
||||
- [Home Assistant: The Python Approach to Home Automation](https://www.linux.com/news/home-assistant-python-approach-home-automation-video) - June 2016
|
||||
- [Secure home automation, without clouds or dedicated hubs](http://linuxgizmos.com/secure-home-automation-without-clouds-or-dedicated-hubs/) - June 2016
|
||||
- [Secure home automation, without clouds or dedicated hubs](https://linuxgizmos.com/secure-home-automation-without-clouds-or-dedicated-hubs/) - June 2016
|
||||
- [Weekend Project: Setting up Home Assistant on your PC or Mac](https://www.automatedhome.co.uk/software/weekend-project-setting-up-home-assistant-on-your-pc-or-mac.html) by [automated home](https://www.automatedhome.co.uk/) - April 2016
|
||||
- [Episode 105 - DIY Home Automation Roundup](https://www.hometech.fm/shows/105) by [HomeTech.fm](https://www.hometech.fm/) - April 2016
|
||||
- [5 open source home automation tools](https://opensource.com/life/16/3/5-open-source-home-automation-tools) by [opensource.com](https://opensource.com) - March 2016
|
||||
|
||||
@ -16,7 +16,7 @@ The website [https://www.home-assistant.io](/) was launched on December 18, 2014
|
||||
|
||||
## Logo
|
||||
|
||||
The current logo was created by [Jeremy Geltman](http://jeremygeltman.com/). Further details can be found in the [announcement](/blog/2015/03/08/new-logo/).
|
||||
The current logo was created by [Jeremy Geltman](https://jeremygeltman.com/). Further details can be found in the [announcement](/blog/2015/03/08/new-logo/).
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 2.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.8 KiB |
@ -30,7 +30,7 @@ name:
|
||||
default: Name of entity
|
||||
icon:
|
||||
required: false
|
||||
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](https://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
type: string
|
||||
default: Entity domain icon
|
||||
image:
|
||||
@ -87,7 +87,7 @@ name:
|
||||
type: string
|
||||
icon:
|
||||
required: false
|
||||
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
description: Overwrites icon or entity picture. You can use any icon from [MaterialDesignIcons.com](https://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
type: string
|
||||
image:
|
||||
required: false
|
||||
|
||||
@ -110,7 +110,7 @@ dashboards:
|
||||
type: string
|
||||
icon:
|
||||
required: false
|
||||
description: The icon to show in the sidebar. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
description: The icon to show in the sidebar. You can use any icon from [MaterialDesignIcons.com](https://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
type: string
|
||||
show_in_sidebar:
|
||||
required: false
|
||||
@ -191,4 +191,4 @@ views:
|
||||
title: Lovelace
|
||||
content: >
|
||||
Welcome to your **Lovelace UI**.
|
||||
```
|
||||
```
|
||||
|
||||
@ -69,7 +69,7 @@ entities:
|
||||
type: string
|
||||
icon:
|
||||
required: false
|
||||
description: Override the entity icon. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
description: Override the entity icon. You can use any icon from [MaterialDesignIcons.com](https://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
type: string
|
||||
image:
|
||||
required: false
|
||||
|
||||
@ -155,7 +155,7 @@ views:
|
||||
default: view index
|
||||
icon:
|
||||
required: false
|
||||
description: Icon-name from Material Design Icons. You can use any icon from [MaterialDesignIcons.com](http://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
description: Icon-name from Material Design Icons. You can use any icon from [MaterialDesignIcons.com](https://materialdesignicons.com). Prefix the icon name with `mdi:`, ie `mdi:home`.
|
||||
type: string
|
||||
background:
|
||||
required: false
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user