MLIrrigation 3.75 Plugin

From Cinemar Wiki
Jump to: navigation, search

About

This PlugIn allows users to control any supported irrigation system.


Requirements

  • MLServer 3
  • MainLobby 3
  • Hardware specific driver


Supported Hardware

  • WGL & Associates
Rain8Net


Release Notes

Available Drivers


Setup

Adding a Controller

  1. Click Add below the Controllers Table.
  2. An ID will be auto-generated as well as an Alias. You can change these if you prefer.
  3. Select your irrigation controller model from the drop down.
  4. Specify the number of Slave units (not including your master).
  5. You will be prompted if you wish to auto-populate the Zones Table. We recommend you select yes.
  6. If you have a master valve or irrigation pump, specify which Zone is designated for this device.
  7. Press OK and your Zones will be created within the Zones Table.
  8. Next, select your Controller in the Controller Table and press EDIT.
  9. Specify your Com Port then press Connect.
  10. Also, check Connect on Start?
  11. We also recommend checking Master Valve Safety Shut Off and Maximum One Zone On at a Time.

Adding a New Program

  1. Click Programs menu at the top.
  2. Click New Program and enter the name of the program in the window that pops up.
  3. Click OK.
  4. The program should now show in the list of programs and is ready to have zones added.


Adding Zones to a Program

  1. Click on Programs tab at the top.
  2. Select the Program you would like to add a zone to from the programs list.
  3. Click Add Zone.
  4. Select the zone that you would like to add.
  5. Either select one of the predefined durations or enter the number of minutes that this zone it to run for.
  6. Click add command.
  7. The new zone should now appear in the next available position in the commands list for the program.


Removing Zones from a Program

  1. Click on the Programs tab at the top.
  2. Select the Program you wish to remove the zone from the programs list.
  3. Select the zone you wish to remove from the Zone list.
  4. Click Remove Zone.
  5. The zone is now removed from the program.


Edit Zone Duration in a Program

  1. Click on the Programs tab at the top.
  2. Select the Program you wish to remove the zone from the programs list.
  3. Select the zone you wish to edit from the Zone list.
  4. Enter the new zone duration in the pop up.
  5. Click OK.
  6. The zone duration is now changed.


Schedule a Program

  1. Click on Scheduler at the top.
  2. Select the program that you wish to schedule from the programs list.
  3. Select a watering schedule from the Schedule list.
  4. Based on what you selected as the watering schedule you will get one of the following options:
    • Calendar Day -- Check any day that you want the program to run.
    • Interval Day -- Enter the number of days in between each run of the program.
    • Odd/Even Day -- Check either odd or even.
  5. Enter up to eight start times in the text boxes provided. Ex. 12:35 pm.
  6. Click apply changes.
  7. The program is now scheduled to run.


MLServeCmd

On

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|On~Irrigation_Zone_Id


(Literal)

MLServeCmd.MLIrrigation|On~1

MLServeCmd.MLIrrigation|On~Back_Yard


Parameters

Irrigation_Zone_Id = The id of the zone to turn on.


Returns

Nothing


Description

Turns on the specified zone.


Notes

Also opens the master valve if not already open.


Off

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|Off~Irrigation_Zone_Id


(Literal)

MLServeCmd.MLIrrigation|Off~1

MLServeCmd.MLIrrigation|Off~Back_Yard


Parameters

Irrigation_Zone_Id = The id of the zone to turn off.


Returns

Nothing.


Description

Turns off the specified zone.


Notes

Also closes the master valve if no other zones are on.


AllOff

{MLServeCmd}Script Usage

MLServeCmd.Irrigation|AllOff~Irrigation_Controller_Id


(Literal)

MLServeCmd.MLIrrigation|AllOff~1

MLServeCmd.MLIrrigation|AllOff~Front_Controller


Parameters

Irrigation_Controller_Id = The id of the controller you wish to send the command to.


Returns

Nothing


Description

Turns off all zones on the specified controller including the master valve.


Notes


Toggle

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|Toggle~Irrigation_Zone_Id


(Literal)

