SwiftNav.SBP.Settings

Messages for reading and writing the device's device settings. Note that some of these messages share the same message type ID for both the host request and the device response. See the accompanying document for descriptions of settings configurations and examples: https://github.com swift-navpiksi_firmwareblobmasterdocssettings.pdf

Documentation

msgSettingsSave :: Word16

data MsgSettingsSave

SBP class for message MSG_SETTINGS_SAVE (0x00A1).

The save settings message persists the device's current settings configuration to its onboard flash memory file system.

Constructors

MsgSettingsSave

Instances

Eq MsgSettingsSave

Methods

(==) :: MsgSettingsSave -> MsgSettingsSave -> Bool

(/=) :: MsgSettingsSave -> MsgSettingsSave -> Bool

Read MsgSettingsSave

Methods

readsPrec :: Int -> ReadS MsgSettingsSave

readList :: ReadS [MsgSettingsSave]

readPrec :: ReadPrec MsgSettingsSave

readListPrec :: ReadPrec [MsgSettingsSave]

Show MsgSettingsSave

Methods

showsPrec :: Int -> MsgSettingsSave -> ShowS

show :: MsgSettingsSave -> String

showList :: [MsgSettingsSave] -> ShowS

ToJSON MsgSettingsSave

Methods

toJSON :: MsgSettingsSave -> Value

toEncoding :: MsgSettingsSave -> Encoding

FromJSON MsgSettingsSave

Methods

parseJSON :: Value -> Parser MsgSettingsSave

Binary MsgSettingsSave

Methods

put :: MsgSettingsSave -> Put

get :: Get MsgSettingsSave

putList :: [MsgSettingsSave] -> Put

ToSBP MsgSettingsSave

Methods

toSBP :: MsgSettingsSave -> Word16 -> Msg

msgSettingsWrite :: Word16

data MsgSettingsWrite

SBP class for message MSG_SETTINGS_WRITE (0x00A0).

The setting message writes the device configuration.

Constructors

MsgSettingsWrite

Fields

• _msgSettingsWrite_setting :: Text

  A NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE]. A device will only process to this message when it is received from sender ID 0x42.

Instances

Eq MsgSettingsWrite

Methods

(==) :: MsgSettingsWrite -> MsgSettingsWrite -> Bool

(/=) :: MsgSettingsWrite -> MsgSettingsWrite -> Bool

Read MsgSettingsWrite

Methods

readsPrec :: Int -> ReadS MsgSettingsWrite

readList :: ReadS [MsgSettingsWrite]

readPrec :: ReadPrec MsgSettingsWrite

readListPrec :: ReadPrec [MsgSettingsWrite]

Show MsgSettingsWrite

Methods

showsPrec :: Int -> MsgSettingsWrite -> ShowS

show :: MsgSettingsWrite -> String

showList :: [MsgSettingsWrite] -> ShowS

ToJSON MsgSettingsWrite

Methods

toJSON :: MsgSettingsWrite -> Value

toEncoding :: MsgSettingsWrite -> Encoding

FromJSON MsgSettingsWrite

Methods

parseJSON :: Value -> Parser MsgSettingsWrite

Binary MsgSettingsWrite

Methods

put :: MsgSettingsWrite -> Put

get :: Get MsgSettingsWrite

putList :: [MsgSettingsWrite] -> Put

ToSBP MsgSettingsWrite

Methods

toSBP :: MsgSettingsWrite -> Word16 -> Msg

msgSettingsWrite_setting :: Iso' MsgSettingsWrite Text

msgSettingsReadReq :: Word16

data MsgSettingsReadReq

SBP class for message MSG_SETTINGS_READ_REQ (0x00A4).

The setting message reads the device configuration.

Constructors

MsgSettingsReadReq

Fields

• _msgSettingsReadReq_setting :: Text

  A NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING]. A device will only respond to this message when it is received from sender ID 0x42.

Instances

Eq MsgSettingsReadReq

Methods

(==) :: MsgSettingsReadReq -> MsgSettingsReadReq -> Bool

(/=) :: MsgSettingsReadReq -> MsgSettingsReadReq -> Bool

Read MsgSettingsReadReq

Methods

readsPrec :: Int -> ReadS MsgSettingsReadReq

readList :: ReadS [MsgSettingsReadReq]

readPrec :: ReadPrec MsgSettingsReadReq

readListPrec :: ReadPrec [MsgSettingsReadReq]

Show MsgSettingsReadReq

Methods

showsPrec :: Int -> MsgSettingsReadReq -> ShowS

show :: MsgSettingsReadReq -> String

showList :: [MsgSettingsReadReq] -> ShowS

ToJSON MsgSettingsReadReq

Methods

toJSON :: MsgSettingsReadReq -> Value

toEncoding :: MsgSettingsReadReq -> Encoding

FromJSON MsgSettingsReadReq

Methods

parseJSON :: Value -> Parser MsgSettingsReadReq

Binary MsgSettingsReadReq

Methods

put :: MsgSettingsReadReq -> Put

get :: Get MsgSettingsReadReq

putList :: [MsgSettingsReadReq] -> Put

ToSBP MsgSettingsReadReq

