Login

Standard format events markers

Events are records of non-sample incidents, and can be used to aid interpretation of the deployment data, or for diagnostic purposes.

In Standard format, events and sample data are stored together in chronological order in dataset-1. Sample data should always be stored as complete sets of readings, one set comprising one reading from each active channel, all taken at the same time. However, it may be possible under some fault conditions for only a partial sample set to be stored. It is therefore important when parsing data in Standard format to check for event markers at every reading, not just at the assumed start of every sample set.

Event structure

BytesDescription
Bytes 0,116-bit byte-swapped CCITT CRC of Bytes 2..7
Byte 2Type Code
Byte 30xF3 marker byte
Bytes 4..7

32-bit date/time in elapsed seconds format

Bytes 8..916 b count of milliseconds in current second [0..999]
Byte 10Size of event in uint32_t N
Byte 11Event processing info
Bytes 12..4*N-1Auxiliary data

Seconds for the date/time are counted from 2000-Jan-01 00:00:00.

Event processing info byte

Bit #Description
bit 0

1 - the timestamp of this event is the timestamp of the next following sample set.

0 - the timestamp of this event does not affect the timestamp of the next following sample set.

bit 1..7Unused

Type Codes

Type codeDescription
0x00Unknown or unrecognized events
0x01Time synchronization marker
0x02stop command received
0x03Run-time error encountered
0x04CPU reset detected
0x05One or more parameters recovered after reset
0x06Restart failed : Real Time Clock/Calendar contents not valid
0x07Restart failed : logger status not valid
0x08Restart failed : primary schedule parameters could not be recovered.
0x09Unable to load alarm time for next sample
0x0ASampling restarted after resetting Real Time Clock (RTC)
0x0BParameters recovered, sampling restarted after resetting RTC
0x0CSampling stopped, end time reached
0x0DStart of a recorded burst
0x0EStart of a wave burst
0x0F( reserved )
0x10Streaming now OFF for both ports
0x11Streaming ON for USB, OFF for serial
0x12Streaming OFF for USB, ON for serial
0x13Streaming now ON for both ports
0x14Sampling started, threshold condition satisfied
0x15Sampling paused, threshold condition not met
0x16Power source switched to internal battery
0x17Power source switched to external battery
0x18Twist activation started sampling
0x19Twist activation paused sampling
0x1AWiFi module detected and activated
0x1BWiFi module de-activated; removed or activity timeout
0x1CRegimes enabled, but not yet in a regime
0x1DEntered regime 1
0x1EEntered regime 2
0x1FEntered regime 3
0x20Start of regime bin
0x21Begin profiling 'up' cast
0x22Begin profiling 'down' cast
0x23End of profiling cast
0x24Battery failed, schedule finished.
0x25Directional dependent sampling, beginning of fast sampling mode
0x26Directional dependent sampling, beginning of slow sampling mode

Auxiliary data

Not all the events have embedded auxiliary data; here is a comprehensive list of those that do, with descriptions of the embedded data.

Regime bin event 0x20 auxiliary data

BytesDescription
12..15Number of readings in the bin 

Firmware versions 1.100 or later may also support a derived data channel, type cnt_00, which contains this value from event 0x20 when in the regimes sampling mode. Refer to the Section "Integrating with a profiling float " for further details.

Begin profiling 'up' cast event auxiliary data

BytesDescription
12..1532-bit (4-byte) address of the corresponding sample set.

Begin profiling 'down' cast event auxiliary data

BytesDescription
12..1532-bit (4-byte) address of the corresponding sample set.

End of profiling cast event auxiliary data

BytesDescription
12..15

32-bit (4-byte) address of the first sample set after the cast.

Runtime error event auxiliary data

BytesDescription
12..15

32-bit (4-byte) firmware program address at which the error was detected