mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 16:27:19 +00:00
Merge branch 'current' into next
This commit is contained in:
Fabian Affolter
commit
bf918f5c03
@ -139,8 +139,8 @@ social:
|
||||
# Home Assistant release details
|
||||
current_major_version: 0
|
||||
current_minor_version: 88
|
||||
current_patch_version: 0
|
||||
date_released: 2019-02-20
|
||||
current_patch_version: 1
|
||||
date_released: 2019-02-22
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Rachio Binary Sensor"
|
||||
description: "Instructions on how to use Rachio binary sensors with Home Assistant."
|
||||
date: 2018-06-23 16:15
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rachio.png
|
||||
ha_category: Irrigation
|
||||
ha_iot_class: "Cloud Push"
|
||||
ha_release: 0.73
|
||||
---
|
||||
|
||||
The `rachio` binary sensor platform allows you to view the status of your [Rachio irrigation system](http://rachio.com/).
|
||||
|
||||
Once configured, a binary sensor will be added that shows whether or not each controller in the account provided is online and reachable by Rachio's servers.
|
||||
|
||||
They will be automatically added if the [Rachio component](/components/rachio/) component is loaded.
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "RainMachine Binary Sensor"
|
||||
description: "Instructions on how to use RainMachine binary sensors with Home Assistant."
|
||||
date: 2018-05-06 21:26
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rainmachine.png
|
||||
ha_category: Irrigation
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.71
|
||||
---
|
||||
|
||||
The `rainmachine` binary sensor platform allows you to view crucial sensor data
|
||||
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [RainMachine component](/components/rainmachine/)
|
||||
configured to use this platform. After configuring that component, binary
|
||||
sensors automatically appear.
|
||||
</p>
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Sense binary sensors"
|
||||
description: "Instructions on how to integrate Sense binary sensors into Home Assistant."
|
||||
date: 2018-11-14 23:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: sense.png
|
||||
ha_category: Energy
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.82
|
||||
---
|
||||
|
||||
The `Sense` platform allows you to get data from your [Sense](http://Sense.com/).
|
||||
|
||||
They will be automatically discovered if the `sense` component is loaded.
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Vultr Binary Sensor"
|
||||
description: "Instructions on how to set up Vultr binary sensors within Home Assistant."
|
||||
date: 2017-10-17 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: System Monitor
|
||||
logo: vultr.png
|
||||
ha_release: "0.58"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `vultr` binary sensor platform allows you to monitor your [Vultr](https://www.vultr.com/) subscription to see if it is powered on or not.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use this binary sensor, you first have to set up your [Vultr hub](/components/vultr/).
|
||||
|
||||
<p class='note'>
|
||||
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
|
||||
</p>
|
||||
|
||||
Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`):
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: vultr
|
||||
subscription: 123456
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
subscription:
|
||||
description: The subscription you want to monitor, this can be found in the URL when viewing a server.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name you want to give this binary sensor.
|
||||
required: false
|
||||
default: "Vultr {subscription label}"
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Full example %}
|
||||
|
||||
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
|
||||
|
||||
```yaml
|
||||
binary_sensor:
|
||||
- platform: vultr
|
||||
name: totally_awesome_server
|
||||
subscription: 12345
|
||||
```
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Melissa Climate"
|
||||
description: "Instructions on how to integrate Melissa climate system (HVAC) into Home Assistant."
|
||||
date: 2018-01-08 20:21
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: mclimate.png
|
||||
ha_category: Climate
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.63
|
||||
---
|
||||
|
||||
The `melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant.
|
||||
|
||||
The climate platform will be automatically configured if Melissa component is configured.
|
||||
|
||||
For more configuration information see the [Melissa component](/components/melissa/) documentation.
|
||||
@ -1,164 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Ubiquiti Unifi WAP"
|
||||
description: "Instructions on how to use a Unifi WAP controller as a device tracker module."
|
||||
date: 2016-02-19 20:59
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ubiquiti.png
|
||||
ha_category: Presence Detection
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.14
|
||||
---
|
||||
|
||||
This platform allows you to detect presence by looking at devices connected to a [Ubiquiti](http://ubnt.com/) [Unifi](https://www.ubnt.com/enterprise/#unifi) controller.
|
||||
|
||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: unifi
|
||||
host: unifi
|
||||
username: username
|
||||
password: password
|
||||
ssid_filter:
|
||||
- 'HomeSSID'
|
||||
- 'IoTSSID'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: A user on the controller
|
||||
type: string
|
||||
required: true
|
||||
password:
|
||||
description: The password for the account
|
||||
type: string
|
||||
required: true
|
||||
host:
|
||||
description: The hostname or IP address of your controller
|
||||
default: localhost
|
||||
type: string
|
||||
required: false
|
||||
port:
|
||||
description: The port of your controller's web interface
|
||||
default: 8443
|
||||
type: integer
|
||||
required: false
|
||||
site_id:
|
||||
description: For multisite installations, you can specify `site_id` to specify which is used
|
||||
type: string
|
||||
required: false
|
||||
default: default
|
||||
verify_ssl:
|
||||
description: Whether to do strict validation on SSL certificates of the Unifi controller. This can be true/false or the path to a locally trusted certificate to use for verification (i.e. "/path/to/custom_cert.pm")
|
||||
type: boolean or filename
|
||||
required: false
|
||||
default: true
|
||||
detection_time:
|
||||
description: How long since the last seen time before the device is marked away, specified in seconds.
|
||||
type: integer
|
||||
required: false
|
||||
default: 300
|
||||
ssid_filter:
|
||||
description: Filter the SSIDs that tracking will occur on.
|
||||
type: list of strings
|
||||
required: false
|
||||
default: None
|
||||
monitored_conditions:
|
||||
description: A list of extra attributes to pull from the Unifi controller.
|
||||
type: list
|
||||
required: false
|
||||
default: None
|
||||
|
||||
{% endconfiguration %}
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|
||||
|
||||
### {% linkable_title Configuring Users %}
|
||||
|
||||
The Unifi controller allows you to create multiple users on it besides the main administrator. It is recommended that you create a limited user that has `read-only` permissions for the Unifi device tracker.
|
||||
|
||||
### {% linkable_title Conflicts with MQTT %}
|
||||
|
||||
The Unifi controller can either be a dedicated hardware device (Unifi's cloud key), or as software any Linux system. If you run the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT component as well.
|
||||
|
||||
It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation.
|
||||
|
||||
### {% linkable_title Correctly specifying the Site ID %}
|
||||
|
||||
For environments where there are multiple sites setup on the controller, or the default site is not being used you can use the `site_id` parameter to specify which site you would like to target.
|
||||
|
||||
Please note that the value that is to be specificed here is not the name of the site as you would see it in controller interface, but a site ID value assigned from the software itself.
|
||||
|
||||
To obtain this value for your configuration file, you can take it from the URL of your browser when on the controller webpage.
|
||||
|
||||
For example, this is what would be seen in the URL bar when inside the dashboard page of a site:
|
||||
|
||||
* https://127.0.0.1:8443/manage/s/ceb1m27d/dashboard
|
||||
|
||||
And your `site_id` value would be ceb1m27d.
|
||||
|
||||
|
||||
### {% linkable_title Troubleshooting and Time Synchronization %}
|
||||
|
||||
Presence detection depends on accurate time configuration between Home Assistant and the Unifi controller.
|
||||
|
||||
If Home Assistant and the Unifi controller are running on separate machines or VMs ensure that all clocks are synchronized. Failing to have synchronized clocks will lead to Home Assistant failing to mark a device as home.
|
||||
|
||||
[Related Issue](https://github.com/home-assistant/home-assistant/issues/10507)
|
||||
|
||||
### {% linkable_title Monitored Conditions %}
|
||||
|
||||
The Unifi controller returns a number of additional attributes that can be used for tracking devices, including signal strength, rx/tx rates, and which AP it is connected to. The list of possible options may vary depending on your Unifi controller version and if a device is wired or wireless.
|
||||
|
||||
Unifi Controller version 5.6.29 has the following options:
|
||||
- _id
|
||||
- _is_guest_by_uap
|
||||
- _last_seen_by_uap
|
||||
- _uptime_by_uap
|
||||
- ap_mac
|
||||
- assoc_time
|
||||
- authorized
|
||||
- bssid
|
||||
- bytes-r
|
||||
- ccq
|
||||
- channel
|
||||
- essid
|
||||
- first_seen
|
||||
- hostname
|
||||
- idletime
|
||||
- ip
|
||||
- is_11r
|
||||
- is_guest
|
||||
- is_wired
|
||||
- last_seen
|
||||
- latest_assoc_time
|
||||
- mac
|
||||
- name
|
||||
- noise
|
||||
- noted
|
||||
- oui
|
||||
- powersave_enabled
|
||||
- qos_policy_applied
|
||||
- radio
|
||||
- radio_proto
|
||||
- rssi
|
||||
- rx_bytes
|
||||
- rx_bytes-r
|
||||
- rx_packets
|
||||
- rx_rate
|
||||
- signal
|
||||
- site_id
|
||||
- tx_bytes
|
||||
- tx_bytes-r
|
||||
- tx_packets
|
||||
- tx_power
|
||||
- tx_rate
|
||||
- uptime
|
||||
- user_id
|
||||
- usergroup_id
|
||||
- vlan
|
||||
@ -71,7 +71,7 @@ Device type | Description
|
||||
|
||||
## {% linkable_title Notes %}
|
||||
|
||||
Devices will appear in the format `devicetracker.<home hub ip>_<device mac address>`. Note that dots are removed from the IP and BT MAC addresses.
|
||||
Devices will appear in the format `device_tracker.<home hub ip>_<device mac address>`. Note that dots are removed from the IP and BT MAC addresses.
|
||||
|
||||
[googlehomeapi]: https://rithvikvibhu.github.io/GHLocalApi/
|
||||
[devicetrackerconfig]: /components/device_tracker/#configuring-a-device_tracker-platform
|
||||
|
||||
@ -11,6 +11,8 @@ logo: logitech.png
|
||||
ha_category: Remote
|
||||
ha_iot_class: "Local Push"
|
||||
ha_release: "0.34"
|
||||
redirect_from:
|
||||
- /components/remote.harmony/
|
||||
---
|
||||
|
||||
The `harmony` remote platform allows you to control the state of your [Harmony Hub Device](http://www.logitech.com/en-us/product/harmony-hub).
|
||||
|
||||
@ -8,12 +8,15 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: lutron.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Light
|
||||
featured: false
|
||||
ha_release: 0.85
|
||||
ha_iot_class: "Local Push"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.homeworks/
|
||||
- /components/light.homeworks/
|
||||
---
|
||||
|
||||
[Lutron](http://www.lutron.com/) is an American lighting control company. The Lutron Homeworks Series 4 & 8 systems are relatively old (~2003), and use RS-232 connections to communicate with home automation systems. The `homeworks` component in Home Assistant is responsible for communicating with the main controller for these systems. Communication is through an ethernet to serial converter (NPort, for example).
|
||||
|
||||
@ -8,16 +8,18 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: iota.png
|
||||
ha_category: Finance
|
||||
ha_category:
|
||||
- Finance
|
||||
- Sensor
|
||||
ha_release: 0.62
|
||||
ha_iot_class: "Cloud Polling"
|
||||
redirect_from:
|
||||
- /components/sensor.iota/
|
||||
---
|
||||
|
||||
[IOTA](http://iota.org/) is a new blockless distributed ledger which is
|
||||
scalable, lightweight and makes it possible to transfer value without any fees.
|
||||
[IOTA](http://iota.org/) is a new blockless distributed ledger which is scalable, lightweight and makes it possible to transfer value without any fees.
|
||||
|
||||
The `iota` component displays various details
|
||||
(e.g., the balance, node attributes) of IOTA wallets.
|
||||
The `iota` component displays various details (e.g., the balance, node attributes) of IOTA wallets.
|
||||
|
||||
```yaml
|
||||
# configuration.yaml example
|
||||
@ -62,3 +64,12 @@ iota:
|
||||
- name: Exchange Wallet
|
||||
seed: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||||
```
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
The sensors are automatically created if the IOTA component is present.
|
||||
|
||||
Available sensors:
|
||||
|
||||
- Wallet balance
|
||||
- Node information
|
||||
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Homeworks Light"
|
||||
description: "How to use Lutron Homeworks Series 4 & 8 lights."
|
||||
date: 2018-10-05 23:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: lutron.png
|
||||
ha_category: Light
|
||||
featured: false
|
||||
ha_release: 0.85
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
`homeworks` lights let you monitor and control Lutron Homeworks Series 4 & 8 dimmers.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [homeworks component](/components/homeworks/) configured to use this light.
|
||||
</p>
|
||||
@ -18,6 +18,7 @@ The `denonavr` platform allows you to control a [Denon Network Receivers](http:/
|
||||
Supported devices:
|
||||
|
||||
- Denon AVR-X1300W
|
||||
- Denon AVR-X1500H
|
||||
- Denon AVR-X2000
|
||||
- Denon AVR-X2100W
|
||||
- Denon AVR-X4100W
|
||||
|
||||
@ -89,12 +89,12 @@ Currently known supported models:
|
||||
- KU7000 (port must be set to 8001)
|
||||
- M5620 (port must be set to 8001, and `pip3 install websocket-client` must be executed)
|
||||
- MU6170UXZG (port must be set to 8001, and `pip3 install websocket-client` must be executed)
|
||||
- NU7090 (port must be set to 8801, On/Off, MAC must be specified for Power On)
|
||||
- NU7400 (port set to 8001 and `pip3 install websocket-client` executed)
|
||||
- NU8000
|
||||
- Q7F (port must be set to 8001, MAC must be specified for Power On)
|
||||
- U6000 (port must be set to 8001)
|
||||
- U6300 (port must be set to 8001, and `pip3 install websocket-client` must be executed)
|
||||
- D7000
|
||||
- UE6199UXZG (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button)
|
||||
- UE65KS8005 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button)
|
||||
- UE49KU6470 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button)
|
||||
|
||||
@ -8,14 +8,24 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: mclimate.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Climate
|
||||
featured: false
|
||||
ha_release: 0.63
|
||||
ha_iot_class: "Cloud Polling"
|
||||
redirect_from:
|
||||
- /components/climate.melissa/
|
||||
---
|
||||
|
||||
The `melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Climate
|
||||
|
||||
The climate platform will be automatically configured if Melissa component is configured.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To set the Melissa component up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
@ -13,9 +13,17 @@ ha_qa_scale: internal
|
||||
ha_release: 0.88
|
||||
---
|
||||
|
||||
The person component allows to connect device tracker entities to one or more person entities. The last state update of a connected device tracker will set the state of the person. Eg if you connect your router and your owntracks device as trackers to your person, the last state update from either the router or your owntracks device will set the state of your person.
|
||||
The person component allows to connect device tracker entities to one or more person entities. The last state update of a connected device tracker will set the state of the person. For example if you connect your router and your OwnTracks device as trackers to your person, the last state update from either the router or your OwnTracks device will set the state of your person.
|
||||
|
||||
You can manage persons via the UI from the person page inside the configuration panel.
|
||||
You can manage persons via the UI from the person page inside the configuration panel or via `YAML`.
|
||||
|
||||
## {% linkable_title Configuring the `person` component via the Home Assistant configuration panel %}
|
||||
|
||||
If you prefer to use the configuration panel to configure the `person` component simply add one line to your `configuration.yaml` file and restart Home Assistant.
|
||||
|
||||
```yaml
|
||||
person:
|
||||
```
|
||||
|
||||
## {% linkable_title Configuring the `person` component via YAML %}
|
||||
|
||||
|
||||
@ -8,19 +8,32 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rachio.png
|
||||
ha_category: Irrigation
|
||||
ha_category:
|
||||
- Irrigation
|
||||
- Binary Sensor
|
||||
- Switch
|
||||
ha_iot_class: "Cloud Push"
|
||||
ha_release: 0.73
|
||||
redirect_from:
|
||||
- /components/binary_sensor.rachio/
|
||||
- /components/switch.rachio/
|
||||
---
|
||||
|
||||
The `rachio` platform allows you to control your [Rachio irrigation system](http://rachio.com/).
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- **Binary Sensor** - Allows you to view the status of your [Rachio irrigation system](http://rachio.com/).
|
||||
- [**Switch**](#switch)
|
||||
|
||||
They will be automatically added if the Rachio component component is loaded.
|
||||
|
||||
## {% linkable_title Getting your Rachio API Key %}
|
||||
|
||||
1. Log in at [https://app.rach.io/](https://app.rach.io/).
|
||||
1. Click the "Account Settings" menu item at the bottom of the left sidebar
|
||||
1. Click "Get API Key"
|
||||
1. Copy the API key from the dialog that opens.
|
||||
2. Click the "Account Settings" menu item at the bottom of the left sidebar
|
||||
3. Click "Get API Key"
|
||||
4. Copy the API key from the dialog that opens.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -53,8 +66,6 @@ manual_run_mins:
|
||||
Set `manual_run_mins` to a high maximum failsafe value when using scripts to control zones. If something goes wrong with your script, Home Assistant, or you hit the Rachio API rate limit of 1700 calls per day, the controller will still turn off the zone after this amount of time.
|
||||
</p>
|
||||
|
||||
Once configured, [Rachio Binary Sensor](/components/binary_sensor.rachio/) and [Rachio Switch](/components/switch.rachio/) platforms will be automatically loaded.
|
||||
|
||||
### {% linkable_title iFrame %}
|
||||
|
||||
If you would like to see and control more detailed zone information, create an [iFrame](/components/panel_iframe/) that renders the Rachio web app.
|
||||
@ -66,3 +77,40 @@ panel_iframe:
|
||||
url: "https://app.rach.io"
|
||||
icon: mdi:water-pump
|
||||
```
|
||||
|
||||
## {% linkable_title Switch %}
|
||||
|
||||
The `rachio` switch platform allows you to toggle zones connected to your [Rachio irrigation system](http://rachio.com/) on and off.
|
||||
|
||||
Once configured, a switch will be added for every zone that is enabled on every controller in the account provided, as well as a switch to toggle each controller's standby mode.
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
In this section, you find some real-life examples of how to use this switch.
|
||||
|
||||
### {% linkable_title `groups.yaml` example %}
|
||||
|
||||
```yaml
|
||||
irrigation:
|
||||
name: Irrigation
|
||||
icon: mdi:water-pump
|
||||
view: true
|
||||
entities:
|
||||
- group.zones_front
|
||||
- group.zones_back
|
||||
- switch.side_yard
|
||||
|
||||
zones_front:
|
||||
name: Front Yard
|
||||
view: false
|
||||
entities:
|
||||
- switch.front_bushes
|
||||
- switch.front_yard
|
||||
|
||||
zones_back:
|
||||
name: Back Yard
|
||||
view: false
|
||||
entities:
|
||||
- switch.back_garden
|
||||
- switch.back_porch
|
||||
```
|
||||
@ -8,18 +8,30 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rainmachine.png
|
||||
ha_category: Irrigation
|
||||
ha_category:
|
||||
- Irrigation
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: 0.69
|
||||
ha_iot_class: "Local Polling"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.rainmachine/
|
||||
- /components/sensor.rainmachine/
|
||||
- /components/switch.rainmachine/
|
||||
---
|
||||
|
||||
The `rainmachine` component is the main component to integrate all platforms
|
||||
related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/).
|
||||
The `rainmachine` component is the main component to integrate all platforms related to [RainMachine smart Wi-Fi sprinkler controllers](http://www.rainmachine.com/).
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
- [Switch](#switch)
|
||||
|
||||
## {% linkable_title Base Configuration %}
|
||||
|
||||
To connect to your RainMachine device, add the following to your
|
||||
`configuration.yaml` file:
|
||||
To connect to your RainMachine device, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
rainmachine:
|
||||
@ -28,9 +40,7 @@ rainmachine:
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
To configure additional functionality, add configuration options beneath
|
||||
a `binary_sensor`, `sensor`, and/or `switches` key within the `rainmachine`
|
||||
sections of `configuration.yaml` as below:
|
||||
To configure additional functionality, add configuration options beneath a `binary_sensor`, `sensor`, and/or `switches` key within the `rainmachine` sections of `configuration.yaml` as below:
|
||||
|
||||
```yaml
|
||||
rainmachine:
|
||||
@ -140,3 +150,15 @@ Stop a RainMachine zone.
|
||||
|---------------------------|----------|----------------------|
|
||||
| `zone_id` | no | The zone to stop |
|
||||
|
||||
## {% linkable_title Switch %}
|
||||
|
||||
The `rainmachine` switch platform allows you to control programs and zones within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
|
||||
|
||||
### {% linkable_title Controlling Your Device %}
|
||||
|
||||
After Home Assistant loads, new switches will be added for every enabled program and zone. These work as expected:
|
||||
|
||||
- Program On/Off: starts/stops a program
|
||||
- Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to determine how long to run for)
|
||||
|
||||
Programs and zones are linked. While a program is running, you will see both the program and zone switches turned on; turning either one off will turn the other one off (just like in the web app).
|
||||
@ -150,7 +150,7 @@ Purging does not necessarily remove all entries before a given date. For example
|
||||
| MS SQL Server | `mssql+pymssql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
|
||||
|
||||
<p class='note'>
|
||||
If you use MariaDB 10 you need to add port 3307 (or another port depending on which port is used by, for example: your hosting provider.) to the SERVER_IP, e.g., `mysql://user:password@SERVER_IP:3307/DB_NAME?charset=utf8`.
|
||||
Some installations of MariaDB/MySQL may require an ALTERNATE_PORT (3rd-party hosting providers or parallel installations) to be added to the SERVER_IP, e.g., `mysql://user:password@SERVER_IP:ALTERNATE_PORT/DB_NAME?charset=utf8`.
|
||||
</p>
|
||||
|
||||
<p class='note'>
|
||||
|
||||
@ -8,13 +8,23 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: sense.png
|
||||
ha_category: Energy
|
||||
ha_category:
|
||||
- Energy
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.82
|
||||
redirect_from: /components/sensor.sense/
|
||||
redirect_from:
|
||||
- /components/sensor.sense/
|
||||
- /components/binary_sensor.sense/
|
||||
---
|
||||
|
||||
Integrate your [Sense](https://sense.com) meter information into Home Assistant.
|
||||
Integrate your [Sense](https://sense.com) meter information into Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
@ -39,7 +49,7 @@ password:
|
||||
timeout:
|
||||
description: Seconds for timeout of API requests.
|
||||
required: false
|
||||
type: positive_int
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
Sensors are added for both usage and production with the following names:
|
||||
|
||||
@ -1,22 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "IOTA sensor"
|
||||
description: "Instructions on how to integrate IOTA wallets sensors with Home Assistant."
|
||||
date: 2017-12-31 13:29
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: iota.png
|
||||
ha_category: Finance
|
||||
ha_release: 0.62
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The sensors are automatically created if the [IOTA hub](/components/iota/) is
|
||||
present.
|
||||
|
||||
Available sensors:
|
||||
|
||||
- Wallet balance
|
||||
- Node information
|
||||
@ -44,7 +44,7 @@ name:
|
||||
required: false
|
||||
default: MSW.
|
||||
type: string
|
||||
hour:
|
||||
hours:
|
||||
description: List of hours you would like to receive data for.
|
||||
required: false
|
||||
default: Defaults to current forecast.
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "RainMachine Sensor"
|
||||
description: "Instructions on how to use RainMachine sensors with Home Assistant."
|
||||
date: 2018-05-06 21:26
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rainmachine.png
|
||||
ha_category: Irrigation
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.71
|
||||
---
|
||||
|
||||
The `rainmachine` sensor platform allows you to view crucial sensor data within
|
||||
a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [RainMachine component](/components/rainmachine/)
|
||||
configured to use this platform. After configuring that component, sensors
|
||||
automatically appear.
|
||||
</p>
|
||||
@ -29,7 +29,7 @@ sensor:
|
||||
The `stop_id` can be obtained by looking up the name of the stop at this link:
|
||||
|
||||
<http://xmlopen.rejseplanen.dk/bin/rest.exe/location?format=json&input=STOP_NAME>
|
||||
|
||||
(Replace "STOP_NAME" with city or location you want id for)
|
||||
find the stop and copy the `id` field with the trailing zeros.
|
||||
|
||||
The sensor can filter the timetables by one or more routes, directions and types. The known types are listed in the table below.
|
||||
|
||||
@ -1,74 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Vultr Sensor"
|
||||
description: "Instructions on how to integrate Vultr sensor within Home Assistant."
|
||||
date: 2017-10-17 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: vultr.png
|
||||
ha_release: "0.58"
|
||||
ha_category: System Monitor
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `vultr` sensor platform will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription.
|
||||
|
||||
To use this sensor, you must set up your [Vultr hub](/components/vultr/).
|
||||
|
||||
<p class='note'>
|
||||
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
|
||||
</p>
|
||||
|
||||
Minimal `configuration.yaml` (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`):
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
subscription: 123456
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
subscription:
|
||||
description: The Vultr subscription to monitor, this can be found in the URL when viewing a subscription.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name to give this sensor.
|
||||
required: false
|
||||
default: "Vultr {Vultr subscription label} {monitored condition name}"
|
||||
type: string
|
||||
monitored_conditions:
|
||||
description: List of items you want to monitor for each subscription.
|
||||
required: false
|
||||
detault: All conditions
|
||||
type: list
|
||||
keys:
|
||||
current_bandwidth_used:
|
||||
description: The current (invoice period) bandwidth usage in Gigabytes (GB).
|
||||
temperature:
|
||||
pending_charges: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$).
|
||||
{% endconfiguration %}
|
||||
|
||||
Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`):
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
name: Server {}
|
||||
subscription: 123456
|
||||
monitored_conditions:
|
||||
- current_bandwidth_used
|
||||
- pending_charges
|
||||
```
|
||||
|
||||
Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`):
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
name: Web Server Bandwidth
|
||||
subscription: 123456
|
||||
monitored_conditions:
|
||||
- current_bandwidth_used
|
||||
```
|
||||
@ -1,51 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Rachio Switch"
|
||||
description: "Instructions on how to use Rachio switches with Home Assistant."
|
||||
date: 2018-06-23 16:09
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rachio.png
|
||||
ha_category: Irrigation
|
||||
ha_iot_class: "Cloud Push"
|
||||
ha_release: 0.46
|
||||
---
|
||||
|
||||
The `rachio` switch platform allows you to toggle zones connected to your [Rachio irrigation system](http://rachio.com/) on and off.
|
||||
|
||||
Once configured, a switch will be added for every zone that is enabled on every controller in the account provided, as well as a switch to toggle each controller's standby mode.
|
||||
|
||||
They will be automatically added if the [Rachio component](/components/rachio/) is loaded.
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
In this section, you find some real-life examples of how to use this switch.
|
||||
|
||||
### {% linkable_title `groups.yaml` example %}
|
||||
|
||||
```yaml
|
||||
irrigation:
|
||||
name: Irrigation
|
||||
icon: mdi:water-pump
|
||||
view: true
|
||||
entities:
|
||||
- group.zones_front
|
||||
- group.zones_back
|
||||
- switch.side_yard
|
||||
|
||||
zones_front:
|
||||
name: Front Yard
|
||||
view: false
|
||||
entities:
|
||||
- switch.front_bushes
|
||||
- switch.front_yard
|
||||
|
||||
zones_back:
|
||||
name: Back Yard
|
||||
view: false
|
||||
entities:
|
||||
- switch.back_garden
|
||||
- switch.back_porch
|
||||
```
|
||||
@ -1,35 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "RainMachine Switch"
|
||||
description: "Instructions on how to use RainMachine switches with Home Assistant."
|
||||
date: 2017-08-14 13:30
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: rainmachine.png
|
||||
ha_category: Irrigation
|
||||
ha_iot_class: "Cloud Polling"
|
||||
ha_release: 0.51
|
||||
---
|
||||
|
||||
The `rainmachine` switch platform allows you to control programs and zones
|
||||
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [RainMachine component](/components/rainmachine/)
|
||||
configured to use this platform. After configuring that component, switches will
|
||||
automatically appear.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Controlling Your Device %}
|
||||
|
||||
After Home Assistant loads, new switches will be added for every enabled
|
||||
program and zone. These work as expected:
|
||||
|
||||
- Program On/Off: starts/stops a program
|
||||
- Zone On/Off: starts/stops a zone (using the `zone_run_time` parameter to determine how long to run for)
|
||||
|
||||
Programs and zones are linked. While a program is running, you will see both
|
||||
the program and zone switches turned on; turning either one off will turn the
|
||||
other one off (just like in the web app).
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "UniFi Switches"
|
||||
description: "Instructions on how to integrate POE control switches from UniFi into Home Assistant."
|
||||
date: 2018-10-15 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ubiquiti.png
|
||||
ha_category: Switch
|
||||
ha_release: "0.81"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
See the [UniFi main component](/components/unifi/) for configuration instructions.
|
||||
|
||||
Switches are network devices that are powered by POE switches from Ubuiqitis UniFi line of networking gear.
|
||||
|
||||
Note that POE control actually configures the network port of the switch which the device is connected to.
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Vultr Switch"
|
||||
description: "Instructions on how to set up Vultr switches within Home Assistant."
|
||||
date: 2017-10-17 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: vultr.png
|
||||
ha_category: System Monitor
|
||||
ha_release: "0.58"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `vultr` switch platform allows you to control (start/stop) your
|
||||
[Vultr](https://www.vultr.com/) subscription.
|
||||
|
||||
To control your Vultr subscription, you first have to set up
|
||||
your [Vultr hub](/components/vultr/).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Minimal `configuration.yaml` (produces `switch.vultr_web_server`):
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: vultr
|
||||
subscription: YOUR_SUBSCRIPTION_ID
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
subscription:
|
||||
description: List of droplets you want to control.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name you want to give this switch.
|
||||
required: false
|
||||
default: "Vultr {subscription label}"
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Additional Examples %}
|
||||
|
||||
Full example that produces `switch.amazing_server`, assuming a subscription
|
||||
that has an ID of `123456` and a label of `Web Server`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: vultr
|
||||
name: Amazing Server
|
||||
subscription: 123456
|
||||
```
|
||||
@ -8,13 +8,24 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ubiquiti.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Presence Detection
|
||||
- Switch
|
||||
ha_release: "0.81"
|
||||
ha_iot_class: "Local Polling"
|
||||
redirect_from:
|
||||
- /components/device_tracker.unifi/
|
||||
- /components/switch.unifi/
|
||||
---
|
||||
|
||||
[UniFi](https://unifi-sdn.ubnt.com/) by [Ubiquiti Networks, inc.](https://www.ubnt.com/) is a software that binds gateways, switches and wireless access points together with one graphical front end.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Presence Detection](#presence-detection)
|
||||
- [Switch](#switch)
|
||||
|
||||
Currently this implementation only exposes POE control for networked devices. Device tracker implementation is not using the same code base.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
@ -35,3 +46,161 @@ logger:
|
||||
homeassistant.components.unifi: debug
|
||||
homeassistant.components.switch.unifi: debug
|
||||
```
|
||||
|
||||
## {% linkable_title Presence detection %}
|
||||
|
||||
This platform allows you to detect presence by looking at devices connected to a [Ubiquiti](http://ubnt.com/) [Unifi](https://www.ubnt.com/enterprise/#unifi) controller.
|
||||
|
||||
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: unifi
|
||||
host: unifi
|
||||
username: username
|
||||
password: password
|
||||
ssid_filter:
|
||||
- 'HomeSSID'
|
||||
- 'IoTSSID'
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: A user on the controller
|
||||
type: string
|
||||
required: true
|
||||
password:
|
||||
description: The password for the account
|
||||
type: string
|
||||
required: true
|
||||
host:
|
||||
description: The hostname or IP address of your controller
|
||||
default: localhost
|
||||
type: string
|
||||
required: false
|
||||
port:
|
||||
description: The port of your controller's web interface
|
||||
default: 8443
|
||||
type: integer
|
||||
required: false
|
||||
site_id:
|
||||
description: For multisite installations, you can specify `site_id` to specify which is used
|
||||
type: string
|
||||
required: false
|
||||
default: default
|
||||
verify_ssl:
|
||||
description: Whether to do strict validation on SSL certificates of the Unifi controller. This can be true/false or the path to a locally trusted certificate to use for verification (i.e. "/path/to/custom_cert.pm")
|
||||
type: boolean or filename
|
||||
required: false
|
||||
default: true
|
||||
detection_time:
|
||||
description: How long since the last seen time before the device is marked away, specified in seconds.
|
||||
type: integer
|
||||
required: false
|
||||
default: 300
|
||||
ssid_filter:
|
||||
description: Filter the SSIDs that tracking will occur on.
|
||||
type: list of strings
|
||||
required: false
|
||||
default: None
|
||||
monitored_conditions:
|
||||
description: A list of extra attributes to pull from the Unifi controller.
|
||||
type: list
|
||||
required: false
|
||||
default: None
|
||||
|
||||
{% endconfiguration %}
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|
||||
|
||||
### {% linkable_title Configuring Users %}
|
||||
|
||||
The Unifi controller allows you to create multiple users on it besides the main administrator. It is recommended that you create a limited user that has `read-only` permissions for the Unifi device tracker.
|
||||
|
||||
### {% linkable_title Conflicts with MQTT %}
|
||||
|
||||
The Unifi controller can either be a dedicated hardware device (Unifi's cloud key), or as software any Linux system. If you run the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT component as well.
|
||||
|
||||
It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation.
|
||||
|
||||
### {% linkable_title Correctly specifying the Site ID %}
|
||||
|
||||
For environments where there are multiple sites setup on the controller, or the default site is not being used you can use the `site_id` parameter to specify which site you would like to target.
|
||||
|
||||
Please note that the value that is to be specificed here is not the name of the site as you would see it in controller interface, but a site ID value assigned from the software itself.
|
||||
|
||||
To obtain this value for your configuration file, you can take it from the URL of your browser when on the controller webpage.
|
||||
|
||||
For example, this is what would be seen in the URL bar when inside the dashboard page of a site:
|
||||
|
||||
* https://127.0.0.1:8443/manage/s/ceb1m27d/dashboard
|
||||
|
||||
And your `site_id` value would be ceb1m27d.
|
||||
|
||||
|
||||
### {% linkable_title Troubleshooting and Time Synchronization %}
|
||||
|
||||
Presence detection depends on accurate time configuration between Home Assistant and the Unifi controller.
|
||||
|
||||
If Home Assistant and the Unifi controller are running on separate machines or VMs ensure that all clocks are synchronized. Failing to have synchronized clocks will lead to Home Assistant failing to mark a device as home.
|
||||
|
||||
[Related Issue](https://github.com/home-assistant/home-assistant/issues/10507)
|
||||
|
||||
### {% linkable_title Monitored Conditions %}
|
||||
|
||||
The Unifi controller returns a number of additional attributes that can be used for tracking devices, including signal strength, rx/tx rates, and which AP it is connected to. The list of possible options may vary depending on your Unifi controller version and if a device is wired or wireless.
|
||||
|
||||
Unifi Controller version 5.6.29 has the following options:
|
||||
- _id
|
||||
- _is_guest_by_uap
|
||||
- _last_seen_by_uap
|
||||
- _uptime_by_uap
|
||||
- ap_mac
|
||||
- assoc_time
|
||||
- authorized
|
||||
- bssid
|
||||
- bytes-r
|
||||
- ccq
|
||||
- channel
|
||||
- essid
|
||||
- first_seen
|
||||
- hostname
|
||||
- idletime
|
||||
- ip
|
||||
- is_11r
|
||||
- is_guest
|
||||
- is_wired
|
||||
- last_seen
|
||||
- latest_assoc_time
|
||||
- mac
|
||||
- name
|
||||
- noise
|
||||
- noted
|
||||
- oui
|
||||
- powersave_enabled
|
||||
- qos_policy_applied
|
||||
- radio
|
||||
- radio_proto
|
||||
- rssi
|
||||
- rx_bytes
|
||||
- rx_bytes-r
|
||||
- rx_packets
|
||||
- rx_rate
|
||||
- signal
|
||||
- site_id
|
||||
- tx_bytes
|
||||
- tx_bytes-r
|
||||
- tx_packets
|
||||
- tx_power
|
||||
- tx_rate
|
||||
- uptime
|
||||
- user_id
|
||||
- usergroup_id
|
||||
- vlan
|
||||
|
||||
## {% linkable_title Switch %}
|
||||
|
||||
Switches are network devices that are powered by POE switches from Ubuiqitis UniFi line of networking gear.
|
||||
|
||||
Note that POE control actually configures the network port of the switch which the device is connected to.
|
||||
|
||||
@ -8,14 +8,28 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
featured: false
|
||||
ha_category: System Monitor
|
||||
ha_category:
|
||||
- System Monitor
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: "0.58"
|
||||
logo: vultr.png
|
||||
ha_iot_class: "Cloud Polling"
|
||||
redirect_from:
|
||||
- /components/binary_sensor.vultr/
|
||||
- /components/sensor.vultr/
|
||||
- /components/switch.vultr/
|
||||
---
|
||||
|
||||
The `vultr` component allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Sensor](#sensor)
|
||||
- [Switch](#switch)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#settingsapi).
|
||||
@ -38,3 +52,151 @@ api_key:
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Binary sensor %}
|
||||
|
||||
The `vultr` binary sensor platform allows you to monitor your [Vultr](https://www.vultr.com/) subscription to see if it is powered on or not.
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
To use this binary sensor, you first have to set up your Vultr hub.
|
||||
|
||||
<p class='note'>
|
||||
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
|
||||
</p>
|
||||
|
||||
Minimal `configuration.yaml` (produces `binary_sensor.vultr_web_server`):
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
binary_sensor:
|
||||
- platform: vultr
|
||||
subscription: 123456
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
subscription:
|
||||
description: The subscription you want to monitor, this can be found in the URL when viewing a server.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name you want to give this binary sensor.
|
||||
required: false
|
||||
default: "Vultr {subscription label}"
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Full example %}
|
||||
|
||||
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
|
||||
|
||||
```yaml
|
||||
binary_sensor:
|
||||
- platform: vultr
|
||||
name: totally_awesome_server
|
||||
subscription: 12345
|
||||
```
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
The `vultr` sensor platform will allow you to view current bandwidth usage and pending charges against your [Vultr](https://www.vultr.com/) subscription.
|
||||
|
||||
To use this sensor, you must set up your Vultr hub.
|
||||
|
||||
<p class='note'>
|
||||
The following examples assume a subscription that has an ID of `123456` and a label of `Web Server`
|
||||
</p>
|
||||
|
||||
Minimal `configuration.yaml` (produces `sensor.vultr_web_server_current_bandwidth_used` and `sensor.vultr_web_server_pending_charges`):
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
subscription: 123456
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
subscription:
|
||||
description: The Vultr subscription to monitor, this can be found in the URL when viewing a subscription.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name to give this sensor.
|
||||
required: false
|
||||
default: "Vultr {Vultr subscription label} {monitored condition name}"
|
||||
type: string
|
||||
monitored_conditions:
|
||||
description: List of items you want to monitor for each subscription.
|
||||
required: false
|
||||
detault: All conditions
|
||||
type: list
|
||||
keys:
|
||||
current_bandwidth_used:
|
||||
description: The current (invoice period) bandwidth usage in Gigabytes (GB).
|
||||
temperature:
|
||||
pending_charges: The current (invoice period) charges that have built up for this subscription. Value is in US Dollars (US$).
|
||||
{% endconfiguration %}
|
||||
|
||||
Full `configuration.yaml` using `{}` to format condition name (produces `sensor.server_current_bandwidth_used` and `sensor.server_pending_charges`):
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
name: Server {}
|
||||
subscription: 123456
|
||||
monitored_conditions:
|
||||
- current_bandwidth_used
|
||||
- pending_charges
|
||||
```
|
||||
|
||||
Custom `configuration.yaml` with only one condition monitored (produces `sensor.web_server_bandwidth`):
|
||||
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: vultr
|
||||
name: Web Server Bandwidth
|
||||
subscription: 123456
|
||||
monitored_conditions:
|
||||
- current_bandwidth_used
|
||||
```
|
||||
|
||||
## {% linkable_title Switch %}
|
||||
|
||||
The `vultr` switch platform allows you to control (start/stop) your [Vultr](https://www.vultr.com/) subscription.
|
||||
|
||||
To control your Vultr subscription, you first have to set up your Vultr hub.
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
|
||||
Minimal `configuration.yaml` (produces `switch.vultr_web_server`):
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: vultr
|
||||
subscription: YOUR_SUBSCRIPTION_ID
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
subscription:
|
||||
description: List of droplets you want to control.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name you want to give this switch.
|
||||
required: false
|
||||
default: "Vultr {subscription label}"
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Additional Examples %}
|
||||
|
||||
Full example that produces `switch.amazing_server`, assuming a subscription that has an ID of `123456` and a label of `Web Server`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: vultr
|
||||
name: Amazing Server
|
||||
subscription: 123456
|
||||
```
|
||||
@ -110,7 +110,7 @@ name = John Doe
|
||||
|
||||
Leading and trailing whitespace, as well as lines starting with `#` are ignored. The following variables are supported. More may be added in the future.
|
||||
|
||||
* `name`: The real name of the user to be displayed in his profile.
|
||||
* `name`: The real name of the user to be displayed in their profile.
|
||||
|
||||
Stdaerr is not read at all and just passed through to that of the Home Assistant process, hence you can use it for status messages or suchlike.
|
||||
|
||||
|
||||
@ -132,7 +132,8 @@ automation:
|
||||
platform: event
|
||||
event_type: ios.notification_action_fired
|
||||
event_data:
|
||||
actionName: SOUND_ALARM
|
||||
data:
|
||||
actionName: SOUND_ALARM
|
||||
action:
|
||||
...
|
||||
```
|
||||
|
||||
@ -385,6 +385,11 @@ state_filter:
|
||||
required: false
|
||||
description: '[State-based CSS filters](#how-to-use-state_filter)'
|
||||
type: object
|
||||
aspect_ratio:
|
||||
required: false
|
||||
description: Height-width-ratio.
|
||||
type: string
|
||||
default: "50%"
|
||||
style:
|
||||
required: true
|
||||
description: Position and style the element using CSS.
|
||||
|
||||
@ -65,6 +65,34 @@ Note for custom component developers: We are moving to a new file structure. Mor
|
||||
- Add quirks info to ZHA device ([@dmulcahey] - [#20923]) ([zha docs]) (new-feature)
|
||||
- Added IDs and enabled workarounds for Yale YRD220, YRL220, YRD120 ([@mw-white] - [#20929]) ([zwave docs]) (new-feature)
|
||||
|
||||
## {% linkable_title Release 0.88.1 - February 21 %}
|
||||
|
||||
- Fix ZHA bugs ([@dmulcahey] - [#21246]) ([zha docs])
|
||||
- Add missing configuration option to plex ([@elupus] - [#21264]) ([media_player.plex docs])
|
||||
- Add missing configation option ([@elupus] - [#21265]) ([sensor.imap_email_content docs])
|
||||
- Add SamsungTV Mac validation ([@balloob] - [#21268]) ([media_player.samsungtv docs])
|
||||
- update services.yaml ([@dmulcahey] - [#21276])
|
||||
- Fix unhandled exception in Ambient PWS config entry ([@bachya] - [#21278]) ([ambient_station docs])
|
||||
- Fix yeelight config validation ([@balloob] - [#21295]) ([light.yeelight docs])
|
||||
|
||||
[#21246]: https://github.com/home-assistant/home-assistant/pull/21246
|
||||
[#21264]: https://github.com/home-assistant/home-assistant/pull/21264
|
||||
[#21265]: https://github.com/home-assistant/home-assistant/pull/21265
|
||||
[#21268]: https://github.com/home-assistant/home-assistant/pull/21268
|
||||
[#21276]: https://github.com/home-assistant/home-assistant/pull/21276
|
||||
[#21278]: https://github.com/home-assistant/home-assistant/pull/21278
|
||||
[#21295]: https://github.com/home-assistant/home-assistant/pull/21295
|
||||
[@bachya]: https://github.com/bachya
|
||||
[@balloob]: https://github.com/balloob
|
||||
[@dmulcahey]: https://github.com/dmulcahey
|
||||
[@elupus]: https://github.com/elupus
|
||||
[ambient_station docs]: /components/ambient_station/
|
||||
[light.yeelight docs]: /components/light.yeelight/
|
||||
[media_player.plex docs]: /components/media_player.plex/
|
||||
[media_player.samsungtv docs]: /components/media_player.samsungtv/
|
||||
[sensor.imap_email_content docs]: /components/sensor.imap_email_content/
|
||||
[zha docs]: /components/zha/
|
||||
|
||||
## {% 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.
|
||||
|
||||
@ -115,19 +115,19 @@ A detailed guide about running Hass.io as a virtual machine is available in the
|
||||
[balenaEtcher]: https://www.balena.io/etcher
|
||||
[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.8/hassos_rpi0-w-2.8.img.gz
|
||||
[pi1]: https://github.com/home-assistant/hassos/releases/download/2.8/hassos_rpi-2.8.img.gz
|
||||
[pi2]: https://github.com/home-assistant/hassos/releases/download/2.8/hassos_rpi2-2.8.img.gz
|
||||
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/2.8/hassos_rpi3-2.8.img.gz
|
||||
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/2.8/hassos_rpi3-64-2.8.img.gz
|
||||
[tinker]: https://github.com/home-assistant/hassos/releases/download/2.9/hassos_tinker-2.9.img.gz
|
||||
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.8/hassos_odroid-c2-2.8.img.gz
|
||||
[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/2.8/hassos_odroid-xu4-2.8.img.gz
|
||||
[opi-prime]: https://github.com/home-assistant/hassos/releases/download/2.8/hassos_opi-prime-2.8.img.gz
|
||||
[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/2.8/hassos_intel-nuc-2.8.img.gz
|
||||
[vmdk]: https://github.com/home-assistant/hassos/releases/download/2.9/hassos_ova-2.9.vmdk.gz
|
||||
[vhdx]: https://github.com/home-assistant/hassos/releases/download/2.9/hassos_ova-2.9.vhdx.gz
|
||||
[vdi]: https://github.com/home-assistant/hassos/releases/download/2.9/hassos_ova-2.9.vdi.gz
|
||||
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_rpi0-w-2.10.img.gz
|
||||
[pi1]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_rpi-2.10.img.gz
|
||||
[pi2]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_rpi2-2.10.img.gz
|
||||
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_rpi3-2.10.img.gz
|
||||
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_rpi3-64-2.10.img.gz
|
||||
[tinker]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_tinker-2.10.img.gz
|
||||
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_odroid-c2-2.10.img.gz
|
||||
[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_odroid-xu4-2.10.img.gz
|
||||
[opi-prime]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_opi-prime-2.10.img.gz
|
||||
[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_intel-nuc-2.10.img.gz
|
||||
[vmdk]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_ova-2.10.vmdk.gz
|
||||
[vhdx]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_ova-2.10.vhdx.gz
|
||||
[vdi]: https://github.com/home-assistant/hassos/releases/download/2.10/hassos_ova-2.10.vdi.gz
|
||||
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
|
||||
[local]: http://hassio.local:8123
|
||||
[samba]: /addons/samba/
|
||||
|
||||
@ -8,8 +8,28 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
## {% linkable_title Changes in 0.87.0 %}
|
||||
- 📣 MDI icons updated to [3.3.92](https://cdn.materialdesignicons.com/3.3.92/)
|
||||
- 📣 New system-health card in dev-info
|
||||
- 📣 UI Editor: YAML syntax support
|
||||
- 📣 UI Editor: Line numbers
|
||||
- 📣 UI Editor: Now supports columns on wide screens
|
||||
- 📣 Notifications: Indicator updated to show count of pending notifications
|
||||
- 📣 [thermostat card]: more-info button added
|
||||
- 📣 [light card]: more-info button added
|
||||
- 🔧 [thermostat card]: Fix slider
|
||||
- 🔧 groups togglable
|
||||
|
||||
## {% linkable_title Changes in 0.86.0 %}
|
||||
- 📣 Lovelace is now the default UI for Home Assistant!
|
||||
- 📣 New Lovelace [demos](https://demo.home-assistant.io/#/lovelace/0) page
|
||||
- 🔧 [thermostat card]: Fix sizing
|
||||
- 🔧 [guage card]: Fix sizing
|
||||
- 🔧 [iframe card]: Fix card size
|
||||
|
||||
|
||||
## {% linkable_title Changes in 0.85.1 %}
|
||||
- 🔧 Fix removal of `resources` on save in Raw Config Editor
|
||||
- 🔧 UI Editor: Fix removal of `resources` on save
|
||||
- 🔧 Auto-gen correctly converts weblink entities to [weblink row]
|
||||
- 🔧 The [weblink row] opens links in new tabs
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user