WISE-Agent Sample Handler - Revision history

Scott68.chang at 03:59, 7 October 2016

2016-10-07T03:59:38Z

Scott68.chang at 03:51, 7 October 2016

2016-10-07T03:51:51Z

Scott68.chang at 03:51, 7 October 2016

2016-10-07T03:51:13Z

Show changes

Scott68.chang at 03:37, 7 October 2016

2016-10-07T03:37:57Z

Scott68.chang at 03:33, 7 October 2016

2016-10-07T03:33:34Z

Scott68.chang at 03:30, 7 October 2016

2016-10-07T03:30:21Z

Scott68.chang at 03:08, 7 October 2016

2016-10-07T03:08:08Z

Scott68.chang at 03:07, 7 October 2016

2016-10-07T03:07:00Z

Scott68.chang at 02:52, 7 October 2016

2016-10-07T02:52:44Z

Scott68.chang at 02:06, 7 October 2016

2016-10-07T02:06:49Z

@@ Line 1,757: / Line 1,757: @@
 // Types and defines:
 //-----------------------------------------------------------------------------
-#define cagent_request_custom 2102
+#define cagent_request_custom 2102 /*define the request ID for V3.0, not used on V3.1 or later*/
-#define cagent_custom_action 31002
+#define cagent_custom_action 31002 /*define the action ID for V3.0, not used on V3.1 or later*/
 const char strHandlerName[MAX_TOPIC_LEN] = {"TextHandler"};
-const int iRequestID = cagent_request_custom;
+const char strHandlerName[MAX_TOPIC_LEN] = {"TextHandler"}; /*declare the handler name*/
-const int iActionID = cagent_custom_action;
-MSG_CLASSIFY_T *g_Capability = NULL;
+MSG_CLASSIFY_T *g_Capability = NULL; /*the global message structure to describe the sensor data as the handelr capability*/
 //-----------------------------------------------------------------------------
 // Internal Prototypes:
@@ Line 1,768: / Line 1,768: @@
 //
 typedef struct{
-    void* threadHandler;
+    void* threadHandler; // thread handle
-    int interval;
+    int interval;		// time interval for file read
-    bool isThreadRunning;
+    bool isThreadRunning;//thread running flag
 }handler_context_t;
@@ Line 1,776: / Line 1,776: @@
 // Variables
 //-----------------------------------------------------------------------------
-static Handler_info  g_HandlerInfo;
+static Handler_info  g_HandlerInfo; //global Handler info structure
 static handler_context_t g_HandlerContex;
-static HANDLER_THREAD_STATUS g_status = handler_status_no_init;
+static HANDLER_THREAD_STATUS g_status = handler_status_no_init; // global status flag.
 static HandlerSendCbf  g_sendcbf = NULL;						// Client Send information (in JSON format) to Cloud Server
 //-----------------------------------------------------------------------------
 // Function:
@@ Line 1,990: / Line 1,984: @@
 	// 1. Topic of this handler
 	sprintf_s( pluginfo->Name, sizeof(pluginfo->Name), "%s", strHandlerName );
-	pluginfo->RequestID = iRequestID;
+	pluginfo->RequestID = cagent_request_custom;
-	pluginfo->ActionID = iActionID;
+	pluginfo->ActionID = cagent_custom_action;
 	g_samolehandlerlog = pluginfo->loghandle;
 	SampleHLog(Debug, " %s> Initialize", strHandlerName);
@@ Line 2,070: / Line 2,064: @@
 		memset(&g_HandlerInfo, 0, sizeof(HANDLER_INFO));
 		sprintf_s( g_HandlerInfo.Name, sizeof( g_HandlerInfo.Name), "%s", strHandlerName );
-		g_HandlerInfo.RequestID = iRequestID;
+		g_HandlerInfo.RequestID = cagent_request_custom;
-		g_HandlerInfo.ActionID = iActionID;
+		g_HandlerInfo.ActionID = cagent_custom_action;
+	}
+}

@@ Line 1,727: / Line 1,727: @@
-<syntaxhighlight lang="null">#include "stdafx.h"
+<syntaxhighlight lang="c">#include "stdafx.h"
 #include "susiaccess_handler_api.h"
 #include "DeviceMessageGenerate.h"

@@ Line 1,583: / Line 1,583: @@
 ***pRev[POINTER]
 ****Preserved pointer.
