sbp-2.2.8: SwiftNav's SBP Library

CopyrightCopyright (C) 2015 Swift Navigation Inc.
LicenseLGPL-3
MaintainerMark Fine <dev@swiftnav.com>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

SwiftNav.SBP

Description

SBP message containers.

Synopsis

Documentation

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 
SBPMsgAcqResultDepB MsgAcqResultDepB Msg 
SBPMsgAcqSvProfile MsgAcqSvProfile Msg 
SBPMsgAgeCorrections MsgAgeCorrections Msg 
SBPMsgAlmanac MsgAlmanac Msg 
SBPMsgAlmanacGlo MsgAlmanacGlo Msg 
SBPMsgAlmanacGps MsgAlmanacGps Msg 
SBPMsgBasePosEcef MsgBasePosEcef Msg 
SBPMsgBasePosLlh MsgBasePosLlh Msg 
SBPMsgBaselineEcef MsgBaselineEcef Msg 
SBPMsgBaselineEcefDepA MsgBaselineEcefDepA Msg 
SBPMsgBaselineHeading MsgBaselineHeading Msg 
SBPMsgBaselineHeadingDepA MsgBaselineHeadingDepA Msg 
SBPMsgBaselineNed MsgBaselineNed Msg 
SBPMsgBaselineNedDepA MsgBaselineNedDepA Msg 
SBPMsgBootloaderHandshakeDepA MsgBootloaderHandshakeDepA Msg 
SBPMsgBootloaderHandshakeReq MsgBootloaderHandshakeReq Msg 
SBPMsgBootloaderHandshakeResp MsgBootloaderHandshakeResp Msg 
SBPMsgBootloaderJumpToApp MsgBootloaderJumpToApp Msg 
SBPMsgCommandOutput MsgCommandOutput Msg 
SBPMsgCommandReq MsgCommandReq Msg 
SBPMsgCommandResp MsgCommandResp Msg 
SBPMsgCwResults MsgCwResults Msg 
SBPMsgCwStart MsgCwStart Msg 
SBPMsgDeviceMonitor MsgDeviceMonitor Msg 
SBPMsgDgnssStatus MsgDgnssStatus Msg 
SBPMsgDops MsgDops Msg 
SBPMsgDopsDepA MsgDopsDepA Msg 
SBPMsgEphemerisDepA MsgEphemerisDepA Msg 
SBPMsgEphemerisDepB MsgEphemerisDepB Msg 
SBPMsgEphemerisDepC MsgEphemerisDepC Msg 
SBPMsgEphemerisDepD MsgEphemerisDepD Msg 
SBPMsgEphemerisGlo MsgEphemerisGlo Msg 
SBPMsgEphemerisGloDepA MsgEphemerisGloDepA Msg 
SBPMsgEphemerisGloDepB MsgEphemerisGloDepB Msg 
SBPMsgEphemerisGloDepC MsgEphemerisGloDepC Msg 
SBPMsgEphemerisGps MsgEphemerisGps Msg 
SBPMsgEphemerisGpsDepE MsgEphemerisGpsDepE Msg 
SBPMsgEphemerisSbas MsgEphemerisSbas Msg 
SBPMsgEphemerisSbasDepA MsgEphemerisSbasDepA Msg 
SBPMsgExtEvent MsgExtEvent Msg 
SBPMsgFcnsGlo MsgFcnsGlo 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 
SBPMsgFwd MsgFwd Msg 
SBPMsgGpsTime MsgGpsTime Msg 
SBPMsgGpsTimeDepA MsgGpsTimeDepA Msg 
SBPMsgGroupDelay MsgGroupDelay Msg 
SBPMsgGroupDelayDepA MsgGroupDelayDepA Msg 
SBPMsgHeartbeat MsgHeartbeat Msg 
SBPMsgIarState MsgIarState Msg 
SBPMsgImuAux MsgImuAux Msg 
SBPMsgImuRaw MsgImuRaw Msg 
SBPMsgInitBase MsgInitBase Msg 
SBPMsgIono MsgIono Msg 
SBPMsgLog MsgLog Msg 
SBPMsgM25FlashWriteStatus MsgM25FlashWriteStatus Msg 
SBPMsgMaskSatellite MsgMaskSatellite Msg 
SBPMsgNapDeviceDnaReq MsgNapDeviceDnaReq Msg 
SBPMsgNapDeviceDnaResp MsgNapDeviceDnaResp Msg 
SBPMsgNdbEvent MsgNdbEvent Msg 
SBPMsgNetworkStateReq MsgNetworkStateReq Msg 
SBPMsgNetworkStateResp MsgNetworkStateResp Msg 
SBPMsgObs MsgObs Msg 
SBPMsgObsDepA MsgObsDepA Msg 
SBPMsgObsDepB MsgObsDepB Msg 
SBPMsgObsDepC MsgObsDepC Msg 
SBPMsgPosEcef MsgPosEcef Msg 
SBPMsgPosEcefDepA MsgPosEcefDepA Msg 
SBPMsgPosLlh MsgPosLlh Msg 
SBPMsgPosLlhDepA MsgPosLlhDepA Msg 
SBPMsgPrintDep MsgPrintDep Msg 
SBPMsgReset MsgReset Msg 
SBPMsgResetDep MsgResetDep Msg 
SBPMsgResetFilters MsgResetFilters Msg 
SBPMsgSetTime MsgSetTime Msg 
SBPMsgSettingsReadByIndexDone MsgSettingsReadByIndexDone Msg 
SBPMsgSettingsReadByIndexReq MsgSettingsReadByIndexReq Msg 
SBPMsgSettingsReadByIndexResp MsgSettingsReadByIndexResp Msg 
SBPMsgSettingsReadReq MsgSettingsReadReq Msg 
SBPMsgSettingsReadResp MsgSettingsReadResp Msg 
SBPMsgSettingsRegister MsgSettingsRegister Msg 
SBPMsgSettingsSave MsgSettingsSave Msg 
SBPMsgSettingsWrite MsgSettingsWrite Msg 
SBPMsgSpecan MsgSpecan Msg 
SBPMsgStartup MsgStartup Msg 
SBPMsgStmFlashLockSector MsgStmFlashLockSector Msg 
SBPMsgStmFlashUnlockSector MsgStmFlashUnlockSector Msg 
SBPMsgStmUniqueIdReq MsgStmUniqueIdReq Msg 
SBPMsgStmUniqueIdResp MsgStmUniqueIdResp Msg 
SBPMsgSvConfigurationGps MsgSvConfigurationGps Msg 
SBPMsgThreadState MsgThreadState Msg 
SBPMsgTrackingIq MsgTrackingIq Msg 
SBPMsgTrackingState MsgTrackingState Msg 
SBPMsgTrackingStateDepA MsgTrackingStateDepA Msg 
SBPMsgTrackingStateDepB MsgTrackingStateDepB Msg 
SBPMsgTrackingStateDetailed MsgTrackingStateDetailed Msg 
SBPMsgTweet MsgTweet Msg 
SBPMsgUartState MsgUartState Msg 
SBPMsgUartStateDepa MsgUartStateDepa Msg 
SBPMsgUserData MsgUserData Msg 
SBPMsgUtcTime MsgUtcTime Msg 
SBPMsgVelEcef MsgVelEcef Msg 
SBPMsgVelEcefDepA MsgVelEcefDepA Msg 
SBPMsgVelNed MsgVelNed Msg 
SBPMsgVelNedDepA MsgVelNedDepA Msg 
SBPMsgBadCrc Msg 
SBPMsgUnknown Msg 

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.

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)