MLServeCmd.MLIrrigation|Toggle~1

MLServeCmd.MLIrrigation|Toggle~Back_Yard


Parameters

Irrigation_Zone_Id = The id of the zone to be toggled.


Returns

None


Description

Toggles the specified zone. If on it is turned off, if off it is turned on.


Notes

If the zone is to be turned on the master valve is opened if it is not already.

If the zone is to be turned off the master valve is closed if no other zones are on.


ManualSingleZone

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|ManualSingleZone~Irrigation_Zone_Id~Duration


(Literal)

MLServeCmd.MLIrrigation|ManualSingleZone~1~10

MLServeCmd.MLIrrigation|ManualSingleZone~Back_Yard~10


Parameters

Irrigation_Zone_Id = The id of the zone to be toggled.
Duration = The time in minutes the zone is to run.


Returns

None


Description

Runs the specified zone for the specified number of minutes.


Notes

If the master valve is not open when the command is sent then it is opened.

When done if no other zones are on then the master valve is closed.


RunProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|RunProgram~Irrigation_Program_Id


(Literal)

MLServeCmd.MLIrrigation|RunProgram~1

MLServeCmd.MLIrrigation|RunProgram~Summer


Parameters

Irrigation_Program_Id = The id of the program to run.


Returns

None


Description

Runs the specified program.


Notes


Stop

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|Stop


(Literal)

MLServeCmd.MLIrrigation|Stop


Parameters

None


Returns

Nothing


Description

Stops the running program or manual zone.


Notes


Pause

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|Pause


(Literal)

MLServeCmd.MLIrrigation|Pause


Parameters

None


Returns

None


Description

Pauses the running program or manual zone.


Notes


NextZone

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|NextZone


(Literal)

MLServeCmd.MLIrrigation|NextZone


Parameters

None


Returns

Nothing


Description

Skips the currently active zone in the currently running program and starts the next.


Notes


NextProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|NextProgram


(Literal)

MLServeCmd.MLIrrigation|NextProgram


Parameters

None


Returns


Description

Stops the currently running program, if there is one, and starts the next one in the list. This command works in a circular fashion. When the end of the list is reached it automatically goes to the beginning.


Notes


PreviousProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|PreviousProgram


(Literal)

MLServeCmd.MLIrrigation|PreviousProgram


Parameters

None


Returns

Nothing


Description

Stops the currently running program, if there is one, and starts the previous one in the list. This command works in a circular fashion. When the beginning of the list is reached it automatically goes to the end.


Notes


INIClient

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|INIClient


(Literal)

MLServeCmd.MLIrrigation|INIClient


Parameters

None.


Returns

Nothing.


Description Initializes all variables for the client issueing the command.


Notes


SetProgramAlias

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetProgramAlias~Irrigation_Program_Id~New Alias


(Literal)

MLServeCmd.MLIrrigation|SetProgramAlias~1~Summer_Program


Parameters

Irrigation_Program_Id = The id of the program to set the alias on.
New Alias = The new alias to be assigned to the program.


Returns

Nothing.


Description

Sets the specified programs alias.


Notes


SetZoneAlias

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetZoneAlias~Irrigation_Zone_Id~New Alias


(Literal)

MLServeCmd.MLIrrigation|SetZoneAlias~2~Front_Yard


Parameters

Irrigation_Zone_Id = The id of the zone to set the alias on.
New Alias = The new alias of the zone.


Returns

Nothing.


Description

Sets the specified zones alias.


Notes


AdjustWateringTimeUp

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|AdjustWateringTimeUp~Irrigation_Program_Id~Time_Number


(Literal)

MLServeCmd.MLIrrigation|AdjustWateringTimeUp~Summer_Program~1


Parameters

Irrigation_Program_Id = The id of the program to adjust the start time for.
Time_Number = The number of the start time to adjust. (1-8)


Returns

Nothing.


Description

Increments the specified start time for the specified program by the set adjustment time.


Notes

See Also: SetIncrementValue


AdjustWateringTimeDown

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|AdjustWateringTimeDown~Irrigation_Program_Id~Time_Number


