ESS-WIKI - User contributions [en]

Connectivity/AdvHeartBeat

2016-08-01T09:36:35Z

Winston: /* Client Site - Check by Sefl */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Overview of Testing==
[[File:ConnectionReliability Testing Env.jpg|800x600px|Overview of Testing]]
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Self==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

==Node-Red for Test Case==
[[Media:SendDisconnectMsg.txt|Send Disconnect Msg]] 

[[Media:HB DropMsg.txt|Drop Connect / Disconnect / AdvHeartBeat Msg]] 

[[Media:HB CheckVersion.txt|Check version of Agent]] 

[[Media:HB CheckPeriod.txt|Check period of AdvHeartBeat rate]] 

[[Media:HB Get Set Param Re-Connect Get Capability.txt|Get / Set AdvHeartBeat Params Get Capability, Re-Connect]] 

==Test Result==
[[Media:Connection Reliability v1 Test Result20160801.xlsx|V1 Test Result 20160801 Excel]] 

[[File:ConnectionReliability v1 Test result.jpg|800x600px|Test result of v1]]

Connectivity/AdvHeartBeat

2016-08-01T08:52:18Z

Winston: /* Test Case */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Overview of Testing==
[[File:ConnectionReliability Testing Env.jpg|800x600px|Overview of Testing]]
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

==Node-Red for Test Case==
[[Media:SendDisconnectMsg.txt|Send Disconnect Msg]] 

[[Media:HB DropMsg.txt|Drop Connect / Disconnect / AdvHeartBeat Msg]] 

[[Media:HB CheckVersion.txt|Check version of Agent]] 

[[Media:HB CheckPeriod.txt|Check period of AdvHeartBeat rate]] 

[[Media:HB Get Set Param Re-Connect Get Capability.txt|Get / Set AdvHeartBeat Params Get Capability, Re-Connect]] 

==Test Result==
[[Media:Connection Reliability v1 Test Result20160801.xlsx|V1 Test Result 20160801 Excel]] 

[[File:ConnectionReliability v1 Test result.jpg|800x600px|Test result of v1]]

Connectivity/AdvHeartBeat

2016-08-01T08:51:22Z

Winston: /* Node-Red flow for Test Case */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Overview of Testing==
[[File:ConnectionReliability Testing Env.jpg|800x600px|Overview of Testing]]
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

==Node-Red flow for Test Case==
[[Media:SendDisconnectMsg.txt|Send Disconnect Msg]] 

[[Media:HB DropMsg.txt|Drop Connect / Disconnect / AdvHeartBeat Msg]] 

[[Media:HB CheckVersion.txt|Check version of Agent]] 

[[Media:HB CheckPeriod.txt|Check period of AdvHeartBeat rate]] 

[[Media:HB Get Set Param Re-Connect Get Capability.txt|Get / Set AdvHeartBeat Params Get Capability, Re-Connect]] 

==Test Result==
[[Media:Connection Reliability v1 Test Result20160801.xlsx|V1 Test Result 20160801 Excel]] 

[[File:ConnectionReliability v1 Test result.jpg|800x600px|Test result of v1]]

Connectivity/AdvHeartBeat

2016-08-01T08:50:58Z

File:HB SendDisconnectMsg.txt

2016-08-01T08:42:54Z

Winston:

Connectivity/AdvHeartBeat

2016-08-01T08:42:38Z

Winston: /* Test Result */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Overview of Testing==
[[File:ConnectionReliability Testing Env.jpg|800x600px|Overview of Testing]]
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

===Test Result===
[[Media:Connection Reliability v1 Test Result20160801.xlsx|V1 Test Result 20160801 Excel]] 

[[File:ConnectionReliability v1 Test result.jpg|800x600px|Test result of v1]]

Connectivity/AdvHeartBeat

2016-08-01T08:42:00Z

Winston: /* Integration Test */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Overview of Testing==
[[File:ConnectionReliability Testing Env.jpg|800x600px|Overview of Testing]]
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

===Test Result===
[[Medai:Connection Reliability v1 Test Result20160801.xlsx|V1 Test Result 20160801 Excel]] 

[[File:ConnectionReliability v1 Test result.jpg|800x600px|Test result of v1]]

File:ConnectionReliability v1 Test result.jpg

2016-08-01T08:39:52Z

Winston:

File:Connection Reliability v1 Test Result20160801.xlsx

2016-08-01T08:38:33Z

Winston:

Connectivity/AdvHeartBeat

2016-08-01T08:36:38Z

Winston: /* Test Case */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Overview of Testing==
[[File:ConnectionReliability Testing Env.jpg|800x600px|Overview of Testing]]
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

Connectivity/AdvHeartBeat

2016-08-01T08:35:32Z

Winston: /* Test Case */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Overview of Testing==
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

File:ConnectionReliability Testing Env.jpg

2016-08-01T08:34:22Z

Winston:

Connectivity/AdvHeartBeat

2016-08-01T07:10:49Z

Winston: /* Network Environment */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

MI3.1 Standard Image V1.0.1 Porting SOP

2016-07-29T01:23:36Z

Winston: /* For Quark Memeory Configuration */

=Prepare=
#Ubuntu 14.04 x64 develop host installed with MI3.1 WindRiver workbench
#4GB USB Flash
#Porting Target ( ex: UTX-3115 )

=SOP for Porting=
#MI3.1_Pro_Config_V1.sh barytail 0014
#make fs
#sudo ./deploy.sh -u -f ./export/intel -d /dev/sdx -y; sync
#Insert Target platform and boot up -> root/root
#copy modem_cell_default to /etc/.
#copy usb-modem.sh to /
#copy ar3k.zip to /lib/firmware/ & unzip ar3k.zip
#RD Verify & HW Functional Test
#sudo dd if=/dev/sdm of=./IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img bs=4M; sync
#md5sum IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img > IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img.md5
#gzip IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img
#md5sum IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img.gz > IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img.gz.md5

=Double Confirm=
#gunzip IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img
#dd if=./IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img of=/dev/sdx bs=4M; sync
#Insert Target platform and boot up

=Note=
== BIOS Setting for Baytrail and Haswell platforms ==
#BIOS -> Advanced / Miscellaneous Configuration / OS Selection -> Windows 8.X
#MI3.1 image needs boot from UEFI mode => Boot / Boot mode select [UEFI]
#If user want to support Secure boot => Please disable CSM and enable Secure boot in BIOS setting.

==For Quark Memeory Configuration==
./layers/wr-bsps/intel-quark/recipes-support/spi-layout-tools/files/platform-data/clantonhill-platform-data.ini 

This spi flash binary without ini configuration 

./bitbake_build/tmp/work/x86_64-linux/spi-layout-tools/1.2.0-r0/spi-flash-tools_v1.2.0/sysimage-clantonhill/Flash-missingPDAT.bin

MI3.1 Standard Image V1.0.1 Porting SOP

2016-07-28T05:27:23Z

Winston: /* For Quark Memeory Configuration */

=Prepare=
#Ubuntu 14.04 x64 develop host installed with MI3.1 WindRiver workbench
#4GB USB Flash
#Porting Target ( ex: UTX-3115 )

=SOP for Porting=
#MI3.1_Pro_Config_V1.sh barytail 0014
#make fs
#sudo ./deploy.sh -u -f ./export/intel -d /dev/sdx -y; sync
#Insert Target platform and boot up -> root/root
#copy modem_cell_default to /etc/.
#copy usb-modem.sh to /
#copy ar3k.zip to /lib/firmware/ & unzip ar3k.zip
#RD Verify & HW Functional Test
#sudo dd if=/dev/sdm of=./IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img bs=4M; sync
#md5sum IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img > IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img.md5
#gzip IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img
#md5sum IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img.gz > IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img.gz.md5

