Copyright	Copyright (C) 2015-2018 Swift Navigation Inc.
License	LGPL-3
Maintainer	Swift Navigation <dev@swiftnav.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

SwiftNav.SBP.Bootload

Description

Messages for the bootloading configuration of a Piksi 2.3.1. This message group does not apply to Piksi Multi. Note that some of these messages share the same message type ID for both the host request and the device response.

Synopsis

data MsgBootloaderHandshakeReq = MsgBootloaderHandshakeReq
msgBootloaderHandshakeReq :: Word16
data MsgBootloaderHandshakeResp = MsgBootloaderHandshakeResp {
- _msgBootloaderHandshakeResp_flags :: !Word32
- _msgBootloaderHandshakeResp_version :: !Text
}
msgBootloaderHandshakeResp :: Word16
data MsgBootloaderJumpToApp = MsgBootloaderJumpToApp {
- _msgBootloaderJumpToApp_jump :: !Word8
}
msgBootloaderHandshakeResp_flags :: Lens' MsgBootloaderHandshakeResp Word32
msgBootloaderHandshakeResp_version :: Lens' MsgBootloaderHandshakeResp Text
msgBootloaderJumpToApp :: Word16
data MsgNapDeviceDnaReq = MsgNapDeviceDnaReq
msgBootloaderJumpToApp_jump :: Iso' MsgBootloaderJumpToApp Word8
msgNapDeviceDnaReq :: Word16
data MsgNapDeviceDnaResp = MsgNapDeviceDnaResp {
- _msgNapDeviceDnaResp_dna :: ![Word8]
}
msgNapDeviceDnaResp :: Word16
data MsgBootloaderHandshakeDepA = MsgBootloaderHandshakeDepA {
- _msgBootloaderHandshakeDepA_handshake :: ![Word8]
}
msgNapDeviceDnaResp_dna :: Iso' MsgNapDeviceDnaResp [Word8]
msgBootloaderHandshakeDepA :: Word16
msgBootloaderHandshakeDepA_handshake :: Iso' MsgBootloaderHandshakeDepA [Word8]

Documentation

data MsgBootloaderHandshakeReq #

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.

Constructors

MsgBootloaderHandshakeReq

Instances

Eq MsgBootloaderHandshakeReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods (==) :: MsgBootloaderHandshakeReq -> MsgBootloaderHandshakeReq -> Bool # (/=) :: MsgBootloaderHandshakeReq -> MsgBootloaderHandshakeReq -> Bool #
Read MsgBootloaderHandshakeReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods readsPrec :: Int -> ReadS MsgBootloaderHandshakeReq # readList :: ReadS [MsgBootloaderHandshakeReq] # readPrec :: ReadPrec MsgBootloaderHandshakeReq # readListPrec :: ReadPrec [MsgBootloaderHandshakeReq] #
Show MsgBootloaderHandshakeReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods showsPrec :: Int -> MsgBootloaderHandshakeReq -> ShowS # show :: MsgBootloaderHandshakeReq -> String # showList :: [MsgBootloaderHandshakeReq] -> ShowS #
ToJSON MsgBootloaderHandshakeReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods toJSON :: MsgBootloaderHandshakeReq -> Value # toEncoding :: MsgBootloaderHandshakeReq -> Encoding # toJSONList :: [MsgBootloaderHandshakeReq] -> Value # toEncodingList :: [MsgBootloaderHandshakeReq] -> Encoding #
FromJSON MsgBootloaderHandshakeReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods parseJSON :: Value -> Parser MsgBootloaderHandshakeReq # parseJSONList :: Value -> Parser [MsgBootloaderHandshakeReq] #
Binary MsgBootloaderHandshakeReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods put :: MsgBootloaderHandshakeReq -> Put # get :: Get MsgBootloaderHandshakeReq # putList :: [MsgBootloaderHandshakeReq] -> Put #
ToSBP MsgBootloaderHandshakeReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods toSBP :: MsgBootloaderHandshakeReq -> Word16 -> Msg #