(Literal)

MLServeCmd.MLIrrigation|AdjustWateringTimeDown~Spring_Program~2


Parameters

Irrigation_Program_Id = The id of the program to adjust the start time for.
Time_Number = The number of the start time to adjust. (1-8)


Returns

Nothing.


Description

Decrements the specified start time for the specified program by the set adjustment time.


Notes

See Also: SetIncrementValue


NextWateringTimeType

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|NextWateringTimeType~Irrigation_Program_Id~Time_Number


(Literal)

MLServeCmd.MLIrrigation|NextWateringTimeType~Summer_Program~3


Parameters

Irrigation_Program_Id = The id of the program adjust the start time for.
Time_Number = The number of the start time to change the type. (1-8)


Returns

Nothing.


Description

Sets the specified start time for the specified program to the next watering type.

It will "scroll" through the available watering type types:

Off, AtTime, AtSunrise, AtSunset, BeforeSunrise, BeforeSunset, AfterSunrise, AfterSunset


Notes


PreviousWateringTimeType

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|PreviousWateringTimeType~Irrigation_Program_Id~Time_Number


(Literal)

MLServeCmd.MLIrrigation|PreviousWateringTimeType~2~3


Parameters

Irrigation_Program_Id = The id of the program adjust the start time for.
Time_Number = The number of the start time to change the type. (1-8)


Returns

Nothing.


Description

Sets the specified start time for the specified program to the next watering type.

It will "scroll" backwards through the available watering type types:

Off, AtTime, AtSunrise, AtSunset, BeforeSunrise, BeforeSunset, AfterSunrise, AfterSunset


Notes


SetIncrementValue

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetIncrementValue~Mins


(Literal)

MLServeCmd.MLIrrigation|SetIncrementValue~5


Parameters

Mins = The number of minutes to set the adjustment time to.

Returns

Nothing.


Description

Will set the value used when incrementing/decrementing a programs zone run time and the run time for a manual zone.


Notes


IncreaseRunningProgramZoneDuration

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|IncreaseRunningProgramZoneDuration~Irrigation_Zone_Id


(Literal)

MLServeCmd.MLIrrigation|IncreaseRunningProgramZoneDuration~4


Parameters

Irrigation_Zone_Id = The id of the zone adjust the duration for.


Returns

Nothing.


Description

Will increase the duration of the specified zone of the running program by 1 minute.


Notes


DecreaseRunningProgramZoneDuration

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|DecreaseRunningProgramZoneDuration~Irrigation_Zone_Id


(Literal)

MLServeCmd.MLIrrigation|DecreaseRunningProgramZoneDuration~1


Parameters

Irrigation_Zone_Id = The id of the zone to adjust the duration for.


Returns

Nothing.


Description

Will decrease the duration of the specified zone of the running program by 1 minute.


Notes


SelectProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SelectProgram~Irrigation_Program_Id


(Literal)

MLServeCmd.MLIrrigation|SelectProgram~7


Parameters

Irrigation_Program_Id = The id of the program the client wishes to view.


Returns

Nothing.


Description

Selects the program currently being viewed by the client issueing the command and sets all neccessary variables.


Notes


NextProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|NextProgram


(Literal)

MLServeCmd.MLIrrigation|NextProgram


Parameters

None.


Returns

Nothing.


Description

Selects the next available program being viewed by the client issueing the command and sets all neccessary variables.

This command works in a circular fashion, once the end of the list of programs is reached it will return to the start.


Notes


PreviousProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|PreviousProgram


(Literal)

MLServeCmd.MLIrrigation|PreviousProgram


Parameters

None.


Returns

Nothing.


Description

Selects the previous available program being viewed by the client issueing the command and sets all neccessary variables.

This command works in a circular fashion, once the beggining of the list of programs is reached it will return to the end.


Notes


SetSystemMode

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetSystemMode~System_Mode


(Literal)

MLServeCmd.MLIrrigation|SetSystemMode~All


Parameters

System_Mode = The system mode to be assigned. (Off,Schedule,Manual,All)


Returns

Nothing.


Description

