EI-Agent Sample Client - Revision history

Scott68.chang at 02:43, 1 June 2017

2017-06-01T02:43:40Z

Scott68.chang at 09:01, 19 May 2017

2017-05-19T09:01:02Z

Show changes

Scott68.chang at 08:56, 19 May 2017

2017-05-19T08:56:18Z

Scott68.chang at 08:55, 19 May 2017

2017-05-19T08:55:45Z

Scott68.chang at 08:40, 19 May 2017

2017-05-19T08:40:52Z

Scott68.chang: add CORE_UPDATE_CALLBACK

2017-05-19T08:18:55Z

add CORE_UPDATE_CALLBACK

Scott68.chang at 07:44, 19 May 2017

2017-05-19T07:44:35Z

Scott68.chang: add CORE_RENAME_CALLBACK

2017-05-19T07:40:40Z

add CORE_RENAME_CALLBACK

Scott68.chang at 09:49, 18 May 2017

2017-05-18T09:49:43Z

Scott68.chang: add core_error_string_get

2017-05-18T09:43:14Z

add core_error_string_get

@@ Line 35: / Line 35: @@
 <syntaxhighlight lang="c">void core_uninitialize();</syntaxhighlight> ''Description''
-*General function to uninitialize the WISECore API library that should be called before program exit.
+*General function to release the WISECore API library that should be called before program exit.
 ''Parameters''
@@ Line 60: / Line 60: @@
 **the serial number string of target device.
 *strParentID[POINTER]
-**the parent device ID string in UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, used to point out the EIS or Gateway device ID&nbsp;if the taget device connect to server through an EIS or Gateway device.
+**the parent device ID string in UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, used to point out the EIS or Gateway device ID&nbsp;if the target device connect to server through an EIS or Gateway device.
 *strVersion[POINTER]
-**the applicatin version string.
+**the application version string.
 *strType[POINTER]
-**the applicatin type string, default is "IPC" for general usage.
+**the application type string, default is "IPC" for general usage.
 *strProduct[POINTER]
 **the target device product name.
@@ Line 309: / Line 309: @@
+{
      printf("CB_Connected \n");
-     /*Send device registion message.*/
+     /*Send device register message.*/
      core_device_register();
+}
@@ Line 455: / Line 455: @@
 void on_server_reconnect(const char* tenantid, const char* devid, void* userdata)
+{
-     /*Send device registion message again.*/
+     /*Send device register message again.*/
      core_device_register();
+}
@@ Line 613: / Line 613: @@
 EXIT:
      /*Release WISECore*/
-     core_uni nitialize();
+     core_uninitialize();
      return iRet;
+}
@@ Line 639: / Line 639: @@
 void on_heartbeatrate_query(const char* sessionid, const char* tenantid, const char* devid, void* userdata)
+{
-     /*Send current hearbeat rate:60 back to server*/
+     /*Send current heartbeat rate:60 back to server*/
      core_heartbeatratequery_response(g_iHeartbeatRate, sessionid, tenantid, devid);
      printf("Heartbeat Rate Query: %s, %s\n", sessionid, devid);
@@ Line 670: / Line 670: @@
 EXIT:
      /*Release WISECore*/
-     core_uni nitialize();
+     core_uninitialize();
      return iRet;
+}
@@ Line 773: / Line 773: @@
 EXIT:
      /*Release WISECore*/
-     core_uni nitialize();
+     core_uninitialize();
      return iRet;
+}
@@ Line 842: / Line 842: @@
 EXIT:
      /*Release WISECore*/
-     core_uni nitialize();
+     core_uninitialize();
      return iRet;
+}
@@ Line 854: / Line 854: @@
 ''Parameters''
-*toppic[POINTER]
+*topic[POINTER]
 **the topic to subscribe.
 *qos[NUMBER]
