Heartbeat

This page documents the [heartbeat] configuration section.

The CL1000 can optionally transmit a 1-second periodic heartbeat-signal. The signal payload contains:

  • Logging state (enabled/disabled)[1]

  • The device time (used for timestamping of messages)

  • Space left on the memory card in MB

Note

The device cannot transmit the heartbeat signal silent-mode is enabled, see CAN

Note

Note that the heartbeat signal is inactive until the device has successfully received at least one message from the CAN-bus

Note

The heartbeat-signal message is not included the log files generated by the device

Default

[heartbeat]
heartbeatEnb = false            ; Enable heartbeat signal
extendedID = true               ; Use extended 29 bit message ID (2.0B)
msgID = 00435353                ; CAN message ID of heartbeat signal (HEX)

Fields explained

heartbeatEnb

Type

Options

Boolean

true, false

  • true: Heartbeat signal enabled

  • false: Heartbeat signal disabled

extendedID

Type

Options

Boolean

true, false

  • true: Use extended ID format (29-bit)

  • false: Use standard ID format (11-bit)

msgID

The CAN-bus message ID (in HEX) used for the heartbeat signal.

Type

Minimum

Maximum

Example

HEX

0

7FF / 1FFFFFFF[2]

1F4

Encoding

The encoding used for the heartbeat signal is defined below.

Byte No.

0

1

2

3

4

5

6

7

Content

0xAA

State

Epoch time

Space left

Byte 0 has the reserved value \(\texttt{AA}_{16}\). Multi-byte fields are interpreted MSB (Most-Significant-Byte) first.

Examples

Example: Interpretation of a heartbeat-signal message

Byte No.

0

1

2

3

4

5

6

7

Content

0xAA

State

Epoch time

Space left

Value

0xAA

0x01

0x64

0xAE

0x59

0x79

0x1D

0x93

Interpretation of example message payload:

  • State (0x01): Logging state is active

  • Epoch time (0x64AE5979): Device time in epoch format. Translates to 22/5/2016 18:58:30

  • Space left (0x1D93): Space left on device is 7571 MB