From 8ae4eb060621de5ed62fd358abc153f540573f4a Mon Sep 17 00:00:00 2001 From: Mattias Welponer Date: Sun, 5 Aug 2018 15:06:01 +0200 Subject: [PATCH 1/3] Update HomematicIP --- source/_components/homematicip_cloud.markdown | 66 ++++++++++++++----- 1 file changed, 51 insertions(+), 15 deletions(-) diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 70f90d77af99..bd11e5a4f98a 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -14,31 +14,67 @@ ha_release: 0.66 featured: false --- +## HomematicIP + The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. -For for communication [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used. +For for communication [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used. Since there is no official documentation about this API everything was done via reverse engineering. Use at your own risk. -To set up the component: +### Setup the component via interface -- generate the authentication token: -```yaml -generate_auth_token.py -``` +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 internaly. -- add the information to your `configuration.yaml` file: -```yaml +### Setup the component via `configuration.yaml`: + +Generate the authentication token: + +`generate_auth_token.py` + +Add the information to your `configuration.yaml` file: + +``` homematicip_cloud: - accesspoint: IDENTIFIER authtoken: AUTHTOKEN - name: Location2 accesspoint: IDENTIFIER2 - authtoken: AUTHTOKEN2 + authtoken: AUTHTOKEN2 ``` Configuration variables (global): +* **name**: (*Optional*): Name to identify your access point, this will be used to prefix your device names. +* **accesspoint**: (*Required*): This is the access point id (SGTIN) +* **authtoken**: (*Required*): Authentification token generated with `generate_auth_token.py`. -- **name** (*Optional*): Name to identify your access point, this will be - used to prefix your device names. -- **accesspoint** (*Required*): This is the access point id (SGTIN) -- **authtoken** (*Required*): Authentification token generated with -`generate_auth_token.py`. - +### Actual implemented and tested + * homematicip_cloud.alarm_control_panel + - [x] Security zones (*HmIP-SecurityZone*) + + * homematicip_cloud.binary_sensor + - [x] Window and door contact (*HmIP-SWDO*) + - [x] Smoke sensor and alarm (*HmIP-SWSD*) + - [x] Motion detectors (*HmIP-SMI*) + - [x] Motion detectors and push button (*HmIP-SMI55*) + + * homematicip_cloud.climate + - [x] Radiator thermostat (*HmIP-eTRV,-2*) + - [x] Climate group (*HmIP-HeatingGroup*) + + * homematicip_cloud.light + - [x] Switch actuator and meter for brand switches (*HmIP-BSM*) + - [x] Dimming actuator for brand switches (*HmIP-BDT*) + + * homematicip_cloud.sensor + - [x] Accesspoint duty-cycle (*HmIP-HAP*) + - [x] Wall-mounted thermostat (*HmIP-WTH*) + - [x] Temperature and humidity sensor (*HmIP-STH*) + - [x] Temperature and humidity Sensor with display (*HmIP-STHD*) + - [x] Illuminance sensor (*HmIP-SMI, 55*) + + * homematicip_cloud.switch + - [x] Pluggable Switch and Meter (*HmIP-PSM*) From 8bcc0a5fc25954593359ba2a11e543471a8ee2ab Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 9 Aug 2018 17:02:37 +0200 Subject: [PATCH 2/3] :pencil2: Rewrite, layout, spelling, grammar --- source/_components/homematicip_cloud.markdown | 79 +++++++++++-------- 1 file changed, 44 insertions(+), 35 deletions(-) diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index bd11e5a4f98a..724c223a36b1 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -14,22 +14,20 @@ ha_release: 0.66 featured: false --- -## HomematicIP - The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. -For for communication [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used. Since there is no official documentation about this API everything was done via reverse engineering. Use at your own risk. +For for communication [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used. Since there is no official documentation about this API, everything was done via reverse engineering. Use at your own risk. -### Setup the component via interface +## {% linkable_title Setup the component via the frontend %} Menu: *Configuration* -> *Integrations* Fill the form: -* your **access point ID** (SGTIN) +* 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 internaly. +The authentification token will be generated and stored internally. -### Setup the component via `configuration.yaml`: +## {% linkable_title Setup the component using the configuration files %} Generate the authentication token: @@ -37,7 +35,7 @@ Generate the authentication token: Add the information to your `configuration.yaml` file: -``` +```yaml homematicip_cloud: - accesspoint: IDENTIFIER authtoken: AUTHTOKEN @@ -46,35 +44,46 @@ homematicip_cloud: authtoken: AUTHTOKEN2 ``` -Configuration variables (global): -* **name**: (*Optional*): Name to identify your access point, this will be used to prefix your device names. -* **accesspoint**: (*Required*): This is the access point id (SGTIN) -* **authtoken**: (*Required*): Authentification token generated with `generate_auth_token.py`. +{% configuration %} +name: + required: false + description: Name to identify your access point, this will be used to prefix your device names. + type: string +accesspoint: + required: true + description: This is the access point ID (SGTIN). + type: string +authtoken: + required: true + description: "Authentication token generated with `generate_auth_token.py`." + type: string +{% endconfiguration %} -### Actual implemented and tested - * homematicip_cloud.alarm_control_panel - - [x] Security zones (*HmIP-SecurityZone*) - - * homematicip_cloud.binary_sensor - - [x] Window and door contact (*HmIP-SWDO*) - - [x] Smoke sensor and alarm (*HmIP-SWSD*) - - [x] Motion detectors (*HmIP-SMI*) - - [x] Motion detectors and push button (*HmIP-SMI55*) +## {% linkable_title Implemented and tested devices %} + +- homematicip_cloud.alarm_control_panel + - Security zones (*HmIP-SecurityZone*) + +- homematicip_cloud.binary_sensor + - Window and door contact (*HmIP-SWDO*) + - Smoke sensor and alarm (*HmIP-SWSD*) + - Motion detectors (*HmIP-SMI*) + - Motion detectors and push button (*HmIP-SMI55*) - * homematicip_cloud.climate - - [x] Radiator thermostat (*HmIP-eTRV,-2*) - - [x] Climate group (*HmIP-HeatingGroup*) +- homematicip_cloud.climate + - Radiator thermostat (*HmIP-eTRV,-2*) + - Climate group (*HmIP-HeatingGroup*) - * homematicip_cloud.light - - [x] Switch actuator and meter for brand switches (*HmIP-BSM*) - - [x] Dimming actuator for brand switches (*HmIP-BDT*) +- homematicip_cloud.light + - Switch actuator and meter for brand switches (*HmIP-BSM*) + - Dimming actuator for brand switches (*HmIP-BDT*) - * homematicip_cloud.sensor - - [x] Accesspoint duty-cycle (*HmIP-HAP*) - - [x] Wall-mounted thermostat (*HmIP-WTH*) - - [x] Temperature and humidity sensor (*HmIP-STH*) - - [x] Temperature and humidity Sensor with display (*HmIP-STHD*) - - [x] Illuminance sensor (*HmIP-SMI, 55*) +- 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*) + - Illuminance sensor (*HmIP-SMI, 55*) - * homematicip_cloud.switch - - [x] Pluggable Switch and Meter (*HmIP-PSM*) +- homematicip_cloud.switch + - Pluggable Switch and Meter (*HmIP-PSM*) From e5432c8cc4c82e12f1891abd7281fc6d1bff33cf Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 9 Aug 2018 17:18:34 +0200 Subject: [PATCH 3/3] :pencil2: Restructured the introduction text --- source/_components/homematicip_cloud.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 724c223a36b1..2a4c981e2e0e 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -14,8 +14,7 @@ ha_release: 0.66 featured: false --- -The [HomematicIP](http://www.homematic-ip.com) component platform is used as an interface to the cloud server. -For for communication [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used. Since there is no official documentation about this API, everything was done via reverse engineering. Use at your own risk. +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. ## {% linkable_title Setup the component via the frontend %}