class Binary a => ToSBP a where Source #

Class of generic representation of specialized SBP messages into SBP message frames.

Minimal complete definition

toSBP

Methods

toSBP :: a -> Word16 -> Msg Source #

Convert an SBP message record that is serializable and a two-byte senderID to a binary into an SBP message frame.

Instances

ToSBP MsgBootloaderHandshakeReq Source # 
ToSBP MsgBootloaderHandshakeResp Source # 
ToSBP MsgBootloaderJumpToApp Source # 
ToSBP MsgNapDeviceDnaReq Source # 
ToSBP MsgNapDeviceDnaResp Source # 
ToSBP MsgBootloaderHandshakeDepA Source # 
ToSBP MsgExtEvent Source # 
ToSBP MsgFileioReadReq Source # 
ToSBP MsgFileioReadResp Source # 
ToSBP MsgFileioReadDirReq Source # 
ToSBP MsgFileioReadDirResp Source # 
ToSBP MsgFileioRemove Source # 
ToSBP MsgFileioWriteReq Source # 
ToSBP MsgFileioWriteResp Source # 
ToSBP MsgFlashProgram Source # 
ToSBP MsgFlashDone Source # 
ToSBP MsgFlashReadReq Source # 
ToSBP MsgFlashReadResp Source # 
ToSBP MsgFlashErase Source # 
ToSBP MsgStmFlashLockSector Source # 
ToSBP MsgStmFlashUnlockSector Source # 
ToSBP MsgStmUniqueIdReq Source # 
ToSBP MsgStmUniqueIdResp Source # 
ToSBP MsgM25FlashWriteStatus Source # 
ToSBP MsgAcqResult Source # 
ToSBP MsgAcqResultDepB Source # 
ToSBP MsgAcqResultDepA Source # 
ToSBP MsgAcqSvProfile Source # 
ToSBP MsgImuRaw Source # 

Methods

toSBP :: MsgImuRaw -> Word16 -> Msg Source #

ToSBP MsgImuAux Source # 

Methods

toSBP :: MsgImuAux -> Word16 -> Msg Source #

ToSBP MsgLog Source # 

Methods

toSBP :: MsgLog -> Word16 -> Msg Source #

ToSBP MsgFwd Source # 

Methods

toSBP :: MsgFwd -> Word16 -> Msg Source #

ToSBP MsgTweet Source # 

Methods

toSBP :: MsgTweet -> Word16 -> Msg Source #

ToSBP MsgPrintDep Source # 
ToSBP MsgGpsTime Source # 

Methods

toSBP :: MsgGpsTime -> Word16 -> Msg Source #

ToSBP MsgUtcTime Source # 

Methods

toSBP :: MsgUtcTime -> Word16 -> Msg Source #

ToSBP MsgDops Source # 

Methods

toSBP :: MsgDops -> Word16 -> Msg Source #

ToSBP MsgPosEcef Source # 

Methods

toSBP :: MsgPosEcef -> Word16 -> Msg Source #

ToSBP MsgPosLlh Source # 

Methods

toSBP :: MsgPosLlh -> Word16 -> Msg Source #

ToSBP MsgBaselineEcef Source # 
ToSBP MsgBaselineNed Source # 
ToSBP MsgVelEcef Source # 

Methods

toSBP :: MsgVelEcef -> Word16 -> Msg Source #

ToSBP MsgVelNed Source # 

Methods

toSBP :: MsgVelNed -> Word16 -> Msg Source #

ToSBP MsgBaselineHeading Source # 
ToSBP MsgAgeCorrections Source # 
ToSBP MsgGpsTimeDepA Source # 
ToSBP MsgDopsDepA Source # 
ToSBP MsgPosEcefDepA Source # 
ToSBP MsgPosLlhDepA Source # 
ToSBP MsgBaselineEcefDepA Source # 
ToSBP MsgBaselineNedDepA Source # 
ToSBP MsgVelEcefDepA Source # 
ToSBP MsgVelNedDepA Source # 
ToSBP MsgBaselineHeadingDepA Source # 
ToSBP MsgNdbEvent Source # 
ToSBP MsgObs Source # 

Methods

toSBP :: MsgObs -> Word16 -> Msg Source #

ToSBP MsgBasePosLlh Source # 
ToSBP MsgBasePosEcef Source # 
ToSBP MsgEphemerisGpsDepE Source # 
ToSBP MsgEphemerisGps Source # 
ToSBP MsgEphemerisSbasDepA Source # 
ToSBP MsgEphemerisGloDepA Source # 
ToSBP MsgEphemerisSbas Source # 
ToSBP MsgEphemerisGloDepB Source # 
ToSBP MsgEphemerisGloDepC Source # 
ToSBP MsgEphemerisGlo Source # 
ToSBP MsgEphemerisDepD Source # 
ToSBP MsgEphemerisDepA Source # 
ToSBP MsgEphemerisDepB Source # 
ToSBP MsgEphemerisDepC Source # 
ToSBP MsgObsDepA Source # 

Methods

toSBP :: MsgObsDepA -> Word16 -> Msg Source #

ToSBP MsgObsDepB Source # 

Methods

toSBP :: MsgObsDepB -> Word16 -> Msg Source #

ToSBP MsgObsDepC Source # 

Methods

toSBP :: MsgObsDepC -> Word16 -> Msg Source #

ToSBP MsgIono Source # 

Methods

toSBP :: MsgIono -> Word16 -> Msg Source #

ToSBP MsgSvConfigurationGps Source # 
ToSBP MsgGroupDelayDepA Source # 
ToSBP MsgGroupDelay Source # 
ToSBP MsgAlmanacGps Source # 
ToSBP MsgAlmanacGlo Source # 
ToSBP MsgFcnsGlo Source # 

