sbp-0.50.4: SwiftNav's SBP Library

CopyrightCopyright (C) 2015 Swift Navigation, Inc.
LicenseLGPL-3
MaintainerMark Fine <dev@swiftnav.com>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

SwiftNav.SBP.Settings

Description

Messages for reading and writing the device's device settings. These are in the implementation-defined range (0x0000-0x00FF). 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_firmwareblobmasterdocs/settings.pdf

Synopsis

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's configuration.

Constructors

MsgSettingsWrite 

Fields

msgSettingsWrite_setting :: ByteString

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

data MsgSettingsReadReq Source

SBP class for message MSG_SETTINGS_READ_REQ (0x00A4).

The setting message reads the device's configuration.

Constructors

MsgSettingsReadReq 

Fields

msgSettingsReadReq_setting :: ByteString

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

data MsgSettingsReadResp Source

SBP class for message MSG_SETTINGS_READ_RESP (0x00A5).

The setting message reads the device's configuration.

Constructors

MsgSettingsReadResp 

Fields

msgSettingsReadResp_setting :: ByteString

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

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].

Constructors

MsgSettingsReadByIndexReq 

Fields

msgSettingsReadByIndexReq_index :: Word16

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

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

msgSettingsReadByIndexResp_index :: Word16

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

msgSettingsReadByIndexResp_setting :: ByteString

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

data MsgSettingsReadByIndexDone Source

SBP class for message MSG_SETTINGS_READ_BY_INDEX_DONE (0x00A6).

The settings message for indicating end of the settings values.