Spokezone
Classes
Section titled “Classes”| Name | Description |
|---|---|
Api | Provides configured access to the Spoke.Zone API. |
AuthenticationApi | |
AuthManager | Checks and refreshes the configured Spoke.Zone device token. |
DataFilesApi | |
DataFileUploadManager | Uploads files selected by configured data-file sets, manually or on the Spoke.Zone logging schedule. |
DevicesApi | |
GetDataFilesQueryParams | |
GetOtaFilesQueryParams | |
OtaFilesApi | |
OtaManager | Queries OTA files using the module and active-status filters documented by Spoke.Zone. |
SpokeZoneConfig | Owns the validated Spoke.Zone state associated with one caller-owned configuration store. |
DataFileSet | Selects direct child files of a directory using a QDir name-filter pattern. |
Enumerations
Section titled “Enumerations”| Name | Description |
|---|---|
DataFileType | The Spoke.Zone data-file type associated with an on-device file. |
DataFileType
Section titled “DataFileType”Source locationmrx/spoke-zone/data-files/DataFileUtils.hpp
The Spoke.Zone data-file type associated with an on-device file.
| Value | Description |
|---|---|
Log | |
Event | |
Gps | |
Debug | |
Journal | |
Dmesg | |
Text | |
Parquet |
Functions
Section titled “Functions”| Return | Name | Description |
|---|---|---|
QString | dataFileTypeToApiString inline | Returns the Spoke.Zone API string for a data-file type, or an empty string for an unknown value. |
const QString | configDirPath inline | Returns the absolute path to the spoke-zone configuration directory for the current build target. |
QDir | configDir inline | Returns a QDir handle for the spoke-zone configuration directory. |
inline
dataFileTypeToApiString
Section titled “dataFileTypeToApiString”Source locationmrx/spoke-zone/data-files/DataFileUtils.hpp
Returns the Spoke.Zone API string for a data-file type, or an empty string for an unknown value.
inline
configDirPath
Section titled “configDirPath”Source locationmrx/spoke-zone/pathdefs.hpp
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
Returns
Section titled “Returns”Absolute path string to the platform-appropriate config directory.
inline
configDir
Section titled “configDir”Source locationmrx/spoke-zone/pathdefs.hpp
Returns a QDir handle for the spoke-zone configuration directory.
Convenience wrapper that constructs a QDir from configDirPath().
Returns
Section titled “Returns”QDir pointing at the platform-appropriate config directory.