| 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 |
SwiftNav.SBP.Settings
Description
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 ByteString
- msgSettingsReadReq :: Word16
- data MsgSettingsReadReq = MsgSettingsReadReq {}
- msgSettingsReadReq_setting :: Iso' MsgSettingsReadReq ByteString
- msgSettingsReadResp :: Word16
- data MsgSettingsReadResp = MsgSettingsReadResp {}
- msgSettingsReadResp_setting :: Iso' MsgSettingsReadResp ByteString
- msgSettingsReadByIndexReq :: Word16
- data MsgSettingsReadByIndexReq = MsgSettingsReadByIndexReq {}
- msgSettingsReadByIndexReq_index :: Iso' MsgSettingsReadByIndexReq Word16
- msgSettingsReadByIndexResp :: Word16
- data MsgSettingsReadByIndexResp = MsgSettingsReadByIndexResp {}
- msgSettingsReadByIndexResp_setting :: Lens' MsgSettingsReadByIndexResp ByteString
- msgSettingsReadByIndexResp_index :: Lens' MsgSettingsReadByIndexResp Word16
- msgSettingsReadByIndexDone :: Word16
- data MsgSettingsReadByIndexDone = MsgSettingsReadByIndexDone
Documentation
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.
Constructors
| MsgSettingsSave |
data MsgSettingsWrite Source
SBP class for message MSG_SETTINGS_WRITE (0x00A0).
The setting message writes the device configuration.
Constructors
| MsgSettingsWrite | |
Fields
| |
data MsgSettingsReadReq Source
SBP class for message MSG_SETTINGS_READ_REQ (0x00A4).
The setting message reads the device configuration.
Constructors
| MsgSettingsReadReq | |
Fields
| |
data MsgSettingsReadResp Source
SBP class for message MSG_SETTINGS_READ_RESP (0x00A5).
The setting message reads the device configuration.
Constructors
| MsgSettingsReadResp | |
Fields
| |
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.
Constructors
| MsgSettingsReadByIndexReq | |
Fields
| |
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].
Constructors
| MsgSettingsReadByIndexResp | |
Fields
| |
data MsgSettingsReadByIndexDone Source
SBP class for message MSG_SETTINGS_READ_BY_INDEX_DONE (0x00A6).
The settings message for indicating end of the settings values.
Constructors
| MsgSettingsReadByIndexDone |