[electroluxappliance] Initial contribution #17663

jannegpriv · 2024-10-29T18:33:40Z

Signed-off-by: Jan Gustafsson [email protected]

Initial contribution of the Electroluxappliances openHAB binding.

The binding uses the Electrolux Group API and the binding implements support for Electrolux Air Purifiers and Washing Machines and solves #17325.

In the community thread you can find a link to a built binding jar-file.

Signed-off-by: Jan Gustafsson <[email protected]>

lsiepel

Thank you for contributing and following up on the previous binding. Fully covered the binding. It is already in a good shape, just many small comments. The most important ones are the ones around the channel and type id's i guess.

Would be nice if you comment or thumgbs up the comments and let me mark them as resolved, this way i can keep track.

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

lsiepel · 2024-10-29T19:44:02Z

...les/org.openhab.binding.electroluxappliances/src/main/resources/OH-INF/thing/thing-types.xml

+	</channel-type>
+
+	<channel-type id="doorLock">
+		<item-type>Switch</item-type>


As this is a read only status for a lock, did you consider to use the contact type?

Correct, I've changed.

Just a clarification, should the Switch type only be used if there is a possibility to send a command to change the state? Otherwise we should use Contact?

I was thinking of connection-state? It is read-only but currently modelled as a Switch.

Switch can also be marked as read-only. A contact (open/closed) is usually for doors, windows, locks, cicruits etc. I don't think this is used for connection states. I would also ask myself why do you need a connection state channel ?
The Thing state should already reflect the connection state, or am i missing something here?

The Thing state should already reflect the connection state, or am i missing something here?

Not with current implementation. So then I guess I should use connection-state as a base for setting thing state to Online/Offline, that is not done today.

No rush, don't forget to flush your commits as currently all is pending.

...les/org.openhab.binding.electroluxappliances/src/main/resources/OH-INF/thing/thing-types.xml

lsiepel · 2024-10-29T19:47:52Z

...les/org.openhab.binding.electroluxappliances/src/main/resources/OH-INF/thing/thing-types.xml

+		<item-type>Number:Time</item-type>
+		<label>Time To End</label>
+		<description>The time to end of a program.</description>
+		<state readOnly="true"/>


Please provide a state pattern and if not the default unit a unithint (seconds is default)

It is seconds.

Both time-to-start and time-to-end are missing unitHint

Should I then add unitHint="s"?

lsiepel · 2024-10-29T19:48:33Z

...les/org.openhab.binding.electroluxappliances/src/main/resources/OH-INF/thing/thing-types.xml

+		<item-type>Number:Time</item-type>
+		<label>Appliance Total Working Time</label>
+		<description>The appliance total working time.</description>
+		<state readOnly="true"/>


Please provide a state pattern and i guess a unitHint="h"

Still don't see the unitHint, what did you change?

This is reported in seconds:
Channel: electroluxappliance:washing-machine:6996e7d524:33600001:appliance-total-working-time, State: 1490400

Should I then add unitHint="s"?

...les/org.openhab.binding.electroluxappliances/src/main/resources/OH-INF/thing/thing-types.xml

jlaur · 2024-10-29T20:29:20Z

I think binding name should be in singular form (electroluxappliance), but let me check documentation and other binding names, and let me get back.

jlaur · 2024-10-30T20:02:40Z

I think binding name should be in singular form (electroluxappliance), but let me check documentation and other binding names, and let me get back.

I have not found a single binding using plural, but a few similar named bindings denoting the type of device they are for, and being in singular:

jannegpriv · 2024-10-30T22:51:12Z

I think binding name should be in singular form (electroluxappliance), but let me check documentation and other binding names, and let me get back.

I have not found a single binding using plural, but a few similar named bindings denoting the type of device they are for, and being in singular:

epsonprojector

hpprinter

kostalinverter

omnikinverter

luxtronikheatpump

OK, will then rename binding to electroluxappliance.

Signed-off-by: Jan Gustafsson <[email protected]>

lsiepel

Think this is the last review round.

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

bundles/org.openhab.binding.electroluxappliance/src/main/feature/feature.xml

...rg/openhab/binding/electroluxappliance/internal/handler/ElectroluxWashingMachineHandler.java

lsiepel · 2024-11-05T14:26:54Z

Just to be sure they are not missed, some (buried) comments are left open.

jlaur

Just a comment regarding OAuth2.

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

jlaur · 2024-11-05T19:57:38Z

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

+|--------------|-------------------------------------------------------|--------|----------|----------|
+| apiKey       | Your created API key on developer.electrolux.one      | String | NA       | yes      |        
+| accessToken  | Your created access token on developer.electrolux.one | String | NA       | yes      |
+| refreshToken | Your created access token on developer.electrolux.one | String | NA       | yes      |


I don't know if you discussed this already, but is there any reason not to use to OAuth2 implementation provided by core? See for example the Netatmo, Miele Cloud and Bosch Indego bindings.

jannegpriv · 2024-11-05T20:02:20Z

Just to be sure they are not missed, some (buried) comments are left open.

I have gone through all and added some questions.

jannegpriv · 2024-11-06T20:33:53Z

Just a comment regarding OAuth2.

No, that has not been brought up before.

Signed-off-by: Jan Gustafsson <[email protected]>

jannegpriv · 2024-11-07T22:21:57Z