msgBootloaderHandshakeReq :: Word16 #

data MsgBootloaderHandshakeResp #

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 _msgBootloaderHandshakeResp_flags :: !Word32 Bootloader flags _msgBootloaderHandshakeResp_version :: !Text Bootloader version number

Instances

Eq MsgBootloaderHandshakeResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods (==) :: MsgBootloaderHandshakeResp -> MsgBootloaderHandshakeResp -> Bool # (/=) :: MsgBootloaderHandshakeResp -> MsgBootloaderHandshakeResp -> Bool #
Read MsgBootloaderHandshakeResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods readsPrec :: Int -> ReadS MsgBootloaderHandshakeResp # readList :: ReadS [MsgBootloaderHandshakeResp] # readPrec :: ReadPrec MsgBootloaderHandshakeResp # readListPrec :: ReadPrec [MsgBootloaderHandshakeResp] #
Show MsgBootloaderHandshakeResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods showsPrec :: Int -> MsgBootloaderHandshakeResp -> ShowS # show :: MsgBootloaderHandshakeResp -> String # showList :: [MsgBootloaderHandshakeResp] -> ShowS #
ToJSON MsgBootloaderHandshakeResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods toJSON :: MsgBootloaderHandshakeResp -> Value # toEncoding :: MsgBootloaderHandshakeResp -> Encoding # toJSONList :: [MsgBootloaderHandshakeResp] -> Value # toEncodingList :: [MsgBootloaderHandshakeResp] -> Encoding #
FromJSON MsgBootloaderHandshakeResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods parseJSON :: Value -> Parser MsgBootloaderHandshakeResp # parseJSONList :: Value -> Parser [MsgBootloaderHandshakeResp] #
Binary MsgBootloaderHandshakeResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods put :: MsgBootloaderHandshakeResp -> Put # get :: Get MsgBootloaderHandshakeResp # putList :: [MsgBootloaderHandshakeResp] -> Put #
ToSBP MsgBootloaderHandshakeResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods toSBP :: MsgBootloaderHandshakeResp -> Word16 -> Msg #

msgBootloaderHandshakeResp :: Word16 #

data MsgBootloaderJumpToApp #

SBP class for message MSG_BOOTLOADER_JUMP_TO_APP (0x00B1).

The host initiates the bootloader to jump to the application.

Constructors

MsgBootloaderJumpToApp
Fields _msgBootloaderJumpToApp_jump :: !Word8 Ignored by the device

Instances

Eq MsgBootloaderJumpToApp #
Instance details Defined in SwiftNav.SBP.Bootload Methods (==) :: MsgBootloaderJumpToApp -> MsgBootloaderJumpToApp -> Bool # (/=) :: MsgBootloaderJumpToApp -> MsgBootloaderJumpToApp -> Bool #
Read MsgBootloaderJumpToApp #
Instance details Defined in SwiftNav.SBP.Bootload Methods readsPrec :: Int -> ReadS MsgBootloaderJumpToApp # readList :: ReadS [MsgBootloaderJumpToApp] # readPrec :: ReadPrec MsgBootloaderJumpToApp # readListPrec :: ReadPrec [MsgBootloaderJumpToApp] #
Show MsgBootloaderJumpToApp #
Instance details Defined in SwiftNav.SBP.Bootload Methods showsPrec :: Int -> MsgBootloaderJumpToApp -> ShowS # show :: MsgBootloaderJumpToApp -> String # showList :: [MsgBootloaderJumpToApp] -> ShowS #
ToJSON MsgBootloaderJumpToApp #
Instance details Defined in SwiftNav.SBP.Bootload Methods toJSON :: MsgBootloaderJumpToApp -> Value # toEncoding :: MsgBootloaderJumpToApp -> Encoding # toJSONList :: [MsgBootloaderJumpToApp] -> Value # toEncodingList :: [MsgBootloaderJumpToApp] -> Encoding #
FromJSON MsgBootloaderJumpToApp #
Instance details Defined in SwiftNav.SBP.Bootload Methods parseJSON :: Value -> Parser MsgBootloaderJumpToApp # parseJSONList :: Value -> Parser [MsgBootloaderJumpToApp] #
Binary MsgBootloaderJumpToApp #
Instance details Defined in SwiftNav.SBP.Bootload Methods put :: MsgBootloaderJumpToApp -> Put # get :: Get MsgBootloaderJumpToApp # putList :: [MsgBootloaderJumpToApp] -> Put #
ToSBP MsgBootloaderJumpToApp #
Instance details Defined in SwiftNav.SBP.Bootload Methods toSBP :: MsgBootloaderJumpToApp -> Word16 -> Msg #

