62: Cellular Diagnostics

Runtime cellular-module, upload-buffer, and internet-link diagnostic state. GET returns NotSupported when cellular diagnostics are unavailable on the device. Upload-buffer values are zero when their runtime objects are absent. L1 (Cloud link 1) values are zero when its runtime object is absent. L2 (Cloud link 2) fields 13-15 are omitted when its runtime object is unavailable. RX/TX counts belong to L1 (Cloud link 1) and L2 (Cloud link 2), not the UART used to request diagnostics. They count V3 messages, not bytes or cellular network packets. RX increments after protocol, length and checksum validation in the receive path, before message handling. It is not a count of unique messages or successfully executed commands; repeated frames count again. TX increments for each message send request, before queuing or sending, including requests that are later dropped or fail. Uploading or retrying buffered data does not itself increment TX again. Control messages, including ACKs and heartbeats, count when they use these same paths. Each counter starts at zero when its link object is created (normally at boot), survives link reconnects and diagnostic GETs, and wraps from 4294967295 to zero. These are link-object lifetime counters, not per-session totals.

Header

Field	Name	Description	Type
5	Method	Request a service to be perform an action Possible values: 1: SET— Set one or more values that are provided in the message payload. 2: GET— Get values for the associated message type. 3: SUBSCRIBE— Subscribe to values for the associated message type. Can be used in conjunction with other header fields to define the subscription parameters, such as Interval, Duration, Timeout, Storage Level and Message Level. If no interval is provided, messages will be sent as and when new data is available. Some data, such as GPS position, may require a set interval to be provided. 5: UNSUBSCRIBE— Unsubscribe from a previous subscription.	uint8

This is an extract of header fields that are relevant to this message type, you can find them all documented in the Headers section.

Payload

Field	Name	Description	Type	Unit
1	Cellular Module State	Possible values: 0: Off 1: Turning On 2: Resetting 3: Initializing 4: Awaiting Network 5: Initializing Data 6: Ready 7: Sleeping	uint8
2	Network Registration	Cellular network registration code reported by the modem Possible values: 0: Not Connected 1: Connected 2: Searching 3: Denied 4: Unknown 5: Roaming 6: No SIM or SMS Only 7: SMS Only Roaming 11: Emergency	uint8
3	Pending Upload Files	Files waiting to be uploaded	uint16
4	Buffer 0 Used		uint8	%
5	Buffer 1 Used		uint8	%
6	Buffer 2 Used		uint8	%
10	Primary Link Open	L1 (Cloud link 1) open state. False when its link object is absent.	bool
11	Primary Link RX Count	L1 (Cloud link 1) V3 receive-path count; see the RX/TX counting rules above. Zero when its link object is absent.	uint32
12	Primary Link TX Count	L1 (Cloud link 1) V3 message send-request count; see the RX/TX counting rules above. Zero when its link object is absent.	uint32
13	Secondary Link Open	L2 (Cloud link 2) open state. Omitted when its link object is absent.	bool
14	Secondary Link RX Count	L2 (Cloud link 2) V3 receive-path count; see the RX/TX counting rules above. Omitted when its link object is absent.	uint32
15	Secondary Link TX Count	L2 (Cloud link 2) V3 message send-request count; see the RX/TX counting rules above. Omitted when its link object is absent.	uint32

Code

For convenience, the following constants can be used to reference this message type.