[orbitbhyve] Initial contribution

[octa22]

This is the binding for Orbit Bhyve irrrigation systems.

Signed-off-by: Ondrej Pecta opecta@gmail.com

[kubawolanin]

hey @octa22 do you happen to have a JAR for this binding for latest milestone build?
I do have a B-Hyve indoor sprinkler system and I'm willing to test your work on a real device if ready :)
Cheers

[octa22]

Hi, here is the latest 3.2.0 SNAPSHOT. I'd be happy if you can test it.
https://www.dropbox.com/s/hpdxn1cjtn9xj0v/org.openhab.binding.orbitbhyve-3.2.0-SNAPSHOT.jar?dl=1
Ondrej

[kubawolanin]

Hi @octa22!

I've placed the JAR in my addons folder and added a Bridge manually.
For some reason the discovery did not kick in.

After adding a Bridge and immediately after a Sprinkler, I realized that I had a typo in the password field.
This resulted in the following errors after authentication:

 events.log - 2021-06-29 16:03:42.587 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:bridge:sprinklers' changed from OFFLINE (COMMUNICATION_ERROR) to OFFLINE (COMMUNICATION_ERROR): Cannot create websocket session
 events.log - 2021-06-29 16:03:42.587 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:bridge:sprinklers' changed from OFFLINE (COMMUNICATION_ERROR): Cannot create websocket session to ONLINE
 events.log - 2021-06-29 16:03:42.587 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:sprinkler:sprinklers:ddcd8f8b63' changed from OFFLINE (BRIDGE_OFFLINE) to ONLINE
 events.log - 2021-06-29 16:03:43.334 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:bridge:sprinklers' changed from ONLINE to OFFLINE (COMMUNICATION_ERROR): Cannot create websocket session
 events.log - 2021-06-29 16:03:43.334 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:bridge:sprinklers' changed from OFFLINE (COMMUNICATION_ERROR): Cannot create websocket session to OFFLINE (COMMUNICATION_ERROR): web socket creation error
 events.log - 2021-06-29 16:03:43.334 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:bridge:sprinklers' changed from OFFLINE (COMMUNICATION_ERROR): web socket creation error to OFFLINE (COMMUNICATION_ERROR): Returned status: 400
 events.log - 2021-06-29 16:03:43.506 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:bridge:sprinklers' changed from OFFLINE (COMMUNICATION_ERROR): Returned status: 400 to OFFLINE
 events.log - 2021-06-29 16:03:43.506 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:sprinkler:sprinklers:ddcd8f8b63' changed from ONLINE to OFFLINE (BRIDGE_OFFLINE)

Then every 30 seconds it returns 400 HTTP status:

 events.log - 2021-06-29 16:05:17.203 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:bridge:sprinklers' changed from OFFLINE (COMMUNICATION_ERROR): Returned status: 400 to ONLINE
 events.log - 2021-06-29 16:05:17.203 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:sprinkler:sprinklers:ddcd8f8b63' changed from OFFLINE (BRIDGE_OFFLINE) to ONLINE
 events.log - 2021-06-29 16:05:17.378 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:bridge:sprinklers' changed from ONLINE to OFFLINE (COMMUNICATION_ERROR): Returned status: 400
 events.log - 2021-06-29 16:05:17.746 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:sprinkler:sprinklers:ddcd8f8b63' changed from ONLINE to OFFLINE (BRIDGE_OFFLINE)

What I did after that was I completely removed all the created things and started over - this time making sure that my password was correct before I hit Save in the UI during Bridge thing creation.
Turned out to be successful:

After I waited for the bridge to become Online, I navigated to Inbox and then saw that discovery indeed works:

 events.log - 2021-06-29 16:10:20.746 [INFO ] [openhab.event.InboxRemovedEvent     ] - Discovery Result with UID 'orbitbhyve:sprinkler:16f92e4ed5:5f7759994f0c62a04bd24722' has been removed.
 events.log - 2021-06-29 16:10:20.747 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:sprinkler:16f92e4ed5:5f7759994f0c62a04bd24722' changed from UNINITIALIZED to INITIALIZING
 events.log - 2021-06-29 16:10:21.445 [INFO ] [ab.event.ThingStatusInfoChangedEvent] - Thing 'orbitbhyve:sprinkler:16f92e4ed5:5f7759994f0c62a04bd24722' changed from INITIALIZING to ONLINE

Controlling Smart Watering seem to work:

 events.log - 2021-06-29 16:11:54.528 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'Sprinklers_IrrigationMode' changed from NULL to auto
 events.log - 2021-06-29 16:11:54.528 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'Sprinklers_SprinklerStateControl' changed from NULL to ON
 events.log - 2021-06-29 16:11:54.529 [INFO ] [openhab.event.ItemStateChangedEvent ] - Item 'Sprinklers_NextWateringStartTime' changed from NULL to 1970-01-01T00:00:00.000-0400

I couldn't find a way to trigger manual watering yet.

Thank you Ondrej for your great work! 🎉

[octa22]

Hi, the binding should automatically detect all programs and zones you have (as switches where the ON command enables the watering or the program) This is the way how to enable manual watering. Apparently the is some error during the communication with the B-Hybe cloud. It is working fine for the 8-zones Orbit sprinkler that I have. Please can you enable the trace log and provide it here? Thanks. Ondrej út 29. 6. 2021 v 18:56 odesílatel Kuba Wolanin ***@***.***> napsal:

…

I've added Equipment to Model with the UI but noticed that it doesn't update Items state: [image: image] <https://user-images.githubusercontent.com/2270505/123837937-b1747880-d90b-11eb-9d21-12a9873d9e2a.png> And unfortunately none of the switches seem to work :( — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#10426 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AE7QO52K2NTLZOEH76GWH7TTVH3NRANCNFSM42HW5YQQ> .

[octa22]

Hello @kubawolanin,
indeed there were some compatibility issues with the OH3.
It should be fixed now. Please, can you download the jar again and let me know?
https://www.dropbox.com/s/hpdxn1cjtn9xj0v/org.openhab.binding.orbitbhyve-3.2.0-SNAPSHOT.jar?dl=1
All zones and programs should appear as new channels and you will be able to trigger the watering (a zone or a program)
Thanks.
Ondrej

[kubawolanin]

Hi @octa22

Re-added the things after installing the latest binding and it immediately found all my zones!

Manual watering works perfectly - here's a proof ;-)

Unfortunately I forgot to switch to TRACE when adding things but will test the binding for a few days.

Thank you for the great work!

[octa22]

Hi @kubawolanin, thanks again for the testing. Very glad it works! May I ask what device are you using? I am finishing the documentation and I would like to include a list of tested devices so far.
Thank you!

[kubawolanin]

It's B-Hyve Smart Indoor Timer @octa22

[octa22]

It's B-Hyve Smart Indoor Timer @octa22

Thanks. The same as mine. I guess the binding is ready for a review. @kubawolanin

[fwolter]

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

You need to add your binding to bom\openhab-addons\pom.xml.

Your binding doesn't build as it contains checkstyle errors. You could take a look at target/code-analysis/report.html after building it with mvn clean install.

There is also one compiler warning about a null value left.

[octa22]

Hi @fwolter,
thanks for the review. I guess I have addressed all your comments.
Checkstyle errors have been fixed and I have added the entry to bom\openhab-addons\pom.xml as well

[fwolter]

Congratulation! 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