[rachio] Initial contribution #10434

markus7017 · 2021-04-02T14:31:16Z

This binding integrates Rachio sprinkler controllers. The binding uses the Rachio Cloud API. Event callback can be configured to utilized myopenhab.org as a proxy.

openhab-bot · 2021-04-02T14:42:56Z

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

https://community.openhab.org/t/rachio-smart-sprinkler-controller/7078/352

robnielsen · 2021-04-11T01:00:36Z

@markus7017, I'm trying out the rachio binding, and noticed some messages getting logged with INFO. These will need to be changed to debug or higher.

robnielsen · 2021-04-13T18:03:08Z

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

+    Thing rachio:zone:1:XXXXXXXXXXXX-5 "Rachio zone 5" @ "Sprinkler"
+    Thing rachio:zone:1:XXXXXXXXXXXX-6 "Rachio zone 6" @ "Sprinkler"
+    Thing rachio:zone:1:XXXXXXXXXXXX-7 "Rachio zone 7" @ "Sprinkler"
+    Thing rachio:zone:1:XXXXXXXXXXXX-8 "Rachio zone 8" @ "Sprinkler"


I'm seeing the following in openhab.log with my 8 zone rachio:

2021-04-13 12:47:27.271 [INFO ] [el.core.internal.ModelRepositoryImpl] - Validation issues found in configuration model 'rachio.things', using it anyway: Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId> Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId> Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId> Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId> Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId> Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId> Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId> Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId> Provide a thing type ID and a thing ID in this format: <thingTypeId> <thingId>

robnielsen · 2021-04-13T18:06:32Z

...chio/src/main/java/org/openhab/binding/rachio/internal/discovery/RachioDiscoveryService.java

+@NonNullByDefault
+public class RachioDiscoveryService extends AbstractDiscoveryService implements DiscoveryService, ThingHandlerService {
+
+    private static final int DISCOVERY_REFRESH_SEC = 900;


Why is this necessary every 15 minutes? Once a controller is configured why does this need to continually occur?

robnielsen · 2021-04-13T18:09:37Z

...chio/src/main/java/org/openhab/binding/rachio/internal/discovery/RachioDiscoveryService.java

+                    logger.info("Zone#{} '{}' (id={}) added, enabled={}", zone.zoneNumber, zone.name, zone.id,
+                            zone.getEnabled());
+
+                    if (zone.getEnabled() == OnOffType.ON) {


Shouldn't all zones be added, even if they are currently be disabled? The zones can be ignored in the inbox if needed.

robnielsen · 2021-04-13T18:14:52Z

...chio/src/main/java/org/openhab/binding/rachio/internal/discovery/RachioDiscoveryService.java

+                    // register thing if it not already exists
+                    ThingUID zoneThingUID = new ThingUID(THING_TYPE_ZONE, bridgeUID, zone.getThingID());
+                    zone.setUID(devThingUID, zoneThingUID);
+                    logger.info("Zone#{} '{}' (id={}) added, enabled={}", zone.zoneNumber, zone.name, zone.id,


logger.debug

robnielsen · 2021-04-13T18:15:05Z

...chio/src/main/java/org/openhab/binding/rachio/internal/discovery/RachioDiscoveryService.java

+                                .withLabel(dev.name + "[" + zone.zoneNumber + "]: " + zone.name).build();
+                        thingDiscovered(zoneDiscoveryResult);
+                    } else {
+                        logger.info("Zone#{} '{}' is disabled, skip thing creation", zone.name, zone.id);


logger.debug

robnielsen · 2021-04-13T18:15:13Z

...chio/src/main/java/org/openhab/binding/rachio/internal/discovery/RachioDiscoveryService.java

+                    }
+                }
+            }
+            logger.info("{}  Rachio device initialized.", deviceList.size());


logger.debug

robnielsen · 2021-04-13T18:15:37Z

...chio/src/main/java/org/openhab/binding/rachio/internal/discovery/RachioDiscoveryService.java