Sets the system mode.

  • Off -- Turns off all schedules and accepts no commands to control any zones or programs.
  • Schedule -- Will only run scheduled programs, accepts no commands to control any zones or programs.
  • Manual -- Turns off all schedules, accepts commands
  • All -- All schedules will run and all commands are accepted


Notes


ViewZones

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|ViewZones


(Literal)

MLServeCmd.MLIrrigation|ViewZones


Parameters

None.


Returns

Nothing.


Description

Displays the first page of zones for the client issueing the command.


Notes


NextZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|NextZonePage


(Literal)

MLServeCmd.MLIrrigation|NextZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the next page of zones for the client issueing the command.

This command works in circular fashion, when the end of the zone pages is reached it will return to the beggining.


Notes


PrevZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|PrevZonePage


(Literal)

MLServeCmd.MLIrrigation|PrevZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the previous page of zones for the client issueing the command.

This command works in circular fashion, when the begginging of the zone pages is reached it will return to the end.


Notes


FirstZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|FirstZonePage


(Literal)

MLServeCmd.MLIrrigation|FirstZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the first page of zones for the client issueing the command.


Notes


LastZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|LastZonePage


(Literal)

MLServeCmd.MLIrrigation|LastZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the last page of zones for the client issueing the command.


Notes


ViewRunningProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|ViewRunningProgram


(Literal)

MLServeCmd.MLIrrigation|ViewRunningProgram


Parameters

None.


Returns

Nothing.


Description

Displays the first page of the zones in the running program for the client issueing the command.


Notes


NextRunningProgramPage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|NextRunningProgramPage

(Literal)

MLServeCmd.MLIrrigation|NextRunningProgramPage


Parameters

None.


Returns

Nothing.


Description

Displays the next page of zones in the running program for the client issueing the command.

This command works in a circular fashion, when the end of the pages of zones is reached it will return to the begginging.


Notes


PrevRunningProgramPage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|PrevRunningProgramPage


(Literal)

MLServeCmd.MLIrrigation|PrevRunningProgramPage


Parameters

None.


Returns

Nothing.


Description

Displays the previous page of zones in the running program for the client issueing the command.

This command works in a circular fashion, when the end of the pages of zones is reached it will return to the begginging.


Notes


FirstRunningProgramZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|FirstRunningProgramZonePage


(Literal)

MLServeCmd.MLIrrigation|FirstRunningProgramZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the first page of the zones in the running program for the client issueing the command.


Notes


LastRunningProgramZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|LastRunningProgramZonePage


(Literal)

MLServeCmd.MLIrrigation|LastRunningProgramZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the last page of the zones in the running program for the client issueing the command.


Notes


ViewProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|ViewProgram~Irrigation_Program_Id


(Literal)

MLServeCmd.MLIrrigation|ViewProgram~Summer_Program


Parameters

Irrigation_Program_Id = The id of the program to display.


Returns

Nothing.


Description

Displays the first page of zones in the specified program for the client issueing the command.


Notes


NextProgramZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|NextProgramZonePage


(Literal)

MLServeCmd.MLIrrigation|NextProgramZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the next page of zones in the program the client issueing the command is currently viewing.

This command works in a circular fashion, when the end of the pages of zones is reached it will return to the begginging.

Notes


PrevProgramZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|PrevProgramZonePage


(Literal)

MLServeCmd.MLIrrigation|PrevProgramZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the previous page of zones in the program the client issueing the command is currently viewing.

This command works in a circular fashion, when the beggining of the pages of zones is reached it will return to the end.


Notes


FirstProgramZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|FirstProgramZonePage


(Literal)

MLServeCmd.MLIrrigation|FirstProgramZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the first page of zones in the program the client issueing the command is currently viewing.


Notes


LastProgramZonePage

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|LastProgramZonePage


(Literal)

MLServeCmd.MLIrrigation|LastProgramZonePage


Parameters

None.


Returns

Nothing.


Description

Displays the last page of zones in the program the client issueing the command is currently viewing.


Notes


