Data Structures
struct	msg_settings_write_t

struct	msg_settings_write_resp_t

struct	msg_settings_read_req_t

struct	msg_settings_read_resp_t

struct	msg_settings_read_by_index_req_t

struct	msg_settings_read_by_index_resp_t

struct	msg_settings_register_t

Macros
#define	SBP_MSG_SETTINGS_SAVE 0x00A1
	Save settings to flash (host => device) More...

#define	SBP_MSG_SETTINGS_WRITE 0x00A0
	Write device configuration settings (host => device) More...

#define	SBP_MSG_SETTINGS_WRITE_RESP 0x00AF
	Acknowledgement with status of MSG_SETTINGS_WRITE. More...

#define	SBP_MSG_SETTINGS_READ_REQ 0x00A4
	Read device configuration settings (host => device) More...

#define	SBP_MSG_SETTINGS_READ_RESP 0x00A5
	Read device configuration settings (host <= device) More...

#define	SBP_MSG_SETTINGS_READ_BY_INDEX_REQ 0x00A2
	Read setting by direct index (host => device) More...

#define	SBP_MSG_SETTINGS_READ_BY_INDEX_RESP 0x00A7
	Read setting by direct index (host <= device) More...

#define	SBP_MSG_SETTINGS_READ_BY_INDEX_DONE 0x00A6
	Finished reading settings (host <= device) More...

#define	SBP_MSG_SETTINGS_REGISTER 0x00AE
	Register setting and default value (device => host) More...

Detailed 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_info\0firmware_version\0", 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/customer/en/portal/articles/2628580-piksi-multi-specifications#settings. 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.

Macro Definition Documentation

#define SBP_MSG_SETTINGS_READ_BY_INDEX_DONE 0x00A6

Finished reading settings (host <= device)

The settings message for indicating end of the settings values.

Definition at line 181 of file settings.h.

#define SBP_MSG_SETTINGS_READ_BY_INDEX_REQ 0x00A2

Read setting by direct index (host => device)

The settings message for iterating through the settings values. A device will respond to this message with a "MSG_SETTINGS_READ_BY_INDEX_RESP".

Definition at line 145 of file settings.h.

#define SBP_MSG_SETTINGS_READ_BY_INDEX_RESP 0x00A7

Read setting by direct index (host <= device)

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_SETTING\0SETTING\0VALUE\0FORMAT_TYPE\0". 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 "simulator\0enabled\0True\0enum:True,False\0"

Definition at line 166 of file settings.h.

#define SBP_MSG_SETTINGS_READ_REQ 0x00A4

Read device configuration settings (host => device)

The setting message that reads the device configuration. The string field is a NULL-terminated and NULL-delimited string with contents "SECTION_SETTING\0SETTING\0" 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 "solution\0soln_freq\0". 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).

Definition at line 112 of file settings.h.

#define SBP_MSG_SETTINGS_READ_RESP 0x00A5

Read device configuration settings (host <= device)

The setting message wich 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_SETTING\0SETTING\0VALUE\0" 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 "solution\0soln_freq\010\0".

Definition at line 130 of file settings.h.

#define SBP_MSG_SETTINGS_REGISTER 0x00AE

Register setting and default value (device => host)

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.

Definition at line 190 of file settings.h.

#define SBP_MSG_SETTINGS_SAVE 0x00A1

Save settings to flash (host => device)

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

Definition at line 61 of file settings.h.

#define SBP_MSG_SETTINGS_WRITE 0x00A0

Write device configuration settings (host => device)

The setting message writes the device configuration for a particular setting via A NULL-terminated and NULL-delimited string with contents "SECTION_SETTING\0SETTING\0VALUE\0" 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 "solution\0soln_freq\010\0".

Definition at line 74 of file settings.h.

#define SBP_MSG_SETTINGS_WRITE_RESP 0x00AF

Acknowledgement with status of MSG_SETTINGS_WRITE.

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_SETTING\0SETTING\0VALUE\0" 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 "solution\0soln_freq\010\0".

Definition at line 92 of file settings.h.

Data Structures

Macros

Detailed Description

Macro Definition Documentation