DCE Binary Communication Protocol - Revision history

Marie.o: /* Enums */

2010-05-17T21:19:38Z

Enums

←Older revision		Revision as of 21:19, 17 May 2010
Line 193:		Line 193:
	* enum eExpectedResponse { ER_None=0, ER_ReplyMessage, ER_ReplyString, ER_DeliveryConfirmation };		* enum eExpectedResponse { ER_None=0, ER_ReplyMessage, ER_ReplyString, ER_DeliveryConfirmation };
	* message types:		* message types:
	** enum { MESSAGETYPE_COMMAND=1, MESSAGETYPE_EVENT=2, MESSAGETYPE_DATAPARM_CHANGE=3, MESSAGETYPE_REPLY=4,		** enum { MESSAGETYPE_COMMAND=1, MESSAGETYPE_EVENT=2, MESSAGETYPE_DATAPARM_CHANGE=3, MESSAGETYPE_REPLY=4, MESSAGETYPE_DATAPARM_REQUEST=5, MESSAGETYPE_LOG=6, MESSAGETYPE_SYSCOMMAND=7, MESSAGETYPE_REGISTER_INTERCEPTOR=8, MESSAGETYPE_MESSAGE_INTERCEPTED=9, MESSAGETYPE_EXEC_COMMAND_GROUP=10, MESSAGETYPE_START_PING=11, MESSAGETYPE_STOP_PING=12, MESSAGETYPE_PURGE_INTERCEPTORS=13, MESSAGETYPE_PENDING_TASKS=14 };
	MESSAGETYPE_DATAPARM_REQUEST=5, MESSAGETYPE_LOG=6, MESSAGETYPE_SYSCOMMAND=7,
	MESSAGETYPE_REGISTER_INTERCEPTOR=8, MESSAGETYPE_MESSAGE_INTERCEPTED=9, MESSAGETYPE_EXEC_COMMAND_GROUP=10,
	MESSAGETYPE_START_PING=11, MESSAGETYPE_STOP_PING=12, MESSAGETYPE_PURGE_INTERCEPTORS=13,
	MESSAGETYPE_PENDING_TASKS=14 };
	* message priority		* message priority
	** enum { PRIORITY_LOW=0, PRIORITY_NORMAL=1, PRIORITY_HIGH=2, PRIORITY_URGENT=3 };		** enum { PRIORITY_LOW=0, PRIORITY_NORMAL=1, PRIORITY_HIGH=2, PRIORITY_URGENT=3 };

Marie.o: beautification

2010-05-17T21:17:54Z

beautification

Show changes

Rwilson131 at 15:09, 6 December 2008

2008-12-06T15:09:04Z

