SwiftNav.SBP.System

Standardized system messages from Swift Navigation devices.

Documentation

data MsgStartup

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

• _msgStartup_cause :: !Word8

  Cause of startup

• _msgStartup_startup_type :: !Word8

  Startup type

• _msgStartup_reserved :: !Word16

  Reserved

Instances

Eq MsgStartup

Defined in SwiftNav.SBP.System

Methods

(==) :: MsgStartup -> MsgStartup -> Bool

(/=) :: MsgStartup -> MsgStartup -> Bool

Read MsgStartup

Defined in SwiftNav.SBP.System

Methods

readsPrec :: Int -> ReadS MsgStartup

readList :: ReadS [MsgStartup]

readPrec :: ReadPrec MsgStartup

readListPrec :: ReadPrec [MsgStartup]

Show MsgStartup

Defined in SwiftNav.SBP.System

Methods

showsPrec :: Int -> MsgStartup -> ShowS

show :: MsgStartup -> String

showList :: [MsgStartup] -> ShowS

ToJSON MsgStartup

Defined in SwiftNav.SBP.System

Methods

toJSON :: MsgStartup -> Value

toEncoding :: MsgStartup -> Encoding

toJSONList :: [MsgStartup] -> Value

toEncodingList :: [MsgStartup] -> Encoding

FromJSON MsgStartup

Defined in SwiftNav.SBP.System

Methods

parseJSON :: Value -> Parser MsgStartup

parseJSONList :: Value -> Parser [MsgStartup]

Binary MsgStartup

Defined in SwiftNav.SBP.System

Methods

put :: MsgStartup -> Put

get :: Get MsgStartup

putList :: [MsgStartup] -> Put

ToSBP MsgStartup

Defined in SwiftNav.SBP.System

Methods

toSBP :: MsgStartup -> Word16 -> Msg

msgStartup :: Word16

data MsgDgnssStatus

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

• _msgDgnssStatus_flags :: !Word8

  Status flags

• _msgDgnssStatus_latency :: !Word16

  Latency of observation receipt

• _msgDgnssStatus_num_signals :: !Word8

  Number of signals from base station

• _msgDgnssStatus_source :: !Text

  Corrections source string

Instances

Eq MsgDgnssStatus

Defined in SwiftNav.SBP.System

Methods

(==) :: MsgDgnssStatus -> MsgDgnssStatus -> Bool

(/=) :: MsgDgnssStatus -> MsgDgnssStatus -> Bool

Read MsgDgnssStatus

Defined in SwiftNav.SBP.System

Methods

readsPrec :: Int -> ReadS MsgDgnssStatus

readList :: ReadS [MsgDgnssStatus]

readPrec :: ReadPrec MsgDgnssStatus

readListPrec :: ReadPrec [MsgDgnssStatus]

Show MsgDgnssStatus

Defined in SwiftNav.SBP.System

Methods

showsPrec :: Int -> MsgDgnssStatus -> ShowS

show :: MsgDgnssStatus -> String

showList :: [MsgDgnssStatus] -> ShowS

ToJSON MsgDgnssStatus

Defined in SwiftNav.SBP.System

Methods

toJSON :: MsgDgnssStatus -> Value

toEncoding :: MsgDgnssStatus -> Encoding

toJSONList :: [MsgDgnssStatus] -> Value

toEncodingList :: [MsgDgnssStatus] -> Encoding

FromJSON MsgDgnssStatus

Defined in SwiftNav.SBP.System

Methods

parseJSON :: Value -> Parser MsgDgnssStatus

parseJSONList :: Value -> Parser [MsgDgnssStatus]

Binary MsgDgnssStatus

Defined in SwiftNav.SBP.System

Methods

put :: MsgDgnssStatus -> Put

get :: Get MsgDgnssStatus

putList :: [MsgDgnssStatus] -> Put

ToSBP MsgDgnssStatus

Defined in SwiftNav.SBP.System

Methods

toSBP :: MsgDgnssStatus -> Word16 -> Msg

msgStartup_cause :: Lens' MsgStartup Word8

msgStartup_reserved :: Lens' MsgStartup Word16

msgStartup_startup_type :: Lens' MsgStartup Word8

msgDgnssStatus :: Word16

data MsgHeartbeat

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

• _msgHeartbeat_flags :: !Word32

  Status flags

Instances

Eq MsgHeartbeat

Defined in SwiftNav.SBP.System