MoveProgramZoneUp

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|MoveProgramZoneUp~Irrigation_Zone_Id


(Literal)

MLServeCmd.MLIrrigation|MoveProgramZoneUp~3


Parameters

Irrigation_Zone_Id = The id of the zone to move.


Returns

Nothing.


Description

Moves the specified zone up one position in the program the client is currently viewing.


Notes


MoveProgramZoneDown

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|MoveProgramZoneDown


(Literal)

MLServeCmd.MLIrrigation|MoveProgramZoneDown


Parameters

Irrigation_Zone_Id = The id of the zone to move.


Returns

Nothing.


Description

Moves the specified zone down one position in the program the client is currently viewing.


Notes


SetDuration

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetDuration~Command~Time [Optional]


(Literal)

MLServeCmd.MLIrrigation|SetDuration~Next
MLServeCmd.MLIrrigation|SetDuration~Previous
MLServeCmd.MLIrrigation|SetDuration~Next~5
MLServeCmd.MLIrrigation|SetDuration~Previous~2


Parameters

Command = Next, Previous
Time = By default, the run time will increment/decrement by 1 minute if this parameter is not supplied. Specifying a different value will increment/decrement by that amount in minutes.


Returns

MLIrrigation_Set_Duration


Description

Increments/Decrements the time value to issue when specifying which single zone to run manually.


Notes


SetProgramZoneDuration

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetProgramZoneDuration~Irrigation_Program_Id~Irrigation_Zone_Id~Duration


(Literal)

MLServeCmd.MLIrrigation|SetProgramZoneDuration~1~2~10


Parameters

Irrigation_Program_Id = The id of the program.
Irrigation_Zone_Id = The id of the zone.
Duration = The duration in minutes the zone is to run.


Returns

Nothing.


Description

Sets the specified zone in the specified program to run for the specified duration.


Notes


SetProgramWaterDays

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetProgramWateringDays~Irrigation_Program_Id~Day~Value


(Literal)

MLServeCmd.MLIrrigation|SetProgramWateringDays~Monday~False


Parameters

Irrigation_Program_Id = The id of the program set the water days.
Day = The day to set watering on/off for.
Value = True or false


Returns

Nothing.


Description

Sets the specified watering day for the specified program to on or off.

  • Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday -- Enables/disables the specified day for watering.
  • Even -- Enables/Disables watering on even days
  • Odd -- Enables/Disables watering on odd days
  • Days -- Enables/Disables watering on an interval of days


Notes


SetProgramScheduleEnabled

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetProgramScheduleEnabled~Irrigation_Program_Id~Value


(Literal)

MLServeCmd.MLIrrigation|SetProgramScheduleEnabled~1~False


Parameters

Irrigation_Program_Id = The id of the program enable/disable the schedule for.
Value = True, False, Toggle


Returns

Nothing.


Description

Enables/Disables the schdule for the specified program.


Notes


SetProgramStartTime

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetProgramStartTime~Irrigation_Program_Id~Time_Number~Value


(Literal)

MLServeCmd.MLIrrigation|SetProgramStartTime~1~1~10:00 am


Parameters

Irrigation_Program_Id = The id of the program to set the start time for.
Time_Number = The start time to set for the program (1-8)
Value = Up,Down, or a Time.


Returns

Nothing.


Description

Sets the specified start time for the specified program.

If up/down is used for the value the Increment Value will be added/subtracted from the programs start start time.


Notes

See Also: SetIncrementValue


SetSeasonalAdjust

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetSeasonalAdjust~Percent_Value


(Literal)

MLServeCmd.MLIrrigation|SetSeasonalAdjust~50


Parameters

Percent_Value = The new seasonal adjust value. (0-100)


Returns

Nothing.


Description

Sets the seasonal adjust value.


Notes


SeasonalAdjustUp

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SeasonalAdjustUp


(Literal)

MLServeCmd.MLIrrigation|SeasonalAdjustUp


Parameters

None.


Returns

Nothing.


Description

Increments the seasonal adjust value by 1%.


Notes


SeasonalAdjustDown

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SeasonalAdjustDown


