[solarwatt] Initial contribution for solarwatt energy manager #10091

sven-carstens · 2021-02-07T15:04:12Z

Binding to query a solarwatt energy manager and read the values of all attached devices.

All supported values and devices were discovered while playing with my own energy manager.

No write support yet, as it seems to have limited use.

The implementation off the energy manager device itself seems to be based on work from Kiwigrid. As there seems to be no public documentation about any of the devices
everything covered in this binding is based on guesswork and estimates.

Therefore I would love to get feedback from other owners and especially their configured devices.

openhab-bot · 2021-02-07T15:10:07Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/solarwatt-energymanager-binding/116620/1

openhab-bot · 2021-02-08T12:31:27Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/solarwatt-new-binding-for-solarwatt-energy-manager/116452/1

bundles/org.openhab.binding.solarwatt/README.md

bundles/org.openhab.binding.solarwatt/src/main/resources/OH-INF/thing/thing-types.xml

bundles/org.openhab.binding.solarwatt/README.md

...g.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/SolarwattConfiguration.java

....solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/SolarwattHandlerFactory.java

...ing.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/dto/DeviceDTO.java

...ng.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/model/GridFlow.java

...ng.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/model/Location.java

...rwatt/src/main/java/org/openhab/binding/solarwatt/internal/handler/EnergyManagerHandler.java

.../java/org/openhab/binding/solarwatt/internal/discovery/SolarwattDevicesDiscoveryService.java

fwolter

Thanks for your contribution! I reviewed your code and here is my feedback.

bundles/org.openhab.binding.solarwatt/README.md

...c/main/java/org/openhab/binding/solarwatt/internal/channel/SolarwattChannelTypeProvider.java

bundles/org.openhab.binding.solarwatt/README.md

...att/src/main/java/org/openhab/binding/solarwatt/internal/handler/EnergyManagerConnector.java

...arwatt/src/main/java/org/openhab/binding/solarwatt/internal/handler/SimpleDeviceHandler.java

bundles/org.openhab.binding.solarwatt/src/main/resources/OH-INF/thing/thing-types.xml

bundles/org.openhab.binding.solarwatt/README.md

...att/src/main/java/org/openhab/binding/solarwatt/internal/handler/EnergyManagerConnector.java

...rwatt/src/main/java/org/openhab/binding/solarwatt/internal/handler/EnergyManagerHandler.java

...arwatt/src/main/java/org/openhab/binding/solarwatt/internal/handler/SimpleDeviceHandler.java

…ustom tracking of child handlers, fix wrong calculation of the "direct consumed" values. Signed-off-by: Sven Carstens <s.carstens@gmx.de>

…tations. Signed-off-by: Sven Carstens <s.carstens@gmx.de>

Signed-off-by: Sven Carstens <s.carstens@gmx.de>

…gStatus.OFFLINE Signed-off-by: Sven Carstens <s.carstens@gmx.de>

…e status. Signed-off-by: Sven Carstens <s.carstens@gmx.de>

Signed-off-by: Sven Carstens <s.carstens@gmx.de>

fwolter · 2021-05-26T19:14:43Z

Are you finished incorporating all review findings?

sven-carstens · 2021-05-27T15:37:01Z

Hi,

everything should be fixed and marked as resolved on github.

fwolter

There are some checkstyle warnings left. You could take a look at target/code-analysis/report.html.

bundles/org.openhab.binding.solarwatt/README.md

...rwatt/src/main/java/org/openhab/binding/solarwatt/internal/handler/EnergyManagerHandler.java

bundles/org.openhab.binding.solarwatt/src/main/resources/OH-INF/thing/thing-types.xml

Signed-off-by: Sven Carstens <s.carstens@gmx.de>

fwolter

Here is the output of mvn clean install:

[INFO] --- sat-plugin:0.11.1:report (sat-all) @ org.openhab.binding.solarwatt ---
[INFO] Individual report appended to summary report.
[ERROR] Code Analysis Tool has found:
 1 error(s)!
 7 warning(s)
 3 info(s)
