Author Topic: Plugin: Rachio Irrigation  (Read 804 times)

Offline rigpapa

  • Sr. Member
  • ****
  • Posts: 358
  • Karma: +50/-0
Plugin: Rachio Irrigation
« on: January 16, 2018, 06:19:13 pm »
I am starting this thread as the (new) official thread for the Rachio plugin.

The Rachio plugin provides an interface to Rachio Iro Irrigation controllers. The plugin supports multiple controllers, each with any number of zones and schedules. Each device allows the basic functions available for the respective device.

Full documentation is available on my web site. The project also has a GitHub repository for those who may like to live on the bleeding edge.


UPDATE HISTORY
2018-03-19: Version 1.3 is now available in the Vera plugin marketplace. This version better supports recent changes Rachio has made to their API, which is to say, it restores some functionality arising from things they broke, and avoids crashing over things that they have not yet fixed. I will continue to track the API status and incorporate workarounds and fixes as I discover them, but for now, basic functionality is restored. The most glaring defect remaining is that the Rachio API no longer announces when a manual single- or multi-zone schedule is running, so there is no consistent state change or update in the display of the plugin in this circumstance. Schedule-based manual runs (i.e. starting a schedule manually) works, but Rachio's start time and duration reports are broken, so time remaining will not display correctly. If/when Rachio fixes their API, these issues should resolve on their own.

2018-03-04: Version 1.2 considerably reduces traffic between the plugin and the API by caching more information, and unfortunately, making update calls less frequently (every 3 minutes by default, vs every minute previously). The latter is an unfortunate necessity arising from Rachio's low quota of 1700 API calls per day (making one query per minute would be 1440 calls, and many activities take several calls).

2018-01-15: Version 1.1 of the Rachio plugin (approved 2018-01-22) fixes a few small bugs, and answers a request for the Zone devices to be identified as valves (category 3 subcategory 7).


TROUBLESHOOTING
Why does my plugin device say "Delayed"?
Rachio is now enforcing a quota of 1700 requests per day to its API. This may cause the RachioService plugin to stall at some point during the day, and it will be unable to update status or issue commands until the following day. The version 1.2 release attempts to mitigate this problem. If you have other systems that also hit the Rachio API, they also impact the quota and therefore affect the operation of this plugin. The Home Assistant Rachio component, in particular, is currently badly broken, attempting more than 5,000 API calls per day, so if you use HA with Vera, you would be well-advised to turn off that integration in HA and use the pass-through devices from this plugin running on the Vera for your HA display/control.


« Last Edit: March 19, 2018, 08:57:29 am by rigpapa »
Author of Rachio, Deus Ex Machina II, Intesis WMP Gateway, SiteSensor, DelayLight, Auto Virtual Thermostat and VirtualSensor plugins. Vera Plus w/100+ Z-wave devices. Vera3 sandbox.

Offline ssubo

  • Sr. Newbie
  • *
  • Posts: 35
  • Karma: +0/-0
Re: Plugin: Rachio Irrigation
« Reply #1 on: March 15, 2018, 05:37:19 pm »
Thanks for a great plugin! In the last few days I've been getting "Offline (internal error)". I updated the API Token just in case but I'm still getting the error. Anything I can do? I'm running 1.2. Tks!

Offline rigpapa

  • Sr. Member
  • ****
  • Posts: 358
  • Karma: +50/-0
Re: Plugin: Rachio Irrigation
« Reply #2 on: March 15, 2018, 07:10:00 pm »
Rachio changed their API about two weeks ago. It was disastrous. They injected numerous bugs (for example, the API call to put a controller online put it in standby, and the API to put it in standby would put it on line), and removed some fields (no warning, and no change in spec/documentation, just gone--this is why your plugin is stopped, probably). They also introduced a quota on the number of API calls per day (1700) a week before that.

I have a new version of the plugin that will deal with the lost fields and the quota. I've been working with Rachio for three weeks to get some of their bugs fixed, but so far, they've only fixed about 1/2 of what I've reported. Over time, as more API users begin to discover what's going on, they'll probably get around to the rest. My goal right now is simply to make the plugin as tolerant of future changes as possible, and work around the remaining shortcomings in a way that doesn't break things when (or if) they get around to fixing them.

Vera's plugin release cycle is Monday. I'll have an updated version of the plugin in for approval. It should be mostly functional, but as of this writing, the biggest outstanding issue is that the updated Rachio API does not report when a controller is watering manually on a zone-specific manual start (it does report manual and automatic schedule starts), so the plugin will be unable to show the correct status of the controller in this case until Rachio gets it head out of its grass.
« Last Edit: March 15, 2018, 09:41:57 pm by rigpapa »
Author of Rachio, Deus Ex Machina II, Intesis WMP Gateway, SiteSensor, DelayLight, Auto Virtual Thermostat and VirtualSensor plugins. Vera Plus w/100+ Z-wave devices. Vera3 sandbox.

