Copyright | Copyright (C) 2015 Swift Navigation, Inc. |
---|---|
License | LGPL-3 |
Maintainer | Mark Fine <dev@swiftnav.com> |
Stability | experimental |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
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
- msgSettingsSave :: Word16
- data MsgSettingsSave = MsgSettingsSave
- msgSettingsWrite :: Word16
- data MsgSettingsWrite = MsgSettingsWrite {}
- msgSettingsWrite_setting :: Iso' MsgSettingsWrite Text
- msgSettingsReadReq :: Word16
- data MsgSettingsReadReq = MsgSettingsReadReq {}
- msgSettingsReadReq_setting :: Iso' MsgSettingsReadReq Text
- msgSettingsReadResp :: Word16
- data MsgSettingsReadResp = MsgSettingsReadResp {}
- msgSettingsReadResp_setting :: Iso' MsgSettingsReadResp Text
- msgSettingsReadByIndexReq :: Word16
- data MsgSettingsReadByIndexReq = MsgSettingsReadByIndexReq {
- _msgSettingsReadByIndexReq_index :: Word16
- msgSettingsReadByIndexReq_index :: Iso' MsgSettingsReadByIndexReq Word16
- msgSettingsReadByIndexResp :: Word16
- data MsgSettingsReadByIndexResp = MsgSettingsReadByIndexResp {}
- msgSettingsReadByIndexResp_setting :: Lens' MsgSettingsReadByIndexResp Text
- msgSettingsReadByIndexResp_index :: Lens' MsgSettingsReadByIndexResp Word16
- msgSettingsReadByIndexDone :: Word16
- data MsgSettingsReadByIndexDone = MsgSettingsReadByIndexDone
- msgSettingsRegister :: Word16
- data MsgSettingsRegister = MsgSettingsRegister {}
- msgSettingsRegister_setting :: Iso' MsgSettingsRegister Text
Documentation
msgSettingsSave :: Word16 Source #
data MsgSettingsSave Source #
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.
msgSettingsWrite :: Word16 Source #
data MsgSettingsWrite Source #
SBP class for message MSG_SETTINGS_WRITE (0x00A0).
The setting message writes the device configuration.
MsgSettingsWrite | |
|
msgSettingsReadReq :: Word16 Source #
data MsgSettingsReadReq Source #
SBP class for message MSG_SETTINGS_READ_REQ (0x00A4).
The setting message reads the device configuration.
MsgSettingsReadReq | |
|
msgSettingsReadResp :: Word16 Source #
data MsgSettingsReadResp Source #
SBP class for message MSG_SETTINGS_READ_RESP (0x00A5).
The setting message reads the device configuration.
MsgSettingsReadResp | |
|
msgSettingsReadByIndexReq :: Word16 Source #
data MsgSettingsReadByIndexReq Source #
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.
MsgSettingsReadByIndexReq | |
|
msgSettingsReadByIndexResp :: Word16 Source #
data MsgSettingsReadByIndexResp Source #
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].
MsgSettingsReadByIndexResp | |
|
msgSettingsReadByIndexDone :: Word16 Source #
data MsgSettingsReadByIndexDone Source #
SBP class for message MSG_SETTINGS_READ_BY_INDEX_DONE (0x00A6).
The settings message for indicating end of the settings values.
msgSettingsRegister :: Word16 Source #
data MsgSettingsRegister Source #
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.
MsgSettingsRegister | |
|