IMCInter Module Communication
v5.5.11

HealthCheck

HealthCheck ID 2015
Payload
≥ 11 bytes, variable
Packet
≥ 33 bytes
Source
ccu
Category
Sensors

Used to request/reply a health check of a system

#Fields

Offset FieldTypeUnitRangeDescription
0 #opOperation uint8_t Enumerated –

Operation to perform. OP.REQUEST should start the HealthCheck. Use OP.REPLY to report the progress. OP.QUERY asks if the task implements health checking. Upon receiving OP.Query, reply with OP.REPLY and STATUS.IMP or STATUS.NOT_IMP.

0OP_REQUESTRequest
1OP_REPLYReply
2OP_QUERYQuery
1 #request_idRequest identitier uint32_t – –

Echoes the request_id in the request

5 #entity_nameEntity Name plaintext – –

Entity Label of the task that's replying to the request

var #statusStatus uint16_t Enumerated –

Health status of the entity

11 values
0ST_FINISHED_OKFinished OK
1ST_FINISHED_ERRORFinished with errors
2ST_IN_PROGRESSIn Progress
3ST_IMPImplemented
4ST_NOT_IMPNot implemented
5ST_ABORTAbort
6ST_CONN_ERRORFailed to establish connection
7ST_SEND_ERRORFailure sending data
8ST_READ_ERRORFailure reading data
9ST_DEV_ERRORDevice error
10ST_DISC_ERRORDisconnect Error
var #textText plaintext – –

Textual description of the health status