MLHAL Plugin

From Cinemar Wiki
Jump to: navigation, search

About

MLHAL plugin allows for integration between MLServer3 and HAL automation software


System Requirements

For the plug-in to work it requires HALdeluxe or above, version 3.0.9 or above. http://www.automatedliving.com/downloads_v300_us.shtml

The latest HALi, available for download from the same link as above.


New features

IR Control Added.

2-way status of 25 devices

2-way status of 25 sensors

Added the ability to monitor two thermostats

Added the ability to monitor the status of two garage doors

Added the ability to monitor the status of Automated Blinds/Drapes


Commands

SPEAK~<<Text>>

RUN_MACRO~<<Macro Name>>

SET_MODE~<<Mode Name>>

FLAG~<<Flag Name>>~TRUE|FALSE

RUN_SCENE~<<Scene Name>>

IR~<<IR Device Name>>~<<IR Device Button>>~<<Number of times to push button>> (example: IR~KITCHEN TV~POWER ON~1)

DEVICE~<<Device Name>>~ACTIVATE|DEACTIVATE|(GRADUATED~<<0 - 100>>)

GROUP~<<Group Name>>~ACTIVATE|DEACTIVATE|BRIGHTEN|LOWER

ASR~LISTEN~ON|OFF

SECURITY~ARM|DISARM|BYPASS|RESTORE~<>~<<opt: Zone>>

THERMOSTAT~SET|FAN|MODE~<<Degrees|Fan Mode|ThermMode>>~<<Zone>>

X10~<<HC and UC>>~ACTIVATE|DEACTIVATE|(GRADUATED~<<0 - 100>>)|RESET (example: X10~F04~ACTIVATE)

DIRECTX10~<<X10 addr or cmd>> (example: DIRECTX10~A05 or DIRECTX10~DON)


FOR THIS PLUGIN TO WORK PROPERLY YOU NEED HAL VERSION 3.09 or Above


Main Lobby Variable Names

Sensors - You have the option to input and track the status of 25 Sensor Objects these objects will return a State of ON or OFF.

MLVARIABLE NAMES: {{sensor1state}} - {{sensor25state}}

To utilize these 2-way states in MainLobby you can put the variable name in the label field of a Text.SingleLine, use the states option in the button property panel, or use dynamic jpg's.

Devices - You have the option to input and track the status of 25 Device Objects these objects will return a State of ON or OFF.

MLVARIABLE NAMES: {{device1state}} - {{device25state}}

To utilize these 2-way states in MainLobby you can put the riable name in the label field of a Text.SingleLine, use the states option in the button property panel, or use dynamic jpg's.

Thermostats - You have the ability to monitor the real-time status of any two compatible Thermostats. Just input the zone numbers you wish to monitor into the setup form and the program will obtain all variables.

MLVARIABLE NAMES: THERMOSTAT #1

{{currentfanmode1}} States = ON or OFF

Returns current Fan Mode Status.

{{currenttemp1}} State = XX Degrees i.e. "68"

Returns Current Home Temp.

{{currenttherm1}} State = XX Degrees

Returns Current thermostat mode set point.

{{currentthermmode1}} State = OFF, COOL, HEAT, AUTO

Returns Current Thermostat Mode.

THERMOSTAT #2

{{currentfanmode2}} States = ON or OFF

Returns current Fan Mode Status.

{{currenttemp2}} State = XX Degrees i.e. "68"

Returns Current Home Temp.

{{currenttherm2}} State = XX Degrees

Returns Current thermostat mode set point.

{{currentthermmode2}} State = OFF, COOL, HEAT, AUTO

Returns Current Thermostat Mode.

To view these 2-way states in MainLobby you put the variable name in the label field of a Text.SingleLine button.

Garage Doors - You have the option to input and track the status of two Garage Door Sensor Objects. I programmed this so that if the monitored sensor is ON the state is CLOSED if the monitored sensor is OFF the state is OPEN.

MLVARIABLE NAMES:

{{Garage1State}} Garage Door 1 Status

{{Garage2State}} Garage Door 2 Status

Blinds/Drapes - You have the option to input and track the status of one set of automated blinds/drapes or any flag you want to track the status


1. Upgrade and install latest version of Hal (V3.09)

