EasyParse 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. EasyParse events are stored in dataset-0, separate from the sample data in dataset-1.
In EasyParse format, all events have the same structure; this helps to make the stream of events easier to parse because they all have the same, fixed size: 16-bytes. Compared to Standard events, the format of the timestamp is different, and all events have an extended data field, or payload. If the payload is not applicable to a particular event type, its content is not defined, and no attempt to interpret it should be made.
For consistency, the Type Codes are the same as used for Basic (F7) and Extended (F5) events in Standard data storage format, and all are listed below for completeness. However, note that some type codes should never be encountered in EasyParse events; for example, 0x01 used for time synchronization is completely redundant, as all samples and events have their own timestamp.
| Bytes 0,1 | 16-bit byte-swapped CCITT CRC of Bytes 2..15 |
| Byte 2 | Type Code |
| Byte 3 | 0xF4 marker byte |
| Bytes 4..11 | 64-bit unsigned number of milliseconds since 1970-01-01 00:00:00 |
| Bytes 12..15 | 32-bit (4-byte) payload dependent on 'T ype Code' |
The event payloads depend on the event Type Code:
- Most event types have no payload and the content is not defined; it should be ignored.
- A separate time-stamp field for milliseconds is redundant and never used.
- For regime bin events (0x20), the payload is the number of reading values in the reported average.
- For cast events, the payload is the address of the sample in dataset-1, where the actual sample data is stored.
In the case of event 0x23 (End of profiling cast), the sample address given is that of the next sample, ie. the first sample which is not in the cast.
| Hex Code | Description | Payload |
|---|---|---|
| 0x00 | Unknown or unrecognized events | undefined |
| 0x01 | Time synchronization marker | undefined |
| 0x02 | stop command received | undefined |
| 0x03 | Run-time error encountered | undefined |
| 0x04 | CPU reset detected | undefined |
| 0x05 | One or more parameters recovered after reset | undefined |
| 0x06 | Restart failed : Real Time Clock/Calendar contents not valid | undefined |
| 0x07 | Restart failed : logger status not valid | undefined |
| 0x08 | Restart failed : primary schedule parameters not be recovered. | undefined |
| 0x09 | Unable to load alarm time for next sample | undefined |
| 0x0A | Sampling restarted after resetting Real Time Clock (RTC) | undefined |
| 0x0B | Parameters recovered, sampling restarted after resetting RTC. | undefined |
| 0x0C | Sampling stopped, end time reached | undefined |
| 0x0D | Start of a recorded burst | undefined |
| 0x0E | Start of a wave burst | undefined |
| 0x0F | ( reserved ) | undefined |
| 0x10 | Streaming now OFF for both ports | undefined |
| 0x11 | Streaming ON for USB, OFF for serial | undefined |
| 0x12 | Streaming OFF for USB, ON for serial | undefined |
| 0x13 | Streaming now ON for both ports | undefined |
| 0x14 | Sampling started, threshold condition satisfied | undefined |
| 0x15 | Sampling paused, threshold condition not met | undefined |
| 0x16 | Power source switched to internal battery | undefined |
| 0x17 | Power source switched to external battery | undefined |
| 0x18 | Twist activation started sampling | undefined |
| 0x19 | Twist activation paused sampling | undefined |
| 0x1A | WiFi module detected and activated | undefined |
| 0x1B | WiFi module de-activated; removed or activity timeout | undefined |
| 0x1C | Regimes enabled, but not yet in a regime | undefined |
| 0x1D | Entered regime 1 | undefined |
| 0x1E | Entered regime 2 | undefined |
| 0x1F | Entered regime 3 | undefined |
| 0x20 | Start of regime bin | number of readings in average; see note below |
| 0x21 | Begin profiling 'up' cast | address of sample in dataset-1 |
| 0x22 | Begin profiling 'down' cast | address of sample in dataset-1 |
| 0x23 | End of profiling cast | address of first sample not in cast |
| 0x24 | Battery failed, schedule finished. | undefined |
| 0x25 | Directional dependent sampling, beginning of fast sampling mode | undefined |
| 0x26 | Directional dependent sampling, beginning of slow sampling mode | undefined |
| 0x27 | Energy used marker, internal battery | energy consumed from power source since last accumulator reset |
| 0x28 | Energy used marker, external power source | energy consumed from power source since last accumulator reset |
| 0x29 | Device control action result | result of control action |
Logger configuration may also include a derived data channel, type cnt_00, which contains the same value as event 0x20 when in the regimes sampling mode. The benefit of turning it on when storing data in EasyParse format is that the value is then available in the main sample data in dataset-1; the dataset containing these events does not have to be retrieved. Refer to the Section "Integrating with a profiling float" for further details.