=Double Confirm=
#gunzip IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img
#dd if=./IDP_MI3.1_7.0.0.14_x64_ARK-1123H_V1.0.1_20160530.img of=/dev/sdx bs=4M; sync
#Insert Target platform and boot up

=Note=
== BIOS Setting for Baytrail and Haswell platforms ==
#BIOS -> Advanced / Miscellaneous Configuration / OS Selection -> Windows 8.X
#MI3.1 image needs boot from UEFI mode => Boot / Boot mode select [UEFI]
#If user want to support Secure boot => Please disable CSM and enable Secure boot in BIOS setting.

==For Quark Memeory Configuration==
./layers/wr-bsps/intel-quark/recipes-support/spi-layout-tools/files/platform-data/clantonhill-platform-data.ini
This spi flash binary without ini configuration
./bitbake_build/tmp/work/x86_64-linux/spi-layout-tools/1.2.0-r0/spi-flash-tools_v1.2.0/sysimage-clantonhill/Flash-missingPDAT.bin

IDP Documentation

2016-07-27T03:48:49Z

Winston: /* Secure */

=IDP2.0=
*[[Media:Wr linux release notes 5.0.1.pdf|<big><big>WR Linux Release Note 5.0.1 - ( list down the pkg name )</big></big>]]
*[[Media:WRU WCP IDP Quick Start Guide.pdf|<big><big>WRU WCP IDP Quick Start Guide.pdf</big></big>]]
*[[Media:BlacksBeach_GetStarted_Rev1_0.pdf|<big><big>IDP2.0 Early Access Get Started Guide</big></big>]]
*[[Media:03 03 LxPlatformDevelopment WorkingWithUserDefinedProjects.pdf|<big><big>''03 03 LxPlatformDevelopment WorkingWithUserDefinedProjects.pdf''</big></big>]]
*[[Media:05 01 LxPlatformDevelopment BuildingAndCustomizingPlatform.pdf|<big><big>''05 01 LxPlatformDevelopment BuildingAndCustomizingPlatform.pdf''</big></big>]]
*[[Media:07 03 LxPlatformDevelopment WorkingWithKernelModules.pdf|<big><big>''07 03 LxPlatformDevelopment WorkingWithKernelModules.pdf''</big></big>]]
*[[Media:08 02 LxPlatformDevelopment CreatingLayers.pdf|<big><big>''08 02 LxPlatformDevelopment CreatingLayers.pdf''</big></big>]]

=IDP3.0=
*[[Media:540625 10923 8 Intel IoT Gateway GoldDeck 081015 ext.pdf|''<big>Intel IoT Gateway GoldDeck</big>'']] 
*[[Media:Introduction of IDP3.0.pptx|''<big>Introduction of IDP3.0.pptx - by Advantech Eric</big>'']] 
*[[Media:IoT_Gateway_IDP_XT_GSG.pdf ?|<big><big>''IDP 3.0 Quick Start Guide.pdf''</big></big>]]

