MLGC100 Plugin

From Cinemar Wiki
Jump to: navigation, search

About

Global Cache's IP-enabled products are compatible with Cinemar's MLGC100 Plugin. Their product offering includes sending IR and serial commands, IR learning, IR receivers, power sensors, specialized convesion cables and more. Their comprehensive line-up of enabling products allows integrators and installers to simply and cost effectively connect diverse systems, such as home entertainment, security, lighting, irrigation, and more, to any PC and the Internet.

The MLGC100 Plugin supports the following products from Global Cache:

  • GC-100-06
  • GC-100-12
  • GC-100-18
  • GC-IRL
  • GC-SV1 Video Out Sensor
  • GC-SP1 AC/DC Voltage Sensor
  • GC-SC1 Contact Closure Sensor



Installation

Downloading the Plugin

  1. From MLServer, select Help
  2. Select Additional Software Downloads
    Mlgc100 help additional software.jpg


  3. From the Additional Software Downloads window, check the box next to MLGC100 located in the Drivers section
    Mlgc100 additional software.jpg]


  4. Press Download File(s)
  5. Press OK when the file has completely downloaded
  6. Close MLServer by selecting from the main menu SERVER then EXIT
    Locate MLServer's Downloaded Files folder
  7. Right click on Windows Start
  8. Select Explore
  9. In your Address Bar, type: C:\Program Files\MLServer\Downloaded Files



Installing the Plugin

  1. Double Click on MLC100_Plugin_Setup.exe
  2. Press Next >
    Mlgc100 install01.jpg


  3. Select the radio button next to I accept the agreement
    Mlgc100 install02.jpg


  4. Press Next > again to install to the default location: C:\Program Files\MLServer
    Mlgc100 install03.jpg


  5. Select Next > to opt to install both the MLGC100 Plug-In and the MLGC100 Database
    Mlgc100 install04.jpg


  6. Press Install
    Mlgc100 install05.jpg


  7. Press Finish to exit the Installation Wizard
    Mlgc100 install06.jpg


  8. Now startup MLServer




Configuration

Events Tab

The Events Tab is composed of two main windows necessary for troubleshooting and to verify successful communication with your Global Cache device:

  • Command Que
  • Event Log

The Command Que will visually show you commands as they come into our software. Commands happen fast, so you typically won't see anything in this window.

The Event Log is more critical for debugging. From this window, you'll see all communication to your Global Cache device(s). You will also be notified of any errors should they occur. You have the option to view the log by selecting Start Logging. In addition, you can also store your Log to a file, which in some cases may be helpful for Cinemar if we need to assist you in debugging. The Log file is stored in your MLServer Logs folder.

Mlgc100 events.jpg


Database Tab

Adding a New Controller

On intial install of the MLGC100 Plugin, it is already configured with your GC-100 device based on the IP Address they ship the unit. No changes are necessary to the IP Address unless you physically change the Global Cache unit via their web interface. Sample devices are already added to the base GC-100 Controller - these can be Deleted by right-clicking on them and selecting Delete.

If your setup consists of more than one Global Cache device you can add more Controllers.


Mlgc100 database tab.jpg


To add additional controllers:

  1. Right click on the text GC-100 in the Command Database Window
  2. Select New Controller
  3. Enter a name in the Name field
  4. Enter the IP Address of your connected Global Cache
  5. Enter any Notes
  6. Press Save at the bottom of the window

You have now successfully added a second controller. Repeat the above steps for additional controllers.


Adding a New Device

To add a new device:

  1. Right-click on the Controller you wish to add a Device to
  2. Select New Device
  3. Enter an alias Name in the Name field. This will be used later from the user interface. We recommend a short name without spaces or specialty characters.
  4. Enter a brief description for your device. ie: Bedroom Cable Box
  5. Enter the appropriate Module Number (See Diagram Below)
  6. In most cases, the IR Repeat Count should be set to 3
  7. Enter the Port Number (See Diagram Below)


Mlgc100 gc100-12 diagram.jpg


Adding a New IR or Serial Command

To add a new command:

  1. Right-click on the Device you wish to add the command to
  2. Select New Command
  3. Type in the Name of the Command in the Name field
  4. Paste your IR Codes into the Data field or press Learn if you have the optional GC-IRL connected
  5. Now select ASCII or HEX
  6. Finally press Save




Testing Commands

It is recommended that you test your IR/Serial Commands from the Plugin before executing the commands from MLServer or MainLobby. This will eliminate the possibility of spelling errors, connection problems or incorrect syntax.

To test your IR or Serial Command:

  1. Right-click on the command from the Command Database window
  2. Select Test IR Command or Test Serial Command. Which one you select depends on how the device is connected and configured.