-***No return value
+***Return values
 ''Return Values''
@@ Line 1,688: / Line 1,689: @@
 	}}
 </syntaxhighlight>
 == Handler Sample Code ==

@@ Line 1,528: / Line 1,528: @@
-<syntaxhighlight lang="c">int HANDLERKERNEL_API HandlerKernel_SetThresholdTrigger(void (*on_triggered)(threshold_event_type type, char* sensorname, double value, MSG_ATTRIBUTE_T* attr, void *pRev));
+<syntaxhighlight lang="c">int HandlerKernel_SetThresholdTrigger(void (*on_triggered)(threshold_event_type type, char* sensorname, double value, MSG_ATTRIBUTE_T* attr, void *pRev));
 </syntaxhighlight> ''Description''
 *register the threshold check event callback function.
@@ Line 1,562: / Line 1,562: @@
-<syntaxhighlight lang="c">int HANDLERKERNEL_API HandlerKernel_GetSensorData(int replyID, char* sessionID, char *pInQuery, bool (*on_get_sensor)(get_data_t* getlist, void *pRev));
+<syntaxhighlight lang="c">int HandlerKernel_GetSensorData(int replyID, char* sessionID, char *pInQuery, bool (*on_get_sensor)(get_data_t* getlist, void *pRev));
 </syntaxhighlight> ''Description''
 *Get Sensor Data.

