Connectivity/AdvHeartBeat

From ESS-WIKI
Revision as of 11:39, 30 June 2016 by Winston (talk | contribs) (Created page with " =How could check Agent support "AdvHeartBeat"?= 1. Check the version in deviceinfo Agent will support "AdvHeartBeat" in version "3.2". >= 3.2 : Agent supports...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

How could check Agent support "AdvHeartBeat"?

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. Server could query the parameters of "AdvHeartBeat" by "Query / Change AdvHeartBeat parameter"

Parameters of "AdvHeartBeat Protocol"

AdvHeartBeat Rate

Unit: second
Default Value: 60  sec
Range: -1 : Agent doesn't send any "AdvHeartBeat" message
        1 ~ 0xFFFFFFFF

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