- 
+ 
Set a theme
- 
+ 
Choose a Language
@@ -69,7 +69,12 @@ This channel ID has to be used as the target when calling the notification servi
"target": [
"1234567890",
"0987654321"
- ]
+ ],
+ "data": {
+ "images": [
+ "/tmp/garage_cam.jpg"
+ ]
+ }
}
```
diff --git a/source/_components/notify.html5.markdown b/source/_components/notify.html5.markdown
index 36dd74067e6..57e6ce10e38 100644
--- a/source/_components/notify.html5.markdown
+++ b/source/_components/notify.html5.markdown
@@ -72,7 +72,7 @@ The `html5` platform can only function if all of the following requirements are
Assuming you have already added the platform to your configuration:
1. Open Home Assistant in Chrome or Firefox.
-2. Assuming you have met all the [requirements](#requirements) above, you should see a new slider for Push Notifications through the sidebar Configuration > General.
+2. Assuming you have met all the [requirements](#requirements) above, you should see a new slider for Push Notifications through the profile page Profile > Push notifications.
3. Slide it to the on position.
4. Within a few seconds you should be prompted to allow notifications from Home Assistant.
5. Assuming you accept, that's all there is to it!
diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown
index 78945fc3761..4e81f1e2362 100644
--- a/source/_components/notify.knx.markdown
+++ b/source/_components/notify.knx.markdown
@@ -17,6 +17,8 @@ The `knx` notify platform allows you to send notifications to [KNX](http://www.k
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
+## {% linkable_title Configuration %}
+
To use your KNX switch in your installation, add the following lines to your `configuration.yaml` file:
```yaml
@@ -26,5 +28,8 @@ notify:
address: '5/1/10'
```
+Configuration variables:
+
+* **address** (*Required*): KNX group address of the notification.
* **name** (*Optional*): A name for this device used within Home Assistant.
-* **address**: KNX group address of the notification
+
diff --git a/source/_components/notify.mailgun.markdown b/source/_components/notify.mailgun.markdown
index 9e98d180524..93695c7e458 100644
--- a/source/_components/notify.mailgun.markdown
+++ b/source/_components/notify.mailgun.markdown
@@ -22,8 +22,7 @@ The Mailgun notification service allows you to send emails via Mailgun's REST AP
# Example configuration.yaml entry
mailgun:
domain: mg.example.com
- api_key: token-XXXXXXXXX
- sandbox: False
+ api_key: XXXXXXXXXXXXXX
notify:
- name: mailgun
@@ -33,11 +32,11 @@ notify:
Configuration variables:
-- **domain** (*Optional*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up.
-- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`.
-- **token** (*Required*): This is the API token that has been generated in your Mailgun account.
+- **domain** (*Required*): This is the domain name to be used when sending out mail.
+- **sandbox** (*Deprecated*): If a sandboxed domain is used, specify it in `domain`. Defaults to `False`.
+- **api_key** (*Required*): This is the API Key that has been generated in your Mailgun account.
- **recipient** (*Required*): The email address of the recipient.
-- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is outgoint mail domain, as defined by the `domain` and `sanbox` configuration entries.
+- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is the outgoing mail domain, as defined by the `domain` configuration entry.
## {% linkable_title Example automation %}
diff --git a/source/_components/notify.mycroft.markdown b/source/_components/notify.mycroft.markdown
index 81917884998..d868b43331a 100644
--- a/source/_components/notify.mycroft.markdown
+++ b/source/_components/notify.mycroft.markdown
@@ -12,4 +12,9 @@ ha_category: Notifications
ha_release: "0.53"
---
-Please see the main [Mycroft Component](/components/mycroft)
+The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/).
+
+Please check the [`mycroft` component](/components/mycroft/) for details.
+
+To use notifications, please see the [getting started with automation page](/getting-started/automation/).
+
diff --git a/source/_components/notify.mysensors.markdown b/source/_components/notify.mysensors.markdown
index 3dab5bc10dd..085f9b87cfc 100644
--- a/source/_components/notify.mysensors.markdown
+++ b/source/_components/notify.mysensors.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mysensors.png
-ha_category: Notifications
+ha_category: DIY
ha_release: 0.36
ha_iot_class: "Local Push"
---
diff --git a/source/_components/notify.rest.markdown b/source/_components/notify.rest.markdown
index 4d1d83c5813..d46ca8e932d 100644
--- a/source/_components/notify.rest.markdown
+++ b/source/_components/notify.rest.markdown
@@ -29,7 +29,7 @@ Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **resource** (*Required*): The resource or endpoint that will receive the value.
-- **method** (*Optional*): The method of the request. Default is GET.
+- **method** (*Optional*): The method of the request. Default is `GET`. Other valid options are `POST` or `POST_JSON`.
- **headers** (*Optional*): The headers for the request.
- **message_param_name** (*Optional*): Parameter name for the message. Defaults to `message`.
- **title_param_name** (*Optional*): Parameter name for the title. Defaults to none.
diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown
index 69e22a94e60..a4893d35c97 100644
--- a/source/_components/openuv.markdown
+++ b/source/_components/openuv.markdown
@@ -8,23 +8,19 @@ comments: false
sharing: true
footer: true
logo: openuv.jpg
-ha_category: Hub
+ha_category: Health
ha_release: 0.76
ha_iot_class: "Cloud Polling"
---
-The `openuv` component displays UV and Ozone data from
-[openuv.io](http://openuv.io).
+The `openuv` component displays UV and Ozone data from [openuv.io](http://openuv.io).
## {% linkable_title Generating an API Key %}
To generate an API key, [simply log in to the OpenUV website](https://www.openuv.io/auth/google).
-The "Limited" plan (which is what new users are given by default) is limited to -500 API requests per day. In order to leave a buffer, the `openuv` component -queries the API every 30 minutes by default. This value can be modifed (via the -`scan_interval` key), but please note that over-running the API will require +The "Limited" plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the `openuv` component queries the API every 30 minutes by default. This value can be modifed (via the `scan_interval` key), but please note that over-running the API will require you to upgrade to a paid plan (and may disable your access in the meantime).
@@ -38,9 +34,7 @@ openuv: api_key: YOUR_OPENUV_API_KEY ``` -To configure additional functionality, add configuration options beneath -a `binary_sensor` and/or `sensor` key within the `openuv` section of -`configuration.yaml` as below: +To configure additional functionality, add configuration options beneath a `binary_sensor` and/or `sensor` key within the `openuv` section of `configuration.yaml` as below: ```yaml openuv: @@ -87,8 +81,7 @@ sensors: ### {% linkable_title `uv_protection_window` %} -This sensor displays `true` if UV protection (sunscreen, etc.) is recommended -at the current date and time; displays `false` otherwise. +This sensor displays `true` if UV protection (sunscreen, etc.) is recommended at the current date and time; displays `false` otherwise. ## {% linkable_title Sensor Types %} @@ -102,19 +95,15 @@ This sensor displays the current UV index. ### {% linkable_title `current_uv_level` %} -This sensor displays the level of current UV index, which is calculated based -on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors). +This sensor displays the level of current UV index, which is calculated based on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors). ### {% linkable_title `max_uv_index` %} -This sensor displays the maximum UV index that will be encountered that day (at -solar noon). +This sensor displays the maximum UV index that will be encountered that day (at solar noon). ### {% linkable_title `safe_exposure_time_type_X` %} -These sensors display the approximate number of minutes a particular skin type -can be exposed to the sun before burning/tanning starts. Each sensor depicts -a skin type based on the +These sensors display the approximate number of minutes a particular skin type can be exposed to the sun before burning/tanning starts. Each sensor depicts a skin type based on the [Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale): * Skin Type I @@ -125,7 +114,5 @@ a skin type based on the * Skin Type VI-The above guidelines constitude estimates and are intended to help informed -decision making. They should not replace analysis, advice, or diagnosis from a -trained medical professional. +The above guidelines constitude estimates and are intended to help informed decision making. They should not replace analysis, advice, or diagnosis from a trained medical professional.
diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 45e98323815..05b3ce1fbec 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Hub +ha_category: DIY ha_release: 0.26 ha_iot_class: "Local Push" --- diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 6beaa00557f..df2947e19da 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Other +ha_category: Environment ha_release: 0.44 --- This`plant`component lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits. +## {% linkable_title Configuration %} + To use your `plant` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/rachio.markdown b/source/_components/rachio.markdown index b27edc4017d..25f54b65118 100644 --- a/source/_components/rachio.markdown +++ b/source/_components/rachio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rachio.png -ha_category: Hub +ha_category: Irrigation ha_iot_class: "Cloud Push" ha_release: 0.73 --- @@ -22,6 +22,8 @@ The `rachio` platform allows you to control your [Rachio irrigation system](http 1. Click "Get API Key" 1. Copy the API key from the dialog that opens. +## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 413a612fdc5..187173c1f78 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.61 ha_iot_class: "Local Polling" --- This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +## {% linkable_title Configuration %} + To enable it, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/raincloud.markdown b/source/_components/raincloud.markdown index 3eb377e0468..b73766cac17 100644 --- a/source/_components/raincloud.markdown +++ b/source/_components/raincloud.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Hub +ha_category: Irrigation ha_release: 0.55 --- The `raincloud` component allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant. +## {% linkable_title Configuration %} + To enable it, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index 42027fe9182..7bb254ef5d3 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.69 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/remote.harmony.markdown b/source/_components/remote.harmony.markdown old mode 100755 new mode 100644 diff --git a/source/_components/remote.itach.markdown b/source/_components/remote.itach.markdown old mode 100755 new mode 100644 diff --git a/source/_components/remote.markdown b/source/_components/remote.markdown old mode 100755 new mode 100644 diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index 4daf012653f..e600e3e140a 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ring.png -ha_category: Hub +ha_category: Doorbell ha_release: 0.42 --- @@ -16,6 +16,8 @@ The `ring` implementation allows you to integrate your [Ring.com](https://ring.c Currently only doorbells are supported by this sensor. +## {% linkable_title Configuration %} + To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index e77b6571811..c9752de20c3 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -16,6 +16,10 @@ The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + +To use your KNX scence in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry scene: @@ -27,8 +31,7 @@ scene: Configuration variables: +- **address** (*Required*): KNX group address of the binary sensor. +- **scene_number** (*Required*): KNX scene number to be activated. - **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address of the binary sensor. -- **scene_number** KNX scene number to be activated. - diff --git a/source/_components/sensor.airvisual.markdown b/source/_components/sensor.airvisual.markdown index 896c09234c3..2cde892cddb 100644 --- a/source/_components/sensor.airvisual.markdown +++ b/source/_components/sensor.airvisual.markdown @@ -13,30 +13,17 @@ ha_release: 0.53 ha_iot_class: "Cloud Polling" --- -The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) -API for air quality data. Data can be collected via latitude/longitude or by -city/state/country. The resulting information creates sensors for the Air -Quality Index (AQI), the human-friendly air quality level, and the main -pollutant of that area. Sensors that conform to either/both the -[U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366) -can be created. +The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality data. Data can be collected via latitude/longitude or by city/state/country. The resulting information creates sensors for the Air Quality Index (AQI), the human-friendly air quality level, and the main pollutant of that area. Sensors that conform to either/both the [U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366) can be created. -This platform requires an AirVisual API key, which can be obtained -[here](https://airvisual.com/api). Note that the platform was designed using -the "Community" package; the "Startup" and "Enterprise" package keys should -continue to function, but actual results may vary (or not work at all). +This platform requires an AirVisual API key, which can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all).-The "Community" API key is limited to 10,000 calls per month. In order to leave -a buffer, the `airvisual` platform queries the API every 10 minutes by default. -Modification of this (via the `scan_interval` key) to a too-low value may -result in your API key being deactivated. +The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated.
-## {% linkable_title Configuring the Platform via Latitude/Longitude %} +## {% linkable_title Configuration via Latitude/Longitude %} -To enable the platform and gather data via latitude/longitude, add the -following lines to your `configuration.yaml` file: +To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file: ```yaml sensor: @@ -58,59 +45,53 @@ sensor: {% configuration %} api_key: - description: your AirVisual API key + description: Your AirVisual API key. required: required type: string monitored_conditions: - description: the air quality standard(s) to use (`us` for U.S., `cn` for Chinese) + description: "The air quality standard(s) to use (`us` for U.S., `cn` for Chinese)." required: required type: list default: ['us', 'cn'] show_on_map: - description: whether to show a marker on the map at the specified location + description: "Whether to show a marker on the map at the specified location." required: optional type: boolean default: true scan_interval: - description: the rate at which AirVisual should be polled for new data + description: "The rate at which AirVisual should be polled for new data." required: optional type: int default: 600 latitude: - description: the latitude of the location to monitor + description: The latitude of the location to monitor. required: optional type: str - default: the latitude defined under the `homeassistant` key in `configuration.yaml` + default: "The latitude defined under the `homeassistant` key in `configuration.yaml`." longitude: - description: the longitude of the location to monitor + description: The longitude of the location to monitor. required: optional - type: str - default: the longitude defined under the `homeassistant` key in `configuration.yaml` + type: string + default: "The longitude defined under the `homeassistant` key in `configuration.yaml`." city: - description: the city to monitor + description: The city to monitor. required: optional - type: str + type: string state: - description: the state the city belongs to + description: The state the city belongs to. required: optional - type: str + type: string country: - description: the country the state belongs to + description: The country the state belongs to. required: optional - type: str + type: string {% endconfiguration %} ## {% linkable_title Determining the City/State/Country %} -To easily determine the proper values for a particular location, use the -[AirVisual region directory](https://airvisual.com/world). Once you browse to -the particular city you want, take note of the breadcrumb title, which is of -the form `country > state/region > city`. Use this information to fill out -`configuration.yaml`. +To easily determine the proper values for a particular location, use the [AirVisual region directory](https://airvisual.com/world). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`. -For example, Sao Paulo, Brazil shows a breadcrumb title of -`Brazil > Sao Paulo > Sao Paulo` – thus, the proper configuration would look -like this: +For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo > Sao Paulo`. Thus, the proper configuration would look like this: ```yaml sensor: @@ -126,19 +107,14 @@ sensor: ## {% linkable_title Sensor Types %} -When configured, the platform will create three sensors for each configured -air quality standard: +When configured, the platform will create three sensors for each configured air quality standard: ### Air Quality Index -**Description:** This sensor displays a numeric air quality index (AQI), a -metric for the overall "health" of the air. - -**Example Sensor Name:** `sensor.chinese_air_quality_index` - -**Example Sensor Value:** `32` - -**Explanation:** +- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air. +- **Example Sensor Name:** `sensor.chinese_air_quality_index` +- **Example Sensor Value:** `32` +- **Explanation:** AQI | Status | Description ------- | :----------------: | ---------- @@ -151,23 +127,16 @@ AQI | Status | Description ### Air Pollution Level -**Description:** This sensor displays the associated `Status` (from the above -table) for the current AQI. - -**Sample Sensor Name:** `sensor.us_air_pollution_level` - -**Example Sensor Value:** `Moderate` +- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI. +- **Sample Sensor Name:** `sensor.us_air_pollution_level` +- **Example Sensor Value:** `Moderate` ### Main Pollutant -**Description:** This sensor displays the pollutant whose value is currently -highest. - -**Sample Sensor Name:** `sensor.us_main_pollutant` - -**Example Sensor Value:** `PM2.5` - -**Explanation:** +- **Description:** This sensor displays the pollutant whose value is currently highest. +- **Sample Sensor Name:** `sensor.us_main_pollutant` +- **Example Sensor Value:** `PM2.5` +- **Explanation:** Pollutant | Symbol | More Info ------- | :----------------: | ---------- @@ -176,3 +145,4 @@ Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution ](https Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution) Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution) Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution) + diff --git a/source/_components/sensor.apcupsd.markdown b/source/_components/sensor.apcupsd.markdown index 54db50e7520..bfaf33769b6 100644 --- a/source/_components/sensor.apcupsd.markdown +++ b/source/_components/sensor.apcupsd.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command. +## {% linkable_title Configuration %} + To use this sensor platform, you first have to set up [apcupsd](/components/apcupsd/), and add the following to your `configuration.yaml` file: ```yaml @@ -24,14 +26,6 @@ sensor: resources: - bcharge - linev - - loadpct - - nominv - - nompower - - numxfers - - outputv - - status - - timeleft - - tonbatt ``` Configuration variables: @@ -64,37 +58,7 @@ MAXTIME : 0 Seconds MAXLINEV : 249.6 Volts MINLINEV : 244.4 Volts OUTPUTV : 218.4 Volts -SENSE : High -DWAKE : 0 Seconds -DSHUTD : 180 Seconds -DLOWBATT : 2 Minutes -LOTRANS : 196.0 Volts -HITRANS : 253.0 Volts -RETPCT : 15.0 Percent -ITEMP : 30.6 C -ALARMDEL : Low Battery -BATTV : 27.6 Volts -LINEFREQ : 50.0 Hz -LASTXFER : High line voltage -NUMXFERS : 0 -TONBATT : 0 Seconds -CUMONBATT: 0 Seconds -XOFFBATT : N/A -SELFTEST : NO -STESTI : 336 -STATFLAG : 0x0500000A -DIPSW : 0x00 -REG1 : 0x00 -REG2 : 0x00 -REG3 : 0x00 -MANDATE : 07/13/99 -SERIALNO : GS9888761008 -BATTDATE : 13/11/15 -NOMOUTV : 230 Volts -NOMBATTV : 24.0 Volts -EXTBATTS : 0 -FIRMWARE : 70.11.I -END APC : 2016-02-09 17:13:46 +0000 +[...] ``` Use the (case insensitive) values from the left hand column: @@ -105,5 +69,5 @@ sensor: resources: - linev - loadpct - - itemp + - timeleft ``` diff --git a/source/_components/sensor.api_stream.markdown b/source/_components/sensor.api_stream.markdown index c363e885332..cdc4541c29d 100644 --- a/source/_components/sensor.api_stream.markdown +++ b/source/_components/sensor.api_stream.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_release: 0.33 ha_iot_class: "Local Push" --- The `api_stream` sensor platform shows how many clients are connected to the stream API +## {% linkable_title Configuration %} + To add the connected clients to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.arest.markdown b/source/_components/sensor.arest.markdown index 4f7c68732fc..4bb0a11ad78 100644 --- a/source/_components/sensor.arest.markdown +++ b/source/_components/sensor.arest.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: arest.png -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Polling" ha_release: pre 0.7 --- @@ -16,6 +16,8 @@ ha_release: pre 0.7 The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +## {% linkable_title Configuration %} + To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bbox.markdown b/source/_components/sensor.bbox.markdown index ec3be264acc..a45e4bdb5ed 100644 --- a/source/_components/sensor.bbox.markdown +++ b/source/_components/sensor.bbox.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: bbox.png -ha_category: Sensor +ha_category: Network ha_release: 0.31 ha_iot_class: "Local Push" --- @@ -19,6 +19,8 @@ The `bbox` platform uses the [Bbox Modem Router](https://fr.wikipedia.org/wiki/B Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser. +## {% linkable_title Configuration %} + To add Bbox sensors to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bh1750.markdown b/source/_components/sensor.bh1750.markdown index 4910cdfba0a..b7bae73cf1e 100644 --- a/source/_components/sensor.bh1750.markdown +++ b/source/_components/sensor.bh1750.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.48 ha_iot_class: "Local Push" --- @@ -20,6 +20,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.bloomsky.markdown b/source/_components/sensor.bloomsky.markdown index 61b850de1e1..d2e1ca31a50 100644 --- a/source/_components/sensor.bloomsky.markdown +++ b/source/_components/sensor.bloomsky.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Cloud Polling" The `bloomsky` sensor component allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](/components/camera.bloomsky). +## {% linkable_title Configuration %} + To enable these sensors in your installation, set up the [BloomSky component](/components/bloomsky) with your API key add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bme280.markdown b/source/_components/sensor.bme280.markdown index 7dd524405a3..7887aff3dde 100644 --- a/source/_components/sensor.bme280.markdown +++ b/source/_components/sensor.bme280.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.48 ha_iot_class: "Local Push" --- @@ -20,6 +20,8 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} + To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bme680.markdown b/source/_components/sensor.bme680.markdown index 05d42769c1b..b32f23ab5d7 100644 --- a/source/_components/sensor.bme680.markdown +++ b/source/_components/sensor.bme680.markdown @@ -8,18 +8,20 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.62 ha_iot_class: "Local Push" --- -The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf) connected via an [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement. +The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf) connected via an [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement. Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} + To use your BME680 sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bmw_connected_drive.markdown b/source/_components/sensor.bmw_connected_drive.markdown index 083e5124a69..9100fb4b71b 100644 --- a/source/_components/sensor.bmw_connected_drive.markdown +++ b/source/_components/sensor.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Sensor +ha_category: Car ha_release: 0.64 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +The `bmw_connected_drive` sensor platform allows you to import data on your BMW into Home Assistant. The sensors will be automatically configured if the `bmw_connected_drive` component is configured. diff --git a/source/_components/sensor.canary.markdown b/source/_components/sensor.canary.markdown index 25efd713e39..79239f075bc 100644 --- a/source/_components/sensor.canary.markdown +++ b/source/_components/sensor.canary.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: canary.png -ha_category: Sensor +ha_category: Environment ha_release: "0.60" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.cert_expiry.markdown b/source/_components/sensor.cert_expiry.markdown index 23682318933..99b0578b76b 100644 --- a/source/_components/sensor.cert_expiry.markdown +++ b/source/_components/sensor.cert_expiry.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: System Monitor +ha_category: Network ha_release: 0.44 ha_iot_class: "depends" --- The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days. +## {% linkable_title Configuration %} + To add the Certificate Expiry sensor to your installation, add these options to `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.citybikes.markdown b/source/_components/sensor.citybikes.markdown index 7b4aced03ac..c23e5783aaa 100644 --- a/source/_components/sensor.citybikes.markdown +++ b/source/_components/sensor.citybikes.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "CityBikes API sensor" +title: "CityBikes Sensor" description: "Instructions on how to integrate data from the CityBikes API into Home Assistant." date: 2017-06-25 14:20 sidebar: true @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: citybikes.png -ha_category: Sensor +ha_category: Transport ha_release: 0.49 --- The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world. +## {% linkable_title Configuration %} + To enable it, add the following lines to your `configuration.yaml`: ```yaml @@ -33,6 +35,8 @@ Configuration options: - **radius** (*Optional*): The radius (in meters or feet, depending on the Home Assistant configuration) around the monitored location. Only stations closer than this distance will be monitored. - **stations** array (*Optional*): A list of specific stations to monitor. The list should contain station `ID`s or `UID`s, which can be obtained from the CityBikes API. +## {% linkable_title Example %} + Additional configuration samples: ```yaml diff --git a/source/_components/sensor.coinbase.markdown b/source/_components/sensor.coinbase.markdown index c506d823417..537b10f9973 100644 --- a/source/_components/sensor.coinbase.markdown +++ b/source/_components/sensor.coinbase.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: coinbase.png -ha_category: Sensor +ha_category: Finance ha_release: 0.61 --- diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index 238c46f7f61..94e85385128 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: command_line.png -ha_category: Sensor +ha_category: Utility ha_release: pre 0.7 ha_iot_class: "Local Polling" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `command_line` sensor platform that issues specific commands to get data. This might become our most powerful platform as it allows anyone to integrate any type of sensor into Home Assistant that can get data from the command line. +## {% linkable_title Configuration %} + To enable it, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.crimereports.markdown b/source/_components/sensor.crimereports.markdown index 1bb1b89d052..e80d504a51f 100644 --- a/source/_components/sensor.crimereports.markdown +++ b/source/_components/sensor.crimereports.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Social logo: crimereports.png ha_release: 0.42 ha_iot_class: "Cloud Polling" @@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling" The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day. -## Configuration +## {% linkable_title Configuration %} To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area. @@ -36,13 +36,13 @@ Configuration options for the Crime Reports Sensor: - **exclude** (*Optional*): List of incident types to exclude. -## Notes +## {% linkable_title Notes %} -### Area +### {% linkable_title Area %} Crime Reports captures all incidents in a region defined by a square shape. Home Assistant zones are circular. Therefore, the region defined by a Home Assistant zone in a Crime Reports context is a square that is big enough to fit the zone circle. Practically, this means some incidents may be captured that are outside your zone. -### Incident Types +### {% linkable_title Incident Types %} You can explicitly include or exclude incident types. Specifying `include`s restricts the incidents to those types. Specifying `exclude`s will return all incident types except those specified. @@ -83,6 +83,6 @@ These incident types are available: - Vehicle Stop - Weapons Offense -### Events +### {% linkable_title Events %} The `crimealerts` sensor fires a `crimealerts_incident` event when a new incident is detected, including the type, description, time, location, and coordinates of the incident. diff --git a/source/_components/sensor.daikin.markdown b/source/_components/sensor.daikin.markdown index 20831781606..5d9ba959592 100644 --- a/source/_components/sensor.daikin.markdown +++ b/source/_components/sensor.daikin.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Daikin AC" +title: "Daikin AC Sensor" description: "Instructions on how to integrate Daikin AC(s) with Home Assistant." date: 2017-12-03 05:00 sidebar: True @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: daikin.png -ha_category: Sensor +ha_category: Environment ha_release: 0.59 ha_iot_class: "Local Polling" --- @@ -16,12 +16,10 @@ ha_iot_class: "Local Polling" The `daikin` sensor platform integrates Daikin air conditioning systems into Home Assistant, enabling displaying the following parameters: -- **inside temperature** -- **outside temperature** +- Inside temperature +- Outside temperature --Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. -
+## {% linkable_title Configuration %} To enable the platform manually, add the following lines to your `configuration.yaml` file: @@ -52,6 +50,3 @@ monitored_conditions: description: The current temperature measured outside the house. {% endconfiguration %} -- Please note that some AC devices may report outside temperature only when they are turned on. -
diff --git a/source/_components/sensor.dht.markdown b/source/_components/sensor.dht.markdown index 1898ab35d4f..65a16633bda 100644 --- a/source/_components/sensor.dht.markdown +++ b/source/_components/sensor.dht.markdown @@ -14,7 +14,9 @@ ha_iot_class: "Local Polling" --- -The `dht` sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22, or AM2302 device. +The `dht` sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22 or AM2302 device. + +## {% linkable_title Configuration %} To use your DHTxx sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.discogs.markdown b/source/_components/sensor.discogs.markdown index 281852abc79..ec600a21b44 100644 --- a/source/_components/sensor.discogs.markdown +++ b/source/_components/sensor.discogs.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: https://www.magneticmag.com/.image/t_share/MTQ5OTE1NzU4NTczMzk3OTYw/discogs-vinyl-record-mark.png -ha_category: Sensor +ha_category: Multimedia ha_release: 0.61 logo: discogs.png ha_iot_class: "Cloud Polling" @@ -16,9 +16,13 @@ ha_iot_class: "Cloud Polling" The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection. +## {% linkable_title Setup %} + First, you'll need to get a personal access token from your Discogs account. You can generate a token from your profile's [Developer settings](https://www.discogs.com/settings/developers). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.dnsip.markdown b/source/_components/sensor.dnsip.markdown index 3eeff8b0c1e..0850e3696d3 100644 --- a/source/_components/sensor.dnsip.markdown +++ b/source/_components/sensor.dnsip.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "DNS IP" +title: "DNS IP Sensor" description: "Instructions on how to integrate a DNS IP sensor into Home Assistant." date: 2017-02-25 11:05 sidebar: true @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Network ha_iot_class: "Cloud Polling" ha_release: "0.40" --- @@ -21,6 +21,8 @@ The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its You may also override the nameserver that is being used by setting the `resolver` parameter to any nameserver you like. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.duke_energy.markdown b/source/_components/sensor.duke_energy.markdown index 1d1bb410d5e..2e120441b3d 100644 --- a/source/_components/sensor.duke_energy.markdown +++ b/source/_components/sensor.duke_energy.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: duke_energy.png -ha_category: Sensor +ha_category: Energy ha_release: "0.74" ha_iot_class: "Cloud Polling" --- The `duke_energy` sensor platform allows you get the previous days usage for all of your Duke Energy smart meters. +## {% linkable_title Setup %} + You will only have access to meters listed in your account at [Duke Energy Usage](https://www.duke-energy.com/my-account/usage-analysis). This supports both electric and gas meters. Along with previous days usage, each sensor will have attributes for the previous bills total usage and average usage. diff --git a/source/_components/sensor.dyson.markdown b/source/_components/sensor.dyson.markdown index 022d778ceb6..8a1cd8a1efb 100644 --- a/source/_components/sensor.dyson.markdown +++ b/source/_components/sensor.dyson.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: dyson.png -ha_category: Sensor +ha_category: Environment ha_iot_class: "Cloud Polling" ha_release: 0.47 --- diff --git a/source/_components/sensor.ebox.markdown b/source/_components/sensor.ebox.markdown index d2ad1a9cb5c..c71643c4c81 100644 --- a/source/_components/sensor.ebox.markdown +++ b/source/_components/sensor.ebox.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "EBox" +title: "EBox Sensor" description: "Instructions on how to integrate EBox data usage within Home Assistant." date: 2017-02-15 17:17 sidebar: true @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ebox.png -ha_category: Sensor +ha_category: Network ha_release: 0.39 ha_iot_class: "Cloud Polling" --- Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant. +## {% linkable_title Configuration %} + To use your EBox sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.ecobee.markdown b/source/_components/sensor.ecobee.markdown index 19491a566eb..e05a714d371 100644 --- a/source/_components/sensor.ecobee.markdown +++ b/source/_components/sensor.ecobee.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ecobee.png -ha_category: Binary Sensor +ha_category: Environment ha_release: 0.9 ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.eight_sleep.markdown b/source/_components/sensor.eight_sleep.markdown index 2d78d94f705..23e4ce46ed2 100644 --- a/source/_components/sensor.eight_sleep.markdown +++ b/source/_components/sensor.eight_sleep.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: eight_sleep.png -ha_category: Sensor +ha_category: Health ha_release: "0.44" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.enphase_envoy.markdown b/source/_components/sensor.enphase_envoy.markdown index fb04d906ed4..ec6d8002162 100644 --- a/source/_components/sensor.enphase_envoy.markdown +++ b/source/_components/sensor.enphase_envoy.markdown @@ -23,33 +23,44 @@ To enable this sensor, add the following lines to your `configuration.yaml` file # Example configuration.yaml entry sensor: - platform: enphase_envoy - ip_address: ENVOY_LOCAL_IP_ADDRESS +``` + +```yaml +# Example configuration.yaml entry +sensor: + - platform: enphase_envoy + ip_address: LOCAL_IP_FOR_ENVOY + monitored_conditions: + - production + - consumption + - lifetime_production + - lifetime_consumption ``` {% configuration %} ip_address: - description: The local IP Address of your Envoy - required: true + description: The local IP Address of your Envoy. Leave blank to search for it, but this may not always be reliable. + required: false type: string monitored_conditions: - description: The list of conditions to monitor + description: The list of conditions to monitor. required: false type: list keys: production: - description: The power in W being produced by the solar panels + description: The power in W being produced by the solar panels. daily_production: - description: The energy in Wh produced that day - 7_days_production: - description: The energy in Wh produced the last 7 days + description: The energy in Wh produced that day. + seven_days_production: + description: The energy in Wh produced the last 7 days. lifetime_production: - description: The energy in Wh produced in the lifetime of the Envoy + description: The energy in Wh produced in the lifetime of the Envoy. consumption: - description: The power in W being consumed in the whole house + description: The power in W being consumed in the whole house. daily_consumption: - description: The energy in Wh consumed that day - 7_days_consumption: - description: The energy in Wh consumed the last 7 days + description: The energy in Wh consumed that day. + seven_days_consumption: + description: The energy in Wh consumed the last 7 days. lifetime_consumption: - description: The energy in Wh consumed in the lifetime of the Envoy + description: The energy in Wh consumed in the lifetime of the Envoy. {% endconfiguration %} diff --git a/source/_components/sensor.envirophat.markdown b/source/_components/sensor.envirophat.markdown index 9863a4ab3b5..0e41d737225 100644 --- a/source/_components/sensor.envirophat.markdown +++ b/source/_components/sensor.envirophat.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.44 --- diff --git a/source/_components/sensor.fail2ban.markdown b/source/_components/sensor.fail2ban.markdown index ca1467cf1b1..20f46f6f15c 100644 --- a/source/_components/sensor.fail2ban.markdown +++ b/source/_components/sensor.fail2ban.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Network ha_iot_class: "Local Polling" logo: fail2ban.png ha_release: 0.57 @@ -20,6 +20,8 @@ The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.o Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, Home Assistant must be able to read the `fail2ban` log file. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.fedex.markdown b/source/_components/sensor.fedex.markdown index acbdf251d62..00e8a6c1b62 100644 --- a/source/_components/sensor.fedex.markdown +++ b/source/_components/sensor.fedex.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: fedex.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.39 ha_iot_class: "Cloud Polling" --- The `fedex` platform allows one to track deliveries by [FedEx](http://www.fedex.com/). To use this sensor, you need a [FedEx Delivery Manager](https://www.fedex.com/us/delivery/) account. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.fido.markdown b/source/_components/sensor.fido.markdown index edb59195a38..4331701e3e4 100644 --- a/source/_components/sensor.fido.markdown +++ b/source/_components/sensor.fido.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Fido" +title: "Fido Sensor" description: "Instructions on how to integrate Fido data usage within Home Assistant." date: 2017-01-01 17:17 sidebar: true @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: fido.png -ha_category: Sensor +ha_category: Network ha_release: 0.39 ha_iot_class: "Cloud Polling" --- @@ -16,7 +16,9 @@ ha_iot_class: "Cloud Polling" Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant. -To enable this sensor, add the following lines to your `configuration.yaml`: +## {% linkable_title Configuration %} + +To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.file.markdown b/source/_components/sensor.file.markdown index 8ae7216a7d7..627e7f28ff2 100644 --- a/source/_components/sensor.file.markdown +++ b/source/_components/sensor.file.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: file.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.45 --- @@ -16,6 +16,8 @@ ha_release: 0.45 The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). +## {% linkable_title Configuration %} + To enable the `file` sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.filesize.markdown b/source/_components/sensor.filesize.markdown index 3178fa6e3cf..c52057294ee 100644 --- a/source/_components/sensor.filesize.markdown +++ b/source/_components/sensor.filesize.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "File size sensor" +title: "File size Sensor" description: "Component for monitoring the size of a file." date: 2018-02-06 14:00 sidebar: true @@ -8,13 +8,16 @@ comments: false sharing: true footer: true logo: file.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.64 --- -Component for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). -Add to your config: +The `filesize` sensor for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). + +## {% linkable_title Configuration %} + +To enable the `filesize` sensor, add the following lines to your `configuration.yaml`: ```yaml sensor: diff --git a/source/_components/sensor.filter.markdown b/source/_components/sensor.filter.markdown index 5e2834eebca..a0a07337a70 100644 --- a/source/_components/sensor.filter.markdown +++ b/source/_components/sensor.filter.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Utility ha_release: 0.65 ha_iot_class: "Local Push" logo: home-assistant.png @@ -21,8 +21,9 @@ The `filter` platform enables sensors that process the states of other entities.
-To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file:
+## {% linkable_title Configuration %}
+To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
diff --git a/source/_components/sensor.fints.markdown b/source/_components/sensor.fints.markdown
index 79351f765e3..e871ba3cb97 100644
--- a/source/_components/sensor.fints.markdown
+++ b/source/_components/sensor.fints.markdown
@@ -7,14 +7,16 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Sensor
-ha_release: 0.70
+ha_category: Finance
+ha_release: "0.70"
ha_iot_class: "Local Push"
logo: home-assistant.png
---
With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline.
+## {% linkable_title Configuration %}
+
For each account you have with the bank, a separate sensor is created. If you have several accounts with a bank, you can select which ones you want to have, and you can also give the accounts a name.
{% raw %}
@@ -70,5 +72,4 @@ To find out the configuration for your bank, check their website or call their h
description: (optional) Use this field to give the account a meaningful name.
required: false
type: string
-
{% endconfiguration %}
diff --git a/source/_components/sensor.folder.markdown b/source/_components/sensor.folder.markdown
index 292e7366ea6..878d8e45a0c 100644
--- a/source/_components/sensor.folder.markdown
+++ b/source/_components/sensor.folder.markdown
@@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: file.png
-ha_category: Sensor
+ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.64
---
Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes.
+## {% linkable_title Configuration %}
+
To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.fritzbox_callmonitor.markdown b/source/_components/sensor.fritzbox_callmonitor.markdown
index 6e50df044b1..013a8af18ec 100644
--- a/source/_components/sensor.fritzbox_callmonitor.markdown
+++ b/source/_components/sensor.fritzbox_callmonitor.markdown
@@ -84,7 +84,7 @@ automation:
entity_id: sensor.phone
action:
- service: notify.notify
- data:
+ data_template:
title: "Phone"
message: >-
{% if is_state("sensor.phone", "idle") %}
diff --git a/source/_components/sensor.google_travel_time.markdown b/source/_components/sensor.google_travel_time.markdown
index 4fb24f39d07..92046fd4a62 100644
--- a/source/_components/sensor.google_travel_time.markdown
+++ b/source/_components/sensor.google_travel_time.markdown
@@ -13,11 +13,19 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.19
---
-Sensor to provide travel time from the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/).
+The `google_travel_time` sensor provides travel time from the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/).
+
+## {% linkable_title Setup %}
You need to register for an API key by following the instructions [here](https://github.com/googlemaps/google-maps-services-python#api-keys). You only need to turn on the Distance Matrix API.
-A free API Key allows 2500 requests per day. The sensor will update the travel time every 5 minutes.
+[Google now require billing](https://mapsplatform.googleblog.com/2018/05/introducing-google-maps-platform.html) to be enabled (and a valid credit card loaded) to access Google Maps APIs. The Distance Matrix API is billed at US$10 per 1000 requests, however a US$200 per month credit is applied (20,000 requests). By default, the sensor will update the travel time every 5 minutes, making approximately 288 calls per day. Note that at this rate, more than 2 sensors will likely exceed the free credit amount. If you need to run more than 2 sensors, consider changing the [scan interval](/docs/configuration/platform_options/#scan-interval) to something longer than 5 minutes to stay within the free credit limit.
+
+A quota can be set against the API to avoid exceeding the free credit amount. Set the 'Elements per day' to a limit of 645 or less. Details on how to configure a quota can be found [here](https://developers.google.com/maps/documentation/distance-matrix/usage-and-billing#set-caps)
+
+## {% linkable_title Configuration %}
+
+To enable the sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example entry for configuration.yaml
@@ -40,9 +48,9 @@ Configuration variables:
- **arrival_time** (*Optional*): See notes above for `departure_time`. `arrival_time` can not be `now`, only a Unix timestamp or time string. You can not provide both `departure_time` and `arrival_time`. If you do provide both, `arrival_time` will be removed from the request.
- **units** (*Optional*): Set the unit for the sensor in metric or imperial, otherwise the default unit the same as the unit set in `unit_system:`.
-##### {% linkable_title Dynamic Configuration %}
+## {% linkable_title Dynamic Configuration %}
-Tracking can be setup to track entities of type device_tracker, zone, and sensor. If an entity is placed in the origin or destination then every 5 minutes when the component updates it will use the latest location of that entity.
+Tracking can be setup to track entities of type `device_tracker`, `zone` and `sensor`. If an entity is placed in the origin or destination then every 5 minutes when the platform updates it will use the latest location of that entity.
```yaml
# Example entry for configuration.yaml
@@ -67,10 +75,9 @@ sensor:
destination: zone.home
options:
units: imperial # 'metric' for Metric, 'imperial' for Imperial
-
```
-#### {% linkable_title Entity Tracking %}
+## {% linkable_title Entity Tracking %}
- **device_tracker**
- If state is a zone then the zone location will be used
diff --git a/source/_components/sensor.gpsd.markdown b/source/_components/sensor.gpsd.markdown
index 82448cd970b..d66cc20110f 100644
--- a/source/_components/sensor.gpsd.markdown
+++ b/source/_components/sensor.gpsd.markdown
@@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: gpsd.png
-ha_category: Sensor
+ha_category: Utility
ha_release: 0.26
ha_iot_class: "Local Polling"
---
The `gpsd` component is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver.
+## {% linkable_title Setup %}
+
A requirement is that `gpsd` is installed (`$ sudo apt-get install gpsd` or `$ sudo dnf -y install gpsd`). `gpsd` uses the socket activation feature of systemd on recent Linux distributions for USB receivers. This means that if you plug your GPS receiver in, `gpsd` is started. Other GPS device may work too, but this was not tested.
```bash
@@ -40,6 +42,8 @@ Escape character is '^]'.
{"class":"VERSION","release":"3.15","rev":"3.15-2.fc23","proto_major":3,"proto_minor":11}
```
+## {% linkable_title Configuration %}
+
To setup a GPSD sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -48,8 +52,21 @@ sensor:
- platform: gpsd
```
-Configuration variables:
+{% configuration %}
+host:
+ description: The host where GPSD is running.
+ required: false
+ type: string
+ default: localhost
+port:
+ description: The port which GPSD is using.
+ required: false
+ type: int
+ default: 2947
+name:
+ description: Friendly name to use for the frontend.
+ required: false
+ type: string
+ default: GPS
+{% endconfiguration %}
-- **host** (*Optional*): The host where GPSD is running. Defaults to `localhost`.
-- **port** (*Optional*): The port which GPSD is using. Defaults to `2947`.
-- **name** (*Optional*): Friendly name to use for the frontend. Default to GPS.
diff --git a/source/_components/sensor.history_stats.markdown b/source/_components/sensor.history_stats.markdown
index d1fa2cfa1dc..d324bc26b52 100644
--- a/source/_components/sensor.history_stats.markdown
+++ b/source/_components/sensor.history_stats.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Sensor
+ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.39
---
diff --git a/source/_components/sensor.htu21d.markdown b/source/_components/sensor.htu21d.markdown
index a485fb0c382..fbb513aef4a 100644
--- a/source/_components/sensor.htu21d.markdown
+++ b/source/_components/sensor.htu21d.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
-ha_category: Sensor
+ha_category: DIY
ha_release: 0.48
ha_iot_class: "Local Push"
---
@@ -20,6 +20,8 @@ Tested devices:
- [Raspberry Pi](https://www.raspberrypi.org/)
+## {% linkable_title Configuration %}
+
To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.hydrawise.markdown b/source/_components/sensor.hydrawise.markdown
index ed1fbd52e5e..6268b188504 100644
--- a/source/_components/sensor.hydrawise.markdown
+++ b/source/_components/sensor.hydrawise.markdown
@@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: hydrawise_logo.png
-ha_category: Sensor
+ha_category: Irrigation
ha_release: 0.71
ha_iot_class: Cloud Polling
---
Before setting up the [Hunter Hydrawise](https://hydrawise.com) sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component.
+## {% linkable_title Configuration %}
+
Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown
index a3b9af23b29..f09956e9648 100644
--- a/source/_components/sensor.imap.markdown
+++ b/source/_components/sensor.imap.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: smtp.png
-ha_category: Sensor
+ha_category: Mailbox
ha_release: 0.25
ha_iot_class: "Cloud Push"
---
@@ -16,6 +16,8 @@ ha_iot_class: "Cloud Push"
The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails.
+## {% linkable_title Configuration %}
+
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown
index 22212426f6a..e67340b7ef7 100644
--- a/source/_components/sensor.imap_email_content.markdown
+++ b/source/_components/sensor.imap_email_content.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: smtp.png
-ha_category: Sensor
+ha_category: Mailbox
ha_iot_class: "Local Polling"
ha_release: 0.25
---
@@ -16,6 +16,8 @@ ha_release: 0.25
The `imap_email_content` sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email.
+## {% linkable_title Configuration %}
+
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.juicenet.markdown b/source/_components/sensor.juicenet.markdown
index 03bad7fccc9..df9929c658e 100644
--- a/source/_components/sensor.juicenet.markdown
+++ b/source/_components/sensor.juicenet.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: juicenet.png
-ha_category: Sensor
+ha_category: Energy
ha_release: 0.47
---
diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown
index f7e78920229..6e0921c341a 100644
--- a/source/_components/sensor.knx.markdown
+++ b/source/_components/sensor.knx.markdown
@@ -17,8 +17,26 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensor
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
+## {% linkable_title Configuration %}
+
To use your KNX sensor in your installation, add the following lines to your `configuration.yaml` file:
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: knx
+ name: Heating.Valve1
+ address: '2/0/0'
+```
+
+
+
+- **address** (*Required*): KNX group address of the sensor.
+- **name** (*Optional*): A name for this device used within Home Assistant.
+- **type** (*Optional*): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed".
+
+## {% linkable_title Full example %}
+
```yaml
# Example configuration.yaml entry
sensor:
@@ -31,8 +49,3 @@ sensor:
address: '6/2/1'
type: 'temperature'
```
-
-- **name** (*Optional*): A name for this device used within Home Assistant.
-- **address**: KNX group address of the sensor.
-- **type** (Optional): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed".
-
diff --git a/source/_components/sensor.lacrosse.markdown b/source/_components/sensor.lacrosse.markdown
index 5218a2b710b..b634ccbcd37 100644
--- a/source/_components/sensor.lacrosse.markdown
+++ b/source/_components/sensor.lacrosse.markdown
@@ -8,14 +8,14 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Sensor
+ha_category: DIY
ha_release: 0.58
ha_iot_class: "Local Polling"
---
The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip).
-#### {% linkable_title Tested Devices %}
+### {% linkable_title Tested Devices %}
- Technoline TX 29 IT (temperature only)
- Technoline TX 29 DTH-IT (including humidity)
@@ -27,6 +27,9 @@ Since the sensor change their ID after each powercycle/battery change you can ch
```bash
$ sudo pylacrosse -d /dev/ttyUSB0 scan
```
+
+## {% linkable_title Configuration %}
+
To use your `lacrosse` compatible sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.luftdaten.markdown b/source/_components/sensor.luftdaten.markdown
index 8e4a41cdefc..b368a6d8e9b 100644
--- a/source/_components/sensor.luftdaten.markdown
+++ b/source/_components/sensor.luftdaten.markdown
@@ -15,9 +15,13 @@ ha_iot_class: "Cloud Polling"
The `luftdaten` sensor platform will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station.
+## {% linkable_title Setup %}
+
- To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID").
- To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/).
+## {% linkable_title Configuration %}
+
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.magicseaweed.markdown b/source/_components/sensor.magicseaweed.markdown
index 8bfbc13d664..4160439956e 100644
--- a/source/_components/sensor.magicseaweed.markdown
+++ b/source/_components/sensor.magicseaweed.markdown
@@ -14,10 +14,14 @@ ha_release: "0.75"
ha_iot_class: "Cloud Polling"
---
-The 'magicseaweed' platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice.
+The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice.
+
+## {% linkable_title Setup %}
You need an API key which is free but requires [registration](https://magicseaweed.com/developer/sign-up). Magicseaweed is limiting users of the API to 1 spot for the free plan.
+## {% linkable_title Configuration %}
+
To add Magicseaweed forecasts to your installation, add the following to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.melissa.markdown b/source/_components/sensor.melissa.markdown
index 4b18248d522..0b4360560d5 100644
--- a/source/_components/sensor.melissa.markdown
+++ b/source/_components/sensor.melissa.markdown
@@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: mclimate.png
-ha_category: Sensor
+ha_category: Environment
ha_iot_class: "Cloud Polling"
ha_release: 0.63
---
-The `Melissa` platform allows you to get data from your [Melissa](http://seemelissa.com/) sensors from within Home Assistant.
+The `melissa` platform allows you to get data from your [Melissa](http://seemelissa.com/) sensors from within Home Assistant.
The sensor platform will be automatically configured if Melissa component is configured.
diff --git a/source/_components/sensor.mercedesme.markdown b/source/_components/sensor.mercedesme.markdown
index da5fd9ba453..205955639dc 100644
--- a/source/_components/sensor.mercedesme.markdown
+++ b/source/_components/sensor.mercedesme.markdown
@@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: mercedesme.png
-ha_category: Sensor
+ha_category: Car
ha_iot_class: "Cloud Push"
ha_release: 0.63
---
-The `Mercedes me` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors from within Home Assistant.
+The `mercedesme` sensor platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors from within Home Assistant.
The sensor platform will be automatically configured if Mercedes me component is configured.
diff --git a/source/_components/sensor.mfi.markdown b/source/_components/sensor.mfi.markdown
index 4498c4d3281..a0aeac788de 100644
--- a/source/_components/sensor.mfi.markdown
+++ b/source/_components/sensor.mfi.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ubiquiti.png
-ha_category: Sensor
+ha_category: Network
ha_iot_class: "Local Polling"
ha_release: 0.32
---
diff --git a/source/_components/sensor.mhz19.markdown b/source/_components/sensor.mhz19.markdown
index 25cd6405ce7..142eeed155f 100644
--- a/source/_components/sensor.mhz19.markdown
+++ b/source/_components/sensor.mhz19.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: mhz19_logo.png
-ha_category: Sensor
+ha_category: DIY
ha_release: 0.27
ha_iot_class: "Local Polling"
---
@@ -17,6 +17,8 @@ The MH-Z19 is a small non-dispersive infrared sensor that can measure CO2 level.
Check out the [Open Home Automation web site](https://www.open-homeautomation.com/2016/08/24/monitor-co2-levels-in-your-house/) for a quick guide how to connect the sensor to your PC or Raspberry Pi.
+## {% linkable_title Configuration %}
+
To use this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
diff --git a/source/_components/sensor.miflora.markdown b/source/_components/sensor.miflora.markdown
index 85ad3cd03b5..0e82f9a6e32 100644
--- a/source/_components/sensor.miflora.markdown
+++ b/source/_components/sensor.miflora.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: miflora.png
-ha_category: DIY
+ha_category: Environment
ha_release: 0.29
ha_iot_class: "Local Polling"
---
@@ -70,13 +70,10 @@ sensor:
- **name** (*Optional*): The name displayed in the frontend.
- **force_update** (*Optional*): Sends update events even if the value hasn't changed.
- **median** (*Optional*): Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last 3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes. If you never have problems with spikes, `median: 1` will work fine.
-- **timeout** (*Optional*): Define the timeout value in seconds when polling (defaults to 10 if not defined)
-- **retries** (*Optional*): Define the number of retries when polling (defaults to 2 if not defined)
-- **cache_value** (*Optional*): Define cache expiration value in seconds (defaults to 1200 if not defined)
- **adapter** (*Optional*): Define the Bluetooth adapter to use (defaults to hci0). Run `hciconfig` to get a list of available adapters.
-By default the sensor is only polled once every 20 minutes. So, if you set `median: 3` it will take _at least_ 40 minutes before the sensor will report a value after a Home Assistant restart. Since the values usually change very slowly, this usually isn't a big problem. Keep in mind though that reducing polling intervals will have a negative effect on the battery life. +By default the sensor is only polled once every 20 minutes (`scan_interval` is 1200 seconds by default). On a Home Assistant restart sensor will report initial value. If you set `median: 3`, it will take _at least_ 40 minutes before the sensor will report an average value. Keep in mind though that reducing polling intervals will have a negative effect on the battery life.
A full configuration example could look like the one below: diff --git a/source/_components/sensor.min_max.markdown b/source/_components/sensor.min_max.markdown index 428e8485666..4606862da2d 100644 --- a/source/_components/sensor.min_max.markdown +++ b/source/_components/sensor.min_max.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: "0.31" --- @@ -18,15 +18,19 @@ The `min_max` sensor platform consumes the state from other sensors to determine This sensor is an alternative to the [template sensor](/components/sensor.template/)'s `value_template:` to get the average of multiple sensors. +{% raw %} ```yaml -{% raw %}{{ ((float(states.sensor.kitchen_temperature.state) + +{{ ((float(states.sensor.kitchen_temperature.state) + float(states.sensor.living_room_temperature.state) + float(states.sensor.office_temperature.state)) / 3) | round(2) -}}{% endraw %} +}} ``` +{% endraw %} Sensors with an unknown state will be ignored in the calculation. If the unit of measurement of the sensors differs, the `min_max` sensor will go to an error state where the value is `UNKNOWN` and unit of measurement is `ERR`. +## {% linkable_title Configuration %} + To enable the `min_max` sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.modem_callerid.markdown b/source/_components/sensor.modem_callerid.markdown index 6fa1ed1919d..4747aea5cf9 100644 --- a/source/_components/sensor.modem_callerid.markdown +++ b/source/_components/sensor.modem_callerid.markdown @@ -14,6 +14,26 @@ ha_iot_class: "Local Polling" The `modem_callerid` sensor platform uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1). +When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number. + +## {% linkable_title Setup %} + +To find the path of your USB modem, run: + +```bash +$ ls /dev/ttyACM* +``` + +If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with: + +```bash +$ sudo usermod -a -G dialout homeassistant +``` + +Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). + +## {% linkable_title Configuration %} + To enable the sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -22,10 +42,19 @@ sensor: - platform: modem_callerid ``` -Configuration variables: +{% configuration %} +name: + description: Name of the sensor to use in the frontend. + required: false + type: string + default: "`modem_callerid`" +device: + description: The port to use. + required: false + type: string + default: "`/dev/ttyACM0`" +{% endconfiguration %} -- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `modem_callerid`. -- **device** (*Optional*): Device port name. Defaults to `/dev/ttyACM0`. To find the path of your USB modem, run: @@ -37,11 +66,15 @@ If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hass Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). -When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number. + + +## {% linkable_title Examples %} Some example automations: + +{% raw %} ```yaml -{% raw %}automation: +automation: - alias: Notify CallerID trigger: platform: state @@ -69,6 +102,6 @@ Some example automations: action: service: tts.google_say data_template: - message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }} '{% endraw %} + message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }}' ``` - +{% endraw %} diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index bc049af3e65..e2d870f7924 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -8,14 +8,18 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Environment ha_release: '0.20' ha_iot_class: "Local Polling" --- The Mold Indicator sensor component consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor component estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. -The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: +The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. + +## {% linkable_title Configuration %} + +To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.moon.markdown b/source/_components/sensor.moon.markdown index d80c1068988..6a292040da2 100644 --- a/source/_components/sensor.moon.markdown +++ b/source/_components/sensor.moon.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Weather +ha_category: Environment ha_iot_class: "Local Polling" ha_release: 0.38 --- @@ -16,6 +16,8 @@ ha_release: 0.38 The `moon` sensor platform is tracking the moon phases. +## {% linkable_title Configuration %} + To enable the moon sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -23,5 +25,6 @@ To enable the moon sensor, add the following lines to your `configuration.yaml`: sensor: - platform: moon ``` + This sensor will return one of the following values: `new_moon`, `waxing_crescent`, `first_quarter`, `waxing_gibbous`, `full_moon`, `waning_gibbous`, `last_quarter` or `waning_crescent` . diff --git a/source/_components/sensor.mopar.markdown b/source/_components/sensor.mopar.markdown index 65146841838..ab620c56d9e 100644 --- a/source/_components/sensor.mopar.markdown +++ b/source/_components/sensor.mopar.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mopar.png -ha_category: Sensor +ha_category: Car featured: false ha_release: 0.53 ha_iot_class: "Cloud Polling" @@ -19,8 +19,12 @@ The `mopar` sensor provides the following for owners of FCA vehicles with a uCon - Sensor per vehicle with vehicle health report and other meta-data - Service for remote commands: Lock/unlock, Engine on/off, Horn & lights +## {% linkable_title Setup %} + Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`. ```yaml @@ -42,7 +46,7 @@ password: required: true type: string pin: - description: v + description: The pin for your account. required: true type: string {% endconfiguration %} diff --git a/source/_components/sensor.mychevy.markdown b/source/_components/sensor.mychevy.markdown index 03b3146f5f9..33747f5aab1 100644 --- a/source/_components/sensor.mychevy.markdown +++ b/source/_components/sensor.mychevy.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "MyChevy Sensors" +title: "MyChevy Sensor" description: "Instructions on how to integrate Chevy Bolt sensors car into Home Assistant." date: 2017-08-28 17:00 sidebar: true @@ -8,9 +8,15 @@ comments: false sharing: true footer: true logo: chevy.png -ha_category: Sensor +ha_category: Car ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -For configuration instructions, see [main component config](/components/mychevy/). + +The `mychevy` sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant. + +The sensor platform will be automatically configured if the `mychevy` component is configured. + +For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation. + diff --git a/source/_components/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index a6e8657014a..ae77bb096eb 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Sensor +ha_category: DIY featured: false ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.netatmo_public.markdown b/source/_components/sensor.netatmo_public.markdown index 9c89a1c5a71..c1c61a1a05c 100644 --- a/source/_components/sensor.netatmo_public.markdown +++ b/source/_components/sensor.netatmo_public.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: netatmo.png -ha_category: Sensor +ha_category: Environment ha_iot_class: "Cloud Polling" ha_release: 0.77 --- @@ -60,7 +60,7 @@ areas: type: string default: Netatmo Public Data type: - description: How to calculate the value of the sensor if there are multiple stations reporting data. Accepts `max` or `avg`. + description: "How to calculate the value of the sensor if there are multiple stations reporting data. Accepts `max` or `avg`." required: false type: string default: max diff --git a/source/_components/sensor.netgear_lte.markdown b/source/_components/sensor.netgear_lte.markdown index a8f82f8206a..b0031f161cf 100644 --- a/source/_components/sensor.netgear_lte.markdown +++ b/source/_components/sensor.netgear_lte.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: netgear.png ha_release: 0.72 -ha_category: Sensor +ha_category: Network ha_iot_class: "Local Polling" --- @@ -17,6 +17,10 @@ The `netgear_lte` sensor platform allows you to monitor your Netgear LTE modem. This requires you to have set up the [Netgear LTE component](/components/netgear_lte/). +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry sensor: @@ -28,16 +32,16 @@ sensor: {% configuration %} sensors: - description: Sensor types to create. - required: true - type: list - keys: - sms: - description: Number of unread SMS messages in the modem inbox. - usage: - description: Amount of data transferred. + description: Sensor types to create. + required: true + type: list + keys: + sms: + description: Number of unread SMS messages in the modem inbox. + usage: + description: Amount of data transferred. host: - description: The modem to use. Not needed if you only have one. - required: false - type: string + description: The modem to use. Not needed if you only have one. + required: false + type: string {% endconfiguration %} diff --git a/source/_components/sensor.noaa_tides.markdown b/source/_components/sensor.noaa_tides.markdown index fca7249529b..434d25dd621 100644 --- a/source/_components/sensor.noaa_tides.markdown +++ b/source/_components/sensor.noaa_tides.markdown @@ -7,15 +7,19 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Weather +ha_category: Environment ha_release: 0.75 logo: noaa.png --- The `noaa_tides` sensor platform uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States. +## {% linkable_title Setup %} + This sensor requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164` +## {% linkable_title Configuration %} + To use this sensor, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.nsw_fuel_station.markdown b/source/_components/sensor.nsw_fuel_station.markdown index 5ebdb8fc51e..9a560f322c3 100644 --- a/source/_components/sensor.nsw_fuel_station.markdown +++ b/source/_components/sensor.nsw_fuel_station.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Fuel +ha_category: Car ha_release: 0.72 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.openevse.markdown b/source/_components/sensor.openevse.markdown index e9df04e8da0..df249bd1137 100644 --- a/source/_components/sensor.openevse.markdown +++ b/source/_components/sensor.openevse.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: openevse.png -ha_category: Sensor +ha_category: Car ha_release: "0.38" ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.opensky.markdown b/source/_components/sensor.opensky.markdown index cf16befa77e..39bbb600b4b 100644 --- a/source/_components/sensor.opensky.markdown +++ b/source/_components/sensor.opensky.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: opensky.png -ha_category: Sensor +ha_category: Transport featured: false ha_release: 0.43 ha_iot_class: "Cloud Polling" @@ -16,9 +16,9 @@ ha_iot_class: "Cloud Polling" The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region. -## Configuration +## {% linkable_title Configuration %} -To enable this sensor, add the following lines to your `configuration.yaml`. +To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml sensor: @@ -28,24 +28,24 @@ sensor: Configuration options for the OpenSky Network sensor: -- **radius** (*Required*): Radius of region to monitor, in kilometers -- **latitude** (*Optional*): Region latitude (defaults to home zone latitude) -- **longitude** (*Optional*): Region longitude (defaults to home zone longitude) -- **altitude** (*Optional*): The maximum altitude(in meters) for planes to be detected in, 0 sets it to unlimited (defaults to 0) -- **name** (*Optional*): Sensor name (defaults to `opensky`) +- **radius** (*Required*): Radius of region to monitor, in kilometers. +- **latitude** (*Optional*): Region latitude. Defaults to home zone latitude. +- **longitude** (*Optional*): Region longitude. Defaults to home zone longitude. +- **altitude** (*Optional*): The maximum altitude (in meters) for planes to be detected in, 0 sets it to unlimited. Defaults to 0). +- **name** (*Optional*): Sensor name. Defaults to opensky. -## Events +## {% linkable_title Events %} -- **opensky_entry**: Fired when a flight enters the region -- **opensky_exit**: Fired when a flight exits the region +- **opensky_entry**: Fired when a flight enters the region. +- **opensky_exit**: Fired when a flight exits the region. Both events have two attributes: -- **sensor**: Name of `opensky` sensor that fired the event -- **callsign**: Callsign of the flight -- **altitude**: Altitude of the flight in meters +- **sensor**: Name of `opensky` sensor that fired the event. +- **callsign**: Callsign of the flight. +- **altitude**: Altitude of the flight in meters. -To receive notifications of the entering flights, add the following lines to your `configuration.yaml`. +To receive notifications of the entering flights, add the following lines to your `configuration.yaml` file: {% raw %} ```yaml diff --git a/source/_components/sensor.openuv.markdown b/source/_components/sensor.openuv.markdown index f777be94262..61240520043 100644 --- a/source/_components/sensor.openuv.markdown +++ b/source/_components/sensor.openuv.markdown @@ -8,16 +8,12 @@ comments: false sharing: true footer: true logo: openuv.jpg -ha_category: Sensor +ha_category: Health ha_release: 0.76 ha_iot_class: "Cloud Polling" --- -The `openuv` sensor platform allows you to view sensor data from -[OpenUV](http://openuv.io). +The `openuv` sensor platform allows you to view sensor data from [OpenUV](http://openuv.io). + +You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, sensors will automatically appear. --You must have the [OpenUV component](/components/openuv/) configured to use -this platform. After configuring that component, sensors will automatically -appear. -
diff --git a/source/_components/sensor.otp.markdown b/source/_components/sensor.otp.markdown index 849f2167184..3f0cd12d337 100644 --- a/source/_components/sensor.otp.markdown +++ b/source/_components/sensor.otp.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.49 --- The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds. +## {% linkable_title Configuration %} + To enable the OTP sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.pilight.markdown b/source/_components/sensor.pilight.markdown index 2a33cc2a1dd..a78f5a1d391 100644 --- a/source/_components/sensor.pilight.markdown +++ b/source/_components/sensor.pilight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Sensor +ha_category: DIY ha_release: 0.31 ha_iot_class: depends --- diff --git a/source/_components/sensor.pocketcasts.markdown b/source/_components/sensor.pocketcasts.markdown index 89d48c79f3c..0a1c0d1fce8 100644 --- a/source/_components/sensor.pocketcasts.markdown +++ b/source/_components/sensor.pocketcasts.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: pocketcasts.png -ha_category: Sensor +ha_category: Multimedia ha_release: 0.39 ha_iot_class: "Cloud Polling" --- The `pocketcasts` sensor platform let one monitor the podcasts at [Pocket Casts](https://play.pocketcasts.com/). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.postnl.markdown b/source/_components/sensor.postnl.markdown index 3fa41230239..0510b0dd14b 100644 --- a/source/_components/sensor.postnl.markdown +++ b/source/_components/sensor.postnl.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: postnl.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.69 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.qnap.markdown b/source/_components/sensor.qnap.markdown index 3814f37bd00..7731bb33110 100644 --- a/source/_components/sensor.qnap.markdown +++ b/source/_components/sensor.qnap.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: qnap.png -ha_category: Sensor +ha_category: System Monitor ha_release: 0.38 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index 94a46655485..8795896f9e7 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: radarr.png -ha_category: Sensor +ha_category: Downloading ha_release: 0.47 --- diff --git a/source/_components/sensor.rainbird.markdown b/source/_components/sensor.rainbird.markdown index 750c2874979..4c523a82c48 100644 --- a/source/_components/sensor.rainbird.markdown +++ b/source/_components/sensor.rainbird.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.61 ha_iot_class: "Local Polling" --- This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +## {% linkable_title Configuration %} + Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file to enable the rain sensor: ```yaml diff --git a/source/_components/sensor.raincloud.markdown b/source/_components/sensor.raincloud.markdown index 381599c785e..9435f1a7782 100644 --- a/source/_components/sensor.raincloud.markdown +++ b/source/_components/sensor.raincloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Sensor +ha_category: Irrigation ha_release: "0.55" ha_iot_class: "Cloud Polling" --- To get your [Melnor RainCloud](https://wifiaquatimer.com) sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). +## {% linkable_title Configuration %} + Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.rainmachine.markdown b/source/_components/sensor.rainmachine.markdown index 7df129ab2b6..4db41b38eaf 100644 --- a/source/_components/sensor.rainmachine.markdown +++ b/source/_components/sensor.rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Sensor +ha_category: Irrigation ha_iot_class: "Cloud Polling" ha_release: 0.71 --- diff --git a/source/_components/sensor.random.markdown b/source/_components/sensor.random.markdown index cbe6049cf30..e3515333eab 100644 --- a/source/_components/sensor.random.markdown +++ b/source/_components/sensor.random.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.32 --- @@ -18,7 +18,7 @@ The `random` sensor platform is creating random sensor values (integers) out of ## {% linkable_title Configuration %} -To enable the random sensor, add the following lines to your `configuration.yaml`: +To enable the random sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.ring.markdown b/source/_components/sensor.ring.markdown index 898a76ffa4c..e8059abc990 100644 --- a/source/_components/sensor.ring.markdown +++ b/source/_components/sensor.ring.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ring.png -ha_category: Sensor +ha_category: Doorbell ha_release: "0.40" ha_iot_class: "Cloud Polling" --- To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). +## {% linkable_title Configuration %} + Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown index 875636fb7ce..9e2ecc39c74 100644 --- a/source/_components/sensor.season.markdown +++ b/source/_components/sensor.season.markdown @@ -7,13 +7,13 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Utility logo: home-assistant.png ha_iot_class: "Local Polling" ha_release: 0.53 --- -This sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the users setting in the config file. +The `season` sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the user's setting in the configuration file. All information about how the seasons work was taken from Wikipedia: @@ -21,6 +21,9 @@ All information about how the seasons work was taken from Wikipedia: - [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox) - [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice) +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -29,6 +32,11 @@ sensor: type: astronomical ``` -Configuration variables: +{% configuration %} +type: + description: "Type of season definition. Options are `meteorological` or `astronomical`." + required: false + type: string + default: astronomical +{% endconfiguration %} -- **type** (*Optional*): Type of season definition. Options are `meteorological` or `astronomical`. Default is `astronomical`. diff --git a/source/_components/sensor.sense.markdown b/source/_components/sensor.sense.markdown index e13e45dd937..f894c5312e2 100644 --- a/source/_components/sensor.sense.markdown +++ b/source/_components/sensor.sense.markdown @@ -15,6 +15,9 @@ ha_release: 0.65 Integrate your [Sense](https://sense.com) meter information into Home Assistant. + +## {% linkable_title Configuration %} + To enable this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -31,9 +34,9 @@ sensor: ``` Two types of sensors can be monitored and will be created with the following names: + - **Active Usage/Production**: Current active power usage/production in Watts. Updated every 30 seconds. - **Daily Usage/Production**: Daily power usage/production in kWh. Updated every 5 minutes. -- ... Weekly, Monthly and Yearly variants are also available. @@ -52,23 +55,23 @@ monitored_conditions: type: list keys: active_usage: - description: The current power usage in W + description: The current power usage in W. active_production: - description: The current solar production in W + description: The current solar production in W. daily_usage: - description: Total power used for current day in kWh + description: Total power used for current day in kWh. daily_production: - description: Total power produced for current day in kWh + description: Total power produced for current day in kWh. weekly_usage: - description: Total power used for current week in kWh + description: Total power used for current week in kWh. weekly_production: - description: Total power produced for current week in kWh + description: Total power produced for current week in kWh. monthly_usage: - description: Total power used for current month in kWh + description: Total power used for current month in kWh. monthly_production: - description: Total power produced for current month in kWh + description: Total power produced for current month in kWh. yearly_usage: - description: Total power used for current year in kWh + description: Total power used for current year in kWh. yearly_production: - description: Total power produced for current year in kWh + description: Total power produced for current year in kWh. {% endconfiguration %} diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown index 640ea7b1a52..a2236c2fb5f 100644 --- a/source/_components/sensor.sensehat.markdown +++ b/source/_components/sensor.sensehat.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sense-hat.png -ha_category: Sensor +ha_category: DIY ha_release: 0.35 ha_iot_class: "Local Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Push" The `sensehat` sensor platform allows you to display information collected by a [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) add-on board for Raspberry Pi. +## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -23,9 +25,9 @@ To add this platform to your installation, add the following to your `configurat sensor: - platform: sensehat display_options: - - temperature - - humidity - - pressure + - temperature + - humidity + - pressure ``` Configuration variables: diff --git a/source/_components/sensor.sigfox.markdown b/source/_components/sensor.sigfox.markdown index f3f0bbb0ea5..e11dc9600e8 100644 --- a/source/_components/sensor.sigfox.markdown +++ b/source/_components/sensor.sigfox.markdown @@ -13,7 +13,20 @@ ha_iot_class: "Local Polling" ha_release: 0.68 --- -[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ( [snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). +[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). + +## {% linkable_title Setup %} + +Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following: + +1. Log into [Sigfox backend](https://backend.sigfox.com) +1. Select `GROUP` +1. Select `API ACCESS` +1. Click on `new` and create new access entry + +## {% linkable_title Configuration %} + +To use this sensor, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -39,9 +52,3 @@ name: type: string {% endconfiguration %} -Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following: - -1. Log into [Sigfox backend](https://backend.sigfox.com) -1. Select `GROUP` -1. Select `API ACCESS` -1. Click on `new` and create new access entry diff --git a/source/_components/sensor.simulated.markdown b/source/_components/sensor.simulated.markdown index 07b97c8fce1..ef4d98bd73d 100644 --- a/source/_components/sensor.simulated.markdown +++ b/source/_components/sensor.simulated.markdown @@ -8,16 +8,16 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: 0.65 --- -The `simulated` sensor platform provides a simulated sensor that generates a time-varying signal ```V(t)``` given by the [function](https://en.wikipedia.org/wiki/Sine_wave): +The `simulated` sensor platform provides a simulated sensor that generates a time-varying signal `V(t)` given by the [function](https://en.wikipedia.org/wiki/Sine_wave): - ``` - V(t) = M + A sin((2 pi (t - t_0) / w) + P) + N(s) - ``` +```text +V(t) = M + A sin((2 pi (t - t_0) / w) + P) + N(s) +``` where: diff --git a/source/_components/sensor.skybell.markdown b/source/_components/sensor.skybell.markdown index 4c9f3b5434c..023ee75738f 100644 --- a/source/_components/sensor.skybell.markdown +++ b/source/_components/sensor.skybell.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: skybell.png -ha_category: Sensor +ha_category: Doorbell ha_release: 0.56 ha_iot_class: "Cloud Polling" --- To get your [Skybell.com](https://skybell.com/) sensors working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell). +## {% linkable_title Configuration %} + Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.sleepiq.markdown b/source/_components/sensor.sleepiq.markdown index 6740af6ab83..616c54e56ba 100644 --- a/source/_components/sensor.sleepiq.markdown +++ b/source/_components/sensor.sleepiq.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sleepiq.png -ha_category: Sensor +ha_category: Health ha_release: 0.29 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.smappee.markdown b/source/_components/sensor.smappee.markdown index 2886f2b4340..8a1e1c56e25 100644 --- a/source/_components/sensor.smappee.markdown +++ b/source/_components/sensor.smappee.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: smappee.png ha_release: "0.64" -ha_category: Sensor +ha_category: Energy --- [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. diff --git a/source/_components/sensor.socialblade.markdown b/source/_components/sensor.socialblade.markdown index cf106c9133e..143feb80e9d 100644 --- a/source/_components/sensor.socialblade.markdown +++ b/source/_components/sensor.socialblade.markdown @@ -3,25 +3,28 @@ layout: page title: Social Blade Sensor description: "Instructions on how to set up Social Blade Sensor within Home Assistant." date: 2018-04-23 08:00 -sidebar: false +sidebar: true comments: false sharing: true footer: true logo: socialblade.png -ha_category: Sensor +ha_category: Multimedia ha_release: 0.69 ha_iot_class: "Cloud Polling" --- -The `socialblade` sensor component allows you get updates on a youtube channel using your social blade channel id. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/) +The `socialblade` sensor platform allows you get updates on a Youtube channel using your social blade channel ID. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/). -to get the channel id you can go to [Social Blade Website]( https://socialblade.com/) and search for youtube channel by username, then select the channel and grab the id from the url. -The channel id will be the last part of the url : -https://socialblade.com/youtube/channel/{channel_id} +## {% linkable_title Setup %} -## Example for `configuration.yaml` : +To get the channel ID you can go to [Social Blade Website]( https://socialblade.com/) and search for Youtube channel by username, then select the channel and grab the ID from the URL. The channel ID will be the last part of the URL: https://socialblade.com/youtube/channel/{channel_id} + +## {% linkable_title Configuration %} + +To enable the sensor, add the following lines to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry sensor: - platform: socialblade channel_id: YOUR_CHANNEL_NUMBER @@ -29,7 +32,7 @@ sensor: {% configuration %} channel_id: - description: channel id number optained from the URL when you access Social Blade web client. + description: Channel id number optained from the URL when you access Social Blade web client. required: true type: string {% endconfiguration %} diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index 13a4944feaa..93b070adcee 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sonarr.png -ha_category: Sensor +ha_category: Downloading ha_release: 0.34 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.spotcrime.markdown b/source/_components/sensor.spotcrime.markdown index b36d01b4b46..73bda02a894 100644 --- a/source/_components/sensor.spotcrime.markdown +++ b/source/_components/sensor.spotcrime.markdown @@ -7,15 +7,19 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Social ha_release: 0.65 ha_iot_class: "Cloud Polling" --- The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](http://spotcrime.com). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via configuration.yaml. +## {% linkable_title Setup %} + You will need to request an API key from [Spotcrime](mailto:pyrrhus@spotcrime.com). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area. 0.01 = 1 mile. ```yaml diff --git a/source/_components/sensor.sql.markdown b/source/_components/sensor.sql.markdown index a7484b1480c..201861f2620 100644 --- a/source/_components/sensor.sql.markdown +++ b/source/_components/sensor.sql.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sql.png -ha_category: Sensor +ha_category: Utility ha_release: 0.63 --- diff --git a/source/_components/sensor.startca.markdown b/source/_components/sensor.startca.markdown index cd92fe272ce..5d36a629eec 100644 --- a/source/_components/sensor.startca.markdown +++ b/source/_components/sensor.startca.markdown @@ -8,16 +8,18 @@ comments: false sharing: true footer: true logo: startca.png -ha_category: Sensor +ha_category: Network ha_release: 0.64 ha_iot_class: "Cloud Polling" --- Integrate your [Start.ca](https://www.start.ca/) account information into Home Assistant. -You can get your API key from: +## {% linkable_title Setup %} -[Start.ca Usage API](https://www.start.ca/support/usage/api) +You can get your API key from: [Start.ca Usage API](https://www.start.ca/support/usage/api) + +## {% linkable_title Configuration %} To use your Start.ca sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.statistics.markdown b/source/_components/sensor.statistics.markdown index 9bfd40dd39c..a169c2cc71d 100644 --- a/source/_components/sensor.statistics.markdown +++ b/source/_components/sensor.statistics.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Polling" ha_release: "0.30" --- @@ -19,6 +19,8 @@ The `statistics` sensor platform consumes the state from other sensors. Besides If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` component on startup. If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation. +## {% linkable_title Configuration %} + To enable the statistics sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.swiss_hydrological_data.markdown b/source/_components/sensor.swiss_hydrological_data.markdown index 44f4d6100bd..c6110b8f7c5 100644 --- a/source/_components/sensor.swiss_hydrological_data.markdown +++ b/source/_components/sensor.swiss_hydrological_data.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: swiss-hydrological-data.png -ha_category: Weather +ha_category: Environment ha_iot_class: "Cloud Polling" ha_release: 0.22 --- @@ -19,33 +19,49 @@ ha_release: 0.22 The `swiss_hydrological_data` sensor will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland. +## {% linkable_title Setup %} + The [station overview](http://www.hydrodaten.admin.ch/en/danger-levels-table.html) contains a list of all available measuring points and will help to determine the ID of station which is needed for the configuration. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor: - platform: swiss_hydrological_data - station: STATION_ID + - platform: swiss_hydrological_data + station: STATION_ID ``` -Configuration variables: - -- **name** (*Optional*): Name to use in the frontend. -- **station** (*Required*): The ID of the measurement point. +{% configuration %} +station: + description: The ID of the measurement point. + required: true + type: string +name: + description: Name to use in the frontend. + required: false + type: string + default: +{% endconfiguration %} The hydrological measurings are coming from the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) and are updated almost in real-time. +## {% linkable_title Example %} + This sensor contains additional information which an easily accessed by a [template sensor](/components/sensor.template/). +{% raw %} ```yaml # Example configuration.yaml entry sensor: platform: template sensors: discharge: - value_template: '{% raw %}{{ states.sensor.aare.attributes.Discharge }}{% endraw %}' + value_template: '{{ states.sensor.aare.attributes.Discharge }}' friendly_name: 'Discharge' ``` +{% endraw %} + diff --git a/source/_components/sensor.syncthru.markdown b/source/_components/sensor.syncthru.markdown index 19b2e5d1399..f2238dda257 100644 --- a/source/_components/sensor.syncthru.markdown +++ b/source/_components/sensor.syncthru.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: samsung.png -ha_category: Sensor +ha_category: System Monitor ha_iot_class: "Local Polling" ha_release: 0.66 --- diff --git a/source/_components/sensor.systemmonitor.markdown b/source/_components/sensor.systemmonitor.markdown index 855dca71c04..8f4ee938fea 100644 --- a/source/_components/sensor.systemmonitor.markdown +++ b/source/_components/sensor.systemmonitor.markdown @@ -80,7 +80,7 @@ sensor: arg: 'Local Area Connection' ``` -If you need to use some other interface, open a command line prompt and type `ipconfig` to list all interface names. For example a wireless connection output from `ifconfig` might look like: +If you need to use some other interface, open a command line prompt and type `ipconfig` to list all interface names. For example a wireless connection output from `ipconfig` might look like: ```bash Wireless LAN adapter Wireless Network Connection: diff --git a/source/_components/sensor.sytadin.markdown b/source/_components/sensor.sytadin.markdown index 1c44a9bdd3f..4b62e198574 100644 --- a/source/_components/sensor.sytadin.markdown +++ b/source/_components/sensor.sytadin.markdown @@ -9,12 +9,14 @@ sharing: true footer: true logo: sytadin.png ha_release: 0.57 -ha_category: Sensor +ha_category: Car ha_iot_class: "Clound Polling" --- The `sytadin` sensor platform allows you to monitor traffic details from [Sytadin](http://www.sytadin.fr). +## {% linkable_title Configuration %} + To add Sytadin to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.tank_utility.markdown b/source/_components/sensor.tank_utility.markdown index 061c66ab918..6446f5e8949 100644 --- a/source/_components/sensor.tank_utility.markdown +++ b/source/_components/sensor.tank_utility.markdown @@ -8,37 +8,51 @@ comments: false sharing: true footer: true logo: tank_utility.png -ha_category: Sensor +ha_category: Energy ha_release: "0.53" --- Add [Tank Utility](https://www.tankutility.com/) propane tank monitors to Home Assistant. +## {% linkable_title Setup %} + +### {% linkable_title Authentication %} + +Authentication for the Tank Utility API is performed with the same email and password credentials used at [https://app.tankutility.com](https://app.tankutility.com). + +### {% linkable_title Devices %} + +Each item in the list of devices is a 24 character string. These values can be found by clicking on the **Usage Reports** link at the bottom of the graph on the [Tank Utility devices page](https://app.tankutility.com/#/devices). + +The device item value is the last segment of the URL path, e.g., the URL +[https://app.tankutility.com/#/reports/000000000000000000000000](https://app.tankutility.com/#/reports/000000000000000000000000) would indicate `000000000000000000000000` as a device value. + +## {% linkable_title Configuration %} + +To enable the component, add the following lines to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry sensor: - platform: tank_utility - email: EMAIL - password: PASSWORD + email: YOUR_EMAIL_ADDRESS + password: YOUR_PASSWORD devices: - 000000000000000000000000 ``` -Configuration variables: +{% configuration %} +email: + description: "Your [https://app.tankutility.com](https://app.tankutility.com) email address." + required: true + type: string +password: + description: "Your [https://app.tankutility.com](https://app.tankutility.com) password." + required: true + type: string +unit_of_measurement: + description: All devices to monitor. + required: true + type: map +{% endconfiguration %} -* **email** *(Required)*: [https://app.tankutility.com](https://app.tankutility.com) email address -* **password** *(Required)*: [https://app.tankutility.com](https://app.tankutility.com) password -* **devices** *(Required)*: List of devices - -Authentication: - -Authentication for the Tank Utility API is performed with the same email and password credentials used at -[https://app.tankutility.com](https://app.tankutility.com). - -Devices: - -Each item in the list of devices is a 24 character string. These values can be found by clicking on the **Usage -Reports** link at the bottom of the graph on the [Tank Utility devices page](https://app.tankutility.com/#/devices). -The device item value is the last segment of the URL path, e.g., the URL -[https://app.tankutility.com/#/reports/000000000000000000000000](https://app.tankutility.com/#/reports/000000000000000000000000) -would indicate `000000000000000000000000` as a device value. diff --git a/source/_components/sensor.ted5000.markdown b/source/_components/sensor.ted5000.markdown index 20e94ba3e8d..1dd451255c7 100644 --- a/source/_components/sensor.ted5000.markdown +++ b/source/_components/sensor.ted5000.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ted.png -ha_category: Sensor +ha_category: Energy ha_release: "0.30" ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.teksavvy.markdown b/source/_components/sensor.teksavvy.markdown index 9f7a8e70faa..c55d05f3f39 100644 --- a/source/_components/sensor.teksavvy.markdown +++ b/source/_components/sensor.teksavvy.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: teksavvy.png -ha_category: Sensor +ha_category: Network ha_release: 0.62 ha_iot_class: "Cloud Polling" --- @@ -17,6 +17,8 @@ Integrate your [TekSavvy](https://myaccount.teksavvy.com/) account information i You can get your API key from [TekSavvy My Account](https://myaccount.teksavvy.com/ApiKey/ApiKeyManagement). +## {% linkable_title Configuration %} + To use your TekSavvy sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.temper.markdown b/source/_components/sensor.temper.markdown index 09626f0984e..65fd75fd725 100644 --- a/source/_components/sensor.temper.markdown +++ b/source/_components/sensor.temper.markdown @@ -7,13 +7,15 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Push" ha_release: pre 0.7 --- This `temper` sensor platform allows you to get the current temperature from a TEMPer device. +## {% linkable_title Configuration %} + To use your TEMPer sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.tesla.markdown b/source/_components/sensor.tesla.markdown index 262a18910e2..1b9dfcca155 100644 --- a/source/_components/sensor.tesla.markdown +++ b/source/_components/sensor.tesla.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Sensor +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.53 --- -The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. +The `tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. -The sensor platform will be automatically configured if Tesla component is configured. +The sensor platform will be automatically configured if `tesla` component is configured. For more configuration information see the [Tesla component](/components/tesla/) documentation. diff --git a/source/_components/sensor.tibber.markdown b/source/_components/sensor.tibber.markdown index 81d11c7ac2b..3e71d8fc2a5 100644 --- a/source/_components/sensor.tibber.markdown +++ b/source/_components/sensor.tibber.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: tibber.png -ha_category: Sensor +ha_category: Energy ha_release: 0.55 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.torque.markdown b/source/_components/sensor.torque.markdown index 38379ccd675..91d45e4d7b9 100644 --- a/source/_components/sensor.torque.markdown +++ b/source/_components/sensor.torque.markdown @@ -8,14 +8,15 @@ comments: false sharing: true footer: true logo: torque.png -ha_category: Transport +ha_category: Car ha_release: "0.10" ha_iot_class: "Cloud Polling" --- The `torque` platform will allow you to monitor [Torque](http://torque-bhp.com/) data relayed from a Bluetooth OBD2 stick via the Torque mobile application. -## {% linkable_title Configuration %} +## {% linkable_title Setup %} + To use Torque sensors with your installation, you must configure both the Torque mobile application and Home Assistant. ### {% linkable_title Torque application %} @@ -34,7 +35,7 @@ Under the **Realtime Web Upload** header: - Enter an email address in **User Email Address**. - Optionally set the **Web Logging Interval**. The 2-second default may quickly fill up the Home Assistant history database. -### {% linkable_title Home Assistant %} +### {% linkable_title Configuration %} Add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.tradfri.markdown b/source/_components/sensor.tradfri.markdown index fb78480fb1b..91827191509 100644 --- a/source/_components/sensor.tradfri.markdown +++ b/source/_components/sensor.tradfri.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "IKEA Trådfri sensors" +title: "IKEA Trådfri Sensor" description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Sensors." date: 2017-04-12 22.04 sidebar: true diff --git a/source/_components/sensor.trafikverket_weatherstation.markdown b/source/_components/sensor.trafikverket_weatherstation.markdown index ebbb7724a55..152d95316ac 100644 --- a/source/_components/sensor.trafikverket_weatherstation.markdown +++ b/source/_components/sensor.trafikverket_weatherstation.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: trafikverket.png -ha_category: Sensor +ha_category: Weather ha_release: 0.66.0 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.twitch.markdown b/source/_components/sensor.twitch.markdown index d1265c1b1d5..660488a7675 100644 --- a/source/_components/sensor.twitch.markdown +++ b/source/_components/sensor.twitch.markdown @@ -16,6 +16,10 @@ ha_iot_class: "Cloud Polling" The `twitch` platform will allow you to monitor [Twitch](http://www.twitch.tv/) channel status from within Home Assistant and setup automation based on the information. +## {% linkable_title Setup %} + +Create a new app at "Register Your Application" in the [Twitch developer portal](https://glass.twitch.tv/console/apps). Then get the **Client ID** for the new app. + ## {% linkable_title Configuration %} To use Twitch with your installation, add the following to your `configuration.yaml` file: @@ -24,12 +28,17 @@ To use Twitch with your installation, add the following to your `configuration.y # Example configuration.yaml entry sensor: platform: twitch + client_id: YOUR_TWITCH_CLIENT_ID channels: - channel1 - channel2 ``` {% configuration %} +clientid: + description: Your Twitch client ID. + required: true + type: string channels: description: List of channels. required: true diff --git a/source/_components/sensor.uk_transport.markdown b/source/_components/sensor.uk_transport.markdown index ccf0c1a5a77..17bebc15dad 100644 --- a/source/_components/sensor.uk_transport.markdown +++ b/source/_components/sensor.uk_transport.markdown @@ -46,7 +46,21 @@ Configuration variables: - **origin** (*Required*): Specify the three character long origin station code. - **destination** (*Required*): Specify the three character long destination station code. -A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID `sensor.next_train_to_wat` with the attribute `next_trains` which is a list of the next 25 departing trains. The status of the next departing train is accessed using the [template sensor](/components/sensor.template/) below, as are the train origin, estimated and scheduled departure times, and the departure platform. +A large amount of information about upcoming departures is available within the attributes of the sensor. The example above creates a sensor with ID `sensor.next_train_to_wat` with the attribute `next_trains` which is a list of the next 25 departing trains. + +These attributes are available for each departing train: + +- `origin_name` +- `destination_name` +- `status` +- `scheduled`: (API attribute is `aimed_departure_time`) +- `estimated`: (API attribute is `expected_departure_time`) +- `platform` +- `operator_name` + +Refer to the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##request_uk_train_station_station_code_live_json) for definitions. + +Attributes can be accessed using the [template sensor](/components/sensor.template/) as per this example: ```yaml # Example configuration.yaml entry for a template sensor to access the attributes of the next departing train. diff --git a/source/_components/sensor.upnp.markdown b/source/_components/sensor.upnp.markdown index c9d31bcca21..027d76d9ede 100644 --- a/source/_components/sensor.upnp.markdown +++ b/source/_components/sensor.upnp.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: upnp.png -ha_category: "Other" +ha_category: Network ha_release: 0.48 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.ups.markdown b/source/_components/sensor.ups.markdown index 6e1989bfe22..fe1ae61a91a 100644 --- a/source/_components/sensor.ups.markdown +++ b/source/_components/sensor.ups.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ups.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.39 ha_iot_class: "Cloud Polling" --- The `ups` platform allows one to track deliveries by the [UPS](https://www.ups.com/). To use this sensor, you need a [My UPS Account](https://www.ups.com/mychoice). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.uptime.markdown b/source/_components/sensor.uptime.markdown index f67feb188e4..30f8cdadb29 100644 --- a/source/_components/sensor.uptime.markdown +++ b/source/_components/sensor.uptime.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Pushing" logo: home-assistant.png ha_release: 0.56 @@ -16,6 +16,8 @@ ha_release: 0.56 The `uptime` sensor platform displays the time since the last Home Assistant restart. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml @@ -24,10 +26,20 @@ sensor: - platform: uptime ``` -Configuration variables: +{% configuration %} +name: + description: Name to use in the frontend. + required: false + type: string + default: Uptime +unit_of_measurement: + description: "Units for uptime measurement in either `days`, `hours`, or `minutes`." + required: false + type: string + default: days +{% endconfiguration %} -- **name** (*Optional*): Name of the sensor. Defaults to `Uptime`. -- **unit_of_measurement** (*Optional*): Units for uptime measurement in either `days`, `hours`, or `minutes`. Defaults to `days`. +## {% linkable_title Example %} ```yaml # Example with configuration variables diff --git a/source/_components/sensor.uscis.markdown b/source/_components/sensor.uscis.markdown index 3d214dc818a..8dbedc2a3cb 100644 --- a/source/_components/sensor.uscis.markdown +++ b/source/_components/sensor.uscis.markdown @@ -3,7 +3,7 @@ layout: page title: USCIS Sensor description: "Instructions on how to set up USCIS within Home Assistant." date: 2018-03-21 08:00 -sidebar: false +sidebar: true comments: false sharing: true footer: true @@ -15,7 +15,9 @@ ha_iot_class: "Cloud Polling" The `uscis` sensor component allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) -## Example for `configuration.yaml` : +## {% linkable_title Configuration %} + +To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file: ```yaml sensor: @@ -25,7 +27,7 @@ sensor: ``` {% configuration %} -friendly_name: +name: description: Name of the sensor in Home Assistant. required: false default: USCIS diff --git a/source/_components/sensor.usps.markdown b/source/_components/sensor.usps.markdown index 46244107308..89d7029a0a8 100644 --- a/source/_components/sensor.usps.markdown +++ b/source/_components/sensor.usps.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: usps.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.36 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.version.markdown b/source/_components/sensor.version.markdown index a84c05f7a27..dda7b220fab 100644 --- a/source/_components/sensor.version.markdown +++ b/source/_components/sensor.version.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Utility ha_iot_class: "Local Pushing" logo: home-assistant.png ha_release: 0.52 @@ -16,6 +16,8 @@ ha_release: 0.52 The `version` sensor platform is displaying the current version of Home Assistant in the frontend. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: ```yaml @@ -24,9 +26,13 @@ sensor: - platform: version ``` -Configuration variables: - -- **name** (*Optional*): Name of the sensor. Defaults to `Current Version`. +{% configuration %} +name: + description: Name to use in the frontend. + required: false + type: string + default: Current Version +{% endconfiguration %} ## {% linkable_title Alternatives %} @@ -58,6 +64,7 @@ sensor: You might think that a [`rest` sensor](/components/sensor.rest/) could work, too, but it will not as Home Assistant is not ready when the sensor get initialized. +{% raw %} ```yaml sensor: - platform: rest @@ -65,3 +72,4 @@ sensor: name: Current Version value_template: '{{ value_json.version }}' ``` +{% endraw %} diff --git a/source/_components/sensor.whois.markdown b/source/_components/sensor.whois.markdown index 87e2e674cbc..95e351dd9e7 100644 --- a/source/_components/sensor.whois.markdown +++ b/source/_components/sensor.whois.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: icann.png -ha_category: Sensor +ha_category: Network ha_release: "0.57" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.worldtidesinfo.markdown b/source/_components/sensor.worldtidesinfo.markdown index 471a09566b4..9dcde7eafbc 100644 --- a/source/_components/sensor.worldtidesinfo.markdown +++ b/source/_components/sensor.worldtidesinfo.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: worldtidesinfo.png -ha_category: Weather +ha_category: Environment ha_release: 0.52 --- diff --git a/source/_components/sensor.xiaomi_miio.markdown b/source/_components/sensor.xiaomi_miio.markdown index 26e1a4293b9..c5a1bebe3bf 100644 --- a/source/_components/sensor.xiaomi_miio.markdown +++ b/source/_components/sensor.xiaomi_miio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: xiaomi.png -ha_category: Sensor +ha_category: Health ha_iot_class: "Local Polling" ha_release: 0.66 --- @@ -26,6 +26,8 @@ Currently, the supported features are: Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token. +## {% linkable_title Configuration %} + To add a Xiaomi Mi Air Quality Monitor to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.yahoo_finance.markdown b/source/_components/sensor.yahoo_finance.markdown index 0e8d12c0fbe..937dc442b44 100644 --- a/source/_components/sensor.yahoo_finance.markdown +++ b/source/_components/sensor.yahoo_finance.markdown @@ -20,6 +20,8 @@ ha_release: 0.29 The `yahoo_finance` platform uses [Yahoo Finance](https://finance.yahoo.com/) to monitor the stock market. +## {% linkable_title Configuration %} + To enable the `yahoo_finance` platform, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/skybell.markdown b/source/_components/skybell.markdown index 189f3a1b999..379cf3248a0 100644 --- a/source/_components/skybell.markdown +++ b/source/_components/skybell.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: skybell.png -ha_category: Hub +ha_category: Doorbell ha_release: 0.56 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sleepiq.markdown b/source/_components/sleepiq.markdown index a3efeaa0a0c..bb006c23cdc 100644 --- a/source/_components/sleepiq.markdown +++ b/source/_components/sleepiq.markdown @@ -8,15 +8,19 @@ comments: false sharing: true footer: true logo: sleepiq.png -ha_category: Hub +ha_category: Health ha_release: 0.29 ha_iot_class: "Local Polling" --- The SleepIQ implementation lets you view sensor data from [SleepIQ by SleepNumber](http://www.sleepnumber.com/sn/en/sleepiq-sleep-tracker). In particular, it lets you see the occupancy and current SleepNumber (ie current firmness) of each side of a SleepNumber bed. +## {% linkable_title Setup %} + You will need an account on [SleepIQ](https://sleepiq.sleepnumber.com/) to use this component. +## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml diff --git a/source/_components/snips.markdown b/source/_components/snips.markdown index f69b7f0b138..afe3d1f7e0a 100644 --- a/source/_components/snips.markdown +++ b/source/_components/snips.markdown @@ -38,17 +38,17 @@ $ sudo apt-get update $ sudo apt-get install -y snips-platform-voice ``` -Note: if the keyserver pgp.mit.edu is down try to use another one in the 4th line , like pgp.surfnet.nl: +Note that if the keyserver pgp.mit.edu is down then try to use another one in the 4th line, like pgp.surfnet.nl: ```bash -sudo apt-key adv --keyserver pgp.surfnet.nl --recv-keys D4F50CDCA10A2849 +$ sudo apt-key adv --keyserver pgp.surfnet.nl --recv-keys D4F50CDCA10A2849 ``` ### {% linkable_title Creating an assistant %} Head over to the [Snips Console](https://console.snips.ai) to create your assistant. Launch the training and download by clicking on the "Download Assistant" button. -The next step is to get the assistant to work on your device. Unzip and copy the assistant folder that you downloaded from the web console to the path. Assuming your downloaded assistant folder is on your desktop, just run: +The next step is to get the assistant to work on your device. Unzip and copy the `assistant` folder that you downloaded from the web console to the path. Assuming your downloaded `assistant` folder is on your desktop, just run: ```bash $ scp -r ~/Desktop/assistant pi@
+
+## {% linkable_title Troubleshooting %}
+
+### {% linkable_title Lost owner password %}
+
+While you should hopefully be storing your passwords in a password manager, if you lose the password associated with the owner account the only way to resolve this is to delete *all* the authentication data. You do this by shutting down Home Assistant and deleting the following files from the `.storage/` folder in your [configuration folder](https://www.home-assistant.io/docs/configuration/):
+
+* `auth`
+* `auth_provider.homeassistant`
+* `onboarding`
+
+When you start Home Assistant next you'll be required to set up authentication again.
diff --git a/source/_docs/authentication/multi-factor-auth.markdown b/source/_docs/authentication/multi-factor-auth.markdown
index ceefb1b39d8..d1528a8197b 100644
--- a/source/_docs/authentication/multi-factor-auth.markdown
+++ b/source/_docs/authentication/multi-factor-auth.markdown
@@ -16,9 +16,9 @@ This is an advanced feature. If misconfigured, you will not be able to access Ho
Besides the authentication providers, it's also possible to configure multi-factor authentication modules. These authentication modules will require the user to solve a second challenge besides just logging in. The idea is that you ask the user for something they know, their username/password, and something they have, like a time-based authentication token from their phone.
-Multi-factor authentication module can be used mixed-match with authentication providers. After normal authentication provider validation, the login flow will ask user for addional challenge if there are multi-factor authentication modules enabled for this user. If more than one mutli-factor authentication module enabled, user can select one of them during the login.
+The multi-factor authentication module can be used mixed-matched with authentication providers. After the normal authentication provider validation, the login flow will ask the user for additional challenge(s) if there are multi-factor authentication modules enabled for this user. If more than one mutli-factor authentication module is enabled, the user can select one of them during the login.
-Multi-factor authentication module has to be enabled for user before it can be used in the login process, user can go to profile page enable it by himself.
+The multi-factor authentication module has to be enabled for the user before it can be used in the login process. The user can go to the profile page enable it by himself.
## {% linkable_title Configuring mutli-factor authentication modules %}
@@ -26,7 +26,7 @@ Multi-factor authentication module has to be enabled for user before it can be u
By configuring your own instead of using the default configuration, you take full responsibility for the authentication of the system.
-Multi-factor authentication modules are configured in your `configuration.yaml` under the `homeassistant:` block:
+Multi-factor authentication modules are configured in your `configuration.yaml` file under the `homeassistant:` block:
```yaml
homeassistant:
@@ -36,24 +36,25 @@ homeassistant:
## {% linkable_title Available mutli-factor authentication modules %}
-Below is a list of currently available auth providers.
+Below is a list of the currently available auth providers.
### {% linkable_title Time-based One-Time Password mutli-factor authentication module %}
[Time-based One-Time Password](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm) is widely adopted in modern authencation system, it combines a secret key with the current timestamp using a cryptographic hash function to generate a one-time password. Whoever possessed the secret key will get same one-time password in certain time period. By verifying that password, Home Assistant knows the user have the right secrt key.
-When try to set up TOTP module, a QR code will show up, user can scan it by an authenticator app, or set it up manauly using the code showed in UI. After setup, user need to input a six digit number generate in the authenticator app to verify the setup is good. If the verificaiton keep falling, you need to check whether the clock on Home Asistant is accurate.
+When trying to set up TOTP module, a QR code will show up. The user can scan it by an authenticator app, or set it up manually using the code showed in the UI. After setup, the user needs to input a six digit number generated in the authenticator app to verify the setup is good. If the verification keeps failing, you need to check whether the clock on Home Assistant is accurate.
-There are several authenctior apps on the market, we recommend either [Google Authenticator](https://support.google.com/accounts/answer/1066447) or [Authy](https://authy.com/)
+There are several authenticator apps on the market, we recommend either [Google Authenticator](https://support.google.com/accounts/answer/1066447) or [Authy](https://authy.com/).
-Please treat the secret key like a password, never exposure it to others. +Please treat the secret key like a password, never expose it to others.
+By default, one TOTP multi-factor named "Authenticator app" will be auto loaded if no `auth_mfa_modules` configuration section defined in the `configuration.yaml` file. By default one TOTP multi-factor auth module named "Authenticator app" will be auto loaded if no `auth_mfa_modules` config section defined in `configuration.yaml`. -Example of configuration +Example of configuration: ```yaml homeassistant: diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index b672beb0967..728ecb58b2d 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -27,7 +27,7 @@ To make the transition from API password to authentication system easier, we've ## {% linkable_title Configuring auth providers %}-By configuring your own instead of using the default configuration, you take full responsibility for the authentication of the system. +Home Assistant automatically configures the standard auth providers and you **do not** need to specify `auth_providers` in your `configuration.yaml` file. Specifying `auth_providers` in your configuration will disable all auth providers that are not listed and can reduce your security or create difficulties logging in.
Authentication providers are configured in your `configuration.yaml` under the `homeassistant:` block: diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index 17211e5ed9d..6b43b19c2e1 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -78,7 +78,7 @@ ExecStopPost=/usr/bin/docker rm -f home-assistant-%i WantedBy=multi-user.target ``` -### Next Steps +### {% linkable_title Next Steps %} You need to reload `systemd` to make the daemon aware of the new configuration. diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown index 2c085217a6c..f862052b3cf 100644 --- a/source/_docs/configuration/basic.markdown +++ b/source/_docs/configuration/basic.markdown @@ -36,20 +36,4 @@ Configuration variables: - **customize** (*Optional*): [Customize](/docs/configuration/customizing-devices/) entities. - **customize_domain** (*Optional*): [Customize](/docs/configuration/customizing-devices/) all entities in a domain. - **customize_glob** (*Optional*): [Customize](/docs/configuration/customizing-devices/) entities matching a pattern. -- **whitelist_external_dirs** (*Optional*): List of folders that can be used as sources for sending files. - -### {% linkable_title Password protecting the web interface %} - -First, you'll want to add a password for the Home Assistant web interface. Use your favorite text editor to open `configuration.yaml` and edit the `http` section: - -```yaml -http: - api_password: YOUR_PASSWORD -``` - --If you decide to expose your Home Assistant instance to the internet and forget to set a password, your installation could be accessed by everybody. -
- -See the [HTTP component documentation](/components/http/) for more options, such as the use of HTTPS encryption. - +- **whitelist_external_dirs** (*Optional*): List of folders that can be used as sources for sending files. \ No newline at end of file diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index a3dc6cc91a3..8de3aa169e0 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -10,8 +10,86 @@ footer: true redirect_from: /getting-started/customizing-devices/ --- +## {% linkable_title Changing the entity_id %} + +You can use the UI to change the `entity_id` and friendly name of supported entities. To do this: + +1. Select the entity, either from or from the frontend, or by clicking
next to the entity in the dev-states menu
+2. Click on the cog in the right corner of the entity's dialog
+3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`)
+4. Select *Save*
+
+## {% linkable_title Customizing entities %}
+
By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
+### {% linkable_title Customization using the UI %}
+
+Under the *Configuration* menu you'll find the *Customization* menu. When you select an entity to customize, you'll see all the existing attributes listed and you can customize those, or select an additional supported attribute ([see below](/docs/configuration/customizing-devices/#possible-values)).
+
+#### {% linkable_title Possible values %}
+
+{% configuration customize %}
+friendly_name:
+ description: Name of the entity as displayed in the UI.
+ required: false
+ type: string
+homebridge_name:
+ description: Name of the entity in `HomeBridge`.
+ required: false
+ type: string
+hidden:
+ description: Set to `true` to hide the entity.
+ required: false
+ type: boolean
+ default: False
+homebridge_hidden:
+ description: Set to `true` to hide the entity from `HomeBridge`.
+ required: false
+ type: boolean
+ default: False
+emulated_hue_hidden:
+ description: Set to `true` to hide the entity from `emulated_hue` (this will be deprecated in the near future and should be configured in [`emulated_hue`](/components/emulated_hue)).
+ required: false
+ type: boolean
+ default: False
+entity_picture:
+ description: URL to use as picture for entity.
+ required: false
+ type: string
+icon:
+ description: Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://materialdesignicons.com/cheatsheet)). Prefix name with `mdi:`, ie `mdi:home`.
+ required: false
+ type: string
+assumed_state:
+ description: For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
+ required: false
+ type: boolean
+ default: True
+device_class:
+ description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below).
+ required: false
+ type: boolean
+initial_state:
+ description: Sets the initial state for automations, `on` or `off`.
+ required: false
+ type: string
+unit_of_measurement:
+ description: Defines the units of measurement, if any.
+ required: false
+ type: string
+{% endconfiguration %}
+
+#### {% linkable_title Device Class %}
+
+Device class is currently supported by the following components:
+
+* [Binary Sensor](/components/binary_sensor/)
+* [Sensor](/components/sensor/)
+* [Cover](/components/cover/)
+
+### {% linkable_title Manual customization %}
+
If you implement `customize`, `customize_domain`, or `customize_glob` you must make sure it is done inside of `homeassistant:` or it will fail.
@@ -53,30 +131,6 @@ homeassistant: homebridge_hidden: true ``` -### {% linkable_title Possible values %} - -| Attribute | Description | -| --------- | ----------- | -| `friendly_name` | Name of the entity. -| `homebridge_name` | Name of the entity in `HomeBridge`. -| `hidden` | Set to `true` to hide the entity. -| `homebridge_hidden` | Set to `true` to hide the entity from `HomeBridge`. -| `emulated_hue_hidden` | Set to `true` to hide the entity from `emulated_hue` (this will be deprecated in the near future and should be configured in [`emulated_hue`](/components/emulated_hue)). -| `entity_picture` | Url to use as picture for entity. -| `icon` | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://materialdesignicons.com/cheatsheet)). Prefix name with `mdi:`, ie `mdi:home`. -| `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon. -| `device_class` | Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). -| `initial_state` | Sets the initial state for automations. `on` or `off`. -| `unit_of_measurement` | Defines the units of measurement, if any. - -### {% linkable_title Device Class %} - -Device class is currently supported by the following components: - -* [Binary Sensor](/components/binary_sensor/) -* [Sensor](/components/sensor/) -* [Cover](/components/cover/) - ### {% linkable_title Reloading customize %} Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant.reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the
service developer tools, select the service `homeassistant.reload_core_config` and click "CALL SERVICE".
@@ -84,4 +138,3 @@ Home Assistant offers a service to reload the core configuration while Home Assi
New customize information will be applied the next time the state of the entity gets updated.
- diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown index 4ed3e20243e..664acbe217b 100644 --- a/source/_docs/configuration/securing.markdown +++ b/source/_docs/configuration/securing.markdown @@ -14,7 +14,7 @@ One major advantage of Home Assistant is that it's not dependent on cloud servic ### {% linkable_title Checklist %} -- [Protect your web interface with a password](/getting-started/basic/#password-protecting-the-web-interface) +- [Choose a strong password](/docs/authentication/). - Secure your host. Sources could be [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/pdf/Security_Guide/Red_Hat_Enterprise_Linux-7-Security_Guide-en-US.pdf), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf), or the [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-howto/index.en.html). - Restrict network access to your devices. Set `PermitRootLogin no` in your sshd config (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. - Don't run Home Assistant as root – consider the Principle of Least Privilege. diff --git a/source/_docs/installation/hassbian.markdown b/source/_docs/installation/hassbian.markdown index 9c12947cd46..9fdcd566a0a 100644 --- a/source/_docs/installation/hassbian.markdown +++ b/source/_docs/installation/hassbian.markdown @@ -23,4 +23,5 @@ When instructions tell you to activate the virtual environment to install a Pyth ```bash $ sudo -u homeassistant -H -s -$ source /srv/homeassistant/bin/activate``` +$ source /srv/homeassistant/bin/activate +``` diff --git a/source/_docs/installation/python.markdown b/source/_docs/installation/python.markdown index a7dda882e25..7f8c01ad421 100644 --- a/source/_docs/installation/python.markdown +++ b/source/_docs/installation/python.markdown @@ -10,6 +10,10 @@ footer: true redirect_from: /getting-started/installation-python/ --- ++If you're running a Linux-based platform, we strongly recommend you follow the instructions for a [virtual environment](/docs/installation/virtualenv/) instead. If you're running on Windows then [see here](/docs/installation/windows/#installing-in-a-python-virtual-environment) instead. +
+ Once Python is installed, execute the following code in a console: ```bash @@ -22,12 +26,10 @@ Running these commands will: - Install Home Assistant - Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123) -If you're running a Linux-based platform, we suggest you follow the instructions for a [virtual environment](/docs/installation/virtualenv/) to avoid using `root`. - Video tutorials of this process for various operating systems are available here: - [Windows 10](https://www.youtube.com/watch?v=X27eVvuqwnY) - [macOS](https://www.youtube.com/watch?v=hej6ipN86ls) - [Ubuntu 14.04](https://www.youtube.com/watch?v=SXaAG1lGNH0) -Keep in mind that the used operating systems and the shown software releases may be outdated. +Keep in mind that the operating systems used and the software releases shown may be outdated. diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown index fdaac560c3c..128b122649b 100644 --- a/source/_docs/z-wave/controllers.markdown +++ b/source/_docs/z-wave/controllers.markdown @@ -24,6 +24,7 @@ You need to have a [supported Z-Wave USB stick or module](https://github.com/Ope | Sigma Designs UZB Stick | | | | | Tricklestar | | | | | Vision USB Stick | | | | +| ZWave.me Razberry Board | ✓ | | | | ZWave.me UZB1 | ✓ | | |diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index bb84afca590..add87e6abdc 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -49,7 +49,7 @@ $ echo -e -n "\x01\x08\x00\xF2\x51\x01\x01\x05\x01\x50" > /dev/serial/by-id/usb- You need to disable the on-board Bluetooth since the board requires the use of the hardware UART (and there's only one on the Pi3). You do this by adding the following to the end of `/boot/config.txt`: -``` +```text dtoverlay=pi3-disable-bt ``` @@ -59,7 +59,24 @@ Then disable the Bluetooth modem service: $ sudo systemctl disable hciuart ``` -Finally, reboot to make those changes active. It's been reported that this is also required on the Pi2. +Once Bluetooth is off, enable the serial interface via the `raspi-config` tool. After reboot run: + +```bash +$ sudo systemctl mask serial-getty@ttyAMA0.service +``` + +so that your serial interface looks like: + +```text +crw-rw---- 1 root dialout 204, 64 Sep 2 14:38 /dev/ttyAMA0 +``` +at this point simply add your user (homeassistant) to the dialout group: + +```bash +$ sudo usermod -a -G dialout homeassistant +``` + +Finally, reboot again to make those changes active. It's has been tested on hassbian and has been reported that this is also required on the Pi2.
If you've installed the Z-Way software, you'll need to ensure you disable it before you install Home Assistant or you won't be able to access the board. Do this with `sudo /etc/init.d/z-way-server stop; sudo update-rc.d z-way-server disable`. diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index 586f319a68a..a118d2c97ce 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -103,7 +103,7 @@ device_config / device_config_domain / device_config_glob: type: integer default: 2 invert_openclose_buttons: - description: Inverts function of the open and close buttons for the cover domain. + description: Inverts function of the open and close buttons for the cover domain. This will not invert the positon and state reporting. required: false type: boolean default: False diff --git a/source/_lovelace/map.markdown b/source/_lovelace/map.markdown index 503d4ee0bb7..6f8f81b1a0a 100644 --- a/source/_lovelace/map.markdown +++ b/source/_lovelace/map.markdown @@ -40,17 +40,29 @@ aspect_ratio: description: "The map's height:width ratio." type: string default: "100%" +default_zoom: + required: false + description: The default zoom level of the map. + type: integer + default: 14 (or whatever zoom level is required to fit all visible markers) {% endconfiguration %}
Only entities that have latitude and longitude attributes will be displayed on the map.
++ The `default_zoom` value will be ignored if it is set higher than the current zoom level + after fitting all visible entity markers in the map window. In other words, this can only + be used to zoom the map _out_ by default. +
+ ## {% linkable_title Examples %} ```yaml - type: map aspect_ratio: 100% + default_zoom: 8 entities: - device_tracker.demo_paulus - zone.home diff --git a/source/_lovelace/weather-forecast.markdown b/source/_lovelace/weather-forecast.markdown index b92588bd2c2..c636319db9a 100644 --- a/source/_lovelace/weather-forecast.markdown +++ b/source/_lovelace/weather-forecast.markdown @@ -34,3 +34,9 @@ entity: - type: weather-forecast entity: weather.demo_weather_north ``` + ++ This card works only with platforms that define a `weather` entity. + + E.g., it works with [Dark Sky](https://www.home-assistant.io/components/weather.darksky/) but not [Dark Sky Sensor](https://www.home-assistant.io/components/sensor.darksky/) +
diff --git a/source/_posts/2018-08-29-release-77.markdown b/source/_posts/2018-08-29-release-77.markdown index fdaf74551a6..d57d9910198 100644 --- a/source/_posts/2018-08-29-release-77.markdown +++ b/source/_posts/2018-08-29-release-77.markdown @@ -23,7 +23,7 @@ Once logged in, you will have access to the following new features: - Configure multifactor authentication (TOTP) - Manage other users (limited to account created during onboarding) -Although it's possible to configure authentication, we stronlgy recommend to stick with the default authentication configuration. If you had auth providers configured in a previous Home Assistant release, we recommend to remove the configuration and start using the default. +Although it's possible to configure authentication, we strongly recommend to stick with the default authentication configuration. If you had auth providers configured in a previous Home Assistant release, we recommend to remove the configuration and start using the default. It will take some time before all of the Home Assistant ecosystem has been migrated over to the new auth system. Home Assistant will print a warning whenever an application connects to Home Assistant with the legacy authentication. This will help users notify the application developers to transition to use the new [OAuth2](https://developers.home-assistant.io/docs/en/auth_api.html) authentication. For non-interactive scripts or other applications that are unable to update, we are planning to introduce a migration path for components to adopt url specific auth tokens and also introduce long lived access tokens to replace API passwords. A list of impacted components can be found [here](https://github.com/home-assistant/home-assistant/issues/15376#issuecomment-415890552). @@ -48,6 +48,51 @@ You didn't think we would forget about Lovelace, did you? This release include a - Add support for NOAA tide information (new PR) ([@jcconnell] - [#15947]) ([sensor.noaa_tides docs]) (new-platform) - Hangouts ([@hobbypunk90] - [#16049]) ([hangouts docs]) ([notify docs]) (new-platform) +## {% linkable_title Release 0.77.1 - August 29 %} + +- Fix trusted networks login error ([@awarecan]) +- Fix data_key override by parent class ([@syssi] - [#16278]) ([binary_sensor.xiaomi_aqara docs]) +- Fix error when vacuum is idling ([@cnrd] - [#16282]) ([vacuum.xiaomi_miio docs]) + +[#16278]: https://github.com/home-assistant/home-assistant/pull/16278 +[#16282]: https://github.com/home-assistant/home-assistant/pull/16282 +[@cnrd]: https://github.com/cnrd +[@syssi]: https://github.com/syssi +[binary_sensor.xiaomi_aqara docs]: /components/binary_sensor.xiaomi_aqara/ +[vacuum.xiaomi_miio docs]: /components/vacuum.xiaomi_miio/ + +## {% linkable_title Release 0.77.2 - August 31 %} + +- Correct wemo static device discovery issue. ([@lamiskin] - [#16292]) ([wemo docs]) +- Fix LIFX effects ([@amelchio] - [#16309]) ([light.lifx docs]) +- avoid error in debug log mode and rss entry without title ([@exxamalte] - [#16316]) ([feedreader docs]) +- Fix charts for climate devices ([@jeradM]) +- Fix header in Lovelace Glance cards ([@balloob]) +- Fix Profile page on Safari ([@balloob]) +- Fix redirect to login page on offline server ([@balloob]) + +[#16292]: https://github.com/home-assistant/home-assistant/pull/16292 +[#16309]: https://github.com/home-assistant/home-assistant/pull/16309 +[#16316]: https://github.com/home-assistant/home-assistant/pull/16316 +[@amelchio]: https://github.com/amelchio +[@exxamalte]: https://github.com/exxamalte +[@lamiskin]: https://github.com/lamiskin +[feedreader docs]: /components/feedreader/ +[light.lifx docs]: /components/light.lifx/ +[wemo docs]: /components/wemo/ + +## {% linkable_title Release 0.77.3 - September 3 %} + +Frontend changes only: + +- Ask "save login" after hass connected [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1631) [@awarecan] +- Show an error when invalid client id or redirect uri [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1620) [@balloob] +- Disable autocapitalization of username field [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1627) [@timmo001] +- Upgrade MDI icons [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1630) [@balloob] +- Update translations + +[@timmo001]: https://github.com/timmo001 + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. diff --git a/source/cloud/alexa.markdown b/source/cloud/alexa.markdown index 7e140825afd..8e90a4d8eef 100644 --- a/source/cloud/alexa.markdown +++ b/source/cloud/alexa.markdown @@ -10,13 +10,13 @@ footer: true redirect_from: /components/cloud.alexa/ --- -The Alexa integration allows users to control the entities via the [Home Assistant Smart Home skill for Alexa][alexa skill]. This means that you can say things like "Alexa, turn on the kitchen light" to control your local Home Assistant. +The Alexa integration allows users to control the entities via the Home Assistant Smart Home skill for Alexa. This means that you can say things like "Alexa, turn on the kitchen light" to control your local Home Assistant. To use this integration, you need to have: - The cloud component set up. [Learn more](/components/cloud/) - An Alexa enabled device like the Amazon Echo - - Activated the [Home Assistant Smart Home skill for Alexa][alexa skill] + - Activated the Home Assistant Smart Home skill via the Alexa app You can use `configuration.yaml` to configure the entities that are being shown to Alexa and how they are exposed. @@ -110,5 +110,3 @@ Currently, the following domains are available to be used with Alexa: - scene - script (enables/disables) - switch - -[alexa skill]: https://alexa.amazon.com/spa/index.html#skills/dp/B0772J1QKB/?ref=skill_dsk_skb_sr_2 diff --git a/source/hassio/commandline.markdown b/source/hassio/commandline.markdown index 61fefdd1877..a37177f832f 100644 --- a/source/hassio/commandline.markdown +++ b/source/hassio/commandline.markdown @@ -89,3 +89,7 @@ GLOBAL OPTIONS: --help, -h show help --version, -v print the version ``` + +## {% linkable_title Console access %} + +You can also access HassOS via a directly connected keyboard and monitor, the console. To log in to the physical console the username is `root`, with no password. diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 88aac017cc6..1b17327d575 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -77,14 +77,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the [etcher]: https://etcher.io/ [Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md [hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md -[pi0-w]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi0-w-2.2.img.gz -[pi1]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi-2.2.img.gz -[pi2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi2-2.2.img.gz -[pi3-32]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi3-2.2.img.gz -[pi3-64]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi3-64-2.2.img.gz +[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi0-w-1.10.img.gz +[pi1]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi-1.10.img.gz +[pi2]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi2-1.10.img.gz +[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi3-1.10.img.gz +[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi3-64-1.10.img.gz [tinker]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_tinker-2.2.img.gz [odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_odroid-c2-2.2.img.gz -[vmdk]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_ova-2.2.vmdk.gz +[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_ova-1.10.vmdk.gz [linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio [local]: http://hassio.local:8123 [samba]: /addons/samba/ diff --git a/source/images/frontend/entity_box.png b/source/images/frontend/entity_box.png new file mode 100644 index 00000000000..8336a978d98 Binary files /dev/null and b/source/images/frontend/entity_box.png differ diff --git a/source/images/frontend/user-language.png b/source/images/frontend/user-language.png new file mode 100644 index 00000000000..258c6f5ac78 Binary files /dev/null and b/source/images/frontend/user-language.png differ diff --git a/source/images/frontend/user-theme.png b/source/images/frontend/user-theme.png new file mode 100644 index 00000000000..28dd6248f92 Binary files /dev/null and b/source/images/frontend/user-theme.png differ diff --git a/source/images/supported_brands/switchbot.png b/source/images/supported_brands/switchbot.png new file mode 100644 index 00000000000..da31c5feb00 Binary files /dev/null and b/source/images/supported_brands/switchbot.png differ diff --git a/source/lovelace/changelog.markdown b/source/lovelace/changelog.markdown index e32dbaf0bcf..39bc13598b8 100644 --- a/source/lovelace/changelog.markdown +++ b/source/lovelace/changelog.markdown @@ -2,12 +2,14 @@ layout: page title: "Lovelace Changelog" description: "Changelog of the Lovelace UI." -date: 2018-07-01 10:28 +00:00 +date: 2018-08-31 13:06 +02:00 sidebar: true comments: false sharing: true footer: true --- +## {% linkable_title Changes in 0.77.0 %} +- 📣 New notification drawer ❤️ ## {% linkable_title Changes in 0.75.0 %}