(Literal)

MLServeCmd.MLIrrigation|SeasonalAdjustDown


Parameters

None.


Returns

Nothing.


Description

Decrements the seasonal adjust value by 1%.


Notes



MLServer Variables

{{ClientName}}_mlirrigation_program_zone_{{Irrigation_Zone}}_alias

Description: The alias of the program zone.

Values: Text

{{ClientName}}_mlirrigation_program_zone_{{Irrigation_Zone}}_duration

Description: The duration in minutes the program zone is to run.

Values: Number

{{ClientName}}_mlirrigation_program_zone_{{Irrigation_Zone}}_id

Description: The id number of the program zone.

Values: Text

{{ClientName}}_mlirrigation_program_zone_page

Description: The page of the programs zones the client is currently viewing.

Values: Number

{{ClientName}}_mlirrigation_program_zone_page_count

Description: The total number of program zone pages the client is currently viewing.

Values: Number

{{ClientName}}_mlirrigation_running_program_zone_{{Irrigation_Zone}}_alias

Description: The alias of the running program zone.

Values: Text

{{ClientName}}_mlirrigation_running_program_zone_{{Irrigation_Zone}}_duration

Description: The duration in minutes of the running program zone.

Values: Number

{{ClientName}}_mlirrigation_running_program_zone_{{Irrigation_Zone}}_elapsed

Description: The total time that the zone has run in time format.

Values: Time Value

{{ClientName}}_mlirrigation_running_program_zone_{{Irrigation_Zone}}_id

Description: The id number of the running program zone.

Values: Number

{{ClientName}}_mlirrigation_running_program_zone_{{Irrigation_Zone}}_percent_done

Description: The percentage of the duration that the running programs current zone as run.

Values: Number

{{ClientName}}_mlirrigation_running_program_zone_{{Irrigation_Zone}}_percent_remaining

Description: The percentage of the running programs currently active zones duration remaining.

Values: Number

{{ClientName}}_mlirrigation_running_program_zone_{{Irrigation_Zone}}_remaining

Description: The total time remaining on the zone for the running program in time format

Values: Time Value

{{ClientName}}_mlirrigation_running_program_zone_page

Description: The page of zones from the currently running program that the client is viewing.

Values: Number

{{ClientName}}_mlirrigation_running_program_zone_page_count

Description: The total number of zone pages for the currently running program.

Values: Number

{{ClientName}}_mlirrigation_selected_program

Description: The number of the program the client currently has selected.

Values: Number

{{ClientName}}_mlirrigation_zone_item_{{Irrigation_Zone}}_alias

Description: The alias of the zone.

Values: Text

{{ClientName}}_mlirrigation_zone_item_{{Irrigation_Zone}}_id

Description: The id number of the zone.

Values: Number

{{ClientName}}_mlirrigation_zone_item_{{Irrigation_Zone}}_model

Description: The model of the zone.

Values: Text

{{ClientName}}_mlirrigation_zone_item_{{Irrigation_Zone}}_status

Description: The status of the zone.

Values: On, Off

{{ClientName}}_mlirrigation_zone_item_{{Irrigation_Zone}}_type

Description: The type of the zone.

Values: Master, Sprinkler, Sensor

{{ClientName}}_mlirrigation_zone_page

Description: The page of zones the client is currently viewing.

Values: Number

{{ClientName}}_mlirrigation_zone_page_count

Description: The total number of pages of zones.

Values: Number

mlirrigation_active_progendtime

Description: The estimated end time of the active program.

Values: Time Value

mlirrigation_active_progpercentdone

Description: The percentage of the duration done for the active program.

Values: Number

mlirrigation_active_progpercentremaining

Description: The percentage of the durtaion remaining for the active program.

Values: Number

mlirrigation_active_program

Description: The id number of the avtive program.

Values: Number

mlirrigation_active_program_alias

Description: The alias of the active program.

Values: Text

mlirrigation_active_program_remaining

Description: The total time remaining for the active program in a time format.

Values: Time value

mlirrigation_active_program_status

Description: The status of the active program.

Values: Complete, Running, Paused