Methods

toSBP :: MsgFcnsGlo -> Word16 -> Msg Source #

ToSBP MsgAlmanac Source # 

Methods

toSBP :: MsgAlmanac -> Word16 -> Msg Source #

ToSBP MsgSetTime Source # 

Methods

toSBP :: MsgSetTime -> Word16 -> Msg Source #

ToSBP MsgReset Source # 

Methods

toSBP :: MsgReset -> Word16 -> Msg Source #

ToSBP MsgResetDep Source # 
ToSBP MsgCwResults Source # 
ToSBP MsgCwStart Source # 

Methods

toSBP :: MsgCwStart -> Word16 -> Msg Source #

ToSBP MsgResetFilters Source # 
ToSBP MsgInitBase Source # 
ToSBP MsgThreadState Source # 
ToSBP MsgUartState Source # 
ToSBP MsgUartStateDepa Source # 
ToSBP MsgIarState Source # 
ToSBP MsgMaskSatellite Source # 
ToSBP MsgDeviceMonitor Source # 
ToSBP MsgCommandReq Source # 
ToSBP MsgCommandResp Source # 
ToSBP MsgCommandOutput Source # 
ToSBP MsgNetworkStateReq Source # 
ToSBP MsgNetworkStateResp Source # 
ToSBP MsgSpecan Source # 

Methods

toSBP :: MsgSpecan -> Word16 -> Msg Source #

ToSBP MsgSettingsSave Source # 
ToSBP MsgSettingsWrite Source # 
ToSBP MsgSettingsReadReq Source # 
ToSBP MsgSettingsReadResp Source # 
ToSBP MsgSettingsReadByIndexReq Source # 
ToSBP MsgSettingsReadByIndexResp Source # 
ToSBP MsgSettingsReadByIndexDone Source # 
ToSBP MsgSettingsRegister Source # 
ToSBP MsgStartup Source # 

Methods

toSBP :: MsgStartup -> Word16 -> Msg Source #

ToSBP MsgDgnssStatus Source # 
ToSBP MsgHeartbeat Source # 
ToSBP MsgTrackingStateDetailed Source # 
ToSBP MsgTrackingState Source # 
ToSBP MsgTrackingIq Source # 
ToSBP MsgTrackingStateDepA Source # 
ToSBP MsgTrackingStateDepB Source # 
ToSBP MsgUserData Source # 

data MsgAcqResult Source #

SBP class for message MSG_ACQ_RESULT (0x001F).

This message describes the results from an attempted GPS signal acquisition search for a satellite PRN over a code phase/carrier frequency range. It contains the parameters of the point in the acquisition search space with the best carrier-to-noise (CN/0) ratio.

Constructors

MsgAcqResult 

Fields

data MsgAcqResultDepB Source #

SBP class for message MSG_ACQ_RESULT_DEP_B (0x0014).

Deprecated.

Constructors

MsgAcqResultDepB 

Fields

data MsgAcqResultDepA Source #

SBP class for message MSG_ACQ_RESULT_DEP_A (0x0015).

Deprecated.

Constructors

MsgAcqResultDepA 

Fields

data AcqSvProfile Source #

AcqSvProfile.

Profile for a specific SV for debugging purposes The message describes SV profile during acquisition time. The message is used to debug and measure the performance.

Constructors

AcqSvProfile 

Fields

data MsgBootloaderHandshakeReq Source #

SBP class for message MSG_BOOTLOADER_HANDSHAKE_REQ (0x00B3).

The handshake message request from the host establishes a handshake between the device bootloader and the host. The response from the device is MSG_BOOTLOADER_HANDSHAKE_RESP.

data MsgBootloaderHandshakeResp Source #

SBP class for message MSG_BOOTLOADER_HANDSHAKE_RESP (0x00B4).

The handshake message response from the device establishes a handshake between the device bootloader and the host. The request from the host is MSG_BOOTLOADER_HANDSHAKE_REQ. The payload contains the bootloader version number and the SBP protocol version number.

Constructors

MsgBootloaderHandshakeResp 

Fields

data MsgBootloaderJumpToApp Source #

SBP class for message MSG_BOOTLOADER_JUMP_TO_APP (0x00B1).

The host initiates the bootloader to jump to the application.

Constructors

MsgBootloaderJumpToApp 

Fields

data MsgNapDeviceDnaReq Source #

SBP class for message MSG_NAP_DEVICE_DNA_REQ (0x00DE).

The device message from the host reads a unique device identifier from the SwiftNAP, an FPGA. The host requests the ID by sending a MSG_NAP_DEVICE_DNA_REQ message. The device responds with a MSG_NAP_DEVICE_DNA_RESP message with the device ID in the payload. Note that this ID is tied to the FPGA, and not related to the Piksi's serial number.

Constructors

MsgNapDeviceDnaReq 

data MsgNapDeviceDnaResp Source #

SBP class for message MSG_NAP_DEVICE_DNA_RESP (0x00DD).

The device message from the host reads a unique device identifier from the SwiftNAP, an FPGA. The host requests the ID by sending a MSG_NAP_DEVICE_DNA_REQ message. The device responds with a MSG_NAP_DEVICE_DNA_RESP messagage with the device ID in the payload. Note that this ID is tied to the FPGA, and not related to the Piksi's serial number.

Constructors

MsgNapDeviceDnaResp 

Fields

data MsgBootloaderHandshakeDepA Source #

SBP class for message MSG_BOOTLOADER_HANDSHAKE_DEP_A (0x00B0).

Deprecated.

Constructors

MsgBootloaderHandshakeDepA 

Fields

data MsgExtEvent Source #

SBP class for message MSG_EXT_EVENT (0x0101).

Reports detection of an external event, the GPS time it occurred, which pin it was and whether it was rising or falling.

Constructors

MsgExtEvent 

Fields

data MsgFileioReadReq Source #

SBP class for message MSG_FILEIO_READ_REQ (0x00A8).

The file read message reads a certain length (up to 255 bytes) from a given offset into a file, and returns the data in a MSG_FILEIO_READ_RESP message where the message length field indicates how many bytes were succesfully read.The sequence number in the request will be returned in the response. If the message is invalid, a followup MSG_PRINT message will print "Invalid fileio read message". A device will only respond to this message when it is received from sender ID 0x42.

Constructors

MsgFileioReadReq 

Fields

data MsgFileioReadResp Source #

SBP class for message MSG_FILEIO_READ_RESP (0x00A3).

The file read message reads a certain length (up to 255 bytes) from a given offset into a file, and returns the data in a message where the message length field indicates how many bytes were succesfully read. The sequence number in the response is preserved from the request.

