Difference between revisions of "IoTGateway/DataProcess"

From ESS-WIKI
Jump to: navigation, search
(→‎Example)
 
(3 intermediate revisions by the same user not shown)
Line 216: Line 216:
  
 
=Example=
 
=Example=
−
==SenHub's Info Spec==
+
'''<big>SenHub's Info Spec</big>'''<br />
−
Topic: /cagent/admin/<devID>/agentactionreq
+
Topic: /cagent/admin/<devID>/agentactionreq<br />
 +
 
 
  Msg:
 
  Msg:
−
  {
+
  { "susiCommData": {
−
"susiCommData": {
+
    "infoSpec": {
−
"infoSpec": {
+
        "SenHub": {
−
"SenHub": {
+
          "SenData": {
−
"SenData": {
+
                "e": [{"n": "Temperature","u": "Cel","v": 0,"min": -100,"max": 200,"asm": "r","type": "d","rt": "ucum.Cel","st": "ipso","exten": ""},
−
"e": [
+
                      {"n": "Humidity","u": "%","v": 0,"min": 0,"max": 100,"asm": "r","type": "d","rt": "ucum.%","st": "ipso","exten": ""}],
−
{
+
            "bn": "SenData"
−
"n": "Temperature",
+
        },
−
"u": "Cel",
+
        "Info": {"e": [{"n": "Name","sv": "SenHub1","asm": "rw"},{"n": "sw","sv": "1.0.00","asm": "r"}],
−
"v": 0,
+
          "bn": "Info"
−
"min": -100,
+
        },
−
"max": 200,
+
        "Net": {"e": [{"n": "sw","sv": "1.0.00","asm": "r"},{"n": "Neighbor","sv": "","asm": "r"},{"n": "Health","v": "100.000000","asm": "r"}],
−
"asm": "r",
+
                "bn": "Net"
−
"type": "d",
+
        }
−
"rt": "ucum.Cel",
+
    }
−
"st": "ipso",
+
  },
−
"exten": ""
+
  "commCmd": 2052,
−
},
+
  "requestID": 2001,
−
{
+
  "agentID": "0017000E40000000",
−
"n": "Humidity",
+
  "handlerName": "general",
−
"u": "%",
+
  "sendTS": 160081024
−
"v": 0,
+
  }
−
"min": 0,
 
−
"max": 100,
 
−
"asm": "r",
 
−
"type": "d",
 
−
"rt": "ucum.%",
 
−
"st": "ipso",
 
−
"exten": ""
 
−
},
 
−
{
 
−
"n": "GPIO1",
 
−
"u": "",
 
−
"bv": 0,
 
−
"min": 0,
 
−
"max": 1,
 
−
"asm": "r",
 
−
"type": "b",
 
−
"rt": "",
 
−
"st": "ipso",
 
−
"exten": ""
 
−
},
 
−
{
 
−
"n": "GPIO2",
 
−
"u": "",
 
−
"bv": 0,
 
−
"min": 0,
 
−
"max": 1,
 
−
"asm": "r",
 
−
"type": "b",
 
−
"rt": "",
 
−
"st": "ipso",
 
−
"exten": ""
 
−
}
 
−
],
 
−
"bn": "SenData"
 
−
},
 
−
"Info": {
 
−
"e": [
 
−
{
 
−
"n": "Name",
 
−
"sv": "SenHub1",
 
−
"asm": "rw"
 
−
},
 
−
{
 
−
"n": "sw",
 
−
"sv": "1.0.00",
 
−
"asm": "r"
 
−
}
 
−
],
 
−
"bn": "Info"
 
−
},
 
−
"Net": {
 
−
"e": [
 
−
{
 
−
"n": "sw",
 
−
"sv": "1.0.00",
 
−
"asm": "r"
 
−
},
 
−
{
 
−
"n": "Neighbor",
 
−
"sv": "",
 
−
"asm": "r"
 
−
},
 
−
{
 
−
"n": "Health",
 
−
"v": "100.000000",
 
−
"asm": "r"
 
−
}
 
−
],
 
−
"bn": "Net"
 
−
}
 
−
}
 
−
},
 
−
"commCmd": 2052,
 
−
"requestID": 2001,
 
−
"agentID": "0017000E40000000",
 
−
"handlerName": "general",
 
−
"sendTS": 160081024
 
−
}
 
 
  }
 
  }
 +
 +
:'''<big>DataEx</big>'''
 +
nVer:          1
 +
 +
:'''<big>SqlParams:</big>'''
 +
nAction:        0
 +
pszPrimaryKey:  /cagent/admin/<devID>/agentactionreq
 +
pszOutData:    NULL
 +
pszGeneralInfo: NULL
 +
pExtend1:      NULL
 +
pExtend2:      NULL
 +
 +
SQL Table  IoTGWHandler_UniqueKey
 +
Key:            /cagent/admin/<devID>/agentactionreq
 +
SecondKey:      IoTGWHandler
 +
Protocol_Param: Refer above
 +
