[ANSWERED]Custom sprinkler device

Hello,

I'm working on a sprinkler plugin, and had a look on the SDK example.
If the property OverrideScheduleActions is set to True, the overall sprinkler actions have to be managed by the plugin. When a schedule is started through the RunNewSchedule action, what is the way of working regarding the sprinkler properties ? Do I have to update the zoneScheduledDurations and activeZones properties, or is it managed by the Indigo Server ?

Regards,

Julien

[jay (support)]

Indigo will handle zone durations for you since it will get those from the user directly. You manage the activeZone in the ZoneOn action handler - basically, you do whatever you need to do to tell the sprinkler device which zone to activate, then when you get confirmation (hopefully) you update the activeZone state (see line 59 in the example plugin):

Code: Select all

# And then tell the Indigo Server to update the state.
dev.updateStateOnServer("activeZone", action.zoneIndex)


[matt (support)]

I think in this case Julien is asking how to handle the higher level commands since he is setting OverrideScheduleActions to True.

In that case then in addition to updating the activeZone state, you do also have to manage the properties as well: PreviousZoneDurations, ScheduledZoneDurations, and PauseScheduleZoneIndex. I believe the example in the SDK is pretty complete and shows what to update, so look at that in detail. If you have questions about what the SDK example is doing then let me know.

[jay (support)]

LOL - True != False...

Sorry!

Thanks guys. That's clear.

2 more questions :
- how have I to manage the new pausedScheduleRemainingZoneDuration property ?
- what is the difference between the StopSchedule and AllZonesOff actions ?

An other point : I have a strange behavior, and I don't know if it's on my side or on your side. When I update the activeZone state with an integer, the new value is stored as a string ... I don't find in my code where could be the mistake, so perhaps it's on your side ... If you can check ?

Julien

[matt (support)]

Hi Julien,

how have I to manage the new pausedScheduleRemainingZoneDuration property ?

You'll want to update the pluginProps["PauseScheduleRemainingZoneDuration"] value for that. I just posted an update to the SDK (1.2.2) Example Sprinkler plugin that shows roughly how/when to set PauseScheduleRemainingZoneDuration (pretty much the exact places PauseScheduleZoneIndex is used). The value is just as a place the plugin can store the remaining zone duration for the activeZone when it is paused, such that it knows on resume to use that duration. Because you have OverrideScheduleActions set to True you'll have to calculate what the remainingZoneDuration value should be manually.

Note that IndigoServer has a buglet in the python object model so that the dev.pausedScheduleRemainingZoneDuration attribute does not mirror the dev.pluginProps["PauseScheduleRemainingZoneDuration"] property. They should always be the same, but in the case of OverrideScheduleActions being True the value isn't reflecting on the device instance property correctly. That will be fixed in the next release of Indigo, but in the mean time you can just access it via dev.pluginProps[] which is what the SDK example does.

what is the difference between the StopSchedule and AllZonesOff actions ?

If I remember correctly,

if OverrideScheduleActions is False:

• AllZonesOff will be called whenever Indigo Server's logic determines no zones should be on (user presses stop schedule, a schedule ends, user pauses a schedule, etc.)
• StopSchedule is never called since Indigo Server handles the higher level scheduling

else if OverrideScheduleActions is True:

• StopSchedule will be called whenever user stops an actively running schedule
• StopSchedule will also be called if user turns off the zones when no schedule is running (ex: they manually selected a zone when no schedule was running, then press stop)

I'm not 100% positive on the last one though, in that case AllZonesOff might be dispatched instead. I'd have to just try it to see.

When I update the activeZone state with an integer, the new value is stored as a string ... I don't find in my code where could be the mistake, so perhaps it's on your side

Should be an integer. I tried it with the example plugin and never saw it become a string. Let me know if you come up with steps to reproduce the problem.

OK thanks Matt for your detailed explanations.

I have just finished a new version of my plugin, and everything works perfectly.

Julien

Hello guys,

Another question : I don't understand how I have to manage to take into account the multiply duration variable.
The information (the variable or its value) is not contained in the action dict, and the values from the zoneDurations key have not been multiplied.

Julien

[matt (support)]

Hi Julien,

The variable ID should have been included in the action, but it wasn't. It will be in a future version of Indigo as action.multiplierVarId.

Ok, I Will prepare the code and wait for the update.
Just to be sure : multiplierVarId will be None if the checkbox is not ticked in the sprinkler schedule UI ?

[matt (support)]

It should be None but to be safe you might also want to check for integer 0.

Ok thanks Matt.

[matt (support)]

The new multiplierVarId attribute is now available in v6.1.5.

Thanks !