MLPoolNSpa

From Cinemar Wiki
Jump to: navigation, search
  • MLServer 3
  • MainLobby 3
  • Hardware specific driver


Supported Hardware

  • Pentair


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 pool and spa controller model from the drop down.
  4. Next, select your device in the devices table and press EDIT.
  5. Specify your Com Port then press Connect.
  6. Also, check Connect on Start?

MLServeCmd

Reset

{MLServeCmd}Script Usage

MLPoolNSpa|Device~Reset


(Literal)

MLPoolNSpa|1~Reset


Parameters

Device = The id of the device to reset.


Description

Resets the specified device.


GetStatus

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetStatus


(Literal)

MLPoolNSpa|1~GetStatus


Parameters

Device = The id of the device to control.


Description

Gets the current status of the device.


Spa

{MLServeCmd}Script Usage

MLPoolNSpa|Irrigation_Controller_Id~Spa~Mode


(Literal)

MLPoolNSpa|1~Spa~On


Parameters

Device = The id of the device to send the command to.
Mode = One of (On, Off or Toggle)


Description

Controls the state of the Spa.


Pump

{MLServeCmd}Script Usage

MLPoolNSpa|Device~Pump~Mode


(Literal)

MLPoolNSpa|1~Pump~On


Parameters

Device = The id of the device to send the command to.
Mode = One of (On, Off or Toggle)


Description

Controls the state of the Pump.


Aux

{MLServeCmd}Script Usage

MLPoolNSpa|Device~Aux~DevNum~Mode


(Literal)

MLPoolNSpa|1~Aux~5~On


Parameters

Device = The id of the device to send the command to.
DevNum = The Aux Device to control
Mode = One of (On, Off, Toggle, Dim or Bright)


Description

Controls the state of the Aux device.


Cleaner

{MLServeCmd}Script Usage

MLPoolNSpa|Device~Cleaner~Mode


(Literal)

MLPoolNSpa|1~Cleaner~Toggle


Parameters

Device = The id of the device to send the command to.
Mode = One of (On, Off or Toggle)


Description

Controls the state of the Cleaner.


Spillway

{MLServeCmd}Script Usage

MLPoolNSpa|Device~Spillway~Mode


(Literal)

MLPoolNSpa|1~Spillway~Toggle


Parameters

Device = The id of the device to send the command to.
Mode = One of (On, Off, Toggle)


Description

Controls the state of the Spillway.


PoolSetPoint

{MLServeCmd}Script Usage

MLPoolNSpa|Device~PoolSetPoint~Temp


(Literal)

MLPoolNSpa|1~PoolSetPoint~85


Parameters

Device = The id of the device to send the command to.
Temp = A valid temperature or Inc, Dec


Description

Controls the Pool Set Point


SpaSetPoint

{MLServeCmd}Script Usage

MLPoolNSpa|Device~SpaSetPoint~Temp


(Literal)

MLPoolNSpa|1~SpaSetPoint~85


Parameters

Device = The id of the device to send the command to.
Temp = A valid temperature or Inc, Dec


Description

Controls the Spa Set Point


PoolHeater

{MLServeCmd}Script Usage

MLPoolNSpa|Device~PoolHeater~Mode


(Literal)

MLPoolNSpa|1~PoolHeater~On


Parameters

Device = The id of the device to send the command to.
Mode = On of (On or Off)


Description

Controls the Pool Heater


HighPoolHeater

{MLServeCmd}Script Usage

MLPoolNSpa|Device~HighPoolHeater~Mode


(Literal)

MLPoolNSpa|1~HighPoolHeater~On


Parameters

Device = The id of the device to send the command to.
Mode = On of (On or Off)


Description

Controls the High Pool Heater


SpaHeater

{MLServeCmd}Script Usage

MLPoolNSpa|Device~SpaHeater~Mode


(Literal)

MLPoolNSpa|1~SpaHeater~On


Parameters

Device = The id of the device to send the command to.
Mode = On of (On or Off)


Description

