sbp-6.0.1: SwiftNav's SBP Library
CopyrightCopyright (C) 2015-2021 Swift Navigation Inc.
LicenseMIT
Stabilityexperimental
Portabilityportable
Safe HaskellSafe-Inferred
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 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 (0x00B6).

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

Constructors

MsgReset 

Fields

Instances

Instances details
FromJSON MsgReset Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgReset Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgReset Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgReset Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgReset Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

put :: MsgReset -> Put #

get :: Get MsgReset #

putList :: [MsgReset] -> Put #

Eq MsgReset Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgReset Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

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

data MsgResetDep Source #

SBP class for message MSG_RESET_DEP (0x00B2).

Deprecated.

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 

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

Instances

Instances details
FromJSON MsgResetFilters Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgResetFilters Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgResetFilters Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgResetFilters Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgResetFilters Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgResetFilters Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgResetFilters Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

data MsgInitBaseDep Source #

SBP class for message MSG_INIT_BASE_DEP (0x0023).

Deprecated.

Constructors

MsgInitBaseDep 

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

Instances details
FromJSON Period Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON Period Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read Period Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show Period Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary Period Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

put :: Period -> Put #

get :: Get Period #

putList :: [Period] -> Put #

Eq Period Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

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

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

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

Instances

Instances details
FromJSON Latency Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON Latency Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read Latency Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show Latency Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary Latency Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

put :: Latency -> Put #

get :: Get Latency #

putList :: [Latency] -> Put #

Eq Latency Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Methods

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

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

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

SBP class for message MSG_UART_STATE_DEPA (0x0018).

Deprecated.

Constructors

MsgUartStateDepa 

Fields

Instances

Instances details
FromJSON MsgUartStateDepa Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgUartStateDepa Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgUartStateDepa Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgUartStateDepa Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgUartStateDepa Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgUartStateDepa Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgUartStateDepa Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

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 (0x002B).

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

Constructors

MsgMaskSatellite 

Fields

Instances

Instances details
FromJSON MsgMaskSatellite Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgMaskSatellite Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgMaskSatellite Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgMaskSatellite Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgMaskSatellite Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgMaskSatellite Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgMaskSatellite Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

data MsgMaskSatelliteDep Source #

SBP class for message MSG_MASK_SATELLITE_DEP (0x001B).

Deprecated.

Constructors

MsgMaskSatelliteDep 

Fields

Instances

Instances details
FromJSON MsgMaskSatelliteDep Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgMaskSatelliteDep Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgMaskSatelliteDep Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgMaskSatelliteDep Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgMaskSatelliteDep Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgMaskSatelliteDep Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgMaskSatelliteDep Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

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

Instances

Instances details
FromJSON MsgDeviceMonitor Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgDeviceMonitor Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgDeviceMonitor Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgDeviceMonitor Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgDeviceMonitor Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgDeviceMonitor Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgDeviceMonitor Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

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

Instances

Instances details
FromJSON MsgCommandOutput Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgCommandOutput Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgCommandOutput Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgCommandOutput Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgCommandOutput Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgCommandOutput Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgCommandOutput Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

data MsgNetworkStateReq Source #

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 

Instances

Instances details
FromJSON MsgNetworkStateReq Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgNetworkStateReq Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgNetworkStateReq Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgNetworkStateReq Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgNetworkStateReq Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgNetworkStateReq Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgNetworkStateReq Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

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

Instances

Instances details
FromJSON MsgNetworkStateResp Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgNetworkStateResp Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgNetworkStateResp Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgNetworkStateResp Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgNetworkStateResp Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgNetworkStateResp Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgNetworkStateResp Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

data NetworkUsage Source #

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

SBP class for message MSG_NETWORK_BANDWIDTH_USAGE (0x00BD).

The bandwidth usage, a list of usage by interface.

Constructors

MsgNetworkBandwidthUsage 

Fields

Instances

Instances details
FromJSON MsgNetworkBandwidthUsage Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgNetworkBandwidthUsage Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgNetworkBandwidthUsage Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgNetworkBandwidthUsage Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgNetworkBandwidthUsage Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgNetworkBandwidthUsage Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgNetworkBandwidthUsage Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

data MsgCellModemStatus Source #

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

Instances

Instances details
FromJSON MsgCellModemStatus Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgCellModemStatus Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgCellModemStatus Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgCellModemStatus Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgCellModemStatus Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgCellModemStatus Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgCellModemStatus Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

data MsgSpecanDep Source #

SBP class for message MSG_SPECAN_DEP (0x0050).

Deprecated.

Constructors

MsgSpecanDep 

Fields

data MsgSpecan Source #

SBP class for message MSG_SPECAN (0x0051).

Spectrum analyzer packet.

Constructors

MsgSpecan 

Fields

data MsgFrontEndGain Source #

SBP class for message MSG_FRONT_END_GAIN (0x00BF).

This message describes the gain of each channel in the receiver frontend. Each gain is encoded as a non-dimensional percentage relative to the maximum range possible for the gain stage of the frontend. By convention, each gain array has 8 entries and the index of the array corresponding to the index of the rf channel in the frontend. A gain of 127 percent encodes that rf channel is not present in the hardware. A negative value implies an error for the particular gain stage as reported by the frontend.

Constructors

MsgFrontEndGain 

Fields

Instances

Instances details
FromJSON MsgFrontEndGain Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToJSON MsgFrontEndGain Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Read MsgFrontEndGain Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Show MsgFrontEndGain Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Binary MsgFrontEndGain Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

Eq MsgFrontEndGain Source # 
Instance details

Defined in SwiftNav.SBP.Piksi

ToSBP MsgFrontEndGain Source # 
Instance details

Defined in SwiftNav.SBP.Piksi