[opensprinkler] Fix Program names and add new features for firmware 2.2.0 #15410

Skinah · 2023-08-12T08:01:21Z

This change fixes the bindings ability to scrape the program names of the sprinkler controllers internal automated programs that a user can select to run. More information is found that the issue this fixes here closes #15260

The newer firmware uses JSON with this structure and the "pd" now has an extra element over previous firmware which causes the update to break the old code. The JSON is an Array that contains mixed types including further arrays. Details are included in case a better method exists.

{
	"nprogs": 3,
	"nboards": 1,
	"mnp": 40,
	"mnst": 4,
	"pnsize": 32,
	"pd": [
		[3, 68, 0, [20540, 0, 120, 0],
			[0, 2700, 2700, 0, 0, 0, 0, 0], Water Lawn, [0, 33, 415]
		],
		[3, 1, 0, [16384, 0, 0, 0],
			[0, 0, 0, 2700, 0, 0, 0, 0], Water Citrus, [0, 33, 415]
		],
		[3, 18, 0, [16384, 0, 0, 0],
			[2700, 0, 0, 0, 0, 0, 0, 0], Water Fruit Trees, [0, 33, 415]
		]
	]
}

This pull request will automatically be built and available under the following links if anyone wants to test:
https://openhab.jfrog.io/ui/native/libs-pullrequest-local/org/openhab/addons/bundles/

https://openhab.jfrog.io/ui/native/libs-pullrequest-local/org/openhab/addons/bundles/org.openhab.binding.opensprinkler/4.1.0-SNAPSHOT/org.openhab.binding.opensprinkler-4.1.0-SNAPSHOT.jar

Signed-off-by: Matthew Skinner matt@pcmus.com

openhab-bot · 2023-08-12T08:24:51Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/opensprinkler-v2-2-firmware-incompatibility-with-current-openhab-binding/147841/6

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

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

bundles/org.openhab.binding.opensprinkler/src/main/resources/OH-INF/thing/thing-types.xml

...sprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApi.java

...main/java/org/openhab/binding/opensprinkler/internal/handler/OpenSprinklerDeviceHandler.java

...ensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/OpenSprinklerState.java

bundles/org.openhab.binding.opensprinkler/src/main/resources/OH-INF/thing/thing-types.xml

lolodomo · 2023-10-18T18:50:59Z

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

@@ -61,22 +61,25 @@ NOTE: Some channels will only show up if the hardware has the required sensor an

 | Channel Type ID | Item Type              |    | Description                                                                        |
 |-----------------|------------------------|----|------------------------------------------------------------------------------------|
-| rainsensor      | Switch                 | RO | This channel indicates whether rain is detected by the device or not.              |
-| sensor2         | Switch                 | RO | This channel is for the second sensor (if your hardware supports it).              |
+| cloudConnected  | Switch                 | RO | If the device is fully connected to the OpenSprinkler cloud this will show as 'ON'.|


I am asking myself if a channel is really the good option.
The connection status should probably be something defining the thing status ?

@jlaur : WDYT ?

I think I need some more context. The binding is declared as local, so if I understand this correctly, this is just some information from the device whether it is also integrated with a cloud service in addition to being integrated through the local API?

In that case, what would be the use of this channel? Perhaps it would be sufficient to provide this as a property? And also, in that case it probably shouldn't impact the thing status, since it wouldn't interfere with the openHAB integration in any way?

I believe a property is wrong as it has a state that changes. Read only channel seemed to fit. Your thoughts are correct and I also do not see the use case, but was easy to add it when doing other channels instead of someone requesting it later. It could possibly be used to fault find why you can not use their cloud to connect and control the sprinkler. The binding is full local and it is perhaps strange that the device can do both without trying to force you to do one over the other.

I would prefer to delete the channel then to spend any more time on changing or adding extra lines to add it to things that are missing the channel. I don't have a lot of spare time these days.

Signed-off-by: Matthew Skinner <matt@pcmus.com>

...r/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV220.java

...main/java/org/openhab/binding/opensprinkler/internal/handler/OpenSprinklerDeviceHandler.java

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

lolodomo · 2023-12-07T11:05:53Z

@Skinah : any chance you take a look to my last comments ? I would like to merge your PR for OH 4.1.

Signed-off-by: Matthew Skinner <matt@pcmus.com>

Skinah · 2023-12-10T04:49:29Z

@lolodomo I believe all changes are now addressed. Can you take a look over the update instructions to ensure I did them correctly please?

bundles/org.openhab.binding.opensprinkler/src/main/resources/OH-INF/thing/thing-types.xml

Signed-off-by: Matthew Skinner <matt@pcmus.com>

lolodomo

LGTM, thank you

openhab-bot · 2024-02-28T02:54:25Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/too-many-stations-listed/152241/2