Controls the Spa Heater


PoolSolar

{MLServeCmd}Script Usage

MLPoolNSpa|Device~PoolSolar~Mode


(Literal)

MLPoolNSpa|1~PoolSolar~On


Parameters

Device = The id of the device to send the command to.
Mode = On of (On or Off)


Description

Controls the Pool Solar Heater


SpaSolar

{MLServeCmd}Script Usage

MLPoolNSpa|Device~SpaSolar~Mode


(Literal)

MLPoolNSpa|1~SpaSolar~On


Parameters

Device = The id of the device to send the command to.
Mode = On of (On or Off)


Description

Controls the Spa Solar Heater


PreferPoolSolar

{MLServeCmd}Script Usage

MLPoolNSpa|Device~PreferPoolSolar~Mode


(Literal)

MLPoolNSpa|1~PreferPoolSolar~On


Parameters

Device = The id of the device to send the command to.
Mode = On of (On or Off)


Description

Controls the Prefer Pool Solar


PreferSpaSolar

{MLServeCmd}Script Usage

MLPoolNSpa|Device~PreferSpaSolar~Mode


(Literal)

MLPoolNSpa|1~PreferSpaSolar~On


Parameters

Device = The id of the device to send the command to.
Mode = On of (On or Off)


Description

Controls the Prefer Spa Solar


AllLights

{MLServeCmd}Script Usage

MLPoolNSpa|Device~AllLights~Mode


(Literal)

MLPoolNSpa|1~AllLights~On


Parameters

Device = The id of the device to send the command to.
Mode = On of (On or Off)


Description

Controls the state of all lights


SetColorSwim

{MLServeCmd}Script Usage

MLPoolNSpa|Device~SetColorSwim


(Literal)

MLPoolNSpa|1~SetColorSwim


Parameters

Device = The id of the device to send the command to.


Description

Controls the state of ColorSwim


SetColorSet

{MLServeCmd}Script Usage

MLPoolNSpa|Device~SetColorSet


(Literal)

MLPoolNSpa|1~SetColorSet


Parameters

Device = The id of the device to send the command to.


Description

Controls the state of ColorSet


SetColorSync

{MLServeCmd}Script Usage

MLPoolNSpa|Device~SetColorSync


(Literal)

MLPoolNSpa|1~SetColorSync


Parameters

Device = The id of the device to send the command to.


Description

Controls the state of ColorSync


GetPoolTemp

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetPoolTemp


(Literal)

MLPoolNSpa|1~GetPoolTemp


Parameters

Device = The id of the device to send the command to.


Description

Controls the Pool temp


GetSpaTemp

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetSpaTemp


(Literal)

MLPoolNSpa|1~GetSpaTemp


Parameters

Device = The id of the device to send the command to.


Description

Gets the Spa temp


GetAirTemp

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetAirTemp


(Literal)

MLPoolNSpa|1~GetAirTemp


Parameters

Device = The id of the device to send the command to.


Description

Gets the Air temp


GetOpMode

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetOpMode


(Literal)

MLPoolNSpa|1~GetOpMode


Parameters

Device = The id of the device to send the command to.


Description

Gets the Op mode


GetUnits

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetUnits


(Literal)

MLPoolNSpa|1~GetUnits


Parameters

Device = The id of the device to send the command to.


Description

Gets the current Units mode


GetModel

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetModel


(Literal)

MLPoolNSpa|1~GetModel


Parameters

Device = The id of the device to send the command to.


Description

Gets the current Model name


GetPumpStatus

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetPumpStatus


(Literal)

MLPoolNSpa|1~GetPumpStatus


Parameters

Device = The id of the device to send the command to.


Description

Gets the current Pump Status


GetPumpSpeed

{MLServeCmd}Script Usage

MLPoolNSpa|Device~GetPumpSpeed


(Literal)

MLPoolNSpa|1~GetPumpSpeed


Parameters

Device = The id of the device to send the command to.


Description

Gets the current Pump Speed


MLServer Variables