+                // register thing if it not already exists
+                ThingUID devThingUID = new ThingUID(THING_TYPE_DEVICE, bridgeUID, dev.getThingID());
+                dev.setUID(bridgeUID, devThingUID);
+                logger.info(" Rachio device discovered: '{}' (id {}), S/N={}, MAC={}", dev.name, dev.id,


logger.debug

robnielsen · 2021-04-13T18:15:44Z

...chio/src/main/java/org/openhab/binding/rachio/internal/discovery/RachioDiscoveryService.java

+                logger.info(" Rachio device discovered: '{}' (id {}), S/N={}, MAC={}", dev.name, dev.id,
+                        dev.serialNumber, dev.macAddress);
+                logger.debug("  latitude={}, longitude={}", dev.latitude, dev.longitude);
+                logger.info("   device status={}, paused/sleep={}, on={}", dev.status, dev.getSleepMode(),


logger.debug

robnielsen · 2021-04-13T18:16:44Z

...ding.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioZoneHandler.java

+            zone.setEvent(evt, getTimestamp()); // and funnel all zone events to the device
+            if (event.type.equals("ZONE_STATUS")) {
+                if (event.zoneRunStatus.state.equals("ZONE_STARTED")) {
+                    logger.info("{}: Zone {} STARTED watering ({}).", thingId, zoneName, event.timestamp);


logger.debug

robnielsen · 2021-04-13T18:16:53Z

...ding.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioZoneHandler.java

+                    logger.info("{}: Zone {} STARTED watering ({}).", thingId, zoneName, event.timestamp);
+                    updateChannel(CHANNEL_ZONE_RUN, OnOffType.ON);
+                } else if (event.subType.equals("ZONE_STOPPED") || event.subType.equals("ZONE_COMPLETED")) {
+                    logger.info(


logger.debug

robnielsen · 2021-04-13T18:17:04Z

...ding.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioZoneHandler.java

+                            event.durationInMinutes, event.flowVolume);
+                    updateChannel(CHANNEL_ZONE_RUN, OnOffType.OFF);
+                } else {
+                    logger.info("{}: Event for zone {}: {} (status={}, duration = {}sec)", thingId, event.zoneName,


logger.debug

robnielsen · 2021-04-13T18:17:11Z

...ding.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioZoneHandler.java

+                }
+                update = true;
+            } else if (event.subType.equals("ZONE_DELTA")) {
+                logger.info("{}: DELTA Event for zone {}: {}.{}", thingId, zone.name, event.category, event.action);


logger.debug

robnielsen · 2021-04-13T18:24:15Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioBridgeHandler.java

+                }
+            }
+
+            logger.info("RachioCloud: Connector initialized");


logger.debug

robnielsen · 2021-04-13T18:24:34Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioBridgeHandler.java

+                RachioDevice checkDev = de.getValue();
+                RachioDevice dev = deviceList.get(checkDev.id);
+                if (dev == null) {
+                    logger.info("RachioCloud: New device detected: {} - {}", checkDev.id, checkDev.name);


logger.debug

robnielsen · 2021-04-13T18:24:48Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioBridgeHandler.java

+    }
+
+    public void shutdown() {
+        logger.info("RachioCloud: Shutting down");


logger.debug

robnielsen · 2021-04-13T18:27:07Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                }
+            } else if (channel.equals(RachioBindingConstants.CHANNEL_DEVICE_STOP)) {
+                if (command == OnOffType.ON) {
+                    logger.info("STOP watering for device '{}'", dev.name);


logger.debug

robnielsen · 2021-04-13T18:27:12Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                }
+            } else if (channel.equals(RachioBindingConstants.CHANNEL_DEVICE_RAIN_DELAY)) {
+                if (command instanceof DecimalType) {
+                    logger.info("Start rain delay cycle for {} sec", command.toString());


logger.debug

robnielsen · 2021-04-13T18:27:47Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioBridgeHandler.java

+            if (checkApi.getLastApiResult().isRateLimitWarning()) {
+                skipCalls++;
+                if (skipCalls % RACHIO_RATE_SKIP_CALLS > 0) {
+                    logger.info("RachioCloud: API limit is getting critical -> skip update ({} / {})", skipCalls,


logger.debug

robnielsen · 2021-04-13T18:28:06Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                // RAIN_SENSOR_DETECTION_ON, RAIN_SENSOR_DETECTION_OFF, RAIN_DELAY_ON, RAIN_DELAY_OFF
+                logger.debug("Device {} ('{}') changed to status '{}'.", d.name, d.id, event.subType);
+                if (event.subType.equals("COLD_REBOOT")) {
+                    logger.info("{}: Device {}  was restarted, ip={}/{}, gw={}, dns={}/{}, wifi rssi={}.", thingId,


logger.debug

robnielsen · 2021-04-13T18:28:19Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                        dev.setNetwork(event.network);
+                    }
+                } else if (event.subType.equals("ONLINE")) {
+                    logger.info("{}: Device is ONLINE.", thingId);


logger.debug

robnielsen · 2021-04-13T18:28:26Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                    logger.info("{}: Device is ONLINE.", thingId);
+                    dev.setStatus(event.subType);
+                } else if (event.subType.equals("OFFLINE") || event.subType.equals("OFFLINE_NOTIFICATION")) {
+                    logger.info("{}: Device is OFFLINE (subType = '{}').", thingId, event.subType);


logger.debug

robnielsen · 2021-04-13T18:28:33Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                    logger.info("{}: Device is OFFLINE (subType = '{}').", thingId, event.subType);
+                    dev.setStatus(event.subType);
+                } else if (event.subType.equals("SLEEP_MODE_ON")) {
+                    logger.info("{}: Device switch to sleep mode.", thingId);


logger.debug

robnielsen · 2021-04-13T18:28:55Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                    logger.info("{}: Device reporterd Rain Delay ON.", thingId);
+                    update = false; // details missing
+                } else if (event.subType.equals("RAIN_DELAY_OFF")) {
+                    logger.info("{}: Device reporterd Rain Delay OFF.", thingId);


logger.debug

robnielsen · 2021-04-13T18:29:01Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                    logger.info("{}: Device reporterd Rain Delay OFF.", thingId);
+                    update = false; // details missing
+                } else if (event.subType.equals("RAIN_SENSOR_DETECTION_ON")) {
+                    logger.info("{}: Device reporterd a Rain Sensor ON.", thingId);


logger.debug

robnielsen · 2021-04-13T18:29:08Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                    logger.info("{}: Device reporterd a Rain Sensor ON.", thingId);
+                    update = false; // details missing
+                } else if (event.subType.equals("RAIN_SENSOR_DETECTION_ON")) {
+                    logger.info("{}: Device reporterd Rain Sensor OFF.", thingId);


logger.debug

robnielsen · 2021-04-13T18:29:18Z

...ng.rachio/src/main/java/org/openhab/binding/rachio/internal/handler/RachioDeviceHandler.java

+                    update = false; // details missing
+                }
+            } else if (event.type.equals("SCHEDULE_STATUS")) {
+                logger.info("{}: Status {} for schedule {}: {} (start={}, end={}, duration={}min)", thingId,


logger.debug

robnielsen · 2021-04-13T19:30:30Z

...chio/src/main/java/org/openhab/binding/rachio/internal/discovery/RachioDiscoveryService.java

+                    TimeUnit.SECONDS);
+        }
+    }
+


Missing:

@Override protected void stopBackgroundDiscovery() { logger.debug("Stopping background discovery for new Rachio controllers"); if (discoveryJob != null) { discoveryJob.cancel(true); discoveryJob = null; } }

Signed-off-by: Markus Michels <markus7017@gmail.com>

myopenhab.org) Signed-off-by: Markus Michels <markus7017@gmail.com>

properties Signed-off-by: Markus Michels <markus7017@gmail.com>

Signed-off-by: Markus Michels <markus7017@gmail.com>

kaikreuzer · 2021-06-21T19:18:39Z

@markus7017 Did you see @robnielsen's review comments?

fwolter · 2021-12-11T11:58:07Z

@markus7017 Did you see @kaikreuzer's question if you saw @robnielsen comments?

jlaur

Setting PR status according to pending review comments.

lolodomo · 2022-06-11T07:12:36Z

Marked as "stale", last activity was 14 months ago and there were unfortunately no answers to review comments.

markus7017 · 2022-07-08T21:56:58Z

Hi gusy, sorry. I set other priorities, but just some people asked for OH 3.3 support so I'll work on this shortly

wborn · 2022-07-10T08:15:59Z

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

+  <parent>
+    <groupId>org.openhab.addons.bundles</groupId>
+    <artifactId>org.openhab.addons.reactor.bundles</artifactId>
+    <version>3.1.0-SNAPSHOT</version>


Suggested change

<version>3.1.0-SNAPSHOT</version>

<version>3.4.0-SNAPSHOT</version>

Signed-off-by: Markus Michels <markus7017@gmail.com>

jlaur · 2022-12-23T15:49:23Z

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

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">


Suggested change

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

See #11833

wborn · 2022-12-29T10:52:11Z

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

+  <parent>
+    <groupId>org.openhab.addons.bundles</groupId>
+    <artifactId>org.openhab.addons.reactor.bundles</artifactId>
+    <version>3.4.0-SNAPSHOT</version>


Suggested change

<version>3.4.0-SNAPSHOT</version>

<version>4.2.0-SNAPSHOT</version>

lsiepel · 2023-01-16T15:55:57Z

bundles/org.openhab.binding.rachio/src/main/resources/OH-INF/binding/binding.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>


This needs to be adapted to the new addon.xml, the PR to adapt the developer docs is not merged yet, so if you need more details, the corresponding issue is here: openhab/openhab-core#2058
But you can also update your branch and look at another binding's addon.xml and adapt it to this initial contribution.

lsiepel · 2023-12-29T09:07:35Z

This PR is 2,5 years old. In #10434 (comment) @markus7017 (PR author) commented that his priorities have changed. Now (over a year later) the status quo has not changed. As this PR needs some work (review, fixes etc), i don't think some one else will bring it to a mergable state.
If ever needed it can be re-opened at any time.

markus7017 requested a review from a team as a code owner April 2, 2021 14:31

markus7017 added the new binding If someone has started to work on a binding. For a new binding PR. label Apr 2, 2021

markus7017 added this to the 3.1 milestone Apr 2, 2021

markus7017 self-assigned this Apr 2, 2021

markus7017 force-pushed the rachio_snapshot3 branch from cc468f9 to 81bdd69 Compare April 2, 2021 14:41

markus7017 force-pushed the rachio_snapshot3 branch from a13bd8a to 03f81c8 Compare April 5, 2021 14:12

robnielsen reviewed Apr 13, 2021

View reviewed changes

markus7017 added 5 commits April 27, 2021 21:09

Adaption to OH3

51361e5

Signed-off-by: Markus Michels <markus7017@gmail.com>

auto-url encode the credentials, README updated

45244e8

Signed-off-by: Markus Michels <markus7017@gmail.com>

Some refactoring + new channels; README updated

666d002

Signed-off-by: Markus Michels <markus7017@gmail.com>

RachioNetwork IP filter removed (no longer required when using

d8c091a

myopenhab.org) Signed-off-by: Markus Michels <markus7017@gmail.com>

channels longitude + latitude removed from xml definition, those are

5ae3baa

properties Signed-off-by: Markus Michels <markus7017@gmail.com>

markus7017 force-pushed the rachio_snapshot3 branch from 03f81c8 to 5ae3baa Compare April 27, 2021 19:09

fix: prevent setting callback url multiple times

2422e11

Signed-off-by: Markus Michels <markus7017@gmail.com>

wborn removed this from the 3.1 milestone Jun 28, 2021

fwolter added the awaiting feedback Awaiting feedback from the pull request author label Jul 25, 2021

jlaur requested changes Feb 2, 2022

View reviewed changes

lolodomo added the stale As soon as a PR is marked stale, it can be removed 6 months later. label Jun 11, 2022

markus7017 removed awaiting feedback Awaiting feedback from the pull request author stale As soon as a PR is marked stale, it can be removed 6 months later. labels Jul 8, 2022

wborn reviewed Jul 10, 2022

View reviewed changes

pom.xml changed to 3.4.0

3a74dec

Signed-off-by: Markus Michels <markus7017@gmail.com>

wborn added the awaiting feedback Awaiting feedback from the pull request author label Nov 5, 2022

jlaur reviewed Dec 23, 2022

View reviewed changes

wborn reviewed Dec 29, 2022

View reviewed changes

lsiepel reviewed Jan 16, 2023

View reviewed changes

lsiepel closed this Dec 29, 2023

	<version>3.1.0-SNAPSHOT</version>
	<version>3.4.0-SNAPSHOT</version>

	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

	<version>3.4.0-SNAPSHOT</version>
	<version>4.2.0-SNAPSHOT</version>

[rachio] Initial contribution #10434

[rachio] Initial contribution #10434

Conversation

markus7017 commented Apr 2, 2021

openhab-bot commented Apr 2, 2021

robnielsen commented Apr 11, 2021

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

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

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

kaikreuzer commented Jun 21, 2021

fwolter commented Dec 11, 2021

jlaur left a comment

Choose a reason for hiding this comment

lolodomo commented Jun 11, 2022 • edited Loading

markus7017 commented Jul 8, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wborn Dec 29, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lsiepel commented Dec 29, 2023

lolodomo commented Jun 11, 2022 •

edited

Loading

wborn Dec 29, 2022 •

edited

Loading