sbp-6.2.1: SwiftNav's SBP Library
CopyrightCopyright (C) 2015-2021 Swift Navigation Inc.
LicenseMIT
Stabilityexperimental
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell2010

SwiftNav.SBP.System

Description

< Standardized system messages from Swift Navigation devices. >

Synopsis

Documentation

data MsgStartup Source #

SBP class for message MSG_STARTUP (0xFF00).

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.

Constructors

MsgStartup 

Fields

data MsgDgnssStatus Source #

SBP class for message MSG_DGNSS_STATUS (0xFF02).

This message provides information about the receipt of Differential corrections. It is expected to be sent with each receipt of a complete corrections packet.

Constructors

MsgDgnssStatus 

Fields

data MsgHeartbeat Source #

SBP class for message MSG_HEARTBEAT (0xFFFF).

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.

Constructors

MsgHeartbeat 

Fields

data SubSystemReport Source #

SubSystemReport.

Report the general and specific state of a subsystem. If the generic state is reported as initializing, the specific state should be ignored.

Constructors

SubSystemReport 

Fields

data MsgStatusReport Source #

SBP class for message MSG_STATUS_REPORT (0xFFFE).

The status report is sent periodically to inform the host or other attached devices that the system is running. It is used to monitor system malfunctions. It contains status reports that indicate to the host the status of each subsystem and whether it is operating correctly.

Interpretation of the subsystem specific status code is product dependent, but if the generic status code is initializing, it should be ignored. Refer to product documentation for details.

Constructors

MsgStatusReport 

Fields

Instances

Instances details
FromJSON MsgStatusReport Source # 
Instance details

Defined in SwiftNav.SBP.System

ToJSON MsgStatusReport Source # 
Instance details

Defined in SwiftNav.SBP.System

Read MsgStatusReport Source # 
Instance details

Defined in SwiftNav.SBP.System

Show MsgStatusReport Source # 
Instance details

Defined in SwiftNav.SBP.System

Binary MsgStatusReport Source # 
Instance details

Defined in SwiftNav.SBP.System

Eq MsgStatusReport Source # 
Instance details

Defined in SwiftNav.SBP.System

ToSBP MsgStatusReport Source # 
Instance details

Defined in SwiftNav.SBP.System

data StatusJournalItem Source #

StatusJournalItem.

Reports the uptime and the state of a subsystem via generic and specific status codes. If the generic state is reported as initializing, the specific state should be ignored.

Constructors

StatusJournalItem 

Fields

data MsgStatusJournal Source #

SBP class for message MSG_STATUS_JOURNAL (0xFFFD).

The status journal message contains past status reports (see MSG_STATUS_REPORT) and functions as a error/event storage for telemetry purposes.

Constructors

MsgStatusJournal 

Fields

Instances

Instances details
FromJSON MsgStatusJournal Source # 
Instance details

Defined in SwiftNav.SBP.System

ToJSON MsgStatusJournal Source # 
Instance details

Defined in SwiftNav.SBP.System

Read MsgStatusJournal Source # 
Instance details

Defined in SwiftNav.SBP.System

Show MsgStatusJournal Source # 
Instance details

Defined in SwiftNav.SBP.System

Binary MsgStatusJournal Source # 
Instance details

Defined in SwiftNav.SBP.System

Eq MsgStatusJournal Source # 
Instance details

Defined in SwiftNav.SBP.System

ToSBP MsgStatusJournal Source # 
Instance details

Defined in SwiftNav.SBP.System

data MsgInsStatus Source #

SBP class for message MSG_INS_STATUS (0xFF03).

The INS status message describes the state of the operation and initialization of the inertial navigation system.

Constructors

MsgInsStatus 

Fields

data MsgCsacTelemetry Source #

SBP class for message MSG_CSAC_TELEMETRY (0xFF04).

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.

Constructors

MsgCsacTelemetry 

Fields

Instances

Instances details
FromJSON MsgCsacTelemetry Source # 
Instance details

Defined in SwiftNav.SBP.System

ToJSON MsgCsacTelemetry Source # 
Instance details

Defined in SwiftNav.SBP.System

Read MsgCsacTelemetry Source # 
Instance details

Defined in SwiftNav.SBP.System

Show MsgCsacTelemetry Source # 
Instance details

Defined in SwiftNav.SBP.System

Binary MsgCsacTelemetry Source # 
Instance details

Defined in SwiftNav.SBP.System

Eq MsgCsacTelemetry Source # 
Instance details

Defined in SwiftNav.SBP.System

ToSBP MsgCsacTelemetry Source # 
Instance details

