12#ifndef INFUSE_SDK_INCLUDE_GENERATED_KV_DEFINITIONS_H_
13#define INFUSE_SDK_INCLUDE_GENERATED_KV_DEFINITIONS_H_
17#include <zephyr/toolchain.h>
18#include <zephyr/sys/util_macro.h>
51#define KV_STRUCT_KV_STRING_VAR(num) \
117#define _KV_KEY_DEVICE_NAME_VAR(num) \
119 KV_STRUCT_KV_STRING_VAR(num) name; \
142#define _KV_KEY_WIFI_SSID_VAR(num) \
144 KV_STRUCT_KV_STRING_VAR(num) ssid; \
156#define _KV_KEY_WIFI_PSK_VAR(num) \
158 KV_STRUCT_KV_STRING_VAR(num) psk; \
172#define _KV_KEY_WIFI_CHANNELS_VAR(num) \
175 uint8_t channels[num]; \
187#define _KV_KEY_NTP_SERVER_URL_VAR(num) \
189 KV_STRUCT_KV_STRING_VAR(num) url; \
201#define _KV_KEY_EPACKET_UDP_URL_VAR(num) \
203 KV_STRUCT_KV_STRING_VAR(num) server; \
221#define _KV_KEY_LTE_MODEM_MODEL_VAR(num) \
223 KV_STRUCT_KV_STRING_VAR(num) model; \
235#define _KV_KEY_LTE_MODEM_FIRMWARE_REVISION_VAR(num) \
237 KV_STRUCT_KV_STRING_VAR(num) revision; \
249#define _KV_KEY_LTE_MODEM_ESN_VAR(num) \
251 KV_STRUCT_KV_STRING_VAR(num) esn; \
269#define _KV_KEY_LTE_SIM_UICC_VAR(num) \
271 KV_STRUCT_KV_STRING_VAR(num) uicc; \
285#define _KV_KEY_LTE_PDP_CONFIG_VAR(num) \
288 KV_STRUCT_KV_STRING_VAR(num) apn; \
355#define _KV_KEY_GEOFENCE_VAR(num) \
357 uint8_t points_num; \
358 struct gcs_location points[num]; \
385 uint8_t _remainder[];
390#define _KV_KEY_TASK_SCHEDULES_VAR(num) \
394 uint8_t periodicity_type; \
395 uint32_t timeout_s; \
396 struct kv_range_u8 battery_start; \
397 struct kv_range_u8 battery_terminate; \
398 uint32_t periodicity; \
399 uint8_t _remainder[num]; \
412#define _KV_KEY_SECURE_STORAGE_RESERVED_VAR(num) \
473#ifdef CONFIG_KV_STORE_KEY_GEOFENCE_RANGE
475 KV_KEY_GEOFENCE_END = 100 + CONFIG_KV_STORE_KEY_GEOFENCE_RANGE - 1,
483#ifdef CONFIG_KV_STORE_KEY_TASK_SCHEDULES_RANGE
485 KV_KEY_TASK_SCHEDULES_END = 1001 + CONFIG_KV_STORE_KEY_TASK_SCHEDULES_RANGE - 1,
491#ifdef CONFIG_KV_STORE_KEY_SECURE_STORAGE_RESERVED_RANGE
493 KV_KEY_SECURE_STORAGE_RESERVED_END =
494 30000 + CONFIG_KV_STORE_KEY_SECURE_STORAGE_RESERVED_RANGE - 1,
504 _KV_KEY_REBOOTS_SIZE =
sizeof(
struct kv_reboots),
523#define _KV_KEY_REBOOTS_TYPE struct kv_reboots
524#define _KV_KEY_BLUETOOTH_ADDR_TYPE struct kv_bluetooth_addr
525#define _KV_KEY_EXFAT_DISK_INFO_TYPE struct kv_exfat_disk_info
526#define _KV_KEY_BLUETOOTH_CTLR_VERSION_TYPE struct kv_bluetooth_ctlr_version
527#define _KV_KEY_DEVICE_NAME_TYPE struct kv_device_name
528#define _KV_KEY_INFUSE_APPLICATION_ID_TYPE struct kv_infuse_application_id
529#define _KV_KEY_FIXED_LOCATION_TYPE struct kv_fixed_location
530#define _KV_KEY_WIFI_SSID_TYPE struct kv_wifi_ssid
531#define _KV_KEY_WIFI_PSK_TYPE struct kv_wifi_psk
532#define _KV_KEY_WIFI_CHANNELS_TYPE struct kv_wifi_channels
533#define _KV_KEY_NTP_SERVER_URL_TYPE struct kv_ntp_server_url
534#define _KV_KEY_EPACKET_UDP_URL_TYPE struct kv_epacket_udp_url
535#define _KV_KEY_EPACKET_UDP_PORT_TYPE struct kv_epacket_udp_port
536#define _KV_KEY_LTE_MODEM_MODEL_TYPE struct kv_lte_modem_model
537#define _KV_KEY_LTE_MODEM_FIRMWARE_REVISION_TYPE struct kv_lte_modem_firmware_revision
538#define _KV_KEY_LTE_MODEM_ESN_TYPE struct kv_lte_modem_esn
539#define _KV_KEY_LTE_MODEM_IMEI_TYPE struct kv_lte_modem_imei
540#define _KV_KEY_LTE_SIM_UICC_TYPE struct kv_lte_sim_uicc
541#define _KV_KEY_LTE_PDP_CONFIG_TYPE struct kv_lte_pdp_config
542#define _KV_KEY_LTE_NETWORKING_MODES_TYPE struct kv_lte_networking_modes
543#define _KV_KEY_LTE_SIM_IMSI_TYPE struct kv_lte_sim_imsi
544#define _KV_KEY_BLUETOOTH_PEER_TYPE struct kv_bluetooth_peer
545#define _KV_KEY_LORA_CONFIG_TYPE struct kv_lora_config
546#define _KV_KEY_BLUETOOTH_THROUGHPUT_LIMIT_TYPE struct kv_bluetooth_throughput_limit
547#define _KV_KEY_GRAVITY_REFERENCE_TYPE struct kv_gravity_reference
548#define _KV_KEY_GEOFENCE_TYPE struct kv_geofence
549#define _KV_KEY_TASK_SCHEDULES_DEFAULT_ID_TYPE struct kv_task_schedules_default_id
550#define _KV_KEY_TASK_SCHEDULES_TYPE struct kv_task_schedules
551#define _KV_KEY_SECURE_STORAGE_RESERVED_TYPE struct kv_secure_storage_reserved
556#define KV_REFLECT_NUM ( \
557 IF_ENABLED(CONFIG_KV_STORE_KEY_BLUETOOTH_ADDR, \
559 IF_ENABLED(CONFIG_KV_STORE_KEY_EXFAT_DISK_INFO, \
561 IF_ENABLED(CONFIG_KV_STORE_KEY_BLUETOOTH_CTLR_VERSION, \
563 IF_ENABLED(CONFIG_KV_STORE_KEY_DEVICE_NAME, \
565 IF_ENABLED(CONFIG_KV_STORE_KEY_FIXED_LOCATION, \
567 IF_ENABLED(CONFIG_KV_STORE_KEY_WIFI_SSID, \
569 IF_ENABLED(CONFIG_KV_STORE_KEY_WIFI_PSK, \
571 IF_ENABLED(CONFIG_KV_STORE_KEY_WIFI_CHANNELS, \
573 IF_ENABLED(CONFIG_KV_STORE_KEY_NTP_SERVER_URL, \
575 IF_ENABLED(CONFIG_KV_STORE_KEY_EPACKET_UDP_URL, \
577 IF_ENABLED(CONFIG_KV_STORE_KEY_EPACKET_UDP_PORT, \
579 IF_ENABLED(CONFIG_KV_STORE_KEY_LTE_MODEM_MODEL, \
581 IF_ENABLED(CONFIG_KV_STORE_KEY_LTE_MODEM_FIRMWARE_REVISION, \
583 IF_ENABLED(CONFIG_KV_STORE_KEY_LTE_MODEM_ESN, \
585 IF_ENABLED(CONFIG_KV_STORE_KEY_LTE_MODEM_IMEI, \
587 IF_ENABLED(CONFIG_KV_STORE_KEY_LTE_SIM_UICC, \
589 IF_ENABLED(CONFIG_KV_STORE_KEY_LTE_PDP_CONFIG, \
591 IF_ENABLED(CONFIG_KV_STORE_KEY_LTE_NETWORKING_MODES, \
593 IF_ENABLED(CONFIG_KV_STORE_KEY_LTE_SIM_IMSI, \
595 IF_ENABLED(CONFIG_KV_STORE_KEY_BLUETOOTH_PEER, \
597 IF_ENABLED(CONFIG_KV_STORE_KEY_LORA_CONFIG, \
599 IF_ENABLED(CONFIG_KV_STORE_KEY_BLUETOOTH_THROUGHPUT_LIMIT, \
601 IF_ENABLED(CONFIG_KV_STORE_KEY_GRAVITY_REFERENCE, \
603 IF_ENABLED(CONFIG_KV_STORE_KEY_GEOFENCE, \
604 (CONFIG_KV_STORE_KEY_GEOFENCE_RANGE +)) \
605 IF_ENABLED(CONFIG_KV_STORE_KEY_TASK_SCHEDULES_DEFAULT_ID, \
607 IF_ENABLED(CONFIG_KV_STORE_KEY_TASK_SCHEDULES, \
608 (CONFIG_KV_STORE_KEY_TASK_SCHEDULES_RANGE +)) \
613#define KV_KEY_TYPE(key) _##key##_TYPE
615#define _KV_KEY_TYPE_VAR_EXEC(macro, num) macro(num)
618#define KV_KEY_TYPE_VAR(key, num) _KV_KEY_TYPE_VAR_EXEC(_##key##_VAR, num)
621#define KV_STRING_CONST(name, val) KV_STRUCT_KV_STRING_VAR(sizeof(val)) name = {sizeof(val), val};
643#ifdef _KV_SLOTS_ARRAY_DEFINE
645#ifdef CONFIG_KV_STORE_KEY_REBOOTS
652#ifdef CONFIG_KV_STORE_KEY_BLUETOOTH_ADDR
659#ifdef CONFIG_KV_STORE_KEY_EXFAT_DISK_INFO
666#ifdef CONFIG_KV_STORE_KEY_BLUETOOTH_CTLR_VERSION
673#ifdef CONFIG_KV_STORE_KEY_DEVICE_NAME
680#ifdef CONFIG_KV_STORE_KEY_INFUSE_APPLICATION_ID
687#ifdef CONFIG_KV_STORE_KEY_FIXED_LOCATION
694#ifdef CONFIG_KV_STORE_KEY_WIFI_SSID
701#ifdef CONFIG_KV_STORE_KEY_WIFI_PSK
708#ifdef CONFIG_KV_STORE_KEY_WIFI_CHANNELS
715#ifdef CONFIG_KV_STORE_KEY_NTP_SERVER_URL
722#ifdef CONFIG_KV_STORE_KEY_EPACKET_UDP_URL
729#ifdef CONFIG_KV_STORE_KEY_EPACKET_UDP_PORT
736#ifdef CONFIG_KV_STORE_KEY_LTE_MODEM_MODEL
743#ifdef CONFIG_KV_STORE_KEY_LTE_MODEM_FIRMWARE_REVISION
750#ifdef CONFIG_KV_STORE_KEY_LTE_MODEM_ESN
757#ifdef CONFIG_KV_STORE_KEY_LTE_MODEM_IMEI
764#ifdef CONFIG_KV_STORE_KEY_LTE_SIM_UICC
771#ifdef CONFIG_KV_STORE_KEY_LTE_PDP_CONFIG
778#ifdef CONFIG_KV_STORE_KEY_LTE_NETWORKING_MODES
785#ifdef CONFIG_KV_STORE_KEY_LTE_SIM_IMSI
792#ifdef CONFIG_KV_STORE_KEY_BLUETOOTH_PEER
799#ifdef CONFIG_KV_STORE_KEY_LORA_CONFIG
806#ifdef CONFIG_KV_STORE_KEY_BLUETOOTH_THROUGHPUT_LIMIT
813#ifdef CONFIG_KV_STORE_KEY_GRAVITY_REFERENCE
820#ifdef CONFIG_KV_STORE_KEY_GEOFENCE
823 .range = CONFIG_KV_STORE_KEY_GEOFENCE_RANGE,
827#ifdef CONFIG_KV_STORE_KEY_TASK_SCHEDULES_DEFAULT_ID
834#ifdef CONFIG_KV_STORE_KEY_TASK_SCHEDULES
837 .range = CONFIG_KV_STORE_KEY_TASK_SCHEDULES_RANGE,
841#ifdef CONFIG_KV_STORE_KEY_SECURE_STORAGE_RESERVED
844 .range = CONFIG_KV_STORE_KEY_SECURE_STORAGE_RESERVED_RANGE,
kv_slot_flags
Flags that can be applied to a slot.
Definition kv_types.h:624
kv_builtin_id
Definition kv_types.h:420
kv_builtin_size
Size of builtin KV definitions.
Definition kv_types.h:503
@ KV_FLAGS_REFLECT
KV reflection enabled for the slot.
Definition kv_types.h:626
@ KV_FLAGS_READ_ONLY
Value can not be written by external actors.
Definition kv_types.h:630
@ KV_FLAGS_WRITE_ONLY
Value can not be read by external actors.
Definition kv_types.h:628
@ KV_KEY_BLUETOOTH_THROUGHPUT_LIMIT
Request connected Bluetooth peers to limit throughtput.
Definition kv_types.h:468
@ KV_KEY_LTE_MODEM_MODEL
Modem model as returned by AT+CGMM.
Definition kv_types.h:448
@ KV_KEY_NTP_SERVER_URL
URL of the NTP server to use for time synchronisation.
Definition kv_types.h:442
@ KV_KEY_LTE_SIM_IMSI
'International Modem Subscriber Identity' as returned by AT+CIMI
Definition kv_types.h:462
@ KV_KEY_BLUETOOTH_PEER
Bluetooth peer device.
Definition kv_types.h:464
@ KV_KEY_BUILTIN_END
End of builtin KV range.
Definition kv_types.h:499
@ KV_KEY_WIFI_CHANNELS
WiFi band and channel configuration.
Definition kv_types.h:440
@ KV_KEY_INFUSE_APPLICATION_ID
CONFIG_INFUSE_APPLICATION_ID, store will be reset if the values don't match.
Definition kv_types.h:432
@ KV_KEY_GEOFENCE
Array of points defining a closed polygon.
Definition kv_types.h:472
@ KV_KEY_EXFAT_DISK_INFO
exFAT disk information
Definition kv_types.h:426
@ KV_KEY_LTE_MODEM_FIRMWARE_REVISION
Modem firmware revision as returned by AT+CGMR.
Definition kv_types.h:450
@ KV_KEY_TASK_SCHEDULES_MAX
Maximum number of KV_KEY_TASK_SCHEDULES slots that can be enabled.
Definition kv_types.h:488
@ KV_KEY_FIXED_LOCATION
Fixed global location of the device.
Definition kv_types.h:434
@ KV_KEY_REBOOTS
Number of times device has rebooted.
Definition kv_types.h:422
@ KV_KEY_DEVICE_NAME
Personalised name for the device.
Definition kv_types.h:430
@ KV_KEY_BLUETOOTH_CTLR_VERSION
External Bluetooth controller version.
Definition kv_types.h:428
@ KV_KEY_WIFI_SSID
WiFi network name.
Definition kv_types.h:436
@ KV_KEY_EPACKET_UDP_URL
ePacket UDP server hostname
Definition kv_types.h:444
@ KV_KEY_LTE_PDP_CONFIG
Packet Data Protocol (PDP) default context configuration.
Definition kv_types.h:458
@ KV_KEY_SECURE_STORAGE_RESERVED_MAX
Maximum number of KV_KEY_SECURE_STORAGE_RESERVED slots that can be enabled.
Definition kv_types.h:497
@ KV_KEY_GEOFENCE_MAX
Maximum number of KV_KEY_GEOFENCE slots that can be enabled.
Definition kv_types.h:478
@ KV_KEY_LORA_CONFIG
LoRa modem configuration.
Definition kv_types.h:466
@ KV_KEY_LTE_MODEM_ESN
'Electronic Serial Number' as returned by AT+CGSN=0
Definition kv_types.h:452
@ KV_KEY_BLUETOOTH_ADDR
Bluetooth advertising address.
Definition kv_types.h:424
@ KV_KEY_LTE_SIM_UICC
SIM Universal Identifier (https://www.itu.int/en/ITU-T/inr/forms/Pages/iin.aspx)
Definition kv_types.h:456
@ KV_KEY_GRAVITY_REFERENCE
Reference gravity vector for tilt calculations.
Definition kv_types.h:470
@ KV_KEY_LTE_NETWORKING_MODES
Enabled LTE networking modes and preferences.
Definition kv_types.h:460
@ KV_KEY_WIFI_PSK
WiFi network password.
Definition kv_types.h:438
@ KV_KEY_TASK_SCHEDULES
Task runner task schedule definition (task_schedule)
Definition kv_types.h:482
@ KV_KEY_SECURE_STORAGE_RESERVED
Keys reserved for secure storage (do not enable)
Definition kv_types.h:490
@ KV_KEY_EPACKET_UDP_PORT
ePacket UDP server port
Definition kv_types.h:446
@ KV_KEY_LTE_MODEM_IMEI
'International Modem Equiment Identifier' as returned by AT+CGSN=1
Definition kv_types.h:454
@ KV_KEY_TASK_SCHEDULES_DEFAULT_ID
Unique identifier for default schedule set.
Definition kv_types.h:480
Bluetooth address type (bt_addr_le_t)
Definition kv_types.h:38
uint8_t type
Definition kv_types.h:39
uint8_t val[6]
Definition kv_types.h:40
Geographic Co-ordinate System location.
Definition kv_types.h:31
int32_t latitude
Definition kv_types.h:32
int32_t height
Definition kv_types.h:34
int32_t longitude
Definition kv_types.h:33
Key value slot description.
Definition kv_types.h:634
uint16_t key
Base key ID for slot.
Definition kv_types.h:636
uint8_t range
Number of IDs used by the slot.
Definition kv_types.h:638
uint8_t flags
Bitmask of kv_slot_flags for slot.
Definition kv_types.h:640
Bluetooth advertising address.
Definition kv_types.h:88
struct bt_addr_le address
Broadcasting address.
Definition kv_types.h:90
External Bluetooth controller version.
Definition kv_types.h:102
uint32_t application
Application ID.
Definition kv_types.h:104
struct kv_mcuboot_img_sem_ver version
Application version number.
Definition kv_types.h:106
Bluetooth peer device.
Definition kv_types.h:307
struct bt_addr_le address
Peer device Bluetooth address.
Definition kv_types.h:309
Request connected Bluetooth peers to limit throughtput.
Definition kv_types.h:331
uint16_t limit_kbps
Requested throughput limit (kbps)
Definition kv_types.h:333
Personalised name for the device.
Definition kv_types.h:110
struct kv_string name
Personalised device name.
Definition kv_types.h:112
ePacket UDP server port
Definition kv_types.h:208
uint32_t port
UDP server port.
Definition kv_types.h:210
ePacket UDP server hostname
Definition kv_types.h:194
struct kv_string server
UDP server hostname.
Definition kv_types.h:196
exFAT disk information
Definition kv_types.h:94
uint32_t block_size
Disk block size.
Definition kv_types.h:98
uint32_t block_count
Disk block count.
Definition kv_types.h:96
Fixed global location of the device.
Definition kv_types.h:129
struct gcs_location location
Location.
Definition kv_types.h:131
Array of points defining a closed polygon.
Definition kv_types.h:347
uint8_t points_num
Points in geofence.
Definition kv_types.h:349
struct gcs_location points[]
Definition kv_types.h:350
Reference gravity vector for tilt calculations.
Definition kv_types.h:337
int16_t y
Y axis component of gravity vector.
Definition kv_types.h:341
int16_t z
Z axis component of gravity vector.
Definition kv_types.h:343
int16_t x
X axis component of gravity vector.
Definition kv_types.h:339
CONFIG_INFUSE_APPLICATION_ID, store will be reset if the values don't match.
Definition kv_types.h:124
uint32_t application_id
Definition kv_types.h:125
LoRa modem configuration.
Definition kv_types.h:313
uint8_t bandwidth
Signal bandwidth (see enum lora_signal_bandwidth)
Definition kv_types.h:317
uint16_t preamble_len
Preamble length.
Definition kv_types.h:323
uint32_t frequency
Frequency (Hz)
Definition kv_types.h:315
int8_t tx_power
Transmit power (dBm)
Definition kv_types.h:325
uint8_t sync_word
Custom sync word.
Definition kv_types.h:327
uint8_t spreading_factor
Spreading factor (see enum lora_datarate)
Definition kv_types.h:319
uint8_t coding_rate
Coding rate (see enum lora_coding_rate)
Definition kv_types.h:321
'Electronic Serial Number' as returned by AT+CGSN=0
Definition kv_types.h:242
struct kv_string esn
ESN or IMEI if not available.
Definition kv_types.h:244
Modem firmware revision as returned by AT+CGMR.
Definition kv_types.h:228
struct kv_string revision
Firmware revision.
Definition kv_types.h:230
'International Modem Equiment Identifier' as returned by AT+CGSN=1
Definition kv_types.h:256
uint64_t imei
15 digit IMEI
Definition kv_types.h:258
Modem model as returned by AT+CGMM.
Definition kv_types.h:214
struct kv_string model
Modem model.
Definition kv_types.h:216
Enabled LTE networking modes and preferences.
Definition kv_types.h:293
uint8_t modes
Enabled modes as per enum lte_lc_system_mode
Definition kv_types.h:295
uint8_t prefer
Preference as per enum lte_lc_system_mode_preference
Definition kv_types.h:297
Packet Data Protocol (PDP) default context configuration.
Definition kv_types.h:276
struct kv_string apn
Access Point Name.
Definition kv_types.h:280
uint8_t family
Protocol family (0 = IPv4, 1 = IPv6, 2 = IPv4v6, 3 = Non-IP)
Definition kv_types.h:278
'International Modem Subscriber Identity' as returned by AT+CIMI
Definition kv_types.h:301
uint64_t imsi
15 digit IMSI
Definition kv_types.h:303
SIM Universal Identifier (https://www.itu.int/en/ITU-T/inr/forms/Pages/iin.aspx)
Definition kv_types.h:262
struct kv_string uicc
Variable length UICC string.
Definition kv_types.h:264
MCUboot semantic versioning struct.
Definition kv_types.h:59
uint32_t build_num
Definition kv_types.h:63
uint8_t major
Definition kv_types.h:60
uint8_t minor
Definition kv_types.h:61
uint16_t revision
Definition kv_types.h:62
URL of the NTP server to use for time synchronisation.
Definition kv_types.h:180
struct kv_string url
NTP server URL.
Definition kv_types.h:182
Generic range structure.
Definition kv_types.h:67
uint8_t lower
Definition kv_types.h:68
uint8_t upper
Definition kv_types.h:69
Number of times device has rebooted.
Definition kv_types.h:83
uint32_t count
Definition kv_types.h:84
Keys reserved for secure storage (do not enable)
Definition kv_types.h:404
uint8_t data_num
Opaque data.
Definition kv_types.h:406
uint8_t data[]
Definition kv_types.h:407
String type.
Definition kv_types.h:44
char value[]
Definition kv_types.h:46
uint8_t value_num
Definition kv_types.h:45
Unique identifier for default schedule set.
Definition kv_types.h:363
uint32_t set_id
If this value changes, existing schedules are overwritten.
Definition kv_types.h:365
Task runner task schedule definition (task_schedule)
Definition kv_types.h:369
struct kv_range_u8 battery_terminate
Battery charge thresholds to terminate the task.
Definition kv_types.h:381
struct kv_range_u8 battery_start
Battery charge thresholds to start the task.
Definition kv_types.h:379
uint8_t validity
TASK_VALID_* value.
Definition kv_types.h:373
uint8_t task_id
Task ID referenced by schedule.
Definition kv_types.h:371
uint32_t periodicity
Periodicity values.
Definition kv_types.h:383
uint8_t periodicity_type
TASK_PERIODICITY_* value.
Definition kv_types.h:375
uint32_t timeout_s
Duration after which task is requested to terminate.
Definition kv_types.h:377
WiFi band and channel configuration.
Definition kv_types.h:163
uint8_t band
WiFi frequency band (0 = 2.4Ghz, 1 = 5GHz, 2 = 6Ghz, other = Unknown)
Definition kv_types.h:165
uint8_t channels[]
WiFi channels network uses.
Definition kv_types.h:167
WiFi network password.
Definition kv_types.h:149
struct kv_string psk
WiFi pre-shared-key.
Definition kv_types.h:151
WiFi network name.
Definition kv_types.h:135
struct kv_string ssid
WiFi network name.
Definition kv_types.h:137