Methods

(==) :: MsgHeartbeat -> MsgHeartbeat -> Bool

(/=) :: MsgHeartbeat -> MsgHeartbeat -> Bool

Read MsgHeartbeat

Defined in SwiftNav.SBP.System

Methods

readsPrec :: Int -> ReadS MsgHeartbeat

readList :: ReadS [MsgHeartbeat]

readPrec :: ReadPrec MsgHeartbeat

readListPrec :: ReadPrec [MsgHeartbeat]

Show MsgHeartbeat

Defined in SwiftNav.SBP.System

Methods

showsPrec :: Int -> MsgHeartbeat -> ShowS

show :: MsgHeartbeat -> String

showList :: [MsgHeartbeat] -> ShowS

ToJSON MsgHeartbeat

Defined in SwiftNav.SBP.System

Methods

toJSON :: MsgHeartbeat -> Value

toEncoding :: MsgHeartbeat -> Encoding

toJSONList :: [MsgHeartbeat] -> Value

toEncodingList :: [MsgHeartbeat] -> Encoding

FromJSON MsgHeartbeat

Defined in SwiftNav.SBP.System

Methods

parseJSON :: Value -> Parser MsgHeartbeat

parseJSONList :: Value -> Parser [MsgHeartbeat]

Binary MsgHeartbeat

Defined in SwiftNav.SBP.System

Methods

put :: MsgHeartbeat -> Put

get :: Get MsgHeartbeat

putList :: [MsgHeartbeat] -> Put

ToSBP MsgHeartbeat

Defined in SwiftNav.SBP.System

Methods

toSBP :: MsgHeartbeat -> Word16 -> Msg

msgDgnssStatus_flags :: Lens' MsgDgnssStatus Word8

msgDgnssStatus_latency :: Lens' MsgDgnssStatus Word16

msgDgnssStatus_num_signals :: Lens' MsgDgnssStatus Word8

msgDgnssStatus_source :: Lens' MsgDgnssStatus Text

msgHeartbeat :: Word16

data MsgInsStatus

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

• _msgInsStatus_flags :: !Word32

  Status flags

Instances

Eq MsgInsStatus

Defined in SwiftNav.SBP.System

Methods

(==) :: MsgInsStatus -> MsgInsStatus -> Bool

(/=) :: MsgInsStatus -> MsgInsStatus -> Bool

Read MsgInsStatus

Defined in SwiftNav.SBP.System

Methods

readsPrec :: Int -> ReadS MsgInsStatus

readList :: ReadS [MsgInsStatus]

readPrec :: ReadPrec MsgInsStatus

readListPrec :: ReadPrec [MsgInsStatus]

Show MsgInsStatus

Defined in SwiftNav.SBP.System

Methods

showsPrec :: Int -> MsgInsStatus -> ShowS

show :: MsgInsStatus -> String

showList :: [MsgInsStatus] -> ShowS

ToJSON MsgInsStatus

Defined in SwiftNav.SBP.System

Methods

toJSON :: MsgInsStatus -> Value

toEncoding :: MsgInsStatus -> Encoding

toJSONList :: [MsgInsStatus] -> Value

toEncodingList :: [MsgInsStatus] -> Encoding

FromJSON MsgInsStatus

Defined in SwiftNav.SBP.System

Methods

parseJSON :: Value -> Parser MsgInsStatus

parseJSONList :: Value -> Parser [MsgInsStatus]

Binary MsgInsStatus

Defined in SwiftNav.SBP.System

Methods

put :: MsgInsStatus -> Put

get :: Get MsgInsStatus

putList :: [MsgInsStatus] -> Put

ToSBP MsgInsStatus

Defined in SwiftNav.SBP.System

Methods

toSBP :: MsgInsStatus -> Word16 -> Msg

msgHeartbeat_flags :: Iso' MsgHeartbeat Word32

msgInsStatus :: Word16

data MsgCsacTelemetry

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

• _msgCsacTelemetry_id :: !Word8

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

• _msgCsacTelemetry_telemetry :: !Text

  Comma separated list of values as defined by the index

Instances

Eq MsgCsacTelemetry

Defined in SwiftNav.SBP.System

Methods

(==) :: MsgCsacTelemetry -> MsgCsacTelemetry -> Bool

(/=) :: MsgCsacTelemetry -> MsgCsacTelemetry -> Bool

Read MsgCsacTelemetry

