[iammeter] Iammeter Binding initial contribution #8252

lewei50 · 2020-08-04T07:10:26Z

Initial contribution,Add support for Iammeter devices in Openhab.

Iammeter devices provides real-time readings of power meter over Wi-Fi.
The Iammeter binding is make data visualized in openhab system.

this binding had tested locally.

sorry that I closed PR 7799 accidentally and don't know how to open it again,so I opened this PR to continue my progress.
sorry to bother you with this.

TravisBuddy · 2020-08-04T07:20:56Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

TravisBuddy · 2020-08-04T07:21:19Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

fwolter · 2020-08-06T19:41:04Z

Did you finish making all changes from the old PR?

lewei50 · 2020-08-07T00:54:07Z

Did you finish making all changes from the old PR?

yes.

fwolter

Your changes from the other PR look good! Here is my detailed feedback.

There are some formatting issues. You can view them with mvn spotless:check -Dspotless.check.skip=false and fix them with mvn spotless:apply.

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

bundles/org.openhab.binding.iammeter/src/main/resources/ESH-INF/thing/thing-types.xml

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

...ding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterConfiguration.java

TravisBuddy · 2020-08-11T07:49:12Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

...ing.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterWEM3080Channel.java

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

...ng.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterWEM3080TChannel.java

bundles/org.openhab.binding.iammeter/src/main/resources/ESH-INF/thing/thing-types.xml

TravisBuddy · 2020-08-12T06:49:56Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

TravisBuddy · 2020-08-12T06:54:03Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

fwolter

LGTM

Since this is a new binding, another maintainer needs to review your code before it can be merged.

In the meantime, you can fix some formatting issues. You can view them with mvn spotless:check -Dspotless.check.skip=false and fix them with mvn spotless:apply.

Please also update your sign-offs in the commit messages. The real name is required. See https://www.openhab.org/docs/developer/contributing.html#sign-your-work

TravisBuddy · 2020-08-13T00:58:33Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

TravisBuddy · 2020-08-13T01:00:00Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

lewei50 · 2020-08-13T01:01:26Z

LGTM

Since this is a new binding, another maintainer needs to review your code before it can be merged.

In the meantime, you can fix some formatting issues. You can view them with mvn spotless:check -Dspotless.check.skip=false and fix them with mvn spotless:apply.

Please also update your sign-offs in the commit messages. The real name is required. See https://www.openhab.org/docs/developer/contributing.html#sign-your-work

Thanks for your help,I'v re-do the sign-off push.
thanks a lot!

TravisBuddy · 2020-08-13T01:02:04Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

Hilbrand

Thanks for your contribution. The code isn't to complex, but you might need look into how to improve some modelling related to the different types of devices. See my comment. If you have any questions or need some help feel free to ask.

Hilbrand · 2020-08-29T13:27:08Z

.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>


Please remove this file

file removed.

You've removed the wrong file 😉 This file is at the root, you removed the file in the binding. That file should not be removed.

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

bundles/org.openhab.binding.iammeter/pom.xml

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

bundles/org.openhab.binding.iammeter/src/main/resources/ESH-INF/thing/thing-types.xml

Hilbrand · 2020-08-29T15:06:38Z

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