Offline kartcon

  • Full Member
  • ***
  • Posts: 142
  • Karma: +7/-0
Re: Plugin: Rachio Irrigation
« Reply #3 on: March 15, 2018, 09:00:23 pm »
rigpapa,

Thanks for the status update. I had noticed the problems you stated, but had not pushed it to the front of my Vera to do list. Nice to know that it is not a MCV issue. Thanks again for such a great plug-in and the efforts you put in to maintaining it.

Offline Sammy2

  • Hero Member
  • *****
  • Posts: 799
  • Karma: +4/-4
Re: Plugin: Rachio Irrigation
« Reply #4 on: March 15, 2018, 09:30:14 pm »
That explains it. Figured it corresponds to the release of the "improved" Rachio App which is also a disaster in layout and functionality.

Don't fix it if it isn't broken!

Looking forward to the update.

THANKS!

Sent from my SM-G930P using Tapatalk


Offline tomtcom

  • Hero Member
  • *****
  • Posts: 936
  • Karma: +21/-31
Re: Plugin: Rachio Irrigation
« Reply #5 on: March 24, 2018, 12:20:23 pm »
Hey Rigpapa and everyone else, I sent a PM to Rigpapa but in case there's an answer I wanted everyone to see it. Looking to see if DataMine2 or the API to Rachio can extract values such as the water used for DataMine2 instead of using their app/site. I see on the browser you can download data although prior to March 1st isn't available. So just curious if this could be added or not possible.

Offline rigpapa

  • Sr. Member
  • ****
  • Posts: 358
  • Karma: +50/-0
Re: Plugin: Rachio Irrigation
« Reply #6 on: March 24, 2018, 12:35:58 pm »
That data is not returned by their API, or if it is, I haven't found it.
Author of Rachio, Deus Ex Machina II, Intesis WMP Gateway, SiteSensor, DelayLight, Auto Virtual Thermostat and VirtualSensor plugins. Vera Plus w/100+ Z-wave devices. Vera3 sandbox.

Offline tomtcom

  • Hero Member
  • *****
  • Posts: 936
  • Karma: +21/-31
Re: Plugin: Rachio Irrigation
« Reply #7 on: March 24, 2018, 12:42:10 pm »
That data is not returned by their API, or if it is, I haven't found it.

Understood, thanks Rigpapa!

Offline lvandeusenii

  • Sr. Newbie
  • *
  • Posts: 45
  • Karma: +0/-0
Re: Plugin: Rachio Irrigation
« Reply #8 on: April 20, 2018, 01:19:13 pm »
Hi @rigapapa,

I wanted to know if I could use your code to build a plugin for rainmachine.  I'd like to use the structure but leveraging Rainmachine's api. 

Offline rigpapa

  • Sr. Member
  • ****
  • Posts: 358
  • Karma: +50/-0
Re: Plugin: Rachio Irrigation
« Reply #9 on: April 21, 2018, 07:03:40 am »
I have no problem with that. It's GPL3, so derivative works are OK. Check the license for details.
Author of Rachio, Deus Ex Machina II, Intesis WMP Gateway, SiteSensor, DelayLight, Auto Virtual Thermostat and VirtualSensor plugins. Vera Plus w/100+ Z-wave devices. Vera3 sandbox.

Offline keithj69

  • Sr. Newbie
  • *
  • Posts: 37
  • Karma: +0/-0
Re: Plugin: Rachio Irrigation
« Reply #10 on: April 29, 2018, 09:13:46 am »
Have they stopped users from getting the api key?  I have tried from multiple browsers from my account settings, and nothing happens when i click the api key.

Offline rigpapa

  • Sr. Member
  • ****
  • Posts: 358
  • Karma: +50/-0
Re: Plugin: Rachio Irrigation
« Reply #11 on: April 29, 2018, 12:01:27 pm »
Pop-up blocker?
Author of Rachio, Deus Ex Machina II, Intesis WMP Gateway, SiteSensor, DelayLight, Auto Virtual Thermostat and VirtualSensor plugins. Vera Plus w/100+ Z-wave devices. Vera3 sandbox.

Offline panic

  • Newbie
  • *
  • Posts: 2
  • Karma: +0/-0
Re: Plugin: Rachio Irrigation
« Reply #12 on: May 03, 2018, 06:55:42 am »
Hi @rigapapa,

I wanted to know if I could use your code to build a plugin for rainmachine.  I'd like to use the structure but leveraging Rainmachine's api.

If you find it helpful you can use: https://github.com/sprinkler/rainmachine-developer-resources/tree/master/api-lua. I'm looking at integrating RainMachine too but I find the documentation scarce.