diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 70f90d77af9..2a4c981e2e0 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -14,31 +14,75 @@ 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. +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. -To set up the component: +## {% linkable_title Setup the component via the frontend %} -- 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 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: -- add the information to your `configuration.yaml` file: ```yaml homematicip_cloud: - accesspoint: IDENTIFIER authtoken: AUTHTOKEN - name: Location2 accesspoint: IDENTIFIER2 - authtoken: AUTHTOKEN2 + authtoken: AUTHTOKEN2 ``` -Configuration variables (global): +{% 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 %} -- **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`. +## {% 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 + - 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*) + +- 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 + - Pluggable Switch and Meter (*HmIP-PSM*)