sbp-2.3.17: SwiftNav's SBP Library

CopyrightCopyright (C) 2015-2018 Swift Navigation Inc.
LicenseLGPL-3
MaintainerSwift Navigation <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

data MsgAlmanac #

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 #

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 #

SBP class for message MSG_RESET (0x00B6).

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

Constructors

MsgReset 

Fields

Instances
Eq MsgReset # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgReset # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgReset # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgReset # 
Instance details

Defined in SwiftNav.SBP.Piksi

FromJSON MsgReset # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgReset # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

put :: MsgReset -> Put #

get :: Get MsgReset #

putList :: [MsgReset] -> Put #

ToSBP MsgReset # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

toSBP :: MsgReset -> Word16 -> Msg #

data MsgResetDep #

SBP class for message MSG_RESET_DEP (0x00B2).

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

Constructors

MsgResetDep 

data MsgCwResults #

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 #

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 #

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

data MsgInitBase #

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 #

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 #

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 #

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
Eq Period # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

(==) :: Period -> Period -> Bool #

(/=) :: Period -> Period -> Bool #

Read Period # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show Period # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON Period # 
Instance details

Defined in SwiftNav.SBP.Piksi

FromJSON Period # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary Period # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

put :: Period -> Put #

get :: Get Period #

putList :: [Period] -> Put #

data Latency #

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

Instances
Eq Latency # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

(==) :: Latency -> Latency -> Bool #

(/=) :: Latency -> Latency -> Bool #

Read Latency # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show Latency # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON Latency # 
Instance details

Defined in SwiftNav.SBP.Piksi

FromJSON Latency # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary Latency # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

put :: Latency -> Put #

get :: Get Latency #

putList :: [Latency] -> Put #

data MsgUartState #

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

SBP class for message MSG_UART_STATE_DEPA (0x0018).

Deprecated

Constructors

MsgUartStateDepa 

Fields

data MsgIarState #

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 #

SBP class for message MSG_MASK_SATELLITE (0x002B).

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

Constructors

MsgMaskSatellite 

Fields

data MsgMaskSatelliteDep #

SBP class for message MSG_MASK_SATELLITE_DEP (0x001B).

Deprecated.

Constructors

MsgMaskSatelliteDep 

Fields

data MsgDeviceMonitor #

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 #

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 #

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

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

SBP class for message MSG_NETWORK_STATE_REQ (0x00BA).

Request state of Piksi network interfaces. Output will be sent in MSG_NETWORK_STATE_RESP messages

Constructors

MsgNetworkStateReq 

data MsgNetworkStateResp #

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

NetworkUsage.

The bandwidth usage for each interface can be reported within this struct and utilize multiple fields to fully specify the type of traffic that is being tracked. As either the interval of collection or the collection time may vary, both a timestamp and period field is provided, though may not necessarily be populated with a value.

Constructors

NetworkUsage 

Fields

data MsgNetworkBandwidthUsage #

SBP class for message MSG_NETWORK_BANDWIDTH_USAGE (0x00BD).

The bandwidth usage, a list of usage by interface.

Constructors

MsgNetworkBandwidthUsage 

Fields

Instances
Eq MsgNetworkBandwidthUsage # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgNetworkBandwidthUsage # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgNetworkBandwidthUsage # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgNetworkBandwidthUsage # 
Instance details

Defined in SwiftNav.SBP.Piksi

FromJSON MsgNetworkBandwidthUsage # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgNetworkBandwidthUsage # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgNetworkBandwidthUsage # 
Instance details

Defined in SwiftNav.SBP.Piksi

data MsgCellModemStatus #

SBP class for message MSG_CELL_MODEM_STATUS (0x00BE).

If a cell modem is present on a piksi device, this message will be send periodically to update the host on the status of the modem and its various parameters.

Constructors

MsgCellModemStatus 

Fields

data MsgSpecanDep #

SBP class for message MSG_SPECAN_DEP (0x0050).

Deprecated.

Constructors

MsgSpecanDep 

Fields

data MsgSpecan #

SBP class for message MSG_SPECAN (0x0051).

Spectrum analyzer packet.

Constructors

MsgSpecan 

Fields

Instances
Eq MsgSpecan # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgSpecan # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgSpecan # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgSpecan # 
Instance details

Defined in SwiftNav.SBP.Piksi

FromJSON MsgSpecan # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgSpecan # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgSpecan # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

toSBP :: MsgSpecan -> Word16 -> Msg #