jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/current' into rc

Browse Source
This commit is contained in:
Paulus Schoutsen 2018-03-29 17:27:55 -07:00
commit e0f90c5b9d
78 changed files with 709 additions and 424 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
source/_addons/mosquitto.markdown
View File

@ -43,7 +43,7 @@ Configuration variables:
### {% linkable_title Home Assistant configuration %}
To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own) add the following entry to the `configuration.yaml` file.
To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), add the following entry to the `configuration.yaml` file.
```yaml
# Example configuration.yaml entry
@ -59,3 +59,20 @@ mqtt:
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
### {% linkable_title Listening simultaneously on SSL/TLS (8883) and insecure (1883) ports %}
1. Configure SSL/TLS as normal.
2. Set `customize` flag to `true` in your configuration.
3. Create a file in `/share/mosquitto` named `insecure.conf` with the following contents:
```text
listener 1883
protocol mqtt
```
4. Restart MQTT
<p class='note warning'>
It's recommened that you only open your firewall to the SSL/TLS port (8883) and only use the insecure port (1883) for local devices.
</p>

2
source/_addons/nginx_proxy.markdown
View File

@ -11,7 +11,7 @@ footer: true
Setup an SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on.
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid a HTTP 502 error.
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid an HTTP 502 error.
```json
{

2
source/_addons/samba.markdown
View File

@ -35,7 +35,7 @@ Configuration variables:
- **name** (*Optional*): Set netbios name of Hass.io device. Default is `hassio`.
- **workgroup** (*Optional*): Set network workgroup name. Default is `WORKGROUP`.
- **guest** (*Optional*): Allow login without a username or password. Default is `true`.
- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repositiory. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`.
- **map** (*Optional*): Control which folders will be exposed. `config` shares the Home Assistant configuration folder. `addons` shares the local custom repository. `share` shares a folder that can be accessed by add-ons and Home Assistant. `backup` shares access to snapshot files. `ssl` shares certificate storage. Be careful with the `ssl` option! Defaults are all set to `true`, except for `ssl`.
- **username** (*Optional*): Username for logging in if guest login is not used.
- **password** (*Optional*): Password for `username`. An empty password is not supported.
- **interface** (*Optional*): Interface that will start the share. Normally this is `eth0` for ethernet wired connection and `wlan0` for wireless connection.

16
source/_components/amcrest.markdown
View File

@ -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:

20
source/_components/arlo.markdown
View File

@ -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.

38
source/_components/august.markdown
View File

@ -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.

73
source/_components/binary_sensor.hikvision.markdown
View File

@ -15,22 +15,22 @@ ha_iot_class: "Local Push"
The Hikvision Binary Sensor is a platform that parses the event stream of a [Hikvision IP Camera or NVR](http://www.hikvision.com/) and presents the camera/nvr events to Home Assistant as binary sensors with either an "off" or "on" state.
The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
The platform will automatically add all sensors to Home Assistant that are configured within the camera/nvr interface to "Notify the surveillance center" as a trigger. If you would like to hide a sensor type you can do so by either unchecking "Notify the surveillance center" in the camera configuration or by using the "ignored" customize option detailed below.
<p class='note'>
In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center / Trigger Alarm Output' permission which can be enabled from the user managment section of the web interace. Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security / authentication section.
In order for the sensors to work the hikvision user must have the 'Remote: Notify Surveillance Center/Trigger Alarm Output' permission which can be enabled from the user management section of the web interface. Also the 'WEB Authentication' needs to be set to 'digest/basic' in the security/authentication section.
</p>
For example, if you configure a camera with the name "Front Porch" that has motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
```
```text
binary_sensor.front_porch_motion
binary_sensor.front_port_line_crossing
```
When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
When used with a NVR device the sensors will be appended with the channel number they represent. For example, if you configure an NVR with the name "Home" that supports 2 cameras with motion detection and line crossing events enabled to notify the surveillance center the following binary sensors will be added to Home Assistant:
```
```text
binary_sensor.home_motion_1
binary_sensor.home_motion_2
binary_sensor.home_line_crossing_1
@ -38,35 +38,37 @@ binary_sensor.home_line_crossing_2
```
This platform should work with all Hikvision cameras and nvrs, and has been confirmed to work with the following models:
- DS-2CD3132-I
- DS-2CD2232-I5
- DS-2CD2032-I
- DS-2CD2042WD-I
- DS-2CD2142FWD-I
To enable this sensor, the following lines are required in your `configuration.yaml`:
To enable this sensor, the following lines are required in your `configuration.yaml` file:
```yaml
binary_sensor:
platform: hikvision
host: IP_ADDRESS
username: user
password: pass
- platform: hikvision
host: IP_ADDRESS
username: user
password: pass
```
Configuration options for a Hikvision Sensor:
- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera.
- **host** (*Required*): The IP address of the camera you would like to connect to.
- **port** (*Optional*): The port to connect to the camera on, defaults to 80.
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
- **username** (*Required*): The username to authenticate with.
- **password** (*Required*): The password to authenticate with.
- **name** (*Optional*): The name you'd like to give the camera in Home Assistant, defaults to name defined in the camera.
- **port** (*Optional*): The port to connect to the camera on, defaults to 80.
- **ssl** (*Optional*): True if you want to connect with https. Be sure to set the port also.
- **customize** (*Optional*): This attribute contains sensor-specific override values. Only sensor name needs defined:
- **ignored** (*Optional*): Ignore this sensor completely. It won't be shown in the Web Interface and no events are generated for it.
- **delay** (*Optional*): Specify the delay to wait after a sensor event ends before notifying Home Assistant. This is useful to catch multiple quick trips in one window without the state toggling on and off. The default delay is 5 seconds.
Supported sensor/event types are:
- Motion
- Line Crossing
- Field Detection
@ -84,37 +86,36 @@ Supported sensor/event types are:
- Face Detection
- Scene Change Detection
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a camera:
```yaml
binary_sensor:
platform: hikvision
host: 192.168.X.X
port: 80
ssl: False
username: user
password: pass
customize:
motion:
delay: 30
line_crossing:
ignored: True
- platform: hikvision
host: 192.168.X.X
port: 80
ssl: False
username: user
password: pass
customize:
motion:
delay: 30
line_crossing:
ignored: True
```
Example of a configuration in your `configuration.yaml` that utilizes the customize options for a nvr:
```yaml
binary_sensor:
platform: hikvision
host: 192.168.X.X
port: 80
ssl: False
username: user
password: pass
customize:
motion_1:
delay: 30
field_detection_2:
ignored: True
- platform: hikvision
host: 192.168.X.X
port: 80
ssl: False
username: user
password: pass
customize:
motion_1:
delay: 30
field_detection_2:
ignored: True
```

6
source/_components/binary_sensor.mqtt.markdown
View File

@ -17,6 +17,8 @@ The `mqtt` binary sensor platform uses an MQTT message payload to set the binary
The binary sensor state will be updated only after a new message is published on `state_topic` matching `payload_on` or `payload_off`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`.
## {% linkable_title Configuration %}
The `mqtt` binary sensor platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT cover device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability_topic` is defined, Home Assistant will consider the MQTT device to be available.
To use an MQTT binary sensor in your installation, add the following to your `configuration.yaml` file:
@ -42,12 +44,12 @@ payload_on:
description: The payload that represents the on state.
required: false
type: string
default: ON
default: "ON"
payload_off:
description: The payload that represents the off state.
required: false
type: string
default: OFF
default: "OFF"
availability_topic:
description: "The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor availability state will always be `available`. If `availability_topic` is defined, the binary sensor availability state will be `unavailable` by default."
required: false

53
source/_components/calendar.google.markdown
View File

@ -14,7 +14,7 @@ ha_release: 0.33
---
This platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file *google_calendars.yaml* that will contain information about all of the calendars you can see.
The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see.
### {% linkable_title Prerequisites %}
@ -27,7 +27,7 @@ Generate a Client ID and Client Secret on [Google Developers Console](https://co
1. Save this page. You don't have to fill out anything else there.
1. Click 'Create credentials' -> OAuth client ID.
1. Set the Application type to 'Other' and give this credential set a name then click Create.
1. Save the client ID and secret as you will need to put these in your configuration.yaml file.
1. Save the client ID and secret as you will need to put these in your `configuration.yaml` file.
1. Click on "Library", search for "Google Calendar API" and enable it.
### {% linkable_title Basic Setup %}
@ -37,33 +37,43 @@ To integrate Google Calendar in Home Assistant, add the following section to you
```yaml
# Example configuration.yaml entry
google:
client_id: *Value_created_from_steps_above*
client_secret: *Value_created_from_steps_above*
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
```
Configuration variables:
- **client_id** (*Required*): Use the value you generated in the Prerequisites stage.
- **client_secret** (*Required*): Use the value you generated in the Prerequisites stage.
- **track_new_calendar** (*Optional*): Will automatically generate a binary sensor when a new calendar is detected. The system scans for new calendars on startup. By default this is set to `True`.
{% configuration %}
client_id:
description: Use the value you generated in the Prerequisites stage.
required: true
type: string
minimum:
description: Use the value you generated in the Prerequisites stage.
required: true
type: string
track_new_calendar:
description: Will automatically generate a binary sensor when a new calendar is detected. The system scans for new calendars only on startup.
required: false
type: boolean
default: true
{% endconfiguration %}
The next steps will require you to have Home Assistant running.
After you have it running complete the Google authentication that pops up. It will give you a URL and a code to enter. This will grant your Home Assistant service access to all the Google Calendars that the account you authenticate with can read. This is a Read-Only view of these calendars.
### {% linkable_title Calendar Configuration %}
Editing `google_calendars.yaml`
Editing the `google_calendars.yaml` file.
A basic entry for a single calendar looks like:
```yaml
- cal_id: "***************************@group.calendar.google.com"
- cal_id: "*****@group.calendar.google.com"
entities:
- device_id: test_everything
name: Give me everything
track: true
- cal_id: "***************************@group.calendar.google.com"
- cal_id: "*****@group.calendar.google.com"
entities:
- device_id: test_important
name: Important Stuff
@ -79,38 +89,27 @@ A basic entry for a single calendar looks like:
Variables:
- **cal_id**: The Google generated unique id for this calendar. **DO NOT CHANGE**
- **entities**: Yes, you can have multiple sensors for a calendar!
- **device_id**: (*Required*): The name that all your automations/scripts will use to reference this device.
- **name**: (*Required*): What is the name of your sensor that you'll see in the frontend.
- **track**: (*Required*): Should we create a sensor `True` or ignore it `False`?
- **search**: (*Optional*): If set will only trigger for matched events.
- **offset**: (*Optional*): A set of characters that precede a number in the event title for designating a pre-trigger state change on the sensor. (Default: `!!`)
From this we will end up with the binary sensors `calendar.test_unimportant` and `calendar.test_important` which will toggle themselves on/off based on events on the same calendar that match the search value set for each. You'll also have a sensor `calendar.test_everything` that will not filter events out and always show the next event available.
But what if you only wanted it to toggle based on all events? Just leave out the *search* parameter.
**Note**: If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment.
<p class='note warning'>
If you use a `#` sign for `search` then wrap the whole search term in quotes. Otherwise everything following the hash sign would be considered a YAML comment.
</p>
### {% linkable_title Sensor attributes %}
- **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts.
- **all_day**: `True`/`False` if this is an all day event. Will be `False` if there is no event found.
- **message**: The event title with the `search` and `offset` values extracted. So in the above example for **offset_reached** the **message** would be set to `Very important meeting`
- **description**: The event description.
- **location**: The event Location.
- **start_time**: Start time of event.
- **end_time**: End time of event.

7
source/_components/camera.foscam.markdown
View File

@ -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.

12
source/_components/camera.synology.markdown
View File

@ -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
```

8
source/_components/canary.markdown
View File

@ -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
source/_components/cover.garadget.markdown
View File

@ -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.

22
source/_components/cover.myq.markdown
View File

@ -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`.

56
source/_components/deconz.markdown
View File

@ -17,19 +17,7 @@ ha_iot_class: "Local Push"
[deCONZ REST API](http://dresden-elektronik.github.io/deconz-rest-doc/).
Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file.
If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to Menu->Settings->Unlock Gateway in deCONZ and then use the deCONZ configurator in Home Assistant GUI to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in deconz.conf inside the home-assistant folder.
You can add the following to your configuration.yaml file if you are not using the `discovery:` component:
```yaml
# Example configuration.yaml entry
deconz:
host: IP ADDRESS
```
#### {% linkable_title Supported Device types %}
### {% linkable_title Supported device types %}
- [Zigbee Lights](/components/light.deconz/)
- [Consumption Sensors](/components/sensor.deconz/)
@ -42,6 +30,20 @@ deconz:
- [Switches (Remote Controls)](/components/sensor.deconz/)
- [Temperature Sensors](/components/sensor.deconz/)
## {% linkable_title Configuration %}
Home Assistant will automatically discover deCONZ presence on your network, if `discovery:` is present in your `configuration.yaml` file.
If you don't have the API key, you can generate an API key for deCONZ by using the one-click functionality similar to Philips Hue. Go to **Menu** -> **Settings** -> **Unlock Gateway** in deCONZ and then use the deCONZ configurator in Home Assistant frontend to create an API key. When you've generated the API key from Home Assistant, the API key will be stored in `deconz.conf` inside the `.homeassistant` folder.
You can add the following to your configuration.yaml file if you are not using the `discovery:` component:
```yaml
# Example configuration.yaml entry
deconz:
host: IP_ADDRESS
```
{% configuration %}
host:
description: The IP address of your deCONZ web server.
@ -68,10 +70,24 @@ deconz:
port: 80
```
## {% linkable_title Debugging component %}
If you have problems with deCONZ or the component you can add debug prints to the log.
```yaml
logger:
default: info
logs:
pydeconz: debug
   homeassistant.components.deconz: debug
```
## {% linkable_title Device services %}
Available services: `configure`.
#### {% linkable_title Service `deconz/configure` %}
#### {% linkable_title Service `deconz.configure` %}
Set attribute of device in Deconz using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/).
| Service data attribute | Optional | Description |
@ -88,7 +104,7 @@ Field and entity are exclusive, i.e you can only use one in a request.
{ "field": "/config", "data": {"permitjoin": 60} }
## {% linkable_title Remote control devices%}
## {% linkable_title Remote control devices %}
Remote controls (ZHASwitch category) will be not be exposed as a regular entity, but as events named 'deconz_event' with a payload of 'id' and 'event'. Id will be the device name from deCONZ and Event will be the momentary state of the switch. However, a sensor entity will be created that shows the battery level of the switch as reported by deCONZ, named sensor.device_name_battery_level.
@ -109,6 +125,7 @@ For the IKEA Tradfri remote, 1 is the middle button, 2 is up, 3 is down, 4 is le
### {% linkable_title Step up and step down input number with wireless dimmer %}
{% raw %}
```yaml
automation:
- alias: 'Toggle lamp from dimmer'
@ -135,9 +152,9 @@ automation:
- service: light.turn_on
data_template:
entity_id: light.lamp
brightness: {% raw %}>
brightness: >
{% set bri = states.light.lamp.attributes.brightness | int %}
{{ [bri+30, 249] | min }}{% endraw %}
{{ [bri+30, 249] | min }}
- alias: 'Decrease brightness of lamp from dimmer'
initial_state: 'on'
@ -151,7 +168,8 @@ automation:
- service: light.turn_on
data_template:
entity_id: light.lamp
brightness: {% raw %}>
brightness: >
{% set bri = states.light.lamp.attributes.brightness | int %}
{{ [bri-30, 0] | max }}{% endraw %}
{{ [bri-30, 0] | max }}
```
{% endraw %}

29
source/_components/device_tracker.huawei_router.markdown
View File

@ -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.

17
source/_components/device_tracker.trackr.markdown
View File

@ -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.

4
source/_components/doorbird.markdown
View File

@ -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:

28
source/_components/dyson.markdown
View File

@ -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.*

26
source/_components/eight_sleep.markdown
View File

@ -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 %}

4
source/_components/foursquare.markdown
View File

@ -31,7 +31,7 @@ Configuration variables:
#### Getting the access token ####
After you have registered your APP on your [My Apps Page](https://foursquare.com/developers/apps) you get a `CLIENT_ID` and you have specified a
`REDIRECT_URL` which can be any URL you like, but since it will get your access token via a HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant.
`REDIRECT_URL` which can be any URL you like, but since it will get your access token via an HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant.
Visit the following URL in your browser:
```
@ -40,7 +40,7 @@ https://foursquare.com/oauth2/authenticate?client_id=CLIENT_ID&response_type=tok
and change the `CLIENT_ID` and `YOUR_REGISTERED_REDIRECT_URL` to your actual values.
You will receive an OAuth request landing page, asking you if you want to connect your Foursquare account to your newly created app. Say "Yes".
After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as a HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`.
After that, you will get redirected to your `REDIRECT_URL` with the `access_token` as an HTTP GET variable. Copy everything after the = and paste it in your configuration.yaml as the `access_token`.
### {% linkable_title Real-Time API %}

2
source/_components/frontend.markdown
View File

@ -135,7 +135,7 @@ Those will be loaded via `<link rel='import' href='{{ extra_url }}' async>` on a
### {% linkable_title Manual Language Selection %}
The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select a one from "Choose a Language". It will be applied immediately.
The browser language is automatically detected. To use a different language, go to **General** in the Configuration panel and select one from "Choose a Language". It will be applied immediately.
<p class='img'>
<img src='/images/frontend/choose-language.png' />

4
source/_components/goalfeed.markdown
View File

@ -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 %}

2
source/_components/google_assistant.markdown
View File

@ -67,7 +67,7 @@ agent_user_id:
required: false
type: string
api_key:
description: An API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see step 9 below). If not provided then the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have setup this componenet you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration.
description: An API Key generated for the project from [Google Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see step 9 below). If not provided then the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have setup this component you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration.
required: false
type: string
expose_by_default:

2
source/_components/image_processing.dlib_face_identify.markdown
View File

@ -13,7 +13,7 @@ featured: false
ha_release: 0.44
---
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire a event with identify persons.
The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons.
For using the result inside an automation rule, take a look at the [component](/components/image_processing/) page.

2
source/_components/knx.markdown
View File

@ -116,7 +116,7 @@ knx:
```
* **type**: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity").
* **entity_id**: Entity id of the HASS component to be exposed. Not necessarry for types time and datetime.
* **entity_id**: Entity id of the HASS component to be exposed. Not necessary for types time and datetime.
* **address**: KNX group address.

2
source/_components/light.avion.markdown
View File

@ -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:

19
source/_components/light.decora_wifi.markdown
View File

@ -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 %}

21
source/_components/lock.nello.markdown
View File

@ -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 %}