Methods

toSBP :: MsgSettingsReadReq -> Word16 -> Msg

msgSettingsReadReq_setting :: Iso' MsgSettingsReadReq Text

msgSettingsReadResp :: Word16

data MsgSettingsReadResp

SBP class for message MSG_SETTINGS_READ_RESP (0x00A5).

The setting message reads the device configuration.

Constructors

MsgSettingsReadResp

Fields

• _msgSettingsReadResp_setting :: Text

  A NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE].

Instances

Eq MsgSettingsReadResp

Methods

(==) :: MsgSettingsReadResp -> MsgSettingsReadResp -> Bool

(/=) :: MsgSettingsReadResp -> MsgSettingsReadResp -> Bool

Read MsgSettingsReadResp

Methods

readsPrec :: Int -> ReadS MsgSettingsReadResp

readList :: ReadS [MsgSettingsReadResp]

readPrec :: ReadPrec MsgSettingsReadResp

readListPrec :: ReadPrec [MsgSettingsReadResp]

Show MsgSettingsReadResp

Methods

showsPrec :: Int -> MsgSettingsReadResp -> ShowS

show :: MsgSettingsReadResp -> String

showList :: [MsgSettingsReadResp] -> ShowS

ToJSON MsgSettingsReadResp

Methods

toJSON :: MsgSettingsReadResp -> Value

toEncoding :: MsgSettingsReadResp -> Encoding

FromJSON MsgSettingsReadResp

Methods

parseJSON :: Value -> Parser MsgSettingsReadResp

Binary MsgSettingsReadResp

Methods

put :: MsgSettingsReadResp -> Put

get :: Get MsgSettingsReadResp

putList :: [MsgSettingsReadResp] -> Put

ToSBP MsgSettingsReadResp

Methods

toSBP :: MsgSettingsReadResp -> Word16 -> Msg

msgSettingsReadResp_setting :: Iso' MsgSettingsReadResp Text

msgSettingsReadByIndexReq :: Word16

data MsgSettingsReadByIndexReq

SBP class for message MSG_SETTINGS_READ_BY_INDEX_REQ (0x00A2).

The settings message for iterating through the settings values. It will read the setting at an index, returning a NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE]. A device will only respond to this message when it is received from sender ID 0x42.

Constructors

MsgSettingsReadByIndexReq

Fields

• _msgSettingsReadByIndexReq_index :: Word16

  An index into the device settings, with values ranging from 0 to length(settings)

Instances

Eq MsgSettingsReadByIndexReq

Methods

(==) :: MsgSettingsReadByIndexReq -> MsgSettingsReadByIndexReq -> Bool

(/=) :: MsgSettingsReadByIndexReq -> MsgSettingsReadByIndexReq -> Bool

Read MsgSettingsReadByIndexReq

Methods

readsPrec :: Int -> ReadS MsgSettingsReadByIndexReq

readList :: ReadS [MsgSettingsReadByIndexReq]

readPrec :: ReadPrec MsgSettingsReadByIndexReq

readListPrec :: ReadPrec [MsgSettingsReadByIndexReq]

Show MsgSettingsReadByIndexReq

Methods

showsPrec :: Int -> MsgSettingsReadByIndexReq -> ShowS

show :: MsgSettingsReadByIndexReq -> String

showList :: [MsgSettingsReadByIndexReq] -> ShowS

ToJSON MsgSettingsReadByIndexReq

Methods

toJSON :: MsgSettingsReadByIndexReq -> Value

toEncoding :: MsgSettingsReadByIndexReq -> Encoding

FromJSON MsgSettingsReadByIndexReq

Methods

parseJSON :: Value -> Parser MsgSettingsReadByIndexReq

Binary MsgSettingsReadByIndexReq

Methods

put :: MsgSettingsReadByIndexReq -> Put

get :: Get MsgSettingsReadByIndexReq

putList :: [MsgSettingsReadByIndexReq] -> Put

ToSBP MsgSettingsReadByIndexReq

Methods

toSBP :: MsgSettingsReadByIndexReq -> Word16 -> Msg

msgSettingsReadByIndexReq_index :: Iso' MsgSettingsReadByIndexReq Word16

msgSettingsReadByIndexResp :: Word16

data MsgSettingsReadByIndexResp

SBP class for message MSG_SETTINGS_READ_BY_INDEX_RESP (0x00A7).

The settings message for iterating through the settings values. It will read the setting at an index, returning a NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE].

Constructors

MsgSettingsReadByIndexResp

Fields

• _msgSettingsReadByIndexResp_index :: Word16

  An index into the device settings, with values ranging from 0 to length(settings)

• _msgSettingsReadByIndexResp_setting :: Text

  A NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE].

Instances

Eq MsgSettingsReadByIndexResp

Methods

(==) :: MsgSettingsReadByIndexResp -> MsgSettingsReadByIndexResp -> Bool

(/=) :: MsgSettingsReadByIndexResp -> MsgSettingsReadByIndexResp -> Bool

Read MsgSettingsReadByIndexResp

Methods

readsPrec :: Int -> ReadS MsgSettingsReadByIndexResp