….2.0 (openhab#15410) * Fix Program names are not parsed correctly in firmware 2.2.0 --------- Signed-off-by: Matthew Skinner <matt@pcmus.com> Signed-off-by: Jørgen Austvik <jaustvik@acm.org>

….2.0 (openhab#15410) * Fix Program names are not parsed correctly in firmware 2.2.0 --------- Signed-off-by: Matthew Skinner <matt@pcmus.com>

Skinah added the bug An unexpected problem or unintended behavior of an add-on label Aug 12, 2023

Skinah requested review from CrackerStealth and FlorianSW as code owners August 12, 2023 08:01

Skinah changed the title ~~Fix Program names are not parsed correctly for firmware 2.2.0~~ [opensprinkler] Fix Program names are not parsed correctly for firmware 2.2.0 Aug 12, 2023

Skinah added the enhancement An enhancement or new feature for an existing add-on label Aug 22, 2023

Skinah changed the title ~~[opensprinkler] Fix Program names are not parsed correctly for firmware 2.2.0~~ [opensprinkler] Fix Program names and add new features for firmware 2.2.0 Aug 22, 2023

lolodomo requested changes Oct 18, 2023

View reviewed changes

lolodomo reviewed Oct 18, 2023

View reviewed changes

lolodomo added the awaiting feedback Awaiting feedback from the pull request author label Nov 3, 2023

Skinah added 5 commits November 26, 2023 13:10

Fix Program names are not parsed correctly in firmware 2.2.0

1a9f531

Signed-off-by: Matthew Skinner <matt@pcmus.com>

Add new features.

ea72123

Signed-off-by: Matthew Skinner <matt@pcmus.com>

spotless fixes

68b5732

Signed-off-by: Matthew Skinner <matt@pcmus.com>

add dependancy

2f8e17d

Signed-off-by: Matthew Skinner <matt@pcmus.com>

update i18n translations

f5044e3

Signed-off-by: Matthew Skinner <matt@pcmus.com>

Skinah force-pushed the os branch from 6b9888b to f5044e3 Compare November 26, 2023 02:11

Skinah added 6 commits November 26, 2023 13:29

remove dependancy.

9b54626

Signed-off-by: Matthew Skinner <matt@pcmus.com>

remove dep from features.

c328245

Signed-off-by: Matthew Skinner <matt@pcmus.com>

Change channels to DecimalType and Number.

5cf82ed

Signed-off-by: Matthew Skinner <matt@pcmus.com>

tidy up channel commands

cbf20e5

Signed-off-by: Matthew Skinner <matt@pcmus.com>

Add suggest param

ea47a41

Signed-off-by: Matthew Skinner <matt@pcmus.com>

remove unused vars

68d20cc

Signed-off-by: Matthew Skinner <matt@pcmus.com>

lolodomo removed the awaiting feedback Awaiting feedback from the pull request author label Nov 26, 2023

lolodomo requested changes Nov 26, 2023

View reviewed changes

...r/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerHttpApiV220.java Outdated Show resolved Hide resolved

lolodomo requested changes Nov 26, 2023

View reviewed changes

...main/java/org/openhab/binding/opensprinkler/internal/handler/OpenSprinklerDeviceHandler.java Outdated Show resolved Hide resolved

...main/java/org/openhab/binding/opensprinkler/internal/handler/OpenSprinklerDeviceHandler.java Outdated Show resolved Hide resolved

lolodomo requested changes Nov 26, 2023

View reviewed changes

bundles/org.openhab.binding.opensprinkler/README.md Outdated Show resolved Hide resolved

Skinah added 2 commits December 10, 2023 14:41

Fix suggestions.

1d2e0f4

Signed-off-by: Matthew Skinner <matt@pcmus.com>

upgrade inst added.

7d9901a

Signed-off-by: Matthew Skinner <matt@pcmus.com>

lolodomo requested changes Dec 10, 2023

View reviewed changes

bundles/org.openhab.binding.opensprinkler/src/main/resources/OH-INF/thing/thing-types.xml Outdated Show resolved Hide resolved

remove version.

f59d057

Signed-off-by: Matthew Skinner <matt@pcmus.com>

lolodomo approved these changes Dec 10, 2023

View reviewed changes

lolodomo merged commit a950f19 into openhab:main Dec 10, 2023
3 checks passed

lolodomo added this to the 4.1 milestone Dec 10, 2023

Skinah deleted the os branch December 10, 2023 10:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[opensprinkler] Fix Program names and add new features for firmware 2.2.0 #15410

[opensprinkler] Fix Program names and add new features for firmware 2.2.0 #15410

Skinah commented Aug 12, 2023 •

edited

Loading

openhab-bot commented Aug 12, 2023

lolodomo Oct 18, 2023

lolodomo Oct 18, 2023

jlaur Oct 18, 2023 •

edited

Loading

Skinah Oct 18, 2023

Skinah Oct 18, 2023

lolodomo commented Dec 7, 2023

Skinah commented Dec 10, 2023

lolodomo left a comment

openhab-bot commented Feb 28, 2024

[opensprinkler] Fix Program names and add new features for firmware 2.2.0 #15410

[opensprinkler] Fix Program names and add new features for firmware 2.2.0 #15410

Conversation

Skinah commented Aug 12, 2023 • edited Loading

openhab-bot commented Aug 12, 2023

lolodomo Oct 18, 2023

Choose a reason for hiding this comment

lolodomo Oct 18, 2023

Choose a reason for hiding this comment

jlaur Oct 18, 2023 • edited Loading

Choose a reason for hiding this comment

Skinah Oct 18, 2023

Choose a reason for hiding this comment

Skinah Oct 18, 2023

Choose a reason for hiding this comment

lolodomo commented Dec 7, 2023

Skinah commented Dec 10, 2023

lolodomo left a comment

Choose a reason for hiding this comment

openhab-bot commented Feb 28, 2024

Skinah commented Aug 12, 2023 •

edited

Loading

jlaur Oct 18, 2023 •

edited

Loading