@@ Line 868: / Line 868: @@
+{
      printf("CB_Connected \n");
-     /*Send device registion message.*/
+     /*Send device register message.*/
      core_device_register();
@@ Line 933: / Line 933: @@
 Reference to core_subscribe().
 ----

@@ Line 1,162: / Line 1,162: @@
 *None.
 ----
@@ Line 1,182: / Line 1,183: @@
 *None.
 ----
@@ Line 1,204: / Line 1,206: @@
 *None.
 ----
 <syntaxhighlight lang="c">typedef long long (*CORE_GET_TIME_TICK_CALLBACK)(void* userdata);</syntaxhighlight> ''Description''
 *define theget time tick callback function to handle pass the time tick into EI-Agent. EI-Agent cannot get or generate time tick itself.
 ''Parameters''
 *userdata[POINTER]
 **unformated pointer to carry the user defined structure.

@@ Line 1,074: / Line 1,074: @@
 *None.
 ----
@@ Line 1,092: / Line 1,093: @@
 *None.
 ----
@@ Line 1,114: / Line 1,116: @@
 *None.
 ----
@@ Line 1,136: / Line 1,139: @@
 *None.
 ----
@@ Line 1,148: / Line 1,152: @@
 *pktlength[NUMBER]
 **the length of received payload.
 *tenantid[POINTER]
 **the tenant ID string in UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

@@ Line 1,041: / Line 1,041: @@
 *None.
 ----
 <syntaxhighlight lang="c">typedef void (*CORE_UPDATE_CALLBACK)(const char* loginID, const char* loginPW, const int port, const char* path, const char* md5, const int cmdid, const char* sessionid, const char* tenantid, const char* clientid, void* userdata);</syntaxhighlight> ''Description''
-*define the rename callback function to handle the rename command received from server.
+*define the update callback function to handle the update command received from server.
 ''Parameters''
@@ Line 1,052: / Line 1,053: @@
 **ftp server login account.
 *loginPW[POINTER]
-**ftp server  login password.
+**ftp server login password.
 *port[NUMBER]
 **ftp server listen port.
@@ Line 1,063: / Line 1,064: @@
 *sessionid[POINTER]
 **received request session ID.
 *tenantid[POINTER]
 **the tenant ID string in UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

@@ Line 1,027: / Line 1,027: @@
 *name[POINTER]
 **new name.
 *cmdid[NUMBER]
 **received command ID.

@@ Line 975: / Line 975: @@
-<syntaxhighlight lang="c">typedef void (*CORE_CONNECTED_CALLBACK)(void* userdata);</syntaxhighlight>
+<syntaxhighlight lang="c">typedef void (*CORE_CONNECTED_CALLBACK)(void* userdata);</syntaxhighlight> ''Description''
 *define the on connected callback function.
@@ Line 992: / Line 990: @@
-<syntaxhighlight lang="c">typedef void (*CORE_LOSTCONNECTED_CALLBACK)(void* userdata);</syntaxhighlight>
+<syntaxhighlight lang="c">typedef void (*CORE_LOSTCONNECTED_CALLBACK)(void* userdata);</syntaxhighlight> ''Description''
 *define the on lost connect&nbsp;callback function.
@@ Line 1,009: / Line 1,005: @@
-<syntaxhighlight lang="c">typedef void (*CORE_DISCONNECT_CALLBACK)(void* userdata);</syntaxhighlight>
+<syntaxhighlight lang="c">typedef void (*CORE_DISCONNECT_CALLBACK)(void* userdata);</syntaxhighlight> ''Description''
 *define the on disconnect callback function.
@@ Line 1,022: / Line 1,016: @@
 *None.
 ----
-<syntaxhighlight lang="c">typedef void (*CORE_RENAME_CALLBACK)(const char* name, const int cmdid, const char* sessionid, const char* tenantid, const char* devid, void* userdata);</syntaxhighlight>
+<syntaxhighlight lang="c">typedef void (*CORE_RENAME_CALLBACK)(const char* name, const int cmdid, const char* sessionid, const char* tenantid, const char* clientid, void* userdata);</syntaxhighlight> ''Description''
 *define the rename callback function to handle the rename command received from server.
@@ Line 1,039: / Line 1,032: @@
 **received request session ID.
 *tenantid[POINTER]
-**tenant ID.
+**the tenant ID string in UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
-*devid[POINTER]
+*clientid[POINTER]
-**device ID.
+**the client ID string in UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
 *userdata[POINTER]
 **unformated pointer to carry the user defined structure.

@@ Line 952: / Line 952: @@
 === Callback Function ===
-<pre>typedef&nbsp;void (*SACLIENT_MESSAGE_RECV_CALLBACK)(char* topic, susiaccess_packet_body_t *pkt, void *pRev1, void* pRev2);</pre>
+<syntaxhighlight lang="c">typedef void (*CORE_MESSAGE_RECV_CALLBACK)(const char* topic, const void *pkt, const long pktlength, void* userdata);</syntaxhighlight>
 ''Description''
@@ Line 963: / Line 962: @@
 **MQTT topic string
 *pkt[POINTER]
-**the packet&nbsp;structure pointer.
+**the packet structure pointer.
-*pRev1[POINTER]
+*pktlength[NUMBER]
-**preserved pointer.
+**received packet length.
-*pRev2[POINTER]
+*userdata[POINTER]
-**preserved pointer.
+**unformated pointer to carry the user defined structure.
 ''Return Values''
@@ Line 976: / Line 975: @@
-<pre>typedef&nbsp;void (*SACLIENT_CONNECTED_CALLBACK)();</pre>
+<syntaxhighlight lang="c">typedef void (*CORE_CONNECTED_CALLBACK)(void* userdata);</syntaxhighlight>
 ''Description''
@@ Line 984: / Line 983: @@
 ''Parameters''
-*None
+*userdata[POINTER]
 ''Return Values''
@@ Line 993: / Line 993: @@
-<pre>typedef&nbsp;void (*SACLIENT_LOSTCONNECT_CALLBACK)();</pre>
+<syntaxhighlight lang="c">typedef void (*CORE_LOSTCONNECTED_CALLBACK)(void* userdata);</syntaxhighlight>
 ''Description''
@@ Line 1,001: / Line 1,001: @@
 ''Parameters''
-*None
+*userdata[POINTER]
 ''Return Values''
@@ Line 1,010: / Line 1,012: @@
-<pre>typedef&nbsp;void (*SACLIENT_DISCONNECT_CALLBACK)();</pre>
+<syntaxhighlight lang="c">typedef void (*CORE_DISCONNECT_CALLBACK)(void* userdata);</syntaxhighlight >
 ''Description''
@@ Line 1,018: / Line 1,020: @@
 ''Parameters''
-*None
 ''Return Values''

← Older revision		Revision as of 09:43, 18 May 2017
Line 933:		Line 933:

	Reference to core_subscribe().		Reference to core_subscribe().
		+	----
		+
		+
		+	<syntaxhighlight lang="c">const char* core_error_string_get();</syntaxhighlight> ''Description''
		+	*Call to obtain a const string description the error number.
		+
		+	''Parameters''
		+
		+	*None
		+
		+	''Return Values''
		+
		+	*true/false
		+
		+	''Example''
		+
		+	Reference to core_connection_callback_set().

	=== Callback Function ===		=== Callback Function ===