sbp-2.2.3: 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.

Synopsis

Documentation

msgAlmanac :: Word16 Source #

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 

msgSetTime :: Word16 Source #

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 

msgReset :: Word16 Source #

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

msgResetDep :: Word16 Source #

data MsgResetDep Source #

SBP class for message MSG_RESET_DEP (0x00B2).

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

Constructors

MsgResetDep 

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 

msgCwStart :: Word16 Source #

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

msgInitBase :: Word16 Source #

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

Instances

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

msgIarState :: Word16 Source #

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

SBP class for message MSG_COMMAND_RESP (0x00B9).

The response to MSG_COMMAND_REQ with the return code of the command. A return code of zero indicates success.

Constructors

MsgCommandResp 

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

msgSpecan :: Word16 Source #

data MsgSpecan Source #

SBP class for message MSG_SPECAN (0x0050).

Spectrum analyzer packet.

Constructors

MsgSpecan 

Fields