If your device is connected, verify to see the command was successful.


Here are some common problems for the command not getting through properly:

  • Incorrect IR command
  • Incorrect Serial command
  • Global Cache not connected or configured properly
  • Check to make sure the IR port you specified blinks when sending the command
  • Incorrect Module#, Port#
  • IR Repeat Count set too low (Try 3, 4, 5 or 6)




Exporting a Device

You have the option to export your device to a file. This file can then be moved to another system or shared with other users.

To export your device to a file:

  1. Right-click on the Device name in the Command Database window
  2. Select Export Device
  3. Specify in the pop-up window the file name and location where you want to store the exported device. Store this in a location you will remember.
  4. Finally press Save to complete the process




Importing a Device

The MLGC100 Plugin will allow you to import devices that were originally created and exported with the Plugin and in the (.dev) format.

To import a device:

  1. Right-click on the Controller name in the Command Database window. This device will be added to only that Controller if you have multiple Controllers.
  2. Browse to the location of the (.dev) file stored on your hard drive
  3. Press Open

Your device and all commands are now available within the Command Database window.


Deleting a Controller, Device or Command

To delete Controller, Device or Command:

  1. Right-click on the item in the Command Database window you want to Delete
  2. Select Delete
  3. A window will pop-up at which time you can press OK to confirm that you want to delete the item




Macros Tab

Often times, you'll need to send multiple IR or Serial commands accompanied with pauses or delays between the commands. Other examples of why you might want to build a macro are:

  • Power On All Equipment
  • Power Off All Equipment
  • Sending Channel Favorites that require multiple channels
  • Automating Lighting


Note: You should have already created your devices from the Database Tab before diving into Macros.


Upon install, the MLGC100 Plugin already contains two sample Macros:

  • PlayDVDp1
  • PlayDVDp2


Mlgc100 macros tab.jpg


Click the "+" next to the text Macros in the Macro Database window to expand the list of macros. To view the Steps for each macro, simply left-click on them with your mouse. The Steps will then be displayed in the Steps window on the right.


Creating a Macro

To create your own Macro:

  1. Right-click on Macros in the Macro Database window
  2. Select New Macro
  3. Your mouse cursor will move to the Name field on the right - enter a Name for your Macro.
  4. Now we just need to build the Steps we would like to see happen in sequential order from top to bottom. See the Supported Commands section for a complete details on building commands. For now, paste the following into the Steps window:
    SendIR~DVD~Enter
    Delay~1
    SendIR~DVD~Play
    Delay~5
    SendIR~DVD~Display
    • Each new command starts on a new line
    • It is not necessary to include MLServeCmd.MLGC100| in the beginning of your commands as shown in the (Literal) section of the Supported Commands. This is inferred.
  5. Finally press Save


You've now successfully created a macro that will appear on the left in the Macro Database window.


Exporting a Macro

You have the option to export your macro to a file (.mac). This file can then be moved to another system or shared with other users.

To export your macro to a file:

  1. Right-click on the Macro name in the Macro Database window
  2. Select Export Macro
  3. Specify in the pop-up window the file name and location where you want to store the exported macro. Store this in a location you will remember.
  4. Finally press Save to complete the process




Importing a Macro

The MLGC100 Plugin will allow you to import macros that were originally created and exported with this Plugin and in the (.mac) format.

To import a macro:

  1. Right-click on the text Macros in the Macro Database window.
  2. Browse to the location of the macro (.mac) file stored on your hard drive
  3. Press Open

That macro and is now available within the Macro Database window.


IR Learning Tab

By adding the GC-IRL device, you can learn in IR codes from any remote control.

Mlgc100 irlearning tab.jpg


To configure the GC-IRL hardware:

  1. Make sure the GC-IRL is physically connected to the PC running MLServer and the MLGC100 Plugin
  2. Configure the COMM Port
  3. Set the Baud Rate to 9600
  4. Set the Bits to 8
  5. Set the Parity to N
  6. Set the Stop Bits to 1
  7. Set the End Timeout to 20 mSecs
  8. Finally select Connect
    • When Connected, the ACT light on the GC-IRL will be lit up. If the light is not lit up, double-check your settings and try connecting again. Also, be sure the GC-IRL is firmly connected to your COMM Port.


To learn in your remote control IR code:

  1. Point your remote control towards the GC-IRL light labeled IR IN at a distance of about six to twelve inches away
  2. Press the button you would like to learn on your Remote while keeping it poined at the IR IN on the GC-IRL
  3. The ACT light will blink and you should see the GC-IRL and GC100 Command Format fields populated under the Learning Events section