Constructors

MsgFileioReadResp 

Fields

data MsgFileioReadDirReq Source #

SBP class for message MSG_FILEIO_READ_DIR_REQ (0x00A9).

The read directory message lists the files in a directory on the device's onboard flash file system. The offset parameter can be used to skip the first n elements of the file list. Returns a MSG_FILEIO_READ_DIR_RESP message containing the directory listings as a NULL delimited list. The listing is chunked over multiple SBP packets. The sequence number in the request will be returned in the response. If message is invalid, a followup MSG_PRINT message will print "Invalid fileio read message". A device will only respond to this message when it is received from sender ID 0x42.

Constructors

MsgFileioReadDirReq 

Fields

data MsgFileioReadDirResp Source #

SBP class for message MSG_FILEIO_READ_DIR_RESP (0x00AA).

The read directory message lists the files in a directory on the device's onboard flash file system. Message contains the directory listings as a NULL delimited list. The listing is chunked over multiple SBP packets and the end of the list is identified by an entry containing just the character 0xFF. The sequence number in the response is preserved from the request.

Constructors

MsgFileioReadDirResp 

Fields

data MsgFileioRemove Source #

SBP class for message MSG_FILEIO_REMOVE (0x00AC).

The file remove message deletes a file from the file system. If the message is invalid, a followup MSG_PRINT message will print "Invalid fileio remove message". A device will only process this message when it is received from sender ID 0x42.

Constructors

MsgFileioRemove 

Fields

data MsgFileioWriteReq Source #

SBP class for message MSG_FILEIO_WRITE_REQ (0x00AD).

The file write message writes a certain length (up to 255 bytes) of data to a file at a given offset. Returns a copy of the original MSG_FILEIO_WRITE_RESP message to check integrity of the write. The sequence number in the request will be returned in the response. If message is invalid, a followup MSG_PRINT message will print "Invalid fileio write message". A device will only process this message when it is received from sender ID 0x42.

Constructors

MsgFileioWriteReq 

Fields

data MsgFileioWriteResp Source #

SBP class for message MSG_FILEIO_WRITE_RESP (0x00AB).

The file write message writes a certain length (up to 255 bytes) of data to a file at a given offset. The message is a copy of the original MSG_FILEIO_WRITE_REQ message to check integrity of the write. The sequence number in the response is preserved from the request.

Constructors

MsgFileioWriteResp 

Fields

data MsgFlashProgram Source #

SBP class for message MSG_FLASH_PROGRAM (0x00E6).

The flash program message programs a set of addresses of either the STM or M25 flash. The device replies with either a MSG_FLASH_DONE message containing the return code FLASH_OK (0) on success, or FLASH_INVALID_LEN (2) if the maximum write size is exceeded. Note that the sector-containing addresses must be erased before addresses can be programmed.

Constructors

MsgFlashProgram 

Fields

data MsgFlashDone Source #

SBP class for message MSG_FLASH_DONE (0x00E0).

This message defines success or failure codes for a variety of flash memory requests from the host to the device. Flash read and write messages, such as MSG_FLASH_READ_REQ, or MSG_FLASH_PROGRAM, may return this message on failure.

Constructors

MsgFlashDone 

Fields

data MsgFlashReadReq Source #

SBP class for message MSG_FLASH_READ_REQ (0x00E7).

The flash read message reads a set of addresses of either the STM or M25 onboard flash. The device replies with a MSG_FLASH_READ_RESP message containing either the read data on success or a MSG_FLASH_DONE message containing the return code FLASH_INVALID_LEN (2) if the maximum read size is exceeded or FLASH_INVALID_ADDR (3) if the address is outside of the allowed range.

Constructors

MsgFlashReadReq 

Fields

data MsgFlashReadResp Source #

SBP class for message MSG_FLASH_READ_RESP (0x00E1).

The flash read message reads a set of addresses of either the STM or M25 onboard flash. The device replies with a MSG_FLASH_READ_RESP message containing either the read data on success or a MSG_FLASH_DONE message containing the return code FLASH_INVALID_LEN (2) if the maximum read size is exceeded or FLASH_INVALID_ADDR (3) if the address is outside of the allowed range.

Constructors

MsgFlashReadResp 

Fields

data MsgFlashErase Source #

SBP class for message MSG_FLASH_ERASE (0x00E2).

The flash erase message from the host erases a sector of either the STM or M25 onboard flash memory. The device will reply with a MSG_FLASH_DONE message containing the return code - FLASH_OK (0) on success or FLASH_INVALID_FLASH (1) if the flash specified is invalid.

Constructors

MsgFlashErase 

Fields

data MsgStmFlashLockSector Source #

SBP class for message MSG_STM_FLASH_LOCK_SECTOR (0x00E3).

The flash lock message locks a sector of the STM flash memory. The device replies with a MSG_FLASH_DONE message.

Constructors

MsgStmFlashLockSector 

Fields

data MsgStmFlashUnlockSector Source #

SBP class for message MSG_STM_FLASH_UNLOCK_SECTOR (0x00E4).

The flash unlock message unlocks a sector of the STM flash memory. The device replies with a MSG_FLASH_DONE message.

Constructors

MsgStmFlashUnlockSector 

Fields

data MsgStmUniqueIdResp Source #

SBP class for message MSG_STM_UNIQUE_ID_RESP (0x00E5).

This message reads the device's hardcoded unique ID. The host requests the ID by sending a MSG_STM_UNIQUE_ID_REQ. The device responds with a MSG_STM_UNIQUE_ID_RESP with the 12-byte unique ID in the payload..

Constructors

MsgStmUniqueIdResp 

Fields

data MsgM25FlashWriteStatus Source #

SBP class for message MSG_M25_FLASH_WRITE_STATUS (0x00F3).

The flash status message writes to the 8-bit M25 flash status register. The device replies with a MSG_FLASH_DONE message.

Constructors

MsgM25FlashWriteStatus 

Fields

data GnssSignal Source #

GnssSignal.

Signal identifier containing constellation, band, and satellite identifier

Constructors

GnssSignal 

Fields

data GpsTime Source #

GPSTime.

A wire-appropriate GPS time, defined as the number of milliseconds since beginning of the week on the Saturday/Sunday transition.

Constructors

GpsTime 

Fields

data GpsTimeSec Source #

GPSTimeSec.

A GPS time, defined as the number of seconds since beginning of the week on the Saturday/Sunday transition.

Constructors

GpsTimeSec 

Fields

data GpsTimeNano Source #

GPSTimeNano.

A wire-appropriate receiver clock time, defined as the time since the beginning of the week on the Saturday/Sunday transition. In most cases, observations are epoch aligned so ns field will be 0.

