jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Merge branch 'current' into next

Browse source
This commit is contained in:
Paulus Schoutsen 2018-04-13 17:59:14 -04:00
commit e7c121f462
33 changed files with 680 additions and 135 deletions
Download patch file Download diff file Expand all files Collapse all files

2
source/_components/device_tracker.unifi.markdown
View file

@ -80,7 +80,7 @@ The Unifi controller allows you to create multiple users on it besides the main
The Unifi controller can either be a dedicated hardware device (Unifi's cloud key), or as software any Linux system. If you run the the Unifi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT component as well.
It is recommended that you run the Unifi controller in a dedicate virtual machine to avoid that situation.
It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation.
### {% linkable_title Troubleshooting and Time Synchronization %}

4
source/_components/folder_watcher.markdown
View file

@ -1,6 +1,6 @@
---
layout: page
title: "folder watcher"
title: "Folder Watcher"
description: "Component for monitoring changes within the filesystem."
date: 2018-03-11 14:00
sidebar: true
@ -32,7 +32,7 @@ folder:
patterns:
description: Pattern matching to apply
required: false
default: "*"
default: "*"
type: string
{% endconfiguration %}

6
source/_components/homekit.markdown
View file

@ -15,7 +15,7 @@ logo: apple-homekit.png
The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they could be controlled from Apple `Home` app and `Siri`. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later.
<p class="note warning">
It might be necessary to install an additional package:
It might be necessary to install an additional package:
`$ sudo apt-get install libavahi-compat-libdnssd-dev`
</p>
@ -154,7 +154,7 @@ automation:
## {% linkable_title Configure Filter %}
By default no entity will be excluded. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
By default no entity will be excluded. To limit which entities are being exposed to `HomeKit`, you can use the `filter` parameter. Keep in mind only [supported components](#supported-components) can be added.
{% raw %}
```yaml
@ -184,7 +184,7 @@ Filters are applied as follows:
- if both include and exclude domains specified, the exclude domains are ignored
* Neither include or exclude domain specified
- if entity is included, pass (as #2 above)
- if entity include and exclude, the entity exclude is ignored
- if entity include and exclude, the entity exclude is ignored
## {% linkable_title Supported Components %}

2
source/_components/http.markdown
View file

@ -90,7 +90,7 @@ Please note, that sources from `trusted_networks` won't be banned automatically.
## {% linkable_title Hosting files %}
If you want to use Home Assistant to host or serve static files then create a directory called `www` under the configuration path (`/config` on Hass.io, `.homeassistant` elswhere). The static files in `www/` can be accessed by the following URL `http://your.domain:8123/local/`, for example `audio.mp3` would be accessed as `http://your.domain:8123/local/audio.mp3`.
If you want to use Home Assistant to host or serve static files then create a directory called `www` under the configuration path (`/config` on Hass.io, `.homeassistant` elsewhere). The static files in `www/` can be accessed by the following URL `http://your.domain:8123/local/`, for example `audio.mp3` would be accessed as `http://your.domain:8123/local/audio.mp3`.
<p class='note'>
If you've had to create the `www/` folder for the first time, you'll need to restart Home Assistant.

17
source/_components/ios.markdown Normal file
View file

@ -0,0 +1,17 @@
---
layout: page
title: "iOS"
description: "Instructions on how to use the iOS companion app with Home Assistant."
date: 2018-04-06 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: apple.png
ha_category: Hub
featured: false
ha_release: 0.31
ha_iot_class: depends
---
The `ios` component is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details.

4
source/_components/mqtt.markdown
View file

@ -33,6 +33,10 @@ mqtt:
broker: IP_ADDRESS_BROKER
```
<p class='note'>
The minimal setup uses the embedded MQTT broker, however a separate broker is advised for more stability.
</p>
## {% linkable_title Additional features %}
- [Certificate](/docs/mqtt/certificate/)

27
source/_components/qwikswitch.markdown
View file

@ -60,13 +60,32 @@ On some QS Mobile servers button events are only generated for switches added to
### {% linkable_title Qwikswitch Sensors %}
Some Qwikswith devices might support more than one channel per device (i.e. ipmod). The channel can be specified by appending a number to the QS_id. Example sensors configuration:
The sensor configuration is a list of sensors. Each sensor is configured with the following parameters:
- **name** (*Required*): The sensor name from which the entity_id will be derived.
- **id** (*Required*): A QS_Id
- **type** (*Required*): The Qwikswitch sensor type. These could include:
- imod (up to 6 channels)
- door (single channel)
- qwikcord (Channel1 = CTavg, Channel 2 = CTsum)
- **channel** (*Optional, default=1*): The channel of interest. Refer to type above.
Example sensor configuration:
```yaml
qwikswitch:
...
sensors:
door_sensor: '@0dev01'
door2_sensor: '@0dev02.1'
door3_sensor: '@0dev02.2'
- name: door sensor
id: "@id03"
type: door
- name: Imod 1 sensor
id: "@id02"
channel: 1
type: imod
- name: Imod 2 sensor
id: "@id02"
channel: 2
type: imod
```

9
source/_components/sensor.mqtt.markdown
View file

@ -171,7 +171,12 @@ sensor:
### {% linkable_title Get sensor value from a device with ESPEasy %}
Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" set a name ("Unit Name:") for your device (here it's "bathroom"). A "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example the topics are prefixed with "home". Also, add a sensor in the "Devices" tap with the name "analog" and "brightness" as value.
Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" set a name ("Unit Name:") for your device (here it's "bathroom"). A "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example the topics are prefixed with "home". Please keep in mind that the ESPEasy default topics start with a `/` and only contain the name when writing your entry for the `configuration.yaml` file.
- **Controller Subscribe**: `home/%sysname%/#` (instead of `/%sysname%/#`)
- **Controller Publish**: `home/%sysname%/%tskname%/%valname%` (instead of `/%sysname%/%tskname%/%valname%`)
Also, add a sensor in the "Devices" tap with the name "analog" and "brightness" as value.
As soon as the unit is online, you will get the state of the sensor.
@ -192,5 +197,3 @@ sensor:
name: Brightness
```
{% endraw %}

18
source/_components/sensor.qwikswitch.markdown Normal file
View file

@ -0,0 +1,18 @@
---
layout: page
title: "QwikSwitch Sensor"
description: "Instructions on how to integrate Qwikswitch dimmers and relays as sensors into Home Assistant."
date: 2016-05-04 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: qwikswitch.png
ha_category: Sensor
ha_iot_class: "Local Push"
ha_release: "0.67"
---
The `qwikswitch` sensor platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays and dimmers as sensors from within Home Assistant.
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).

16
source/_components/sensor.tradfri.markdown Normal file
View file

@ -0,0 +1,16 @@
---
layout: page
title: "IKEA Trådfri sensors"
description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Sensors."
date: 2017-04-12 22.04
sidebar: true
comments: false
sharing: true
footer: true
logo: ikea.svg
ha_category: Sensor
ha_iot_class: "Local Polling"
ha_release: 0.67
---
For installation instructions, see [the Trådfri component](/components/tradfri/).

33
source/_components/smappee.markdown
View file

@ -12,41 +12,42 @@ ha_release: "0.64"
ha_category: Hub
---
[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.
The `smappee` component adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.
Switches and Sensors are supported - and will be automatically added when you connect to the Smappee controller.
The smappee component gets information from [Smappee API](https://smappee.atlassian.net/wiki/display/DEVAPI/API+Methods) using the [smappy](https://github.com/EnergieID/smappy) pypy module
The smappee component gets information from [Smappee API](https://smappee.atlassian.net/wiki/display/DEVAPI/API+Methods).
<p class='note'>
Info on how to get api access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki)
</p>
## {% linkable_title Configuration %}
Info on how to get API access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki).
To use the `smappee` component in your installation, add the following to your `configuration.yaml` file:
# Configuration
```yaml
# Example configuration.yaml entry
smappee:
host: 10.0.0.5
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
username: YOUR_MYSMAPPEE_USERNAME
password: YOUR_MYSMAPPEE_PASSWORD
host: 10.0.0.5
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
username: YOUR_MYSMAPPEE_USERNAME
password: YOUR_MYSMAPPEE_PASSWORD
```
```yaml
# Minimal example configuration.yaml entry
smappee:
host: 10.0.0.5
host: 10.0.0.5
```
```yaml
# Cloud only example configuration.yaml entry
smappee:
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
username: YOUR_MYSMAPPEE_USERNAME
password: YOUR_MYSMAPPEE_PASSWORD
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
username: YOUR_MYSMAPPEE_USERNAME
password: YOUR_MYSMAPPEE_PASSWORD
```
Configuration variables:

21
source/_components/switch.vesync.markdown
View file

@ -12,7 +12,9 @@ ha_category: Switch
ha_release: 0.66
---
The `vesync` switch platform enabled integration with Etekcity VeSync smart switches.
The `vesync` switch platform enables integration with Etekcity VeSync smart switches.
VeSync switches are low-cost wifi smart plugs that offer energy monitoring and work with popular voice assistants.
To use your VeSync switches, you must first register your switches with the VeSync app. Once registration is complete you must add the following to your `configuration.yaml` file:
@ -20,8 +22,8 @@ To use your VeSync switches, you must first register your switches with the VeSy
# Example configuration.yaml entry
switch:
- platform: vesync
username: username
password: password
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
@ -34,3 +36,16 @@ password:
required: true
type: string
{% endconfiguration %}
### {% linkable_title Exposed Attributes %}
VeSync switches will expose the following details.
| Attribute | Description | Example |
| ------------------- | ------------------------------------------------------------------- | --------------- |
| `current_power_w` | The present power consumption of the switch in watts. | 100 |
| `today_energy_kwh` | The kilowatt hours used by the switch during the previous 24 hours. | 0.12 |
| `connection_status` | The connection status of the switch. | online |
| `connection_type` | The connection type of the switch. | wifi |
| `device_type` | The device type of the switch. | wifi-switch-1.3 |
| `model` | The model of the switch. | wifi-switch |

18
source/_components/vacuum.markdown
View file

@ -27,7 +27,7 @@ Available services: `turn_on`, `turn_off`, `start_pause`, `stop`, `return_to_hom
Before calling one of these services, make sure your botvac platform supports it.
#### {% linkable_title Service `vacuum/turn_on` %}
#### {% linkable_title Service `vacuum.turn_on` %}
Start a new cleaning task.
@ -35,7 +35,7 @@ Start a new cleaning task.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/turn_off` %}
#### {% linkable_title Service `vacuum.turn_off` %}
Stop the current cleaning task and return to the dock.
@ -43,7 +43,7 @@ Stop the current cleaning task and return to the dock.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/start_pause` %}
#### {% linkable_title Service `vacuum.start_pause` %}
Start, pause or resume a cleaning task.
@ -51,7 +51,7 @@ Start, pause or resume a cleaning task.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/stop` %}
#### {% linkable_title Service `vacuum.stop` %}
Stop the current activity of the botvac.
@ -59,7 +59,7 @@ Stop the current activity of the botvac.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/return_to_home` %}
#### {% linkable_title Service `vacuum.return_to_home` %}
Tell the botvac to return home.
@ -67,7 +67,7 @@ Tell the botvac to return home.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/locate` %}
#### {% linkable_title Service `vacuum.locate` %}
Locate the vacuum cleaner robot.
@ -75,7 +75,7 @@ Locate the vacuum cleaner robot.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/clean_spot` %}
#### {% linkable_title Service `vacuum.clean_spot` %}
Tell the vacuum cleaner to do a spot clean-up.
@ -83,7 +83,7 @@ Tell the vacuum cleaner to do a spot clean-up.
|---------------------------|----------|-------------------------------------------------------|
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
#### {% linkable_title Service `vacuum/set_fanspeed` %}
#### {% linkable_title Service `vacuum.set_fanspeed` %}
Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform.
@ -92,7 +92,7 @@ Set the fan speed of the botvac. The `fanspeed` can be a label, as `balanced` or
| `entity_id` | yes | Only act on specific botvac. Else targets all. |
| `fanspeed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
#### {% linkable_title Service `vacuum/send_command` %}
#### {% linkable_title Service `vacuum.send_command` %}
Send a platform-specific command to the vacuum cleaner.

4
source/_components/vacuum.xiaomi_miio.markdown
View file

@ -81,7 +81,7 @@ Remote control the robot. Please ensure you first set it in remote control mode
| `entity_id` | yes | Only act on specific robot; default targets all |
| `velocity` | no | Speed: between -0.29 and 0.29 |
| `rotation` | no | Rotation: between -179 degrees and 179 degrees |
| `duration` | no | The number of seconds that the robot should move for |
| `duration` | no | The number of milliseconds that the robot should move for |
### {% linkable_title Service `vacuum.xiaomi_remote_control_move_step` %}
@ -92,7 +92,7 @@ Enter remote control mode, make one move, stop, and exit remote control mode.
| `entity_id` | yes | Only act on specific robot; default targets all |
| `velocity` | no | Speed: between -0.29 and 0.29. |
| `rotation` | no | Rotation: between -179 degrees and 179 degrees. |
| `duration` | no | The number of seconds that the robot should move for |
| `duration` | no | The number of milliseconds that the robot should move for |
## {% linkable_title Attributes %}