mlirrigation_active_progstarttime

Description: The start time of the active program.

Values: Time value.

mlirrigation_active_progtimelapsedmin

Description: The number of minutes that have elapsed in the active program.

Values: Number

mlirrigation_active_progtimelapsedsec

Description: The number of seconds that have elapsed in the active program.

Values: Number

mlirrigation_active_progtimeremainingmin

Description: The number of minutes remaining in the active programs duration.

Values: Number

mlirrigation_active_progtimeremainingsec

Description: The number of secondes remaining in the active programs duration.

Values: Number

mlirrigation_active_zone

Description: The number of the active zone.

Values: Number

mlirrigation_active_zone_alias

Description: The alias of the active zone.

Values: Text

mlirrigation_active_zonepercentdone

Description: The percentage of the duration done for the active zone

Values: Number

mlirrigation_active_zonepercentremaining

Description: The percentage of the duration remaining for active the zone.

Values: Number

mlirrigation_active_zonetimelapsedmin

Description: The number of minutes the actice zone has been running for.

Values: Number

mlirrigation_active_zonetimelapsedsec

Description: The number of secs the active zone has been running for.

Values: Number

mlirrigation_active_zonetimeremainingmin

Description: The number of minutes remaining in the active zones duration.

Values: Number

mlirrigation_active_zonetimeremainingsec

Description: The number of seconds remaining in the active zones duration.

Values: Number

mlirrigation_controller_alias_{{Irrigation_Controller}}

Description: The alias of the controller.

Values: Text

mlirrigation_controller_model_{{Irrigation_Controller}}

Description: The model of the controller.

Values: Text

mlirrigation_controller_numberzones_{{Irrigation_Controller}}

Description: The number of zones the controller has.

Values: Number

mlirrigation_increment_value

Description: The value in minutes to be used when incrementing start times and zone durations.

Values: Number

mlirrigation_program_{{Irrigation_Program}}_alias

Description: The alias of the program.

Values: Text

mlirrigation_program_{{Irrigation_Program}}_duration

Description: The total duration in minutes the program will run.

Values: Number

mlirrigation_program_{{Irrigation_Program}}_schedule_days

Description: Tells if the program will run on an interval of days.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_enabled

Description: Tells if the programs schedule is enabled.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_even

Description: Tells if the program will run on even days.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_friday

Description: Tells if the program will run on friday.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_monday

Description: Tells if the program will run on monday.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_odd

Description: Tells if the program will run on odd days.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_saturday

Description: Tells if the program will run on saturday.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_sunday

Description: Tells if the program will run on sunday

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_thursday

Description: Tells if the program will run on thursday

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_time_{{Irrigation_Time_Number}}

Description: One of the eight start times of the program.

Values: Time value

mlirrigation_program_{{Irrigation_Program}}_schedule_time_type_{{Irrigation_Time_Number}}

Description: The programs start time type.

Values: Off, AtTime, AtSunrise, AtSunset, AfterSunrise, AfterSunset, BeforeSunrise, BeforeSunset

mlirrigation_program_{{Irrigation_Program}}_schedule_tuesday

Description: Tells if the program will run on tuesday.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_schedule_type

Description: The programs schedule type.

Values: Calendar, Odd/Even, Interval

mlirrigation_program_{{Irrigation_Program}}_schedule_wednesday

Description: Tells if the program will run on wednesday.

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_show_schedule_time_adjust_buttons_{{Irrigation_Program}}

Description: Tells if the adjust buttons should be shown for the programs schedule start time

Values: True, False

mlirrigation_program_{{Irrigation_Program}}_alias

Description: The programs alias.

Values: Text

mlirrigation_seasonal_adjust

Description: The seasonal adjustment value.

Values: Number

mlirrigation_system_mode

Description: The current system mode.

Values: Off,Schedule,Manual,All

mlirrigation_zone_status_{{Irrigation_Zone}}

Description: The status of the zone.

Values: On, Off

mlirrigation_set_duration

Description: The time in minutes that a zone will run when issuing a manual single zone command.

Values: Time in minutes