20
source/_components/lock.sesame.markdown
View File

@ -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.

2
source/_components/lutron.markdown
View File

@ -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:

8
source/_components/media_player.cmus.markdown
View File

@ -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

2
source/_components/media_player.firetv.markdown
View File

@ -16,7 +16,7 @@ ha_iot_class: "Local Polling"
The `firetv` platform allows you to control a [Amazon Fire TV/stick](http://www.amazon.com/Amazon-DV83YW-Fire-TV/dp/B00U3FPN4U).
The python-firetv Python 2.x module with its helper script that exposes a HTTP server to fetch state and perform actions is used.
The python-firetv Python 2.x module with its helper script that exposes an HTTP server to fetch state and perform actions is used.
Steps to configure your Amazon Fire TV stick with Home Assistant:

4
source/_components/media_player.markdown
View File

@ -9,7 +9,7 @@ sharing: true
footer: true
---
Interacts with media players on your network. Please check the sidebar for a full list of supported devices.
Interacts with media players on your network. Please check the right sidebar for a full list of supported devices.
## {% linkable_title Services %}
@ -27,7 +27,7 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`,
| `entity_id` | yes | Target a specific media player. Defaults to all. |
| `is_volume_muted` | no | True/false for mute/unmute |
#### {% linkable_title Service `media_player/volume_set` %}
#### {% linkable_title Service `media_player.volume_set` %}
| Service data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------|

4
source/_components/media_player.ue_smart_radio.markdown
View File

@ -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 %}

6
source/_components/melissa.markdown
View File

@ -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 adress>
password: ********
username: YOUR_MELISSA_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}

18
source/_components/mercedesme.markdown
View File

@ -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'>

2
source/_components/mqtt_eventstream.markdown
View File

@ -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

2
source/_components/mqtt_statestream.markdown
View File

@ -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

46
source/_components/mychevy.markdown
View File

@ -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.

20
source/_components/neato.markdown
View File

@ -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>

2
source/_components/notify.gntp.markdown
View File

@ -30,7 +30,7 @@ Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **app_name** (*Optional*): The application name that will be displayed on every notification and will be registered with the server.
- **app_icon** (*Optional*): The icon that will be displayed on every notification. You can provide a HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use a HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering.
- **app_icon** (*Optional*): The icon that will be displayed on every notification. You can provide an HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use an HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering.
- **hostname** (*Optional*): The hostname or IP address of the GNTP server to contact.
- **password** (*Optional*): The password to authenticate to the GNTP server with.
- **port** (*Optional*): The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case.

6
source/_components/notify.matrix.markdown
View File

@ -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
source/_components/notify.rocketchat.markdown
View File

@ -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/).

8
source/_components/nuheat.markdown
View File

@ -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

19
source/_components/rainbird.markdown
View File

@ -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.

20
source/_components/raincloud.markdown
View File

@ -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.

18
source/_components/ring.markdown
View File

@ -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.

8
source/_components/sensor.command_line.markdown
View File

@ -61,6 +61,7 @@ sensor:
Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, various details about a system can be retrieved. Here the CPU temperature is of interest. Add something similar to your `configuration.yaml` file:
{% raw %}
```yaml
# Example configuration.yaml entry
sensor:
@ -69,8 +70,9 @@ sensor:
command: "cat /sys/class/thermal/thermal_zone0/temp"
# If errors occur, remove degree symbol below
unit_of_measurement: "°C"
value_template: '{% raw %}{{ value | multiply(0.001) }}{% endraw %}'
value_template: '{{ value | multiply(0.001) | round(1) }}'
```
{% endraw %}
### {% linkable_title Monitoring failed login attempts on Home Assistant %}
@ -149,11 +151,13 @@ sensor:
[Templates](/docs/configuration/templating/) are supported in the `command:` configuration variable. This could be used if you want to include the state of a specific sensor as an argument to your external script.
{% raw %}
```yaml
# Example configuration.yaml entry
sensor:
- platform: command_line
name: wind direction
command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {% raw %}{{ states.sensor.wind_direction.state }}{% endraw %}'
command: 'sh /home/pi/.homeassistant/scripts/wind_direction.sh {{ states.sensor.wind_direction.state }}'
unit_of_measurement: "Direction"
```
{% endraw %}

11
source/_components/sensor.hp_ilo.markdown
View File

@ -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

4
source/_components/sensor.imap.markdown
View File

@ -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:

8
source/_components/sensor.mfi.markdown
View File

@ -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:

26
source/_components/sensor.mopar.markdown
View File

@ -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 %}

2
source/_components/sensor.random.markdown
View File

@ -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

2
source/_components/sensor.rest.markdown
View File

@ -151,7 +151,7 @@ sensor:
unit_of_measurement: "°C"
```
### {% linkable_title Accessing a HTTP authentication protected endpoint %}
### {% linkable_title Accessing an HTTP authentication protected endpoint %}
The REST sensor supports HTTP authentication and customized headers.

6
source/_components/sensor.sma.markdown
View File

@ -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:

6
source/_components/sensor.synologydsm.markdown
View File

@ -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

20
source/_components/shiftr.markdown
View File

@ -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 %}