readList :: ReadS [MsgSettingsReadByIndexResp]

readPrec :: ReadPrec MsgSettingsReadByIndexResp

readListPrec :: ReadPrec [MsgSettingsReadByIndexResp]

Show MsgSettingsReadByIndexResp

Methods

showsPrec :: Int -> MsgSettingsReadByIndexResp -> ShowS

show :: MsgSettingsReadByIndexResp -> String

showList :: [MsgSettingsReadByIndexResp] -> ShowS

ToJSON MsgSettingsReadByIndexResp

Methods

toJSON :: MsgSettingsReadByIndexResp -> Value

toEncoding :: MsgSettingsReadByIndexResp -> Encoding

FromJSON MsgSettingsReadByIndexResp

Methods

parseJSON :: Value -> Parser MsgSettingsReadByIndexResp

Binary MsgSettingsReadByIndexResp

Methods

put :: MsgSettingsReadByIndexResp -> Put

get :: Get MsgSettingsReadByIndexResp

putList :: [MsgSettingsReadByIndexResp] -> Put

ToSBP MsgSettingsReadByIndexResp

Methods

toSBP :: MsgSettingsReadByIndexResp -> Word16 -> Msg

msgSettingsReadByIndexResp_setting :: Lens' MsgSettingsReadByIndexResp Text

msgSettingsReadByIndexResp_index :: Lens' MsgSettingsReadByIndexResp Word16

msgSettingsReadByIndexDone :: Word16

data MsgSettingsReadByIndexDone

SBP class for message MSG_SETTINGS_READ_BY_INDEX_DONE (0x00A6).

The settings message for indicating end of the settings values.

Constructors

MsgSettingsReadByIndexDone

Instances

Eq MsgSettingsReadByIndexDone

Methods

(==) :: MsgSettingsReadByIndexDone -> MsgSettingsReadByIndexDone -> Bool

(/=) :: MsgSettingsReadByIndexDone -> MsgSettingsReadByIndexDone -> Bool

Read MsgSettingsReadByIndexDone

Methods

readsPrec :: Int -> ReadS MsgSettingsReadByIndexDone

readList :: ReadS [MsgSettingsReadByIndexDone]

readPrec :: ReadPrec MsgSettingsReadByIndexDone

readListPrec :: ReadPrec [MsgSettingsReadByIndexDone]

Show MsgSettingsReadByIndexDone

Methods

showsPrec :: Int -> MsgSettingsReadByIndexDone -> ShowS

show :: MsgSettingsReadByIndexDone -> String

showList :: [MsgSettingsReadByIndexDone] -> ShowS

ToJSON MsgSettingsReadByIndexDone

Methods

toJSON :: MsgSettingsReadByIndexDone -> Value

toEncoding :: MsgSettingsReadByIndexDone -> Encoding

FromJSON MsgSettingsReadByIndexDone

Methods

parseJSON :: Value -> Parser MsgSettingsReadByIndexDone

Binary MsgSettingsReadByIndexDone

Methods

put :: MsgSettingsReadByIndexDone -> Put

get :: Get MsgSettingsReadByIndexDone

putList :: [MsgSettingsReadByIndexDone] -> Put

ToSBP MsgSettingsReadByIndexDone

Methods

toSBP :: MsgSettingsReadByIndexDone -> Word16 -> Msg

msgSettingsRegister :: Word16

data MsgSettingsRegister

SBP class for message MSG_SETTINGS_REGISTER (0x00AE).

This message registers the presence and default value of a setting with a settings daemon. The host should reply with MSG_SETTINGS_WRITE for this setting to set the initial value.

Constructors

MsgSettingsRegister

Fields

• _msgSettingsRegister_setting :: Text

  A NULL-terminated and delimited string with contents [SECTION_SETTING, SETTING, VALUE].

Instances

Eq MsgSettingsRegister

Methods

(==) :: MsgSettingsRegister -> MsgSettingsRegister -> Bool

(/=) :: MsgSettingsRegister -> MsgSettingsRegister -> Bool

Read MsgSettingsRegister

Methods

readsPrec :: Int -> ReadS MsgSettingsRegister

readList :: ReadS [MsgSettingsRegister]

readPrec :: ReadPrec MsgSettingsRegister

readListPrec :: ReadPrec [MsgSettingsRegister]

Show MsgSettingsRegister

Methods

showsPrec :: Int -> MsgSettingsRegister -> ShowS

show :: MsgSettingsRegister -> String

showList :: [MsgSettingsRegister] -> ShowS

ToJSON MsgSettingsRegister

Methods

toJSON :: MsgSettingsRegister -> Value

toEncoding :: MsgSettingsRegister -> Encoding

FromJSON MsgSettingsRegister

Methods

parseJSON :: Value -> Parser MsgSettingsRegister

Binary MsgSettingsRegister

Methods

put :: MsgSettingsRegister -> Put

get :: Get MsgSettingsRegister

putList :: [MsgSettingsRegister] -> Put

ToSBP MsgSettingsRegister

Methods

toSBP :: MsgSettingsRegister -> Word16 -> Msg

msgSettingsRegister_setting :: Iso' MsgSettingsRegister Text