MLRSCThermo Plugin

From Cinemar Wiki
Jump to: navigation, search

About

The MLRCSThermo plugin supports the RCS line of RS485 thermostats.


Hardware Requirements

RCS TR-40 RS485 thermostat

RCS TR-16 RS485 thermostat

A RS485 to RS232 adapter (so the thermostat can "plug" into a PC com port)

If you are using multiple thermostats, the RCS 8 RS485 to RS232 hub is required.

Available com port on MLServer3 PC (that is not being used by any other software)

Software Requirements

MLServer3 v 3.0.104 and later

MLRCSThermo plugin

MainLobby 3 client v 3.0.84 and later

Installation

Shutdown MLServer3

Plug the RCS RS485 to RS232 hub into the MLServer3 available com port. Take note of which comport is being used.

Download and launch the MLRCSThermo_Setup.exe file.

Restart MLServer3.

Open MLServer3 plugins window and right click on MLRCSThermo and click Settings

In the Com Settings tab, set the comport that the hardware is plugged into. Click OnStart? checkbox to have the plugin connect automatically when MLServer3 starts (typical).

Click on the Device Settings and click the New button. Type a ID number (if you have one RCS thermostat, typically this is left as "1") Add an Alias name for your thermostat (like "Dining Room") and type the RCS thermostat Unit code (that you programmed into the thermostat - 1 is the default that RCS ships thermostats set with. See the RCS manual on how to set the Unit code). Click OK to add the thermostat to the MLRCSThermo database. The Alias name must be unique for all "HVAC" plugins you have installed. This includes if you are using different brand HVAC devices.

You can add additional RSC RS485 thermostats. Again, make sure the Alias name is unique.

Click the Update All button and the plugin will begin communicating to the thermostat and populate MLServer variables and the plugin table.

You can change modes at the bottom of the Device tab by selecting what you would like to set.

Make sure you have your RCS thermostat configured to "Auto Send Mode". This is an RCS setup on some thermostats that force the thermostat to send changes that are performed at the local thermostat.


How to create one MainLobby scene that can view two thermostats

Create a MLCycleStates hvac_current that is configured with these two commands

MLServeCmd.SetVariable|hvac_current_thermo~dining

MLServeCmd.SetVariable|hvac_current_thermo~masterbedroom


Each entry in the MainLobby scene would be configured like

{{hvac_{{hvac_current_thermo}}_average_temperature}}

MLServer Variables

{{hvac_001_run_time_led1}}

{{hvac_001_run_time_led2}}

{{hvac_001_run_time_led3}}

{{hvac_001_run_time_message1}}~70~20

{{hvac_001_run_time_message2}}~70~20

{{hvac_001_run_time_message3}}~70~20

{{hvac_001_USEROPERATINGMODE}} (Off, HeatOn, CoolOn, AutoChangeOver, AuxHeatOn, EconomyHeatOn, EmergencyHeatOn, AuxCoolOn, EconomyCoolOn, BuildingProtection, EnergySavingsMode are valid values.)

{{hvac_001_fan_mode}} (Mode, FanStatus, Name, Auto, ContinuousOn, PeriodicOn are valid values.)

{{hvac_001_run_time_message3}}~60~20

{{hvac_001_COOLINGSETPOINT}} C~70~30

{{hvac_001_HEATINGSETPOINT}} H~70~30

{{hvac_001_average_temperature}}~170~100

MLServer Commands

MLRCSThermo follows the new Family Manager syntax: Family.Alias|Command

Note: no MLServeCmd. is necessary.

Here is how that relates to MLRCSThermo: HVAC.aliasname|command~parameter

The plugin also supports using a variable to represent the Alias: HVAC.{AliasName}|SET_FAN_MODE_ON


Examples

HVAC.2|SET_FAN_MODE_On
HVAC.1|STATUS_REQUEST_6


The MLRCSThermo plugin natively processes command in this form

MLRCSThermo|HEATINGSETPOINT_PLUS~1


Command List

HEATINGSETPOINT

COOLINGSETPOINT

USEROPERATINGMODE_OFF

USEROPERATINGMODE_HEATON

USEROPERATINGMODE_COOLON

USEROPERATINGMODE_AUTOCHANGEOVER

USEROPERATINGMODE_ECONOMYHEATON

FANOPERATINGMODE_AUTO

FANOPERATINGMODE_CONTINUOUSON

SYSTEM_TEMPERATURE_FORMAT_F

SYSTEM_TEMPERATURE_FORMAT_C

A_ARG_TYPE_DAYOFWEEK

HEATINGSETPOINT_PLUS

HEATINGSETPOINT_MINUS

COOLINGSETPOINT_PLUS

COOLINGSETPOINT_MINUS

CURRENTSETPOINT_PLUS

CURRENTSETPOINT_MINUS

USEROPERATINGMODE_TOGGLE

FANOPERATINGMODE_TOGGLE

SEND_TEXT_MESSAGE

SEND_TEXT_MESSAGE_ERASE

SET_TIME

SET_DATE

SET_DISPLAY_LOCK_ON

SET_DISPLAY_LOCK_OFF

STATUS_REQUEST_1 (1 through 10)

SCHEDULE_RUN

SCHEDULE_HOLD

SCHEDULE_TOGGLE

SCHEDULE_STATUS

DETAILED_LOGGING_ON

DETAILED_LOGGING_OFF

SET_AUTO_SEND_MODE

SET_AUTO_SEND_MODE_STATUS

SET_OUTSIDE_TEMP~TEMP

SET_REMOTE_TEMP~TEMP

Bugs

New Feature Requests