Paulus Schoutsen
GitHub
commit
0d851cff54
45 changed files with 1105 additions and 96 deletions
39
source/_components/abode.markdown
Normal file
39
source/_components/abode.markdown
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Abode Home Security"
|
||||
description: "Instructions on integrating Abode home security with Home Assistant."
|
||||
date: 2017-08-26 0:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: abode.jpg
|
||||
ha_category: Hub
|
||||
ha_release: 0.52
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
|
||||
|
||||
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](/components/binary_sensor.abode/): Reports on `Door Contacts` (open or close) and `Motion Camera` (motion detected or not)
|
||||
- [Alarm Control Panel](/components/alarm_control_panel.abode/): Reports on current alarm status and can be used to arm/disarm the system
|
||||
|
||||
The component currently polls every 30 seconds, so device status may not be immediately reflected in Home Assistant.
|
||||
|
||||
An `abode` section must be present in the `configuration.yaml` file and contain the following options as required:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
abode:
|
||||
username: abode_username
|
||||
password: abode_password
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): Username for the Abode account.
|
||||
- **password** (*Required*): Password for Abode account.
|
||||
19
source/_components/alarm_control_panel.abode.markdown
Normal file
19
source/_components/alarm_control_panel.abode.markdown
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Abode Alarm Control Panel"
|
||||
description: "Instructions how to setup the Abode Alarm control panel within Home Assistant."
|
||||
date: 2017-08-26 0:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: abode.jpg
|
||||
ha_category: Alarm
|
||||
ha_release: 0.52
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
|
||||
|
||||
The requirement is that you have setup your [Abode hub](/components/abode/).
|
||||
|
|
@ -14,7 +14,9 @@ ha_release: 0.42
|
|||
|
||||
The `totalconnect` platform provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies.
|
||||
|
||||
If you have issues running this component, you may require "libxml2-dev" and "libxmlsec1-dev". To install these on Hassbian, run the command `apt install libxml2-dev libxmlsec1-dev` with sudo
|
||||
This platform supports the following services: `alarm_arm_away`, `alarm_arm_home`, `alarm_arm_night` and `alarm_disarm`.
|
||||
|
||||
If you have issues running this component, you may require `libxml2-dev` and `libxmlsec1-dev` packages. To install these on Hassbian, run the command `apt install libxml2-dev libxmlsec1-dev` with sudo.
|
||||
|
||||
To enable this, add the following lines to your `configuration.yaml`:
|
||||
|
||||
|
|
|
|||
20
source/_components/binary_sensor.abode.markdown
Normal file
20
source/_components/binary_sensor.abode.markdown
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Abode Binary Sensor"
|
||||
description: "Instructions how to integrate Abode binary sensors into Home Assistant."
|
||||
date: 2017-08-26 0:28
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: alarmdecoder.png
|
||||
ha_release: 0.52
|
||||
ha_category: Binary Sensor
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `abode` security control panel platform allows you to control your [Abode](https://goabode.com/) alarms.
|
||||
|
||||
This component will automatically add `Door Contact` and `Motion Camera` binary sensors that are configured in your Abode account.
|
||||
|
||||
The requirement is that you have setup your [Abode hub](/components/abode/).
|
||||
|
|
@ -30,6 +30,7 @@ Configuration variables:
|
|||
- **province** (*Optional*): Province code according to [holidays](https://pypi.python.org/pypi/holidays/0.8.1) notation. Defaults to None.
|
||||
- **workdays** (*Optional*): List of workdays. Defaults to `mon`, `tue`, `wed`, `thu`, `fri`.
|
||||
- **excludes** (*Optional*): List of workday excludes. Defaults to `sat`, `sun`, `holiday`.
|
||||
- **days_offset** (*Optional*): Set days offset. Defaults to `0`.
|
||||
|
||||
Days are specified as follows: `mon`, `tue`, `wed`, `thu`, `fri`, `sat`, `sun`. The keyword `holiday` is used for public holidays identified by the holidays module.
|
||||
|
||||
|
|
|
|||
31
source/_components/camera.usps.markdown
Normal file
31
source/_components/camera.usps.markdown
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
layout: page
|
||||
title: USPS Camera
|
||||
description: "Instructions on how to set up USPS camera within Home Assistant."
|
||||
date: 2017-07-28 20:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: usps.png
|
||||
ha_category: Camera
|
||||
ha_release: 0.52
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `usps` camera component allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](/components/sensor.usps).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [USPS component](/components/usps/) configured to use this camera. The camera will be setup if the `usps` component is configured and the required configuration is set.
|
||||
</p>
|
||||
|
||||
To customize the interval that mail images are rotated in the mail camera you can edit your `configuration.yaml` file with the following settings:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
camera:
|
||||
- platform: usps
|
||||
scan_interval: 5
|
||||
```
|
||||
|
||||
To enable this camera in your installation, set up the [USPS component](/components/usps) with your username and password.
|
||||
|
|
@ -16,9 +16,9 @@ ha_iot_class: "Cloud Push"
|
|||
|
||||
The `automatic` platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service.
|
||||
|
||||
To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will also need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference.
|
||||
To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `<home-assistant-url>/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication.
|
||||
|
||||
Home Assistant will also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, Home Assistant will automatically make use of it after the next restart.
|
||||
Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml.
|
||||
|
||||
Once your developer account is created, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -28,8 +28,6 @@ device_tracker:
|
|||
- platform: automatic
|
||||
client_id: 1234567
|
||||
secret: 0987654321
|
||||
username: your@email.com
|
||||
password: your_password
|
||||
devices:
|
||||
- 2007 Honda Element
|
||||
- 2004 Subaru Impreza
|
||||
|
|
@ -39,8 +37,7 @@ Configuration variables:
|
|||
|
||||
- **client_id** (*Required*): The OAuth client id (get from https://developer.automatic.com/).
|
||||
- **secret** (*Required*): The OAuth client secret (get from https://developer.automatic.com/).
|
||||
- **username** (*Required*): The username associated with your ODB reader.
|
||||
- **password** (*Required*): The password for your given ODB reader account.
|
||||
- **current_location** (*Optional*): Set to `true` if you have requested `scope:current_location` for your account. Home Assistant will then be able to receive periodic location updates during trips.
|
||||
- **devices** (*Optional*): The list of vehicle display names you wish to track. If not provided, all vehicles will be tracked.
|
||||
|
||||
Home Assistant will also fire events when an update is received from Automatic. These can be used to trigger automations, as shown in the example below. A list of available event types can be found in the [Automatic Real-Time Events documentation](https://developer.automatic.com/api-reference/#real-time-events).
|
||||
|
|
|
|||
52
source/_components/lock.nello.markdown
Normal file
52
source/_components/lock.nello.markdown
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Nello Lock"
|
||||
description: "Instructions on how to integrate Nello intercom devices."
|
||||
date: 2017-08-13 17:25
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: nello.png
|
||||
ha_category: Lock
|
||||
featured: false
|
||||
|
||||
ha_release: 0.52
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `nello` platform allows you to control [Nello](https://nello.io) intercoms.
|
||||
To get started you need to create a secondary Nello account and authorize it to access your lock(s).
|
||||
|
||||
<p class="note warning">
|
||||
Be aware that if you use your main account for Home Assistant you may not be able to use it with the App.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
lock:
|
||||
- platform: nello
|
||||
username: mail@example.com
|
||||
password: mySecretPassword
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The username of your Nello account.
|
||||
- **password** (*Required*): The password of your Nello account.
|
||||
|
||||
## {% linkable_title Events %}
|
||||
|
||||
### {% linkable_title Event `nello_bell_ring` %}
|
||||
|
||||
Every time someone rings the bell, a `nello_bell_ring` event will be fired.
|
||||
|
||||
Field | Description
|
||||
----- | -----------
|
||||
`address` | Postal address of the lock.
|
||||
`date` | Date when the event occured.
|
||||
`description` | Human readable string describing the event.
|
||||
`location_id` | Nello ID of the location where the bell has been rung.
|
||||
`short_id` | Shorter Nello ID.
|
||||
|
|
@ -30,6 +30,7 @@ Configuration variables:
|
|||
- **host** (*Optional*): The IP of the LG webOS Smart TV, e.g. `192.168.0.10`.
|
||||
- **mac** (*Optional*): The MAC address of the TV, e.g. `C8:08:E9:99:99:1A`.
|
||||
- **name** (*Optional*): The name you would like to give to the LG webOS Smart TV.
|
||||
- **timeout** (*Optional*): The timeout for connections to the TV in seconds.
|
||||
- **filename** (*Optional*): The filename where the pairing key with the TV should be stored. This path is relative to Home Assistant's config directory. It defaults to `webostv.conf`.
|
||||
- **customize** array (*Optional*): List of options to customize.
|
||||
- ***sources** array (*Optional*): List of hardware inputs.
|
||||
|
|
@ -46,6 +47,7 @@ media_player:
|
|||
host: 192.168.0.10
|
||||
mac: C8:08:E9:99:99:1A
|
||||
name: Living Room TV
|
||||
timeout: 5
|
||||
filename: webostv.conf
|
||||
customize:
|
||||
sources:
|
||||
|
|
|
|||
53
source/_components/notify.hipchat.markdown
Normal file
53
source/_components/notify.hipchat.markdown
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
layout: page
|
||||
title: "HipChat"
|
||||
description: "Instructions how to add HipChat notifications to Home Assistant."
|
||||
date: 2017-08-10 15:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: hipchat.png
|
||||
ha_category: Notifications
|
||||
ha_release: "0.52"
|
||||
---
|
||||
|
||||
|
||||
The `hipchat` platform allows you to send notifications from Home Assistant to [HipChat](https://hipchat.com/).
|
||||
|
||||
You need to obtain a [HipChat API token](https://developer.atlassian.com/hipchat/guide/hipchat-rest-api/api-access-tokens#APIaccesstokens-Usergeneratedtokens) to be able to send notifications.
|
||||
|
||||
To enable the HipChat notification in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: hipchat
|
||||
token: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||
room: 1234567
|
||||
```
|
||||
|
||||
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`.
|
||||
- **token** (*Required*): The HipChat API token to use for sending HipChat notifications.
|
||||
- **room** (*Required*): The default room to post to if no room is explicitly specified when sending the notification.
|
||||
- **color** (*Optional*): Setting color will override the default color for the notification. By default not setting this will post to HipChat using the default color yellow. Valid options are 'yellow', 'green', 'red', 'purple', 'gray', 'random'.
|
||||
- **notify** (*Optional*): Setting notify will override the default notify (blink application icon, chime, or otherwise call attention) setting for the notification. By default this is 'false'. Valid options are 'true' and 'false'.
|
||||
- **format** (*Optional*): Setting format will override the default message format. Default is 'text'. Valid options are 'text' and 'html'.
|
||||
- **host** (*Optional*): Setting the host will override the default HipChat server host. Default is 'https://api.hipchat.com/'.
|
||||
|
||||
### {% linkable_title HipChat service data %}
|
||||
|
||||
The following attributes can be placed `data` for extended functionality.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `room` | yes | (int) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
|
||||
| `color` | yes | (str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
|
||||
| `notify` | yes | (bool) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
|
||||
| `format` | yes | (str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
||||
43
source/_components/notify.prowl.markdown
Normal file
43
source/_components/notify.prowl.markdown
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Prowl"
|
||||
description: "Instructions how to add Prowl notifications to Home Assistant."
|
||||
date: 2017-08-17 18:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: prowl.png
|
||||
ha_category: Notifications
|
||||
ha_release: 0.52
|
||||
---
|
||||
|
||||
|
||||
The `prowl` platform uses [Prowl](https://www.prowlapp.com/) to deliver push notifications from Home Assistant to your iOS device.
|
||||
|
||||
Go to the [Prowl website](https://www.prowlapp.com/) and create a new API key.
|
||||
|
||||
To add Prowl notifications to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: prowl
|
||||
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
||||
```
|
||||
|
||||
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`.
|
||||
- **api_key** (*Required*): The Prowl API key to use.
|
||||
|
||||
### {% linkable_title Prowl service data %}
|
||||
|
||||
The following attributes can be placed `data` for extended functionality.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `priority` | yes | Priority level, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
|
@ -23,12 +23,14 @@ To get started with the OctoPrint API, please follow the directions on their [si
|
|||
octoprint:
|
||||
host: YOUR_OCTOPRINT_HOST
|
||||
api_key: YOUR_API_KEY
|
||||
bed: false
|
||||
number_of_tools: 1
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): IP address or hostname of Octoprint host.
|
||||
- **api_key** (*Required*): The retrieved api key.
|
||||
- **bed** (*Optional*): If the printer has a heated bed.
|
||||
- **number_of_tools** (*Optional*): Number of temperature adjustable tools. i.e. nozzle.
|
||||
|
||||
|
||||
**NOTE** If your 3D printer isn't connected to the OctoPrint server during the startup of Home Assistant this component will fail to load.
|
||||
|
|
|
|||
|
|
@ -46,23 +46,48 @@ Configuration variables:
|
|||
- **timeframe** (*Optional*): Minutes to look ahead for precipitation forecast (5..120) [default: 60].
|
||||
- **monitored_conditions** array (*Required*): One or more conditions to display in the frontend.
|
||||
- **stationname**: The name of the selected meteo-station.
|
||||
- **symbol**: A symbol for the current weather.
|
||||
- **conditioncode**: A symbol and a unique code identifying the current weather condition ([a..z]).
|
||||
- **condition**: A symbol and the current weather condition (clear, cloudy, fog, rainy, snowy, lightning).
|
||||
- **conditiondetailed**: A symbol and detailed current weather condition (clear, partlycloudy, cloudy, partlycloudy-fog, partlycloudy-light-rain, partlycloudy-rain, light-rain, rainy, snowy-rainy, partlycloudy-light-snow, partlycloudy-snow, light-snow, snowy, partlycloudy-lightning, lightning).
|
||||
- **conditionexact**: A symbol with the full current weather condition (in English).
|
||||
- **symbol**: A symbol for the current weather with the full current condition (in Dutch).
|
||||
- **humidity**: The relative humidity (%).
|
||||
- **temperature**: The current temperature (in C).
|
||||
- **groundtemperature**: The current ground temperature (in C).
|
||||
- **windspeed**: The wind speed in m/s.
|
||||
- **windforce**: The wind speed/force in Bft.
|
||||
- **temperature**: The current temperature (in [C](https://en.wikipedia.org/wiki/Celsius)).
|
||||
- **groundtemperature**: The current ground temperature (in [C](https://en.wikipedia.org/wiki/Celsius)).
|
||||
- **windspeed**: The wind speed in [m/s](https://en.wikipedia.org/wiki/M/s).
|
||||
- **windforce**: The wind speed/force in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale).
|
||||
- **winddirection**: Where the wind is coming from: N (North),Z (south), NO (Noth-East), etc.
|
||||
- **windazimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.
|
||||
- **pressure**: The sea-level air pressure in hPa.
|
||||
- **visibility**: Visibility in meters (m).
|
||||
- **windgust**: The windspeed of wind gusts (m/s).
|
||||
- **pressure**: The sea-level air pressure in [hPa](https://en.wikipedia.org/wiki/Hectopascal).
|
||||
- **visibility**: Visibility in meters ([m](https://en.wikipedia.org/wiki/Metre)).
|
||||
- **windgust**: The windspeed of wind gusts ([m/s](https://en.wikipedia.org/wiki/M/s)).
|
||||
- **precipitation**: The amount of precipitation/rain in mm/h.
|
||||
- **precipitation_forecast_average**: The average expected precipitation/rain in mm/h within the given timeframe.
|
||||
- **precipitation_forecast_total**: The total expected precipitation/rain in mm within the given timeframe. The total expected rain in the configured timeframe will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with timeframe configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If timeframe is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
|
||||
- **irradiance**: Sun intensity in Watt per square meter (W/m2).
|
||||
|
||||
Full configuration example where location is manually specified:
|
||||
- **irradiance**: Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2)).
|
||||
- **temperature_1d** [<sup>[1d]</sup>](#1d): The forecasted temperature (in [C](https://en.wikipedia.org/wiki/Celsius)).
|
||||
- **mintemp_1d** [<sup>[1d]</sup>](#1d): The forecasted minimum temperature (in [C](https://en.wikipedia.org/wiki/Celsius)).
|
||||
- **rainchance_1d** [<sup>[1d]</sup>](#1d): The forecasted chance for rain (%).
|
||||
- **sunchance_1d** [<sup>[1d]</sup>](#1d): The forecasted chance for sun (%).
|
||||
- **rain_1d** [<sup>[1d]</sup>](#1d): The forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimetre).
|
||||
- **snow_1d** [<sup>[1d]</sup>](#1d): The forecasted amount of snow in [cm](https://en.wikipedia.org/wiki/Centimetre).
|
||||
- **windforce_1d** [<sup>[1d]</sup>](#1d): The expected windforce in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale).
|
||||
- **conditioncode_1d** [<sup>[1d]</sup>](#1d): Symbol and condition code of the expected condition.
|
||||
- **condition_1d** [<sup>[1d]</sup>](#1d): Symbol and expected condition.
|
||||
- **conditiondetailed_1d** [<sup>[1d]</sup>](#1d): Symbol and detailed expected condition.
|
||||
- **conditionexact_1d** [<sup>[1d]</sup>](#1d): Symbol and full expected condition (in English).
|
||||
- **symbol_1d** [<sup>[1d]</sup>](#1d): Symbol and full expected condition (in Dutch).
|
||||
|
||||
|
||||
## Daily forecasts
|
||||
|
||||
Conditions above marked with <a name="1d">[1d]</a> are daily forecasts. To get forecast for different day, replace the number
|
||||
in `_1d` part of the sensor name. Valid values are from `1` to `5`.
|
||||
|
||||
|
||||
## Configuration examples
|
||||
|
||||
Full configuration example (excluding forecasted conditions) where location is manually specified:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
|
@ -73,6 +98,10 @@ Full configuration example where location is manually specified:
|
|||
longitude: 5.70
|
||||
monitored_conditions:
|
||||
- stationname
|
||||
- conditioncode
|
||||
- condition
|
||||
- conditiondetailed
|
||||
- conditionexact
|
||||
- symbol
|
||||
- humidity
|
||||
- temperature
|
||||
|
|
@ -90,5 +119,47 @@ Full configuration example where location is manually specified:
|
|||
- precipitation_forecast_total
|
||||
```
|
||||
|
||||
|
||||
Configuration example with current condition and (some) forecasted values:
|
||||
|
||||
```yaml
|
||||
# Weather prediction
|
||||
sensor:
|
||||
- platform: buienradar
|
||||
monitored_conditions:
|
||||
# current condition:
|
||||
- condition
|
||||
- conditioncode
|
||||
- conditiondetailed
|
||||
- conditionexact
|
||||
- symbol
|
||||
# conditions for forecasted data:
|
||||
- symbol_1d
|
||||
- symbol_2d
|
||||
- symbol_3d
|
||||
- symbol_4d
|
||||
- symbol_5d
|
||||
- temperature_1d
|
||||
- temperature_2d
|
||||
- temperature_3d
|
||||
- temperature_4d
|
||||
- temperature_5d
|
||||
- rainchance_1d
|
||||
- rainchance_2d
|
||||
- rainchance_3d
|
||||
- rainchance_4d
|
||||
- rainchance_5d
|
||||
- sunchance_1d
|
||||
- sunchance_2d
|
||||
- sunchance_3d
|
||||
- sunchance_4d
|
||||
- sunchance_5d
|
||||
- rain_1d
|
||||
- rain_2d
|
||||
- rain_3d
|
||||
- rain_4d
|
||||
- rain_5d
|
||||
```
|
||||
|
||||
[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
|
||||
> Buienradar makes free weatherdata available for use by individuals and businesses (website/intranet). The use of the weatherdata is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your usage or to request permission.
|
||||
|
|
|
|||
|
|
@ -145,3 +145,16 @@ sensor:
|
|||
command: "python3 /path/to/script/arest-value.py"
|
||||
unit_of_measurement: "°C"
|
||||
```
|
||||
|
||||
### {% linkable_title Usage of templating in `command:` %}
|
||||
|
||||
[Templates](/docs/configuration/templating/) are supported in the `command:` configuration variable. This could be used if you want to include the state of a specific sensor as an argument to your external script.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: command_line
|
||||
name: wind direction
|
||||
command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {{ states.sensor.wind_direction.state }}'
|
||||
unit_of_measurement: "Direction"
|
||||
```
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ sensor:
|
|||
Configuration variables:
|
||||
|
||||
- **access_token** (*Required*): The Access Token for your account.
|
||||
- **channel_id** (*Optional*): Channel ID of your device. Needed if you have more than one device.
|
||||
- **channel_id** (*Optional*): Channel ID (as integer) of your device. Needed if you have more than one device.
|
||||
- **name** (*Optional*): The name of the sensor, eg. the city.
|
||||
|
||||
For details please check the [API documentation](https://my.eliq.se/knowledge/sv-SE/49-eliq-online/299-eliq-online-api).
|
||||
|
|
|
|||
|
|
@ -21,6 +21,7 @@ Enable the sensor by adding the following to your `configuration.yaml` file:
|
|||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: fitbit
|
||||
clock_format: 12H
|
||||
monitored_resources:
|
||||
- "body/weight"
|
||||
```
|
||||
|
|
@ -34,6 +35,7 @@ The unit system that the sensor will use is based on the country you set in your
|
|||
Configuration variables:
|
||||
|
||||
- **monitored_resources** (*Optional*): Resource to monitor. Defaults to `activities/steps`.
|
||||
- **clock_format** (*Optional*): Format to use for `sleep/startTime` resource. Accepts `12H` or `24H`. Defaults to `24H`.
|
||||
|
||||
Below is the list of resources that you can add to `monitored_resources`. One sensor is exposed for every resource.
|
||||
|
||||
|
|
|
|||
78
source/_components/sensor.london_air.markdown
Normal file
78
source/_components/sensor.london_air.markdown
Normal file
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
layout: page
|
||||
title: "London Air Quality"
|
||||
description: "Display the current status of London air quality by area and pollution type."
|
||||
date: 2017-08-02 18:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: waqi.png
|
||||
ha_category: Health
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.52
|
||||
---
|
||||
|
||||
|
||||
The `london_air` component [queries](http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available.
|
||||
|
||||
Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described [here](http://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json) and are Carbon Monoxide ([CO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx)), Nitrogen Dioxide ([NO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx)), Ozone ([O3](http://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx)), Sulphur Dioxide ([SO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx)), PM2.5 & PM10 [particulates](http://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx). The `latitude` and `longitude` of each site is accessible through a `data` attribute of the sensor, as are details about the pollutants monitored at that site. The `sites` attribute of a sensor displays how many monitoring sites that sensor covers. The `updated` attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes.
|
||||
|
||||
To add sensors to Home-assistant for all possible areas/boroughs add the following to your `configuration.yaml` file:
|
||||
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry for a single sensor
|
||||
sensor:
|
||||
- platform: london_air
|
||||
locations:
|
||||
- Barking and Dagenham
|
||||
- Bexley
|
||||
- Brent
|
||||
- Camden
|
||||
- City of London
|
||||
- Croydon
|
||||
- Ealing
|
||||
- Enfield
|
||||
- Greenwich
|
||||
- Hackney
|
||||
- Hammersmith and Fulham
|
||||
- Haringey
|
||||
- Harrow
|
||||
- Havering
|
||||
- Hillingdon
|
||||
- Islington
|
||||
- Kensington and Chelsea
|
||||
- Kingston
|
||||
- Lambeth
|
||||
- Lewisham
|
||||
- Merton
|
||||
- Redbridge
|
||||
- Richmond
|
||||
- Southwark
|
||||
- Sutton
|
||||
- Tower Hamlets
|
||||
- Wandsworth
|
||||
- Westminster
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **locations** array (*Required*): At least one entry required.
|
||||
|
||||
To explore the data available within the `data` attribute of a sensor use the `dev-template` tool on the Home-assistant frontend. `data` contains a list of monitored sites, where the number of monitored sites are given by the `sites` attribute. If a sensor has four sites, access the fourth site by indexing the list of sites using data[3]. Each site is a dictionary with multiple fields, with entries for the `latitude` and `longitude` of that site, a `pollution_status`, `site_code`, `site_name` and `site_type`. The field `number_of_pollutants` states how many pollutants are monitored (of the possible six) and the field `pollutants` returns a list with data for each pollutant. To access the first pollutant in the list for site zero use `attributes.data[0].pollutants[0]`. Each entry in `pollutants` is a dictionary with fields for the pollutant `code`, `description`, `index`, `quality` and a `summary`. [Template sensors](https://home-assistant.io/components/sensor.template/) can then be added to display these attributes, for example:
|
||||
|
||||
```yaml
|
||||
# Example template sensors
|
||||
- platform: template
|
||||
sensors:
|
||||
updated:
|
||||
friendly_name: 'Updated'
|
||||
value_template: {% raw %}'{{states.sensor.merton.attributes.updated}}'{% endraw %}
|
||||
merton_pm10:
|
||||
friendly_name: 'Merton PM10'
|
||||
value_template: {% raw %}'{{states.sensor.merton.attributes.data[0].pollutants[0].summary}}'{% endraw %}
|
||||
westminster_s02:
|
||||
friendly_name: 'Westminster S02'
|
||||
value_template: {% raw %}'{{states.sensor.westminster.attributes.data[0].pollutants[3].summary}}'{% endraw %}
|
||||
```
|
||||
|
|
@ -41,4 +41,6 @@ Configuration variables:
|
|||
- 'system_load': System Load 15 min
|
||||
- 'system_io_in': System I/O In
|
||||
- 'system_io_out': System I/O Out
|
||||
|
||||
- 'ipv4_in': Amount of inbound IPv4 packets per second
|
||||
- 'ipv4_out': Amount of outbound IPv4 packets per second
|
||||
- 'disk_free': Free disk space
|
||||
|
|
|
|||
|
|
@ -39,5 +39,9 @@ Configuration variables:
|
|||
- **monitored_conditions** array (*Required*): States to monitor.
|
||||
- **Current State**: Text of current state)
|
||||
- **Temperatures**: Temperatures of all available tools, eg. `print`, `head`, `print bed`, etc. These will be displayed as `tool0`, `tool1`, or `toolN` please refer to your OctoPrint frontend to associate the tool number with an actual device.
|
||||
- **Job Percentage**:
|
||||
- **Job Percentage**: Percentage of the job.
|
||||
|
||||
|
||||
<p class='note'>
|
||||
If you are tracking temperature it is recommended to set `bed` and/or `number_of_tools` in your octoprint configuration. This will allow the octoprint sensors to load if the printer is offline during Home Assistant startup.
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ ha_release: "0.22"
|
|||
---
|
||||
|
||||
|
||||
The `snmp` sensor platform simple displays the information which are available through the [Simple Network Management Protocol (SNMP)](https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol). SNMP uses a tree-like hierarchy where each node is an object.
|
||||
The `snmp` sensor platform displays information available through the [Simple Network Management Protocol (SNMP)](https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol). SNMP uses a tree-like hierarchy where each node is an object, and is mainly supported by network-oriented devices such as routers, modems, and printers.
|
||||
|
||||
To enable this sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
|
|
@ -29,18 +29,23 @@ sensor:
|
|||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address of your host, eg. `192.168.1.32`.
|
||||
- **port** (*Option*): The SNMP port of your host. Defaults to `161`.
|
||||
- **name** (*Optional*): Name of the SNMP sensor.
|
||||
- **community** (*Optional*): The SNMP community which is set for the device. Most devices have a default community set to to `public` with read-only permission (which is sufficient).
|
||||
- **baseoid** (*Required*): The OID where the information is located. It's advised to use the numerical notation.
|
||||
- **port** (*Option*): The SNMP port of your host. Defaults to `161`.
|
||||
- **community** (*Optional*): The SNMP community which is set for the device. Most devices have a default community set to to `public` with read-only permission (which is sufficient).
|
||||
- **version** (*Optional*) version of SNMP protocol, `1` or `2c`. Defaults to `1`. Version `2c` is needed to read data from 64-bit counters.
|
||||
- **name** (*Optional*): Name of the SNMP sensor.
|
||||
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
|
||||
- **version** (*Optional*) version of SNMP protocol, `1` or `2c` defaults to `1`. Version `2c` is needed to read data from 64-bit counters.
|
||||
- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to parse the value.
|
||||
- **accept_errors** (*Optional*): Determines whether the sensor should start and keep working even if the SNMP host is unreachable or not responding. This allows the sensor to be initialized properly even if, for example, your printer is not on when you start Home Assistant. Defaults to `false`.
|
||||
- **default_value** (*Optional*): Determines what value the sensor should take if `accept_errors` is set and the host is unreachable or not responding. If not set, the sensor will have value `unknown` in case of errors.
|
||||
|
||||
The OIDs may vary on different system because they are vendor-specific. Beside the device's manual is the [OID Repository](http://www.oid-info.com/) a good place to start if you are looking for OIDs. The following OIDs are for the load of a Linux systems.
|
||||
## {% linkable_title Finding OIDs %}
|
||||
|
||||
- 1 minute Load: 1.3.6.1.4.1.2021.10.1.3.1
|
||||
- 5 minute Load: 1.3.6.1.4.1.2021.10.1.3.2
|
||||
- 15 minute Load: 1.3.6.1.4.1.2021.10.1.3.3
|
||||
OIDs may vary on different systems because they are vendor-specific. Beside the device's manual, the [OID Repository](http://www.oid-info.com/) is a good place to start if you are looking for OIDs. As an example, the following OIDs are for the load of a Linux systems.
|
||||
|
||||
- 1 minute Load: `1.3.6.1.4.1.2021.10.1.3.1`
|
||||
- 5 minute Load: `1.3.6.1.4.1.2021.10.1.3.2`
|
||||
- 15 minute Load: `1.3.6.1.4.1.2021.10.1.3.3`
|
||||
|
||||
There is a large amount of tools available to work with SNMP. `snmpwalk` let you easily retrieve the value of a OID.
|
||||
|
||||
|
|
@ -49,3 +54,26 @@ $ snmpwalk -Os -c public -v 2c 192.168.1.32 1.3.6.1.4.1.2021.10.1.3.1
|
|||
laLoad.1 = STRING: 0.19
|
||||
```
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
### {% linkable_title Printer uptime minutes %}
|
||||
|
||||
According to the most common SNMP standard, the uptime of a device is accessible under OID `1.3.6.1.2.1.1.3.0`. The value represented using a format called `TimeTicks`, in units of hundredth of a second.
|
||||
|
||||
To create a sensor that displays the uptime for your printer in minutes, you can use this configuration:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: snmp
|
||||
name: 'Printer uptime'
|
||||
host: 192.168.2.21
|
||||
baseoid: 1.3.6.1.2.1.1.3.0
|
||||
accept_errors: true
|
||||
unit_of_measurement: 'minutes'
|
||||
value_template: {% raw %}'{{((value | int) / 6000) | int}}'{% endraw %}
|
||||
```
|
||||
|
||||
The `accept_errors` option will allow the sensor to work even if the printer is not on when Home Assistant is first started: the sensor will just display a `-` instead of a minute count.
|
||||
|
||||
The `value_template` option converts the original value to minutes.
|
||||
|
|
|
|||
|
|
@ -13,27 +13,6 @@ ha_release: 0.36
|
|||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `usps` platform allows one to track deliveries and inbound mail from the [US Postal Service (USPS)](https://www.usps.com/).
|
||||
In addition to having a USPS account, you will need to complete the "Opt-In" process by clicking "Get Started Now" on [this page](https://my.usps.com/mobileWeb/pages/intro/start.action). You must also "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see inbound mail.
|
||||
The `usps` sensor component allows you to view statistics on incoming mail and packages made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS camera](/components/camera.usps).
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: usps
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
You will see two new sensors, one for packages and one for mail.
|
||||
|
||||
Configuration options for the USPS Sensor:
|
||||
|
||||
- **username** (*Required*): The username to access the MyUSPS service.
|
||||
- **password** (*Required*): The password for the given username.
|
||||
- **name** (*Optional*): Prefix for sensor names (defaults to "USPS")
|
||||
|
||||
<p class='note warning'>
|
||||
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.
|
||||
</p>
|
||||
To enable this sensor in your installation, set up the [USPS component](/components/usps) with your username and password.
|
||||
|
|
|
|||
67
source/_components/sensor.version.markdown
Normal file
67
source/_components/sensor.version.markdown
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Version Sensor"
|
||||
description: "Instructions how to integrate a version sensor into Home Assistant."
|
||||
date: 2017-08-10 10:30
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Pushing"
|
||||
logo: home-assistant.png
|
||||
ha_release: 0.52
|
||||
---
|
||||
|
||||
|
||||
The `version` sensor platform is displaying the current version of Home Assistant in the frontend.
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: version
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Name of the sensor. Defaults to `Current Version`.
|
||||
|
||||
## {% linkable_title Alternatives %}
|
||||
|
||||
This sensor is an alternative to the existing solutions to achieve the same result through various platforms. Remember that you can easily get the installed version on the command line.
|
||||
|
||||
```bash
|
||||
$ hass --version
|
||||
```
|
||||
|
||||
Or go to the <img src='/images/screenshots/developer-tool-about-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Info** section of the **Developer Tools**.
|
||||
|
||||
A [`command_line`](/components/sensor.command_line/) with [`hass`](/docs/tools/hass/) to display your current version.
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: command_line
|
||||
name: Version
|
||||
command: "/home/homeassistant/bin/hass --version"
|
||||
```
|
||||
|
||||
It's also possible to ready a file called `.HA_VERSION` which is located in your Home Assistant [configuration](/docs/configuration/) folder.
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: command_line
|
||||
name: Version
|
||||
command: "cat /home/homeassistant/.homeassistant/.HA_VERSION"
|
||||
```
|
||||
|
||||
You might think that a [`rest` sensor](/components/sensor.rest/) could work to but it will not as Home Assistant is not ready when the sensor get initialized.
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: rest
|
||||
resource: http://IP_ADDRESS:8123/api/config
|
||||
name: Current Version
|
||||
value_template: '{{ value_json.version }}'
|
||||
```
|
||||
32
source/_components/sensor.worldtidesinfo.markdown
Normal file
32
source/_components/sensor.worldtidesinfo.markdown
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
layout: page
|
||||
title: "World Tides"
|
||||
description: "Instructions how to add Tides information to Home Assistant."
|
||||
date: 2017-08-23 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: worldtidesinfo.png
|
||||
ha_category: Weather
|
||||
ha_release: 0.52
|
||||
---
|
||||
|
||||
The `worldtidesinfo` sensor platform uses details from [World Tides](https://www.worldtides.info/) to provide information about the prediction for the tides for any location in the world.
|
||||
|
||||
To use this sensor, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: worldtidesinfo
|
||||
api_key: YOUR_API_KEY
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your API key for https://www.worldtides.info/.
|
||||
- **name** (*Optional*): Name to use in the frontend.
|
||||
- **latitude** (*Optional*): Latitude of the location to display the tides. Defaults to the latitude in your `configuration.yaml` file.
|
||||
- **longitude** (*Optional*): Longitude of the location to display the tides. Defaults to the longitude in your `configuration.yaml` file.
|
||||
|
||||
|
|
@ -35,9 +35,11 @@ Configuration variables:
|
|||
- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'.
|
||||
- **state_topic** (*Optional*): The MQTT topic subscribed to receive state updates.
|
||||
- **command_topic** (*Required*): The MQTT topic to publish commands to change the switch state.
|
||||
- **availability_topic** (*Optional*): The MQTT topic subscribed to receive availability (online/offline) updates. The payload is the same for the command_topic.
|
||||
- **availability_topic** (*Optional*): The MQTT topic subscribed to receive availability (online/offline) updates.
|
||||
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
|
||||
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
|
||||
- **payload_available** (*Optional*): The payload that represents the available state, e.g. 'online'. Default is "ON".
|
||||
- **payload_not_available** (*Optional*): The payload that represents the unavailable state, e.g. 'offline'. Default is "OFF".
|
||||
- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is `true` if no `state_topic` defined, else `false`.
|
||||
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
|
||||
- **retain** (*Optional*): If the published message should have the retain flag on or not.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
layout: page
|
||||
title: "RainMachine Switch"
|
||||
description: "Instructions on how to use RainMachine units with Home Assistant."
|
||||
date: 2017-08-04 12:00
|
||||
date: 2017-08-14 13:30
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
|
|
@ -23,7 +23,7 @@ The platform allows for either local (i.e., directly across the LAN) or remote
|
|||
dictate what your configuration should look like.
|
||||
|
||||
For local access, specify the IP address/hostname of your RainMachine unit
|
||||
and your RainMachine password:
|
||||
, your RainMachine password, and optionally, the device's HTTP port:
|
||||
|
||||
```yaml
|
||||
switch:
|
||||
|
|
@ -43,11 +43,16 @@ switch:
|
|||
|
||||
Configuration Variables:
|
||||
|
||||
- **ip_address** (*Optional*): The IP address of your RainMachine unit
|
||||
- **email** (*Optional*): Your RainMachine username/email
|
||||
- **password** (*Required*): Your RainMachine password
|
||||
- **zone_run_time** (*Optional*): The number of seconds that a zone should run when
|
||||
turned on; defaults to 600 (10 minutes)
|
||||
- **ip_address** (*Optional*): the IP address of your RainMachine unit; cannot be
|
||||
used with the `email` parameter
|
||||
- **email** (*Optional*): your RainMachine username/email; cannot be used with the
|
||||
`ip_address` parameter
|
||||
- **password** (*Required*): your RainMachine password
|
||||
- **port** (*Optional*): the TCP port used by your unit for the REST API (default: 8080)
|
||||
- **ssl** (*Optional*): whether communication with the local device should occur
|
||||
over HTTPS (default: true)
|
||||
- **zone_run_time** (*Optional*): the number of seconds that a zone should run when
|
||||
turned on (default: 600)
|
||||
|
||||
## {% linkable_title Controlling Your Device %}
|
||||
|
||||
|
|
|
|||
38
source/_components/usps.markdown
Normal file
38
source/_components/usps.markdown
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
layout: page
|
||||
title: USPS
|
||||
description: "Interface USPS mail and package information to Home Assistant."
|
||||
date: 2017-07-28 20:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: usps.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.52
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `usps` platform allows one to track deliveries and inbound mail from the [US Postal Service (USPS)](https://www.usps.com/).
|
||||
In addition to having a USPS account, you will need to complete the "Opt-In" process by clicking "Get Started Now" on [this page](https://my.usps.com/mobileWeb/pages/intro/start.action). You must also "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see inbound mail.
|
||||
|
||||
To enable this component, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
usps:
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
You will see two new sensors, one for packages and one for mail and a camera to rotate through images of incoming mail for the current day.
|
||||
|
||||
Configuration options for the USPS component:
|
||||
|
||||
- **username** (*Required*): The username to access the MyUSPS service.
|
||||
- **password** (*Required*): The password for the given username.
|
||||
- **name** (*Optional*): Prefix for sensor names (defaults to "USPS")
|
||||
|
||||
<p class='note warning'>
|
||||
The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API.
|
||||
</p>
|
||||
|
|
@ -20,6 +20,12 @@ Current supported features are `turn_on`, `pause`, `stop`, `return_to_home`, `tu
|
|||
|
||||
Follow the pairing process using your phone and Mi-Home app. From here you will be able to retrieve the token from a SQLite file inside your phone.
|
||||
|
||||
Before you begin you need to install `libffi-dev` by running the command below. This is needed for `python-mirobi` to be installed correctly.
|
||||
|
||||
```bash
|
||||
apt-get install libffi-dev
|
||||
```
|
||||
|
||||
<p class='note warning'>
|
||||
If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below.</p>
|
||||
|
||||
|
|
@ -61,8 +67,8 @@ java.exe -jar ../android-backup-extractor/abe.jar unpack backup.ab backup.tar ""
|
|||
1. Setup iOS device with the Mi-Home app.
|
||||
2. Create an unencrypted backup of the device using iTunes.
|
||||
3. Install iBackup Viewer from here: http://www.imactools.com/iphonebackupviewer/
|
||||
4. Extract this file /raw data/com.xiami.mihome/_mihome.sqlite to your computer
|
||||
5. Open the file extracted using notepad. You will then see the list of all the device in your account with their token.
|
||||
4. Extract this file: **`/raw data/com.xiami.mihome/1234567_mihome.sqlite`** to your computer, where _1234567_ is any string of numbers.
|
||||
5. Open the sqlite DB with a tool like SQLite Manager extension for FireFox, DB Browser, etc. You will then see the list of all the devices in your account with their token. The token you need is in the column **`ZToken`** and looks like **`123a1234567b12345c1d123456789e12`**.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue