Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[freeathome] Initial contribution #13703

Merged
merged 178 commits into from
Apr 20, 2024
Merged

Conversation

andrasU
Copy link
Contributor

@andrasU andrasU commented Nov 12, 2022

This is the reworked initial contribution of the free@home binding, which is based on the official local API from ABB/Busch-Jäger

ABB/Busch-Jäger free@home binding for OpenHAB

This is a new binding for controlling free@home devices from ABB / Busch-Jaeger. I would like to provide this binding to the OpenHAB community to be able to bind the free@home devices through the official API.
This Binding makes possible to control the [free@home] devices through the free@home SysAP bridge.

The SysAP bridge is the only one device, which shall be added manually to the system.
The things can be detected on the openHAB dashboard
This binding is creating the thing's channels automatically based the free@home drives features.
The following gateway and devices are supported

Network Gateway / System Access Point

  • ABB / Busch-Jaeger System Access Point 2.0

Supported Devices

  • Switch Actuator Sensor with single and multiple channels (wired and wireless)
  • Dimming Actuator Sensor with single and multiple channels (wired, wireless and flex)
  • Motion detection with and without actuator (wired, wireless and flex)
  • Switch Actuator 4-channel
  • Dimming Actuator 4- and 6-channel
  • Door opener actuator
  • Door ring sensor
  • Hue devices (untested)
  • Shutter Actuator with single and multiple channels (wired and wireless)
  • Blind Actuator with single and multiple channels (wired and wireless)
  • Attic window actuator
  • Awning actuator
  • Room temperature controller master without fan
  • Room temperature controller master with fan
  • Room temperature controller slave
  • IP-touch panel (function: door opener, door ring sensor)
  • Virtual devices (e.g. virtual switch, RTC and detectors)

Tests
The new features (also the old implementation) is verified by the community
openhAB communitiy of this binding

binaries
https://github.com/andrasU/openhab-addons/releases/tag/fh-v4.0.1

@andrasU andrasU requested a review from a team as a code owner November 12, 2022 17:01
@andrasU andrasU force-pushed the freeathomesystemupdate branch from a5aaa19 to 5d28009 Compare November 12, 2022 17:07
@lolodomo lolodomo changed the title Freeathomesystemupdate [freeathomesystem] Initial contribution Nov 12, 2022
@lolodomo lolodomo added the new binding If someone has started to work on a binding. For a new binding PR. label Nov 12, 2022
@lsiepel lsiepel added rebuild Triggers Jenkins PR build and removed rebuild Triggers Jenkins PR build labels Nov 19, 2022
@andrasU
Copy link
Contributor Author

andrasU commented Nov 20, 2022

Hello @lsiepel,

The complete build is failing in other bindings as mine, however my branch is in synch with the main stream. I tried everything but I cannot solve the issue.
My local complete build is OK

could you give a hint what I shall fix or try
thank you

@lsiepel
Copy link
Contributor

lsiepel commented Nov 20, 2022

There are some SAT issues that should be addressed. I understand that you excluded some addons to get the builds wortking, but please revert it. They seem to be unrelated as far as i can see.

@andrasU
Copy link
Contributor Author

andrasU commented Nov 20, 2022

There are some SAT issues that should be addressed. I understand that you excluded some addons to get the builds wortking, but please revert it. They seem to be unrelated as far as i can see.

Ok I will have a look on it and revert the removal of 2 packages.

@andrasU
Copy link
Contributor Author

andrasU commented Nov 21, 2022

There are some SAT issues that should be addressed. I understand that you excluded some addons to get the builds wortking, but please revert it. They seem to be unrelated as far as i can see.

I reverted the changes, the stream is in sync, however now the MercedesMe binding is not building. Static code analysis failure for the command "mvn clean install". (I checked only in local build)

Do you have any idea, what to do?

Copy link
Contributor

@lsiepel lsiepel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Building errors seem to be solved by other commits to the faulty addons. Now there are more SAT-details available, some need you attention: https://github.com/openhab/openhab-addons/suites/9452497308/artifacts/447382278

eI left a note about the readme regarding logging. There are some screenshots, don't think they should be added too,

If these are fixed, i think some more experienced reviewer can do another pass, Thank you!

andrasU and others added 2 commits April 9, 2024 20:54
Co-authored-by: Jacob Laursen <[email protected]>
Signed-off-by: Andras Uhrin <[email protected]>
Apply suggestions from code review

Signed-off-by: Andras Uhrin <[email protected]>
andrasU and others added 2 commits April 20, 2024 09:49
Apply suggestions from code review

* Minor changes in examples

Signed-off-by: Andras Uhrin <[email protected]>
@andrasU
Copy link
Contributor Author

andrasU commented Apr 20, 2024

@jlaur
I think all findings are fixed or commented. I would consider the current version as final

@jlaur what is your opinion? What is still open from your point of view?

Co-authored-by: Jacob Laursen <[email protected]>
Signed-off-by: Andras Uhrin <[email protected]>
@jlaur
Copy link
Contributor

jlaur commented Apr 20, 2024

I think all findings are fixed or commented. I would consider the current version as final
what is your opinion? What is still open from your point of view?

Everything is addressed, thank you! There are now a few compiler warnings and SAT findings left. You can take a look at target/code-analysis/report.html. I think they can be addressed easily, and this PR is then ready for being merged.

andrasU and others added 2 commits April 20, 2024 16:40
Copy link
Contributor

@jlaur jlaur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for providing this new binding and for enduring the long review process. 👍

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

@jlaur jlaur merged commit f466c88 into openhab:main Apr 20, 2024
3 checks passed
@jlaur jlaur added this to the 4.2 milestone Apr 20, 2024
@andrasU
Copy link
Contributor Author

andrasU commented Apr 21, 2024

Thank you for providing this new binding and for enduring the long review process. 👍

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

Thank you from my side to be able to be part of this great community!

@jlaur
Copy link
Contributor

jlaur commented Apr 21, 2024

@andrasU - seeing the logo in openhab/openhab-docs#2286 made me wonder: Do you think the binding should actually be named "free@home" rather than "free@home system"? I'm wondering is the binding id should be simplified to "freeathome". In that PR you also refer to it as "free@home binding". It's a bit late I'm asking myself and you this question, but this is probably the final chance to do something about it.

lo92fr pushed a commit to lo92fr/openhab-addons that referenced this pull request Apr 30, 2024
@jlaur
Copy link
Contributor

jlaur commented May 4, 2024

@andrasU - seeing the logo in openhab/openhab-docs#2286 made me wonder: Do you think the binding should actually be named "free@home" rather than "free@home system"? I'm wondering is the binding id should be simplified to "freeathome". In that PR you also refer to it as "free@home binding". It's a bit late I'm asking myself and you this question, but this is probably the final chance to do something about it.

@andrasU - gentle ping, did you see this question? If we decide to rename the binding, it would probably be best to do this before next milestone.

@andrasU
Copy link
Contributor Author

andrasU commented May 5, 2024

@andrasU - seeing the logo in openhab/openhab-docs#2286 made me wonder: Do you think the binding should actually be named "free@home" rather than "free@home system"? I'm wondering is the binding id should be simplified to "freeathome". In that PR you also refer to it as "free@home binding". It's a bit late I'm asking myself and you this question, but this is probably the final chance to do something about it.

@andrasU - gentle ping, did you see this question? If we decide to rename the binding, it would probably be best to do this before next milestone.

@jlaur: You have completely right the name shall be "free@home". This is also the name as ABB and Busch-Jaeger referencing the smart home system. The name freeathomesystem was my work-title.
How can the binding renamed? Just rename the folder and create a new PR?

@jlaur
Copy link
Contributor

jlaur commented May 5, 2024

You have completely right the name shall be "free@home". This is also the name as ABB and Busch-Jaeger referencing the smart home system. The name freeathomesystem was my work-title.

All right, let's rename binding id to "freeathome" then.

How can the binding renamed? Just rename the folder and create a new PR?

Yes, you can branch out from latest main and create a new PR with the needed changes. As a minimum, the folder must be renamed, as well as everything referring to binding id "freeathomesystem" within. Search & replace might come in handy. There are also a few files outside the binding folder that must be updated, e.g. pom.xml and CODEOWNERS.

@lsiepel
Copy link
Contributor

lsiepel commented May 5, 2024

e completely right the name shall be "free@home". This is also the name as ABB and Busch-Jaeger referencing the smart home system. The name freeathomesystem was my work-title.
How can the binding renamed? Just rename the folder and create a new PR?

Did this recently, so i created a PR directly. Only need to fix the pom. give me a second

@jlaur
Copy link
Contributor

jlaur commented May 5, 2024

Only need to fix the pom

@lsiepel - thanks! Can you also update CODEOWNERS?

@kaikreuzer - can you add @andrasU to the contributor team as he is now maintainer of the free@home binding? 🙂

@jlaur jlaur changed the title [freeathomesystem] Initial contribution [freeathome] Initial contribution May 5, 2024
@kaikreuzer
Copy link
Member

can you add @andrasU to the contributor team as he is now maintainer of the free@home binding? 🙂

Sure thing! Done. 😄

psmedley pushed a commit to psmedley/openhab-addons that referenced this pull request Jun 15, 2024
Signed-off-by: Andras Uhrin <[email protected]>
Signed-off-by: Paul Smedley <[email protected]>
pgfeller pushed a commit to pgfeller/openhab-addons that referenced this pull request Sep 29, 2024
Signed-off-by: Andras Uhrin <[email protected]>
Signed-off-by: Patrik Gfeller <[email protected]>
joni1993 pushed a commit to joni1993/openhab-addons that referenced this pull request Oct 15, 2024
matchews pushed a commit to matchews/openhab-addons that referenced this pull request Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new binding If someone has started to work on a binding. For a new binding PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.