Message:        Refer above
 +
Send:          -
 +
Time:          UTC
 +
General:        -

Latest revision as of 06:39, 6 September 2016

Data Format and SQL Field is designed for Data e-motion, Mqtt Reliability Data Channel.

SQL Field

SQLite Table Fields ( Auto Index)
Item Field Name Type Need Format Example
1 Key Unsigned Int Must 　 6886 (serial number)
2 SecondKey Text Optional 　 Default: Hanle Name: SUSHandler
3 Protocol_Param Text Optional JSON Refer to "Protocol Params in JSON Format"
4 Message Text Optional 　 {IoTGW { …. } )
5 Send Flag Optional 0 or 1 1 or 0
6 Time Unsigned Int Must 　 33325 ( UTC in sec )
7 General Text Optional 　 any type format


SQLite Table Fields ( User Assign Key )
Item Field Name Type Need Format Example
1 Key Text Must 　 /cagent/admin/infoack
2 SecondKey Text Optional 　 Default: Hanle Name: SUSHandler
3 Protocol_Param Text Optional JSON Refer to "Protocol Params in JSON Format"
4 Message Text Optional 　 {IoTGW { …. } )
5 Send Flag Optional 0 or 1 1 or 0
6 Time Unsigned Int Must 　 33325 ( UTC in sec )
7 General Text Optional 　 any type format


SQLite Methods
Item Method Note
1 Insert *by Primary key

*by Second key ( ex: HandlerName ) ( primary key => auto index )

2 Update by Primary key
3 Query * by Primary key

* by Search rules ( like or updatetime or latest item / order by ? (time ...) )

* All ( order by time )

4 Clean *by Primary Key

*by Search rules ( like or updatetime or latest item / order by ? (time ...) )

*All items of Table

5 Create Table *AutoIndex

*UniqueKey


Protocol Params in JSON Format

MQTT 

{			
 "Protocol":"MQTT",
 "MQTT":{
   "Method":"Publish",
   "Topic":"/cagent/admin/<devID>/agentactionreq",
   "QoS":2,
   "Retain":0
 }						
}

Data Extend Information and SQL Structures for Handler pass to Manager

SQL Params structure. This stuucture is designed for Hanlder pass its log behavior. 

typedef struct SQLParams
{
  int   nVer;              // Version of SQL Param	: 1
  int   nAction;          // 0: Insert or Update, 1: Delete, 2: Query
  char *pszPrimaryKey;    // NULL => Auto Index
  char **pszOutDataPoint; // Pass this point to save result of query
  char *pszGeneralInfo;   // 
  int  *pnStatus;              // status code
  void *pExtend1;
  void *pExtend2;				
}SQL_PARAMS, SQL_Params;


Data extened Information Structure. Handler can add more information while sending data to WISE Manager. 

typedef struct DataExInfo
{	
  int   nVer;            // Data Ex Info version: 1					
  void *pSqlParams;      // address of SQL parameters structure
  void *pExtend1;        // Reserved
  void *pExtend2;        // Reserved
}DATAEX_INFO, DataEx_Info;

Example

SenHub's Info Spec
Topic: /cagent/admin/<devID>/agentactionreq

Msg:
{ "susiCommData": {
    "infoSpec": {
       "SenHub": {
          "SenData": {
               "e": [{"n": "Temperature","u": "Cel","v": 0,"min": -100,"max": 200,"asm": "r","type": "d","rt": "ucum.Cel","st": "ipso","exten": ""},
                     {"n": "Humidity","u": "%","v": 0,"min": 0,"max": 100,"asm": "r","type": "d","rt": "ucum.%","st": "ipso","exten": ""}],
           "bn": "SenData"
        },
       "Info": {"e": [{"n": "Name","sv": "SenHub1","asm": "rw"},{"n": "sw","sv": "1.0.00","asm": "r"}],
          "bn": "Info"
       },
       "Net": {"e": [{"n": "sw","sv": "1.0.00","asm": "r"},{"n": "Neighbor","sv": "","asm": "r"},{"n": "Health","v": "100.000000","asm": "r"}],
               "bn": "Net"
       }
    }
  },
  "commCmd": 2052,
  "requestID": 2001,
  "agentID": "0017000E40000000",
  "handlerName": "general",
  "sendTS": 160081024
  }
}
DataEx
nVer:           1
SqlParams: 
nAction:        0
pszPrimaryKey:  /cagent/admin/<devID>/agentactionreq
pszOutData:     NULL
pszGeneralInfo: NULL		
pExtend1:       NULL
pExtend2:       NULL

SQL Table IoTGWHandler_UniqueKey 

Key:            /cagent/admin/<devID>/agentactionreq
SecondKey:      IoTGWHandler
Protocol_Param: Refer above 
Message:        Refer above
Send:           -
Time:           UTC
General:        -
Retrieved from "https://ess-wiki.advantech.com.tw/wiki/index.php?title=IoTGateway/DataProcess&oldid=3184"