mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 16:56:50 +00:00
Update configuration samples (#5041)
* Update configuration samples * Minor changes
This commit is contained in:
Fabian Affolter
GitHub
parent
41a1a06af1
commit
2851b2a606
@ -13,23 +13,25 @@ ha_iot_class: "Local Polling"
|
||||
ha_release: 0.49
|
||||
---
|
||||
|
||||
The `amcrest` platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
|
||||
The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable your camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
amcrest:
|
||||
- host: IP_ADDRESS
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
- host: IP_ADDRESS_CAMERA_1
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
sensors:
|
||||
- motion_detector
|
||||
- sdcard
|
||||
|
||||
- host: IP_ADDRESS
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
- host: IP_ADDRESS_CAMERA_2
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
resolution: low
|
||||
stream_source: snapshot
|
||||
sensors:
|
||||
|
||||
@ -15,19 +15,27 @@ ha_iot_class: "Cloud Polling"
|
||||
|
||||
The `arlo` implementation allows you to integrate your [Arlo](https://arlo.netgear.com/) devices in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
arlo:
|
||||
username: you@example.com
|
||||
password: secret
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The username for accessing your Arlo account.
|
||||
- **password** (*Required*): The password for accessing your Arlo account.
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username for accessing your Arlo account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your Arlo account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
It is recommended to create a dedicated user on Arlo website to be used within Home Assistant and then share your Arlo cameras.
|
||||
|
||||
|
||||
@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
|
||||
|
||||
The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant. Currently this component supports August Lock and Doorbell.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You will need your August login information (username (either phone# or email), and password) to use this module.
|
||||
|
||||
To set it up, add the following to your `configuration.yaml` file:
|
||||
@ -24,27 +26,27 @@ To set it up, add the following to your `configuration.yaml` file:
|
||||
august:
|
||||
login_method: phone
|
||||
username: "+16041234567"
|
||||
password: secret
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
login_method:
|
||||
description: Method to login to your August account, either "email" or "phone". A verification code will be sent to your email or phone during setup.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: The username for accessing your August account. This depends on your login_method, if login_method is email, this will be your email of the account. Otherwise, this will be your phone number.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your August account.
|
||||
required: true
|
||||
type: string
|
||||
timeout:
|
||||
description: Timeout to wait for connections.
|
||||
required: false
|
||||
type: int
|
||||
default: 10
|
||||
login_method:
|
||||
description: Method to login to your August account, either "email" or "phone". A verification code will be sent to your email or phone during setup.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: The username for accessing your August account. This depends on your login_method, if login_method is email, this will be your email of the account. Otherwise, this will be your phone number.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your August account.
|
||||
required: true
|
||||
type: string
|
||||
timeout:
|
||||
description: Timeout to wait for connections.
|
||||
required: false
|
||||
type: int
|
||||
default: 10
|
||||
{% endconfiguration %}
|
||||
|
||||
Once Home Assistant is started, a configurator will pop up asking you to enter verification code that is sent to your phone number or email.
|
||||
|
||||
@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable your Foscam IP camera in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -22,8 +24,8 @@ To enable your Foscam IP camera in your installation, add the following to your
|
||||
camera:
|
||||
- platform: foscam
|
||||
ip: IP_ADDRESS
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
@ -39,4 +41,5 @@ There seems to be some issues within Foscam with lengthy passwords and passwords
|
||||
</p>
|
||||
|
||||
### {% linkable_title Control Foscam PTZ (Pan/Tilt/Zoom) - Home/Away %}
|
||||
|
||||
Foscam Webcams which support CGI Commands can be controlled by Home Assistant ([Source](http://www.ipcamcontrol.net/files/Foscam%20IPCamera%20CGI%20User%20Guide-V1.0.4.pdf)). For an example of how this can be done, see the [Foscam IP Camera Pan, Tilt, Zoom Control](/cookbook/foscam_away_mode_PTZ/) Cookbook entry.
|
||||
|
||||
@ -14,7 +14,7 @@ ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `synology` platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.
|
||||
The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.
|
||||
|
||||
To enable your Surveillance Station cameras in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -22,9 +22,9 @@ To enable your Surveillance Station cameras in your installation, add the follow
|
||||
# Minimum configuration.yaml entry
|
||||
camera:
|
||||
- platform: synology
|
||||
url: SYNOLOGY_URL
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
url: IP_ADDRESS_OF_SYNOLOGY_NAS
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
@ -43,8 +43,8 @@ A full sample configuration for the `synology` platform is shown below:
|
||||
camera:
|
||||
- platform: synology
|
||||
url: https://192.168.1.120:5001
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
timeout: 15
|
||||
verify_ssl: False
|
||||
```
|
||||
|
||||
@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
|
||||
|
||||
The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You will need your Canary login information (username, usually your email address, and password) to use this module.
|
||||
|
||||
To set it up, add the following to your `configuration.yaml` file:
|
||||
@ -22,8 +24,8 @@ To set it up, add the following to your `configuration.yaml` file:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
canary:
|
||||
username: you@example.com
|
||||
password: secret
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
@ -42,8 +44,6 @@ canary:
|
||||
default: 10
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
|
||||
Once loaded, your front end will have the following components:
|
||||
|
||||
* A camera image triggered by motion for each camera.
|
||||
|
||||
@ -16,6 +16,8 @@ ha_iot_class: "Cloud Polling"
|
||||
|
||||
The `garadget` cover platform lets you control [Garadget](http://www.garadget.com/) garage door futurizers through Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable Garadget Covers in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -24,8 +26,8 @@ cover:
|
||||
- platform: garadget
|
||||
covers:
|
||||
190028001947343412342341:
|
||||
username: UseYourLogin@garadget.com
|
||||
password: abc123
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
4c003f001151353432134214:
|
||||
access_token: df4cc785ff818f2b01396c44142342fccdef
|
||||
```
|
||||
@ -44,12 +46,13 @@ Configuration variables:
|
||||
|
||||
If provided, the **access_token** will be used, otherwise the **username** and **password** will be used to automatically generate an access token at start time.
|
||||
|
||||
## {% linkable_title Example %}
|
||||
|
||||
**Example with more detail:**
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/components/garadget/cover_garadget_details.png' />
|
||||
</p>
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
# Related configuration.yaml entry
|
||||
cover:
|
||||
@ -64,13 +67,13 @@ sensor:
|
||||
sensors:
|
||||
garage_door_status:
|
||||
friendly_name: 'State of the door'
|
||||
value_template: {% raw %}'{{ states.cover.garage_door.state }}'{% endraw %}
|
||||
value_template: '{{ states.cover.garage_door.state }}'
|
||||
garage_door_time_in_state:
|
||||
friendly_name: 'Since'
|
||||
value_template: {% raw %}'{{ states.cover.garage_door.attributes.time_in_state }}'{% endraw %}
|
||||
value_template: '{{ states.cover.garage_door.attributes.time_in_state }}'
|
||||
garage_door_wifi_signal_strength:
|
||||
friendly_name: 'WiFi strength'
|
||||
value_template: {% raw %}'{{ states.cover.garage_door.attributes.wifi_signal_strength }}'{% endraw %}
|
||||
value_template: '{{ states.cover.garage_door.attributes.wifi_signal_strength }}'
|
||||
unit_of_measurement: 'dB'
|
||||
|
||||
group:
|
||||
@ -88,6 +91,7 @@ customize:
|
||||
sensor.garage_door_wifi_signal_strength:
|
||||
icon: mdi:wifi
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Some of the Garadget sensors can create a lot of clutter in the logbook. Use this section of code in your `configuration.yaml` to exclude those entries.
|
||||
|
||||
|
||||
@ -21,13 +21,23 @@ To use your MyQ cover in your installation, add the following to your `configura
|
||||
# Example configuration.yml entry
|
||||
cover:
|
||||
- platform: myq
|
||||
username: email@email.com
|
||||
password: password
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
type: chamberlain
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Your MyQ account username.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Your MyQ account password.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: "Your device type/brand. Supported types are `chamberlain`, `liftmaster`, `craftsman` and `merlin`."
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
- **username** (*Required*): Your MyQ account username.
|
||||
- **password** (*Required*): Your MyQ account password.
|
||||
- **type** (*Required*): Your device type/brand. Supported types are `chamberlain`, `liftmaster`, `craftsman` and `merlin`.
|
||||
|
||||
@ -12,9 +12,12 @@ ha_category: Presence Detection
|
||||
ha_release: 0.51
|
||||
---
|
||||
|
||||
This component offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm).
|
||||
The `huawei` device trakcer platform offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm).
|
||||
|
||||
Currently, this was only tested with the Huawei HG8247H and HG8247Q Smart Router (used by Vodafone Portugal).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use a Huawei router in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -22,15 +25,23 @@ To use a Huawei router in your installation, add the following to your `configur
|
||||
device_tracker:
|
||||
- platform: huawei_router
|
||||
host: 192.168.1.1
|
||||
username: user
|
||||
password: pass
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address of your router, e.g., 192.168.1.1.
|
||||
- **username** (*Required*): The username to login into the router (the same used trough the router's web interface).
|
||||
- **password** (*Required*): The password for the specified username.
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address of your router, e.g., 192.168.1.1.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: The username to login into the router (the same used trough the router's web interface).
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for the specified username.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|
||||
|
||||
@ -24,11 +24,18 @@ To integrate TrackR in Home Assistant, add the following section to your `config
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
platform: trackr
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The email address for the TrackR account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your given username.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
- **username** (*Required*): The email address for the TrackR account.
|
||||
- **password** (*Required*): The password for your given username.
|
||||
|
||||
@ -21,8 +21,8 @@ To connect your device, add the following to your `configuration.yaml` file:
|
||||
# Example configuration.yaml entry
|
||||
doorbird:
|
||||
host: IP_OR_HOSTNAME
|
||||
username: abcdef0001
|
||||
password: xxxxxxxxxx
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
@ -15,29 +15,31 @@ ha_release: 0.47
|
||||
|
||||
The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms: [Fans](/components/fan/dyson/) and [Robot vacuum](/components/vacuum/dyson/).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this component, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
dyson:
|
||||
username: <dyson_account_user_email>
|
||||
password: <dyson_acount_password>
|
||||
language: <dyson_account_language>
|
||||
username: YOUR_DYSON_USERNAME
|
||||
password: YOUR_DYSON_PASSWORD
|
||||
language: YOUR_DYSON_ACCOUNT_LANGUGAGE
|
||||
devices:
|
||||
- device_id: <device_id_1> # eg: Pure Cool Link device
|
||||
device_ip: <device_ip_1>
|
||||
- device_id: <device_id_2> # eg: Eye 360 robot vacuum
|
||||
device_ip: <device_ip_2>
|
||||
...
|
||||
- device_id: DEVICE_ID_1 # eg: Pure Cool Link device
|
||||
device_ip: DEVICE_ID_1
|
||||
- device_id: DEVICE_ID_2 # eg: Eye 360 robot vacuum
|
||||
device_ip: DEVICE_ID_2
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): Dyson account username (email address)
|
||||
- **password** (*Required*): Dyson account password
|
||||
- **username** (*Required*): Dyson account username (email address).
|
||||
- **password** (*Required*): Dyson account password.
|
||||
- **language** (*Required*): Dyson account language country code. Known working codes: `FR`, `NL`, `GB`, `AU`. But others codes should work.
|
||||
- **devices** (*Optional*): List of devices
|
||||
- **device_id** (*Required*): Device ID. Available in the mobiles applications (*Settings* page)
|
||||
- **device_ip** (*Required*): Device IP address
|
||||
- **devices** (*Optional*): List of devices.
|
||||
- **device_id** (*Required*): Device ID. Available in the mobiles applications (*Settings* page).
|
||||
- **device_ip** (*Required*): Device IP address.
|
||||
|
||||
`devices` list is optional but you'll have to provide them if discovery is not working (warnings in the logs and the devices are not available in Home Assistant web interface).
|
||||
*If your are using a robot vacuum (Dyson 360 Eye), discovery is not yet supported so you have to provide `devices` list.*
|
||||
|
||||
@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
|
||||
|
||||
The `eight_sleep` component allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
It's setup utilizing 'Sensor' components to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' component to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed.
|
||||
|
||||
You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component.
|
||||
@ -24,15 +26,25 @@ To get started add the following information to your `configuration.yaml` file:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
eight_sleep:
|
||||
username: "user@email.com"
|
||||
password: "password"
|
||||
username: YOUR_E_MAIL_ADDRESS
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The email address associated with your Eight Sleep account.
|
||||
- **password** (*Required*): The password associated with your Eight Sleep account.
|
||||
- **partner** (*Optional*): Default is False. Defines if you'd like to fetch data for both sides of the bed.
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The email address associated with your Eight Sleep account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password associated with your Eight Sleep account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Defines if you'd like to fetch data for both sides of the bed.
|
||||
required: false
|
||||
type: string
|
||||
default: False
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Supported features %}
|
||||
|
||||
|
||||
@ -19,8 +19,8 @@ To use this component, enter your email address and password from your goalfeed.
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
goalfeed:
|
||||
username: your_email@gmail.com
|
||||
password: goalfeed_password
|
||||
username: YOUR_E_MAIL_ADDRESS
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
|
||||
@ -21,8 +21,6 @@ To enable these lights, add the following lines to your `configuration.yaml` fil
|
||||
# Example configuration.yaml entry
|
||||
light:
|
||||
- platform: avion
|
||||
username: testuser@fakedomain.com
|
||||
password: foobar
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
@ -26,13 +26,18 @@ To enable these lights, add the following lines to your `configuration.yaml` fil
|
||||
# Example configuration.yaml entry
|
||||
light:
|
||||
- platform: decora_wifi
|
||||
username: my_leviton_user_email@email.com
|
||||
password: my_leviton_password
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): Your "My Leviton" app email address/user name.
|
||||
- **password** (*Required*): Your "My Leviton" app password.
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Your "My Leviton" app email address/user name.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Your "My Leviton" app password.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
@ -16,6 +16,7 @@ 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">
|
||||
@ -24,18 +25,26 @@ Be aware that if you use your main account for Home Assistant you may not be abl
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add your Nello locks to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
lock:
|
||||
- platform: nello
|
||||
username: mail@example.com
|
||||
password: mySecretPassword
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The username of your Nello account.
|
||||
- **password** (*Required*): The password of your Nello account.
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username of your Nello account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password of your Nello account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Events %}
|
||||
|
||||
|
||||
@ -15,18 +15,28 @@ ha_release: "0.47"
|
||||
|
||||
The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Your Sesame needs to be paired with a mobile device running the app in *virtual station* mode, or a standalone [Wi-Fi Access Point](https://candyhouse.co/collections/frontpage/products/wi-fi-access-point).
|
||||
|
||||
Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
lock:
|
||||
- platform: sesame
|
||||
email: abc@i-lovecandyhouse.co
|
||||
password: super-strong-password
|
||||
email: YOUR_E_MAIL_ADDRESS
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
email:
|
||||
description: The email address for your Sesame account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your Sesame account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
- **email** (*Required*): The email address for your Sesame account.
|
||||
- **password** (*Required*): The password for your Sesame account.
|
||||
|
||||
@ -18,6 +18,8 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
Presently, there's only support for communicating with the [RadioRA 2](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RadioRA2/Overview.aspx) Main Repeater and only handle light switches and dimmers.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
When configured, the `lutron` component will automatically discover the rooms and their associated switches/dimmers as configured by the RadioRA 2 software from Lutron. Each room will be treated as a separate group.
|
||||
|
||||
To use Lutron RadioRA 2 devices in your installation, add the following to your `configuration.yaml` file using the IP address of your RadioRA 2 main repeater:
|
||||
|
||||
@ -23,19 +23,19 @@ media_player:
|
||||
- platform: cmus
|
||||
```
|
||||
|
||||
if cmus is running on a remote server:
|
||||
If cmus is running on a remote server:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
- platform: cmus
|
||||
host: IP_ADDRESS
|
||||
password: PASSWORD
|
||||
host: IP_ADDRESS_OF_CMUS_PLAYER
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Optional*): Hostname or IP address of the machine running cmus. Note if a remote cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
|
||||
- **host** (*Optional*): Hostname or IP address of the machine running cmus. Note if a remote cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
|
||||
- **password** (*Required if host is set*): Password for your cmus player.
|
||||
- **port** (*Optional*): Port of the cmus socket, defaults to 3000.
|
||||
- **name** (*Optional*): The name you'd like to give the cmus player in Home Assistant
|
||||
|
||||
@ -22,8 +22,8 @@ To add your UE Smart Radio player to your installation, add the following to you
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
- platform: ue_smart_radio
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
|
||||
@ -16,13 +16,15 @@ ha_iot_class: "Cloud Polling"
|
||||
|
||||
The `Melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To set the Melissa component up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
melissa:
|
||||
username: <email address>
|
||||
password: ********
|
||||
username: YOUR_MELISSA_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
|
||||
@ -14,12 +14,13 @@ ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `Mercedes me` component offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval.
|
||||
The `mercedesme` component offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval.
|
||||
|
||||
This component provides the following platforms:
|
||||
- Binary Sensors - such as windows, tires, doors, lock
|
||||
- Sensors - such as fuel status, service interval, remaining km...
|
||||
- Device tracker - to track location of your car
|
||||
|
||||
- Binary Sensors: Windows, tires, doors and lock.
|
||||
- Sensors:Fuel status, service interval, remaining km, etc.
|
||||
- Device tracker: To track location of your car.
|
||||
|
||||
<p class='note warning'>
|
||||
The component can integrate cars from European and African markets only.
|
||||
@ -30,8 +31,8 @@ To use Mercedes me in your installation, add the following to your `configuratio
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mercedesme:
|
||||
username: email
|
||||
password: password
|
||||
username: YOUR_E_MAIL_ADDRESS
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
@ -43,11 +44,6 @@ password:
|
||||
description: The password for your given Mercedes me account.
|
||||
required: true
|
||||
type: string
|
||||
scan_interval:
|
||||
description: API polling interval. The minimal value can't be less then 30 seconds.
|
||||
required: true
|
||||
default: 30
|
||||
type: int
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
|
||||
@ -15,6 +15,8 @@ ha_iot_class: depends
|
||||
|
||||
The `mqtt_eventstream` component connects two Home Assistant instances via MQTT.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To integrate MQTT Eventstream into Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -15,6 +15,8 @@ ha_iot_class: depends
|
||||
|
||||
The `mqtt_statestream` component publishes state changes in Home Assistant to individual MQTT topics.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable MQTT Statestream in Home Assistant, add the following section to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -13,33 +13,31 @@ ha_release: 0.62
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `MyChevy` component communicates with the
|
||||
[my.chevrolet](https://my.chevrolet.com) website using selenium to log
|
||||
in as your user, and screen scrape the data provided. GM does not
|
||||
make it easy to sign up for any official development program, so this
|
||||
provides a workaround to get access to your data.
|
||||
The `MyChevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user, and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data.
|
||||
|
||||
This component provides the following platforms:
|
||||
- Binary sensors - if the car is plugged in
|
||||
- Sensors - such as Battery Level, Charge Mode, EST Range, Total
|
||||
Distance Traveled
|
||||
|
||||
- Binary sensors: if the car is plugged in
|
||||
- Sensors: Battery Level, Charge Mode, EST Range, Total Distance Traveled
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use MyChevy in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mychevy:
|
||||
username: email
|
||||
password: password
|
||||
username: YOUR_E_MAIL_ADDRESS
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The email address associated with your my.chevrolet account
|
||||
description: The email address associated with your my.chevrolet account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your given my.chevrolet account
|
||||
description: The password for your given my.chevrolet account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
@ -47,27 +45,15 @@ password:
|
||||
|
||||
#### {% linkable_title Installation %}
|
||||
|
||||
Because this uses selenium behind the scenes, installation is more
|
||||
complicated than merely pip install. See the installation instructions
|
||||
at https://github.com/sdague/mychevy.
|
||||
Because this uses selenium behind the scenes, installation is more complicated than merely pip install. See the [installation instructions](https://github.com/sdague/mychevy).
|
||||
|
||||
#### {% linkable_title Limitations %}
|
||||
|
||||
The architecture of the GM automotive networking imposes some
|
||||
limitations on the functionality of the component.
|
||||
The architecture of the GM automotive networking imposes some limitations on the functionality of the component.
|
||||
|
||||
The OnStar network link is very slow, and takes 1 - 3 minutes to get
|
||||
information back from the car. As such the mychevy component only
|
||||
polls every 30 minutes to not overwhelms that connection.
|
||||
The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the mychevy component only polls every 30 minutes to not overwhelms that connection.
|
||||
|
||||
The OnStar network (or more specifically the gateway used by the
|
||||
my.chevrolet website) appears to suffer more than most networks when
|
||||
the car is a) in a garage, and b) it's cold outside (like < 15 degrees
|
||||
F). One of the provided sensors is a status sensor which indicates if
|
||||
we got connectivity with the car on the last polling cycle or not.
|
||||
The OnStar network (or more specifically the gateway used by the my.chevrolet website) appears to suffer more than most networks when the car is a) in a garage, and b) it's cold outside (like < 15 degrees F). One of the provided sensors is a status sensor which indicates if we got connectivity with the car on the last polling cycle or not.
|
||||
|
||||
The "API" for this is written by web scraping. As such, it only currently is known to work if you have a Chevy Bolt EV, and only 1 Chevy car connected to OnStar. Patches for extended support should go to the https://github.com/sdague/mychevy project first, then Home Assistant can be extended.
|
||||
|
||||
The "API" for this is written by web scraping. As such, it only
|
||||
currently is known to work if you have a Chevy Bolt EV, and only 1
|
||||
Chevy car connected to OnStar. Patches for extended support should go
|
||||
to the https://github.com/sdague/mychevy project first, then
|
||||
Home Assistant can be extended.
|
||||
|
||||
@ -19,15 +19,21 @@ To enable `neato` in your installation, add the following to your `configuration
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
neato:
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): Username for the Neato account.
|
||||
- **password** (*Required*): Password for the Neato account.
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Username for the Neato account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: v
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. The start/stop functionality does not work. More information on how to update here: https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-
|
||||
After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. The start/stop functionality does not work. More information on how to update can be found [here](https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-).
|
||||
</p>
|
||||
|
||||
@ -15,6 +15,8 @@ ha_release: 0.32
|
||||
|
||||
The `matrix` platform allows you to deliver notifications from Home Assistant to a [Matrix](http://matrix.org) room. Rooms can be both direct as well as group chats.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable Matrix notifications in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -23,8 +25,8 @@ notify:
|
||||
- name: NOTIFIER_NAME
|
||||
platform: matrix
|
||||
homeserver: HOMESERVER
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
default_room: ROOM_ID_OR_ALIAS
|
||||
```
|
||||
|
||||
|
||||
@ -13,7 +13,9 @@ ha_release: 0.56
|
||||
---
|
||||
|
||||
|
||||
The `rocketchat` platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant.
|
||||
The `rocketchat` notify platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add Rocket.Chat to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -23,9 +25,9 @@ notify:
|
||||
- platform: rocketchat
|
||||
name: NOTIFIER_NAME
|
||||
url: https://rocketchat.example.com
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
room: my-awesome-room
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
room: YOUR_ROOM_NAME
|
||||
```
|
||||
|
||||
- **name** (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
@ -49,8 +51,7 @@ rocketchat_notification:
|
||||
#### {% linkable_title Message variables %}
|
||||
|
||||
- **message** (*Required*): Message to be displayed.
|
||||
- **data** (*Optional*): Dictionary containing any of the variables defined in the
|
||||
[Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example)
|
||||
- **data** (*Optional*): Dictionary containing any of the variables defined in the [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example)
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
||||
|
||||
@ -22,14 +22,14 @@ Once you have the Thermostat ID(s), add the following information to your `confi
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
nuheat:
|
||||
username: you@example.com
|
||||
password: very-secure-password
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
devices: 12345
|
||||
|
||||
# Example configuration.yaml entry with multiple thermostats
|
||||
nuheat:
|
||||
username: you@example.com
|
||||
password: very-secure-password
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
devices:
|
||||
- 12345
|
||||
- 67890
|
||||
|
||||
@ -18,15 +18,22 @@ This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird
|
||||
To enable it, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
rainbird:
|
||||
host: '1.1.1.1'
|
||||
password: 'XXXXXXX'
|
||||
host: IP_ADDRESS_OF_MODULE
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address of your LNK WiFi Module.
|
||||
- **password** (*Required*): The password for accessing the module.
|
||||
{% configuration %}
|
||||
host:
|
||||
description: v
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing the module.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
Finish its configuration by visiting the [Rain Bird sensor](/components/sensor.rainbird/) and [Rain Bird switch](/components/switch.rainbird/) documentation.
|
||||
|
||||
|
||||
@ -18,16 +18,20 @@ To enable it, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
raincloud:
|
||||
username: you@example.com
|
||||
password: secret
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The username for accessing your Melnor RainCloud account.
|
||||
- **password** (*Required*): The password for accessing your Melnor RainCloud account.
|
||||
- **scan_interval** (*Optional*): Defines the update interval of the sensor in seconds. Defaults to 20seconds.
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username for accessing your Melnor RainCloud account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your Melnor RainCloud account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
Finish its configuration by visiting the [Raincloud binary sensor](/components/binary_sensor.raincloud/), [Raincloud sensor](/components/sensor.raincloud/) and [Raincloud switch](/components/switch.raincloud/) documentation.
|
||||
|
||||
@ -21,13 +21,19 @@ To enable device linked in your [Ring.com](https://ring.com/) account, add the f
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
ring:
|
||||
username: you@example.com
|
||||
password: secret
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The username for accessing your Ring account.
|
||||
- **password** (*Required*): The password for accessing your Ring account.
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username for accessing your Ring account.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing your Ring account.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
Finish its configuration by visiting the [Ring binary sensor](/components/binary_sensor.ring/) or [Ring sensor](/components/sensor.ring/) documentation.
|
||||
|
||||
@ -23,6 +23,7 @@ Some more details about what can be retrieved from these sensors is available in
|
||||
<img src='{{site_root}}/images/screenshots/hp_ilo.png' />
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use this component in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -31,8 +32,8 @@ To use this component in your installation, add the following to your `configura
|
||||
sensor:
|
||||
- platform: hp_ilo
|
||||
host: IP_ADDRESS or HOSTNAME
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
monitored_variables:
|
||||
- name: SENSOR NAME
|
||||
sensor_type: SENSOR TYPE
|
||||
@ -63,7 +64,7 @@ Valid sensor_types:
|
||||
- **server_health**: Get server health information.
|
||||
- **network_settings**: Get the iLO network settings.
|
||||
|
||||
### Example
|
||||
## {% linkable_title Example %}
|
||||
|
||||
In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperature, as well as a dump of `server_health` on a HP Microserver Gen8, you could use the following in your `configuration.yaml` file
|
||||
|
||||
@ -71,8 +72,8 @@ In order to get two sensors reporting CPU fan speed and Ambient Inlet Temperatur
|
||||
sensor:
|
||||
- platform: hp_ilo
|
||||
host: IP_ADDRESS or HOSTNAME
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
monitored_variables:
|
||||
- name: CPU fanspeed
|
||||
sensor_type: server_health
|
||||
|
||||
@ -24,8 +24,8 @@ sensor:
|
||||
- platform: imap
|
||||
server: imap.gmail.com
|
||||
port: 993
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
@ -16,15 +16,17 @@ ha_release: 0.32
|
||||
|
||||
The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add this platform to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: mfi
|
||||
host: IP_ADDRESS
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
host: IP_ADDRESS_OF_SENSOR
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
@ -24,18 +24,28 @@ Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) re
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`.
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: mopar
|
||||
username: <mopar.com username>
|
||||
password: <mopar.com password>
|
||||
pin: <uconnect pin>
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
pin: YOUR_UCONNECT_PIN
|
||||
```
|
||||
|
||||
Configuration options for the Mopar sensor:
|
||||
|
||||
- **username** (*Required*): Your mopar.com username.
|
||||
- **password** (*Required*): Your mopar.com password.
|
||||
- **pin** (*Required*): Your uConnect pin.
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Your mopar.com username.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Your mopar.com password.
|
||||
required: true
|
||||
type: string
|
||||
pin:
|
||||
description: v
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Service %}
|
||||
|
||||
|
||||
@ -16,6 +16,8 @@ ha_release: 0.32
|
||||
|
||||
The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. This can be useful if you want to test automation rules. It generates a new value every time it is polled.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable the random sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -16,14 +16,16 @@ ha_release: 0.36
|
||||
|
||||
The `sma` sensor will poll a [SMA](http://www.sma-solar.com/) [(US)](http://www.sma-america.com/) solar inverter and present the values as sensors (or attributes of sensors) in Home Assistant.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor sma:
|
||||
- platform: sma
|
||||
host: 192.168.88.199
|
||||
password: !secret sma_password
|
||||
host: IP_ADDRESS_OF_DEVICE
|
||||
password: YOUR_SMA_PASSWORD
|
||||
sensors:
|
||||
current_consumption: [total_consumption]
|
||||
current_power:
|
||||
|
||||
@ -14,7 +14,7 @@ ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
This `synologydsm` sensor allows getting various statistics from your [Synology NAS](https://www.synology.com).
|
||||
The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com).
|
||||
|
||||
To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -23,8 +23,8 @@ To use the `synologydsm` sensor in your installation, add the following to your
|
||||
sensor:
|
||||
- platform: synologydsm
|
||||
host: IP_ADDRESS_OF_SYNOLOGY_NAS
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
monitored_conditions:
|
||||
- cpu_total_load
|
||||
- memory_real_usage
|
||||
|
||||
@ -15,6 +15,8 @@ ha_release: 0.48
|
||||
|
||||
The `shiftr` component makes it possible to transfer details collected with Home Assistant to [Shiftr.io](https://shiftr.io) and visualize the flow of the information. Keep in mind that your details will be public!
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Create a new [namespace](https://shiftr.io/new) and generate a new token. You will need to use `Key (Username)` and `Secret (Password)` to setup the component.
|
||||
|
||||
To use the `shiftr` component in your installation, add the following to your `configuration.yaml` file:
|
||||
@ -22,12 +24,18 @@ To use the `shiftr` component in your installation, add the following to your `c
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
shiftr:
|
||||
username: 63d8187f
|
||||
password: 32fd92de6a59c3e2
|
||||
username: YOUR_NAMESPACE_USERNAME
|
||||
password: YOUR_NAMESPACE_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): Username for the namespace.
|
||||
- **password** (*Required*): Password for the namespace.
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Username for the Shiftr namespace.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Password for the Shiftr namespace.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
@ -17,13 +17,15 @@ The `skybell` implementation allows you to integrate your [Skybell.com](http://w
|
||||
|
||||
Currently only the Skybell HD is supported by this platform.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable devices set up with your [Skybell.com](http://www.skybell.com/) account, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
skybell:
|
||||
username: you@example.com
|
||||
password: secret
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
|
||||
@ -22,11 +22,18 @@ To set it up, add the following information to your `configuration.yaml` file:
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sleepiq:
|
||||
username: you@example.com
|
||||
password: omgsecure
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
{% configuration %}
|
||||
username:
|
||||
description: Your SleepIQ username (usually an e-mail address).
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: Your SleepIQ password.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
- **username** (*Required*): Your SleepIQ username (usually an email address).
|
||||
- **password** (*Required*): Your SleepIQ password.
|
||||
|
||||
@ -20,23 +20,44 @@ In short, Hook is an RF to Wi-Fi bridge, controlling devices that receive comman
|
||||
|
||||
Hook provides a simple [REST API](https://app.swaggerhub.com/api/rahilj/GetHook_RestAPI/v1). This Home Assistant component reads in devices that have been set up in the official app.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
Configure with either your username/password or your API token for the official app.
|
||||
|
||||
To enable this platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: hook
|
||||
username: <email address>
|
||||
password: !secret hook
|
||||
- platform: hook
|
||||
username: YOUR_E_MAIL_ADDRESS
|
||||
password: YOUR_HOOK
|
||||
```
|
||||
|
||||
Or
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: hook
|
||||
token: <your API token>
|
||||
- platform: hook
|
||||
token: YOUR_API_TOKEN
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The email address associated with your Hook Smart Home Hub.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your Hook Smart Home Hub.
|
||||
required: true
|
||||
type: string
|
||||
token:
|
||||
description: The API token for your Hook Smart Home Hub.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
Extra debug logging is available, if you need it.
|
||||
|
||||
```yaml
|
||||
|
||||
@ -15,15 +15,17 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add this platform to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
- platform: mfi
|
||||
host: IP_ADDRESS
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
host: IP_ADDRESS_OF_SWITCH
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
@ -13,23 +13,19 @@ 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/).
|
||||
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 Configuring the Platform %}
|
||||
|
||||
The platform allows for either local (i.e., directly across the LAN) or remote
|
||||
(i.e., through RainMachine's cloud API) access; the route you choose will
|
||||
dictate what your configuration should look like.
|
||||
The platform allows for either local (i.e., directly across the LAN) or remote (i.e., through RainMachine's cloud API) access; the route you choose will dictate what your configuration should look like.
|
||||
|
||||
For local access, specify the IP address/hostname of your RainMachine unit
|
||||
, your RainMachine password, and optionally, the device's HTTP port:
|
||||
For local access, specify the IP address/hostname of your RainMachine unit, your RainMachine password, and optionally, the device's HTTP port:
|
||||
|
||||
```yaml
|
||||
switch:
|
||||
platform: rainmachine
|
||||
ip_address: 192.168.1.100
|
||||
password: my_password_123
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
For remote access, specify your RainMachine username/email and password:
|
||||
@ -38,34 +34,48 @@ For remote access, specify your RainMachine username/email and password:
|
||||
switch:
|
||||
platform: rainmachine
|
||||
email: user@host.com
|
||||
password: my_password_123
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration Variables:
|
||||
{% configuration %}
|
||||
password:
|
||||
description: Your RainMachine password.
|
||||
required: true
|
||||
type: string
|
||||
email:
|
||||
description: "Your RainMachine username/email. Cannot be used with the `ip_address` parameter."
|
||||
required: false
|
||||
type: string
|
||||
ip_address:
|
||||
description: "The IP address of your RainMachine unit; cannot be used with the `email` parameter."
|
||||
required: optional
|
||||
type: string
|
||||
port:
|
||||
description: The TCP port used by your unit for the REST API.
|
||||
required: false
|
||||
type: int
|
||||
default: 8080
|
||||
ssl:
|
||||
description: Whether communication with the local device should occur over HTTPS.
|
||||
required: false
|
||||
type: boolean
|
||||
default: true
|
||||
zone_run_time:
|
||||
description: The number of seconds that a zone should run when turned on.
|
||||
required: false
|
||||
type: int
|
||||
default: 600
|
||||
{% endconfiguration %}
|
||||
|
||||
- **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 %}
|
||||
|
||||
After Home Assistant loads, you will see new switches for every enabled program
|
||||
and zone. These work as expected:
|
||||
After Home Assistant loads, you will see new switches 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)
|
||||
- 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. If a program is running its final zone, 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).
|
||||
Programs and zones are linked. If a program is running its final zone, 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).
|
||||
|
||||
## {% linkable_title Weblink %}
|
||||
|
||||
@ -83,7 +93,4 @@ You can find `<YOUR_DEVICE_ID>` by logging into [https://my.rainmachine.com](htt
|
||||
|
||||
## {% linkable_title For Awareness %}
|
||||
|
||||
The remote RainMachine API currently has two broken operations (i.e., they return
|
||||
error codes): starting a program and stopping a program. Please note that
|
||||
starting/stopping programs with the remote API is disabled until RainMachine
|
||||
can fix the issue.
|
||||
The remote RainMachine API currently has two broken operations (i.e., they return error codes): starting a program and stopping a program. Please note that starting/stopping programs with the remote API is disabled until RainMachine can fix the issue.
|
||||
|
||||
@ -29,8 +29,8 @@ To use Tesla in your installation, add the following to your `configuration.yaml
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
tesla:
|
||||
username: email
|
||||
password: password
|
||||
username: YOUR_E_MAIL_ADDRESS
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
@ -21,8 +21,8 @@ To use Volvo On Call in your installation, add the following to your `configurat
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
volvooncall:
|
||||
username: username
|
||||
password: password
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Users registered with Volvo in North America or China will need to specify a region:
|
||||
@ -30,15 +30,18 @@ Users registered with Volvo in North America or China will need to specify a reg
|
||||
```yaml
|
||||
# North America
|
||||
volvooncall:
|
||||
username: username
|
||||
password: password
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
region: na
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```yaml
|
||||
# China
|
||||
volvooncall:
|
||||
username: username
|
||||
password: password
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
region: cn
|
||||
```
|
||||
|
||||
@ -47,8 +50,8 @@ A more advanced example for setting the vehicle name and selecting what resource
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
volvooncall:
|
||||
username: username
|
||||
password: password
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
name:
|
||||
abc123: 'Batmobile'
|
||||
resources:
|
||||
|
||||
@ -13,12 +13,11 @@ ha_release: 0.62
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `waterfurnace` component communicates with the WaterFurnace
|
||||
Symphony website's WebSocket to show you many of the sensors in your
|
||||
system. While not an official API, this is the same backend the
|
||||
Symphony website is based on, and should be reasonably stable.
|
||||
The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your
|
||||
system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable.
|
||||
|
||||
The sensors provided include:
|
||||
|
||||
- Thermostat Setpoint
|
||||
- Thermostat Current Temp
|
||||
- Leaving Air Temp
|
||||
@ -28,41 +27,37 @@ The sensors provided include:
|
||||
- Total system power (in Watts)
|
||||
- Furnace Mode
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use Waterfurnace in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
waterfurnace:
|
||||
username: you@example.com
|
||||
password: secr3tpassword
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
unit: 0123456789AB
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The email address for your Symphony WaterFurnace account
|
||||
required: true
|
||||
type: string
|
||||
description: The email address for your Symphony WaterFurnace account
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for your Symphony WaterFurnace account
|
||||
required: true
|
||||
type: string
|
||||
description: The password for your Symphony WaterFurnace account
|
||||
required: true
|
||||
type: string
|
||||
unit:
|
||||
description: The unit serial number for your WaterFurnace
|
||||
required: true
|
||||
type: string
|
||||
description: The unit serial number for your WaterFurnace
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
#### {% linkable_title Limitations %}
|
||||
|
||||
The WebSocket interface used by this module requires active polling,
|
||||
otherwise the server side shuts down the connection. By default, this
|
||||
polling is happening every 10 seconds. All sensors are updated during
|
||||
every polling cycle.
|
||||
The WebSocket interface used by this module requires active polling, otherwise the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle.
|
||||
|
||||
While this is communicating with a thermostat, geothermal systems operate most efficiently when setbacks are not used, and the home is kept at a constant temperature. It remains useful to collect the data from the system to understand its performance, but a full climate interface won't be implemented.
|
||||
|
||||
While this is communicating with a thermostat, geothermal systems
|
||||
operate most efficiently when setbacks are not used, and the home is
|
||||
kept at a constant temperature. It remains useful to collect the data
|
||||
from the system to understand its performance, but a full climate
|
||||
interface won't be implemented.
|
||||
|
||||
@ -39,6 +39,6 @@ zoneminder:
|
||||
path: ZM_PATH
|
||||
path_zms: ZM_PATH_ZMS
|
||||
ssl: False
|
||||
username: USERNAME
|
||||
password: PASSWORD
|
||||
username: YOUR_USERNAME
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user