ubloxcfg
u-blox 9 configuration helpers
|
Data Structures | |
struct | UBLOXCFG_CONST_s |
Constants for type E1/E2/E4 configuration items. More... | |
struct | UBLOXCFG_ITEM_s |
Configuration item. More... | |
struct | UBLOXCFG_MSGRATE_s |
Configuration items for output message rate configuration. More... | |
Macros | |
#define | UBLOXCFG_ID2SIZE(id) |
Get item size from item ID. | |
#define | UBLOXCFG_ID2GROUP(id) |
Get item group ID from item ID. | |
#define | UBLOXCFG_ID2IDGRP(id) |
Get item ID within group from item ID. | |
Typedefs | |
typedef enum UBLOXCFG_SIZE_e | UBLOXCFG_SIZE_t |
Configuration item size. | |
typedef enum UBLOXCFG_TYPE_e | UBLOXCFG_TYPE_t |
Configuration item storage type (s.a. UBLOXCFG_VALUE_t) | |
typedef struct UBLOXCFG_CONST_s | UBLOXCFG_CONST_t |
Constants for type E1/E2/E4 configuration items. | |
typedef struct UBLOXCFG_ITEM_s | UBLOXCFG_ITEM_t |
Configuration item. | |
typedef struct UBLOXCFG_MSGRATE_s | UBLOXCFG_MSGRATE_t |
Configuration items for output message rate configuration. | |
typedef enum UBLOXCFG_LAYER_e | UBLOXCFG_LAYER_t |
Configuration layers. | |
Enumerations | |
enum | UBLOXCFG_SIZE_e { UBLOXCFG_SIZE_BIT = 0x01 , UBLOXCFG_SIZE_ONE = 0x02 , UBLOXCFG_SIZE_TWO = 0x03 , UBLOXCFG_SIZE_FOUR = 0x04 , UBLOXCFG_SIZE_EIGHT = 0x05 } |
Configuration item size. More... | |
enum | UBLOXCFG_TYPE_e { UBLOXCFG_TYPE_U1 , UBLOXCFG_TYPE_U2 , UBLOXCFG_TYPE_U4 , UBLOXCFG_TYPE_U8 , UBLOXCFG_TYPE_I1 , UBLOXCFG_TYPE_I2 , UBLOXCFG_TYPE_I4 , UBLOXCFG_TYPE_I8 , UBLOXCFG_TYPE_X1 , UBLOXCFG_TYPE_X2 , UBLOXCFG_TYPE_X4 , UBLOXCFG_TYPE_X8 , UBLOXCFG_TYPE_R4 , UBLOXCFG_TYPE_R8 , UBLOXCFG_TYPE_E1 , UBLOXCFG_TYPE_E2 , UBLOXCFG_TYPE_E4 , UBLOXCFG_TYPE_L } |
Configuration item storage type (s.a. UBLOXCFG_VALUE_t) More... | |
enum | UBLOXCFG_LAYER_e { UBLOXCFG_LAYER_RAM , UBLOXCFG_LAYER_BBR , UBLOXCFG_LAYER_FLASH , UBLOXCFG_LAYER_DEFAULT } |
Configuration layers. More... | |
Functions | |
const UBLOXCFG_ITEM_t * | ubloxcfg_getItemByName (const char *name) |
Get configuration item info by name. | |
const UBLOXCFG_ITEM_t * | ubloxcfg_getItemById (const uint32_t id) |
Get configuration item info by key ID. | |
const UBLOXCFG_ITEM_t ** | ubloxcfg_getAllItems (int *num) |
Get list of all items. | |
const UBLOXCFG_MSGRATE_t * | ubloxcfg_getMsgRateCfg (const char *msgName) |
Get configuration items for output message rate configuration. | |
const UBLOXCFG_MSGRATE_t ** | ubloxcfg_getAllMsgRateCfgs (int *num) |
Get list of all output message rate configurations. | |
const char * | ubloxcfg_layerName (const UBLOXCFG_LAYER_t layer) |
Get name for layer. | |
bool | ubloxcfg_layerFromName (const char *name, UBLOXCFG_LAYER_t *layer) |
Get layer from name. | |
#define UBLOXCFG_ID2SIZE | ( | id | ) |
Get item size from item ID.
[in] | id | The item ID |
Definition at line 60 of file ubloxcfg.h.
#define UBLOXCFG_ID2GROUP | ( | id | ) |
Get item group ID from item ID.
[in] | id | The item ID |
Definition at line 67 of file ubloxcfg.h.
#define UBLOXCFG_ID2IDGRP | ( | id | ) |
Get item ID within group from item ID.
[in] | id | The item ID |
Definition at line 74 of file ubloxcfg.h.
enum UBLOXCFG_SIZE_e |
Configuration item size.
Enumerator | |
---|---|
UBLOXCFG_SIZE_BIT | One bit. |
UBLOXCFG_SIZE_ONE | One byte. |
UBLOXCFG_SIZE_TWO | Two bytes. |
UBLOXCFG_SIZE_FOUR | Four bytes. |
UBLOXCFG_SIZE_EIGHT | Eight bytes. |
Definition at line 44 of file ubloxcfg.h.
enum UBLOXCFG_TYPE_e |
Configuration item storage type (s.a. UBLOXCFG_VALUE_t)
Definition at line 77 of file ubloxcfg.h.
enum UBLOXCFG_LAYER_e |
Configuration layers.
Enumerator | |
---|---|
UBLOXCFG_LAYER_RAM | RAM layer (a.k.a. current configuration) |
UBLOXCFG_LAYER_BBR | BBR layer. |
UBLOXCFG_LAYER_FLASH | Flash layer. |
UBLOXCFG_LAYER_DEFAULT | Default layer. |
Definition at line 181 of file ubloxcfg.h.
const UBLOXCFG_ITEM_t * ubloxcfg_getItemByName | ( | const char * | name | ) |
Get configuration item info by name.
[in] | name | Name of the configuration item (e.g. "CFG-NAVSPG-FIXMODE") or hexadecimal string of the item ID (e.g. "0x20110011") |
Definition at line 41 of file ubloxcfg.c.
const UBLOXCFG_ITEM_t * ubloxcfg_getItemById | ( | const uint32_t | id | ) |
Get configuration item info by key ID.
[in] | id | ID of the configuration item (e.g. 0x20110011) |
Definition at line 74 of file ubloxcfg.c.
const UBLOXCFG_ITEM_t ** ubloxcfg_getAllItems | ( | int * | num | ) |
Get list of all items.
[out] | num | Number of items returned |
Definition at line 89 of file ubloxcfg.c.
const UBLOXCFG_MSGRATE_t * ubloxcfg_getMsgRateCfg | ( | const char * | msgName | ) |
Get configuration items for output message rate configuration.
[in] | msgName | The name of the message (see Output message rates (aliases)) |
Definition at line 95 of file ubloxcfg.c.
const UBLOXCFG_MSGRATE_t ** ubloxcfg_getAllMsgRateCfgs | ( | int * | num | ) |
Get list of all output message rate configurations.
[out] | num | Number of output message rate configurations returned |
Definition at line 114 of file ubloxcfg.c.
const char * ubloxcfg_layerName | ( | const UBLOXCFG_LAYER_t | layer | ) |
Get name for layer.
Definition at line 1126 of file ubloxcfg.c.
bool ubloxcfg_layerFromName | ( | const char * | name, |
UBLOXCFG_LAYER_t * | layer | ||
) |
Get layer from name.
[in] | name | Layer name, case insensitive |
[out] | layer | Layer, only valid if return value is true |
Definition at line 1138 of file ubloxcfg.c.