Defined in SwiftNav.SBP.System

data MsgCsacTelemetryLabels Source #

SBP class for message MSG_CSAC_TELEMETRY_LABELS (0xFF05).

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.

Constructors

MsgCsacTelemetryLabels 

Fields

Instances

Instances details
FromJSON MsgCsacTelemetryLabels Source # 
Instance details

Defined in SwiftNav.SBP.System

ToJSON MsgCsacTelemetryLabels Source # 
Instance details

Defined in SwiftNav.SBP.System

Read MsgCsacTelemetryLabels Source # 
Instance details

Defined in SwiftNav.SBP.System

Show MsgCsacTelemetryLabels Source # 
Instance details

Defined in SwiftNav.SBP.System

Binary MsgCsacTelemetryLabels Source # 
Instance details

Defined in SwiftNav.SBP.System

Eq MsgCsacTelemetryLabels Source # 
Instance details

Defined in SwiftNav.SBP.System

ToSBP MsgCsacTelemetryLabels Source # 
Instance details

Defined in SwiftNav.SBP.System

data MsgInsUpdates Source #

SBP class for message MSG_INS_UPDATES (0xFF06).

The INS update status message contains information about executed and rejected INS updates. This message is expected to be extended in the future as new types of measurements are being added.

Constructors

MsgInsUpdates 

Fields

data MsgGnssTimeOffset Source #

SBP class for message MSG_GNSS_TIME_OFFSET (0xFF07).

The GNSS time offset message contains the information that is needed to translate messages tagged with a local timestamp (e.g. IMU or wheeltick messages) to GNSS time for the sender producing this message.

Constructors

MsgGnssTimeOffset 

Fields

Instances

Instances details
FromJSON MsgGnssTimeOffset Source # 
Instance details

Defined in SwiftNav.SBP.System

ToJSON MsgGnssTimeOffset Source # 
Instance details

Defined in SwiftNav.SBP.System

Read MsgGnssTimeOffset Source # 
Instance details

Defined in SwiftNav.SBP.System

Show MsgGnssTimeOffset Source # 
Instance details

Defined in SwiftNav.SBP.System

Binary MsgGnssTimeOffset Source # 
Instance details

Defined in SwiftNav.SBP.System

Eq MsgGnssTimeOffset Source # 
Instance details

Defined in SwiftNav.SBP.System

ToSBP MsgGnssTimeOffset Source # 
Instance details

Defined in SwiftNav.SBP.System

data MsgPpsTime Source #

SBP class for message MSG_PPS_TIME (0xFF08).

The PPS time message contains the value of the sender's local time in microseconds at the moment a pulse is detected on the PPS input. This is to be used for synchronisation of sensor data sampled with a local timestamp (e.g. IMU or wheeltick messages) where GNSS time is unknown to the sender.

The local time used to timestamp the PPS pulse must be generated by the same clock which is used to timestamp the IMU/wheel sensor data and should follow the same roll-over rules (i.e. it should roll over to zero after 604800 seconds). A separate MSG_PPS_TIME message should be sent for each source of sensor data which uses local timestamping. The sender ID for each of these MSG_PPS_TIME messages should match the sender ID of the respective sensor data.

Constructors

MsgPpsTime 

Fields

data MsgSensorAidEvent Source #

SBP class for message MSG_SENSOR_AID_EVENT (0xFF09).

This diagnostic message contains state and update status information for all sensors that are being used by the fusion engine. This message will be generated asynchronously to the solution messages and will be emitted anytime a sensor update is being processed.

Constructors

MsgSensorAidEvent 

Fields

Instances

Instances details
FromJSON MsgSensorAidEvent Source # 
Instance details

Defined in SwiftNav.SBP.System

ToJSON MsgSensorAidEvent Source # 
Instance details

Defined in SwiftNav.SBP.System

Read MsgSensorAidEvent Source # 
Instance details

Defined in SwiftNav.SBP.System

Show MsgSensorAidEvent Source # 
Instance details

Defined in SwiftNav.SBP.System

Binary MsgSensorAidEvent Source # 
Instance details

Defined in SwiftNav.SBP.System

Eq MsgSensorAidEvent Source # 
Instance details

Defined in SwiftNav.SBP.System

ToSBP MsgSensorAidEvent Source # 
Instance details

Defined in SwiftNav.SBP.System

data MsgGroupMeta Source #

SBP class for message MSG_GROUP_META (0xFF0A).

This leading message lists the time metadata of the Solution Group. It also lists the atomic contents (i.e. types of messages included) of the Solution Group.

Constructors

MsgGroupMeta 

Fields