mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Merge branch 'current' into next
This commit is contained in:
Paulus Schoutsen
commit
83fdb23442
@ -144,8 +144,8 @@ social:
|
|||||||
# Home Assistant release details
|
# Home Assistant release details
|
||||||
current_major_version: 0
|
current_major_version: 0
|
||||||
current_minor_version: 86
|
current_minor_version: 86
|
||||||
current_patch_version: 3
|
current_patch_version: 4
|
||||||
date_released: 2019-01-26
|
date_released: 2019-01-29
|
||||||
|
|
||||||
# Either # or the anchor link to latest release notes in the blog post.
|
# Either # or the anchor link to latest release notes in the blog post.
|
||||||
# Must be prefixed with a # and have double quotes around it.
|
# Must be prefixed with a # and have double quotes around it.
|
||||||
|
|||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "HomeKit Alarm Control Panel"
|
|
||||||
description: "Instructions how to setup HomeKit security systems within Home Assistant."
|
|
||||||
date: 2018-12-27 20:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: apple-homekit.png
|
|
||||||
ha_category: Alarm Control Panel
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
ha_release: 0.86
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your HomeKit security system working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/).
|
|
||||||
@ -8,10 +8,117 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: beaglebone-black.png
|
logo: beaglebone-black.png
|
||||||
ha_category: DIY
|
ha_category:
|
||||||
|
- DIY
|
||||||
|
- Binary Sensor
|
||||||
|
- Switch
|
||||||
ha_release: 0.36
|
ha_release: 0.36
|
||||||
ha_iot_class: "Local Push"
|
ha_iot_class: "Local Push"
|
||||||
|
redirect_from:
|
||||||
|
- /components/binary_sensor.bbb_gpio/
|
||||||
|
- /components/switch.bbb_gpio/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
|
The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
|
||||||
There is no setup needed for the component itself, for the platforms please check their corresponding pages.
|
There is no setup needed for the component itself.
|
||||||
|
|
||||||
|
## {% linkable_title Binary Sensor %}
|
||||||
|
|
||||||
|
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
binary_sensor:
|
||||||
|
- platform: bbb_gpio
|
||||||
|
pins:
|
||||||
|
P8_12:
|
||||||
|
name: Door
|
||||||
|
GPIO0_26:
|
||||||
|
name: Window
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
pins:
|
||||||
|
description: List of used pins.
|
||||||
|
required: true
|
||||||
|
type: map
|
||||||
|
keys:
|
||||||
|
pin_name:
|
||||||
|
description: Port numbers and corresponding names.
|
||||||
|
required: true
|
||||||
|
type: map
|
||||||
|
keys:
|
||||||
|
name:
|
||||||
|
description: Friendly name to use for the frontend.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
bouncetime:
|
||||||
|
description: Debounce time for reading input pin defined in milliseconds [ms].
|
||||||
|
required: false
|
||||||
|
type: integer
|
||||||
|
default: 50
|
||||||
|
invert_logic:
|
||||||
|
description: If `true`, inverts the input logic to ACTIVE LOW
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
pull_mode:
|
||||||
|
description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
default: UP
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.
|
||||||
|
|
||||||
|
## {% linkable_title Switch %}
|
||||||
|
|
||||||
|
The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
switch:
|
||||||
|
- platform: bbb_gpio
|
||||||
|
pins:
|
||||||
|
GPIO0_7:
|
||||||
|
name: LED Red
|
||||||
|
P9_12:
|
||||||
|
name: LED Green
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
pins:
|
||||||
|
description: List of used pins.
|
||||||
|
required: true
|
||||||
|
type: map
|
||||||
|
keys:
|
||||||
|
pin_name:
|
||||||
|
description: Port numbers and corresponding names.
|
||||||
|
required: true
|
||||||
|
type: map
|
||||||
|
keys:
|
||||||
|
name:
|
||||||
|
description: Friendly name to use for the frontend.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
initial:
|
||||||
|
description: Initial state of the pin.
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
invert_logic:
|
||||||
|
description: If `true`, inverts the input logic to ACTIVE LOW
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.
|
||||||
@ -1,65 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "BeagleBone Black GPIO Binary Sensor"
|
|
||||||
description: "Instructions on how to integrate the GPIO sensor capability of a BeagleBone Black into Home Assistant."
|
|
||||||
date: 2017-01-14 10:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: beaglebone-black.png
|
|
||||||
ha_category: DIY
|
|
||||||
ha_release: 0.37
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
binary_sensor:
|
|
||||||
- platform: bbb_gpio
|
|
||||||
pins:
|
|
||||||
P8_12:
|
|
||||||
name: Door
|
|
||||||
GPIO0_26:
|
|
||||||
name: Window
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
pins:
|
|
||||||
description: List of used pins.
|
|
||||||
required: true
|
|
||||||
type: map
|
|
||||||
keys:
|
|
||||||
pin_name:
|
|
||||||
description: Port numbers and corresponding names.
|
|
||||||
required: true
|
|
||||||
type: map
|
|
||||||
keys:
|
|
||||||
name:
|
|
||||||
description: Friendly name to use for the frontend.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
bouncetime:
|
|
||||||
description: Debounce time for reading input pin defined in milliseconds [ms].
|
|
||||||
required: false
|
|
||||||
type: integer
|
|
||||||
default: 50
|
|
||||||
invert_logic:
|
|
||||||
description: If `true`, inverts the input logic to ACTIVE LOW
|
|
||||||
required: false
|
|
||||||
type: boolean
|
|
||||||
default: false
|
|
||||||
pull_mode:
|
|
||||||
description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
default: UP
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Homematic Binary Sensor"
|
|
||||||
description: "Instructions on how to integrate binary Homematic sensors within Home Assistant."
|
|
||||||
date: 2016-06-28 08:30
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: homematic.png
|
|
||||||
ha_category: Binary Sensor
|
|
||||||
ha_release: 0.23
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `homematic` binary sensor platform lets you observe the state changes of binary [Homematic](http://www.homematic.com/) sensors through Home Assistant.
|
|
||||||
|
|
||||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "OpenUV Binary Sensor"
|
|
||||||
description: "Instructions on how to integrate OpenUV binary sensors within Home Assistant."
|
|
||||||
date: 2018-07-31 22:01
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: openuv.jpg
|
|
||||||
ha_category: Health
|
|
||||||
ha_release: 0.76
|
|
||||||
ha_iot_class: "Cloud Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `openuv` binary sensor platform allows you to view binary sensor data from [OpenUV](http://openuv.io).
|
|
||||||
|
|
||||||
You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, binary sensors will automatically appear.
|
|
||||||
@ -1,60 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Raspberry Pi GPIO Binary Sensor"
|
|
||||||
description: "Instructions on how to integrate the GPIO sensor capability of a Raspberry Pi into Home Assistant."
|
|
||||||
date: 2015-08-30 19:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: raspberry-pi.png
|
|
||||||
ha_category: DIY
|
|
||||||
ha_release: pre 0.7
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
binary_sensor:
|
|
||||||
- platform: rpi_gpio
|
|
||||||
ports:
|
|
||||||
11: PIR Office
|
|
||||||
12: PIR Bedroom
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
ports:
|
|
||||||
description: List of used ports.
|
|
||||||
required: true
|
|
||||||
type: map
|
|
||||||
keys:
|
|
||||||
"port: name":
|
|
||||||
description: The port numbers (BCM mode pin numbers) and corresponding names.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
bouncetime:
|
|
||||||
description: The time in milliseconds for port debouncing.
|
|
||||||
required: false
|
|
||||||
type: integer
|
|
||||||
default: 50
|
|
||||||
invert_logic:
|
|
||||||
description: If `true`, inverts the output logic to ACTIVE LOW.
|
|
||||||
required: false
|
|
||||||
type: boolean
|
|
||||||
default: "`false` (ACTIVE HIGH)"
|
|
||||||
pull_mode:
|
|
||||||
description: >
|
|
||||||
Type of internal pull resistor to use.
|
|
||||||
Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
default: "`UP`"
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "HomeKit Climate"
|
|
||||||
description: "Instructions how to setup HomeKit thermostats within Home Assistant."
|
|
||||||
date: 2018-06-19 20:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: apple-homekit.png
|
|
||||||
ha_category: Climate
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
ha_release: 0.73
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your HomeKit thermostats and air conditioners working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/).
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Homematic Thermostats"
|
|
||||||
description: "Instructions on how to integrate Homematic thermostats within Home Assistant."
|
|
||||||
date: 2016-06-28 08:30
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: homematic.png
|
|
||||||
ha_category: Climate
|
|
||||||
ha_release: 0.23
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
The `homematic` climate platform lets you control [Homematic](http://www.homematic.com/) thermostats through Home Assistant.
|
|
||||||
|
|
||||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "HomeKit Cover"
|
|
||||||
description: "Instructions how to setup HomeKit covers within Home Assistant."
|
|
||||||
date: 2019-1-8 5:30
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: apple-homekit.png
|
|
||||||
ha_category: Cover
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
ha_release: 0.86
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your HomeKit garage door openers, windows, or window coverings working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/).
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Homematic Cover"
|
|
||||||
description: "Instructions on how to integrate Homematic covers within Home Assistant."
|
|
||||||
date: 2016-08-24 14:25
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: homematic.png
|
|
||||||
ha_category: Cover
|
|
||||||
ha_release: 0.27
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
The `homematic` cover platform lets you control [Homematic](http://www.homematic.com/) covers such as rollershutters through Home Assistant.
|
|
||||||
|
|
||||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
|
||||||
@ -1,99 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Raspberry Pi GPIO Cover"
|
|
||||||
description: "Instructions on how to setup the Raspberry Pi GPIO covers within Home Assistant."
|
|
||||||
date: 2016-08-24 14:28
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: raspberry-pi.png
|
|
||||||
ha_category: DIY
|
|
||||||
ha_release: 0.23
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `rpi_gpio` cover platform allows you to use a Raspberry Pi to control your cover such as Garage doors.
|
|
||||||
|
|
||||||
It uses two pins on the Raspberry Pi.
|
|
||||||
|
|
||||||
- The `state_pin` will detect if the cover is closed, and
|
|
||||||
- the `relay_pin` will trigger the cover to open or close.
|
|
||||||
|
|
||||||
Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup).
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
cover:
|
|
||||||
- platform: rpi_gpio
|
|
||||||
covers:
|
|
||||||
- relay_pin: 10
|
|
||||||
state_pin: 11
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
relay_time:
|
|
||||||
description: The time that the relay will be on for in seconds.
|
|
||||||
required: false
|
|
||||||
default: 0.2
|
|
||||||
type: float
|
|
||||||
invert_relay:
|
|
||||||
description: Invert the relay pin output so that it is active-high (True).
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
state_pull_mode:
|
|
||||||
description: The direction the State pin is pulling. It can be UP or DOWN.
|
|
||||||
required: false
|
|
||||||
default: UP
|
|
||||||
type: string
|
|
||||||
invert_state:
|
|
||||||
description: Invert the value of the State pin so that 0 means closed.
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
covers:
|
|
||||||
description: List of your doors.
|
|
||||||
required: true
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
relay_pin:
|
|
||||||
description: The pin of your Raspberry Pi where the relay is connected.
|
|
||||||
required: true
|
|
||||||
type: integer
|
|
||||||
state_pin:
|
|
||||||
description: The pin of your Raspberry Pi to retrieve the state.
|
|
||||||
required: true
|
|
||||||
type: integer
|
|
||||||
name:
|
|
||||||
description: The name to use in the frontend.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
## {% linkable_title Full example %}
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
cover:
|
|
||||||
- platform: rpi_gpio
|
|
||||||
relay_time: 0.2
|
|
||||||
invert_relay: false
|
|
||||||
state_pull_mode: 'UP'
|
|
||||||
invert_state: true
|
|
||||||
covers:
|
|
||||||
- relay_pin: 10
|
|
||||||
state_pin: 11
|
|
||||||
- relay_pin: 12
|
|
||||||
state_pin: 13
|
|
||||||
name: 'Right door'
|
|
||||||
```
|
|
||||||
|
|
||||||
## {% linkable_title Remote Raspberry Pi Cover %}
|
|
||||||
|
|
||||||
If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/components/cover.mqtt/). Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover.
|
|
||||||
|
|
||||||
@ -83,7 +83,7 @@ password:
|
|||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
dhcp_software:
|
dhcp_software:
|
||||||
description: "The DHCP software used in your router: `dnsmasq`, `dhcpd`, or `none`."
|
description: "The DHCP software used in your router: `dnsmasq`, `odhcpd`, or `none`."
|
||||||
required: false
|
required: false
|
||||||
default: dnsmasq
|
default: dnsmasq
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@ -8,21 +8,37 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: apple-homekit.png
|
logo: apple-homekit.png
|
||||||
ha_category: Hub
|
ha_category:
|
||||||
|
- Hub
|
||||||
|
- Alarm Panel Control
|
||||||
|
- Climate
|
||||||
|
- Cover
|
||||||
|
- Light
|
||||||
|
- Lock
|
||||||
|
- Switch
|
||||||
|
- Binary Sensor
|
||||||
ha_release: 0.68
|
ha_release: 0.68
|
||||||
ha_iot_class: "Local Polling"
|
ha_iot_class: "Local Polling"
|
||||||
|
redirect_from:
|
||||||
|
- /components/alarm_control_panel.homekit_controller/
|
||||||
|
- /components/climate.homekit_controller/
|
||||||
|
- /components/cover.homekit_controller/
|
||||||
|
- /components/light.homekit_controller/
|
||||||
|
- /components/lock.homekit_controller/
|
||||||
|
- /components/switch.homekit_controller/
|
||||||
---
|
---
|
||||||
|
|
||||||
[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This component should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit.
|
[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This component should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit.
|
||||||
|
|
||||||
There is currently support for the following device types within Home Assistant:
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
- [Alarm Control Panel](/components/alarm_control_panel.homekit_controller/)
|
- Alarm Control Panel (HomeKit security system)
|
||||||
- [Climate](/components/climate.homekit_controller/)
|
- Climate (HomeKit thermostats and air conditioners)
|
||||||
- [Cover](/components/cover.homekit_controller/)
|
- Cover (HomeKit garage door openers, windows, or window coverings)
|
||||||
- [Light](/components/light.homekit_controller/)
|
- Light (HomeKit lights)
|
||||||
- [Lock](/components/lock.homekit_controller/)
|
- Lock (HomeKit lock)
|
||||||
- [Switch](/components/switch.homekit_controller/)
|
- Switch (HomeKit switches)
|
||||||
|
- Binary Sensor (HomeKit motion sensors)
|
||||||
|
|
||||||
The component will be automatically configured if the [`discovery:`](/components/discovery/) component is enabled and an enable entry added for HomeKit:
|
The component will be automatically configured if the [`discovery:`](/components/discovery/) component is enabled and an enable entry added for HomeKit:
|
||||||
|
|
||||||
|
|||||||
@ -8,15 +8,44 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: homematic.png
|
logo: homematic.png
|
||||||
ha_category: Hub
|
ha_category:
|
||||||
|
- Hub
|
||||||
|
- Binary Sensor
|
||||||
|
- Climate
|
||||||
|
- Cover
|
||||||
|
- Light
|
||||||
|
- Lock
|
||||||
|
- Notify
|
||||||
|
- Sensor
|
||||||
|
- Switch
|
||||||
ha_iot_class: "Local Push"
|
ha_iot_class: "Local Push"
|
||||||
ha_release: 0.23
|
ha_release: 0.23
|
||||||
featured: false
|
featured: false
|
||||||
|
redirect_from:
|
||||||
|
- /components/binary_sensor.homematic/
|
||||||
|
- /components/climate.homematic/
|
||||||
|
- /components/cover.homematic/
|
||||||
|
- /components/light.homematic/
|
||||||
|
- /components/lock.homematic/
|
||||||
|
- /components/notify.homematic/
|
||||||
|
- /components/sensor.homematic/
|
||||||
|
- /components/switch.homematic/
|
||||||
---
|
---
|
||||||
|
|
||||||
The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.
|
The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.
|
||||||
If you are using Homegear with paired [Intertechno](http://intertechno.at/) devices, uni-directional communication is possible as well.
|
If you are using Homegear with paired [Intertechno](http://intertechno.at/) devices, uni-directional communication is possible as well.
|
||||||
|
|
||||||
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
|
- Binary Sensor
|
||||||
|
- Climate
|
||||||
|
- Cover
|
||||||
|
- Light
|
||||||
|
- Lock
|
||||||
|
- Notify
|
||||||
|
- Sensor
|
||||||
|
- Switch
|
||||||
|
|
||||||
Device support is available for most of the wired and wireless devices, as well as a lot of IP devices. If you have a setup with mixed protocols, you have to configure additional [interfaces](/components/homematic#interfaces) with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 **and** require you to set the `path` setting to `/groups`. When using SSL on a CCU3, by default the same ports as usual with a prepended 4 are available. So 2001 becomes 42001, 2010 becomes 42010 etc..
|
Device support is available for most of the wired and wireless devices, as well as a lot of IP devices. If you have a setup with mixed protocols, you have to configure additional [interfaces](/components/homematic#interfaces) with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 **and** require you to set the `path` setting to `/groups`. When using SSL on a CCU3, by default the same ports as usual with a prepended 4 are available. So 2001 becomes 42001, 2010 becomes 42010 etc..
|
||||||
|
|
||||||
If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute.
|
If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute.
|
||||||
@ -413,3 +442,103 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi
|
|||||||
action:
|
action:
|
||||||
service: homematic.reconnect
|
service: homematic.reconnect
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Notifications %}
|
||||||
|
|
||||||
|
The `homematic` notification platform enables invoking Homematic devices.
|
||||||
|
|
||||||
|
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
notify:
|
||||||
|
- name: my_hm
|
||||||
|
platform: homematic
|
||||||
|
address: NEQXXXXXXX
|
||||||
|
channel: 2
|
||||||
|
param: "SUBMIT"
|
||||||
|
value: "1,1,108000,8"
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
address:
|
||||||
|
description: The address of your Homematic device. The address is the serial number of the device shown in the CCU in the `devices` section in the column `serial number`.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
channel:
|
||||||
|
description: The channel of your Homematic device.
|
||||||
|
required: true
|
||||||
|
type: integer
|
||||||
|
param:
|
||||||
|
description: An additional parameter for the Homematic device.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
interface:
|
||||||
|
description: Set the name of the interface from the config.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
value:
|
||||||
|
description: This is the value that is set on the device. Its device specific.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
### {% linkable_title Usage %}
|
||||||
|
|
||||||
|
`homematic` is a notify platform and can be controlled by calling the notify service [as described here](/components/notify/).
|
||||||
|
|
||||||
|
Only the `data` part of the event payload is processed. This part can specify or override the value given as configuration variable:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"address": "NEQXXXXXXX",
|
||||||
|
"channel": 2,
|
||||||
|
"param": "SUBMIT",
|
||||||
|
"value": "1,1,108000,8"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
It is possible to provide a template in order to compute the value:
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"value": "1,1,108000{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},1{% endif %}{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},2{% endif %}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
|
You can also specify the event payload using a group notification (instead of specifying the value for the notify itself):
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
|
```yaml
|
||||||
|
notify:
|
||||||
|
- name: my_hm
|
||||||
|
platform: homematic
|
||||||
|
address: NEQXXXXXXX
|
||||||
|
- name: group_hm
|
||||||
|
platform: group
|
||||||
|
services:
|
||||||
|
- service: my_hm
|
||||||
|
data:
|
||||||
|
data:
|
||||||
|
value: "1,1,108000{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},1{% endif %}{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},2{% endif %}"
|
||||||
|
|
||||||
|
alert:
|
||||||
|
temperature:
|
||||||
|
name: Temperature too high
|
||||||
|
done_message: Temperature OK
|
||||||
|
entity_id: binary_sensor.temperature_too_high
|
||||||
|
can_acknowledge: true
|
||||||
|
notifiers:
|
||||||
|
- group_hm
|
||||||
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
|
Please note that the first `data` element belongs to the service `my_hm`, while the second one belongs to the event payload.
|
||||||
@ -8,8 +8,12 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: joaoapps_join.png
|
logo: joaoapps_join.png
|
||||||
ha_category: Hub
|
ha_category:
|
||||||
|
- Hub
|
||||||
|
- Notify
|
||||||
ha_release: "0.24"
|
ha_release: "0.24"
|
||||||
|
redirect_from:
|
||||||
|
- /components/notify.joaoapps_join/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `joaoapps_join` component exposes services from
|
The `joaoapps_join` component exposes services from
|
||||||
|
|||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "HomeKit Light"
|
|
||||||
description: "Instructions how to setup HomeKit lights within Home Assistant."
|
|
||||||
date: 2017-03-19 21:08
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: apple-homekit.png
|
|
||||||
ha_category: Light
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
ha_release: 0.68
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your HomeKit lights working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/).
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Homematic Light"
|
|
||||||
description: "Instructions on how to integrate Homematic lights within Home Assistant."
|
|
||||||
date: 2016-06-28 08:30
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: homematic.png
|
|
||||||
ha_category: Light
|
|
||||||
ha_release: 0.23
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
The `homematic` light platform lets you control [Homematic](http://www.homematic.com/) lights through Home Assistant.
|
|
||||||
|
|
||||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "HomeKit Lock"
|
|
||||||
description: "Instructions how to setup HomeKit locks within Home Assistant."
|
|
||||||
date: 2019-1-8 7:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: apple-homekit.png
|
|
||||||
ha_category: Lock
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
ha_release: 0.86
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your HomeKit lock working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/).
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Homematic Lock (KeyMatic)"
|
|
||||||
description: "Instructions how to integrate Homematic locks (KeyMatic) within Home Assistant."
|
|
||||||
date: 2018-01-28 03:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: homematic.png
|
|
||||||
ha_category: Lock
|
|
||||||
ha_release: 0.66
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `homematic` lock platform lets you observe and control the state of the HomeMatic [Homematic](http://www.homematic.com/) KeyMatic lock through Home Assistant.
|
|
||||||
|
|
||||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
|
||||||
@ -1,111 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Homematic Notifications"
|
|
||||||
description: "Instructions on how to notify Homematic devices."
|
|
||||||
date: 2018-10-03 11:44
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: homematic.png
|
|
||||||
ha_category: Notifications
|
|
||||||
ha_release: 0.81
|
|
||||||
---
|
|
||||||
|
|
||||||
The `homematic` notification platform enables invoking Homematic devices.
|
|
||||||
|
|
||||||
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
notify:
|
|
||||||
- name: my_hm
|
|
||||||
platform: homematic
|
|
||||||
address: NEQXXXXXXX
|
|
||||||
channel: 2
|
|
||||||
param: "SUBMIT"
|
|
||||||
value: "1,1,108000,8"
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
address:
|
|
||||||
description: The address of your Homematic device. The address is the serial number of the device shown in the CCU in the `devices` section in the column `serial number`.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
channel:
|
|
||||||
description: The channel of your Homematic device.
|
|
||||||
required: true
|
|
||||||
type: integer
|
|
||||||
param:
|
|
||||||
description: An additional parameter for the Homematic device.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
interface:
|
|
||||||
description: Set the name of the interface from the config.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
value:
|
|
||||||
description: This is the value that is set on the device. Its device specific.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
### {% linkable_title Usage %}
|
|
||||||
|
|
||||||
`homematic` is a notify platform and can be controlled by calling the notify service [as described here](/components/notify/).
|
|
||||||
|
|
||||||
Only the `data` part of the event payload is processed. This part can specify or override the value given as configuration variable:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"data": {
|
|
||||||
"address": "NEQXXXXXXX",
|
|
||||||
"channel": 2,
|
|
||||||
"param": "SUBMIT",
|
|
||||||
"value": "1,1,108000,8"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
It is possible to provide a template in order to compute the value:
|
|
||||||
|
|
||||||
{% raw %}
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"data": {
|
|
||||||
"value": "1,1,108000{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},1{% endif %}{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},2{% endif %}"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
{% endraw %}
|
|
||||||
|
|
||||||
You can also specify the event payload using a group notification (instead of specifying the value for the notify itself):
|
|
||||||
|
|
||||||
{% raw %}
|
|
||||||
```yaml
|
|
||||||
notify:
|
|
||||||
- name: my_hm
|
|
||||||
platform: homematic
|
|
||||||
address: NEQXXXXXXX
|
|
||||||
- name: group_hm
|
|
||||||
platform: group
|
|
||||||
services:
|
|
||||||
- service: my_hm
|
|
||||||
data:
|
|
||||||
data:
|
|
||||||
value: "1,1,108000{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},1{% endif %}{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},2{% endif %}"
|
|
||||||
|
|
||||||
alert:
|
|
||||||
temperature:
|
|
||||||
name: Temperature too high
|
|
||||||
done_message: Temperature OK
|
|
||||||
entity_id: binary_sensor.temperature_too_high
|
|
||||||
can_acknowledge: true
|
|
||||||
notifiers:
|
|
||||||
- group_hm
|
|
||||||
```
|
|
||||||
{% endraw %}
|
|
||||||
|
|
||||||
Please note that the first `data` element belongs to the service `my_hm`, while the second one belongs to the event payload.
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Join Notify"
|
|
||||||
description: "Instructions on how to setup the Join notification platform within Home Assistant."
|
|
||||||
date: 2016-07-12 09:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: joaoapps_join.png
|
|
||||||
ha_category: Notifications
|
|
||||||
ha_release: "0.24"
|
|
||||||
---
|
|
||||||
|
|
||||||
See the [Joaoapps Join component page](/components/joaoapps_join/) for
|
|
||||||
information how to get the join notify platform running.
|
|
||||||
@ -8,13 +8,18 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: openuv.jpg
|
logo: openuv.jpg
|
||||||
ha_category: Health
|
ha_category:
|
||||||
|
- Health
|
||||||
|
- Binary Sensor
|
||||||
|
- Sensor
|
||||||
ha_release: 0.76
|
ha_release: 0.76
|
||||||
ha_iot_class: "Cloud Polling"
|
ha_iot_class: "Cloud Polling"
|
||||||
|
redirect_from:
|
||||||
|
- /components/binary_sensor.openuv/
|
||||||
|
- /components/sensor.openuv/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `openuv` component displays UV and Ozone data from
|
The `openuv` component displays UV and Ozone data from [openuv.io](http://openuv.io).
|
||||||
[openuv.io](http://openuv.io).
|
|
||||||
|
|
||||||
## {% linkable_title Generating an API Key %}
|
## {% linkable_title Generating an API Key %}
|
||||||
|
|
||||||
|
|||||||
@ -8,10 +8,202 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: raspberry-pi.png
|
logo: raspberry-pi.png
|
||||||
ha_category: DIY
|
ha_category:
|
||||||
|
- DIY
|
||||||
|
- Binary Sensor
|
||||||
|
- Cover
|
||||||
|
- Switch
|
||||||
ha_release: pre 0.7
|
ha_release: pre 0.7
|
||||||
ha_iot_class: "Local Push"
|
ha_iot_class: "Local Push"
|
||||||
|
redirect_from:
|
||||||
|
- /components/binary_sensor.rpi_gpio/
|
||||||
|
- /components/cover.rpi_gpio/
|
||||||
|
- /components/switch.rpi_gpio/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages.
|
The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages.
|
||||||
|
|
||||||
|
## {% linkable_title Binary Sensor %}
|
||||||
|
|
||||||
|
The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
binary_sensor:
|
||||||
|
- platform: rpi_gpio
|
||||||
|
ports:
|
||||||
|
11: PIR Office
|
||||||
|
12: PIR Bedroom
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
ports:
|
||||||
|
description: List of used ports.
|
||||||
|
required: true
|
||||||
|
type: map
|
||||||
|
keys:
|
||||||
|
"port: name":
|
||||||
|
description: The port numbers (BCM mode pin numbers) and corresponding names.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
bouncetime:
|
||||||
|
description: The time in milliseconds for port debouncing.
|
||||||
|
required: false
|
||||||
|
type: integer
|
||||||
|
default: 50
|
||||||
|
invert_logic:
|
||||||
|
description: If `true`, inverts the output logic to ACTIVE LOW.
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
|
default: "`false` (ACTIVE HIGH)"
|
||||||
|
pull_mode:
|
||||||
|
description: >
|
||||||
|
Type of internal pull resistor to use.
|
||||||
|
Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
default: "`UP`"
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
|
||||||
|
|
||||||
|
## {% linkable_title Cover %}
|
||||||
|
|
||||||
|
The `rpi_gpio` cover platform allows you to use a Raspberry Pi to control your cover such as Garage doors.
|
||||||
|
|
||||||
|
It uses two pins on the Raspberry Pi.
|
||||||
|
|
||||||
|
- The `state_pin` will detect if the cover is closed, and
|
||||||
|
- the `relay_pin` will trigger the cover to open or close.
|
||||||
|
|
||||||
|
Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup).
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
cover:
|
||||||
|
- platform: rpi_gpio
|
||||||
|
covers:
|
||||||
|
- relay_pin: 10
|
||||||
|
state_pin: 11
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
relay_time:
|
||||||
|
description: The time that the relay will be on for in seconds.
|
||||||
|
required: false
|
||||||
|
default: 0.2
|
||||||
|
type: float
|
||||||
|
invert_relay:
|
||||||
|
description: Invert the relay pin output so that it is active-high (True).
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
state_pull_mode:
|
||||||
|
description: The direction the State pin is pulling. It can be UP or DOWN.
|
||||||
|
required: false
|
||||||
|
default: UP
|
||||||
|
type: string
|
||||||
|
invert_state:
|
||||||
|
description: Invert the value of the State pin so that 0 means closed.
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
covers:
|
||||||
|
description: List of your doors.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
relay_pin:
|
||||||
|
description: The pin of your Raspberry Pi where the relay is connected.
|
||||||
|
required: true
|
||||||
|
type: integer
|
||||||
|
state_pin:
|
||||||
|
description: The pin of your Raspberry Pi to retrieve the state.
|
||||||
|
required: true
|
||||||
|
type: integer
|
||||||
|
name:
|
||||||
|
description: The name to use in the frontend.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
## {% linkable_title Full example %}
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
cover:
|
||||||
|
- platform: rpi_gpio
|
||||||
|
relay_time: 0.2
|
||||||
|
invert_relay: false
|
||||||
|
state_pull_mode: 'UP'
|
||||||
|
invert_state: true
|
||||||
|
covers:
|
||||||
|
- relay_pin: 10
|
||||||
|
state_pin: 11
|
||||||
|
- relay_pin: 12
|
||||||
|
state_pin: 13
|
||||||
|
name: 'Right door'
|
||||||
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Remote Raspberry Pi Cover %}
|
||||||
|
|
||||||
|
If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/components/cover.mqtt/). Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover.
|
||||||
|
|
||||||
|
## {% linkable_title Switch %}
|
||||||
|
|
||||||
|
The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
|
||||||
|
|
||||||
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
|
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
switch:
|
||||||
|
- platform: rpi_gpio
|
||||||
|
ports:
|
||||||
|
11: Fan Office
|
||||||
|
12: Light Desk
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
ports:
|
||||||
|
description: Array of used ports.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
port:
|
||||||
|
description: Port numbers and corresponding names (GPIO #).
|
||||||
|
required: true
|
||||||
|
type: [integer, string]
|
||||||
|
invert_logic:
|
||||||
|
description: If true, inverts the output logic to ACTIVE LOW.
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
|
||||||
|
|
||||||
|
<p class='note warning'>
|
||||||
|
Note that a pin managed by HASS is expected to be exclusive to HASS.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
A common question is what does Port refer to, this number is the actual GPIO #, not the pin #.
|
||||||
|
For example, if you have a relay connected to pin 11 its GPIO # is 17.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
switch:
|
||||||
|
- platform: rpi_gpio
|
||||||
|
ports:
|
||||||
|
17: Speaker Relay
|
||||||
|
```
|
||||||
|
|||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Homematic Sensor"
|
|
||||||
description: "Instructions on how to integrate Homematic sensors within Home Assistant."
|
|
||||||
date: 2016-06-28 08:30
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: homematic.png
|
|
||||||
ha_category: Sensor
|
|
||||||
ha_release: 0.23
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
The `homematic` sensor platform lets you observe the state of [Homematic](http://www.homematic.com/) sensors through Home Assistant.
|
|
||||||
|
|
||||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "OpenUV Sensor"
|
|
||||||
description: "Instructions on how to integrate OpenUV sensors within Home Assistant."
|
|
||||||
date: 2018-07-31 22:01
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: openuv.jpg
|
|
||||||
ha_category: Health
|
|
||||||
ha_release: 0.76
|
|
||||||
ha_iot_class: "Cloud Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `openuv` sensor platform allows you to view sensor data from [OpenUV](http://openuv.io).
|
|
||||||
|
|
||||||
You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, sensors will automatically appear.
|
|
||||||
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "WaterFurnace Sensors"
|
|
||||||
description: "Instructions on how to integrate WaterFurnace Geothermal System sensors into Home Assistant."
|
|
||||||
date: 2018-01-19 17:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: waterfurnace.png
|
|
||||||
ha_category: Sensor
|
|
||||||
ha_release: 0.62
|
|
||||||
ha_iot_class: "Cloud Polling"
|
|
||||||
---
|
|
||||||
|
|
||||||
Integrates WaterFurnace sensors into Home Assistant. See the [main component](/components/waterfurnace/) for configuration instructions.
|
|
||||||
|
|
||||||
@ -1,60 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "BeagleBone Black GPIO Switch"
|
|
||||||
description: "Instructions on how to integrate the GPIO of a BeagleBone Black into Home Assistant as a switch."
|
|
||||||
date: 2017-01-14 10:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: beaglebone-black.png
|
|
||||||
ha_category: DIY
|
|
||||||
ha_release: 0.36
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
switch:
|
|
||||||
- platform: bbb_gpio
|
|
||||||
pins:
|
|
||||||
GPIO0_7:
|
|
||||||
name: LED Red
|
|
||||||
P9_12:
|
|
||||||
name: LED Green
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
pins:
|
|
||||||
description: List of used pins.
|
|
||||||
required: true
|
|
||||||
type: map
|
|
||||||
keys:
|
|
||||||
pin_name:
|
|
||||||
description: Port numbers and corresponding names.
|
|
||||||
required: true
|
|
||||||
type: map
|
|
||||||
keys:
|
|
||||||
name:
|
|
||||||
description: Friendly name to use for the frontend.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
initial:
|
|
||||||
description: Initial state of the pin.
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
invert_logic:
|
|
||||||
description: If `true`, inverts the input logic to ACTIVE LOW
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "HomeKit Switch"
|
|
||||||
description: "Instructions on how to setup HomeKit switches within Home Assistant."
|
|
||||||
date: 2017-03-19 21:08
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: apple-homekit.png
|
|
||||||
ha_category: Switch
|
|
||||||
ha_iot_class: "Local Polling"
|
|
||||||
ha_release: 0.68
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your HomeKit switches working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/).
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Homematic Switch"
|
|
||||||
description: "Instructions on how to integrate Homematic switches within Home Assistant."
|
|
||||||
date: 2016-06-28 08:30
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: homematic.png
|
|
||||||
ha_category: Switch
|
|
||||||
ha_release: 0.23
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `homematic` switch platform lets you control [Homematic](http://www.homematic.com/) switches through Home Assistant.
|
|
||||||
|
|
||||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
|
||||||
@ -1,63 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Raspberry Pi GPIO Switch"
|
|
||||||
description: "Instructions on how to integrate the GPIO of a Raspberry Pi into Home Assistant as a switch."
|
|
||||||
date: 2015-08-07 14:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: raspberry-pi.png
|
|
||||||
ha_category: DIY
|
|
||||||
ha_release: pre 0.7
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
switch:
|
|
||||||
- platform: rpi_gpio
|
|
||||||
ports:
|
|
||||||
11: Fan Office
|
|
||||||
12: Light Desk
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
ports:
|
|
||||||
description: Array of used ports.
|
|
||||||
required: true
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
port:
|
|
||||||
description: Port numbers and corresponding names (GPIO #).
|
|
||||||
required: true
|
|
||||||
type: [integer, string]
|
|
||||||
invert_logic:
|
|
||||||
description: If true, inverts the output logic to ACTIVE LOW.
|
|
||||||
required: false
|
|
||||||
default: false
|
|
||||||
type: boolean
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
|
|
||||||
|
|
||||||
<p class='note warning'>
|
|
||||||
Note that a pin managed by HASS is expected to be exclusive to HASS.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
A common question is what does Port refer to, this number is the actual GPIO #, not the pin #.
|
|
||||||
For example, if you have a relay connected to pin 11 its GPIO # is 17.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
switch:
|
|
||||||
- platform: rpi_gpio
|
|
||||||
ports:
|
|
||||||
17: Speaker Relay
|
|
||||||
```
|
|
||||||
@ -11,6 +11,8 @@ logo: waterfurnace.png
|
|||||||
ha_category: Sensor
|
ha_category: Sensor
|
||||||
ha_release: 0.62
|
ha_release: 0.62
|
||||||
ha_iot_class: "Cloud Polling"
|
ha_iot_class: "Cloud Polling"
|
||||||
|
redirect_frome:
|
||||||
|
- /components/sensor.waterfurnace/
|
||||||
---
|
---
|
||||||
|
|
||||||
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.
|
||||||
|
|||||||
@ -45,7 +45,7 @@ $ sudo apt-get upgrade -y
|
|||||||
Install the dependencies.
|
Install the dependencies.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ sudo apt-get install python3 python3-venv python3-pip
|
$ sudo apt-get install python3 python3-venv python3-pip libffi-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Add an account for Home Assistant called `homeassistant`.
|
Add an account for Home Assistant called `homeassistant`.
|
||||||
|
|||||||
@ -38,7 +38,7 @@ The Zigbee team is also planning a bunch of cool things for 2019. Direct device
|
|||||||
|
|
||||||
## {% linkable_title Noteworthy breaking changes %}
|
## {% linkable_title Noteworthy breaking changes %}
|
||||||
|
|
||||||
Update: the entity ID one was too harsh, it's not a warning.
|
Update: the entity ID one was too harsh, it's now a warning.
|
||||||
|
|
||||||
This release also includes two noteworthy breaking changes. One is a follow-up on the slugify breaking change from last release. We did not update the validation check for config options that need to be valid slugs. This means that some of your config values might be invalid. Keep an eye at the console as we have a new message to tell you which ones are wrong.
|
This release also includes two noteworthy breaking changes. One is a follow-up on the slugify breaking change from last release. We did not update the validation check for config options that need to be valid slugs. This means that some of your config values might be invalid. Keep an eye at the console as we have a new message to tell you which ones are wrong.
|
||||||
|
|
||||||
@ -102,6 +102,21 @@ Another noteworthy breaking change (sorry!), is that the automation `time` trigg
|
|||||||
[@starkillerOG]: https://github.com/starkillerOG
|
[@starkillerOG]: https://github.com/starkillerOG
|
||||||
[hue docs]: /components/hue/
|
[hue docs]: /components/hue/
|
||||||
|
|
||||||
|
## {% linkable_title Release 0.86.4 - January 28 %}
|
||||||
|
|
||||||
|
- Bumps aioasuswrt ([@kennedyshead] - [#20432]) ([asuswrt docs])
|
||||||
|
- Add check to validate gamut ([@starkillerOG] - [#20518])
|
||||||
|
- fix #20387 devices without model/protocol ([@fredrike] - [#20530]) ([tellduslive docs])
|
||||||
|
|
||||||
|
[#20432]: https://github.com/home-assistant/home-assistant/pull/20432
|
||||||
|
[#20518]: https://github.com/home-assistant/home-assistant/pull/20518
|
||||||
|
[#20530]: https://github.com/home-assistant/home-assistant/pull/20530
|
||||||
|
[@fredrike]: https://github.com/fredrike
|
||||||
|
[@kennedyshead]: https://github.com/kennedyshead
|
||||||
|
[@starkillerOG]: https://github.com/starkillerOG
|
||||||
|
[asuswrt docs]: /components/asuswrt/
|
||||||
|
[tellduslive docs]: /components/tellduslive/
|
||||||
|
|
||||||
## {% linkable_title If you need help... %}
|
## {% linkable_title If you need help... %}
|
||||||
|
|
||||||
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
|
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
|
||||||
|
|||||||
@ -120,14 +120,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the
|
|||||||
[pi2]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi2-1.13.img.gz
|
[pi2]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi2-1.13.img.gz
|
||||||
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-1.13.img.gz
|
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-1.13.img.gz
|
||||||
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-64-1.13.img.gz
|
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-64-1.13.img.gz
|
||||||
[tinker]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_tinker-2.6.img.gz
|
[tinker]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_tinker-2.7.img.gz
|
||||||
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_odroid-c2-2.6.img.gz
|
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_odroid-c2-2.7.img.gz
|
||||||
[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_odroid-xu4-2.6.img.gz
|
[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_odroid-xu4-2.7.img.gz
|
||||||
[opi-prime]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_opi-prime-2.6.img.gz
|
[opi-prime]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_opi-prime-2.7.img.gz
|
||||||
[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_intel-nuc-2.6.img.gz
|
[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_intel-nuc-2.7.img.gz
|
||||||
[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_ova-1.13.vmdk.gz
|
[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_ova-1.13.vmdk.gz
|
||||||
[vhdx]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_ova-2.6.vhdx.gz
|
[vhdx]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_ova-2.7.vhdx.gz
|
||||||
[vdi]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_ova-2.6.vdi.gz
|
[vdi]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_ova-2.7.vdi.gz
|
||||||
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
|
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
|
||||||
[local]: http://hassio.local:8123
|
[local]: http://hassio.local:8123
|
||||||
[samba]: /addons/samba/
|
[samba]: /addons/samba/
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user