Since Electrolux Group API requires an API key and accessToken , that you generate yourself on the developer portal, this API is nit following the standard OAuth2 flow. Since the authorization and token handling then is so simple, I do not see the benefits of using the Oauth2 implementation in OH core.
https://developer.electrolux.one/documentation/authorization

lsiepel · 2024-11-10T11:38:29Z

Previously i briefly looked at the flow from electrolux and it seemed like a custom flow that is not supported by the oauth2 implementaiton in oh core. I must admit that i dont't know all details about the oath2 implementation. I'll try to read it and might come back to this. For now let's continue this PR and i hope to come back to this before we can merge this PR.

Signed-off-by: Leo Siepel <[email protected]>

lsiepel

Re-generated the i18n file as that was the only comment i had. Had a quick read about the oauth2 again and came to the same conclusion that this binding specific flow does not fit. Now we can merge it and get this into m3.

Next step would be to add the binding logo to the openHAB website. See https://www.openhab.org/docs/developer/addons/#add-your-add-on-s-logo-to-the-openhab-website

jannegpriv added 3 commits October 29, 2024 19:22

First version

b963169

Signed-off-by: Jan Gustafsson <[email protected]>

Updated

c13214b

Signed-off-by: Jan Gustafsson <[email protected]>

Split in 2 handler classes

4874102

Signed-off-by: Jan Gustafsson <[email protected]>

jannegpriv added the new binding If someone has started to work on a binding. For a new binding PR. label Oct 29, 2024

jannegpriv requested a review from a team as a code owner October 29, 2024 18:33

lsiepel requested changes Oct 29, 2024

View reviewed changes

jlaur linked an issue Oct 30, 2024 that may be closed by this pull request

[electroluxappliances] New binding for Electrolux Appliances #17325

Closed

jannegpriv added 3 commits October 31, 2024 22:14

Rename binding from ElectroluxAppliances to ElectroluxAppliance

1d0ca8c

Signed-off-by: Jan Gustafsson <[email protected]>

Rename identifiers from ElectroluxAppliances to ElectroluxAppliance

d92b85c

Signed-off-by: Jan Gustafsson <[email protected]>

Updated after code review

5e3a285

Signed-off-by: Jan Gustafsson <[email protected]>

jlaur changed the title ~~[Electroluxappliances] Initial Contribution~~ [electroluxappliance] Initial contribution Nov 3, 2024

lsiepel requested changes Nov 5, 2024

View reviewed changes

lsiepel reviewed Nov 5, 2024

View reviewed changes

...rg/openhab/binding/electroluxappliance/internal/handler/ElectroluxWashingMachineHandler.java Outdated Show resolved Hide resolved

jlaur reviewed Nov 5, 2024

View reviewed changes

Updated after code review

a05da91

Signed-off-by: Jan Gustafsson <[email protected]>

re-generate i18n

831ff19

Signed-off-by: Leo Siepel <[email protected]>

lsiepel approved these changes Nov 10, 2024

View reviewed changes

lsiepel merged commit da97e57 into openhab:main Nov 10, 2024
5 checks passed

lsiepel added this to the 4.3 milestone Nov 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[electroluxappliance] Initial contribution #17663

[electroluxappliance] Initial contribution #17663

jannegpriv commented Oct 29, 2024

lsiepel left a comment

lsiepel Oct 29, 2024

jannegpriv Oct 30, 2024

jannegpriv Nov 1, 2024

lsiepel Nov 1, 2024

jannegpriv Nov 1, 2024 •

edited

Loading

lsiepel Nov 1, 2024

lsiepel Oct 29, 2024

jannegpriv Oct 30, 2024

jannegpriv Oct 30, 2024

lsiepel Nov 5, 2024

jannegpriv Nov 5, 2024

lsiepel Oct 29, 2024

jannegpriv Oct 30, 2024

lsiepel Nov 5, 2024

jannegpriv Nov 5, 2024

jlaur commented Oct 29, 2024

jlaur commented Oct 30, 2024 •

edited

Loading

jannegpriv commented Oct 30, 2024

lsiepel left a comment

lsiepel commented Nov 5, 2024

jlaur left a comment

jlaur Nov 5, 2024

jannegpriv commented Nov 5, 2024

jannegpriv commented Nov 6, 2024

jannegpriv commented Nov 7, 2024

lsiepel commented Nov 10, 2024

lsiepel left a comment •

edited

Loading

[electroluxappliance] Initial contribution #17663

[electroluxappliance] Initial contribution #17663

Conversation

jannegpriv commented Oct 29, 2024

lsiepel 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

jannegpriv Nov 1, 2024 • 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

jlaur commented Oct 29, 2024

jlaur commented Oct 30, 2024 • edited Loading

jannegpriv commented Oct 30, 2024

lsiepel left a comment

Choose a reason for hiding this comment

lsiepel commented Nov 5, 2024

jlaur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jannegpriv commented Nov 5, 2024

jannegpriv commented Nov 6, 2024

jannegpriv commented Nov 7, 2024

lsiepel commented Nov 10, 2024

lsiepel left a comment • edited Loading

Choose a reason for hiding this comment

jannegpriv Nov 1, 2024 •

edited

Loading

jlaur commented Oct 30, 2024 •

edited

Loading

lsiepel left a comment •

edited

Loading