Difference between revisions of "Connectivity/AdvHeartBeat"
From ESS-WIKI
(→How can I check the Agent support "AdvHeartBeat" protocol ?) |
|||
| Line 1: | Line 1: | ||
| − | |||
=How can I check the Agent support "AdvHeartBeat" protocol ?= | =How can I check the Agent support "AdvHeartBeat" protocol ?= | ||
1. Check the version in deviceinfo | 1. Check the version in deviceinfo | ||
| Line 7: | Line 6: | ||
2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat" | 2. Query the parameters of "AdvHeartBeat" by "Query parameters of "AdvHeartBeat" | ||
| + | |||
=Parameters of "AdvHeartBeat Protocol"= | =Parameters of "AdvHeartBeat Protocol"= | ||
| − | == | + | ==Sending Rate== |
Unit: second | Unit: second | ||
Default Value: 60 sec | Default Value: 60 sec | ||
| Line 15: | Line 15: | ||
1 ~ 0xFFFFFFFF | 1 ~ 0xFFFFFFFF | ||
| − | =Query parameters of "AdvHeartBeat"= | + | ==Query parameters of "AdvHeartBeat"== |
Type: Request | Type: Request | ||
Direction: Server -> Agent | Direction: Server -> Agent | ||
| Line 41: | Line 41: | ||
} | } | ||
| − | =Change parameters of "AdvHeartBeat"= | + | ==Change parameters of "AdvHeartBeat"== |
Type: Request | Type: Request | ||
| Line 69: | Line 69: | ||
} | } | ||
| − | =Topic & Payload of "AdvHeartBeat" | + | =Topic & Payload of "AdvHeartBeat"= |
Topic: /cagent/admin/<devID>/notify | Topic: /cagent/admin/<devID>/notify | ||
Payload: ~ 35 character | Payload: ~ 35 character | ||
{"hb":{"devID":"0017000E40000001"}} | {"hb":{"devID":"0017000E40000001"}} | ||
Revision as of 10:43, 30 June 2016
Contents
How can I check the 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 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"}}