MLRain8Net Plugin

From Cinemar Wiki
Jump to: navigation, search

MLRain8 PlugIn


Introduction

Welcome to the MLRain8 plugin. This plugin allows users to control their Rain8Net system.

Software Requirements

Getting Started

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

Installation

Shut down MLServer if it is currently running.

Double click on setup.exe after you’ve downloaded the zip file. Follow the onscreen prompts.

We recommend installing to the default locations.

Setup

1. Start MLServer.

2. Select the MLRain8 plugin from the plugin list and click settings.

3. Enter the COM port that your rain8 device is connected to.

4. Enter the number of zones you have.

5. You will see a pop up message that says that you are about to change the number of zones that are in your system just click yes for now.

6. Enter the valve that you have setup to be your master valve.

7. For the safety of your equipment we recommend that you check the master valve safety shutoff. In the event that your master valve gets left open this will shut it after two minutes to prevent damage to your equipment.

8. If you would like to connect to your rain8 device when the Main Lobby Server is started check the connect on start box.

9. Click Apply settings.

10. Click the connect button Designing Scenes in MainLobby

Setting a zone alias

1. Click Zone Aliases tab at the top

2. Select the zone that you would like to edit the alias for

3. Click Edit Alias

4. Enter the new alias in the box that pops up

5. Click OK

Adding new program

1. Click Programs tab 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

MLRain8|On
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|On~Zone# / Alias
(Literal)
MLServeCmd.MLRain8|On~1
MLServeCmd.MLRain8|On~Back Yard
Parameters
Zone# / Alias = Information configured in MLRain8 plugin
Returns
MLRain8_zonestatus_Zone#
Description
Turns on the specified zone.
Notes
Also opens the master valve if not already open.
MLRain8|Off
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|On~Zone# / Alias
(Literal)
MLServeCmd.MLRain8|Off~1
MLServeCmd.MLRain8|Off~Back Yard
Parameters
Zone# / Alias = Information configured in MLRain8 plugin
Returns
MLRain8_zonestatus_Zone#
Description
Turns off the specified zone.
Notes
Also closes the master valve if no other zones are on
MLRain8|AllOff
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|AllOff
(Literal)
MLServeCmd.MLRain8|AllOff
Parameters
MLRain8_zonestatus_Zone#
Returns
Nothing
Description
Turns off all zones including the master valve
Notes
MLRain8|Toggle
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|Toggle~Zone# / Alias
(Literal)
MLServeCmd.MLRain8|Toggle~1
MLServeCmd.MLRain8|Toggle~Back Yard
Parameters
Zone# / Alias = Information set in MLRain8 plugin
Returns
MLRain8_zonestatus_Zone#
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.
MLRain8|ManualSingleZone
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|ManualSingleZone ~ Zone# / Alias ~ Duration
(Literal)
MLServeCmd.MLRain8|ManualSingelZone~1~10
MLServeCmd.MLRain8|ManualSingelZone~BackYard~10
Parameters
Zone# / Alias = Information set in MLRain8 plugin
Duration = The time in minutes the zone is to run
Returns
MLRain8_zonestatus_Zone#
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.
MLRain8|RunProgram
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|RunProgram ~ Prog# / Alias
(Literal)
MLServeCmd.MLRain8|RunProgram ~ 1
MLServeCmd.MLRain8|RunProgram ~ Summer
Parameters
Prog# / Alias = Information set in MLRain8 plugin
Returns
MLRain8_RunningProgram
MLRain8_RunningProgram_Alias
MLRain8_Program_#_Status
MLRain8_Active_Zone
MLRain8_Active_Zone_Alias
MLRain8_Active_ZonePercentDone
MLRain8_Active_ZonePercentRemaining
MLRain8_Active_ZoneTimeLapsedMin
MLRain8_Active_ZoneTimeLapsedSec
MLRain8_Active_ZoneTimeRemainingMin
MLRain8_Active_ZoneTimeRemainingSec
MLRain8_ProgEndTime_#
MLRain8_ProgStartTime_#
MLRain8_ProgPrecentDone_#
MLRain8_ProgPrecentRemaining_#
MLRain8_ProgTimeLapsedMin_#
MLRain8_ProgTimeLapsedSec_#
MLRain8 PlugIn
MLRain8_ProgTimeRemainingMin_#
MLRain8_ProgTimeRemainingSec_#
Description
Runs the specified program
Notes
MLRain8|AbortProgram
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|AbortProgram
(Literal)
MLServeCmd.MLRain8|AbortProgram
Parameters
None
Returns
Nothing
Description
Aborts the running program
Notes
MLRain8|PauseProgram
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|PauseProgram
(Literal)
MLServeCmd.MLRain8|PauseProgram
Parameters
None
Returns
MLRain8_program_#_Status
Description
Pauses the running program
Notes
MLRain8|SkipZone
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|SkipZone
(Literal)
MLServeCmd.MLRain8|SkipZone
Parameters
None
Returns
Nothing
Description
Skips the currently active zone in the currently running program
Notes
MLRain8|NextProgram
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|NextProgram
(Literal)
MLServeCmd.MLRain8| NextProgram
Parameters
None
Returns
Nothing
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
MLRain8|PreviousProgram
{MLServeCmd}Script Usage
MLServeCmd.MLRain8|PreviousProgram
MLServeCmd.MLRain8|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.
Note
MLServerVariables
The MLRain8 plugin will auto generate variables in MLServer based on the settings you have entered. It will also update variables in certain circumstances such as running a program Variables Set on Startup:
MLRain8_DevicePresent
MLRain8_Zone_Alias_#
MLRain8_Zone_Status_#
MLRain8_Program_#_Alias
Variables Set At Other Times:
MLRain8_RunningProgram
MLRain8_RunningProgram_Alias
MLRain8_Program_#_Status
MLRain8_Active_Zone
MLRain8_Active_Zone _Alias
MLRain8_Active_ZonePercentDone
MLRain8_Active_ZonePercentRemaining
MLRain8_Active_ZoneTimeLapsedMin
MLRain8_Active_ZoneTimeLapsedSec
MLRain8_Active_ZoneTimeRemainingMin
MLRain8_Active_ZoneTimeRemainingSec
MLRain8_ProgEndTime_#
MLRain8_ProgStartTime_#
MLRain8_ProgPrecentDone_#
MLRain8_ProgPrecentRemaining_#
MLRain8_ProgTimeLapsedMin_#
MLRain8_ProgTimeLapsedSec_#
MLRain8_ProgTimeRemainingMin_#
MLRain8_ProgTimeRemainingSec_#