Support local Smappee Genius device (#17336)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
bsmappee 2021-04-25 12:15:11 +02:00 committed by GitHub
parent 65338f8ffb
commit 921c50fa5d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -20,20 +20,43 @@ ha_platforms:
- switch - switch
--- ---
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) or the limited local API. The Smappee integration will allow users to integrate their Smappee monitors, Smappee Comfort Plugs and Smappee Switches into Home Assistant using the [official cloud API](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview) or the limited local option.
## Smappee monitors
The table below summarizes the available options to initiate the Smappee integration in Home Assistant per Smappee monitor type.
|Monitor type|Local discovery|Cloud API|
|---|---|---|
|Smappee Energy|Yes|Yes|
|Smappee Solar|Yes|Yes|
|Smappee Plus|Yes|Yes|
|Smappee Pro|Yes|Yes|
|Smappee Genius|Yes|Yes|
|Smappee Connect|No|Yes|
|Smappee Wi-Fi Connect|No|Yes|
|Smappee P1/S1 module|No|Yes|
## Local discovery ## Local discovery
In most cases, the Smappee legacy devices (Energy and Solar) will be automatically discovered by Home Assistant through network scanning. In most cases, the Smappee Energy, Solar, Plus, Pro and Genius monitors will be automatically discovered by Home Assistant through network scanning.
Those automatically discovered Smappee devices are listed on the integrations page and can be configured without any additional details. Those automatically discovered Smappee devices are listed on the integrations page and can be configured without any additional details.
This will provide you a limited number of entities only (realtime power values, solar if applicable and the installed Smappee Comfort Plugs and Switches). This will provide you a limited number of entities only.
If your home network doesn't support mDNS you can still manually initiate the Smappee integration by choosing the LOCAL option and entering the IP address of the Smappee monitor through the configuration flow. If your home network doesn't support mDNS you can still manually initiate the Smappee integration by choosing the LOCAL option and entering the IP address of the Smappee monitor through the configuration flow.
If you have API credentials, we strongly suggest you use the Smappee cloud configured integration by following the scheme below. ### Sensor
A sensor entity is being added for the current active power usage. In case of solar production, an entity for active power production is added as well.
Smappee Genius devices will also provide entities for the current reactive, voltages for each phase and current active powers for each configured load (submeter).
### Switch
Switch entities are created for each Smappee Switch and Smappee Comfort Plug.
## Cloud API configuration ## Cloud API configuration
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 [info@smappee.com](mailto:info@smappee.com) and require a recurring monthly fee. To use the Smappee cloud 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 [info@smappee.com](mailto:info@smappee.com) and require a recurring monthly fee.
For any information about the use of the API please refer to the [Smappee API space](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview). For any information about the use of the API please refer to the [Smappee API space](https://smappee.atlassian.net/wiki/spaces/DEVAPI/overview).
```yaml ```yaml
@ -45,6 +68,30 @@ smappee:
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. 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.
Using the Smappee cloud integration allows you to access your Smappee monitor and other shared devices from outside your local network. Additionally a number of (binary) sensor entities become available as well.
### Sensor
Sensor entities are being added for the current active power usage,
the always-on active power, today's total consumption,
total consumption during the current hour, total consumption during the last 5 minutes
and the always-on (slumber) consumption from today. In case of solar production, entities for the active power production, today's total solar production
and the solar production during the current hour are added as well.
Smappee Pro, Plus and Genius devices will create current active powers for each configured load (submeter).
In case a Smappee Gas and/or Water meter is installed as well, an entity showing today's consumption is provided.
Additionally, Smappee Genius devices will also provide entities for the line voltages and phase voltages (for each phase).
### Switch
Switch entities are created for each Smappee Switch, Smappee Comfort Plug and Smappee Output module.
### Binary sensor
For each discovered NILM appliance a binary sensor is being added showing the current state of the appliance.
{% configuration %} {% configuration %}
client_id: client_id:
description: Your Smappee API client ID. description: Your Smappee API client ID.