+        }
+    }
+
+    protected void thingStructureChanged(String channelPrefix) {


This is not right. You should model the different types as different things. So in the xml you would see 2 things, 1 with all channels and 1 with the limited set of channels. You can then create 2 different classes, or maybe create 2 classes that each parse the specific data. and in the handler factory you can than pass that specific class to this handler based on the specific thing created.

thanks for your advice,I have separated those into 2 thingHandler now.

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

Hilbrand · 2020-08-29T15:17:10Z

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

+            updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
+                    "Communication error with the device: " + e.getMessage());
+        } catch (JsonSyntaxException je) {
+            logger.warn("Invalid JSON when refreshing source {}: {}", getThing().getUID(), je.getMessage());


In this case the status should probaly also be set to OFFLINE.

status set.

I don't see the updateStatus here. Is it done somewhere else?

Hilbrand · 2020-09-04T11:18:40Z

If you are able to fix the last review comments on short notice we'll be able to add this binding to openHAB 2.5.9. Otherwise it will go to openHAB 3.0.

yangbo1979 · 2020-09-04T14:10:57Z

If you are able to fix the last review comments on short notice we'll be able to add this binding to openHAB 2.5.9. Otherwise it will go to openHAB 3.0.

thanks for all your advices,I am working on fix them recently,and fixed them finally.
thanks again!

TravisBuddy · 2020-09-04T14:14:10Z

Travis tests have failed

Hey @lewei50,
please read the following log in order to understand the failure reason. There might also be some helpful tips along the way.
It will be awesome if you fix what is wrong and commit the changes.

TravisBuddy · 2020-09-04T14:19:12Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

TravisBuddy · 2020-09-04T14:44:03Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

Hilbrand

Where almost there. Just some comments related to you additional changes.

Hilbrand · 2020-09-04T14:51:15Z

.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>


You've removed the wrong file 😉 This file is at the root, you removed the file in the binding. That file should not be removed.

bundles/org.openhab.binding.iammeter/src/main/resources/ESH-INF/thing/3080.xml

Hilbrand · 2020-09-04T14:59:13Z

bundles/org.openhab.binding.iammeter/src/main/resources/ESH-INF/thing/3080.xml

+				<channel id="importenergy" typeId="importenergy"/>
+				<channel id="exportgrid" typeId="exportgrid"/>
+			</channels>
+		<config-description>


Because all configuration parameters for the 2 things are the same you can also put the configuration in a config/config.xml and reference here to that config. See some other bindings, search for config-description-ref.

Hilbrand · 2020-09-04T15:00:54Z

bundles/org.openhab.binding.iammeter/src/main/resources/ESH-INF/thing/3080T.xml

+		<label>Iammeter Power Meter 3080T</label>
+		<description>3 phases PowerMeter for Iammeter 3080T Binding</description>
+		<channel-groups>
+			<channel-group id="powerPhaseA" typeId="powerPhaseGroupA" />


You only need 1 group powerPhaseGroup. And for each group set label and description here:

Suggested change

<channel-group id="powerPhaseA" typeId="powerPhaseGroupA" />

<channel-group id="powerPhaseA" typeId="powerPhaseGroup" >

<label>Power Phase A</label>

<description>Power phase 1 for Iammeter device</description>

</channel-group>

Hilbrand · 2020-09-04T15:06:21Z

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

+            String content = "";
+            InputStream stream = new ByteArrayInputStream(content.getBytes(StandardCharsets.UTF_8));
+
+            String response = HttpUtil.executeUrl(httpMethod, url, stream, null, TIMEOUT_MS);


The stream is an empty String. Do you need to send something or does it also work to use:

Suggested change

String response = HttpUtil.executeUrl(httpMethod, url, stream, null, TIMEOUT_MS);

String response = HttpUtil.executeUrl(httpMethod, url, TIMEOUT_MS);

Same applies to the other handler

both changed.

Hilbrand · 2020-09-04T15:12:19Z

...ab.binding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterHandler.java

+            updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
+                    "Communication error with the device: " + e.getMessage());
+        } catch (JsonSyntaxException je) {
+            logger.warn("Invalid JSON when refreshing source {}: {}", getThing().getUID(), je.getMessage());


I don't see the updateStatus here. Is it done somewhere else?

Hilbrand · 2020-09-04T15:18:44Z

...nding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/Iammeter3080THandler.java

+            JsonElement iammeterDataElement = new JsonParser().parse(response);
+            JsonObject iammeterData = iammeterDataElement.getAsJsonObject();
+            String keyWord = "Datas";
+            if (iammeterData.has("Datas") && iammeterData.has("SN")) {
+                String groups[] = { "powerPhaseA", "powerPhaseB", "powerPhaseC" };
+                for (int row = 0; row < groups.length; row++) {
+                    String gpName = groups[row];
+                    List<Channel> chnList = getThing().getChannelsOfGroup(gpName);
+                    for (IammeterWEM3080Channel channelConfig : IammeterWEM3080Channel.values()) {
+                        Channel chnl = chnList.get(channelConfig.ordinal());
+                        if (chnl != null) {
+                            State state = getDecimal(iammeterData.get(keyWord).getAsJsonArray().get(row)
+                                    .getAsJsonArray().get(channelConfig.ordinal()).toString(), channelConfig.getUnit());
+                            updateState(chnl.getUID(), state);
+                        }
+                    }


Related to the class splitting. I didn't intend for you to completely copy paste the code as it duplicates a lot of code. Better make an abstract base class with all the logic and let it call methods to do the specific code. The code I selected here would be in the sub class. The method would get the response as parameter. You can make the method getDecimal protected (better rename it getQuantityState probably`.

abstract class made.

Hilbrand · 2020-09-04T15:19:31Z

...nding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/Iammeter3080THandler.java

+        ScheduledFuture<?> refreshJob = this.refreshJob;
+        if (refreshJob != null && !refreshJob.isCancelled()) {
+            refreshJob.cancel(true);
+            refreshJob = null;


You need to set the field to null:

Suggested change

refreshJob = null;

this.refreshJob = null;

TravisBuddy · 2020-09-05T02:16:40Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

Signed-off-by: lewei50 <[email protected]>

Also-by: Yang Bo<[email protected]> Signed-off-by: lewei50 <[email protected]>

Signed-off-by: lewei50 <[email protected]>

TravisBuddy · 2020-09-05T03:59:26Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

TravisBuddy · 2020-09-05T04:02:03Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

TravisBuddy · 2020-09-05T04:21:26Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

Hilbrand

Just some clean up comments.

Can you also run mvn spotless:apply on your binding to make sure the style complies, otherwise it might break the build (this changed recently).

Hilbrand · 2020-09-05T19:45:55Z

...inding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterBaseHandler.java

+ */
+
+@NonNullByDefault
+public class IammeterBaseHandler extends BaseThingHandler {


Suggested change

public class IammeterBaseHandler extends BaseThingHandler {

public abstract class IammeterBaseHandler extends BaseThingHandler {

codes reformated using mvn spotless:apply.

Hilbrand · 2020-09-05T19:46:57Z

...inding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterBaseHandler.java

+            String url = "http://" + config.username + ":" + config.password + "@" + config.host + ":" + config.port
+                    + "/monitorjson";
+            String content = "";
+            InputStream stream = new ByteArrayInputStream(content.getBytes(StandardCharsets.UTF_8));


This is not used anymore and can be removed.

Hilbrand · 2020-09-05T19:47:20Z

...inding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterBaseHandler.java

+
+            resolveData(response);
+
+            // JsonElement iammeterDataElement = new JsonParser().parse(response);


Can you remove this commented out code.

Hilbrand · 2020-09-05T19:48:40Z

...inding.iammeter/src/main/java/org/openhab/binding/iammeter/internal/IammeterBaseHandler.java

+        }
+    }
+
+    protected void resolveData(String response) {


By maing this class abstract you can also make this method abstract:

Suggested change

protected void resolveData(String response) {

protected abstract void resolveData(String response);

Signed-off-by: lewei50 <[email protected]>

TravisBuddy · 2020-09-06T04:08:10Z

Travis tests have failed

Hey @lewei50,
please read the following log in order to understand the failure reason. There might also be some helpful tips along the way.
It will be awesome if you fix what is wrong and commit the changes.

TravisBuddy · 2020-09-06T04:10:43Z

Travis tests have failed

Hey @lewei50,
please read the following log in order to understand the failure reason. There might also be some helpful tips along the way.
It will be awesome if you fix what is wrong and commit the changes.

TravisBuddy · 2020-09-06T04:32:02Z

Travis tests were successful

Hey @lewei50,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

Hilbrand

LGTM

Signed-off-by: Yang Bo <[email protected]>

lewei50 requested a review from a team as a code owner August 4, 2020 07:10

lewei50 force-pushed the iammeter branch from 26b6d5a to 19ce9bc Compare August 4, 2020 07:11

fwolter added the new binding If someone has started to work on a binding. For a new binding PR. label Aug 4, 2020

fwolter requested changes Aug 7, 2020

View reviewed changes

lewei50 force-pushed the iammeter branch from 7c0685a to 30cf5bf Compare August 11, 2020 07:39

fwolter requested changes Aug 11, 2020

View reviewed changes

lewei50 force-pushed the iammeter branch from abe155c to afe0135 Compare August 12, 2020 06:51

fwolter approved these changes Aug 12, 2020

View reviewed changes

fwolter added the cre Coordinated Review Effort label Aug 12, 2020

lewei50 force-pushed the iammeter branch from 2730c7b to b3b4c85 Compare August 13, 2020 00:57

lewei50 force-pushed the iammeter branch from b3b4c85 to a906d2b Compare August 13, 2020 00:59

Hilbrand requested changes Aug 29, 2020

View reviewed changes

lewei50 force-pushed the iammeter branch from bb2602c to c8d5301 Compare September 4, 2020 13:56

Hilbrand requested changes Sep 4, 2020

View reviewed changes

lewei50 added 9 commits September 5, 2020 11:36

First commit for iammeter devices.

4a01c9b

Signed-off-by: lewei50 <[email protected]>

code formating and justify.

ecf6ed9

Signed-off-by: lewei50 <[email protected]>

fix unit display.

c54eaba

Signed-off-by: lewei50 <[email protected]>

fix format

4be2e7d

Also-by: Yang Bo<[email protected]> Signed-off-by: lewei50 <[email protected]>

separate thingHandler

12d9444

Signed-off-by: lewei50 <[email protected]>

Update pom.xml

1380025

Signed-off-by: lewei50 <[email protected]>

Delete .project

8dc054b

Signed-off-by: lewei50 <[email protected]>

abstract iammeterBaseHandler

54f4771

Signed-off-by: lewei50 <[email protected]>

Create .project

31f281f

Signed-off-by: lewei50 <[email protected]>

lewei50 force-pushed the iammeter branch from 6383e12 to 31f281f Compare September 5, 2020 03:37

edit pom.xml

e59269a

Signed-off-by: lewei50 <[email protected]>

Hilbrand requested changes Sep 5, 2020

View reviewed changes

update format

b49258b

Signed-off-by: lewei50 <[email protected]>

lewei50 force-pushed the iammeter branch from b7519ad to b49258b Compare September 6, 2020 04:02

format code.

9ba9046

Signed-off-by: lewei50 <[email protected]>

Hilbrand approved these changes Sep 6, 2020

View reviewed changes

Hilbrand merged commit a228349 into openhab:2.5.x Sep 6, 2020

Hilbrand added this to the 2.5.9 milestone Sep 6, 2020

CSchlipp pushed a commit to CSchlipp/openhab-addons that referenced this pull request Sep 12, 2020

[iammeter] Iammeter Binding initial contribution (openhab#8252)

5333ec6

Signed-off-by: Yang Bo <[email protected]>

markus7017 pushed a commit to markus7017/openhab-addons that referenced this pull request Sep 19, 2020

[iammeter] Iammeter Binding initial contribution (openhab#8252)

6c0b825

Signed-off-by: Yang Bo <[email protected]>

andrewfg pushed a commit to andrewfg/openhab-addons that referenced this pull request Oct 8, 2020

[iammeter] Iammeter Binding initial contribution (openhab#8252)

6875586

Signed-off-by: Yang Bo <[email protected]>

-			<channel-group id="powerPhaseA" typeId="powerPhaseGroupA" />
+			<channel-group id="powerPhaseA" typeId="powerPhaseGroup" >
+			    <label>Power Phase A</label>
+		            <description>Power phase 1 for Iammeter device</description>
+			</channel-group>

	String response = HttpUtil.executeUrl(httpMethod, url, stream, null, TIMEOUT_MS);
	String response = HttpUtil.executeUrl(httpMethod, url, TIMEOUT_MS);

	public class IammeterBaseHandler extends BaseThingHandler {
	public abstract class IammeterBaseHandler extends BaseThingHandler {


		resolveData(response);

		// JsonElement iammeterDataElement = new JsonParser().parse(response);

	protected void resolveData(String response) {
	protected abstract void resolveData(String response);

[iammeter] Iammeter Binding initial contribution #8252

[iammeter] Iammeter Binding initial contribution #8252

Conversation

lewei50 commented Aug 4, 2020

TravisBuddy commented Aug 4, 2020

Travis tests were successful

TravisBuddy commented Aug 4, 2020

Travis tests were successful

fwolter commented Aug 6, 2020 • edited Loading

lewei50 commented Aug 7, 2020

fwolter left a comment

Choose a reason for hiding this comment

TravisBuddy commented Aug 11, 2020

Travis tests were successful

TravisBuddy commented Aug 12, 2020

Travis tests were successful

TravisBuddy commented Aug 12, 2020

Travis tests were successful

fwolter left a comment

Choose a reason for hiding this comment

TravisBuddy commented Aug 13, 2020

Travis tests were successful

TravisBuddy commented Aug 13, 2020

Travis tests were successful

lewei50 commented Aug 13, 2020

TravisBuddy commented Aug 13, 2020

Travis tests were successful

Hilbrand left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Hilbrand commented Sep 4, 2020

yangbo1979 commented Sep 4, 2020

TravisBuddy commented Sep 4, 2020

Travis tests have failed

TravisBuddy commented Sep 4, 2020

Travis tests were successful

TravisBuddy commented Sep 4, 2020

Travis tests were successful

Hilbrand left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TravisBuddy commented Sep 5, 2020

Travis tests were successful

TravisBuddy commented Sep 5, 2020

Travis tests were successful

TravisBuddy commented Sep 5, 2020

Travis tests were successful

TravisBuddy commented Sep 5, 2020

Travis tests were successful

Hilbrand left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TravisBuddy commented Sep 6, 2020

fwolter commented Aug 6, 2020 •

edited

Loading