6
source/_components/skybell.markdown
View File

@ -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 %}

17
source/_components/sleepiq.markdown
View File

@ -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.

2
source/_components/switch.fritzdect.markdown
View File

@ -41,7 +41,7 @@ Configuration variables:
- **password** (*Required*): The password for your Fritz!Box.
- **host** (*Optional*): The IP address/hostname of your Fritz!Box. Defaults to `fritz.box`.
It is recommened to create a dedicated user for Home Assistant and only allow access to "Smart Home".
It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home".
<p class='note warning'>
If this component throws an error when starting home-assistant you should check if all actors are plugged in and connected to the FritzBox. Inactive actors that are not deleted from FritzBox configuration might lead to errors.

31
source/_components/switch.hook.markdown
View File

@ -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

2
source/_components/switch.kankun.markdown
View File

@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
The `kankun` switch platform allows you to toggle customized Kankun SP3 Wifi switches. Switches are
modified to include the [json.cgi](https://github.com/homedash/kankun-json/blob/master/cgi-bin/json.cgi)
script to provide a HTTP API. Details of the necessary modifications can be found
script to provide an HTTP API. Details of the necessary modifications can be found
[here](http://www.homeautomationforgeeks.com/openhab_http.shtml#kankun) (be sure to install the JSON version
of the script as linked above).

8
source/_components/switch.mfi.markdown
View File

@ -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:

69
source/_components/switch.rainmachine.markdown
View File

@ -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.

2
source/_components/tellstick.markdown
View File

@ -30,6 +30,6 @@ tellstick:
Configuration variables:
- **signal_repetitions** (*Optional*): Because the tellstick sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch and light to try to send each signal repeatedly.
- **host** (*Optional*): If you run tellstick on a other server or with a hass.io add-on.
- **host** (*Optional*): If you run tellstick on another server or with a hass.io add-on.
- **port** (*Optional*): If needed with host config option. Must be port pair, for example `[50800, 50801]`.

4
source/_components/tesla.markdown
View File

@ -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:

19
source/_components/volvooncall.markdown
View File

@ -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:

43
source/_components/waterfurnace.markdown
View File

@ -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.

4
source/_components/zoneminder.markdown
View File

@ -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
```

2
source/_cookbook/custom_panel_using_react.markdown
View File

@ -20,7 +20,7 @@ This is a [React](https://facebook.github.io/react/) implementation of [TodoMVC]
Download the source [here](https://github.com/home-assistant/example-custom-config/blob/master/panels/react.html). Copy the file to `<config dir>/panels/` (you might have to create the directory if it doesn't exist).
Create a entry for the panel in your `configuration.yaml` file to enable it.
Create an entry for the panel in your `configuration.yaml` file to enable it.
```yaml
panel_custom:

2
source/_docs/configuration/customizing-devices.markdown
View File

@ -78,7 +78,7 @@ Device class is currently supported by the following platforms:
### {% linkable_title Reloading customize %}
Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant/reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> service developer tools, select the service `homeassistant/reload_core_config` and click "Call Service".
Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant.reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> service developer tools, select the service `homeassistant.reload_core_config` and click "CALL SERVICE".
<p class='note warning'>
New customize information will be applied the next time the state of the entity gets updated.

4
source/_docs/configuration/templating.markdown
View File

@ -83,10 +83,10 @@ Home Assistant adds extensions to allow templates to access all of the current s
- Filter `timestamp_local` will convert an UNIX timestamp to local time/data.
- Filter `timestamp_utc` will convert an UNIX timestamp to UTC time/data.
- Filter `timestamp_custom(format_string, local_boolean)` will convert an UNIX timestamp to a custom format, the use of a local timestamp is default, supporting [Python format options](https://docs.python.org/3/library/time.html#time.strftime).
- Filter `max` will obtain the larget item in a sequence.
- Filter `max` will obtain the largest item in a sequence.
- Filter `min` will obtain the smallest item in a sequence.
[strp-format]: https://docs.python.org/3.4/library/datetime.html#strftime-and-strptime-behavior
[strp-format]: https://docs.python.org/3.6/library/datetime.html#strftime-and-strptime-behavior
<p class='note'>
If your template uses an `entity_id` that begins with a number (example: `states.device_tracker.2008_gmc`) you must use a bracket syntax to avoid errors caused by rendering the `entity_id` improperly. In the example given, the correct syntax for the device tracker would be: `states.device_tracker['2008_gmc']`

2
source/_docs/installation/docker.markdown
View File

@ -80,7 +80,7 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB Stick with Home Assista
### {% linkable_title QNAP NAS %}
As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatability-information, if your NAS is supported), see https://www.qnap.com/solution/container_station/en/index.php
As QNAP within QTS now supports Docker (with a neat UI), you can simply install Home Assistant using docker without the need for command-line. For details about the package (including compatibility-information, if your NAS is supported), see https://www.qnap.com/solution/container_station/en/index.php
The steps would be:

11
source/_docs/installation/virtualenv.markdown
View File

@ -17,7 +17,7 @@ It's recommended when installing Python packages that you use a [virtual environ
_(If you're on a Debian based system, you will need to install Python virtual environment support using `apt-get install python3-pip python3-venv`.)_
<p class='Note'>
It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/) which allows for the installation to run as a `homeassistant` user. The steps below may be shorter but some users find difficulty when applying updates and may run into issues.
It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/) which allows for the installation to run as a `homeassistant` user. The steps below may be shorter but some users find difficulty when applying updates and may run into issues.
</p>
### {% linkable_title Install %}
@ -74,3 +74,12 @@ It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/)
<p class='info'>
Looking for more advanced guides? Check our [Rasbian guide](/docs/installation/raspberry-pi/) or the [other installation guides](/docs/installation/).
</p>
### {% linkable_title After upgrading Python %}
If you've upgraded Python (for example, you were running 3.5.2 and now you've installed 3.5.4) then you'll need to build a new virtual environment. Simply rename your existing virtual environment directory:
```bash
$ mv homeassistant homeassistant.old
```
Then follow the [Install](/docs/installation/virtualenv/#install) steps again, being sure to use the newly installed version of Python.

2
source/_posts/2018-03-24-new-release-schedule.markdown
View File

@ -21,7 +21,7 @@ So this weekend we're going to shake things a little up. Instead of releasing a
Diagram of the new release schedule
</p>
The goal is to create a more stable first release without the need for a quick follow up hot fix. So if you want to be able to access the new features faster but don't mind the risk of running into the occassional bug, get yourself on the beta channel today:
The goal is to create a more stable first release without the need for a quick follow up hot fix. So if you want to be able to access the new features faster but don't mind the risk of running into the occasional bug, get yourself on the beta channel today:
- Hass.io users will be able to enable the dev channel in the system settings.
- For Docker users, the beta's will be published under the `rc` tag.

6
source/help/index.markdown
View File

@ -21,11 +21,13 @@ There are various ways to get in touch with the Home Assistant community. It doe
### {% linkable_title Bugs, Feature requests, and alike %}
Have you found an issue in your Home Assistant installation? Please report it. Reporting it makes it easy to track and ensures that it gets fixed.
Have you found an issue in your Home Assistant installation? Please report it. Reporting it makes it easy to track and ensures that it gets fixed. For more details please refer to [Reporting issues](/help/reporting_issues/) page.
- [Issue tracker Home Assistant](https://github.com/home-assistant/home-assistant/issues)
- [Issue tracker home-assistant.io](https://github.com/home-assistant/home-assistant.io/issues) (Website and documentation)
- [Feature requests Home Assistant](https://community.home-assistant.io/c/feature-requests)
- [Issue tracker Frontend](https://github.com/home-assistant/home-assistant-polymer/issues) (Frontend)
- [Issue tracker Hass.io](https://github.com/home-assistant/hassio/issues)
- [Feature requests Home Assistant](https://community.home-assistant.io/c/feature-requests) (Don't post feature requests in the issue trackers. Thanks.)
### {% linkable_title Videos, talks, workshops and alike %}

72
source/help/reporting_issues.markdown Normal file
View File

@ -0,0 +1,72 @@
---
layout: page
title: "Reporting issues"
description: "Reporting issues about Home Assistant"
date: 2018-03-26 09:00
sidebar: false
comments: false
sharing: true
footer: true
---
If you have an installation, a setup or a configuration issue please use our [Forum](https://community.home-assistant.io/) to get help. We have a big community which will help you if they can.
If you found a bug then please report it in one of our [trackers](help/#bugs-feature-requests-and-alike). To help you and our developers to identify the issue quickly, please fill out the provided template. The "weird" content you will see is there to render your entry in a nice format after submitting. It's just [markddown](https://guides.github.com/features/mastering-markdown/).
Use the command below to get the Home Assistant release you are running from a command-line.
```bash
$ hass --version
```
Otherwise check the **About** page which is accessible in the **Developer tools** of the Home Assistant frontend.
### {% linkable_title First Home Assistant release with the issue %}
Please provide the release which contains the issue.
### {% linkable_title Last working Home Assistant release (if known) %}
If possible, provide the latest release of which you know that the component or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change.
### {% linkable_title Operating environment (Hass.io/Docker/Windows/etc.) %}
There are many different ways to run Home Assistant. In this section please mention which you are using, e.g. manual installation, [Hass.io](/hassio/), Hasbian or as container (Docker). It can help if you mention which operating system you are using because not all are supported on the same level.
### {% linkable_title Component/platform %}
Please add the link to the documention of the component/platform in question. E.g.,
- issue with the `random` sensor: [https://www.home-assistant.io/components/sensor.random/](/components/sensor.random/)
- issue with the `hue` component: [https://www.home-assistant.io/components/hue/](/components/hue/)
### {% linkable_title Description of problem %}
Provide a summary of your issue and tell us what's wrong.
There are components and platform which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed.
### {% linkable_title Problem-relevant `configuration.yaml` entries %}
To exclude configuration issues and allow the developers to quickly test, and perhaps reproduce, your issue, add the relevant part of your `configuration.yaml` file. This file is located in your [configuration folder](/docs/configuration/).
```yaml
sensor:
- platform: random
```
Make sure that you don't post your username, password, API key, access token or other [secrets](/docs/configuration/secrets/).
### {% linkable_title Traceback (if applicable) %}
If things go wrong there will be a so-called traceback or an error message in other words in your log. Please include this. It starts with **Traceback** and can contain informations where the error was triggered in the code.
```bash
Traceback (most recent call last):
...
```
### {% linkable_title Additional information %}
This section can contain additional details or other observation. Often the little things can help as well.