MLIrrigation Plugin

From Cinemar Wiki
Jump to: navigation, search

Welcome to the MLIrrigation PlugIn

This PlugIn allows users to control any supported irrigation system.


Requirements

Software Requirements

  • MLServer 3
  • MainLobby 3
  • Supported Hardware Driver

Supported Hardware

  • WGL & Associates Rain8Net (one to many supported - each have 8 relays)

Getting Started

Before installing anything we recommend that you setup and test your irrigation system to verify that everything is working properly.

Installation

Shut down MLServer if it is currently running. You will need to install the MLIrrigation PlugIn and the supported irrigation driver. Follow the onscreen prompts. We recommend installing to the default locations.

Accessing the MLIrrigation PlugIn

1. Start MLServer.

2. Right Click on MLIrrigation PlugIn from MLServer’s PlugIn Window and select Settings.

Adding a Controller

1. Click Add below the Controllers Table

2. An ID will be autogenerated 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 autopopulate the Zones Table. We recommend you select yes.

6. If so, specify which Zone is designated as your Master Pump Valve.

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:

A. Calendar Day – Check any day that you want the program to run

B. Interval Day – Enter the number of days in between each run of the program

C. 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

NOTE: Only one schedule is allowed per program


MLServeCmd Syntax

MLIrrigation|On

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|On~ID/Alias

(Literal)

MLServeCmd.MLIrrigation|On~1

MLServeCmd.MLIrrigation|On~Back Yard

Parameters

ID / Alias = Information configured in MLIrrigation PlugIn

Affected Variables

MLIrrigation_zone_status_ID

Description

Turns on the specified zone.

Notes

Also opens the master valve if not already open.


MLIrrigation|Off

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|On~ID/Alias

(Literal)

MLServeCmd.MLIrrigation|Off~1

MLServeCmd.MLIrrigation|Off~Back Yard

Parameters

ID / Alias = Information configured in MLIrrigation PlugIn

Affected Variables

Nothing

Description

Turns off the specified zone.

Notes

Also closes the master valve if no other zones are on


MLIrrigation|AllOff

{MLServeCmd}Script Usage

MLServeCmd.Irrigation|AllOff~ID/Alias

(Literal)

MLServeCmd.MLIrrigation|AllOff~1

MLServeCmd.MLIrrigation|AllOff~Front Controller

Parameters

ID / Alias = The ID or Alias of the controller you wish to send the command to.

Affected Variables

Nothing

Description

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

Notes


MLIrrigation|Toggle

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|Toggle~ID/Alias

(Literal)

MLServeCmd.MLIrrigation|Toggle~1

MLServeCmd.MLIrrigation|Toggle~Back Yard

Parameters

ID / Alias = The ID or Alias of the zone to toggle.

Affected Variables

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.


MLIrrigation|ManualSingleZone

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|ManualSingleZone~ID/Alias~Duration

(Literal)

MLServeCmd.MLIrrigation|ManualSingelZone~1~10

MLServeCmd.MLIrrigation|ManualSingelZone~BackYard~10

Parameters

Zone# / Alias = The ID or Alias of the zone to control.

Duration = The time in minutes the zone is to run

Affected Variables

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 them the master valve is closed.


MLIrrigation|RunProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|RunProgram~Prog# / Alias

(Literal)

MLServeCmd.MLIrrigation|RunProgram~1

MLServeCmd.MLIrrigation|RunProgram~Summer

Parameters

Prog# / Alias = The program number or alias.

Affected Variables

None

Description

Runs the specified program.

Notes


MLIrrigation|SetMode

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetMode~<<Manual / Program>>~<<*Program # / Alias>>

(Literal)

MLServeCmd.MLIrrigation|SetMode~Manual

MLServeCmd.MLIrrigation|SetMode~Program~001

MLServeCmd.MLIrrigation|SetMode~Program~1

MLServeCmd.MLIrrigation|SetMode~Program~Summer

Parameters

Affected Variables

mlirrigation_mode

Description

Sets mode of the next run command.

Notes

See also: SetZone, SetDuration


MLIrrigation|SetZone

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetZone~<<Zone # / alias / Next / Previous>>

(Literal)

MLServeCmd.MLIrrigation|SetZone~001

MLServeCmd.MLIrrigation|SetZone~1

MLServeCmd.MLIrrigation|SetZone~Frontyard

MLServeCmd.MLIrrigation|SetZone~Next

MLServeCmd.MLIrrigation|SetZone~Previous

