[mqtt] Have a working Group Id #5156

jochen314 · 2019-03-19T18:37:38Z

Use the device.unique_id as a channel group id, if availble. Use nodeId, ObjectId and component as fallback.
Write the information about nodeId and objectId into the channel config to avoid the need to recover the information from the group id.
Also make the channel configuration read only in the GUI. I changes are needed, then a GenericMQTTThing should be used and not a HomeAssistantThing.

With this PR I am having functional autodisovery for tasmota for the already supported compoenents / features.

@davidgraeff Sorry, but I forgot this PR in my other list, because it was basically already prepared.

This PR is based on #4990

martinvw · 2019-03-19T21:46:11Z

This PR is based on #4990

It requires a rebase now that that one is merged.

Signed-off-by: Jochen Klein <git@jochen.susca.de>

davidgraeff · 2019-03-20T09:46:06Z

...c/src/main/java/org/openhab/binding/mqtt/generic/internal/convention/homeassistant/HaID.java

-    final public String component;
-    final public String nodeID;
-    final public String objectID;
+    final private String baseTopic;


a final property cannot be mutated from outside and this is even an immutable class.
There is no reason to hide the properties behind getters except if you don't like performance or readability or maintainability or want to make it extra hard for reviewers ^^.

Please make those fields public again and access them directly. The HaID class is meant to be immutable. That might be added to the javadoc for the class.

davidgraeff

Overall a lot of improvements. Thanks.
A few annotations included.

Prefer immutable classes if possible. They are thread safe, easy to read and review. Don't use getters. The "object oriented programming" paradigm from the 90ties with getters/setters everywhere -> That gets my hackles up.

davidgraeff · 2019-03-20T09:47:13Z

...c/src/main/java/org/openhab/binding/mqtt/generic/internal/convention/homeassistant/HaID.java