Constructors

GpsTimeNano 

Fields

data CarrierPhase Source #

CarrierPhase.

Carrier phase measurement in cycles represented as a 40-bit fixed point number with Q32.8 layout, i.e. 32-bits of whole cycles and 8-bits of fractional cycles. This phase has the same sign as the pseudorange.

Constructors

CarrierPhase 

Fields

data MsgImuRaw Source #

SBP class for message MSG_IMU_RAW (0x0900).

Raw data from the Inertial Measurement Unit, containing accelerometer and gyroscope readings.

Constructors

MsgImuRaw 

Fields

data MsgImuAux Source #

SBP class for message MSG_IMU_AUX (0x0901).

Auxiliary data specific to a particular IMU. The imu_type field will always be consistent but the rest of the payload is device specific and depends on the value of imu_type.

Constructors

MsgImuAux 

Fields

data MsgLog Source #

SBP class for message MSG_LOG (0x0401).

This message contains a human-readable payload string from the device containing errors, warnings and informational messages at ERROR, WARNING, DEBUG, INFO logging levels.

Constructors

MsgLog 

Fields

data MsgFwd Source #

SBP class for message MSG_FWD (0x0402).

This message provides the ability to forward messages over SBP. This may take the form of wrapping up SBP messages received by Piksi for logging purposes or wrapping another protocol with SBP. The source identifier indicates from what interface a forwarded stream derived. The protocol identifier identifies what the expected protocol the forwarded msg contains. Protocol 0 represents SBP and the remaining values are implementation defined.

Constructors

MsgFwd 

Fields

data MsgGpsTime Source #

SBP class for message MSG_GPS_TIME (0x0102).

This message reports the GPS time, representing the time since the GPS epoch began on midnight January 6, 1980 UTC. GPS time counts the weeks and seconds of the week. The weeks begin at the Saturday/Sunday transition. GPS week 0 began at the beginning of the GPS time scale. Within each week number, the GPS time of the week is between between 0 and 604800 seconds (=60*60*24*7). Note that GPS time does not accumulate leap seconds, and as of now, has a small offset from UTC. In a message stream, this message precedes a set of other navigation messages referenced to the same time (but lacking the ns field) and indicates a more precise time of these messages.

Constructors

MsgGpsTime 

Fields

data MsgUtcTime Source #

SBP class for message MSG_UTC_TIME (0x0103).

This message reports the Universal Coordinated Time (UTC). Note the flags which indicate the source of the UTC offset value and source of the time fix.

Constructors

MsgUtcTime 

Fields

data MsgDops Source #

SBP class for message MSG_DOPS (0x0208).

This dilution of precision (DOP) message describes the effect of navigation satellite geometry on positional measurement precision. The flags field indicated whether the DOP reported corresponds to differential or SPP solution.

Constructors

MsgDops 

Fields

data MsgPosEcef Source #

SBP class for message MSG_POS_ECEF (0x0209).

The position solution message reports absolute Earth Centered Earth Fixed (ECEF) coordinates and the status (single point vs pseudo-absolute RTK) of the position solution. If the rover receiver knows the surveyed position of the base station and has an RTK solution, this reports a pseudo-absolute position solution using the base station position and the rover's RTK baseline vector. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgPosEcef 

Fields

data MsgPosLlh Source #

SBP class for message MSG_POS_LLH (0x020A).

This position solution message reports the absolute geodetic coordinates and the status (single point vs pseudo-absolute RTK) of the position solution. If the rover receiver knows the surveyed position of the base station and has an RTK solution, this reports a pseudo-absolute position solution using the base station position and the rover's RTK baseline vector. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgPosLlh 

Fields

data MsgBaselineEcef Source #

SBP class for message MSG_BASELINE_ECEF (0x020B).

This message reports the baseline solution in Earth Centered Earth Fixed (ECEF) coordinates. This baseline is the relative vector distance from the base station to the rover receiver. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgBaselineEcef 

Fields

data MsgBaselineNed Source #

SBP class for message MSG_BASELINE_NED (0x020C).

This message reports the baseline solution in North East Down (NED) coordinates. This baseline is the relative vector distance from the base station to the rover receiver, and NED coordinate system is defined at the local WGS84 tangent plane centered at the base station position. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of- week (tow).

Constructors

MsgBaselineNed 

Fields

data MsgVelEcef Source #

SBP class for message MSG_VEL_ECEF (0x020D).

This message reports the velocity in Earth Centered Earth Fixed (ECEF) coordinates. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgVelEcef 

Fields

data MsgVelNed Source #

SBP class for message MSG_VEL_NED (0x020E).

This message reports the velocity in local North East Down (NED) coordinates. The NED coordinate system is defined as the local WGS84 tangent plane centered at the current position. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgVelNed 

Fields

data MsgBaselineHeading Source #

SBP class for message MSG_BASELINE_HEADING (0x020F).

This message reports the baseline heading pointing from the base station to the rover relative to True North. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow). It is intended that time-matched RTK mode is used when the base station is moving.

Constructors

MsgBaselineHeading 

Fields

data MsgGpsTimeDepA Source #

SBP class for message MSG_GPS_TIME_DEP_A (0x0100).

This message reports the GPS time, representing the time since the GPS epoch began on midnight January 6, 1980 UTC. GPS time counts the weeks and seconds of the week. The weeks begin at the Saturday/Sunday transition. GPS week 0 began at the beginning of the GPS time scale. Within each week number, the GPS time of the week is between between 0 and 604800 seconds (=60*60*24*7). Note that GPS time does not accumulate leap seconds, and as of now, has a small offset from UTC. In a message stream, this message precedes a set of other navigation messages referenced to the same time (but lacking the ns field) and indicates a more precise time of these messages.

Constructors

MsgGpsTimeDepA 

Fields

data MsgDopsDepA Source #

SBP class for message MSG_DOPS_DEP_A (0x0206).

This dilution of precision (DOP) message describes the effect of navigation satellite geometry on positional measurement precision.

Constructors

MsgDopsDepA 

Fields

data MsgPosEcefDepA Source #

SBP class for message MSG_POS_ECEF_DEP_A (0x0200).

The position solution message reports absolute Earth Centered Earth Fixed (ECEF) coordinates and the status (single point vs pseudo-absolute RTK) of the position solution. If the rover receiver knows the surveyed position of the base station and has an RTK solution, this reports a pseudo-absolute position solution using the base station position and the rover's RTK baseline vector. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgPosEcefDepA 

Fields

data MsgPosLlhDepA Source #

SBP class for message MSG_POS_LLH_DEP_A (0x0201).