NOTE: Hit the button very quickly. If you hold the button down too long the IR string will be too long. Then when you go to test the IR command you will notice that the GC100 IR port light will not light up.

    • You have now successfully learned in your IR code - but we need to transfer this code to a command in your device
  1. Right-Click anywhere within the GC100 Command Format field and click on Select All
  2. Once hilighted, right-click again and select Copy
  3. Click on the Database Tab
  4. From the Command Database section, select the Device and then the Command you wish to paste the IR code into or create one
  5. Right-click in the Data field under Command Detail and select Paste
  6. Select the Hex Radio Button
  7. Press Save
    • Finally - test your command by right-clicking the Command name in the Command Database section and select Test IR Command

NOTE: You can also learn IR codes by using GC-IRE adapter and GC-CXG and then plug that into a Xantech IR hub on one of the emitter ports and use the IR receiver that is plugged into IR hub. Also the GC-IRE can be plugged directly into one of the serial ports of the GC100. You will need however Lantronix Redirector software (free) to have it assign a COM port on your computer to one of the serial ports.

NOTE: If you are having problems with MLGC100 plugin not recording IR commands that you send. You can use the GC-IRL IR learner Utility that comes with GC100 and learn each command that way. You will have to change to CCF Output, then copy the HEX code, and paste into the data window of the IR command.


Sensors & Relays Tab

Mlgc100 sensorsandrelays tab.jpg

Supported Commands

Delay

{MLServeCmd}Script Usage

MLServeCmd.MLGC100|Delay~seconds


(Literal)

MLServeCmd.MLGC100|Delay~4

MLServeCmd.MLGC100|SendIR~TV~PowerOn:Delay~1:SendIR~TV~Input1:SendIR~DVD~Play


Parameters
seconds = Number of seconds to pause


Description

Typically used in between sending IR Commands. Most devices require a .15 second delay when sending multiple IR commands to the same device.


DoMacro

{MLServeCmd}Script Usage

MLServeCmd.MLGC100|DoMacro~macro name


(Literal)

MLServeCmd.MLGC100|DoMacro~PowerOnAllEquipment

MLServeCmd.MLGC100|DoMacro~Play DVD


Parameters
macro name = The exact name of the macro you've created and specified within the Macros Tab


Description

Macros created within the MLGC100 plugin can be executing using the DoMacro command. These are different from the Macros created within MLServer itself. Macros are several commands that can be executed one after another.


GetState

{MLServeCmd}Script Usage

MLServeCmd.MLGC100|GetState~name


(Literal)

MLServeCmd.MLGC100|GetState~Fireplace


Parameters
name = The exact Relay or Sensor name you've created and specified within the Sensors & Relays Tab


Description

Requests the state of the Sensor or Relay based upon the name. A variable is created with the results based upon the MLServer Var field found under the Sensors & Relays Tab.


Relay

{MLServeCmd}Script Usage

MLServeCmd.MLGC100|Relay~relay name~command


(Literal)

MLServeCmd.MLGC100|Relay~Relay1~Open

MLServeCmd.MLGC100|Relay~Relay1~Close

MLServeCmd.MLGC100|Relay~Relay1~Toggle


Parameters
relay name = The exact relay name you've created and specified within the Sensors & Relays Tab
command = (Open, Close, Toggle)


Description

Opens or Closes a Relay that has already been created within the MLGC100 Plugin.


SendIO

{MLServeCmd}Script Usage

MLServeCmd.MLGC100|SendIO~device name~command


(Literal)

MLServeCmd.MLGC100|SendIO~DVD~PowerOn


Parameters
device name = The exact device name you've created and specified within the Database Tab
command = The exact command name for the device as assigned within the Database Tab


Description

Sends a serial command to a device that has already been created within the MLGC100 Plugin.


SendIR

{MLServeCmd}Script Usage

MLServeCmd.MLGC100|SendIR~device name~command


(Literal)

MLServeCmd.MLGC100|SendIR~DVD~PowerOn


Parameters
device name = The exact device name you've created and specified within the Database Tab
command = The exact command name for the device as assigned within the Database Tab


Description

Sends an IR command to a device that has already been created within the MLGC100 Plugin.


MLServer Variables

The only variables created by the MLGC100 Plugin are related to your Sensors & Relays. Each Sensor and Relay has a field labeled MLServer Var. Default variable names exist but they can be changed. For example, if you specify your MLServer Var as BedRoomFireplace - once a GetState or Relay command is sent, the variable for that Sensor or Relay will be created in MLServer's Variables window.


Workshops

Importing Pronto IR Codes