Defined in SwiftNav.SBP.System

Methods

readsPrec :: Int -> ReadS MsgCsacTelemetry

readList :: ReadS [MsgCsacTelemetry]

readPrec :: ReadPrec MsgCsacTelemetry

readListPrec :: ReadPrec [MsgCsacTelemetry]

Show MsgCsacTelemetry

Defined in SwiftNav.SBP.System

Methods

showsPrec :: Int -> MsgCsacTelemetry -> ShowS

show :: MsgCsacTelemetry -> String

showList :: [MsgCsacTelemetry] -> ShowS

ToJSON MsgCsacTelemetry

Defined in SwiftNav.SBP.System

Methods

toJSON :: MsgCsacTelemetry -> Value

toEncoding :: MsgCsacTelemetry -> Encoding

toJSONList :: [MsgCsacTelemetry] -> Value

toEncodingList :: [MsgCsacTelemetry] -> Encoding

FromJSON MsgCsacTelemetry

Defined in SwiftNav.SBP.System

Methods

parseJSON :: Value -> Parser MsgCsacTelemetry

parseJSONList :: Value -> Parser [MsgCsacTelemetry]

Binary MsgCsacTelemetry

Defined in SwiftNav.SBP.System

Methods

put :: MsgCsacTelemetry -> Put

get :: Get MsgCsacTelemetry

putList :: [MsgCsacTelemetry] -> Put

ToSBP MsgCsacTelemetry

Defined in SwiftNav.SBP.System

Methods

toSBP :: MsgCsacTelemetry -> Word16 -> Msg

msgInsStatus_flags :: Iso' MsgInsStatus Word32

msgCsacTelemetry :: Word16

data MsgCsacTelemetryLabels

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

• _msgCsacTelemetryLabels_id :: !Word8

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

• _msgCsacTelemetryLabels_telemetry_labels :: !Text

  Comma separated list of telemetry field values

Instances

Eq MsgCsacTelemetryLabels

Defined in SwiftNav.SBP.System

Methods

(==) :: MsgCsacTelemetryLabels -> MsgCsacTelemetryLabels -> Bool

(/=) :: MsgCsacTelemetryLabels -> MsgCsacTelemetryLabels -> Bool

Read MsgCsacTelemetryLabels

Defined in SwiftNav.SBP.System

Methods

readsPrec :: Int -> ReadS MsgCsacTelemetryLabels

readList :: ReadS [MsgCsacTelemetryLabels]

readPrec :: ReadPrec MsgCsacTelemetryLabels

readListPrec :: ReadPrec [MsgCsacTelemetryLabels]

Show MsgCsacTelemetryLabels

Defined in SwiftNav.SBP.System

Methods

showsPrec :: Int -> MsgCsacTelemetryLabels -> ShowS

show :: MsgCsacTelemetryLabels -> String

showList :: [MsgCsacTelemetryLabels] -> ShowS

ToJSON MsgCsacTelemetryLabels

Defined in SwiftNav.SBP.System

Methods

toJSON :: MsgCsacTelemetryLabels -> Value

toEncoding :: MsgCsacTelemetryLabels -> Encoding

toJSONList :: [MsgCsacTelemetryLabels] -> Value

toEncodingList :: [MsgCsacTelemetryLabels] -> Encoding

FromJSON MsgCsacTelemetryLabels

Defined in SwiftNav.SBP.System

Methods

parseJSON :: Value -> Parser MsgCsacTelemetryLabels

parseJSONList :: Value -> Parser [MsgCsacTelemetryLabels]

Binary MsgCsacTelemetryLabels

Defined in SwiftNav.SBP.System

Methods

put :: MsgCsacTelemetryLabels -> Put

get :: Get MsgCsacTelemetryLabels

putList :: [MsgCsacTelemetryLabels] -> Put

ToSBP MsgCsacTelemetryLabels

Defined in SwiftNav.SBP.System

Methods

toSBP :: MsgCsacTelemetryLabels -> Word16 -> Msg

msgCsacTelemetry_id :: Lens' MsgCsacTelemetry Word8

msgCsacTelemetry_telemetry :: Lens' MsgCsacTelemetry Text

msgCsacTelemetryLabels :: Word16

msgCsacTelemetryLabels_id :: Lens' MsgCsacTelemetryLabels Word8

msgCsacTelemetryLabels_telemetry_labels :: Lens' MsgCsacTelemetryLabels Text