This position solution message reports the absolute geodetic coordinates and the status (single point vs pseudo-absolute RTK) of the position solution. If the rover receiver knows the surveyed position of the base station and has an RTK solution, this reports a pseudo-absolute position solution using the base station position and the rover's RTK baseline vector. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgPosLlhDepA 

Fields

data MsgBaselineEcefDepA Source #

SBP class for message MSG_BASELINE_ECEF_DEP_A (0x0202).

This message reports the baseline solution in Earth Centered Earth Fixed (ECEF) coordinates. This baseline is the relative vector distance from the base station to the rover receiver. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgBaselineEcefDepA 

Fields

data MsgBaselineNedDepA Source #

SBP class for message MSG_BASELINE_NED_DEP_A (0x0203).

This message reports the baseline solution in North East Down (NED) coordinates. This baseline is the relative vector distance from the base station to the rover receiver, and NED coordinate system is defined at the local WGS84 tangent plane centered at the base station position. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of- week (tow).

Constructors

MsgBaselineNedDepA 

Fields

data MsgVelEcefDepA Source #

SBP class for message MSG_VEL_ECEF_DEP_A (0x0204).

This message reports the velocity in Earth Centered Earth Fixed (ECEF) coordinates. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgVelEcefDepA 

Fields

data MsgVelNedDepA Source #

SBP class for message MSG_VEL_NED_DEP_A (0x0205).

This message reports the velocity in local North East Down (NED) coordinates. The NED coordinate system is defined as the local WGS84 tangent plane centered at the current position. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgVelNedDepA 

Fields

data MsgBaselineHeadingDepA Source #

SBP class for message MSG_BASELINE_HEADING_DEP_A (0x0207).

This message reports the baseline heading pointing from the base station to the rover relative to True North. The full GPS time is given by the preceding MSG_GPS_TIME with the matching time-of-week (tow).

Constructors

MsgBaselineHeadingDepA 

Fields

data MsgNdbEvent Source #

SBP class for message MSG_NDB_EVENT (0x0400).

This message is sent out when an object is stored into NDB. If needed message could also be sent out when fetching an object from NDB.

Constructors

MsgNdbEvent 

Fields

data Doppler Source #

Doppler.

Doppler measurement in Hz represented as a 24-bit fixed point number with Q16.8 layout, i.e. 16-bits of whole doppler and 8-bits of fractional doppler. This doppler is defined as positive for approaching satellites.

Constructors

Doppler 

Fields

data PackedObsContent Source #

PackedObsContent.

Pseudorange and carrier phase observation for a satellite being tracked. The observations are interoperable with 3rd party receivers and conform with typical RTCMv3 GNSS observations.

Constructors

PackedObsContent 

Fields

data MsgObs Source #

SBP class for message MSG_OBS (0x004A).

The GPS observations message reports all the raw pseudorange and carrier phase observations for the satellites being tracked by the device. Carrier phase observation here is represented as a 40-bit fixed point number with Q32.8 layout (i.e. 32-bits of whole cycles and 8-bits of fractional cycles). The observations are be interoperable with 3rd party receivers and conform with typical RTCMv3 GNSS observations.

Constructors

MsgObs 

Fields

data MsgBasePosLlh Source #

SBP class for message MSG_BASE_POS_LLH (0x0044).

The base station position message is the position reported by the base station itself. It is used for pseudo-absolute RTK positioning, and is required to be a high-accuracy surveyed location of the base station. Any error here will result in an error in the pseudo-absolute position output.

data MsgBasePosEcef Source #

SBP class for message MSG_BASE_POS_ECEF (0x0048).

The base station position message is the position reported by the base station itself in absolute Earth Centered Earth Fixed coordinates. It is used for pseudo-absolute RTK positioning, and is required to be a high- accuracy surveyed location of the base station. Any error here will result in an error in the pseudo-absolute position output.

Constructors

MsgBasePosEcef 

Fields

data EphemerisCommonContent Source #

Constructors

EphemerisCommonContent 

Fields

data EphemerisCommonContentDepA Source #

Constructors

EphemerisCommonContentDepA 

Fields

data MsgEphemerisGpsDepE Source #

SBP class for message MSG_EPHEMERIS_GPS_DEP_E (0x0081).

The ephemeris message returns a set of satellite orbit parameters that is used to calculate GPS satellite position, velocity, and clock offset. Please see the Navstar GPS Space Segment/Navigation user interfaces (ICD-GPS-200, Table 20-III) for more details.

Constructors

MsgEphemerisGpsDepE 

Fields

data MsgEphemerisGps Source #

SBP class for message MSG_EPHEMERIS_GPS (0x0086).

The ephemeris message returns a set of satellite orbit parameters that is used to calculate GPS satellite position, velocity, and clock offset. Please see the Navstar GPS Space Segment/Navigation user interfaces (ICD-GPS-200, Table 20-III) for more details.

Constructors

MsgEphemerisGps 

Fields

data MsgEphemerisSbasDepA Source #

Constructors

MsgEphemerisSbasDepA 

Fields

data MsgEphemerisGloDepA Source #

SBP class for message MSG_EPHEMERIS_GLO_DEP_A (0x0083).

The ephemeris message returns a set of satellite orbit parameters that is used to calculate GLO satellite position, velocity, and clock offset. Please see the GLO ICD 5.1 "Table 4.5 Characteristics of words of immediate information (ephemeris parameters)" for more details.

Constructors

MsgEphemerisGloDepA 

Fields

data MsgEphemerisSbas Source #

Constructors

MsgEphemerisSbas 

Fields

data MsgEphemerisGloDepB Source #

SBP class for message MSG_EPHEMERIS_GLO_DEP_B (0x0085).

The ephemeris message returns a set of satellite orbit parameters that is used to calculate GLO satellite position, velocity, and clock offset. Please see the GLO ICD 5.1 "Table 4.5 Characteristics of words of immediate information (ephemeris parameters)" for more details.

Constructors

MsgEphemerisGloDepB 

Fields

data MsgEphemerisGloDepC Source #

SBP class for message MSG_EPHEMERIS_GLO_DEP_C (0x0087).

The ephemeris message returns a set of satellite orbit parameters that is used to calculate GLO satellite position, velocity, and clock offset. Please see the GLO ICD 5.1 "Table 4.5 Characteristics of words of immediate information (ephemeris parameters)" for more details.

Constructors

MsgEphemerisGloDepC 

Fields

data MsgEphemerisGlo Source #

SBP class for message MSG_EPHEMERIS_GLO (0x0088).

The ephemeris message returns a set of satellite orbit parameters that is used to calculate GLO satellite position, velocity, and clock offset. Please see the GLO ICD 5.1 "Table 4.5 Characteristics of words of immediate information (ephemeris parameters)" for more details.

