Difference between revisions of "EIS Service Protocol"
From ESS-WIKI
Eric.liang (talk | contribs) (Created page with "= Overview = :Introduction for "WISE-Snail communication protocol for EIS Service". WISEAgent communication protocol is base on standard MQTT protocol. We also define Advante...") |
Eric.liang (talk | contribs) |
||
| (36 intermediate revisions by the same user not shown) | |||
| Line 14: | Line 14: | ||
*Retained: 0 | *Retained: 0 | ||
*Payload: | *Payload: | ||
| − | < | + | <div>{<br/> "susiCommData": {<br/> "devID":"<span style="color:#FF0000;">0005000E40000001</span>", // User Define, NULL-> Auto UUID-like devID<br/> "hostname":"WISE-1520+(devID4)", // The same with Handler Name<br/> "sn":"0005000E40000001",<br/> "mac":"0005000E40000001",<br/> "version":"3.1.23", <br/> "type":"<span style="color:#0000FF;">Service</span>", // Fixed: Service<br/> "product":"<span style="color:#006400;"><ServiceGroup></span>",<br/> "manufacture":"",<br/> "status":"1",<br/> "commCmd":1,<br/> "requestID":30002,<br/> "agentID":"0005000E40000001", // the same with devID<br/> "handlerName":"general",<br/> "sendTS":160081026<br/> }<br/>}</div> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | } | ||
| − | </ | ||
== OS Info == | == OS Info == | ||
| Line 43: | Line 25: | ||
*Retained: 0 | *Retained: 0 | ||
*Payload: | *Payload: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | {<br/> "susiCommData":{<br/> "osInfo":<br/> {<br/> "cagentVersion":"<span style="color:#008000;">3.1.23</span>", // Service version for user define<br/> "cagentType":<span style="color:#000000;">"</span><span style="color:#0000FF;">Service</span>", // fixed<br/> "osVersion":"SnailOS",<br/> "biosVersion":"",<br/> "platformName":"",<br/> "processorName":"Snail", // different to SnailGW <br/> "osArch":"SnailX86",<br/> "totalPhysMemKB":123,<br/> "macs":"000E40ABCDEF", // uuid<br/> "IP":"" // "null"<br/> },<br/> "commCmd":116,<br/> "requestID":109,<br/> "agentID":"0005000E40000001",<br/> "handlerName":"general",<br/> "sendTS":1466730390<br/> }<br/>} | ||
== Disconnect == | == Disconnect == | ||
| Line 77: | Line 37: | ||
*Retained: 0 | *Retained: 0 | ||
*Payload: | *Payload: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == Info or Update | + | {<br/> "susiCommData": {<br/> "devID":"0005000E40000001",<br/> "hostname":"<span style="color:#FF0000;"></span>WISE-1520+(devID4)<span style="color:#FF0000;"></span>",<br/> "sn":"0005000E40000001",<br/> "mac":"0005000E40000001",<br/> "version":"3.1.23",<br/> "type":"<span style="color:#0000FF;">Service</span>",<br/> "product":"",<br/> "manufacture":"",<br/> "status":"0",<br/> "commCmd":1,<br/> "requestID":30002,<br/> "agentID":"0005000E40000001",<br/> "handlerName":"general",<br/> "sendTS":160081026<br/> }<br/>} |
| + | |||
| + | == Info or Update Service's Capability == | ||
*Description: Agent will send it's capability to Server for description all resource. | *Description: Agent will send it's capability to Server for description all resource. | ||
| Line 108: | Line 51: | ||
Example: Service's Capability | Example: Service's Capability | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | {<br/> "susiCommData":{<br/> "infoSpec": {<br/> "<span style="color:#FF0000;"><ServiceGroup></span>": {<br/> "<span style="color:#FF0000;"><ServeName></span>":{<br/> "ServeName0":{<br/> "Info": { "e": [ {"n":"Temperature","u":"Cel","v":0.000000,"min":-100},<br/> {"n":"Humidity","u":"%","v":0.000000,"min":0.000000,"max":100.000000,"asm":"r","type":"d","rt":"ucum.%","st":"ipso","exten":""},<br/> {"n":"SmartML", "sv":"<xml>", "asm":"rw", "format":"xml", "encoding":"base64"},<br/> {"n":"SmartData", "sv":"<json>", "asm":"r", "format":"json", "encoding":"base64"} <br/> ]<br/> },<br/> "bn":"Info"<br/> },<br/> "bn":"0005000E40000001" <span style="color:#FF0000;">// => uuid</span><br/> },<br/> "bn":"<span style="color:#FF0000;"><ServeName></span>"<br/> }<br/> },<br/> "commCmd":2052,<br/> "requestID":2001,<br/> "agentID":"0005000E40000001",<br/> "handlerName":"general",<br/> "sendTS":160081024<br/> }<br/>} | ||
== Auto Update Sensor Data Value == | == Auto Update Sensor Data Value == | ||
| Line 144: | Line 63: | ||
*Retained: 0 | *Retained: 0 | ||
*Payload: | *Payload: | ||
| − | < | + | |
| − | + | { <br/> "susiCommData":{ <br/> "data":{ <br/> "<span style="color:#FF0000;"><ServiceGroup></span>":{ <br/> "<span style="color:#FF0000;"><ServeName></span>":{ <br/> "ServeName0": {<br/> "Info":{ <br/> "e":[ {"n":"SmartData", "sv":"<json>"}],<br/> "bn":"Info"<br/> },<br/> "bn":"0005000E40000001" <br/> },<br/> "bn":"<ServeName>"<br/> },<br/> "bn":"<ServiceName>"<br/> }<br/> },<br/> "commCmd":2055,<br/> "requestID":2001,<br/> "agentID":"0005000E40000001",<br/> "handlerName":"general",<br/> "sendTS":160081031<br/> }<br/>} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | </ | ||
== Get Sensor Data == | == Get Sensor Data == | ||
| Line 190: | Line 75: | ||
*Retained: 0 | *Retained: 0 | ||
*Payload: | *Payload: | ||
| − | < | + | |
| − | + | { <br/> "susiCommData":{ <br/> "sessionID":"2746E3B65BAB115338B9668CDC5C35C4",<br/> "sensorIDList":{ <br/> "e":[ <br/> { <br/> "n":"<span style="color:#FF0000;">ServiceGroup/ServeName/devID/Info/SmartML</span>"<br/> }<br/> ]<br/> },<br/> "commCmd":523,<br/> "requestID":0,<br/> "agentID":"",<br/> "handlerName":"<span style="color:#FF0000;"></span><span style="color:#0000FF;">Service</span><span style="color:#FF0000;"></span>",<br/> "sendTS":1466057267<br/> }<br/>} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | } | ||
| − | </ | ||
*Description: Agent will reply its data value. | *Description: Agent will reply its data value. | ||
| Line 216: | Line 85: | ||
*Retained: 0 | *Retained: 0 | ||
*Payload: | *Payload: | ||
| − | < | + | |
| − | + | { <br/> "susiCommData":{ <br/> "commCmd":524,<br/> "handlerName":"<span style="color:#FF0000;"><ServiceGroup></span>",<br/> "sessionID":"2746E3B65BAB115338B9668CDC5C35C4",<br/> "sensorInfoList":{ <br/> "e":[ <br/> { <br/> "n":"<span style="color:#FF0000;">ServiceGroup/ServeName/devID/Info/SmartML</span>",<br/> <span style="color:#FF0000;">"sv":"<xml>",</span><br/> "StatusCode":200<br/> }<br/> ]<br/> }<br/> }<br/>} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | </ | ||
== Set Sensor Data == | == Set Sensor Data == | ||
| Line 243: | Line 97: | ||
*Retained: 0 | *Retained: 0 | ||
*Payload: | *Payload: | ||
| − | < | + | |
| − | + | { <br/> "susiCommData":{ <br/> "sessionID":"4DDF0B6DE2773176095F55E8C930507A",<br/> "commCmd":525,<br/> "requestID":0,<br/> "agentID":"",<br/> "handlerName":"<span style="color:#0000FF;">Service</span>", // Fixed name for wisesnail parse rule<br/> "sendTS":1466088605<br/> "sensorIDList":{ <br/> "e":[ <br/> { <br/> "sv":"<span style="color:#FF0000;"><xml></span>",<br/> "n":"<span style="color:#FF0000;">ServiceGroup/ServeName/devID/Info/SmartML</span>"<br/> }<br/> ]<br/> }<br/> }<br/>} | |
| − | + | ||
| − | + | *Description: Agent will reply accept this command | |
| − | + | *Type: Reply | |
| − | + | *Direction: Agent -> Server | |
| − | + | *Topic: /cagent/admin/<devID>/agentactionreq | |
| − | + | *QoS: 0 | |
| − | + | *Retained: 0 | |
| − | + | *Payload: | |
| − | + | ||
| − | + | { <br/> "susiCommData":{ <br/> "commCmd":526,<br/> "handlerName":"<span style="color:#0000FF;">Service</span>",<br/> "sessionID":"4DDF0B6DE2773176095F55E8C930507A",<br/> "sensorInfoList":{ <br/> "e":[ <br/> { <br/> "n":"<span style="color:#FF0000;"><ServiceGroup>/ServeName/<devID>/Info/SmartML</span>",<br/> "StatusCode":<span style="color:#FF0000;">202</span><br/> }<br/> ]<br/> }<br/> }<br/>} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | } | ||
| − | </ | ||
*Description: Agent will reply its result. | *Description: Agent will reply its result. | ||
| Line 270: | Line 117: | ||
*Retained: 0 | *Retained: 0 | ||
*Payload: | *Payload: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | { <br/> "susiCommData":{ <br/> "commCmd":526,<br/> "handlerName":"<span style="color:#0000FF;">Service</span>",<br/> "sessionID":"4DDF0B6DE2773176095F55E8C930507A",<br/> "sensorInfoList":{ <br/> "e":[ <br/> { <br/> "n":"<span style="color:#FF0000;"><ServiceGroup>/ServeName/<devID>/Info/SmartML</span>",<br/> "sv":"<span style="color:#FF0000;"><xml></span>",<br/> "StatusCode":<span style="color:#FF0000;">200</span><br/> }<br/> ]<br/> }<br/> }<br/>} | ||
== EventNotify == | == EventNotify == | ||
| Line 296: | Line 126: | ||
*Direction: Agent -> Server | *Direction: Agent -> Server | ||
*Topic: /cagent/admin/<devID>/eventnotify | *Topic: /cagent/admin/<devID>/eventnotify | ||
| − | *QoS: | + | *QoS: 0 |
| − | *Retained: | + | *Retained: 0 |
*Payload: | *Payload: | ||
| − | < | + | |
| − | + | { <br/> "susiCommData":{ <br/> "commCmd":2059,<br/> "requestID":2001,<br/> "agentID":"0005000E40000001",<br/> "handlerName":"general",<br/> "sendTS":1453356274,<br/> "eventnotify":{ <br/> "subtype":"predictError", #predictError/predictInfo<br/> "msg":"HDD smart 5 over the threshold",<br/> "severity":2,<br/> "handler":"MsgGen",<br/> "extMsg":{<br/> "predictMsg":{<br/> "health":"Sick",<br/> "suggestion1":"Please back up your HDD data. The HDD has the probability to break down in 30 days.",<br/> "deviceName":"ST9250315AS"<br/> },<br/> "alertMsg":{<br/> "warning":"Yes",<br/> "suggestion1":"Please lower the environment temperature under 40C.",<br/> "suggestion2":"Please make sure the cooling system is working properly.",<br/> "deviceName":"ST9250315AS"<br/> }<br/> }<br/> }<br/> }<br/>} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | ||
| − | | ||
| − | | ||
| − | | ||
| − | | ||
| − | | ||
| − | | ||
| − | |||
| − | |||
| − | }</ | ||
| Line 339: | Line 143: | ||
subtype: | subtype: | ||
| − | + | THRESHOLD_CHECK_INFO | |
| − | + | THRESHOLD_CHECK_ERROR | |
| − | + | </pre> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 09:49, 25 April 2017
Contents
Overview
- Introduction for "WISE-Snail communication protocol for EIS Service". WISEAgent communication protocol is base on standard MQTT protocol. We also define Advantech IoT Topic and message in JSON format. Follow standard to design our [Sensor Format in JSON ]
Protocol
Connect
- Description: Agent Client sends the "Connect Info" to RMM Server for on-line notification.
- Type: Info
- Direction: Agent -> Server
- Topic: /cagent/admin/<devID>/agentinfoack
- QoS: 2
- Retained: 0
- Payload:
{
"susiCommData": {
"devID":"0005000E40000001", // User Define, NULL-> Auto UUID-like devID
"hostname":"WISE-1520+(devID4)", // The same with Handler Name
"sn":"0005000E40000001",
"mac":"0005000E40000001",
"version":"3.1.23",
"type":"Service", // Fixed: Service
"product":"<ServiceGroup>",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0005000E40000001", // the same with devID
"handlerName":"general",
"sendTS":160081026
}
}
"susiCommData": {
"devID":"0005000E40000001", // User Define, NULL-> Auto UUID-like devID
"hostname":"WISE-1520+(devID4)", // The same with Handler Name
"sn":"0005000E40000001",
"mac":"0005000E40000001",
"version":"3.1.23",
"type":"Service", // Fixed: Service
"product":"<ServiceGroup>",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0005000E40000001", // the same with devID
"handlerName":"general",
"sendTS":160081026
}
}
OS Info
- Description: Agent Client sends the OS Info" to RMM Server for device OS information.
- Type: Info
- Direction: Agent -> Server
- Topic: /cagent/admin/<devID>/agentactionreq
- QoS: 0
- Retained: 0
- Payload:
{
"susiCommData":{
"osInfo":
{
"cagentVersion":"3.1.23", // Service version for user define
"cagentType":"Service", // fixed
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"Snail", // different to SnailGW
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF", // uuid
"IP":"" // "null"
},
"commCmd":116,
"requestID":109,
"agentID":"0005000E40000001",
"handlerName":"general",
"sendTS":1466730390
}
}
Disconnect
- Description: Agent Client sends the "Disconnect Info" to Server for off-line notification.
- Type: Info
- Direction: Agent -> Server
- Topic: /cagent/admin/<devID>/agentinfoack
- QoS: 2
- Retained: 0
- Payload:
{
"susiCommData": {
"devID":"0005000E40000001",
"hostname":"WISE-1520+(devID4)",
"sn":"0005000E40000001",
"mac":"0005000E40000001",
"version":"3.1.23",
"type":"Service",
"product":"",
"manufacture":"",
"status":"0",
"commCmd":1,
"requestID":30002,
"agentID":"0005000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}
Info or Update Service's Capability
- Description: Agent will send it's capability to Server for description all resource.
- Type: Auto update
- Direction: Agent-> Server
- Topic: /cagent/admin/<devID>/agentactionreq
- QoS: 0
- Retained: 0
- Payload:
Example: Service's Capability
{
"susiCommData":{
"infoSpec": {
"<ServiceGroup>": {
"<ServeName>":{
"ServeName0":{
"Info": { "e": [ {"n":"Temperature","u":"Cel","v":0.000000,"min":-100},
{"n":"Humidity","u":"%","v":0.000000,"min":0.000000,"max":100.000000,"asm":"r","type":"d","rt":"ucum.%","st":"ipso","exten":""},
{"n":"SmartML", "sv":"<xml>", "asm":"rw", "format":"xml", "encoding":"base64"},
{"n":"SmartData", "sv":"<json>", "asm":"r", "format":"json", "encoding":"base64"}
]
},
"bn":"Info"
},
"bn":"0005000E40000001" // => uuid
},
"bn":"<ServeName>"
}
},
"commCmd":2052,
"requestID":2001,
"agentID":"0005000E40000001",
"handlerName":"general",
"sendTS":160081024
}
}
Auto Update Sensor Data Value
- Description: Agent will update latest value to server.
- Type: Auto update
- Direction: Agent-> Server
- Topic: /cagent/admin/<devID>/deviceinfo
- QoS: 0
- Retained: 0
- Payload:
{
"susiCommData":{
"data":{
"<ServiceGroup>":{
"<ServeName>":{
"ServeName0": {
"Info":{
"e":[ {"n":"SmartData", "sv":"<json>"}],
"bn":"Info"
},
"bn":"0005000E40000001"
},
"bn":"<ServeName>"
},
"bn":"<ServiceName>"
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0005000E40000001",
"handlerName":"general",
"sendTS":160081031
}
}
Get Sensor Data
- Description: Server can send mqtt message to get sensor data value.
- Type: Request
- Direction: Server -> Agent
- Topic: /cagent/admin/<devID>/agentcallbackreq
- QoS: 0
- Retained: 0
- Payload:
{
"susiCommData":{
"sessionID":"2746E3B65BAB115338B9668CDC5C35C4",
"sensorIDList":{
"e":[
{
"n":"ServiceGroup/ServeName/devID/Info/SmartML"
}
]
},
"commCmd":523,
"requestID":0,
"agentID":"",
"handlerName":"Service",
"sendTS":1466057267
}
}
- Description: Agent will reply its data value.
- Type: Reply
- Direction: Agent -> Server
- Topic: /cagent/admin/<devID>/agentactionreq
- QoS: 0
- Retained: 0
- Payload:
{
"susiCommData":{
"commCmd":524,
"handlerName":"<ServiceGroup>",
"sessionID":"2746E3B65BAB115338B9668CDC5C35C4",
"sensorInfoList":{
"e":[
{
"n":"ServiceGroup/ServeName/devID/Info/SmartML",
"sv":"<xml>",
"StatusCode":200
}
]
}
}
}
Set Sensor Data
- Description: Server can send mqtt message to set sensor data value.
- Type: Request
- Direction: Server -> Agent
- Topic: /cagent/admin/<devID>/agentcallbackreq
- QoS: 0
- Retained: 0
- Payload:
{
"susiCommData":{
"sessionID":"4DDF0B6DE2773176095F55E8C930507A",
"commCmd":525,
"requestID":0,
"agentID":"",
"handlerName":"Service", // Fixed name for wisesnail parse rule
"sendTS":1466088605
"sensorIDList":{
"e":[
{
"sv":"<xml>",
"n":"ServiceGroup/ServeName/devID/Info/SmartML"
}
]
}
}
}
- Description: Agent will reply accept this command
- Type: Reply
- Direction: Agent -> Server
- Topic: /cagent/admin/<devID>/agentactionreq
- QoS: 0
- Retained: 0
- Payload:
{
"susiCommData":{
"commCmd":526,
"handlerName":"Service",
"sessionID":"4DDF0B6DE2773176095F55E8C930507A",
"sensorInfoList":{
"e":[
{
"n":"<ServiceGroup>/ServeName/<devID>/Info/SmartML",
"StatusCode":202
}
]
}
}
}
- Description: Agent will reply its result.
- Type: Reply
- Direction: Agent -> Server
- Topic: /cagent/admin/<devID>/agentactionreq
- QoS: 0
- Retained: 0
- Payload:
{
"susiCommData":{
"commCmd":526,
"handlerName":"Service",
"sessionID":"4DDF0B6DE2773176095F55E8C930507A",
"sensorInfoList":{
"e":[
{
"n":"<ServiceGroup>/ServeName/<devID>/Info/SmartML",
"sv":"<xml>",
"StatusCode":200
}
]
}
}
}
EventNotify
- Description:
- Type: Auto update
- Direction: Agent -> Server
- Topic: /cagent/admin/<devID>/eventnotify
- QoS: 0
- Retained: 0
- Payload:
{
"susiCommData":{
"commCmd":2059,
"requestID":2001,
"agentID":"0005000E40000001",
"handlerName":"general",
"sendTS":1453356274,
"eventnotify":{
"subtype":"predictError", #predictError/predictInfo
"msg":"HDD smart 5 over the threshold",
"severity":2,
"handler":"MsgGen",
"extMsg":{
"predictMsg":{
"health":"Sick",
"suggestion1":"Please back up your HDD data. The HDD has the probability to break down in 30 days.",
"deviceName":"ST9250315AS"
},
"alertMsg":{
"warning":"Yes",
"suggestion1":"Please lower the environment temperature under 40C.",
"suggestion2":"Please make sure the cooling system is working properly.",
"deviceName":"ST9250315AS"
}
}
}
}
}
severity:
Severity_Emergency = 0,
Severity_Alert = 1,
Severity_Critical = 2,
Severity_Error = 3,
Severity_Warning = 4,
Severity_Informational = 5,
Severity_Debug = 6,
subtype:
THRESHOLD_CHECK_INFO
THRESHOLD_CHECK_ERROR