From 8ce8476eeca4f28d21ef4a2feaacc19965ead156 Mon Sep 17 00:00:00 2001 From: bsmappee <58250533+bsmappee@users.noreply.github.com> Date: Fri, 19 Jun 2020 20:15:03 +0200 Subject: [PATCH] Update Smappee doc (#13764) Co-authored-by: Franck Nijhof --- source/_integrations/smappee.markdown | 60 +++++---------------------- 1 file changed, 10 insertions(+), 50 deletions(-) diff --git a/source/_integrations/smappee.markdown b/source/_integrations/smappee.markdown index cb198ad0442..b5aab16e442 100644 --- a/source/_integrations/smappee.markdown +++ b/source/_integrations/smappee.markdown @@ -1,81 +1,41 @@ --- title: Smappee description: Instructions on how to setup Smappee within Home Assistant. -ha_release: 0.64 ha_category: - Hub - Energy - Sensor - Switch -ha_iot_class: Local Push +ha_iot_class: Cloud polling +ha_release: 0.64 +ha_config_flow: true +ha_codeowners: + - '@bsmappee' ha_domain: smappee --- -The `smappee` integration adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. - -There is currently support for the following device types within Home Assistant: - -- Sensor -- Switch - -Will be automatically added when you connect to the Smappee controller. - -The smappee integration gets information from [Smappee API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview). Note: their cloud API now requires a subscription fee of €2.50 per month for Smappee Energy/Solar or €3 per month for Smappee Plus. +The Smappee integration will allow users to integrate their Smappee monitors, plugs and switches into Home Assistant using the [official API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview). ## Configuration -Info on how to get API access is described in the [smappy wiki](https://github.com/EnergieID/smappy/wiki). - -To use the `smappee` integration in your installation, add the following to your `configuration.yaml` file: +To use the Smappee integration you need a personal `client_id` and `client_secret` and add these to your `configuration.yaml` file. The `client_id` and `client_secret` can be obtained by contacting [support@smappee.com](mailto:support@smappee.com). ```yaml # Example configuration.yaml entry smappee: - host: 10.0.0.5 client_id: YOUR_CLIENT_ID client_secret: YOUR_CLIENT_SECRET - username: YOUR_MYSMAPPEE_USERNAME - password: YOUR_MYSMAPPEE_PASSWORD ``` -```yaml -# Minimal example configuration.yaml entry -smappee: - host: 10.0.0.5 -``` - -```yaml -# Cloud only example configuration.yaml entry -smappee: - client_id: YOUR_CLIENT_ID - client_secret: YOUR_CLIENT_SECRET - username: YOUR_MYSMAPPEE_USERNAME - password: YOUR_MYSMAPPEE_PASSWORD -``` +Once Home Assistant restarted, go to Configuration > Integrations and select the Smappee integration. You will be redirected to a login page and be able to select the locations you would like to use within Home Assistant. {% configuration %} -host: - description: Your Local Smappee unit IP. - required: false - type: string -host_password: - description: Your Local Smappee password. - required: false - type: string client_id: description: Your Smappee API client ID. - required: false + required: true type: string client_secret: description: Your Smappee API client secret. - required: false - type: string -username: - description: Your My Smappee username. - required: false - type: string -password: - description: Your My Smappee password. - required: false + required: true type: string {% endconfiguration %}