sbp.system module

Standardized system messages from Swift Navigation devices.

class sbp.system.MsgCsacTelemetry(sbp=None, **kwargs)

Bases: sbp.msg.SBP

SBP class for message MSG_CSAC_TELEMETRY (0xFF04).

You can have MSG_CSAC_TELEMETRY inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The CSAC telemetry message has an implementation defined telemetry string

from a device. It is not produced or available on general Swift Products. It is intended to be a low rate message for status purposes.

sbp

: SBP

SBP parent object to inherit from.

id

: int

Index representing the type of telemetry in use. It is implemention defined.

telemetry

: string

Comma separated list of values as defined by the index

sender

: int

Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).

from_binary(d)

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)

id

telemetry

to_binary()

Produce a framed/packed SBP message.

to_json_dict()

class sbp.system.MsgCsacTelemetryLabels(sbp=None, **kwargs)

Bases: sbp.msg.SBP

SBP class for message MSG_CSAC_TELEMETRY_LABELS (0xFF05).

You can have MSG_CSAC_TELEMETRY_LABELS inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The CSAC telemetry message provides labels for each member of the string

produced by MSG_CSAC_TELEMETRY. It should be provided by a device at a lower rate than the MSG_CSAC_TELEMETRY.

sbp

: SBP

SBP parent object to inherit from.

id

: int

Index representing the type of telemetry in use. It is implemention defined.

telemetry_labels

: string

Comma separated list of telemetry field values

sender

: int

Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).

from_binary(d)

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)

id

telemetry_labels

to_binary()

Produce a framed/packed SBP message.

to_json_dict()

class sbp.system.MsgDgnssStatus(sbp=None, **kwargs)

Bases: sbp.msg.SBP

SBP class for message MSG_DGNSS_STATUS (0xFF02).

You can have MSG_DGNSS_STATUS inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

This message provides information about the receipt of Differential

corrections. It is expected to be sent with each receipt of a complete corrections packet.

sbp

: SBP

SBP parent object to inherit from.

flags

: int

Status flags

latency

: int

Latency of observation receipt

num_signals

: int

Number of signals from base station

source

: string

Corrections source string

sender

: int

Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).

flags

from_binary(d)

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)

latency

num_signals

source

to_binary()

Produce a framed/packed SBP message.

to_json_dict()

class sbp.system.MsgHeartbeat(sbp=None, **kwargs)

Bases: sbp.msg.SBP

SBP class for message MSG_HEARTBEAT (0xFFFF).

You can have MSG_HEARTBEAT inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The heartbeat message is sent periodically to inform the host

or other attached devices that the system is running. It is used to monitor system malfunctions. It also contains status flags that indicate to the host the status of the system and whether it is operating correctly. Currently, the expected heartbeat interval is 1 sec.

The system error flag is used to indicate that an error has occurred in the system. To determine the source of the error, the remaining error flags should be inspected.

sbp

: SBP

SBP parent object to inherit from.

flags

: int

Status flags

sender

: int

Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).

flags

from_binary(d)

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)

to_binary()

Produce a framed/packed SBP message.

to_json_dict()

class sbp.system.MsgInsStatus(sbp=None, **kwargs)

Bases: sbp.msg.SBP

SBP class for message MSG_INS_STATUS (0xFF03).

You can have MSG_INS_STATUS inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The INS status message describes the state of the operation

and initialization of the inertial navigation system.

sbp

: SBP

SBP parent object to inherit from.

flags

: int

Status flags

sender

: int

Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).

flags

from_binary(d)

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)

to_binary()

Produce a framed/packed SBP message.

to_json_dict()

class sbp.system.MsgStartup(sbp=None, **kwargs)

Bases: sbp.msg.SBP

SBP class for message MSG_STARTUP (0xFF00).

You can have MSG_STARTUP inherit its fields directly from an inherited SBP object, or construct it inline using a dict of its fields.

The system start-up message is sent once on system

start-up. It notifies the host or other attached devices that the system has started and is now ready to respond to commands or configuration requests.

sbp

: SBP

SBP parent object to inherit from.

cause

: int

Cause of startup

startup_type

: int

Startup type

reserved

: int

Reserved

sender

: int

Optional sender ID, defaults to SENDER_ID (see sbp/msg.py).

cause

from_binary(d)

Given a binary payload d, update the appropriate payload fields of the message.

static from_json(s)

Given a JSON-encoded string s, build a message object.

static from_json_dict(d)

reserved

startup_type

to_binary()

Produce a framed/packed SBP message.

to_json_dict()