2. Make sure that Hali is installed as well as Cinemare software Main lobby and ML Server you can find the free trial by emailing both Mario and myself. Please email both of us as this will insure a quick response and include in the subject line "free trial main lobby Hal user"

trialoffer@cinemaronline.com

jpacman@telusplanet.net

3. There is a ML Hal plug zip file that you can download on Hal site at: http://automatedliving.com/downloads_v300_us.shtml

If you can't find it email me I will send you the one I have. jamespaquin@housetalkltd.com

4. Close ML server and main lobby if they are running

5. Open the ML Hal zip file with win zip, you should see a file ML.HAL.dll

6.Extract that file to the C:\Program Files\MLServer\plugins (this is the default location).

7. Then you will have to regestar the dll file you can do this by From Windows Start menu select RUN... then enter: regsvr32 "C:\Program Files\MLServer\plugins\MLHAL.dll"

This will register the dll.

8. Start MLServer.

9. When the screen opens you should see you should see a list of plug ins near the bottom of the screen. scroll throught until you see MLHAL, highlight this plug in then click the Help button you should see something like this

SPEAK~<<Text>>

RUN_MACRO~<<Macro Name>>

SET_MODE~<<Mode Name>>

RUN_SCENE~<<Scene Name>>

DEVICE~<<Device Name>>~ACTIVATE|DEACTIVATE|(GRADUATED~<<0 - 100>>)

GROUP~<<Group Name>>~ACTIVATE|DEACTIVATE|BRIGHTEN|LOWER

ASR~LISTEN~ON|OFF

SECURITY~ARM|DISARM|BYPASS|RESTORE~<<Code>>~<<opt: Zone>>

THERMOSTAT~SET|FAN|MODE~<<Degrees|Fan Mode|ThermMode>>~<<Zone>>

X10~<<HC and UC>>~ACTIVATE|DEACTIVATE|(GRADUATED~<<0 - 100>>)|RESET (example: X10~F04~ACTIVATE)

DIRECTX10~<<X10 addr or cmd>> (example: DIRECTX10~A05 or

If you see when you pressed the help button you are well on your way.

This list of commands can then be assigned to a button in Main lobby.

To test the plug

1. make sure Hal, ML server and mainlobby are all running

2) open a scene in main lobby

3) Insert a button

4) go into edit mode

5) in the Ml serve cmd past this

MLServeCmd.MLHAL|SPEAK~congrats, you just made cinemar talk to Hal

6) press the test button and you should hear Hal talk

7) don't forget to save the scene and then every time you push the button it will have hal talk.

8)Repeat the procedure with the different commands to have Hal activate macros modes etc. for any other button you create on a page buttons.


Problems users have had and fixes

Some users have had problems related to a file called MSSTDFMT.DLL not on their computer, if its missing from your system32 directory

Do a quick google search and you can find this file (free download) copied this accross into the system32 directory and then registered it.


Close MainLobby And Hal

Must have Hal Version 3.0.0.12 (Version 3.0.9 is Broken)

Must have Hali version 1.2.0.13 installed

Remove old plugin version 1.0.0.3 from MLServer\plugins folder

Unregister mlhal.dll- Go to Start-Run and type

regsvr32 /u c:\progra~1\mlserver\plugins\mlhal.dll

Place new 2 way plugin version 2.0.0.15 in MLServer\plugins folder

Register new plugin- Go to Start-Run and type

regsvr32 c:\progra~1\mlserver\plugins\mlhal.dll


Message box pops up and says registration succeeded

To run this plugin you need the file MSSTDFMT.dll in the SYSTEM32 folder Most people dont seem to have this Do a search on Google and get this file and place in the SYSTEM32 folder

Register MSSTDFMT.dll- Go to Start-Run and type

regsvr32 c:\WINDOWS\system32\msstdfmt.dll 

Start Hal - Start MLServer - Start MainLobby

Clicking on help brings up the plugin information

If it shows info for girder the plugin is not being recognized

Clicking on settings brings up the file you list all your devices and sensors

Other problems:

The device and sensor names need to be typed EXACTLY in the plugin as they appear in HAL If an error message pops up it is usually because the names are not the same

Also after you define a device or sensor it will not come up in ML until you restart MLServer