← Older revision		Revision as of 03:30, 7 October 2016
Line 1,558:		Line 1,558:

	Reference to HandlerKernel_SetThreshold().		Reference to HandlerKernel_SetThreshold().
		+
		+	----
		+
		+
		+	<syntaxhighlight lang="c">int HANDLERKERNEL_API HandlerKernel_GetSensorData(int replyID, char* sessionID, char pInQuery, bool (on_get_sensor)(get_data_t* getlist, void *pRev));
		+	</syntaxhighlight> ''Description''
		+	*Get Sensor Data.
		+
		+	''Parameters''
		+
		+	*replyID[NUMBER]
		+	**the message reply ID.
		+	**User can customize the reply ID
		+	**HandlerKernel also pre-defined the reply ID as Command ID.
		+	*sessionID[POINTER]
		+	**the session ID string.
		+	*pInQuery[POINTER]
		+	**the received command.
		+	*on_get_sensor[POINTER]
		+	**callback function pointer
		+	*bool (on_get_sensor)(get_data_t* getlist, void *pRev);
		+	***getlist[POINTER]
		+	****list of the target data structure
		+	***pRev[POINTER]
		+	****Preserved pointer.
		+	***No return value
		+
		+	''Return Values''
		+
		+	*[-1 \| 0] fail or success.
		+
		+	''Example''
		+
		+
		+	<syntaxhighlight lang="c">#include "susiaccess_handler_api.h"
		+	#include "HandlerKernel.h"
		+
		+	void on_threshold_triggered(threshold_event_type type, char* sensorname, double value, bool on_get_sensor(get_data_t* objlist, void *pRev)
		+	{
		+	get_data_t *current = objlist;
		+	if(objlist == NULL) return false;
		+
		+	while(current)
		+	{
		+	current->errcode = STATUSCODE_SUCCESS;
		+	strcpy(current->errstring, STATUS_SUCCESS);
		+
		+	switch(current->attr->type)
		+	{
		+	case attr_type_numeric:
		+	printf(" %s> get: %s value:%d", g_HandlerInfo.Name, current->sensorname, current->attr->v);
		+	break;
		+	case attr_type_boolean:
		+	printf(" %s> get: %s value:%s", g_HandlerInfo.Name, current->sensorname, current->attr->bv?"true":"false");
		+	break;
		+	case attr_type_string:
		+	printf(" %s> get: %s value:%s", g_HandlerInfo.Name, current->sensorname, current->attr->sv);
		+	break;
		+	case attr_type_date:
		+	printf(" %s> get: %s value:Date:%s", g_HandlerInfo.Name, current->sensorname, current->attr->sv);
		+	break;
		+	case attr_type_timestamp:
		+	printf(" %s> get: %s value:Timestamp:%d", g_HandlerInfo.Name, current->sensorname, current->attr->v);
		+	break;
		+	}
		+
		+	current = current->next;
		+	}
		+	return true;
		+	}
		+
		+	bool on_set_sensor(set_data_t* objlist, void *pRev)
		+	{
		+	set_data_t *current = objlist;
		+	if(objlist == NULL) return false;
		+	while(current)
		+	{
		+	current->errcode = STATUSCODE_SUCCESS;
		+	strcpy(current->errstring, STATUS_SUCCESS);
		+
		+	switch(current->newtype)
		+	{
		+	case attr_type_numeric:
		+	printf(" %s> set: %s value:%d", g_HandlerInfo.Name, current->sensorname, current->v);
		+	break;
		+	case attr_type_boolean:
		+	printf(" %s> set: %s value:%s", g_HandlerInfo.Name, current->sensorname, current->bv?"true":"false");
		+	break;
		+	case attr_type_string:
		+	printf(" %s> set: %s value:%s", g_HandlerInfo.Name, current->sensorname, current->sv);
		+	break;
		+	}
		+
		+	current = current->next;
		+	}
		+
		+	return true;
		+	}
		+
		+	void Handler_Recv(char * const topic, void* const data, const size_t datalen, void pRev1, void pRev2 )
		+	{
		+	int cmdID = 0;
		+	char sessionID[32] = {0};
		+	printf(" >Recv Topic [%s] Data %s\n", topic, (char*) data );
		+
		+	/Parse Received Command/
		+	if(HandlerKernel_ParseRecvCMDWithSessionID((char*)data, &cmdID, sessionID) != handler_success)
		+	return;
		+	switch(cmdID)
		+	{
		+	case hk_get_sensors_data_req:
		+	/Get Sensor Data with callback function/
		+	HandlerKernel_GetSensorData(hk_get_sensors_data_rep, sessionID, (char*)data, on_get_sensor);
		+	break;
		+	case hk_set_sensors_data_req:
		+	/Set Sensor Data with callback function/
		+	HandlerKernel_SetSensorData(hk_set_sensors_data_rep, sessionID, (char*)data, on_set_sensor);
		+	break;
		+	default:
		+	{
		+	/* Send command not support reply message*/
		+	char repMsg[32] = {0};
		+	int len = 0;
		+	sprintf( repMsg, "{\"errorRep\":\"Unknown cmd!\"}" );
		+	len= strlen( "{\"errorRep\":\"Unknown cmd!\"}" ) ;
		+	if ( g_sendcbf ) g_sendcbf( & g_HandlerInfo, hk_error_rep, repMsg, len, NULL, NULL );
		+	}
		+	break;
		+	}}
		+	</syntaxhighlight>

	== Handler Sample Code ==		== Handler Sample Code ==

@@ Line 1,483: / Line 1,483: @@
 *[-1 | 0] fail or success.
-''Example'' Reference to HandlerKernel_SetThreshold().
+''Example''
 ----
@@ Line 1,500: / Line 1,502: @@
 *[-1 | 0] fail or success.
-''Example'' Reference to HandlerKernel_SetThreshold().
+''Example''
 ----
@@ Line 1,517: / Line 1,521: @@
 *[-1 | 0] fail or success.
-''Example'' Reference to HandlerKernel_SetThreshold().
+''Example''
 ----
@@ Line 1,549: / Line 1,555: @@
 *[-1 | 0] fail or success.
-''Example'' Reference to HandlerKernel_SetThreshold().
+''Example''
 == Handler Sample Code ==

@@ Line 1,347: / Line 1,347: @@
 	char sessionID[32] = {0};
 	printf(" >Recv Topic [%s] Data %s\n", topic, (char*) data );
+	/*Parse Received Command*/
 	if(HandlerKernel_ParseRecvCMDWithSessionID((char*)data, &cmdID, sessionID) != handler_success)
 		return;
@@ Line 1,353: / Line 1,353: @@
+	{
 	case hk_auto_upload_req:
 		HandlerKernel_LiveReportStart(hk_auto_upload_rep, (char*)data);
 		break;
 	default:
+		{
 			char repMsg[32] = {0};
 			int len = 0;
@@ Line 1,382: / Line 1,384: @@
 *pInQuery[POINTER]
 **the received command.
 ''Return Values''
@@ Line 1,392: / Line 1,392: @@
 Reference to HandlerKernel_ParseRecvCMDWithSessionID().
 == Handler Sample Code ==