Difference between revisions of "GSD Ruby Interface"

From LinuxMCE
Jump to: navigation, search
Line 1: Line 1:
<table width="100%"> <tr><td bgcolor="#FFCFCF">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.</td></tr> </table>Short description of exported classes and methods
+
<table width="100%"> <tr><td bgcolor="#FFCFCF">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.</td></tr> </table>Short description of available classes and methods (the list is not complete)
 
== Connection ==
 
== Connection ==
 +
The connection object, is the exported (already opened) connection to the device. It can be either Serial (or USB Serial) conection or a network connection (in this situation you need to specify host ip and port to connect).
 +
 +
It's usually accessed via '''conn_''' variable.
 +
 
=== Methods ===
 
=== Methods ===
==== Send ====
+
* '''Send (<string>)''' : will send the ''string'' to the device
==== Recv ====
+
* '''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
  
 
== Device ==
 
== Device ==
 
=== Methods ===
 
=== Methods ===
==== ?? ====
+
* A
==== ?? ====
+
* B
=== Members ===
+
==== devdata_ ====
+
==== child_ ====
+
  
 +
=== Members ===
 +
* '''devdata_''' :
 +
* '''child_''' :
  
 
== Command ==
 
== Command ==
 
=== Methods ===
 
=== Methods ===
==== ?? ====
+
* A
==== ?? ====
+
* B
 
=== Members ===
 
=== Members ===
==== params_ ====
+
* '''params_'''

Revision as of 10:43, 23 May 2006

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)

Connection

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

It's usually accessed via conn_ variable.

Methods

  • 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

Device

Methods

  • A
  • B

Members

  • devdata_ :
  • child_ :

Command

Methods

  • A
  • B

Members

  • params_