GSD Ruby Interface - Revision history

Coley: Undo revision 28678 by AHagerty93 (talk) spam

2011-09-27T13:49:18Z

Undo revision 28678 by AHagerty93 (talk) spam

←Older revision		Revision as of 13:49, 27 September 2011
Line 8:		Line 8:
	Short description of available classes and methods. the list is not complete, but covers most of functionality.		Short description of available classes and methods. the list is not complete, but covers most of functionality.
	== RubySerialIOConnectionWrapper ==		== RubySerialIOConnectionWrapper ==
	The connection object, is the exported (already <span class="plainlinks">[http://www.thepiggybackrider.com/ <span style="color:black;font-weight:normal; text-decoration:none!important; background:none!important; text-decoration:none;/CITATION/">child carrier</span>]</span> 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).		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.		It's usually accessed via '''conn_''' variable.
	=== Methods ===		=== Methods ===
	* '''Send (~~<~~string>)''' : will send the ''string'' to the device		* '''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)		* '''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		* '''RecvDelimited(<delimiter>, <timeout>)''' : will return received data until the delimiter was found
	* '''Reconnect()''' : will close and then reopen the connection to the device		* '''Reconnect()''' : will close and then reopen the connection to the device
	* '''Close()''' : will close the connection		* '''Close()''' : will close the connection
Line 21:		Line 21:
	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		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
	=== Methods ===		=== Methods ===
	* '''SendCommand (~~<~~command>)''' : send a command (kind of DCEmessage, may be command or event)		* '''SendCommand (<command>)''' : send a command (kind of DCEmessage, may be command or event)
	* '''SendReceiveCommand (~~<~~command>)''' : send a command, like SendCommand, but also receives the response, that is any parameter that returns a value		* '''SendReceiveCommand (<command>)''' : send a command, like SendCommand, but also receives the response, that is any parameter that returns a value

	=== Members ===		=== Members ===
Line 34:		Line 34:
	* '''devid_''' : Device ID		* '''devid_''' : Device ID
	* '''devtemplid_''' : Device Template ID		* '''devtemplid_''' : Device Template ID
	* '''devdata_''' : a map ~~<~~int, string> with device data		* '''devdata_''' : a map <int, string> with device data
	* '''parent_''' : parent device		* '''parent_''' : parent device
	* '''childdevices_''' : a map ~~<~~int, RubyDeviceWrapper> of child devices.		* '''childdevices_''' : a map <int, RubyDeviceWrapper> of child devices.

	== RubyCommandWrapper ==		== RubyCommandWrapper ==
Line 47:		Line 47:
	* '''type_''' : message type (1 = command, 2 = event)		* '''type_''' : message type (1 = command, 2 = event)
	* '''id_''' : message ID (commandID or eventID)		* '''id_''' : message ID (commandID or eventID)
	* '''params_''' : map ~~<~~int, string> whith parameters		* '''params_''' : map <int, string> whith parameters

	== Usage samples ==		== Usage samples ==

AHagerty93: None

2011-09-27T08:09:47Z

None

Sambuca: /* Usage samples */

2010-05-18T19:16:05Z

Usage samples

←Older revision		Revision as of 19:16, 18 May 2010
Line 55:		Line 55:
	cmd.params_[x] = y;		cmd.params_[x] = y;
	SendCommand(cmd);		SendCommand(cmd);

			To send a command which returns parameters
			cmd = Command.new(devidfrom, devidto, priority, type, id);
			cmd.params_[x] = y;
			SendReceiveCommand(cmd);
			myVar = cmd.params_[z]

	To receive some data of unknown length		To receive some data of unknown length

Sambuca: /* Methods */

2010-05-18T19:11:52Z

Methods

←Older revision		Revision as of 19:11, 18 May 2010
Line 1:		Line 1:
	{\| align="right"		{\| align="right"
	\| __TOC__		\| __TOC__
	\|}		\|}
Line 21:		Line 21:
	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		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
	=== Methods ===		=== Methods ===
	* '''SendCommand (<command>)''' : send a command (kind of DCEmessage, may be command or event)		* '''SendCommand (<command>)''' : send a command (kind of DCEmessage, may be command or event)
			* '''SendReceiveCommand (<command>)''' : send a command, like SendCommand, but also receives the response, that is any parameter that returns a value

	=== Members ===		=== Members ===
	* '''parent_''' : parent device		* '''parent_''' : parent device

Rwilson131 at 04:51, 29 October 2007

2007-10-29T04:51:01Z

←Older revision		Revision as of 04:51, 29 October 2007
Line 1:		Line 1:
			{\| align="right"
			\| __TOC__
			\|}
	[[Category: Programmer's Guide]]		[[Category: Programmer's Guide]]
	[[Category: Serial]]		[[Category: Serial]]

Zaerc: moved categories

2007-10-05T12:26:12Z

moved categories

@@ Line 1: / Line 1: @@
 Short description of available classes and methods. the list is not complete, but covers most of functionality.
 == RubySerialIOConnectionWrapper ==
@@ Line 67: / Line 71: @@
           conn_.Send("OFF "+dev_slot+"\r");
   end

Rwilson131 at 19:02, 25 August 2007

2007-08-25T19:02:59Z

←Older revision		Revision as of 19:02, 25 August 2007
Line 1:		Line 1:
	~~[[Category:GSD]]~~
	Short description of available classes and methods. the list is not complete, but covers most of functionality.		Short description of available classes and methods. the list is not complete, but covers most of functionality.
	== RubySerialIOConnectionWrapper ==		== RubySerialIOConnectionWrapper ==
Line 68:		Line 67:
	conn_.Send("OFF "+dev_slot+"\r");		conn_.Send("OFF "+dev_slot+"\r");
	end		end
			[[Category:GSD]]
			[[Category:Programmer's Guide]]

Trout at 18:30, 21 August 2007

2007-08-21T18:30:44Z

←Older revision		Revision as of 18:30, 21 August 2007
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>[[Category:GSD]]		[[Category:GSD]]
	Short description of available classes and methods. the list is not complete, but covers most of functionality.		Short description of available classes and methods. the list is not complete, but covers most of functionality.
	== RubySerialIOConnectionWrapper ==		== RubySerialIOConnectionWrapper ==

Wikiadmin: spelling corrections

2006-12-10T15:03:17Z

spelling corrections

←Older revision		Revision as of 15:03, 10 December 2006
Line 2:		Line 2:
	Short description of available classes and methods. the list is not complete, but covers most of functionality.		Short description of available classes and methods. the list is not complete, but covers most of functionality.
	== RubySerialIOConnectionWrapper ==		== RubySerialIOConnectionWrapper ==
	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).		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.		It's usually accessed via '''conn_''' variable.
Line 31:		Line 31:

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

	=== Members ===		=== Members ===
Line 58:		Line 58:
	end		end

	To ~~proccess~~ command for child device		To process command for child device
	dev_slot = device_.childdevices_[cmd.devidto_].devdata_[12]		dev_slot = device_.childdevices_[cmd.devidto_].devdata_[12]
	case cmd.id_		case cmd.id_

Wikiadmin at 11:36, 23 May 2006

2006-05-23T11:36:36Z

←Older revision		Revision as of 11:36, 23 May 2006
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 available classes and methods. the list is not complete, but covers most of functionality.		<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>[[Category:GSD]]
			Short description of available classes and methods. the list is not complete, but covers most of functionality.
	== RubySerialIOConnectionWrapper ==		== RubySerialIOConnectionWrapper ==
	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).		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).

←Older revision		Revision as of 08:09, 27 September 2011
Line 8:		Line 8:
	Short description of available classes and methods. the list is not complete, but covers most of functionality.		Short description of available classes and methods. the list is not complete, but covers most of functionality.
	== RubySerialIOConnectionWrapper ==		== RubySerialIOConnectionWrapper ==
	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).		The connection object, is the exported (already <span class="plainlinks">[http://www.thepiggybackrider.com/ <span style="color:black;font-weight:normal; text-decoration:none!important; background:none!important; text-decoration:none;/CITATION/">child carrier</span>]</span> 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.		It's usually accessed via '''conn_''' variable.
	=== Methods ===		=== Methods ===
	* '''Send (<string>)''' : will send the ''string'' to the device		* '''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)		* '''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		* '''RecvDelimited(<delimiter>, <timeout>)''' : will return received data until the delimiter was found
	* '''Reconnect()''' : will close and then reopen the connection to the device		* '''Reconnect()''' : will close and then reopen the connection to the device
	* '''Close()''' : will close the connection		* '''Close()''' : will close the connection
Line 21:		Line 21:
	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		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
	=== Methods ===		=== Methods ===
	* '''SendCommand (<command>)''' : send a command (kind of DCEmessage, may be command or event)		* '''SendCommand (<command>)''' : send a command (kind of DCEmessage, may be command or event)
	* '''SendReceiveCommand (<command>)''' : send a command, like SendCommand, but also receives the response, that is any parameter that returns a value		* '''SendReceiveCommand (<command>)''' : send a command, like SendCommand, but also receives the response, that is any parameter that returns a value

	=== Members ===		=== Members ===
Line 34:		Line 34:
	* '''devid_''' : Device ID		* '''devid_''' : Device ID
	* '''devtemplid_''' : Device Template ID		* '''devtemplid_''' : Device Template ID
	* '''devdata_''' : a map <int, string> with device data		* '''devdata_''' : a map <int, string> with device data
	* '''parent_''' : parent device		* '''parent_''' : parent device
	* '''childdevices_''' : a map <int, RubyDeviceWrapper> of child devices.		* '''childdevices_''' : a map <int, RubyDeviceWrapper> of child devices.

	== RubyCommandWrapper ==		== RubyCommandWrapper ==
Line 47:		Line 47:
	* '''type_''' : message type (1 = command, 2 = event)		* '''type_''' : message type (1 = command, 2 = event)
	* '''id_''' : message ID (commandID or eventID)		* '''id_''' : message ID (commandID or eventID)
	* '''params_''' : map <int, string> whith parameters		* '''params_''' : map <int, string> whith parameters

	== Usage samples ==		== Usage samples ==