| Copyright | Copyright (C) 2015-2021 Swift Navigation Inc. |
|---|---|
| License | MIT |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
SwiftNav.SBP.Settings
Description
< Messages for reading, writing, and discovering device settings. Settings with a "string" field have multiple values in this field delimited with a null character (the c style null terminator). For instance, when querying the firmware_version setting in the system_info section, the following array of characters needs to be sent for the string field in MSG_SETTINGS_READ: "system_info0firmware_version0", where the delimiting null characters are specified with the escape sequence '0' and all quotation marks should be omitted.
In the message descriptions below, the generic strings SECTION_SETTING and SETTING are used to refer to the two strings that comprise the identifier of an individual setting.In firmware_version example above, SECTION_SETTING is the system_info, and the SETTING portion is firmware_version. See the "Software Settings Manual" on support.swiftnav.com for detailed documentation about all settings and sections available for each Swift firmware version. Settings manuals are available for each firmware version at the following link: https://support.swiftnav.com/support/solutions/articles/44001850753-piksi-multi-specification. The latest settings document is also available at the following link: http://swiftnav.com/latest/piksi-multi-settings . See lastly https://github.com/swift-nav/piksi_tools/blob/master/piksi_tools/settings.py , the open source python command line utility for reading, writing, and saving settings in the piksi_tools repository on github as a helpful reference and example. >
Synopsis
- msgSettingsSave :: Word16
- data MsgSettingsSave = MsgSettingsSave
- msgSettingsWrite :: Word16
- data MsgSettingsWrite = MsgSettingsWrite {}
- msgSettingsWriteResp :: Word16
- data MsgSettingsWriteResp = MsgSettingsWriteResp {}
- msgSettingsReadReq :: Word16
- data MsgSettingsReadReq = MsgSettingsReadReq {}
- msgSettingsReadResp :: Word16
- data MsgSettingsReadResp = MsgSettingsReadResp {}
- msgSettingsReadByIndexReq :: Word16
- data MsgSettingsReadByIndexReq = MsgSettingsReadByIndexReq {}
- msgSettingsReadByIndexResp :: Word16
- data MsgSettingsReadByIndexResp = MsgSettingsReadByIndexResp {}
- msgSettingsReadByIndexDone :: Word16
- data MsgSettingsReadByIndexDone = MsgSettingsReadByIndexDone
- msgSettingsRegister :: Word16
- data MsgSettingsRegister = MsgSettingsRegister {}
- msgSettingsRegisterResp :: Word16
- data MsgSettingsRegisterResp = MsgSettingsRegisterResp {}
- msgSettingsWrite_setting :: Iso' MsgSettingsWrite Text
- msgSettingsWriteResp_setting :: Lens' MsgSettingsWriteResp Text
- msgSettingsWriteResp_status :: Lens' MsgSettingsWriteResp Word8
- msgSettingsReadReq_setting :: Iso' MsgSettingsReadReq Text
- msgSettingsReadResp_setting :: Iso' MsgSettingsReadResp Text
- msgSettingsReadByIndexReq_index :: Iso' MsgSettingsReadByIndexReq Word16
- msgSettingsReadByIndexResp_index :: Lens' MsgSettingsReadByIndexResp Word16
- msgSettingsReadByIndexResp_setting :: Lens' MsgSettingsReadByIndexResp Text
- msgSettingsRegister_setting :: Iso' MsgSettingsRegister Text
- msgSettingsRegisterResp_setting :: Lens' MsgSettingsRegisterResp Text
- msgSettingsRegisterResp_status :: Lens' MsgSettingsRegisterResp Word8
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 |
Instances
data MsgSettingsWrite Source #
SBP class for message MSG_SETTINGS_WRITE (0x00A0).
The setting message writes the device configuration for a particular setting via A NULL-terminated and NULL-delimited string with contents "SECTION_SETTING0SETTING0VALUE0" where the '0' escape sequence denotes the NULL character and where quotation marks are omitted. A device will only process to this message when it is received from sender ID 0x42. An example string that could be sent to a device is "solution0soln_freq0100".
Constructors
| MsgSettingsWrite | |
Fields
| |
Instances
data MsgSettingsWriteResp Source #
SBP class for message MSG_SETTINGS_WRITE_RESP (0x00AF).
Return the status of a write request with the new value of the setting. If the requested value is rejected, the current value will be returned. The string field is a NULL-terminated and NULL-delimited string with contents "SECTION_SETTING0SETTING0VALUE0" where the '0' escape sequence denotes the NULL character and where quotation marks are omitted. An example string that could be sent from device is "solution0soln_freq0100".
Constructors
| MsgSettingsWriteResp | |
Fields
| |
Instances
data MsgSettingsReadReq Source #
SBP class for message MSG_SETTINGS_READ_REQ (0x00A4).
The setting message that reads the device configuration. The string field is a NULL-terminated and NULL-delimited string with contents "SECTION_SETTING0SETTING0" where the '0' escape sequence denotes the NULL character and where quotation marks are omitted. An example string that could be sent to a device is "solution0soln_freq0". A device will only respond to this message when it is received from sender ID 0x42. A device should respond with a MSG_SETTINGS_READ_RESP message (msg_id 0x00A5).
Constructors
| MsgSettingsReadReq | |
Fields
| |
Instances
data MsgSettingsReadResp Source #
SBP class for message MSG_SETTINGS_READ_RESP (0x00A5).
The setting message with which the device responds after a MSG_SETTING_READ_REQ is sent to device. The string field is a NULL- terminated and NULL-delimited string with contents "SECTION_SETTING0SETTING0VALUE0" where the '0' escape sequence denotes the NULL character and where quotation marks are omitted. An example string that could be sent from device is "solution0soln_freq0100".
Constructors
| MsgSettingsReadResp | |
Fields
| |
Instances
data MsgSettingsReadByIndexReq Source #
SBP class for message MSG_SETTINGS_READ_BY_INDEX_REQ (0x00A2).
The settings message for iterating through the settings values. A device will respond to this message with a MSG_SETTINGS_READ_BY_INDEX_RESP.
Constructors
| MsgSettingsReadByIndexReq | |
Fields
| |
Instances
data MsgSettingsReadByIndexResp Source #
SBP class for message MSG_SETTINGS_READ_BY_INDEX_RESP (0x00A7).
The settings message that reports the value of a setting at an index.
In the string field, it reports NULL-terminated and delimited string with contents "SECTION_SETTING0SETTING0VALUE0FORMAT_TYPE0". where the '0' escape sequence denotes the NULL character and where quotation marks are omitted. The FORMAT_TYPE field is optional and denotes possible string values of the setting as a hint to the user. If included, the format type portion of the string has the format "enum:value1,value2,value3". An example string that could be sent from the device is "simulator0enabled0True0enum:True,False0".
Constructors
| MsgSettingsReadByIndexResp | |
Fields
| |
Instances
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 |
Instances
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.
Constructors
| MsgSettingsRegister | |
Fields
| |
Instances
data MsgSettingsRegisterResp Source #
SBP class for message MSG_SETTINGS_REGISTER_RESP (0x01AF).
This message responds to setting registration with the effective value. The effective value shall differ from the given default value if setting was already registered or is available in the permanent setting storage and had a different value.
Constructors
| MsgSettingsRegisterResp | |
Fields
| |