Copyright | Copyright (C) 2015-2018 Swift Navigation Inc. |
---|---|
License | MIT |
Stability | experimental |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
SwiftNav.SBP.System
Description
< Standardized system messages from Swift Navigation devices. >
Synopsis
- data MsgStartup = MsgStartup {}
- msgStartup :: Word16
- data MsgDgnssStatus = MsgDgnssStatus {}
- msgStartup_cause :: Lens' MsgStartup Word8
- msgStartup_reserved :: Lens' MsgStartup Word16
- msgStartup_startup_type :: Lens' MsgStartup Word8
- msgDgnssStatus :: Word16
- data MsgHeartbeat = MsgHeartbeat {}
- msgDgnssStatus_flags :: Lens' MsgDgnssStatus Word8
- msgDgnssStatus_latency :: Lens' MsgDgnssStatus Word16
- msgDgnssStatus_num_signals :: Lens' MsgDgnssStatus Word8
- msgDgnssStatus_source :: Lens' MsgDgnssStatus Text
- msgHeartbeat :: Word16
- data SubSystemReport = SubSystemReport {}
- msgHeartbeat_flags :: Iso' MsgHeartbeat Word32
- data MsgStatusReport = MsgStatusReport {}
- subSystemReport_component :: Lens' SubSystemReport Word16
- subSystemReport_generic :: Lens' SubSystemReport Word8
- subSystemReport_specific :: Lens' SubSystemReport Word8
- msgStatusReport :: Word16
- data MsgInsStatus = MsgInsStatus {}
- msgStatusReport_reporting_system :: Lens' MsgStatusReport Word16
- msgStatusReport_sbp_version :: Lens' MsgStatusReport Word16
- msgStatusReport_sequence :: Lens' MsgStatusReport Word32
- msgStatusReport_status :: Lens' MsgStatusReport [SubSystemReport]
- msgStatusReport_uptime :: Lens' MsgStatusReport Word32
- msgInsStatus :: Word16
- data MsgCsacTelemetry = MsgCsacTelemetry {}
- msgInsStatus_flags :: Iso' MsgInsStatus Word32
- msgCsacTelemetry :: Word16
- data MsgCsacTelemetryLabels = MsgCsacTelemetryLabels {}
- msgCsacTelemetry_id :: Lens' MsgCsacTelemetry Word8
- msgCsacTelemetry_telemetry :: Lens' MsgCsacTelemetry Text
- msgCsacTelemetryLabels :: Word16
- data MsgInsUpdates = MsgInsUpdates {}
- msgCsacTelemetryLabels_id :: Lens' MsgCsacTelemetryLabels Word8
- msgCsacTelemetryLabels_telemetry_labels :: Lens' MsgCsacTelemetryLabels Text
- msgInsUpdates :: Word16
- data MsgGnssTimeOffset = MsgGnssTimeOffset {}
- msgInsUpdates_gnsspos :: Lens' MsgInsUpdates Word8
- msgInsUpdates_gnssvel :: Lens' MsgInsUpdates Word8
- msgInsUpdates_nhc :: Lens' MsgInsUpdates Word8
- msgInsUpdates_speed :: Lens' MsgInsUpdates Word8
- msgInsUpdates_tow :: Lens' MsgInsUpdates Word32
- msgInsUpdates_wheelticks :: Lens' MsgInsUpdates Word8
- msgInsUpdates_zerovel :: Lens' MsgInsUpdates Word8
- msgGnssTimeOffset :: Word16
- data MsgPpsTime = MsgPpsTime {}
- msgGnssTimeOffset_flags :: Lens' MsgGnssTimeOffset Word8
- msgGnssTimeOffset_microseconds :: Lens' MsgGnssTimeOffset Int16
- msgGnssTimeOffset_milliseconds :: Lens' MsgGnssTimeOffset Int32
- msgGnssTimeOffset_weeks :: Lens' MsgGnssTimeOffset Int16
- msgPpsTime :: Word16
- data MsgGroupMeta = MsgGroupMeta {}
- msgPpsTime_flags :: Lens' MsgPpsTime Word8
- msgPpsTime_time :: Lens' MsgPpsTime Word64
- msgGroupMeta :: Word16
- msgGroupMeta_flags :: Lens' MsgGroupMeta Word8
- msgGroupMeta_group_id :: Lens' MsgGroupMeta Word8
- msgGroupMeta_group_msgs :: Lens' MsgGroupMeta [Word16]
- msgGroupMeta_n_group_msgs :: Lens' MsgGroupMeta Word8
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
|
Instances
Eq MsgStartup Source # | |
Defined in SwiftNav.SBP.System | |
Read MsgStartup Source # | |
Defined in SwiftNav.SBP.System Methods readsPrec :: Int -> ReadS MsgStartup # readList :: ReadS [MsgStartup] # readPrec :: ReadPrec MsgStartup # readListPrec :: ReadPrec [MsgStartup] # | |
Show MsgStartup Source # | |
Defined in SwiftNav.SBP.System Methods showsPrec :: Int -> MsgStartup -> ShowS # show :: MsgStartup -> String # showList :: [MsgStartup] -> ShowS # | |
ToJSON MsgStartup Source # | |
Defined in SwiftNav.SBP.System Methods toJSON :: MsgStartup -> Value # toEncoding :: MsgStartup -> Encoding # toJSONList :: [MsgStartup] -> Value # toEncodingList :: [MsgStartup] -> Encoding # | |
FromJSON MsgStartup Source # | |
Defined in SwiftNav.SBP.System | |
Binary MsgStartup Source # | |
Defined in SwiftNav.SBP.System | |
ToSBP MsgStartup Source # | |
Defined in SwiftNav.SBP.System |
msgStartup :: Word16 Source #
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
|
Instances
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
|
Instances
Eq MsgHeartbeat Source # | |
Defined in SwiftNav.SBP.System | |
Read MsgHeartbeat Source # | |
Defined in SwiftNav.SBP.System Methods readsPrec :: Int -> ReadS MsgHeartbeat # readList :: ReadS [MsgHeartbeat] # | |
Show MsgHeartbeat Source # | |
Defined in SwiftNav.SBP.System Methods showsPrec :: Int -> MsgHeartbeat -> ShowS # show :: MsgHeartbeat -> String # showList :: [MsgHeartbeat] -> ShowS # | |
ToJSON MsgHeartbeat Source # | |
Defined in SwiftNav.SBP.System Methods toJSON :: MsgHeartbeat -> Value # toEncoding :: MsgHeartbeat -> Encoding # toJSONList :: [MsgHeartbeat] -> Value # toEncodingList :: [MsgHeartbeat] -> Encoding # | |
FromJSON MsgHeartbeat Source # | |
Defined in SwiftNav.SBP.System | |
Binary MsgHeartbeat Source # | |
Defined in SwiftNav.SBP.System | |
ToSBP MsgHeartbeat Source # | |
Defined in SwiftNav.SBP.System |
data SubSystemReport Source #
SubSystemReport.
Report the general and specific state of a sub-system. If the generic state is reported as initializing, the specific state should be ignored.
Constructors
SubSystemReport | |
Fields
|
Instances
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 sub-system 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
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
|
Instances
Eq MsgInsStatus Source # | |
Defined in SwiftNav.SBP.System | |
Read MsgInsStatus Source # | |
Defined in SwiftNav.SBP.System Methods readsPrec :: Int -> ReadS MsgInsStatus # readList :: ReadS [MsgInsStatus] # | |
Show MsgInsStatus Source # | |
Defined in SwiftNav.SBP.System Methods showsPrec :: Int -> MsgInsStatus -> ShowS # show :: MsgInsStatus -> String # showList :: [MsgInsStatus] -> ShowS # | |
ToJSON MsgInsStatus Source # | |
Defined in SwiftNav.SBP.System Methods toJSON :: MsgInsStatus -> Value # toEncoding :: MsgInsStatus -> Encoding # toJSONList :: [MsgInsStatus] -> Value # toEncodingList :: [MsgInsStatus] -> Encoding # | |
FromJSON MsgInsStatus Source # | |
Defined in SwiftNav.SBP.System | |
Binary MsgInsStatus Source # | |
Defined in SwiftNav.SBP.System | |
ToSBP MsgInsStatus Source # | |
Defined in SwiftNav.SBP.System |
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
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
data MsgInsUpdates Source #
SBP class for message MSG_INS_UPDATES (0xFF06).
The INS update status message contains informations 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
|
Instances
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
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 syncronisation 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. A separate MSG_PPS_TIME message should be sent for each source of sensor data which uses PPS-relative 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
|
Instances
Eq MsgPpsTime Source # | |
Defined in SwiftNav.SBP.System | |
Read MsgPpsTime Source # | |
Defined in SwiftNav.SBP.System Methods readsPrec :: Int -> ReadS MsgPpsTime # readList :: ReadS [MsgPpsTime] # readPrec :: ReadPrec MsgPpsTime # readListPrec :: ReadPrec [MsgPpsTime] # | |
Show MsgPpsTime Source # | |
Defined in SwiftNav.SBP.System Methods showsPrec :: Int -> MsgPpsTime -> ShowS # show :: MsgPpsTime -> String # showList :: [MsgPpsTime] -> ShowS # | |
ToJSON MsgPpsTime Source # | |
Defined in SwiftNav.SBP.System Methods toJSON :: MsgPpsTime -> Value # toEncoding :: MsgPpsTime -> Encoding # toJSONList :: [MsgPpsTime] -> Value # toEncodingList :: [MsgPpsTime] -> Encoding # | |
FromJSON MsgPpsTime Source # | |
Defined in SwiftNav.SBP.System | |
Binary MsgPpsTime Source # | |
Defined in SwiftNav.SBP.System | |
ToSBP MsgPpsTime Source # | |
Defined in SwiftNav.SBP.System |
msgPpsTime :: Word16 Source #
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
|
Instances
Eq MsgGroupMeta Source # | |
Defined in SwiftNav.SBP.System | |
Read MsgGroupMeta Source # | |
Defined in SwiftNav.SBP.System Methods readsPrec :: Int -> ReadS MsgGroupMeta # readList :: ReadS [MsgGroupMeta] # | |
Show MsgGroupMeta Source # | |
Defined in SwiftNav.SBP.System Methods showsPrec :: Int -> MsgGroupMeta -> ShowS # show :: MsgGroupMeta -> String # showList :: [MsgGroupMeta] -> ShowS # | |
ToJSON MsgGroupMeta Source # | |
Defined in SwiftNav.SBP.System Methods toJSON :: MsgGroupMeta -> Value # toEncoding :: MsgGroupMeta -> Encoding # toJSONList :: [MsgGroupMeta] -> Value # toEncodingList :: [MsgGroupMeta] -> Encoding # | |
FromJSON MsgGroupMeta Source # | |
Defined in SwiftNav.SBP.System | |
Binary MsgGroupMeta Source # | |
Defined in SwiftNav.SBP.System | |
ToSBP MsgGroupMeta Source # | |
Defined in SwiftNav.SBP.System |