←Older revision		Revision as of 15:09, 6 December 2008
Line 1:		Line 1:
			{\| align="right"
			\| __TOC__
			\|}
			[[Category:Development]]
			[[Category:Programmer's Guide]]
	== Introduction ==		== Introduction ==

Line 445:		Line 450:

	/*********************************************************************************/		/*********************************************************************************/

	~~[[Category:Development]]~~

Lozzo at 17:08, 29 September 2007

2007-09-29T17:08:34Z

←Older revision		Revision as of 17:08, 29 September 2007
Line 445:		Line 445:

	/*********************************************************************************/		/*********************************************************************************/

			[[Category:Development]]

Ender: /* How to serialize a message */

2007-06-05T08:51:38Z

How to serialize a message

←Older revision		Revision as of 08:51, 5 June 2007
Line 235:		Line 235:

	- message priority : enum { PRIORITY_LOW=0, PRIORITY_NORMAL=1, PRIORITY_HIGH=2, PRIORITY_URGENT=3 };		- message priority : enum { PRIORITY_LOW=0, PRIORITY_NORMAL=1, PRIORITY_HIGH=2, PRIORITY_URGENT=3 };


			Important note:

			- when sending to device template, set <device_template_to> to desired device template and also <device_to_id> to -2000 (DEVICEID_MASTERDEVICE)

			- when sending to device category, set <device_category_to> to desired device category and also <device_to_id> to -2001 (DEVICEID_CATEGORY)

			- when sending to a list with devices, set <device_list_to> to comma delimited list with devices and also <device_to_id> to -2002 (DEVICEID_LIST).

Tamjid: /* How to create a command connection */

2007-06-04T15:02:32Z

How to create a command connection

←Older revision		Revision as of 15:02, 4 June 2007
Line 32:		Line 32:
	== How to create a command connection ==		== How to create a command connection ==

	Here is how the handshake is made for ~~an event~~ connection:		Here is how the handshake is made for a command connection:

	>> Device sends:		>> Device sends:

Ender: /* How to serialize data */

2007-05-28T16:11:44Z

How to serialize data

←Older revision		Revision as of 16:11, 28 May 2007
Line 92:		Line 92:

	1. string		1. string

	~~- 4 bytes, STR_LENGTH + 1~~

	- STR_LENGTH bytes, the array with chars		- STR_LENGTH bytes, the array with chars

	- 1 ~~bytes~~, '/0'		- 1 byte, '/0' (value 0x00)

Ender: /* How to serialize a message */

2007-05-21T08:39:44Z

How to serialize a message

←Older revision		Revision as of 08:39, 21 May 2007
Line 255:		Line 255:
	MyDevice.SendData("EVENT 250\n")		MyDevice.SendData("EVENT 250\n")

	MyDevice.ReceiveData() //until you'll get a '\n'		MyDevice.ReceiveData() //until you'll get a '\n' ; you should receive: "OK 250 IP=<device_ip_address> '\n';

	//you should receive: "OK 250 IP=<device_ip_address> '\n';


Line 316:		Line 314:
	MyDevice.SendData(MyData)		MyDevice.SendData(MyData)

	MyDevice.ReceiveData() //until you'll get a '\n'		MyDevice.ReceiveData() //until you'll get a '\n' ; you should receive: "OK" an error message

	//you should receive: "OK" an error message

Ender: /* How to serialize a message */

2007-05-21T08:39:05Z

How to serialize a message

Ender: /* How to serialize a message */

2007-05-21T08:38:12Z

How to serialize a message

←Older revision		Revision as of 08:38, 21 May 2007
Line 237:		Line 237:

	- message priority : enum { PRIORITY_LOW=0, PRIORITY_NORMAL=1, PRIORITY_HIGH=2, PRIORITY_URGENT=3 };		- message priority : enum { PRIORITY_LOW=0, PRIORITY_NORMAL=1, PRIORITY_HIGH=2, PRIORITY_URGENT=3 };




			Example:

			Here is the pseudocode to send the "on" command to a light switch.
			We'll assume that the your device has #id 250 and the light switch has device #id 100

			//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

			MyDevice.Connect(router_ip, 3450 /port/)
			MyDevice.SendData("EVENT 250\n")
			MyDevice.ReceiveData() //until you'll get a '\n'
			//you should receive: "OK 250 IP=<device_ip_address> '\n';

			//next: creating a message
			//let's say MyData is an array of bytes
			SerializeLong(MyData, 1234) //magic number
			SerializeLong(MyData, 250) //my id
			SerializeLong(MyData, 100) //the light switch
			SerializeLong(MyData, 0) //not used now
			SerializeLong(MyData, 192) //message id of command 'on'
			SerializeLong(MyData, 1) //normal priority
			SerializeLong(MyData, 1) //message type : command
			SerializeLong(MyData, 0) //not used now
			SerializeLong(MyData, 0) //not used now
			SerializeUnsignedChar(MyData, 0) //not including children
			SerializeLong(MyData, 0) //broadcast level : none
			SerializeLong(MyData, 0) //don't retry
			SerializeUnsignedChar(MyData, 0) //relative to sender false
			SerializeLong(MyData, 3) //delivery confirmation
			SerializeString(MyData, "") //device list to empty
			SerializeUnsignedLong(MyData, 2) //2 parameters
			SerializeLong(MyData, 98) //parameter type #98
			SerializeString(MyData, "") //empty value
			SerializeLong(MyData, 97) //parameter type #97
			SerializeString(MyData, "") //empty value
			SerializeUnsignedLong(MyData, 0) //no binary parameters
			SerializeUnsignedLong(MyData, 0) //no extra messages
			SerializeUnsignedLong(6789) //magic number

			MyDevice.SendData("MESSAGE " + MyData.length() + '\n')
			MyDevice.SendData(MyData)
			MyDevice.ReceiveData() //until you'll get a '\n'
			//you should receive: "OK" an error message

			MyDevice.CloseConnection();

			//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

	== How to serialize data-grids ==		== How to serialize data-grids ==

←Older revision		Revision as of 08:39, 21 May 2007
Line 242:		Line 242:

	Example:		Example:


	Here is the pseudocode to send the "on" command to a light switch.		Here is the pseudocode to send the "on" command to a light switch.

	We'll assume that the your device has #id 250 and the light switch has device #id 100		We'll assume that the your device has #id 250 and the light switch has device #id 100


	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////		//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

	MyDevice.Connect(router_ip, 3450 /port/)		MyDevice.Connect(router_ip, 3450 /port/)

	MyDevice.SendData("EVENT 250\n")		MyDevice.SendData("EVENT 250\n")

	MyDevice.ReceiveData() //until you'll get a '\n'		MyDevice.ReceiveData() //until you'll get a '\n'

	//you should receive: "OK 250 IP=<device_ip_address> '\n';		//you should receive: "OK 250 IP=<device_ip_address> '\n';


	//next: creating a message		//next: creating a message

	//let's say MyData is an array of bytes		//let's say MyData is an array of bytes

	SerializeLong(MyData, 1234) //magic number		SerializeLong(MyData, 1234) //magic number

	SerializeLong(MyData, 250) //my id		SerializeLong(MyData, 250) //my id

	SerializeLong(MyData, 100) //the light switch		SerializeLong(MyData, 100) //the light switch

	SerializeLong(MyData, 0) //not used now		SerializeLong(MyData, 0) //not used now

	SerializeLong(MyData, 192) //message id of command 'on'		SerializeLong(MyData, 192) //message id of command 'on'

	SerializeLong(MyData, 1) //normal priority		SerializeLong(MyData, 1) //normal priority

	SerializeLong(MyData, 1) //message type : command		SerializeLong(MyData, 1) //message type : command

	SerializeLong(MyData, 0) //not used now		SerializeLong(MyData, 0) //not used now

	SerializeLong(MyData, 0) //not used now		SerializeLong(MyData, 0) //not used now

	SerializeUnsignedChar(MyData, 0) //not including children		SerializeUnsignedChar(MyData, 0) //not including children

	SerializeLong(MyData, 0) //broadcast level : none		SerializeLong(MyData, 0) //broadcast level : none

	SerializeLong(MyData, 0) //don't retry		SerializeLong(MyData, 0) //don't retry

	SerializeUnsignedChar(MyData, 0) //relative to sender false		SerializeUnsignedChar(MyData, 0) //relative to sender false

	SerializeLong(MyData, 3) //delivery confirmation		SerializeLong(MyData, 3) //delivery confirmation

	SerializeString(MyData, "") //device list to empty		SerializeString(MyData, "") //device list to empty

	SerializeUnsignedLong(MyData, 2) //2 parameters		SerializeUnsignedLong(MyData, 2) //2 parameters

	SerializeLong(MyData, 98) //parameter type #98		SerializeLong(MyData, 98) //parameter type #98

	SerializeString(MyData, "") //empty value		SerializeString(MyData, "") //empty value

	SerializeLong(MyData, 97) //parameter type #97		SerializeLong(MyData, 97) //parameter type #97

	SerializeString(MyData, "") //empty value		SerializeString(MyData, "") //empty value

	SerializeUnsignedLong(MyData, 0) //no binary parameters		SerializeUnsignedLong(MyData, 0) //no binary parameters

	SerializeUnsignedLong(MyData, 0) //no extra messages		SerializeUnsignedLong(MyData, 0) //no extra messages

	SerializeUnsignedLong(6789) //magic number		SerializeUnsignedLong(6789) //magic number



	MyDevice.SendData("MESSAGE " + MyData.length() + '\n')		MyDevice.SendData("MESSAGE " + MyData.length() + '\n')

	MyDevice.SendData(MyData)		MyDevice.SendData(MyData)

	MyDevice.ReceiveData() //until you'll get a '\n'		MyDevice.ReceiveData() //until you'll get a '\n'

	//you should receive: "OK" an error message		//you should receive: "OK" an error message


	MyDevice.CloseConnection();		MyDevice.CloseConnection();