Constructors

MsgEphemerisGlo 

Fields

data MsgEphemerisDepD Source #

SBP class for message MSG_EPHEMERIS_DEP_D (0x0080).

The ephemeris message returns a set of satellite orbit parameters that is used to calculate GPS satellite position, velocity, and clock offset. Please see the Navstar GPS Space Segment/Navigation user interfaces (ICD-GPS-200, Table 20-III) for more details.

Constructors

MsgEphemerisDepD 

Fields

data MsgEphemerisDepA Source #

SBP class for message MSG_EPHEMERIS_DEP_A (0x001A).

Deprecated.

Constructors

MsgEphemerisDepA 

Fields

data MsgEphemerisDepB Source #

SBP class for message MSG_EPHEMERIS_DEP_B (0x0046).

Deprecated.

Constructors

MsgEphemerisDepB 

Fields

data MsgEphemerisDepC Source #

SBP class for message MSG_EPHEMERIS_DEP_C (0x0047).

The ephemeris message returns a set of satellite orbit parameters that is used to calculate GPS satellite position, velocity, and clock offset. Please see the Navstar GPS Space Segment/Navigation user interfaces (ICD-GPS-200, Table 20-III) for more details.

Constructors

MsgEphemerisDepC 

Fields

data CarrierPhaseDepA Source #

CarrierPhaseDepA.

Carrier phase measurement in cycles represented as a 40-bit fixed point number with Q32.8 layout, i.e. 32-bits of whole cycles and 8-bits of fractional cycles. This has the opposite sign convention than a typical GPS receiver and the phase has the opposite sign as the pseudorange.

Constructors

CarrierPhaseDepA 

Fields

data PackedObsContentDepA Source #

PackedObsContentDepA.

Deprecated.

Constructors

PackedObsContentDepA 

Fields

data PackedObsContentDepB Source #

PackedObsContentDepB.

Pseudorange and carrier phase observation for a satellite being tracked. Pseudoranges are referenced to a nominal pseudorange.

Constructors

PackedObsContentDepB 

Fields

data PackedObsContentDepC Source #

PackedObsContentDepC.

Pseudorange and carrier phase observation for a satellite being tracked. The observations are be interoperable with 3rd party receivers and conform with typical RTCMv3 GNSS observations.

Constructors

PackedObsContentDepC 

Fields

data MsgObsDepB Source #

SBP class for message MSG_OBS_DEP_B (0x0043).

This observation message has been deprecated in favor of observations that are more interoperable. This message should be used for observations referenced to a nominal pseudorange which are not interoperable with most 3rd party GNSS receievers or typical RTCMv3 observations.

Constructors

MsgObsDepB 

Fields

data MsgObsDepC Source #

SBP class for message MSG_OBS_DEP_C (0x0049).

The GPS observations message reports all the raw pseudorange and carrier phase observations for the satellites being tracked by the device. Carrier phase observation here is represented as a 40-bit fixed point number with Q32.8 layout (i.e. 32-bits of whole cycles and 8-bits of fractional cycles). The observations are interoperable with 3rd party receivers and conform with typical RTCMv3 GNSS observations.

Constructors

MsgObsDepC 

Fields

data MsgIono Source #

SBP class for message MSG_IONO (0x0090).

The ionospheric parameters which allow the "L1 only" or "L2 only" user to utilize the ionospheric model for computation of the ionospheric delay. Please see ICD-GPS-200 (Chapter 20.3.3.5.1.7) for more details.

Constructors

MsgIono 

Fields

data MsgSvConfigurationGps Source #

SBP class for message MSG_SV_CONFIGURATION_GPS (0x0091).

Please see ICD-GPS-200 (Chapter 20.3.3.5.1.4) for more details.

Constructors

MsgSvConfigurationGps 

Fields

data MsgGroupDelayDepA Source #

SBP class for message MSG_GROUP_DELAY_DEP_A (0x0092).

Please see ICD-GPS-200 (30.3.3.3.1.1) for more details.

Constructors

MsgGroupDelayDepA 

Fields

data MsgGroupDelay Source #

SBP class for message MSG_GROUP_DELAY (0x0093).

Please see ICD-GPS-200 (30.3.3.3.1.1) for more details.

Constructors

MsgGroupDelay 

Fields

data AlmanacCommonContent Source #

Constructors

AlmanacCommonContent 

Fields

data MsgAlmanacGps Source #

SBP class for message MSG_ALMANAC_GPS (0x0070).

The almanac message returns a set of satellite orbit parameters. Almanac data is not very precise and is considered valid for up to several months. Please see the Navstar GPS Space Segment/Navigation user interfaces (ICD- GPS-200, Chapter 20.3.3.5.1.2 Almanac Data) for more details.

Constructors

MsgAlmanacGps 

Fields

data MsgAlmanacGlo Source #

SBP class for message MSG_ALMANAC_GLO (0x0071).

The almanac message returns a set of satellite orbit parameters. Almanac data is not very precise and is considered valid for up to several months. Please see the GLO ICD 5.1 "Chapter 4.5 Non-immediate information and almanac" for details.

Constructors

MsgAlmanacGlo 

Fields

data MsgFcnsGlo Source #

SBP class for message MSG_FCNS_GLO (0x0072).

The message reports mapping information regarding GLONASS SV orbital and frequency slots. Mapped as follow: index (SV orbital slot) fcns[index] 0 0xFF 1 FCN for SV orbital slot 1 ... ... 28 FCN for SV orbital slot 28 29 0xFF 30 0xFF 31 0xFF

Constructors

MsgFcnsGlo 

Fields

data MsgAlmanac Source #

SBP class for message MSG_ALMANAC (0x0069).

This is a legacy message for sending and loading a satellite alamanac onto the Piksi's flash memory from the host.

Constructors

MsgAlmanac 

data MsgReset Source #

SBP class for message MSG_RESET (0x00B6).

This message from the host resets the Piksi back into the bootloader.

Constructors

MsgReset 

Fields

data MsgCwResults Source #

SBP class for message MSG_CW_RESULTS (0x00C0).

This is an unused legacy message for result reporting from the CW interference channel on the SwiftNAP. This message will be removed in a future release.

Constructors

MsgCwResults 

data MsgCwStart Source #

SBP class for message MSG_CW_START (0x00C1).

This is an unused legacy message from the host for starting the CW interference channel on the SwiftNAP. This message will be removed in a future release.

Constructors

MsgCwStart 

data MsgInitBase Source #

SBP class for message MSG_INIT_BASE (0x0023).

