Frame

class Frame

Defines a Frame format including its header and payload

Canonical

kortex_api.autogen.messages.Frame_pb2.Frame

Parameters
  • header (Header) –

  • payload (bytes) –

class Header

Defines the frame header

Canonical

kortex_api.autogen.messages.Frame_pb2.Header

Parameters
  • frame_info (int) – Includes frame type, device handle identifier, error code and sub error code

  • message_info (int) – Includes session identifier and message identifier

  • service_info (int) – Includes service version, service identifier and function identifier

  • payload_info (int) – Includes payload length

class Error

Defines an error message

Canonical

kortex_api.autogen.messages.Frame_pb2.Error

Parameters
  • error_code (ErrorCodes) – Error code. Please refer to Errors.proto for list of error codes

  • error_sub_code (int) – Sub error code. Please refer to Errors.proto for list of sub error codes

  • error_sub_string (str) – For internal usage

class PayloadFrameTypeRaw

Defines a raw message

Canonical

kortex_api.autogen.messages.Frame_pb2.PayloadFrameTypeRaw

Parameters
  • topic (str) – Topic used as information on the raw message

  • payload (bytes) – Deferred real payload of the message