GSD Ruby Interface

From LinuxMCE
Revision as of 15:03, 10 December 2006 by Wikiadmin (Talk | contribs) (spelling corrections)

Jump to: navigation, search
This page was written by Pluto and imported with their permission when LinuxMCE branched off in February, 2007. In general any information should apply to LinuxMCE. However, this page should be edited to reflect changes to LinuxMCE and remove old references to Pluto.

Short description of available classes and methods. the list is not complete, but covers most of functionality.


The connection object, is the exported (already opened) connection to the device. It can be either Serial (or USB Serial) connection or a network connection (in this situation you need to specify host IP and port to connect).

It's usually accessed via conn_ variable.


  • Send (<string>) : will send the string to the device
  • Recv (<count>, <timeout>) : will put return received data (either the count was reached, or the timeout)
  • RecvDelimited(<delimiter>, <timeout>) : will return received data until the delimiter was found
  • Reconnect() : will close and then reopen the connection to the device
  • Close() : will close the connection


This class is the equivalent of DCECommandImpl, is the one which implements commands and most of the time your code will run in this context


  • SendCommand (<command>) : send a command (kind of DCEmessage, may be command or event)


  • parent_ : parent device
  • device_ : access to the device itself
  • children_ : list of children


The wrapper for DCEDevice, will have all devicedata and other stuff


  • devid_ : Device ID
  • devtemplid_ : Device Template ID
  • devdata_ : a map <int, string> with device data
  • parent_ : parent device
  • childdevices_ : a map <int, RubyDeviceWrapper> of child devices.


A wrapper over DCEMessage, not quite right called Command, because we can use it for both commands and events.


  • devidfrom_ : device id of sender
  • devidto_ : device id of receiver
  • priority_ : message priority
  • type_ : message type (1 = command, 2 = event)
  • id_ : message ID (commandID or eventID)
  • params_ : map <int, string> whith parameters

Usage samples

To send a command

cmd =, devidto, priority, type, id);
cmd.params_[x] = y;

To receive some data of unknown length

    if(buff.length() == 0)
    recv = recv + buff

To process command for child device

dev_slot = device_.childdevices_[cmd.devidto_].devdata_[12]
case cmd.id_
    #power on
    when 192 then
        conn_.Send("ON "+dev_slot+"\r");
    #power off
    when 193 then
        conn_.Send("OFF "+dev_slot+"\r");