This message initializes the integer ambiguity resolution (IAR) process on the Piksi to use an assumed baseline position between the base station and rover receivers. Warns via MSG_PRINT if there aren't a shared minimum number (4) of satellite observations between the two.

Constructors

MsgInitBase 

data MsgThreadState Source #

SBP class for message MSG_THREAD_STATE (0x0017).

The thread usage message from the device reports real-time operating system (RTOS) thread usage statistics for the named thread. The reported percentage values must be normalized.

Constructors

MsgThreadState 

Fields

data UARTChannel Source #

UARTChannel.

Throughput, utilization, and error counts on the RX/TX buffers of this UART channel. The reported percentage values must be normalized.

Constructors

UARTChannel 

Fields

data Period Source #

Period.

Statistics on the period of observations received from the base station. As complete observation sets are received, their time of reception is compared with the prior set''s time of reception. This measurement provides a proxy for link quality as incomplete or missing sets will increase the period. Long periods can cause momentary RTK solution outages.

Constructors

Period 

Fields

data Latency Source #

Latency.

Statistics on the latency of observations received from the base station. As observation packets are received their GPS time is compared to the current GPS time calculated locally by the receiver to give a precise measurement of the end-to-end communication latency in the system.

Constructors

Latency 

Fields

data MsgUartState Source #

SBP class for message MSG_UART_STATE (0x001D).

The UART message reports data latency and throughput of the UART channels providing SBP I/O. On the default Piksi configuration, UARTs A and B are used for telemetry radios, but can also be host access ports for embedded hosts, or other interfaces in future. The reported percentage values must be normalized. Observations latency and period can be used to assess the health of the differential corrections link. Latency provides the timeliness of received base observations while the period indicates their likelihood of transmission.

Constructors

MsgUartState 

Fields

data MsgIarState Source #

SBP class for message MSG_IAR_STATE (0x0019).

This message reports the state of the Integer Ambiguity Resolution (IAR) process, which resolves unknown integer ambiguities from double-differenced carrier-phase measurements from satellite observations.

Constructors

MsgIarState 

Fields

data MsgMaskSatellite Source #

SBP class for message MSG_MASK_SATELLITE (0x001B).

This message allows setting a mask to prevent a particular satellite from being used in various Piksi subsystems.

Constructors

MsgMaskSatellite 

Fields

data MsgDeviceMonitor Source #

SBP class for message MSG_DEVICE_MONITOR (0x00B5).

This message contains temperature and voltage level measurements from the processor's monitoring system and the RF frontend die temperature if available.

Constructors

MsgDeviceMonitor 

Fields

data MsgCommandReq Source #

SBP class for message MSG_COMMAND_REQ (0x00B8).

Request the recipient to execute an command. Output will be sent in MSG_LOG messages, and the exit code will be returned with MSG_COMMAND_RESP.

Constructors

MsgCommandReq 

Fields

data MsgCommandOutput Source #

SBP class for message MSG_COMMAND_OUTPUT (0x00BC).

Returns the standard output and standard error of the command requested by MSG_COMMAND_REQ. The sequence number can be used to filter for filtering the correct command.

Constructors

MsgCommandOutput 

Fields

data MsgNetworkStateResp Source #

SBP class for message MSG_NETWORK_STATE_RESP (0x00BB).

The state of a network interface on the Piksi. Data is made to reflect output of ifaddrs struct returned by getifaddrs in c.

Constructors

MsgNetworkStateResp 

Fields

data MsgSpecan Source #

SBP class for message MSG_SPECAN (0x0050).

Spectrum analyzer packet.

Constructors

MsgSpecan 

Fields

data MsgSettingsWrite Source #

SBP class for message MSG_SETTINGS_WRITE (0x00A0).

The setting message writes the device configuration.

Constructors

MsgSettingsWrite 

Fields

  • _msgSettingsWrite_setting :: !Text

    A NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE]. A device will only process to this message when it is received from sender ID 0x42.

data MsgSettingsReadReq Source #

SBP class for message MSG_SETTINGS_READ_REQ (0x00A4).

The setting message reads the device configuration.

Constructors

MsgSettingsReadReq 

Fields

  • _msgSettingsReadReq_setting :: !Text

    A NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING]. A device will only respond to this message when it is received from sender ID 0x42.

data MsgSettingsReadResp Source #

SBP class for message MSG_SETTINGS_READ_RESP (0x00A5).

The setting message reads the device configuration.

Constructors

MsgSettingsReadResp 

Fields

data MsgSettingsReadByIndexReq Source #

SBP class for message MSG_SETTINGS_READ_BY_INDEX_REQ (0x00A2).

The settings message for iterating through the settings values. It will read the setting at an index, returning a NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE]. A device will only respond to this message when it is received from sender ID 0x42.

Constructors

MsgSettingsReadByIndexReq 

Fields

data MsgSettingsReadByIndexResp Source #

SBP class for message MSG_SETTINGS_READ_BY_INDEX_RESP (0x00A7).

The settings message for iterating through the settings values. It will read the setting at an index, returning a NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE].

Constructors

MsgSettingsReadByIndexResp 

Fields

data MsgSettingsReadByIndexDone Source #

SBP class for message MSG_SETTINGS_READ_BY_INDEX_DONE (0x00A6).

The settings message for indicating end of the settings values.

data MsgSettingsRegister Source #

SBP class for message MSG_SETTINGS_REGISTER (0x00AE).

This message registers the presence and default value of a setting with a settings daemon. The host should reply with MSG_SETTINGS_WRITE for this setting to set the initial value.

Constructors

MsgSettingsRegister 

Fields

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 MsgTrackingStateDetailed Source #

SBP class for message MSG_TRACKING_STATE_DETAILED (0x0011).

The tracking message returns a set tracking channel parameters for a single tracking channel useful for debugging issues.

Constructors

MsgTrackingStateDetailed 

Fields

data TrackingChannelState Source #

TrackingChannelState.

Tracking channel state for a specific satellite signal and measured signal power.

Constructors

TrackingChannelState 

Fields

data TrackingChannelCorrelation Source #

TrackingChannelCorrelation.

Structure containing in-phase and quadrature correlation components.

Constructors

TrackingChannelCorrelation 

Fields

data TrackingChannelStateDepA Source #

TrackingChannelStateDepA.

Deprecated.

Constructors

TrackingChannelStateDepA 

Fields

data TrackingChannelStateDepB Source #

TrackingChannelStateDepB.

Deprecated.

Constructors

TrackingChannelStateDepB 

Fields

data MsgUserData Source #

SBP class for message MSG_USER_DATA (0x0800).

This message can contain any application specific user data up to a maximum length of 255 bytes per message.

Constructors

MsgUserData 

Fields