=IDP3.1=
*[[Media:Intel IoT Gateway Wind River GoldDeck January16 ext.pdf|'''<big>IDP3.1 Introduction GoldDeck 20160116 PDF</big>''']]
*[http://www.intel.com/content/www/us/en/embedded/solutions/iot-gateway/training/iot-gateway-training-overview.html '''<big>Intel on line Tranning and Documentation</big>''']
*[https://software.intel.com/en-us/iot/hardware/gateways <big><big>'''On-line Docs for MI3.1'''</big></big>]
*[https://software.intel.com/en-us/Setup-IDP-DevelopmentTools <big><big>'''IDP XT 3.1 Getting Started Guide'''</big></big>]
*[[Media:Wr_intelligent_device_platform_xt_programmers_guide_31.pdf| <big><big>'''IDP XT3.1 Programmers Guide'''</big></big>]]
*[[Media:Iot-platform-marketplace-guide.pdf|'''<big><big>IoT Platform Marketplace User Guide</big></big>''']]
*[[IDP/MI3.1/Information|'''<big><big>MI3.1 Information</big></big>''']]
*[[Media:SOP_of_Intel_Customer.docx|'''<big><big>SOP_of_Intel_Customer.docx</big></big>''']]

=Kernel Driver=
*[[Media:Wr_linux_kernel_command_line_tutorials_70.pdf| <big><big>'''WR Linux Kernel command line Tutorials'''</big></big>]]

=Connectivity=
*[[Media:WRU_WCP_IDP_IoT_20XT_02_01_IDP_Architecture_Connectivity.pdf|<big><big>''IDP_Architecture_Connectivity''</big></big>]]

=Application=
*[[Media:WRU_WCP_IDP_IoT_20XT_07_01_IDP_ApplicationStacks.pdf|<big><big>''IDP_ApplicationStacks''</big></big>]]

=Secure=
*[[Media:547808 547808 Intel Gateway for the IoT DK300 Secure Boot Users Guide.pdf|<big><big>''Secure Boot Usr Guide''</big></big>]]
*[[Media:TPM Operations.pdf|<big><big>''TPM Operation on UTX-3115''</big></big>]]

=Trianing=
=IDP2.x=
*[[IDP2.0 Training-20141107|IDP2.0 Training by Wind River-20141107]]
*[[Media:IDP2 20140326 Wind River.pptx|<big>IDP2 20140326 Wind River.pptx</big>]]

==IDP3.0==
*[[Media:MI 3.0 Workshop Foils.zip ?|<big><big>''IDP3.x workshop by Intel/WR in 2015-9-30~10-1''</big></big>]]

=Qualification=
==IDP2.x==
*[[Media:557818 Diagnostic Tool FINAL.PDF|<big>IDP Diagnostic Tool-2015-10</big>]]
*[[Media:Idp-xt-validation-plan_2.0.pdf |<big>Idp-xt-validation-plan_2.0.pdf - by Wind River</big>]]

==IDP3.0==
*[[Media:561994 Intel IoT Gateway Diagnostic Tool.pdf|<big>IDP Diagnostic Tool-2015-11</big>]]
*[[Media:562720 Diagnostic Tool Errata.pdf|<big>Diagnostic_Tool_Errata-2015-11</big>]]

==IDP3.1==

=Intel/Wind River Official Web Site=
*[https://businessportal.intel.com/irj/portal '''<big>Intel IPS system</big>''']
*[https://shopiotmarketplace.com/iot/index.html#/parts '''<big>Intel Marketplace for MI3.1</big>''']
*[https://customercare.intel.com/ '''<big>Intel New Customer Service for MI3.1 -2016 04</big>''']
*[https://windshare.windriver.com/index.php/apps/windriver/ '''<big>WindShare by WindRiver</big>''']
*[http://windriver.mrooms.net/my/ '''<big>On-line Course by Wind River</big>''']

=Support Component List=
==IDP3.x==
*[[Media:551116_551116_Component_List_Final.pdf|<big>IDP3.0 Component List- August 2015</big>]]

=Advantech=
*[[Media:IDP BSP Porting Application Form.xlsx|<big>IDP Image Porting Application Form</big>]]
*[[Media:IDP Issue Request Form.xlsx|<big>IDP Issue Request Form</big>]]
*[[Media:WRLinux5-HW-Drivers.xlsx|<big>IDP2.0 Driver List</big>]]

=Tools=
==[[x86 System Tool|x86 System Tool]]==

File:TPM Operations.pdf

2016-07-27T03:48:23Z

Winston: Eric uploaded a new version of File:TPM Operations.pdf

File:547808 547808 Intel Gateway for the IoT DK300 Secure Boot Users Guide.pdf

2016-07-27T03:48:12Z

Winston: Eric uploaded a new version of File:547808 547808 Intel Gateway for the IoT DK300 Secure Boot Users Guide.pdf

IDP Build & Deploy Image

2016-07-26T07:40:29Z

Winston: /* Copy Gateway OS to USB Flash Drive */

=Build an IDP OS by WR Workbench=
1. Go to the $HOME/Project directory on your Development Computer:
cd $HOME/Project
:1.1 Source WRLinux Enviroment
For MI2.0
./wrenv.sh -p wrlinux-5
For MI3.x
./wrenv.sh -p wrlinux-7

2. Define your Gateway options by coping and pasting the configure command 
:'''MI3.1 Configure for Intel Atom processor'''
../../wrlinux-7/wrlinux/configure --enable-addons=wr-idp --enable-board=intel-baytrail-64 --enable-bootimage=ext3,hdd --enable-internet-download=yes --enable-kernel=idp --enable-patchresolve=noop --enable-reconfig --enable-rootfs=idp --enable-test=no --with-layer=dev-experience,dev_hub,sys-version,wr-hac,wr-hdc-examples,wr-iot,wr-kernel/kernel-dev,wr-ma,wr-mcafee,wr-prosyst-mbs-smarthome-sdk-ia,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069 --with-package=autoconf,automake,conntrack-tools,curl,fuse,gdb,git,iasl,igmpproxy,iperf,ipset,less,libcli,libtool,make,mipv6-daemon-umip,netcat,ntfs-3g,ntfsprogs,perl,ruby,screen,sshfs-fuse,subversion,swig,tcpdump,tftp-hpa,tftp-hpa-server,vim --with-template=feature/backports,feature/bluetooth,feature/ems-test,feature/haccmds,feature/ipsec_vpn,feature/non-grsec,feature/online_updates,feature/openjdk-bin,feature/pptp_vpn,feature/recovery,feature/remote-session,feature/self-hosted,feature/target-toolchain,feature/vlan

:'''MI3.1 Configure for Intel Haswell processor'''
../../wrlinux-7/wrlinux/configure --enable-addons=wr-idp --enable-board=intel-haswell-64 --enable-bootimage=ext3,hdd --enable-internet-download=yes --enable-kernel=idp --enable-patchresolve=noop --enable-reconfig --enable-rootfs=idp --enable-test=no --with-layer=dev-experience,dev_hub,sys-version,wr-hac,wr-hdc-examples,wr-iot,wr-kernel/kernel-dev,wr-ma,wr-mcafee,wr-prosyst-mbs-smarthome-sdk-ia,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069 --with-package=autoconf,automake,conntrack-tools,curl,fuse,gdb,git,iasl,igmpproxy,iperf,ipset,less,libcli,libtool,make,mipv6-daemon-umip,netcat,ntfs-3g,ntfsprogs,perl,ruby,screen,sshfs-fuse,subversion,swig,tcpdump,tftp-hpa,tftp-hpa-server,vim --with-template=feature/backports,feature/bluetooth,feature/ems-test,feature/haccmds,feature/ipsec_vpn,feature/non-grsec,feature/online_updates,feature/openjdk-bin,feature/pptp_vpn,feature/recovery,feature/remote-session,feature/self-hosted,feature/target-toolchain,feature/vlan

:'''MI3.1 Configure for Intel Quark processor'''
../../wrlinux-7/wrlinux/configure --enable-addons=wr-idp --enable-board=intel-quark --enable-bootimage=ext3,hdd --enable-internet-download=yes --enable-kernel=idp --enable-patchresolve=noop --enable-reconfig --enable-rootfs=idp --enable-test=no --with-layer=dev-experience,dev_hub,sys-version,wr-hac,wr-hdc-examples,wr-iot,wr-kernel/kernel-dev,wr-ma,wr-mcafee,wr-prosyst-mbs-smarthome-sdk-ia,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069 --with-package=autoconf,automake,conntrack-tools,curl,fuse,gdb,git,iasl,igmpproxy,iperf,ipset,less,libcli,libtool,make,mipv6-daemon-umip,netcat,ntfs-3g,ntfsprogs,perl,ruby,screen,sshfs-fuse,subversion,swig,tcpdump,tftp-hpa,tftp-hpa-server,vim --with-template=feature/backports,feature/bluetooth,feature/ems-test,feature/haccmds,feature/ipsec_vpn,feature/non-grsec,feature/online_updates,feature/openjdk-bin,feature/pptp_vpn,feature/recovery,feature/remote-session,feature/self-hosted,feature/target-toolchain,feature/vlan

:'''MI3.0 Configure for Intel Atom processor'''
../WindRiver/wrlinux-7/wrlinux/configure --enable-board=intel-baytrail-64 --enable-kernel=idp --enable-bootimage=ext3,hdd --enable-patchresolve=noop --enablerootfs=idp \
--enable-addons=wr-idp --with-layer=wr-prosyst-mbs-smarthome-sdk-ia,wrdigi-idigiconnector,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069,\
sysversion,wr-iot --with-template=feature/vlan,feature/opc,feature/recovery,feature/opc_demo,feature/ipsec_vpn,feature/l2tp,feature/realtek, \
feature/ems-test,feature/remote-session,feature/openjdk-bin,feature/online_updates,feature/bluetooth,feature/pptp_vpn,feature/target-toolchain \
--withpackage=make,git,iasl,libtool,perl,ruby,subversion,autoconf,automake,curl,conntrack-tools,fuse,igmpproxy,iperf,ipset,libcli,mipv6-daemonumip,\
ntfs-3g,ntfsprogs,sshfs-fuse,tftp-hpa,tftp-hpa-server,tcpdump,vim

:'''MI3.0 Configure for Intel Core processor'''
../WindRiver/wrlinux-7/wrlinux/configure --enable-board=intel-haswell-64 --enable-kernel=idp --enable-bootimage=ext3,hdd --enable-patchresolve=noop --enablerootfs=idp \
--enable-addons=wr-idp --with-layer=wr-prosyst-mbs-smarthome-sdk-ia,wrdigi-idigiconnector,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069,\
sysversion,wr-iot --with-template=feature/vlan,feature/opc,feature/recovery,feature/opc_demo,feature/ipsec_vpn,feature/l2tp,feature/realtek, \
feature/ems-test,feature/remote-session,feature/openjdk-bin,feature/online_updates,feature/bluetooth,feature/pptp_vpn,feature/target-toolchain \
--withpackage=make,git,iasl,libtool,perl,ruby,subversion,autoconf,automake,curl,conntrack-tools,fuse,igmpproxy,iperf,ipset,libcli,mipv6-daemonumip,\
ntfs-3g,ntfsprogs,sshfs-fuse,tftp-hpa,tftp-hpa-server,tcpdump,vim

:'''MI2.0 Configure for Intel Atom processor'''
$WIND_LINUX_CONFIGURE --enable-board=intel-atom-baytrail --enable-kernel=standard --enable-rootfs=glibc-idp --enable-addons=wr-idp --enable-bootimage=ext3,hdd --enable-parallel-pkgbuilds=4 --enable-jobs=6 --enable-reconfig --
enable-rm-oldimgs=yes --enable-rm-work=yes --without-layer=wr-srm --with-layer=wr-intel-support,wr-mcafee,wr-wks-oneagent-tr069,wr-ieee11073,wr-mcafee,wr-wks-oneagent-oma-dm-ia,wr-intel-support --with-
template=feature/online_updates,feature/recovery,feature/pptp_vpn,feature/pppoe,feature/upnp,feature/opc,feature/openjdk-bin,
feature/ipsec_vpn,feature/mqtt,feature/l2tp,feature/webif,feature/firewall,feature/vlan,feature/intel-wilkinpeak2,feature/bluetooth --with-rcpl-version=17

3. Build the IDP
make fs
4. The config.log created in $HOME/Project is an exact copy of the configure options used to build the Gateway OS. Save this as config.sh for future development projects:
cp config.log config.sh
5. Continue to Copy Gateway OS to USB Flash Drive. 
'''Note:''' Remove grsecurity to experiment with application development. Refer to [[IDP Build IDP Without Grsecurity]]
:Grsecurity is included in the Linux kernel by default. This feature can inhibit exploration by preventing your apps from working. 
:Disable grsecurity while you experiement with your Gateway. When you are ready to build a production-ready Gateway, consider re-enabling grsecurity

=Kernel Driver Menu Config=
'''$make -C build linux-windriver.menuconfig'''
'''$make -C build linux-windriver.rebuild'''
Note: 1.Type "/" to search key word
2.To select be installed driver or function
For example: Ath9k wifi module driver

=Copy Gateway OS to USB Flash Drive=

1. Insert the USB flash drive into your Development Computer 
2. ls /dv/sd? 
3. cd $HOME/workspace/<YourProjectDirectory_prj> 
4. Deploy the image to USB flash drive. Note: The deploy process takes about 15 minutes. 
'''For Atom processor'''
sudo ./deploy.sh -u -f export/intel-baytrail-64-idp-idp-dist.tar.bz2 -d /dev/sdx -y; sync

'''For Intel Core processor'''
sudo ./deploy.sh -u -f export/intel-haswell-64-idp-idp-dist.tar.bz2 -d /dev/sdx -y; sync

'''For Quark processor'''
sudo ./deploytool -f export/intel-quark-idp-idp-dist.tar.bz2 -d /dev/sdX -y -u -B 1; sync

5. Type your Linux password if prompted and click OK. The bootable USB drive is created when you see DONE!
6. Remove and reinsert into your Development Computer. The flash drive mounts with two partitions, one of which is /media/<username>/wr_usb_boot
7. Copy image to the flash drive
'''For Atom processor'''
sudo cp export/intel-baytrail-64-idp-idp-dist.tar.bz2 /media/<username>/wr_usb_boot/opt/; sync

'''For Intel Core processor'''
sudo cp export/intel-haswell-64-idp-idp-dist.tar.bz2 /media/<username>/wr_usb_boot/opt/; sync

'''For MI3.1'''
sudo cp export/intel-baytrail-64-idp-idp-dist.tar.bz2 /media/<username>/efi/SFR/; sync
8. Remove the USB flash drive from your Development Computer

=Install the OS on the Gateway=
1. Insert the USB to Gateway and power on. Login using "root" for the login ID and password. 
2. Install the OS:
tgt=/dev/sda /sbin/reset_media
3. Installation is complete when you see the message "DONE!" Shut down the Gateway
poweroff
4. Remove the USB flash drive and power up your Gateway
5. Login using "root" for both the login ID and password. The OS installation is complete.

=[[IDP/Advantech/Standard BSP|MI3.1 Advantech Standard BSP by ECG]]=

IDP Build & Deploy Image

2016-07-25T05:47:46Z

Winston:

=Build an IDP OS by WR Workbench=
1. Go to the $HOME/Project directory on your Development Computer:
cd $HOME/Project
:1.1 Source WRLinux Enviroment
For MI2.0
./wrenv.sh -p wrlinux-5
For MI3.x
./wrenv.sh -p wrlinux-7

2. Define your Gateway options by coping and pasting the configure command 
:'''MI3.1 Configure for Intel Atom processor'''
../../wrlinux-7/wrlinux/configure --enable-addons=wr-idp --enable-board=intel-baytrail-64 --enable-bootimage=ext3,hdd --enable-internet-download=yes --enable-kernel=idp --enable-patchresolve=noop --enable-reconfig --enable-rootfs=idp --enable-test=no --with-layer=dev-experience,dev_hub,sys-version,wr-hac,wr-hdc-examples,wr-iot,wr-kernel/kernel-dev,wr-ma,wr-mcafee,wr-prosyst-mbs-smarthome-sdk-ia,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069 --with-package=autoconf,automake,conntrack-tools,curl,fuse,gdb,git,iasl,igmpproxy,iperf,ipset,less,libcli,libtool,make,mipv6-daemon-umip,netcat,ntfs-3g,ntfsprogs,perl,ruby,screen,sshfs-fuse,subversion,swig,tcpdump,tftp-hpa,tftp-hpa-server,vim --with-template=feature/backports,feature/bluetooth,feature/ems-test,feature/haccmds,feature/ipsec_vpn,feature/non-grsec,feature/online_updates,feature/openjdk-bin,feature/pptp_vpn,feature/recovery,feature/remote-session,feature/self-hosted,feature/target-toolchain,feature/vlan

:'''MI3.1 Configure for Intel Haswell processor'''
../../wrlinux-7/wrlinux/configure --enable-addons=wr-idp --enable-board=intel-haswell-64 --enable-bootimage=ext3,hdd --enable-internet-download=yes --enable-kernel=idp --enable-patchresolve=noop --enable-reconfig --enable-rootfs=idp --enable-test=no --with-layer=dev-experience,dev_hub,sys-version,wr-hac,wr-hdc-examples,wr-iot,wr-kernel/kernel-dev,wr-ma,wr-mcafee,wr-prosyst-mbs-smarthome-sdk-ia,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069 --with-package=autoconf,automake,conntrack-tools,curl,fuse,gdb,git,iasl,igmpproxy,iperf,ipset,less,libcli,libtool,make,mipv6-daemon-umip,netcat,ntfs-3g,ntfsprogs,perl,ruby,screen,sshfs-fuse,subversion,swig,tcpdump,tftp-hpa,tftp-hpa-server,vim --with-template=feature/backports,feature/bluetooth,feature/ems-test,feature/haccmds,feature/ipsec_vpn,feature/non-grsec,feature/online_updates,feature/openjdk-bin,feature/pptp_vpn,feature/recovery,feature/remote-session,feature/self-hosted,feature/target-toolchain,feature/vlan

:'''MI3.1 Configure for Intel Quark processor'''
../../wrlinux-7/wrlinux/configure --enable-addons=wr-idp --enable-board=intel-quark --enable-bootimage=ext3,hdd --enable-internet-download=yes --enable-kernel=idp --enable-patchresolve=noop --enable-reconfig --enable-rootfs=idp --enable-test=no --with-layer=dev-experience,dev_hub,sys-version,wr-hac,wr-hdc-examples,wr-iot,wr-kernel/kernel-dev,wr-ma,wr-mcafee,wr-prosyst-mbs-smarthome-sdk-ia,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069 --with-package=autoconf,automake,conntrack-tools,curl,fuse,gdb,git,iasl,igmpproxy,iperf,ipset,less,libcli,libtool,make,mipv6-daemon-umip,netcat,ntfs-3g,ntfsprogs,perl,ruby,screen,sshfs-fuse,subversion,swig,tcpdump,tftp-hpa,tftp-hpa-server,vim --with-template=feature/backports,feature/bluetooth,feature/ems-test,feature/haccmds,feature/ipsec_vpn,feature/non-grsec,feature/online_updates,feature/openjdk-bin,feature/pptp_vpn,feature/recovery,feature/remote-session,feature/self-hosted,feature/target-toolchain,feature/vlan

:'''MI3.0 Configure for Intel Atom processor'''
../WindRiver/wrlinux-7/wrlinux/configure --enable-board=intel-baytrail-64 --enable-kernel=idp --enable-bootimage=ext3,hdd --enable-patchresolve=noop --enablerootfs=idp \
--enable-addons=wr-idp --with-layer=wr-prosyst-mbs-smarthome-sdk-ia,wrdigi-idigiconnector,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069,\
sysversion,wr-iot --with-template=feature/vlan,feature/opc,feature/recovery,feature/opc_demo,feature/ipsec_vpn,feature/l2tp,feature/realtek, \
feature/ems-test,feature/remote-session,feature/openjdk-bin,feature/online_updates,feature/bluetooth,feature/pptp_vpn,feature/target-toolchain \
--withpackage=make,git,iasl,libtool,perl,ruby,subversion,autoconf,automake,curl,conntrack-tools,fuse,igmpproxy,iperf,ipset,libcli,mipv6-daemonumip,\
ntfs-3g,ntfsprogs,sshfs-fuse,tftp-hpa,tftp-hpa-server,tcpdump,vim

:'''MI3.0 Configure for Intel Core processor'''
../WindRiver/wrlinux-7/wrlinux/configure --enable-board=intel-haswell-64 --enable-kernel=idp --enable-bootimage=ext3,hdd --enable-patchresolve=noop --enablerootfs=idp \
--enable-addons=wr-idp --with-layer=wr-prosyst-mbs-smarthome-sdk-ia,wrdigi-idigiconnector,wr-wks-oneagent-oma-dm-ia,wr-wks-oneagent-tr069,\
sysversion,wr-iot --with-template=feature/vlan,feature/opc,feature/recovery,feature/opc_demo,feature/ipsec_vpn,feature/l2tp,feature/realtek, \
feature/ems-test,feature/remote-session,feature/openjdk-bin,feature/online_updates,feature/bluetooth,feature/pptp_vpn,feature/target-toolchain \
--withpackage=make,git,iasl,libtool,perl,ruby,subversion,autoconf,automake,curl,conntrack-tools,fuse,igmpproxy,iperf,ipset,libcli,mipv6-daemonumip,\
ntfs-3g,ntfsprogs,sshfs-fuse,tftp-hpa,tftp-hpa-server,tcpdump,vim

:'''MI2.0 Configure for Intel Atom processor'''
$WIND_LINUX_CONFIGURE --enable-board=intel-atom-baytrail --enable-kernel=standard --enable-rootfs=glibc-idp --enable-addons=wr-idp --enable-bootimage=ext3,hdd --enable-parallel-pkgbuilds=4 --enable-jobs=6 --enable-reconfig --
enable-rm-oldimgs=yes --enable-rm-work=yes --without-layer=wr-srm --with-layer=wr-intel-support,wr-mcafee,wr-wks-oneagent-tr069,wr-ieee11073,wr-mcafee,wr-wks-oneagent-oma-dm-ia,wr-intel-support --with-
template=feature/online_updates,feature/recovery,feature/pptp_vpn,feature/pppoe,feature/upnp,feature/opc,feature/openjdk-bin,
feature/ipsec_vpn,feature/mqtt,feature/l2tp,feature/webif,feature/firewall,feature/vlan,feature/intel-wilkinpeak2,feature/bluetooth --with-rcpl-version=17

3. Build the IDP
make fs
4. The config.log created in $HOME/Project is an exact copy of the configure options used to build the Gateway OS. Save this as config.sh for future development projects:
cp config.log config.sh
5. Continue to Copy Gateway OS to USB Flash Drive. 
'''Note:''' Remove grsecurity to experiment with application development. Refer to [[IDP Build IDP Without Grsecurity]]
:Grsecurity is included in the Linux kernel by default. This feature can inhibit exploration by preventing your apps from working. 
:Disable grsecurity while you experiement with your Gateway. When you are ready to build a production-ready Gateway, consider re-enabling grsecurity

=Kernel Driver Menu Config=
'''$make -C build linux-windriver.menuconfig'''
'''$make -C build linux-windriver.rebuild'''
Note: 1.Type "/" to search key word
2.To select be installed driver or function
For example: Ath9k wifi module driver

=Copy Gateway OS to USB Flash Drive=

1. Insert the USB flash drive into your Development Computer 
2. ls /dv/sd? 
3. cd $HOME/workspace/<YourProjectDirectory_prj> 
4. Deploy the image to USB flash drive. Note: The deploy process takes about 15 minutes. 
'''For Atom processor'''
sudo ./deploy.sh -u -f export/intel-baytrail-64-idp-idp-dist.tar.bz2 -d /dev/sd? -y; sync

'''For Intel Core processor'''
sudo ./deploy.sh -u -f export/intel-haswell-64-idp-idp-dist.tar.bz2 -d /dev/sd? -y; sync

5. Type your Linux password if prompted and click OK. The bootable USB drive is created when you see DONE!
6. Remove and reinsert into your Development Computer. The flash drive mounts with two partitions, one of which is /media/<username>/wr_usb_boot
7. Copy image to the flash drive
'''For Atom processor'''
sudo cp export/intel-baytrail-64-idp-idp-dist.tar.bz2 /media/<username>/wr_usb_boot/opt/; sync

'''For Intel Core processor'''
sudo cp export/intel-haswell-64-idp-idp-dist.tar.bz2 /media/<username>/wr_usb_boot/opt/; sync

'''For MI3.1'''
sudo cp export/intel-baytrail-64-idp-idp-dist.tar.bz2 /media/<username>/efi/SFR/; sync
8. Remove the USB flash drive from your Development Computer

=Install the OS on the Gateway=
1. Insert the USB to Gateway and power on. Login using "root" for the login ID and password. 
2. Install the OS:
tgt=/dev/sda /sbin/reset_media
3. Installation is complete when you see the message "DONE!" Shut down the Gateway
poweroff
4. Remove the USB flash drive and power up your Gateway
5. Login using "root" for both the login ID and password. The OS installation is complete.

=[[IDP/Advantech/Standard BSP|MI3.1 Advantech Standard BSP by ECG]]=

IDP/Advantech/Standard BSP

2016-07-22T06:06:35Z

Winston: /* Modified Items by ECG */

=MI3.1 7.0.0.14 V1.0.1=
==Specification==
#Pro version configuration by Advantech : 1.wr-wks-oneagent-oma-dm-ia, 2.wr-wks-oneagent-tr069, 3.wr-mcafee => These features belong Pro version only.
##[[Media:Adv_Standard_MI3.1_Image_V1.0.1_for_Baytrail_config.log.txt|Baytrail]]
##[[Media:Adv_Standard_MI3.1_Image_V1.0.1_for_Haswell_config.log.txt|Hasell]]
#Have verified 5 Wireless Modules as below
##Silex SX-PCEAN2 ( WiFi - Athero AR9580 )
##EWM-W15801F ( WiFi - Atheros AR9592-AR1B )
##Intel AC7260 ( WiFi + BT Intel AC7260 )
##EWM-CC118HD01E ( 3G u-blox SARA-U270 with SIM Holder )
##Sierra MC7354 ( 3G Sierra MC7354 without SIM Holder )
##Telite HE910 ( 3G Telit HE910 with SIM Holder )
#SUSI4.0 / SUSIIoT Porting
#Doesn't support Secure Boot with this version( need modify BIOS )

==Modified Items by ECG==
[[Media:AdvModify_MI3.1_V1.0.1.zip |Download: Add scripts & files]]

1. add modem_cell_default to /etc/. : Support we tested Modem Module can show on Luci web UI ( EWM-C118HD01E / Sierra MC7354 / EWM-C109F601E / EWM-C117FL04E ) 
2. add the usb-modem.sh to /lib/network/. : Support USB interface 3G module (ex: Sierra MC7354 ) 
3. add ar3k.zip to /lib/firmware/ & unzip ark3k.zip : Support Atheros bluetooth module 
4. SUSI4.0 -> ~/Advantech/SUSI4.0 : SUSI4.0 Linux Driver for Advantech Platform 
5. SUSIIoT -> ~/Advantech/SUSIIoT : SUSIIoT SUSI Driver with JSON format 
6. ReadMe.txt -> ~/Advantech/ReadMe.txt : OS Information 
7. config.log -> ~/Advantech/config.log : Configuration of the MI3.1 7.0.0.14 Pro image 

==[[MI3.1_Standard_Image_V1.0.1_Porting_SOP|Porting SOP]]==

==RD Functional Test==
[[IDP/ARK-2151S_Functional_Test|ARK-2151S_Functional_Test]]

==Advantech Standard BSP by ECG==
*[[MI3.1 7.0.0.14 V1.0.1 for Baytrail|<big>For Baytrail</big>]]

IDP/Advantech/Standard BSP

2016-07-22T06:05:29Z

Winston: /* Modified Items by ECG */

=MI3.1 7.0.0.14 V1.0.1=
==Specification==
#Pro version configuration by Advantech : 1.wr-wks-oneagent-oma-dm-ia, 2.wr-wks-oneagent-tr069, 3.wr-mcafee => These features belong Pro version only.
##[[Media:Adv_Standard_MI3.1_Image_V1.0.1_for_Baytrail_config.log.txt|Baytrail]]
##[[Media:Adv_Standard_MI3.1_Image_V1.0.1_for_Haswell_config.log.txt|Hasell]]
#Have verified 5 Wireless Modules as below
##Silex SX-PCEAN2 ( WiFi - Athero AR9580 )
##EWM-W15801F ( WiFi - Atheros AR9592-AR1B )
##Intel AC7260 ( WiFi + BT Intel AC7260 )
##EWM-CC118HD01E ( 3G u-blox SARA-U270 with SIM Holder )
##Sierra MC7354 ( 3G Sierra MC7354 without SIM Holder )
##Telite HE910 ( 3G Telit HE910 with SIM Holder )
#SUSI4.0 / SUSIIoT Porting
#Doesn't support Secure Boot with this version( need modify BIOS )

==Modified Items by ECG==
[[Media:AdvModify_MI3.1_V1.0.1.zip |Download: Add scripts & files]]

1. add modem_cell_default to /etc/. : Support we tested Modem Module can show on Luci web UI ( EWM-C118HD01E / Sierra MC7354 / EWM-C109F601E / EWM-C117FL04E ) 
2. add the usb-modem.sh to /lib/network/. : Support USB interface 3G module (ex: Sierra MC7354 ) 
3. add ark3k.zip to /lib/firmware/ & unzip ark3k.zip : Support Atheros bluetooth module 
4. SUSI4.0 -> ~/Advantech/SUSI4.0 : SUSI4.0 Linux Driver for Advantech Platform 
5. SUSIIoT -> ~/Advantech/SUSIIoT : SUSIIoT SUSI Driver with JSON format 
6. ReadMe.txt -> ~/Advantech/ReadMe.txt : OS Information 
7. config.log -> ~/Advantech/config.log : Configuration of the MI3.1 7.0.0.14 Pro image 

==[[MI3.1_Standard_Image_V1.0.1_Porting_SOP|Porting SOP]]==

==RD Functional Test==
[[IDP/ARK-2151S_Functional_Test|ARK-2151S_Functional_Test]]

==Advantech Standard BSP by ECG==
*[[MI3.1 7.0.0.14 V1.0.1 for Baytrail|<big>For Baytrail</big>]]

IDP Documentation

2016-07-20T02:54:27Z

Winston: /* IDP2.0 */

=IDP2.0=
*[[Media:Wr linux release notes 5.0.1.pdf|<big><big>WR Linux Release Note 5.0.1 - ( list down the pkg name )</big></big>]]
*[[Media:WRU WCP IDP Quick Start Guide.pdf|<big><big>WRU WCP IDP Quick Start Guide.pdf</big></big>]]
*[[Media:BlacksBeach_GetStarted_Rev1_0.pdf|<big><big>IDP2.0 Early Access Get Started Guide</big></big>]]
*[[Media:03 03 LxPlatformDevelopment WorkingWithUserDefinedProjects.pdf|<big><big>''03 03 LxPlatformDevelopment WorkingWithUserDefinedProjects.pdf''</big></big>]]
*[[Media:05 01 LxPlatformDevelopment BuildingAndCustomizingPlatform.pdf|<big><big>''05 01 LxPlatformDevelopment BuildingAndCustomizingPlatform.pdf''</big></big>]]
*[[Media:07 03 LxPlatformDevelopment WorkingWithKernelModules.pdf|<big><big>''07 03 LxPlatformDevelopment WorkingWithKernelModules.pdf''</big></big>]]
*[[Media:08 02 LxPlatformDevelopment CreatingLayers.pdf|<big><big>''08 02 LxPlatformDevelopment CreatingLayers.pdf''</big></big>]]

=IDP3.0=
*[[Media:540625 10923 8 Intel IoT Gateway GoldDeck 081015 ext.pdf|''<big>Intel IoT Gateway GoldDeck</big>'']] 
*[[Media:Introduction of IDP3.0.pptx|''<big>Introduction of IDP3.0.pptx - by Advantech Eric</big>'']] 
*[[Media:IoT_Gateway_IDP_XT_GSG.pdf ?|<big><big>''IDP 3.0 Quick Start Guide.pdf''</big></big>]]

=IDP3.1=
*[[Media:Intel IoT Gateway Wind River GoldDeck January16 ext.pdf|'''<big>IDP3.1 Introduction GoldDeck 20160116 PDF</big>''']]
*[http://www.intel.com/content/www/us/en/embedded/solutions/iot-gateway/training/iot-gateway-training-overview.html '''<big>Intel on line Tranning and Documentation</big>''']
*[https://software.intel.com/en-us/iot/hardware/gateways <big><big>'''On-line Docs for MI3.1'''</big></big>]
*[https://software.intel.com/en-us/Setup-IDP-DevelopmentTools <big><big>'''IDP XT 3.1 Getting Started Guide'''</big></big>]
*[[Media:Wr_intelligent_device_platform_xt_programmers_guide_31.pdf| <big><big>'''IDP XT3.1 Programmers Guide'''</big></big>]]
*[[Media:Iot-platform-marketplace-guide.pdf|'''<big><big>IoT Platform Marketplace User Guide</big></big>''']]
*[[IDP/MI3.1/Information|'''<big><big>MI3.1 Information</big></big>''']]
*[[Media:SOP_of_Intel_Customer.docx|'''<big><big>SOP_of_Intel_Customer.docx</big></big>''']]

=Kernel Driver=
*[[Media:Wr_linux_kernel_command_line_tutorials_70.pdf| <big><big>'''WR Linux Kernel command line Tutorials'''</big></big>]]

=Connectivity=
*[[Media:WRU_WCP_IDP_IoT_20XT_02_01_IDP_Architecture_Connectivity.pdf|<big><big>''IDP_Architecture_Connectivity''</big></big>]]

=Application=
*[[Media:WRU_WCP_IDP_IoT_20XT_07_01_IDP_ApplicationStacks.pdf|<big><big>''IDP_ApplicationStacks''</big></big>]]

=Secure=
*[[Media:547808 547808 Intel Gateway for the IoT DK300 Secure Boot Users Guide.pdf ?|<big><big>''Secure Boot Usr Guide''</big></big>]]
*[[Media:TPM Operations.pdf ?|<big><big>''TPM Operation on UTX-3115''</big></big>]]

=Trianing=
=IDP2.x=
*[[IDP2.0 Training-20141107|IDP2.0 Training by Wind River-20141107]]
*[[Media:IDP2 20140326 Wind River.pptx|<big>IDP2 20140326 Wind River.pptx</big>]]

==IDP3.0==
*[[Media:MI 3.0 Workshop Foils.zip ?|<big><big>''IDP3.x workshop by Intel/WR in 2015-9-30~10-1''</big></big>]]

=Qualification=
==IDP2.x==
*[[Media:557818 Diagnostic Tool FINAL.PDF|<big>IDP Diagnostic Tool-2015-10</big>]]
*[[Media:Idp-xt-validation-plan_2.0.pdf |<big>Idp-xt-validation-plan_2.0.pdf - by Wind River</big>]]

==IDP3.0==
*[[Media:561994 Intel IoT Gateway Diagnostic Tool.pdf|<big>IDP Diagnostic Tool-2015-11</big>]]
*[[Media:562720 Diagnostic Tool Errata.pdf|<big>Diagnostic_Tool_Errata-2015-11</big>]]

==IDP3.1==

=Intel/Wind River Official Web Site=
*[https://businessportal.intel.com/irj/portal '''<big>Intel IPS system</big>''']
*[https://shopiotmarketplace.com/iot/index.html#/parts '''<big>Intel Marketplace for MI3.1</big>''']
*[https://customercare.intel.com/ '''<big>Intel New Customer Service for MI3.1 -2016 04</big>''']
*[https://windshare.windriver.com/index.php/apps/windriver/ '''<big>WindShare by WindRiver</big>''']
*[http://windriver.mrooms.net/my/ '''<big>On-line Course by Wind River</big>''']

=Support Component List=
==IDP3.x==
*[[Media:551116_551116_Component_List_Final.pdf|<big>IDP3.0 Component List- August 2015</big>]]

=Advantech=
*[[Media:IDP BSP Porting Application Form.xlsx|<big>IDP Image Porting Application Form</big>]]
*[[Media:IDP Issue Request Form.xlsx|<big>IDP Issue Request Form</big>]]
*[[Media:WRLinux5-HW-Drivers.xlsx|<big>IDP2.0 Driver List</big>]]

=Tools=
==[[x86 System Tool|x86 System Tool]]==

File:08 02 LxPlatformDevelopment CreatingLayers.pdf

2016-07-20T02:53:57Z

Winston: Eric uploaded a new version of File:08 02 LxPlatformDevelopment CreatingLayers.pdf

File:AdvHeartBeat-FC-6.jpg

2016-07-20T02:47:26Z

Winston: Eric uploaded a new version of File:AdvHeartBeat-FC-6.jpg

File:AdvHeartBeat-FC-6.jpg

2016-07-20T02:47:25Z

Winston: Eric uploaded a new version of File:AdvHeartBeat-FC-6.jpg

Connectivity/AdvHeartBeat

2016-07-20T02:45:32Z

Winston: /* Connect Info */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server would send "Get Capability" and "Change AdvHeartBeat sending rate" after receiving a "Connect Info" message.
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a "Connect Info" to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server sends "Re-Connect" message for asking agent re-send its "Connect Info".
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send "Connect Info" after receiving a "Re-Connect" message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Connect Info==
Agent Client sends the "Connect Info" to Server for on-line notification. Server would send "Get Capability" to get capability of this agent device and "Change AdvHeartBeat rate" to sync with System's sending rate.

[[File:AdvHeartBeat-FC-6.jpg|800x400px|Agent Connect Info]]

Description: gent Client sends the "Connect Info" to Server for on-line notification.
Type: Info
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 2
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". This issue maybe introduce by running order or dropping message by broker or RMM Server.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.
#Up-plug network cable 6 mins then plug-in.

===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

File:AdvHeartBeat-FC-6.jpg

2016-07-20T02:44:31Z

Winston:

File:AdvHeartBeat-FC-5.jpg

2016-07-20T02:44:19Z

Winston: Eric uploaded a new version of File:AdvHeartBeat-FC-5.jpg

File:AdvHeartBeat-FC-4.jpg

2016-07-20T02:44:06Z

Winston: Eric uploaded a new version of File:AdvHeartBeat-FC-4.jpg

File:AdvHeartBeat-FC-3.jpg

2016-07-20T02:43:52Z

Winston: Eric uploaded a new version of File:AdvHeartBeat-FC-3.jpg

2016-07-19T09:01:44Z

Winston:

Connectivity/AdvHeartBeat

2016-07-19T08:18:52Z

Winston: /* Server Site */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server updates latest update time after receiving a AdvHeartBeat message at its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there is not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a connect info to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server send re-connect message to agent for asking agent re-send connect info.
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send connect info after receiving a re-connect message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". The issue introduce by running order of Agent, Server, and MQTT Broker.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.
#Up-plug network cable 6 mins then plug-in.
#Limited Bandwidth -> 56KB Modem
===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

Connectivity/AdvHeartBeat

2016-07-19T02:20:03Z

Winston: /* Server Site */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server updates latest update time after receiving a AdvHeartBeat message at its AdvHeartBeat Table( NoSQL ).
#Server checks update time of AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If ( timeout & status is connected ) => changes status to disconnect & send a "Re-Connect" message to this device
#If there is latest AdvHeartBeat message in "AdvHeartBeat Table" but there IS not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a connect info to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server send re-connect message to agent for asking agent re-send connect info.
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send connect info after receiving a re-connect message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". The issue introduce by running order of Agent, Server, and MQTT Broker.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.
#Up-plug network cable 6 mins then plug-in.
#Limited Bandwidth -> 56KB Modem
===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart

Connectivity/AdvHeartBeat

2016-07-19T02:14:55Z

Winston: /* Integration Test */

=AdvHeartBeat Protocol=
==AdvHeartBeat Topic & Payload==
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/notify
QoS: 0
Retained: 0
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}

==Client Site==
:Agent needs send "AdvHeartBeat" message ( refer to AdvHeartBeat Topic & Payload ) by period as below picture.

[[File:AdvHeartBeat-FC-1.jpg|500x400px|AdvHeartBeat Protocol]]

==Server Site==
#Server updates latest update time after receiving a AdvHeartBeat message with its AdvHeartBeat Table( NoSQL ).
#Server need to check update time from AdvHeartBeat Table only.
#If the latest update time is over timeout ( Note: This value is depend on Server. Recommend: 3 x send rate => 3 x 60 = 180 sec => tolerate drop 2 AdvHeartBeat MSG ).
##If it is timeout & status is connected => then change status to disconnect & send a "Re-Connect" message to this device
#If server check there is latest AdvHeartBeat message in table but there are not device information in device list table ( SQL ).
##Server sends a re-connect message to this device.
##Server needs to send "Get Capability" message to client after receiving a connect info message. Agent will send its OS info and all handlers' capability to server.

==Re-Connect Message==
:If Server aware any problem of a device's status/information. Server will send a "Re-Connect" Message to Agent. Agent will send a connect info to Server after receiving a re-connect message. You can refer below for detail.

[[File:AdvHeartBeat-FC-2.jpg|800x500px|AdvHeartBeat Protocol]]

Description: Server send re-connect message to agent for asking agent re-send connect info.
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"commCmd": 125,
"handlerName": "general",
"response": {
"statuscode": 4,
"msg": "Reconnect"
}
}
}

Description: Agent will send connect info after receiving a re-connect message.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

==Get Capability==
Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message. 
Agent will send back below messages when receiving a "Get Capability" message.
#OS Info
#All handler's capability ( ex: HWM, KVM, HDD, IoTGW...)
#All SenHub's "Connect Info" message. ( Send by IoTGWHandler )
#Update the latest data of IoTGW ( Update by IoTGWHandler )

[[File:AdvHeartBeat-FC-3.jpg|500x600px|Get Agent's Capability]]

Description: Server will send a "Get Capability" message to Agent after receiving a "Connect Info" message
Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<agentID>/agentcallbackreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"requestID":1001,
"catalogID": 4,
"commCmd":2051,
"handlerName":"general"
}
}

Description: Agent will send back OS Info to Server after receiving "Get Capability" message.
Note: This feature will be implemented in version 3.2.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"osInfo": {
"cagentVersion":"3.1.23",
"cagentType":"IoTGW",
"osVersion":"SnailOS",
"biosVersion":"",
"platformName":"",
"processorName":"SnailGW",
"osArch":"SnailX86",
"totalPhysMemKB":123,
"macs":"000E40ABCDEF",
"IP":"192.168.0.100"
},
"commCmd":116,
"requestID":109,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":1466730390
}
}

Description: Agent will send all handlers' capability to server.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<agentID>/agentactionreq
QoS: 0
Retained: 0
Payload: ( ex: HWM )
{
"susiCommData": {
"infoSpec": {
"HWM": {
"e": [
{"n": "v01","type": "volt","u": "V","max": 20,"min": 10},
{"n": "v02","type": "volt","u": "V","max": 20,"min": 10},
{"n": "t01","type": "temp","u": "Cel","max": 100,"min": 10},
{"n": "V143360","type": "current","u": "A","max": 100,"min": 10}
],
"bn": "HWM"
},
"requestID": 2001,
"commCmd": 2052,
"catalogID": 4,
"agentID": "000014DAE996BE04",
"sendTS": 1417000000004,
"handlerName": "general"
}
}
}

Description: IoTGW Handler will update latest value of IoTGW.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/deviceinfo
QoS: 0
Retained: 0
Payload:
{
"susiCommData":{
"data": {
"IoTGW": {
"WSN": {
"WSN0": {
"Info":{
"e":[
{"n":"SenHubList","sv":"0017000E40000000,0017000E40000001"},
{"n":"Neighbor","sv":"0017000E40000000,0017000E40000001"},
{"n":"Name","sv":"WSN0"},
{"n":"Health","v":"100.000000"},
{"n":"sw","sv":"1.2.1.12"},
{"n":"reset","bv":"0"}
],
"bn":"Info"
},
"bn":"0007000E40ABCDEF",
"ver":1
},
"bn":"WSN"
},
"ver":1
}
},
"commCmd":2055,
"requestID":2001,
"agentID":"0000000E40ABCDEF",
"handlerName":"general",
"sendTS":160081025
}
}

Description: IoTGW Handler will send "Connect Info" for all "SenHub" devices.
Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentinfoack
QoS: 0
Retained: 0
Payload:
{
"susiCommData": {
"devID":"0017000E40000001",
"hostname":"AAA",
"sn":"0017000E40000001",
"mac":"0017000E40000001",
"version":"3.1.23",
"type":"SenHub",
"product":"WISE-1020",
"manufacture":"",
"status":"1",
"commCmd":1,
"requestID":30002,
"agentID":"0017000E40000001",
"handlerName":"general",
"sendTS":160081026
}
}

=Parameters of "AdvHeartBeat Protocol"=
==Sending Rate==
Unit: second
Default: 60
Range: 1 ~ 0xFFFFFFFF
-1 => Agent doesn't send "AdvHeartBeat" message

==Query parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-4.jpg|500x400px|Query parameters of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 127,
"handlerName": "general",
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 128,
"handlerName": "general",
"heartbeatrate": 60,
"sessionID": "123465"
}
}

==Change parameters of "AdvHeartBeat"==
[[File:AdvHeartBeat-FC-5.jpg|500x480px|Set parameter of "AdvHeartBeat"]]

Type: Request
Direction: Server -> Agent
Topic: /cagent/admin/<devID>/agentcallbackreq
Payload:
{
"susiCommData": {
"commCmd": 129,
"handlerName": "general",
"heartbeatrate": 20,
"sessionID": "123465"
}
}

Type: Response
Direction: Agent -> Server
Topic: /cagent/admin/<devID>/agentactionreq
Payload:
{
"susiCommData": {
"commCmd": 130,
"handlerName": "general",
"result":"SUCCESS", //or "FALSE"
"sessionID": "123465"
}
}

=How to confirm the Agent supports "AdvHeartBeat" protocol?=
1. Check the version in deviceinfo
Agent will support "AdvHeartBeat" in version "3.2".
>= 3.2 : Agent supports AdvHeartBeat
< 3.2 : Agent doesn't support AdvHeartBeat

2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat"

=Test Case=
==Expect==
#Server/Client need follow specification to implement "AdvHeartBeat Protocol".
#Agent connection status on RMM Server must be correct in stable state.
#AdvHeartBeat can fix "lost connect info message issue". The issue introduce by running order of Agent, Server, and MQTT Broker.
#AdvHeatBeat can fix "lost disconnect or will" message issue.

==Server Site - Check by Self==
#Find all devices that its update time is over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "On-line" change to "Off-line"
##No -> Do Nothing
#Find all devices that its update time is not over timeout from "AdvHeartBeat Table" & Check these devices is existing in "Device Table"
##Yes -> If connection status is "Off-line" -> Send a "Re-Connect" message to this device
##No -> Send a "Re-Connect" message to this device
#Server can't misjudge earlier agent without "AdvHeartBeat"'s connection status to offline.
#Server needs take care the network and cpu loading to induce misjudge. ( The frequency of drop "AdvHeartBeat Message" is too high or tolerance is too lower ).

==Client Site - Check by Sefl==
#Agent's OS version must greater "3.2.5"
#Agent sends "AdvHeartBeat Message" to Server in period
#Agent sends "AdvHeartBeat Parameters" after receiving a "Query Parameter of AdvHeartBeat Message".
#Agent will change and reply its "AdvHeartBeat Parameters" after receiving a "Setting AdvHeartBeat Message".
#Agent sends "Connect Info Message" to Server after receiving a "Re-Connect Message".
#Agent sends "OS Info", "Info Spec of all handler", "update values of IoTGW", and "Connect Info of all SenHub" while receiving a "Re-Connect Message".

==Integration Test==
*RMM Server supports "AdvHeartBeat Protocol"
*Agent without "AdvHeartBeat"
*Agent with "AdvHeartBeat"
===Test by Node-Red===
#Lost first "Connect Info Msg"
#Lost "Disconnect Msg" and "Will Msg"
#Continue lost 1~5 "AdvHeartBeat Message"
===Network Environment===
#Unplug network cable 5 sec then plug-in.
#Up-plug network cable 3 mins then plug-in.
#Up-plug network cable 6 mins then plug-in.
#Limited Bandwidth -> 56KB Modem
===Test by Manual===
#Broker and Agent client are started before RMM Server.
#RMM Server restart