Climate Drivers

From Cinemar Wiki
Jump to: navigation, search

About

The Climate Family is used to control multiple styles of thermostats with a network or RS-232 connection.It allows for standarized MainLobby Client scene configuration that the Climate Family then routes the commands to the appropriate Thermostat. This allows for scenes to be reusable across multiple Thermostat vendors. It also allows for usage of multiple concurrant thermostat controllers.

Installation

"Climate.Type.Driver".dll

Download the driver from MLInstaller and install the driver that communicates with the type of thermostats connected to MLServer 4.

With MLServer shutdown, run the "Thermostat-Type"_Driver_exe. that coresponds to the type of thermostats you have connected. This will install Thermostat driver to the MLServer/Driver directory. It is recommended to accept all installation defaults.

Drivers avabliable for this family driver are:

RadioThermostat- CT-30, CT-80, 3M-50

(Note more Thermostats will be added)


Settings

Configuring the alias and network IP address/ Com Port for each of your thermostats is done in the Family Manager. Click on the Add button and enter in the IP address/ Com Port of your thermostat and its friendly alias.


Climate.Family.jpg


To see the event logs, settings etc, open the selected device in the Device Driver tab.


Climate.DeviceDriver.jpg

MLServeCmds

SetInterval

{MLServeCmd}Script Usage

Climate|TStat#~SetInterval~Seconds

Parameters
TStat# = The Thermostat's ID or Alias
Seconds = The desired seconds between pollings- 1..60

(Literal)
Climate|1~SetInterval~30


Description

Queries the thermostats for its current status.


HeatSetpoint

{MLServeCmd}Script Usage

Climate|TStat#~HeatSetpoint~Value

Parameters
TStat# = The Thermostat's ID or Alias
Value = The desired temp or Up, Down

(Literal)
Climate|1~HeatSetpoint~78 Climate|1~HeatSetpoint~Up Climate|1~HeatSetpoint~Down


Description

Sets the Heat Setpoint to the desired value or Up/Down by 1 degree.


CoolSetpoint

{MLServeCmd}Script Usage

Climate|TStat#~CoolSetpoint~Value

Parameters
TStat# = The Thermostat's ID or Alias
Value = The desired temp or Up, Down

(Literal)
Climate|1~CoolSetpoint~78 Climate|1~CoolSetpoint~Up Climate|1~CoolSetpoint~Down


Description

Sets the Cool Setpoint to the desired value or Up/Down by 1 degree.


Mode

{MLServeCmd}Script Usage

Climate|TStat#~Mode~Value

Parameters
TStat# = The Thermostat's ID or Alias
Value = The desired thermostat mode (Auto,Cool,Heat,Off,Emht)

(Literal)
Climate|1~Mode~Auto


Description

Sets the Thermostat's HVAC operating mode.


Fan

{MLServeCmd}Script Usage

Climate|TStat#~Fan~Value

Parameters
TStat# = The Thermostat's ID or Alias
Value = The desired thermostat fan mode (Auto,On)

(Literal)
Climate|1~Fan~Auto


Description

Sets the Thermostat's fan mode.


Hold

{MLServeCmd}Script Usage

Climate|TStat#~Hold~Value

Parameters
TStat# = The Thermostat's ID or Alias
Value = The desired hold state (Off,On)

(Literal)
Climate|1~Hold~On


Description

Sets the Thermostat's hold state.


Status

{MLServeCmd}Script Usage

Climate|TStat#~Status

Parameters
TStat# = The Thermostat's ID or Alias

(Literal)
Climate|1~Status


Description

Queries the thermostasts for its current status.


MLServer Variables

All the Server Variables for this Driver begin with the prefix Climate_TSTat#_

They will very some depending on the manufacture of the thermostat.