-        String groupId = channel.getGroupId();
-        if (groupId == null) {
-            throw new IllegalArgumentException("Channel needs a group ID!");
+    public static HaID fromConfig(String baseTopic, Configuration config) {


The factory pattern is like public constructors -> a fellow developer would really enjoy javadoc here.
There are also new public methods in this class, can you please add javadoc there as well? thanks

davidgraeff · 2019-03-20T09:50:12Z

...c/src/main/java/org/openhab/binding/mqtt/generic/internal/convention/homeassistant/HaID.java

+    public String getTopic(String suffix) {
+        StringBuilder str = new StringBuilder();
+
+        str.append(baseTopic).append('/').append(component).append('/');


Please precompute that in the constructor and store it in a private field and then just do a string concatenation: _stored_var+suffix.

I am not sure about this one.
This is a trde off between execution time and space.
While the mehtod is called max. a couple of times during initialization, the member will take up space for the whole runtime....

Yup a tradeoff. It's up to you. Maybe other fields are not used and can be dumped?

davidgraeff · 2019-03-20T09:51:09Z

...c/src/main/java/org/openhab/binding/mqtt/generic/internal/convention/homeassistant/HaID.java

-        return new ChannelTypeUID(MqttBindingConstants.BINDING_ID,
-                objectID + "_" + component + nodeID + "_" + channelID);
+    @Override
+    public int hashCode() {


If you use basic types only like in this class, the java compiler will generate standard hashCode and equals methods.

Am I missing something here?
`
public class Pojo {

private final String name; public Pojo(String name) { this.name = name; } public static void main(String[] argv) { Pojo a = new Pojo("test"); Pojo b = new Pojo("test"); System.out.println("a.hashCode() = " + a.hashCode()); System.out.println("b.hashCode() = " + b.hashCode()); System.out.println("a.equals(b) = " + a.equals(b)); }

}
does not work. And the default equals method inherited from Object is:
public boolean equals(Object obj) {
return (this == obj);
}
`
which will only use the address of the object, not any members into account.

And I added the methods, because using equals() in the unit tests did not work.

Hm. Alright. Different in C++.

davidgraeff · 2019-03-20T09:53:04Z

...org/openhab/binding/mqtt/generic/internal/convention/homeassistant/HandlerConfiguration.java

+        return objectid;
+    }
+
+    public void toProperties(Map<String, Object> properties) {


This is an anti-pattern (using an argument as output).
Please call this method "appendToProperties" or alike and return the map again. And add javadoc please.

davidgraeff · 2019-03-20T09:54:42Z

...org/openhab/binding/mqtt/generic/internal/convention/homeassistant/HandlerConfiguration.java

@@ -27,9 +29,31 @@
    /**
     * The MQTT prefix topic
     */
-    public String basetopic = "homeassistant";
+    private String basetopic = "homeassistant";


please make this an immutable class. final public properties only. No getters.
Your empty constructor will then assign "homeassistant".

I guess, my tendency towards getter/setters i showing my age ;-)

Signed-off-by: Jochen Klein <git@jochen.susca.de>

davidgraeff · 2019-03-21T22:21:40Z

...rc/main/java/org/openhab/binding/mqtt/generic/internal/discovery/HomeAssistantDiscovery.java

@@ -161,7 +161,7 @@ public void receivedMessage(ThingUID connectionBridge, MqttBrokerConnection conn

        Map<String, Object> properties = new HashMap<>();
        HandlerConfiguration handlerConfig = topicParts.toHandlerConfiguration();
-        handlerConfig.toProperties(properties);
+        handlerConfig.appendToProperties(properties);


Make it like so: properties = handlerConfig.appendToProperties(properties);
I'm not sure if the java compiler is smart enough to figure out that it means the same (in c++ that's possible). But for someone reading the code it is more obvious.

yes, should have thought about this...
Its too late after a working day...

Signed-off-by: Jochen Klein <git@jochen.susca.de>

martinvw

Two minor comments, would be nice if you could fix them now or in a follow up PR

martinvw · 2019-03-22T09:16:47Z

...c/src/main/java/org/openhab/binding/mqtt/generic/internal/convention/homeassistant/HaID.java

+    public final String nodeID;
+    public final String objectID;
+
+    private final String _topic;


This is not a correct name according to the Java / openHAB coding guidelines

martinvw · 2019-03-22T09:18:44Z

...c/main/java/org/openhab/binding/mqtt/generic/internal/convention/homeassistant/CChannel.java

            channelState = new ChannelState(
                    ChannelConfigBuilder.create().withRetain(retain).withStateTopic(state_topic)
                            .withCommandTopic(command_topic).build(),
                    channelUID, valueState, channelStateUpdateListener);
-
+                    


This looks wrong but of course not stopping this PR from being merged

Signed-off-by: Jochen Klein <git@jochen.susca.de>

move info from groupd id to group config Signed-off-by: Jochen Klein <git@jochen.susca.de> Signed-off-by: Pshatsillo <pshatsillo@gmail.com>

move info from groupd id to group config Signed-off-by: Jochen Klein <git@jochen.susca.de> Signed-off-by: Maximilian Hess <mail@ne0h.de>

jochen314 requested review from cweitkamp and davidgraeff as code owners March 19, 2019 18:37

move info from groupd id to group config

9705a8e

Signed-off-by: Jochen Klein <git@jochen.susca.de>

jochen314 force-pushed the workingGroupId branch from 1c53b86 to 9705a8e Compare March 19, 2019 22:38

wborn added the binding: mqtt label Mar 20, 2019

davidgraeff reviewed Mar 20, 2019

View reviewed changes

davidgraeff requested changes Mar 20, 2019

View reviewed changes

review findings

9da0dc3

Signed-off-by: Jochen Klein <git@jochen.susca.de>

davidgraeff reviewed Mar 21, 2019

View reviewed changes

more findings

a19f818

Signed-off-by: Jochen Klein <git@jochen.susca.de>

davidgraeff approved these changes Mar 21, 2019

View reviewed changes

HandlerConfig members cannot be final

a89c997

Signed-off-by: Jochen Klein <git@jochen.susca.de>

martinvw approved these changes Mar 22, 2019

View reviewed changes

findings by martin

54f5db5

Signed-off-by: Jochen Klein <git@jochen.susca.de>

jochen314 mentioned this pull request Mar 22, 2019

[mqtt][WIP] Make Homeassistant discovery work for Tasmota #4927

Closed

davidgraeff approved these changes Mar 23, 2019

View reviewed changes

davidgraeff merged commit 06fde81 into openhab:master Mar 23, 2019

wborn added this to the 2.5 milestone Apr 14, 2019

jochen314 deleted the workingGroupId branch August 22, 2019 14:46

ne0h pushed a commit to ne0h/openhab-addons that referenced this pull request Sep 15, 2019

[mqtt] Have a working Group Id (openhab#5156)

e6fd19c

move info from groupd id to group config Signed-off-by: Jochen Klein <git@jochen.susca.de> Signed-off-by: Maximilian Hess <mail@ne0h.de>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[mqtt] Have a working Group Id #5156

[mqtt] Have a working Group Id #5156

jochen314 commented Mar 19, 2019

martinvw commented Mar 19, 2019

davidgraeff Mar 20, 2019

davidgraeff left a comment

davidgraeff Mar 20, 2019

davidgraeff Mar 20, 2019 •

edited

Loading

jochen314 Mar 21, 2019

davidgraeff Mar 21, 2019

davidgraeff Mar 20, 2019

jochen314 Mar 21, 2019

davidgraeff Mar 21, 2019

davidgraeff Mar 20, 2019

davidgraeff Mar 20, 2019

jochen314 Mar 21, 2019

davidgraeff Mar 21, 2019

jochen314 Mar 21, 2019

martinvw left a comment

martinvw Mar 22, 2019

martinvw Mar 22, 2019

[mqtt] Have a working Group Id #5156

[mqtt] Have a working Group Id #5156

Conversation

jochen314 commented Mar 19, 2019

martinvw commented Mar 19, 2019

Choose a reason for hiding this comment

davidgraeff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidgraeff Mar 20, 2019 • edited Loading

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

martinvw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidgraeff Mar 20, 2019 •

edited

Loading