Copyright	Copyright (C) 2015 Swift Navigation, Inc.
License	LGPL-3
Maintainer	Mark Fine <dev@swiftnav.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

SwiftNav.SBP

Description

SBP message containers.

Synopsis

Documentation

data Msg Source

Packet structure for Swift Navigation Binary Protocol (SBP).

Definition of the over-the-wire message framing format and packet structure for Swift Navigation Binary Protocol (SBP), a minimal binary protocol for communicating with Swift devices. It is used to transmit solutions, observations, status and debugging messages, as well as receive messages from the host operating system.

Constructors

Msg

Fields

_msgSBPType :: Word16: Uniquely identifies the type of the payload contents
_msgSBPSender :: Word16: A unique identifier of the sending hardware. For v1.0, set to the 2 least significant bytes of the device serial number
_msgSBPLen :: Word8: Byte-length of the payload field
_msgSBPPayload :: !ByteString: Binary data of the message, as identified by Message Type and Length. Usually contains the in-memory binary representation of a C struct (see documentation on individual message types)
_msgSBPCrc :: Word16: Cyclic Redundancy Check (CRC) of the packet's binary data from the Message Type up to the end of Payload (does not include the Preamble)

Instances

Eq Msg
Read Msg
Show Msg
ToJSON Msg
FromJSON Msg
Binary Msg

data SBPMsg Source

An SBP message ADT composed of all defined SBP messages.

Includes SBPMsgUnknown for valid SBP messages with undefined message types and SBPMsgBadCRC for SBP messages with invalid CRC checksums.

Constructors

SBPMsgAcqResult MsgAcqResult Msg
SBPMsgAcqResultDepA MsgAcqResultDepA Msg
SBPMsgAlmanac MsgAlmanac Msg
SBPMsgBasePos MsgBasePos Msg
SBPMsgBaselineEcef MsgBaselineEcef Msg
SBPMsgBaselineNed MsgBaselineNed Msg
SBPMsgBootloaderHandshakeDepA MsgBootloaderHandshakeDepA Msg
SBPMsgBootloaderHandshakeReq MsgBootloaderHandshakeReq Msg
SBPMsgBootloaderHandshakeResp MsgBootloaderHandshakeResp Msg
SBPMsgBootloaderJumpToApp MsgBootloaderJumpToApp Msg
SBPMsgCwResults MsgCwResults Msg
SBPMsgCwStart MsgCwStart Msg
SBPMsgDops MsgDops Msg
SBPMsgEphemeris MsgEphemeris Msg
SBPMsgEphemerisDepA MsgEphemerisDepA Msg
SBPMsgEphemerisDepB MsgEphemerisDepB Msg
SBPMsgExtEvent MsgExtEvent Msg
SBPMsgFileioReadDirReq MsgFileioReadDirReq Msg
SBPMsgFileioReadDirResp MsgFileioReadDirResp Msg
SBPMsgFileioReadReq MsgFileioReadReq Msg
SBPMsgFileioReadResp MsgFileioReadResp Msg
SBPMsgFileioRemove MsgFileioRemove Msg
SBPMsgFileioWriteReq MsgFileioWriteReq Msg
SBPMsgFileioWriteResp MsgFileioWriteResp Msg
SBPMsgFlashDone MsgFlashDone Msg
SBPMsgFlashErase MsgFlashErase Msg
SBPMsgFlashProgram MsgFlashProgram Msg
SBPMsgFlashReadReq MsgFlashReadReq Msg
SBPMsgFlashReadResp MsgFlashReadResp Msg
SBPMsgGpsTime MsgGpsTime Msg
SBPMsgHeartbeat MsgHeartbeat Msg
SBPMsgIarState MsgIarState Msg
SBPMsgInitBase MsgInitBase Msg
SBPMsgLog MsgLog Msg
SBPMsgM25FlashWriteStatus MsgM25FlashWriteStatus Msg
SBPMsgMaskSatellite MsgMaskSatellite Msg
SBPMsgNapDeviceDnaReq MsgNapDeviceDnaReq Msg
SBPMsgNapDeviceDnaResp MsgNapDeviceDnaResp Msg
SBPMsgObs MsgObs Msg
SBPMsgObsDepA MsgObsDepA Msg
SBPMsgPosEcef MsgPosEcef Msg
SBPMsgPosLlh MsgPosLlh Msg
SBPMsgPrintDep MsgPrintDep Msg
SBPMsgReset MsgReset Msg
SBPMsgResetFilters MsgResetFilters Msg
SBPMsgSetTime MsgSetTime Msg
SBPMsgSettingsReadByIndexDone MsgSettingsReadByIndexDone Msg
SBPMsgSettingsReadByIndexReq MsgSettingsReadByIndexReq Msg
SBPMsgSettingsReadByIndexResp MsgSettingsReadByIndexResp Msg
SBPMsgSettingsReadReq MsgSettingsReadReq Msg
SBPMsgSettingsReadResp MsgSettingsReadResp Msg
SBPMsgSettingsSave MsgSettingsSave Msg
SBPMsgSettingsWrite MsgSettingsWrite Msg
SBPMsgStartup MsgStartup Msg
SBPMsgStmFlashLockSector MsgStmFlashLockSector Msg
SBPMsgStmFlashUnlockSector MsgStmFlashUnlockSector Msg
SBPMsgStmUniqueIdReq MsgStmUniqueIdReq Msg
SBPMsgStmUniqueIdResp MsgStmUniqueIdResp Msg
SBPMsgThreadState MsgThreadState Msg
SBPMsgTrackingIq MsgTrackingIq Msg
SBPMsgTrackingState MsgTrackingState Msg
SBPMsgTrackingStateDepA MsgTrackingStateDepA Msg
SBPMsgTweet MsgTweet Msg
SBPMsgUartState MsgUartState Msg
SBPMsgVelEcef MsgVelEcef Msg
SBPMsgVelNed MsgVelNed Msg
SBPMsgBadCrc Msg
SBPMsgUnknown Msg

Instances

Eq SBPMsg
Read SBPMsg
Show SBPMsg
ToJSON SBPMsg
FromJSON SBPMsg
Binary SBPMsg

msgSBPPreamble :: Word8 Source

Denotes the start of frame transmission. For v1.0, always 0x55.

defaultSender :: Word16 Source

Default sender ID. Intended for messages sent from the host to the device.

module SwiftNav.SBP.Acquisition

module SwiftNav.SBP.Bootload

module SwiftNav.SBP.ExtEvents

module SwiftNav.SBP.FileIo

module SwiftNav.SBP.Flash

module SwiftNav.SBP.Logging

module SwiftNav.SBP.Navigation

module SwiftNav.SBP.Observation

module SwiftNav.SBP.Piksi

module SwiftNav.SBP.Settings

module SwiftNav.SBP.System

module SwiftNav.SBP.Tracking