Skip to content

Heartbeat

For each certain period, Neuron would send a heartbeat to the IIoT platform for aliveness. If IIoT platform can't receive this heartbeat in certain time (e.g. 5 seconds), it may treat the Neuron as dead. In addition, heartbeat message may contain some useful information such as alarm status, running mode, communication status and data usage.

MQTT Topics for Neuron

Publish: Neuron/Heartbeat/%UUID%

MQTT Topics for IIoT platform

Subscribe: Neuron/Heartbeat/%UUID%

Neuron heartbeat syntax

json
{
  "tstp": 1581515618,
  "comm": "UP",
  "mach": "MANU",
  "mode": "ACTIVE",
  "mqcn": "MQCONNECT",
  "dalm": "NON-EXIST",
  "galm": "UNACKNOWLEDGE",
  "ngal": 4,
  "grow": [
    {
      "acat": "alarm",
      "astt": "OFF",
      "amod": "UNACKALARM",
      "atim": 1581513580,
      "alid": 1,
      "comt": "temp1@Temp (812) < low@Temp (800)"
    },
    {
      "acat": "alarm",
      "astt": "ON",
      "amod": "UNACKALARM",
      "atim": 1581515415,
      "alid": 3,
      "comt": "temp2@Temp (791) < low@Temp (800)"
    },
    {
      "acat": "critical",
      "astt": "ON",
      "amod": "UNACKALARM",
      "atim": 1581515415,
      "alid": 4,
      "comt": "temp3@Temp (864) > high@Temp (850)"
    },
    {
      "acat": "alarm",
      "astt": "OFF",
      "amod": "UNACKALARM",
      "atim": 1581513592,
      "alid": 5,
      "comt": "temp3@Temp (864) < low@Temp (800)"
    }
  ]
}
Heartbeat
tstpTimeStamp
commPLC or hardware communication status
UP
DOWN
machMachine Mode
AUTO
MANU
SERV
modePlease refer to Status Mode section.
Inactive Mode
Standby Mode
Semi-Standby Mode
Active Mode
Semi-Active Mode
mqcnMQ broker connection status
MQCONNECT
MQDISCONNECT
dalmDevice Alarm which specify which device has
communication problem.
ndalNumber of device alarms
drowDevice alarm rows
chnlChannel number of devices
addrAddress of devices
galmGeneral Alarm which user define their own alarms and
triggers
ngalNumber of general alarms
growGeneral alarm rows
acatAlarm Category
critical
alarm
warning
event
view
asttAlarm Status
ON
OFF
amodAlarm Mode
UNACKALARM
DISABLE
atimAlarm TimeStamp
alidAlarm ID
must be copied this ID when user acknowledge function
80
comtAlarm Comments