Merge branch 'current' into next

This commit is contained in:
Fabian Affolter 2019-02-23 10:23:05 +01:00
commit a218616c7b
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
16 changed files with 242 additions and 294 deletions

View File

@ -8,12 +8,24 @@ comments: false
sharing: true
footer: true
logo: apcupsd.png
ha_category: System Monitor
ha_category:
- System Monitor
- Binary Sensor
- Sensor
ha_release: 0.13
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.apcupsd/
- /components/sensor.apcupsd/
---
[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) is enabled on the APC device.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Sensor](#sensor)
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
@ -39,3 +51,89 @@ port:
<p class='note'>
If you get `ConnectionRefusedError: Connection refused` errors in the Home assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
</p>
## {% linkable_title Binary sensor %}
In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
### {% linkable_title Configuration %}
To enable this sensor, you first have to set up apcupsd component (above), and add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: apcupsd
```
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: UPS Online Status
{% endconfiguration %}
## {% linkable_title Sensor %}
The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command.
### {% linkable_title Configuration %}
To use this sensor platform, you first have to set up apcupsd component (above), and add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: apcupsd
resources:
- bcharge
- linev
```
{% configuration %}
resources:
description: Contains all entries to display.
required: true
type: list
{% endconfiguration %}
### {% linkable_title Example %}
Given the following output from `apcaccess`:
```yaml
APC : 001,051,1149
DATE : 2016-02-09 17:13:31 +0000
HOSTNAME : localhost
VERSION : 3.14.12 (29 March 2014) redhat
UPSNAME : netrack
CABLE : Custom Cable Smart
DRIVER : APC Smart UPS (any)
UPSMODE : Stand Alone
STARTTIME: 2016-02-09 16:06:47 +0000
MODEL : SMART-UPS 1400
STATUS : TRIM ONLINE
LINEV : 247.0 Volts
LOADPCT : 13.0 Percent
BCHARGE : 100.0 Percent
TIMELEFT : 104.0 Minutes
MBATTCHG : 5 Percent
MINTIMEL : 3 Minutes
MAXTIME : 0 Seconds
MAXLINEV : 249.6 Volts
MINLINEV : 244.4 Volts
OUTPUTV : 218.4 Volts
[...]
```
Use the (case insensitive) values from the left hand column:
```yaml
sensor:
- platform: apcupsd
resources:
- linev
- loadpct
- timeleft
```

View File

@ -1,34 +0,0 @@
---
layout: page
title: APCUPSd Binary Sensor
description: "Instructions on how to set up an APCUPSd binary sensor within Home Assistant."
date: 2016-02-10 18:47
sidebar: true
comments: false
sharing: true
footer: true
logo: apcupsd.png
ha_category: System Monitor
ha_release: 0.13
ha_iot_class: "Local Polling"
---
In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
## {% linkable_title Configuration %}
To enable this sensor, you first have to set up [apcupsd](/components/apcupsd/), and add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: apcupsd
```
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: UPS Online Status
{% endconfiguration %}

View File

@ -1,22 +0,0 @@
---
layout: page
title: "Danfoss Air Binary Sensor"
description: "Instructions for how to setup Danfoss Air binary sensors within Home Assistant."
date: 2019-01-21 19:03
sidebar: true
comments: false
sharing: true
footer: true
logo: danfoss_air.png
ha_category: Binary Sensor
ha_release: "0.87"
ha_iot_class: "Local Polling"
---
<p class='note'>
To get your Danfoss Air binary sensors working with Home Assistant, follow the instructions for the general [Danfoss Air component](/components/danfoss_air/).
</p>
The following binary sensor is supported.
* **Bypass active:** Indicator if heat recovery is currrently bypassed.
* **Away mode active:** Indicator if away mode is currently active.

View File

@ -1,30 +0,0 @@
---
layout: page
title: "DoorBird Camera"
description: "Instructions on how to integrate DoorBird video doorbell images into Home Assistant."
date: 2017-08-06 11:30
sidebar: true
comments: false
sharing: true
footer: true
logo: doorbird.png
ha_category: Camera
ha_release: "0.54"
ha_iot_class: "Local Polling"
---
The `doorbird` implementation allows you to view the live video, the last doorbell ring image, and the last motion sensor image from your [DoorBird](http://www.doorbird.com/) device in Home Assistant.
<p class='note'>
You must have the [DoorBird component](/components/doorbird/) configured to use this camera.
</p>
## {% linkable_title Configuration %}
To enable the camera, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: doorbird
```

View File

@ -7,10 +7,16 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Climate
ha_category:
- Climate
- Binary Sensor
- Sensor
ha_release: "0.87"
logo: danfoss_air.png
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.danfoss_air/
- /components/sensor.danfoss_air/
---
The `danfoss_air` component allows you to access information from your Danfoss Air HRV unit.
@ -18,6 +24,11 @@ The `danfoss_air` component allows you to access information from your Danfoss A
*Note*: Danfoss Air CCM only accepts one TCP connection at a time. Due to this the component
will not work while you have the HRV PC-Tool open.
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Sensor](#sensor)
```yaml
# Example configuration.yaml entry
danfoss_air:
@ -31,3 +42,18 @@ host:
type: string
{% endconfiguration %}
## {% linkable_title Binary sensor %}
The following binary sensor is supported.
- **Bypass active:** Indicator if heat recovery is currrently bypassed.
## {% linkable_title Sensor %}
The following sensors are supported.
- **Outdoor temperature:** Outdoor air temperature.
- **Supply temperature:** Air temperature of the air supplied to the house.
- **Extract temperature:** Air temperature of the air extracted from the house.
- **Exhaust temperature:** Exhausted air temperature.
- **Remaining filter lifetime:** Reamining filter lifetime measured in percent.

View File

@ -8,13 +8,24 @@ comments: false
sharing: true
footer: true
logo: doorbird.png
ha_category: Doorbell
ha_category:
- Doorbell
- Camera
- Switch
ha_release: "0.54"
ha_iot_class: "Local Push"
redirect_from:
- /components/camera.doorbird/
- /components/switch.doorbird/
---
The `doorbird` implementation allows you to integrate your [DoorBird](http://www.doorbird.com/) device in Home Assistant.
There is currently support for the following device types within Home Assistant:
- [Camera](#camera) - View live and historical event based images.
- [Switch](#switch) - Enable control of relays and camera night vision.
## {% linkable_title Setup %}
The user, which you are going to use with Home Assistant, needs the "API-Operator" permission enabled.
@ -77,15 +88,8 @@ devices:
{% endconfiguration %}
The configuration above is also used by the following platforms:
- [Camera](/components/camera.doorbird): View live and historical event based images.
- [Switch](/components/switch.doorbird): Enable control of relays and camera night vision.
## {% linkable_title Full example %}
```yaml
doorbird:
token: YOUR_DOORBIRD_TOKEN
@ -144,3 +148,29 @@ The URLs on the event will be based on the configuration used to connect to your
service: light.turn_on
entity_id: light.side_entry_porch
```
## {% linkable_title Camera %}
The `doorbird` implementation allows you to view the live video, the last doorbell ring image, and the last motion sensor image from your [DoorBird](http://www.doorbird.com/) device in Home Assistant.
### {% linkable_title Configuration %}
To enable the camera, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: doorbird
```
## {% linkable_title Switch %}
The `doorbird` switch platform allows you to power connected relays and trigger the IR array in your [DoorBird](http://www.doorbird.com/) video doorbell device.
To enable this switch, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: doorbird
```

View File

@ -8,23 +8,26 @@ comments: false
sharing: true
footer: true
logo: lcn.png
ha_category: Hub
ha_category:
- Hub
- Light
- Switch
ha_release: 0.85
ha_iot_class: "Local Push"
redirect_from:
- /components/light.lcn/
- /components/switch.lcn/
---
The `lcn` integration for Home Assistant allows you to connect to [LCN](http://www.lcn.eu) hardware devices.
The component requires one unused license of the coupling software LCN-PCHK (version >2.8) and a LCN hardware coupler. Alternatively a LCN-PKE coupler can be used which offers two PCHK licenses.
With this setup sending and receiving commands to and from LCN modules is possible.
There is currently support for the following device types within Home Assistant:
- [Light](/components/light.lcn)
- [Switch](/components/switch.lcn)
- [Light](#light)
- [Switch](#switch)
## {% linkable_title Configuration %}
@ -32,7 +35,6 @@ To use your LCN system in your installation, add the following lines to your `co
You have to specify at least one ip/port with login credentials for a PCHK host.
Consider to store your credentials in a [secrets.yaml](/docs/configuration/secrets).
```yaml
lcn:
connections:
@ -140,9 +142,8 @@ switches:
type: string
{% endconfiguration %}
## {% linkable_title LCN Addresses %}
LCN hardware devices connected to the LCN bus are called _modules_. LCN modules are addressed by their numeric id in the range (5..254).
Modules can be arranged in _segments_. Segments can be addressed by their numeric id (5..128) or 0 (= no segment exist) or 3 (= target all segments).
@ -154,6 +155,7 @@ The LCN component allow the connection to more than one hardware coupler. In thi
Whenever the address of a module or a group has to be specified, it can be addressed using one of the following syntaxes:
Example for modules:
```
connid.s000.m007
connid.s0.m7
@ -162,6 +164,7 @@ s0.m7
```
Example for groups:
```
connid.s000.g007
connid.s0.g7
@ -171,13 +174,27 @@ s0.g7
Leading zeroes in the segment id or module/group id can be omitted. If the `connection_id` is omitted, the first connection defined in the [configuration](#configuration) will be used.
## {% linkable_title LCN Constants %}
The platforms and service calls use several predefined constants as parameters.
#### {% linkable_title Ports %}
### {% linkable_title Ports %}
| Constant | Values |
| -------- | ------ |
| OUTPUT_PORT | `output1`, `output2`, `output3`, `output4` |
| RELAY_PORT | `relay1`, `relay2`, `relay3`, `relay4`, `relay5`, `relay6`, `relay7`, `relay8` |
## {% linkable_title Light %}
The `lcn` light platform allows the control of the following [LCN](http://www.lcn.eu) ports:
- (Dimmable) output ports
- Relays
## {% linkable_title Switch %}
The `lcn` switch platform allows the control of the following [LCN](http://www.lcn.eu) ports:
- Output ports
- Relays

View File

@ -1,24 +0,0 @@
---
layout: page
title: "LCN Light"
description: "Instructions on how to setup LCN lights within Home Assistant."
date: 2018-11-01 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lcn.png
ha_category: Light
ha_release: 0.85
ha_iot_class: "Local Push"
---
The `lcn` light platform allows the control of the following [LCN](http://www.lcn.eu) ports:
- (Dimmable) output ports
- Relays
## {% linkable_title Configuration %}
The `lcn` component must be configured correctly, see [LCN component](/components/lcn).
This platform is configured within the `lcn` component.

View File

@ -1,76 +0,0 @@
---
layout: page
title: "APCUPSd Sensor"
description: "Instructions on how to set up APCUPSd sensors within Home Assistant."
date: 2016-02-10 18:28
sidebar: true
comments: false
sharing: true
footer: true
logo: apcupsd.png
ha_release: 0.13
ha_category: System Monitor
ha_iot_class: "Local Polling"
---
The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command.
## {% linkable_title Configuration %}
To use this sensor platform, you first have to set up [apcupsd](/components/apcupsd/), and add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: apcupsd
resources:
- bcharge
- linev
```
{% configuration %}
resources:
description: Contains all entries to display.
required: true
type: list
{% endconfiguration %}
### {% linkable_title Example %}
Given the following output from `apcaccess`:
```yaml
APC : 001,051,1149
DATE : 2016-02-09 17:13:31 +0000
HOSTNAME : localhost
VERSION : 3.14.12 (29 March 2014) redhat
UPSNAME : netrack
CABLE : Custom Cable Smart
DRIVER : APC Smart UPS (any)
UPSMODE : Stand Alone
STARTTIME: 2016-02-09 16:06:47 +0000
MODEL : SMART-UPS 1400
STATUS : TRIM ONLINE
LINEV : 247.0 Volts
LOADPCT : 13.0 Percent
BCHARGE : 100.0 Percent
TIMELEFT : 104.0 Minutes
MBATTCHG : 5 Percent
MINTIMEL : 3 Minutes
MAXTIME : 0 Seconds
MAXLINEV : 249.6 Volts
MINLINEV : 244.4 Volts
OUTPUTV : 218.4 Volts
[...]
```
Use the (case insensitive) values from the left hand column:
```yaml
sensor:
- platform: apcupsd
resources:
- linev
- loadpct
- timeleft
```

View File

@ -1,30 +0,0 @@
---
layout: page
title: "Danfoss Air Sensor"
description: "Instructions for how to setup Danfoss Air sensors within Home Assistant."
date: 2019-01-21 20:59
sidebar: true
comments: false
sharing: true
footer: true
logo: danfoss_air.png
ha_category: Sensor
ha_release: "0.87"
ha_iot_class: "Local Polling"
---
<p class='note'>
To get your Danfoss Air sensors working with Home Assistant, follow the instructions for the general [Danfoss Air component](/components/danfoss_air/).
</p>
The following sensors are supported.
* **Outdoor temperature:** Outdoor air temperature.
* **Supply temperature:** Air temperature of the air supplied to the house.
* **Extract temperature:** Air temperature of the air extracted from the house.
* **Exhaust temperature:** Exhausted air temperature.
* **Remaining filter lifetime:** Reamining filter lifetime measured in percent.
* **Fan step:** Fan step in percent.
* **Exhaust fan speed:** Exhaust fan speed RPM.
* **Supply fan speed:** Supply fan speed RPM.
* **Battery:** Danfoss Air Dial remaning battery. If your system is without an Air Dial control panel the sensor will show 0%.

View File

@ -17,7 +17,7 @@ The GitHub sensor integrates data from [GitHub](https://github.com/) to monitor
## {% linkable_title Setup %}
To set up this sensor you will need a [personal access token][accesstoken]. You will need to check the `repo` scope for the sensor to function.
To set up this sensor you will need a [personal access token](https://github.com/settings/tokens). You will need to check the `repo` scope for the sensor to function.
## {% linkable_title Configuration %}

View File

@ -1,28 +0,0 @@
---
layout: page
title: "DoorBird Switch"
description: "Instructions on how to integrate DoorBird video doorbell relays into Home Assistant."
date: 2017-08-06 11:30
sidebar: true
comments: false
sharing: true
footer: true
logo: doorbird.png
ha_category: Switch
ha_release: "0.54"
ha_iot_class: "Local Push"
---
The `doorbird` switch platform allows you to power connected relays and trigger the IR array in your [DoorBird](http://www.doorbird.com/) video doorbell device.
<p class='note'>
You must have the [DoorBird component](/components/doorbird/) configured to use this switch.
</p>
To enable this switch, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: doorbird
```

View File

@ -1,24 +0,0 @@
---
layout: page
title: "LCN Switch"
description: "Instructions on how to setup LCN switches within Home Assistant."
date: 2018-11-01 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lcn.png
ha_category: Switch
ha_release: 0.87
ha_iot_class: "Local Push"
---
The `lcn` switch platform allows the control of the following [LCN](http://www.lcn.eu) ports:
- Output ports
- Relays
## {% linkable_title Configuration %}
The `lcn` component must be configured correctly, see [LCN component](/components/lcn).
This platform is configured within the `lcn` component.

View File

@ -8,14 +8,59 @@ comments: false
sharing: true
footer: true
---
[Caddy Server](https://caddyserver.com/) is a powerful HTTP/2 server, that enables HTTPS by default with automatically generated Let's Encrypt certificates, which allows a simple configuration procces.
Configure [Caddy Server](https://caddyserver.com/) for use as a reverse proxy to Home Assistant.
Using Caddy as a proxy for Home Assistant allows you to serve Home Assistant securely over standard ports. This configuration file and instructions will walk you through setting up Home Assistant over a secure connection.
### {% linkable_title 1. Get a domain name forwarded to your IP %}
Chances are, you have a dynamic IP address (your ISP changes your address periodically). If this is true, you can use a Dynamic DNS service to obtain a domain and set it up to update with you IP. If you purchase your own domain name, you will be able to easily get a trusted SSL certificate later.
### {% linkable_title 2. Install Caddy on your server %}
This will vary depending on your OS. Caddy has a [nice utillity](https://caddyserver.com/download) that generates an installer script.
<p class='note'>
Make sure you include the `hook.service` plugin if you want to run Caddy as a service
</p>
### {% linkable_title 3. Port forwarding. %}
Forward ports 443 and 80 to your server on your router. Do not forward port 8123.
### {% linkable_title 4. Create Caddyfile. %}
Use this as your Caddyfile, change the domain name to match yours.
```
hass.example.org {
example.com {
proxy / localhost:8123 {
websocket
transparent
}
}
```
### {% linkable_title 5. Configure Home Assistant %}
Home Assistant is still available without using the Caddy proxy. Restricting it to only listen to `127.0.0.1` will forbid direct accesses. Also, Home Assistant should be told to trust headers coming from Caddy proxy only. Otherwise, incoming requests will always come from `127.0.0.1` and not the real IP address.
On your `configuration.yaml` file, edit the `http` component.
```yaml
http:
# For extra security set this to only accept connections on localhost if Caddy is on the same machine
# server_host: 127.0.0.1
# Update this line to be your domain
base_url: https://example.com
use_x_forwarded_for: true
# You must set the trusted proxy IP address so that Home Assistant will properly accept connections
# Set this to your Caddy machine IP, or localhost if hosted on the same machine.
trusted_proxies: <Caddy IP address here, or 127.0.0.1 if hosted on the same machine>
```
### {% linkable_title 6. Start Caddy %}
You can either start Caddy or [install it as a service](https://github.com/mholt/caddy/wiki/Caddy-as-a-service-examples), pass the Caddyfile path as a `conf` parameter.
Home Assistant will be listening on port 443 (HTTPS) and all insecure traffic on port 80 will be redirected.

View File

@ -39,7 +39,7 @@ The alternative to a stick is a hub that supports Z-Wave. Home Assistant support
### {% linkable_title Aeotec Stick %}
By default this will turn on "disco lights", which you can turn off by following the instructions in the [device specific page](/docs/z-wave/device-specific/#aeon-z-stick)
By default this will turn on "disco lights", which you can turn off by following the instructions in the [device specific page](/docs/z-wave/device-specific/#aeotec-z-stick)
### {% linkable_title Razberry Board %}

View File

@ -24,7 +24,7 @@ footer: true
- 📣 Lovelace is now the default UI for Home Assistant!
- 📣 New Lovelace [demos](https://demo.home-assistant.io/#/lovelace/0) page
- 🔧 [thermostat card]: Fix sizing
- 🔧 [guage card]: Fix sizing
- 🔧 [gauge card]: Fix sizing
- 🔧 [iframe card]: Fix card size