sbp-0.50.6: SwiftNav's SBP Library

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

SwiftNav.SBP.Piksi

Description

System health, configuration, and diagnostic messages specific to the Piksi L1 receiver, including a variety of legacy messages that may no longer be used. These messages are in the implementation-defined range (0x0000-0x00FF), and largely intended for internal-use only.

Synopsis

Documentation

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 MsgSetTime Source

SBP class for message MSG_SET_TIME (0x0068).

This message sets up timing functionality using a coarse GPS time estimate sent by the host.

Constructors

MsgSetTime 

data MsgReset Source

SBP class for message MSG_RESET (0x00B2).

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

Constructors

MsgReset 

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 those host for starting the CW interference channel on the SwiftNAP. This message will be removed in a future release.

Constructors

MsgCwStart 

data MsgResetFilters Source

SBP class for message MSG_RESET_FILTERS (0x0022).

This message resets either the DGNSS Kalman filters or Integer Ambiguity Resolution (IAR) process.

Constructors

MsgResetFilters 

Fields

msgResetFilters_filter :: Word8

Filter flags

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 require to be normalized.

Constructors

MsgThreadState 

Fields

msgThreadState_name :: ByteString

Thread name (NULL terminated)

msgThreadState_cpu :: Word16

Percentage cpu use for this thread. Values range from 0 - 1000 and needs to be renormalized to 100

msgThreadState_stack_free :: Word32

Free stack space for this thread

data UARTChannel Source

UARTChannel.

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

Constructors

UARTChannel 

Fields

uARTChannel_tx_throughput :: Float

UART transmit throughput

uARTChannel_rx_throughput :: Float

UART receive throughput

uARTChannel_crc_error_count :: Word16

UART CRC error count

uARTChannel_io_error_count :: Word16

UART IO error count

uARTChannel_tx_buffer_level :: Word8

UART transmit buffer percentage utilization (ranges from 0 - 255)

uARTChannel_rx_buffer_level :: Word8

UART receive buffer percentage utilization (ranges from 0 to 255)

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

latency_avg :: Int32

Average latency

latency_lmin :: Int32

Minimum latency

latency_lmax :: Int32

Maximum latency

latency_current :: Int32

Smoothed estimate of the current latency

data MsgUartState Source

SBP class for message MSG_UART_STATE (0x0018).

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 require to be normalized.

Constructors

MsgUartState 

Fields

msgUartState_uart_a :: UARTChannel

State of UART A

msgUartState_uart_b :: UARTChannel

State of UART B

msgUartState_uart_ftdi :: UARTChannel

State of UART FTDI (USB logger)

msgUartState_latency :: Latency

UART communication latency

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

msgIarState_num_hyps :: Word32

Number of integer ambiguity hypotheses remaining

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

msgMaskSatellite_mask :: Word8

Mask of systems that should ignore this satellite.

msgMaskSatellite_sid :: Word32

Signal identifier for which the mask is applied