psas_packet API¶

Message Class¶

The message class can be initialized with information about the data that can be packed in it. This will make an object with encode and decode methods available for packing and unpacking.

class psas_packet.messages.Message(definition)¶

Definition of a message type

Parameters:	definition (dict) – Dictionary defining data in a message
Returns:	Message instance

Suitable metadata can be passed in and this class will perform necessary pre-compute steps and create a usable message instance for a specific data source.

decode(raw)¶

Decode a single message body (the data lines). Header info and message boundaries are solved in network

Parameters:	raw (bytestr) – Raw string of bytes the length of
Returns:	A dictionary of values in normal units

encode(data)¶

Encode a set of data into binary

Parameters:	data (dict) – A dictionary of values to encode
Returns:	Binary ecoded data

Uses the struct package to encode into byte array. The dictionary should have values who’s keys match the members list.

typedef()¶

Autogen c style typedef structs

Returns:	String c code for the data and header for this packet

Header¶

Encodes and decodes message headers

class psas_packet.messages.Head¶

Encode and decodes message headers

decode(raw)¶

Take a buffer of bytes and attempt to decode a header

Parameters:	raw (bytes[]) – byte array to decode
Returns:	tuple of the fourcc, timestamp, and lenght

encode(message_class, time)¶

Make a header for a given message class. Headers also contain timestamps of the local time a data was created.

Parameters:	message_class (Message) – Type message to encode time (int) – Timestamp in nanoseconds
Returns:	array of raw bytes the size of a Head.struct.size

Exceptions¶

class psas_packet.messages.MessageSizeError(expected, got)¶

Raised when the byte str to be unpacked does not match the expected size for this type. Check your message boundaries.

Parameters:	expected (int) – correct size got (int) – attempted size
Returns:	MessageSizeError exception