msgBootloaderHandshakeResp_flags :: Lens' MsgBootloaderHandshakeResp Word32 #

msgBootloaderHandshakeResp_version :: Lens' MsgBootloaderHandshakeResp Text #

msgBootloaderJumpToApp :: Word16 #

data MsgNapDeviceDnaReq #

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

Instances

Eq MsgNapDeviceDnaReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods (==) :: MsgNapDeviceDnaReq -> MsgNapDeviceDnaReq -> Bool # (/=) :: MsgNapDeviceDnaReq -> MsgNapDeviceDnaReq -> Bool #
Read MsgNapDeviceDnaReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods readsPrec :: Int -> ReadS MsgNapDeviceDnaReq # readList :: ReadS [MsgNapDeviceDnaReq] # readPrec :: ReadPrec MsgNapDeviceDnaReq # readListPrec :: ReadPrec [MsgNapDeviceDnaReq] #
Show MsgNapDeviceDnaReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods showsPrec :: Int -> MsgNapDeviceDnaReq -> ShowS # show :: MsgNapDeviceDnaReq -> String # showList :: [MsgNapDeviceDnaReq] -> ShowS #
ToJSON MsgNapDeviceDnaReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods toJSON :: MsgNapDeviceDnaReq -> Value # toEncoding :: MsgNapDeviceDnaReq -> Encoding # toJSONList :: [MsgNapDeviceDnaReq] -> Value # toEncodingList :: [MsgNapDeviceDnaReq] -> Encoding #
FromJSON MsgNapDeviceDnaReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods parseJSON :: Value -> Parser MsgNapDeviceDnaReq # parseJSONList :: Value -> Parser [MsgNapDeviceDnaReq] #
Binary MsgNapDeviceDnaReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods put :: MsgNapDeviceDnaReq -> Put # get :: Get MsgNapDeviceDnaReq # putList :: [MsgNapDeviceDnaReq] -> Put #
ToSBP MsgNapDeviceDnaReq #
Instance details Defined in SwiftNav.SBP.Bootload Methods toSBP :: MsgNapDeviceDnaReq -> Word16 -> Msg #

msgBootloaderJumpToApp_jump :: Iso' MsgBootloaderJumpToApp Word8 #

msgNapDeviceDnaReq :: Word16 #

data MsgNapDeviceDnaResp #

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 _msgNapDeviceDnaResp_dna :: ![Word8] 57-bit SwiftNAP FPGA Device ID. Remaining bits are padded on the right.

Instances

Eq MsgNapDeviceDnaResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods (==) :: MsgNapDeviceDnaResp -> MsgNapDeviceDnaResp -> Bool # (/=) :: MsgNapDeviceDnaResp -> MsgNapDeviceDnaResp -> Bool #
Read MsgNapDeviceDnaResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods readsPrec :: Int -> ReadS MsgNapDeviceDnaResp # readList :: ReadS [MsgNapDeviceDnaResp] # readPrec :: ReadPrec MsgNapDeviceDnaResp # readListPrec :: ReadPrec [MsgNapDeviceDnaResp] #
Show MsgNapDeviceDnaResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods showsPrec :: Int -> MsgNapDeviceDnaResp -> ShowS # show :: MsgNapDeviceDnaResp -> String # showList :: [MsgNapDeviceDnaResp] -> ShowS #
ToJSON MsgNapDeviceDnaResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods toJSON :: MsgNapDeviceDnaResp -> Value # toEncoding :: MsgNapDeviceDnaResp -> Encoding # toJSONList :: [MsgNapDeviceDnaResp] -> Value # toEncodingList :: [MsgNapDeviceDnaResp] -> Encoding #
FromJSON MsgNapDeviceDnaResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods parseJSON :: Value -> Parser MsgNapDeviceDnaResp # parseJSONList :: Value -> Parser [MsgNapDeviceDnaResp] #
Binary MsgNapDeviceDnaResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods put :: MsgNapDeviceDnaResp -> Put # get :: Get MsgNapDeviceDnaResp # putList :: [MsgNapDeviceDnaResp] -> Put #
ToSBP MsgNapDeviceDnaResp #
Instance details Defined in SwiftNav.SBP.Bootload Methods toSBP :: MsgNapDeviceDnaResp -> Word16 -> Msg #

msgNapDeviceDnaResp :: Word16 #

data MsgBootloaderHandshakeDepA #

SBP class for message MSG_BOOTLOADER_HANDSHAKE_DEP_A (0x00B0).

Deprecated.

Constructors

MsgBootloaderHandshakeDepA
Fields _msgBootloaderHandshakeDepA_handshake :: ![Word8] Version number string (not NULL terminated)

Instances

Eq MsgBootloaderHandshakeDepA #
Instance details Defined in SwiftNav.SBP.Bootload Methods (==) :: MsgBootloaderHandshakeDepA -> MsgBootloaderHandshakeDepA -> Bool # (/=) :: MsgBootloaderHandshakeDepA -> MsgBootloaderHandshakeDepA -> Bool #
Read MsgBootloaderHandshakeDepA #
Instance details Defined in SwiftNav.SBP.Bootload Methods readsPrec :: Int -> ReadS MsgBootloaderHandshakeDepA # readList :: ReadS [MsgBootloaderHandshakeDepA] # readPrec :: ReadPrec MsgBootloaderHandshakeDepA # readListPrec :: ReadPrec [MsgBootloaderHandshakeDepA] #
Show MsgBootloaderHandshakeDepA #
Instance details Defined in SwiftNav.SBP.Bootload Methods showsPrec :: Int -> MsgBootloaderHandshakeDepA -> ShowS # show :: MsgBootloaderHandshakeDepA -> String # showList :: [MsgBootloaderHandshakeDepA] -> ShowS #
ToJSON MsgBootloaderHandshakeDepA #
Instance details Defined in SwiftNav.SBP.Bootload Methods toJSON :: MsgBootloaderHandshakeDepA -> Value # toEncoding :: MsgBootloaderHandshakeDepA -> Encoding # toJSONList :: [MsgBootloaderHandshakeDepA] -> Value # toEncodingList :: [MsgBootloaderHandshakeDepA] -> Encoding #
FromJSON MsgBootloaderHandshakeDepA #
Instance details Defined in SwiftNav.SBP.Bootload Methods parseJSON :: Value -> Parser MsgBootloaderHandshakeDepA # parseJSONList :: Value -> Parser [MsgBootloaderHandshakeDepA] #
Binary MsgBootloaderHandshakeDepA #
Instance details Defined in SwiftNav.SBP.Bootload Methods put :: MsgBootloaderHandshakeDepA -> Put # get :: Get MsgBootloaderHandshakeDepA # putList :: [MsgBootloaderHandshakeDepA] -> Put #
ToSBP MsgBootloaderHandshakeDepA #
Instance details Defined in SwiftNav.SBP.Bootload Methods toSBP :: MsgBootloaderHandshakeDepA -> Word16 -> Msg #

msgNapDeviceDnaResp_dna :: Iso' MsgNapDeviceDnaResp [Word8] #

msgBootloaderHandshakeDepA :: Word16 #

msgBootloaderHandshakeDepA_handshake :: Iso' MsgBootloaderHandshakeDepA [Word8] #