[ERROR] .binding.solarwatt\README.md:[1]
Datei endet nicht mit einem Zeilenumbruch.
[WARNING] .binding.solarwatt\README.md:[33]
Missing an empty line after the Markdown header (#).
[WARNING] org.openhab.binding.solarwatt.internal.channel.SolarwattChannelTypeProvider.java:[28]
Stern-Importe der Form '.*' sollten vermieden werden - org.openhab.core.thing.type.*.
[WARNING] org.openhab.binding.solarwatt.internal.discovery.SolarwattDevicesDiscoveryService.java:[24]
Stern-Importe der Form '.*' sollten vermieden werden - org.openhab.binding.solarwatt.internal.domain.model.*.
[WARNING] org.openhab.binding.solarwatt.internal.domain.dto.DeviceDTO.java:[26]
Stern-Importe der Form '.*' sollten vermieden werden - com.google.gson.*.
[WARNING] org.openhab.binding.solarwatt.internal.factory.EnergyManagerDevicesFactory.java:[20]
Stern-Importe der Form '.*' sollten vermieden werden - org.openhab.binding.solarwatt.internal.domain.model.*.
[WARNING] org.openhab.binding.solarwatt.internal.handler.EnergyManagerHandler.java:[18]
Stern-Importe der Form '.*' sollten vermieden werden - java.time.*.
[WARNING] org.openhab.binding.solarwatt.internal.handler.SimpleDeviceHandler.java:[30]
Stern-Importe der Form '.*' sollten vermieden werden - org.openhab.core.thing.*.

bundles/org.openhab.binding.solarwatt/src/main/resources/OH-INF/config/config.xml

...rwatt/src/main/java/org/openhab/binding/solarwatt/internal/handler/EnergyManagerHandler.java

Signed-off-by: Sven Carstens <s.carstens@gmx.de>

fwolter

LGTM

Now, you could add your binding's logo to the openHAB website. See https://next.openhab.org/docs/developer/bindings/#add-your-binding-s-logo-to-the-openhab-website

…b#10091) * [ADD] First version which was tested with my local setup. Signed-off-by: Sven Carstens <s.carstens@gmx.de> Signed-off-by: Sven Carstens <sven.carstens@aoe.com> * [ADD] Refactoring, add calculated value for direct self consumption and prepare for more. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [ADD] Add chanel description to README and make some channels advanced. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Remove wrong colon in channel types. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Put colon at the right place in channel types. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Fix spelling of PVPlant in constants and things. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Separate channelName from energy manager tagName. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Reduce loglevels and fix findings from code-analysis. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Move all custom calculations to the handler instances, remove custom tracking of child handlers, fix wrong calculation of the "direct consumed" values. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove unnecessary Nullable and NotNull annotations. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Change wrong ItemType for power items in README Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Change modeConverter to Switch Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Relay stateDevice to Thing status, anything but "OK" means ThingStatus.OFFLINE Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Remove stateDevice from items as it is represented by the device status. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove unnecessary logging. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Allow child things to be configured by hand with a guid. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Allow child things to be configured by hand with a guid. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and move things config to separate config.xml Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove all trace/debug logging. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Use real channel timestamp as the refresh trigger. Signed-off-by: Sven Carstens <s.carstens@gmx.de> Co-authored-by: Sven Carstens <sven.carstens@aoe.com>

…b#10091) * [ADD] First version which was tested with my local setup. Signed-off-by: Sven Carstens <s.carstens@gmx.de> Signed-off-by: Sven Carstens <sven.carstens@aoe.com> * [ADD] Refactoring, add calculated value for direct self consumption and prepare for more. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [ADD] Add chanel description to README and make some channels advanced. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Remove wrong colon in channel types. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Put colon at the right place in channel types. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Fix spelling of PVPlant in constants and things. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Separate channelName from energy manager tagName. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Reduce loglevels and fix findings from code-analysis. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Move all custom calculations to the handler instances, remove custom tracking of child handlers, fix wrong calculation of the "direct consumed" values. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove unnecessary Nullable and NotNull annotations. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Change wrong ItemType for power items in README Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Change modeConverter to Switch Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Relay stateDevice to Thing status, anything but "OK" means ThingStatus.OFFLINE Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Remove stateDevice from items as it is represented by the device status. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove unnecessary logging. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Allow child things to be configured by hand with a guid. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Allow child things to be configured by hand with a guid. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and move things config to separate config.xml Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove all trace/debug logging. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Use real channel timestamp as the refresh trigger. Signed-off-by: Sven Carstens <s.carstens@gmx.de> Co-authored-by: Sven Carstens <sven.carstens@aoe.com> Signed-off-by: Luca Calcaterra <calcaterra.luca@gmail.com>

…b#10091) * [ADD] First version which was tested with my local setup. Signed-off-by: Sven Carstens <s.carstens@gmx.de> Signed-off-by: Sven Carstens <sven.carstens@aoe.com> * [ADD] Refactoring, add calculated value for direct self consumption and prepare for more. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [ADD] Add chanel description to README and make some channels advanced. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Remove wrong colon in channel types. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Put colon at the right place in channel types. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Fix spelling of PVPlant in constants and things. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Separate channelName from energy manager tagName. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Reduce loglevels and fix findings from code-analysis. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Move all custom calculations to the handler instances, remove custom tracking of child handlers, fix wrong calculation of the "direct consumed" values. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove unnecessary Nullable and NotNull annotations. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Change wrong ItemType for power items in README Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Change modeConverter to Switch Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Relay stateDevice to Thing status, anything but "OK" means ThingStatus.OFFLINE Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Remove stateDevice from items as it is represented by the device status. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove unnecessary logging. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Allow child things to be configured by hand with a guid. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Allow child things to be configured by hand with a guid. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and move things config to separate config.xml Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Improve README and remove all trace/debug logging. Signed-off-by: Sven Carstens <s.carstens@gmx.de> * [MOD] Use real channel timestamp as the refresh trigger. Signed-off-by: Sven Carstens <s.carstens@gmx.de> Co-authored-by: Sven Carstens <sven.carstens@aoe.com>

cpmeister added the new binding If someone has started to work on a binding. For a new binding PR. label Feb 7, 2021

sven-carstens marked this pull request as ready for review February 12, 2021 07:22

sven-carstens changed the title ~~[solarwatt][WIP] Initial contribution for solarwatt energy manager~~ [solarwatt] Initial contribution for solarwatt energy manager Feb 12, 2021

Skinah reviewed Feb 18, 2021

View reviewed changes

bundles/org.openhab.binding.solarwatt/README.md Outdated Show resolved Hide resolved

Skinah reviewed Feb 18, 2021

View reviewed changes

bundles/org.openhab.binding.solarwatt/src/main/resources/OH-INF/thing/thing-types.xml Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

bundles/org.openhab.binding.solarwatt/README.md Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

bundles/org.openhab.binding.solarwatt/README.md Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

...g.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/SolarwattConfiguration.java Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

....solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/SolarwattHandlerFactory.java Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

...ing.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/dto/DeviceDTO.java Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

...ng.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/model/GridFlow.java Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

...ng.solarwatt/src/main/java/org/openhab/binding/solarwatt/internal/domain/model/Location.java Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

...rwatt/src/main/java/org/openhab/binding/solarwatt/internal/handler/EnergyManagerHandler.java Outdated Show resolved Hide resolved

Skinah reviewed Feb 20, 2021

View reviewed changes

.../java/org/openhab/binding/solarwatt/internal/discovery/SolarwattDevicesDiscoveryService.java Outdated Show resolved Hide resolved

sven-carstens requested a review from a team as a code owner March 8, 2021 07:09

fwolter requested changes Apr 4, 2021

View reviewed changes

Skinah reviewed Apr 24, 2021

View reviewed changes

bundles/org.openhab.binding.solarwatt/src/main/resources/OH-INF/thing/thing-types.xml Outdated Show resolved Hide resolved