Parameters

  1. / Alias = The number or alias of the next manual zone to run.

Next = Increments manual zone

Previous = Decrements manual zone

Affected Variables

MLIrrigation_set_zone

Description

Sets the next manual zone to run.

Notes

See also: SetMode, SetDuration


MLIrrigation|SetDuration

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|SetDuration~<<Min / Next / Previous>>

(Literal)

MLServeCmd.MLIrrigation|SetDuration~1

MLServeCmd.MLIrrigation|SetDuration~7

MLServeCmd.MLIrrigation|SetDuration~Next

MLServeCmd.MLIrrigation|SetDuration~Previous

Parameters

Min = The number of minutes to run the next manual zone.

Next = Increments the number of minutes to run manual zone.

Previous = Decrements the number of minutes to run manual zone.

Affected Variables

MLIrrigation_set_duration

Description

Sets the duration to run the next manual zone.

Notes

See also: SetMode, SetZone


MLIrrigation|Run

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|Run

(Literal)

MLServeCmd.MLIrrigation|Run

Parameters

None

Affected Variables

mlirrigation_active_program_status

mlirrigation_active_progstarttime

mlirrigation_active_progtimelapsedsec

mlirrigation_active_progtimeremainingsec

mlirrigation_active_progendtime

mlirrigation_active_zonetimelapsedsec

mlirrigation_active_zonetimeremainingmin

mlirrigation_active_zonetimeremainingsec


Description

Starts the set program or manual zone

Notes

See also: SetMode, SetZone, SetDuration


MLIrrigation|Stop

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|Stop

(Literal)

MLServeCmd.MLIrrigation|Stop

Parameters

None

Affected Variables

Nothing

Description

Stops the running program or manual zone

Notes

See also: SetMode, SetZone, SetDuration


MLIrrigation|Pause

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|Pause

(Literal)

MLServeCmd.MLIrrigation|Pause

Parameters

None

Affected Variables

None

Description

Pauses the running program or manual zone.

Notes

See also: SetMode, SetZone, SetDuration


MLIrrigation|NextZone

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|NextZone

(Literal)

MLServeCmd.MLIrrigation|NextZone

Parameters

None

Affected Variables

mlirrigation_active_zone

mlirrigation_active_zone_alias

Description

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

Notes

MLIrrigation|NextProgram

{MLServeCmd}Script Usage


MLServeCmd.MLIrrigation|NextProgram

(Literal)

MLServeCmd.MLIrrigation|NextProgram

Parameters

None

Affected Variables

mlirrigation_active_program

mlirrigation_active_program_alias

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.

Note


MLIrrigation|PreviousProgram

{MLServeCmd}Script Usage

MLServeCmd.MLIrrigation|PreviousProgram

(Literal)

MLServeCmd.MLIrrigation|PreviousProgram

Parameters

None

Affected Variables

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.

Note


MLServer Variables

The MLIrrigation PlugIn will autogenerate variables in MLServer based on the settings you haveentered. It will also update variables in certain circumstances such as running a program

Variables Set on Startup

MLIrrigation_Controller_Alias_ID

MLIrrigation_Controller_Model_ ID

MLIrrigation_Controller_NumberZones_ ID

MLIrrigation_Zone_Alias_ ID

MLIrrigation_Zone_Status_ ID

Variables Set At Other Times:

MLIrrigation_Set_Mode

MLIrrigation_Set_Zone

MLIrrigation_Set_Duration

MLIrrigation_Active_Program

MLIrrigation_Active_Program_Alias

MLIrrigation_Active_Program_Status

MLIrrigation_Active_Zone

MLIrrigation_Active_Zone _Alias

MLIrrigation_Active_ZonePercentDone

MLIrrigation_Active_ZonePercentRemaining

MLIrrigation_ProgEndTime

MLIrrigation_ProgStartTime

MLIrrigation_ProgPrecentDone

MLIrrigation_ProgPrecentRemaining

NOTE

As of 08/11/06 the following variables have been removed to improve the Timer accuracy during programs:

MLIrrigation_Active_ZoneTimeLapsedMin

MLIrrigation_Active_ZoneTimeLapsedSec

MLIrrigation_Active_ZoneTimeRemainingMin

MLIrrigation_Active_ZoneTimeRemainingSec

MLIrrigation_ProgTimeLapsedMin

MLIrrigation_ProgTimeLapsedSec_ID

MLIrrigation_ProgTimeRemainingMin_ID

MLIrrigation_ProgTimeRemainingSec_ID

Bugs

New Feature Requests