Skip to content

Spokezone

NameDescription
ApiProvides configured access to the Spoke.Zone API.
AuthenticationApi
AuthManagerChecks and refreshes the configured Spoke.Zone device token.
DataFilesApi
DataFileUploadManagerUploads files selected by configured data-file sets, manually or on the Spoke.Zone logging schedule.
DevicesApi
GetDataFilesQueryParams
GetOtaFilesQueryParams
OtaFilesApi
OtaManagerQueries OTA files using the module and active-status filters documented by Spoke.Zone.
SpokeZoneConfigOwns the validated Spoke.Zone state associated with one caller-owned configuration store.
DataFileSetSelects direct child files of a directory using a QDir name-filter pattern.
NameDescription
DataFileTypeThe Spoke.Zone data-file type associated with an on-device file.

enum DataFileType

The Spoke.Zone data-file type associated with an on-device file.

ValueDescription
Log
Event
Gps
Debug
Journal
Dmesg
Text
Parquet
ReturnNameDescription
QStringdataFileTypeToApiString inlineReturns the Spoke.Zone API string for a data-file type, or an empty string for an unknown value.
const QStringconfigDirPath inlineReturns the absolute path to the spoke-zone configuration directory for the current build target.
QDirconfigDir inlineReturns a QDir handle for the spoke-zone configuration directory.

inline
inline QString dataFileTypeToApiString(DataFileType type)

Returns the Spoke.Zone API string for a data-file type, or an empty string for an unknown value.


inline
inline const QString configDirPath()

Returns the absolute path to the spoke-zone configuration directory for the current build target.

The directory is selected at compile time based on the active platform macro:

  • Yocto (MRX_SDK_QT_TARGET_OS_YOCTO): /rw_data/etc/spoke-zone
  • Buildroot (MRX_SDK_QT_TARGET_OS_BUILDROOT): /etc/spoke-zone
  • Host / development (no platform macro): $HOME/.config/spoke-zone

Absolute path string to the platform-appropriate config directory.


inline
inline QDir configDir()

Returns a QDir handle for the spoke-zone configuration directory.

Convenience wrapper that constructs a QDir from configDirPath().

QDir pointing at the platform-appropriate config directory.