Difference between revisions of "Connectivity/AdvHeartBeat"

From ESS-WIKI
Jump to: navigation, search
(Sending Rate)
(Sending Rate)
Line 10: Line 10:
 
=Parameters of "AdvHeartBeat Protocol"=
 
=Parameters of "AdvHeartBeat Protocol"=
 
==Sending Rate==
 
==Sending Rate==
Unit: second
+
    Unit: second
Default Value: 60 sec
+
  Default: 60  
        Range: -1 : Agent doesn't send "AdvHeartBeat" message
+
    Range: 1 ~ 0xFFFFFFFF
                1 ~ 0xFFFFFFFF
+
          -1 => Agent doesn't send "AdvHeartBeat" message
  
 
==Query parameters of "AdvHeartBeat"==
 
==Query parameters of "AdvHeartBeat"==

Revision as of 03:48, 1 July 2016

Does Agent support "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"


Parameters of "AdvHeartBeat Protocol"

Sending Rate

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

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"

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"
    }
}

Topic & Payload of "AdvHeartBeat"

Topic: /cagent/admin/<devID>/notify
Payload: ~ 35 character
{"hb":{"devID":"0017000E40000001"}}