mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 08:16:53 +00:00
Merge branch 'current' into next
This commit is contained in:
Fabian Affolter
commit
76773cb618
@ -1,18 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Canary Alarm Control Panel"
|
||||
description: "Instructions on how to integrate your Canary devices into Home Assistant."
|
||||
date: 2017-12-07 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: canary.png
|
||||
ha_category: Alarm
|
||||
ha_release: "0.60"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `canary` alarm control panel platform allows you to integrate your [Canary](https://canary.is) alarm system in Home Assistant.
|
||||
|
||||
To add `canary` alarm control panel to your installation, follow instructions in [Canary component](/components/canary/).
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Envisalink Alarm"
|
||||
description: "Instructions on how to setup the Envisalink Alarm control panel within Home Assistant."
|
||||
date: 2016-07-01 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: eyezon.png
|
||||
ha_category: Alarm
|
||||
ha_release: 0.23
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `envisalink` alarm control panel platform allows you to control your [Envisalink](http://www.eyezon.com) alarms.
|
||||
|
||||
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "HomematicIP Cloud Alarm Control Panel"
|
||||
description: "Instructions on how to integrate HomematicIP alarm control panel into Home Assistant."
|
||||
date: 2018-05-18 22:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: homematicip_cloud.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.73
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `homematicip_cloud` alarm_control_panel platform allows you to control your [HomematicIP](https://www.homematic-ip.com) `Security Zones` through Home Assistant.
|
||||
|
||||
This component will automatically add `Security Zones` configured in your HomematicIP cloud.
|
||||
|
||||
Please refer to the
|
||||
[component](/components/homematicip_cloud/) configuration on how to setup HomematicIP Cloud.
|
||||
@ -1,20 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Envisalink Binary Sensor"
|
||||
description: "Instructions on how to integrate Envisalink binary sensors into Home Assistant."
|
||||
date: 2016-07-01 08:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: eyezon.png
|
||||
ha_release: 0.23
|
||||
ha_category: Binary Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.
|
||||
|
||||
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.
|
||||
|
||||
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "HomematicIP Cloud Binary Sensor"
|
||||
description: "Instructions on how to integrate HomematicIP binary sensors within Home Assistant."
|
||||
date: 2018-04-02 13:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: homematicip_cloud.png
|
||||
ha_category: Binary Sensor
|
||||
ha_release: 0.70
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `homematicip_cloud` binary_switch platform allows you to control
|
||||
[HomematicIP](http://www.homematic-ip.com) binary sensors through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the
|
||||
[component](/components/homematicip_cloud/) configuration on how to setup
|
||||
HomematicIP Cloud.
|
||||
@ -1,34 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Canary Camera"
|
||||
description: "Instructions on how to integrate your Canary devices into Home Assistant."
|
||||
date: 2017-12-07 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: canary.png
|
||||
ha_category: Camera
|
||||
ha_release: "0.60"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured.
|
||||
|
||||
To add `canary` camera to your installation, follow instructions in [Canary component](/components/canary/). Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings:
|
||||
|
||||
```yaml
|
||||
camera:
|
||||
- platform: canary
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
ffmpeg_arguments:
|
||||
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
@ -8,13 +8,26 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: canary.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Camera
|
||||
- Sensor
|
||||
ha_release: "0.60"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
redirect_from:
|
||||
- /components/alarm_control_panel.canary/
|
||||
- /components/camera.canary/
|
||||
- /components/sensor.canary/
|
||||
---
|
||||
|
||||
The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Alarm
|
||||
- [Camera](#camera)
|
||||
- [Sensor](#sensor)
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You will need your Canary login information (username, usually your email address, and password) to use this module.
|
||||
@ -46,8 +59,42 @@ timeout:
|
||||
|
||||
Once loaded, your front end will have the following components:
|
||||
|
||||
* A camera image triggered by motion for each camera.
|
||||
* An alarm control panel for each location.
|
||||
* A sensor per camera that reports temperature.
|
||||
* A sensor per camera that reports humidity.
|
||||
* A sensor per camera that reports air quality.
|
||||
- A camera image triggered by motion for each camera.
|
||||
- An alarm control panel for each location.
|
||||
- A sensor per camera that reports temperature.
|
||||
- A sensor per camera that reports humidity.
|
||||
- A sensor per camera that reports air quality.
|
||||
|
||||
## {% linkable_title Camera %}
|
||||
|
||||
The `canary` camera platform allows you to watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured.
|
||||
|
||||
Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings:
|
||||
|
||||
```yaml
|
||||
camera:
|
||||
- platform: canary
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
ffmpeg_arguments:
|
||||
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Sensor %}
|
||||
|
||||
The `canary` sensor platform allows you to integrate the sensors of your [Canary](https://canary.is) devices in Home Assistant.
|
||||
|
||||
To add `canary` sensors to your installation, follow instructions above.
|
||||
|
||||
Once loaded, you will see following sensors:
|
||||
|
||||
- A sensor per camera that reports temperature.
|
||||
- A sensor per camera that reports humidity.
|
||||
- A sensor per camera that reports air quality.
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "HomematicIP Cloud Climate"
|
||||
description: "Instructions on how to integrate HomematicIP climate within Home Assistant."
|
||||
date: 2018-05-18 22:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: homematicip_cloud.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.71
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `homematicip_cloud` climate platform allows you to control
|
||||
[HomematicIP](https://www.homematic-ip.com) climate through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the
|
||||
[component](/components/homematicip_cloud/) configuration on how to setup
|
||||
HomematicIP Cloud.
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "HomematicIP Cloud Cover"
|
||||
description: "Instructions on how to integrate HomematicIP covers within Home Assistant."
|
||||
date: 2019-01-13 13:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: homematicip_cloud.png
|
||||
ha_category: Cover
|
||||
ha_release: 0.87
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `homematicip_cloud` cover platform allows you to control
|
||||
[HomematicIP](http://www.homematic-ip.com) covers through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the
|
||||
[component](/components/homematicip_cloud/) configuration on how to setup
|
||||
HomematicIP Cloud.
|
||||
@ -8,9 +8,16 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: eyezon.png
|
||||
ha_category: Alarm
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
ha_release: 0.23
|
||||
ha_iot_class: "Local Push"
|
||||
redirect_from:
|
||||
- /components/alarm_control_panel.envisalink/
|
||||
- /components/binary_sensor.envisalink/
|
||||
- /components/sensor.envisalink/
|
||||
---
|
||||
|
||||
The `envisalink` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this component is built. Currently, the Envisalink version 4 is the latest model. This component supports both the evl3 and the evl4.
|
||||
@ -19,9 +26,9 @@ Please visit the [eyezon website](http://www.eyezon.com/) for further informatio
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](/components/binary_sensor.envisalink/): Reports on zone status
|
||||
- [Sensor](/components/sensor.envisalink/): Emulates an alpha-numeric keypad attached to the alarm panel
|
||||
- [Alarm Control Panel](/components/alarm_control_panel.envisalink/): Reports on partition status, and can be used to arm/disarm the system
|
||||
- Binary Sensor: Reports on zone status (Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.)
|
||||
- Sensor: Emulates an alpha-numeric keypad attached to the alarm panel
|
||||
- Alarm Control Panel: Reports on partition status, and can be used to arm/disarm the system
|
||||
|
||||
This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.
|
||||
|
||||
|
||||
@ -8,30 +8,57 @@ comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: homematicip_cloud.png
|
||||
ha_category: Hub
|
||||
ha_category:
|
||||
- Hub
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Climate
|
||||
- Cover
|
||||
- Light
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_iot_class: "Cloud Push"
|
||||
ha_release: 0.66
|
||||
featured: false
|
||||
redirect_from:
|
||||
- /components/alarm_control_panel.homematicip_cloud/
|
||||
- /components/binary_sensor.homematicip_cloud/
|
||||
- /components/climate.homematicip_cloud/
|
||||
- /components/cover.homematicip_cloud/
|
||||
- /components/light.homematicip_cloud/
|
||||
- /components/sensor.homematicip_cloud/
|
||||
- /components/switch.homematicip_cloud/
|
||||
---
|
||||
|
||||
The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. The [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used for communicating. Use at your own risk.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
* Alarm
|
||||
* Binary Sensor
|
||||
* Climate
|
||||
* Cover
|
||||
* Light
|
||||
* Sensor
|
||||
* Switch
|
||||
|
||||
## {% linkable_title Setup the component via the frontend %}
|
||||
|
||||
Menu: *Configuration* -> *Integrations*
|
||||
|
||||
|
||||
Fill the form:
|
||||
|
||||
* Your **access point ID** (SGTIN)
|
||||
* Optional a **name** to identify your access point, this will be used to prefix your device names.
|
||||
|
||||
|
||||
The authentification token will be generated and stored internally.
|
||||
|
||||
## {% linkable_title Setup the component using the configuration files %}
|
||||
|
||||
|
||||
Generate the authentication token:
|
||||
|
||||
|
||||
`generate_auth_token.py`
|
||||
|
||||
|
||||
Add the information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -60,36 +87,40 @@ authtoken:
|
||||
|
||||
## {% linkable_title Implemented and tested devices %}
|
||||
|
||||
- homematicip_cloud.alarm_control_panel
|
||||
- Security zones (*HmIP-SecurityZone*)
|
||||
* homematicip_cloud.alarm_control_panel
|
||||
* Security zones (*HmIP-SecurityZone*)
|
||||
|
||||
- homematicip_cloud.binary_sensor
|
||||
- Window and door contact (*HmIP-SWDO, HmIP-SWDO-I*)
|
||||
- Rotary Handle Sensor (*HmIP-SRH*)
|
||||
- Smoke sensor and alarm (*HmIP-SWSD*)
|
||||
- Motion detectors (*HmIP-SMI*)
|
||||
- Motion detectors and push button (*HmIP-SMI55*)
|
||||
- Water detector (*HmIP-SWD*)
|
||||
|
||||
- homematicip_cloud.climate
|
||||
- Radiator thermostat (*HmIP-eTRV,-2*)
|
||||
- Climate group (*HmIP-HeatingGroup*)
|
||||
|
||||
- homematicip_cloud.light
|
||||
- Switch actuator and meter for brand switches (*HmIP-BSM*)
|
||||
- Dimming actuator for brand switches (*HmIP-BDT*)
|
||||
- Switch Actuator for brand switches – with signal lamp (*HmIP-BSL*)
|
||||
|
||||
- homematicip_cloud.sensor
|
||||
- Accesspoint duty-cycle (*HmIP-HAP*)
|
||||
- Wall-mounted thermostat (*HmIP-WTH*)
|
||||
- Temperature and humidity sensor (*HmIP-STH*)
|
||||
- Temperature and humidity Sensor with display (*HmIP-STHD*)
|
||||
- Outdoor temperature and humidity sensor (*HmIP-STHO*)
|
||||
- Illuminance sensor (*HmIP-SMI, 55*)
|
||||
- Light sensor Outdoor (*HmIP-SLO*)
|
||||
|
||||
- homematicip_cloud.switch
|
||||
- Pluggable Switch and Meter (*HmIP-PSM*)
|
||||
- Full flush Switch and Meter (*HmIP-FSM, HmIP-FSM16*)
|
||||
* homematicip_cloud.binary_sensor
|
||||
* Window and door contact (*HmIP-SWDO, -I*)
|
||||
* Rotary Handle Sensor (*HmIP-SRH*)
|
||||
* Smoke sensor and alarm (*HmIP-SWSD*)
|
||||
* Motion detectors (*HmIP-SMI*)
|
||||
* Water detector (*HmIP-SWD*)
|
||||
|
||||
* homematicip_cloud.climate
|
||||
* Radiator thermostat (*HmIP-eTRV,-2*) - should also work with (*HmIP-eTRV-2-UK, -B, -B1, -C*)
|
||||
* Climate group (*HmIP-HeatingGroup*)
|
||||
|
||||
* homematicip_cloud.light
|
||||
* Switch actuator and meter for brand switches (*HmIP-BSM*)
|
||||
* Dimming actuator for brand switches (*HmIP-BDT*)
|
||||
* Dimming actuator flush-mount (*HmIP-FDT*)
|
||||
* Switch Actuator and Meter – flush-mount (*HmIP-FSM*)
|
||||
|
||||
* homematicip_cloud.sensor
|
||||
* Accesspoint duty-cycle (*HmIP-HAP, -B1*)
|
||||
* Wall-mounted thermostat (*HmIP-WTH, -2*)
|
||||
* Temperature and humidity sensor (*HmIP-STH*)
|
||||
* Temperature and humidity Sensor with display (*HmIP-STHD*)
|
||||
* Outdoor temperature and humidity sensor (*HmIP-STHO, -A*)
|
||||
* Illuminance sensor (*HmIP-SMI*)
|
||||
|
||||
* homematicip_cloud.switch
|
||||
* Pluggable Switch (*HmIP-PS*)
|
||||
* Pluggable Switch and Meter (*HmIP-PSM*) - should also work with (*HmIP-PSM-CH, -IT, -UK, -PE*)
|
||||
|
||||
* homematicip_cloud.shutter
|
||||
* Blind actuator for brand switches (*HmIP-BBL*)
|
||||
* Shutter actuator brand-mount (*HmIP-BROLL*)
|
||||
* Shutter actuator flush-mount (*HmIP-FROLL*)
|
||||
|
||||
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "HomematicIP Cloud Light"
|
||||
description: "Instructions on how to integrate HomematicIP light switches within Home Assistant."
|
||||
date: 2018-04-02 13:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: homematicip_cloud.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.70
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `homematicip_cloud` light platform allows you to control
|
||||
[HomematicIP](http://www.homematic-ip.com) light switches through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the
|
||||
[component](/components/homematicip_cloud/) configuration on how to setup
|
||||
HomematicIP Cloud.
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Canary Sensor"
|
||||
description: "Instructions on how to integrate your Canary devices into Home Assistant."
|
||||
date: 2017-12-07 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: canary.png
|
||||
ha_category: Environment
|
||||
ha_release: "0.60"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `canary` sensor platform allows you to integrate the sensors of your [Canary](https://canary.is) devices in Home Assistant.
|
||||
|
||||
To add `canary` sensors to your installation, follow instructions in [Canary component](/components/canary/).
|
||||
|
||||
Once loaded, you will see following sensors:
|
||||
|
||||
* A sensor per camera that reports temperature.
|
||||
* A sensor per camera that reports humidity.
|
||||
* A sensor per camera that reports air quality.
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Envisalink Sensor"
|
||||
description: "Instructions on how to integrate Envisalink sensors into Home Assistant."
|
||||
date: 2016-07-01 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: eyezon.png
|
||||
ha_release: 0.23
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) sensors from within Home Assistant.
|
||||
|
||||
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).
|
||||
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "HomematicIP Cloud Sensor"
|
||||
description: "Instructions on how to integrate HomematicIP sensors within Home Assistant."
|
||||
date: 2018-04-02 13:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: homematicip_cloud.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.66
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `homematicip_cloud` sensor platform allows you to control
|
||||
[HomematicIP](http://www.homematicip.de) sensors through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the
|
||||
[component](/components/homematicip_cloud/) configuration on how to setup
|
||||
HomematicIP Cloud.
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: "HomematicIP Cloud Switch"
|
||||
description: "Instructions on how to integrate HomematicIP switches within Home Assistant."
|
||||
date: 2018-04-02 13:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: homematicip_cloud.png
|
||||
ha_category: Switch
|
||||
ha_release: 0.70
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
The `homematicip_cloud` switch platform allows you to control
|
||||
[HomematicIP](http://www.homematic-ip.com) switches through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the
|
||||
[component](/components/homematicip_cloud/) configuration on how to setup
|
||||
HomematicIP Cloud.
|
||||
Loading…
x
Reference in New Issue
Block a user