Types module

Contains internal types used by the reading and parsing logic.

Frame

A named tuple to hold frame data.

class orangebox.types.Frame(type, data)

Parameters:

• type (FrameType) – Type of frame

• data (tuple) – Frame data

FrameType

Enumerates the types of frames in a data stream.

class orangebox.types.FrameType(value)

An enumeration.

INTER = 'P'

Inter frames hold deltas

INTRA = 'I'

Intra frames are key frames

GPS = 'G'

Frames for GPS data

SLOW = 'S'

Slow frames are saved at a lower frequency

GPS_HOME = 'H'

Frame for GPS home position

EVENT = 'E'

Frames for log events

FieldDef

class orangebox.types.FieldDef(frame_type: FrameType, name: str | None = None, signed: int | None = None, predictor: int | None = None, encoding: int | None = None, decoderfun: Decoder | None = None, predictorfun: Predictor | None = None)

Holds data for a field definition. Field definitions describe the fields within a given type of frame.

Parameters:

• frame_type (FrameType) – Type of frame

• name – Name of the field

• signed – Not used

• predictor – Numerical index of a predictor function

• encoding – Number indicating the value encoding type

• decoderfun (Optional[Decoder]) – Decoder callable (set by Reader dynamically)

• predictorfun (Optional[Predictor]) – Predictor callable (set by Reader dynamically)

EventType

Enumerates known log event types.

class orangebox.types.EventType(value)

An enumeration.

Event

A named tuple to hold event data.

class orangebox.types.Event(type, data)

Parameters:

• type (EventType) – Type of event

• data (dict) – Arbitrary data for the event