TDF Structure Definitions

Built-in TDF Structure Definitions . More...

Data Structures
struct	tdf_announce
	Common announcement packet. More...
struct	tdf_battery_state
	General battery state. More...
struct	tdf_ambient_temp_pres_hum
	Ambient temperature, pressure & humidity. More...
struct	tdf_ambient_temperature
	Ambient temperature. More...
struct	tdf_time_sync
	Time synchronised to new source. More...
struct	tdf_reboot_info
	Information pertaining to the previous reboot. More...
struct	tdf_acc_2g
	Accelerometer +-2G. More...
struct	tdf_acc_4g
	Accelerometer +-4G. More...
struct	tdf_acc_8g
	Accelerometer +-8G. More...
struct	tdf_acc_16g
	Accelerometer +-16G. More...
struct	tdf_gyr_125dps
	Gyroscope +-125 DPS. More...
struct	tdf_gyr_250dps
	Gyroscope +-250 DPS. More...
struct	tdf_gyr_500dps
	Gyroscope +-500 DPS. More...
struct	tdf_gyr_1000dps
	Gyroscope +-1000 DPS. More...
struct	tdf_gyr_2000dps
	Gyroscope +-2000 DPS. More...
struct	tdf_gcs_wgs84_llha
	Geo-location (WGS-84) + accuracy. More...
struct	tdf_ubx_nav_pvt
	u-blox GNSS NAV-PVT message More...
struct	tdf_lte_conn_status
	Information on service cell and registration status. More...
struct	tdf_globalstar_pkt
	9 byte payload transmitted over the Globalstar Simplex network More...
struct	tdf_acc_magnitude_std_dev
	Accelerometer magnitude standard deviation over a window. More...
struct	tdf_activity_metric
	Generic activity metric. More...
struct	tdf_algorithm_output
	Instantaneous algorithm output. More...
struct	tdf_runtime_error
	Runtime error logging. More...
struct	tdf_charger_en_control
	Battery charging enable state. More...
struct	tdf_gnss_fix_info
	Metadata about a GNSS location fix. More...
struct	tdf_bluetooth_connection
	Bluetooth connection state change. More...
struct	tdf_bluetooth_rssi
	Received signal strength of Bluetooth device. More...
struct	tdf_bluetooth_data_throughput
	Data throughput of Bluetooth link. More...
struct	tdf_algorithm_class_histogram
	Algorithm output class histogram over a time window. More...
struct	tdf_algorithm_class_time_series
	Algorithm output class time series vector. More...
struct	tdf_lte_tac_cells
	Information on cells in a tracking area. More...
struct	tdf_wifi_ap_info
	Wi-Fi access point information. More...
struct	tdf_device_tilt
	Tilt angle of the device. More...
struct	tdf_nrf9x_gnss_pvt
	nRF9x GNSS PVT data frame More...
struct	tdf_battery_charge_accumulated
	Battery charge accumulated over time (+ve entering battery, -ve exiting battery) More...
struct	tdf_infuse_bluetooth_rssi
	Received signal strength of Infuse-IoT Bluetooth device. More...
struct	tdf_adc_raw_8
	Generic 8bit raw ADC reading. More...
struct	tdf_adc_raw_16
	Generic 16bit raw ADC reading. More...
struct	tdf_adc_raw_32
	Generic 32bit raw ADC reading. More...
struct	tdf_annotation
	Generic event annotation. More...
struct	tdf_lora_rx
	Received LoRa packet. More...
struct	tdf_idx_array_freq
	Sample frequency metadata for a TDF_DATA_FORMAT_IDX_ARRAY array. More...
struct	tdf_idx_array_period
	Sample frequency metadata for a TDF_DATA_FORMAT_IDX_ARRAY array. More...
struct	tdf_wifi_connected
	WiFi network is now connected. More...
struct	tdf_wifi_connection_failed
	Failed to connect to a WiFi network. More...
struct	tdf_wifi_disconnected
	Wi-Fi network is now disconnected. More...
struct	tdf_network_scan_count
	Counts associated with scanning Wi-Fi and LTE networks. More...
struct	tdf_battery_voltage
	Battery voltage. More...
struct	tdf_battery_soc
	Battery state of charge. More...

Macros
#define	TDF_ALGORITHM_OUTPUT_VAR(_name, _count)
	Define a variant of tdf_algorithm_output with a constant length.
#define	TDF_ALGORITHM_CLASS_HISTOGRAM_VAR(_name, _count)
	Define a variant of tdf_algorithm_class_histogram with a constant length.
#define	TDF_ALGORITHM_CLASS_TIME_SERIES_VAR(_name, _count)
	Define a variant of tdf_algorithm_class_time_series with a constant length.
#define	TDF_LTE_TAC_CELLS_VAR(_name, _count)
	Define a variant of tdf_lte_tac_cells with a constant length.
#define	TDF_ANNOTATION_VAR(_name, _count)
	Define a variant of tdf_annotation with a constant length.
#define	TDF_LORA_RX_VAR(_name, _count)
	Define a variant of tdf_lora_rx with a constant length.
#define	TDF_LORA_TX_VAR(_name, _count)
	Define a variant of tdf_lora_tx with a constant length.
#define	TDF_EXCEPTION_STACK_FRAME_VAR(_name, _count)
	Define a variant of tdf_exception_stack_frame with a constant length.

Enumerations
enum	tdf_builtin_id {   TDF_ANNOUNCE = 1 , TDF_BATTERY_STATE = 2 , TDF_AMBIENT_TEMP_PRES_HUM = 3 , TDF_AMBIENT_TEMPERATURE = 4 ,   TDF_TIME_SYNC = 5 , TDF_REBOOT_INFO = 6 , TDF_ACC_2G = 10 , TDF_ACC_4G = 11 ,   TDF_ACC_8G = 12 , TDF_ACC_16G = 13 , TDF_GYR_125DPS = 14 , TDF_GYR_250DPS = 15 ,   TDF_GYR_500DPS = 16 , TDF_GYR_1000DPS = 17 , TDF_GYR_2000DPS = 18 , TDF_GCS_WGS84_LLHA = 19 ,   TDF_UBX_NAV_PVT = 20 , TDF_LTE_CONN_STATUS = 21 , TDF_GLOBALSTAR_PKT = 22 , TDF_ACC_MAGNITUDE_STD_DEV = 23 ,   TDF_ACTIVITY_METRIC = 24 , TDF_ALGORITHM_OUTPUT = 25 , TDF_RUNTIME_ERROR = 26 , TDF_CHARGER_EN_CONTROL = 27 ,   TDF_GNSS_FIX_INFO = 28 , TDF_BLUETOOTH_CONNECTION = 29 , TDF_BLUETOOTH_RSSI = 30 , TDF_BLUETOOTH_DATA_THROUGHPUT = 31 ,   TDF_ALGORITHM_CLASS_HISTOGRAM = 32 , TDF_ALGORITHM_CLASS_TIME_SERIES = 33 , TDF_LTE_TAC_CELLS = 34 , TDF_WIFI_AP_INFO = 35 ,   TDF_DEVICE_TILT = 36 , TDF_NRF9X_GNSS_PVT = 37 , TDF_BATTERY_CHARGE_ACCUMULATED = 38 , TDF_INFUSE_BLUETOOTH_RSSI = 39 ,   TDF_ADC_RAW_8 = 40 , TDF_ADC_RAW_16 = 41 , TDF_ADC_RAW_32 = 42 , TDF_ANNOTATION = 43 ,   TDF_LORA_RX = 44 , TDF_LORA_TX = 45 , TDF_IDX_ARRAY_FREQ = 46 , TDF_IDX_ARRAY_PERIOD = 47 ,   TDF_WIFI_CONNECTED = 48 , TDF_WIFI_CONNECTION_FAILED = 49 , TDF_WIFI_DISCONNECTED = 50 , TDF_NETWORK_SCAN_COUNT = 51 ,   TDF_EXCEPTION_STACK_FRAME = 52 , TDF_BATTERY_VOLTAGE = 53 , TDF_BATTERY_SOC = 54 , TDF_BUILTIN_END = 1024 }
	Infuse-IoT builtin TDF definitions. More...

Detailed Description

Built-in TDF Structure Definitions .

Macro Definition Documentation

TDF_ALGORITHM_CLASS_HISTOGRAM_VAR

#define TDF_ALGORITHM_CLASS_HISTOGRAM_VAR	(		_name,
			_count )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Value:

        struct _name {                                                                             \
                uint32_t algorithm_id;                                                             \
                uint16_t algorithm_version;                                                        \
                uint8_t classes[_count];                                                           \
        } __packed;

Define a variant of tdf_algorithm_class_histogram with a constant length.

TDF_ALGORITHM_CLASS_TIME_SERIES_VAR

#define TDF_ALGORITHM_CLASS_TIME_SERIES_VAR	(		_name,
			_count )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Value:

        struct _name {                                                                             \
                uint32_t algorithm_id;                                                             \
                uint16_t algorithm_version;                                                        \
                uint8_t values[_count];                                                            \
        } __packed;

Define a variant of tdf_algorithm_class_time_series with a constant length.

TDF_ALGORITHM_OUTPUT_VAR

#define TDF_ALGORITHM_OUTPUT_VAR	(		_name,
			_count )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Value:

        struct _name {                                                                             \
                uint32_t algorithm_id;                                                             \
                uint16_t algorithm_version;                                                        \
                uint8_t output[_count];                                                            \
        } __packed;

Define a variant of tdf_algorithm_output with a constant length.

TDF_ANNOTATION_VAR

#define TDF_ANNOTATION_VAR	(		_name,
			_count )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Value:

        struct _name {                                                                             \
                uint32_t timestamp;                                                                \
                char event[_count];                                                                \
        } __packed;

Define a variant of tdf_annotation with a constant length.

TDF_EXCEPTION_STACK_FRAME_VAR

#define TDF_EXCEPTION_STACK_FRAME_VAR	(		_name,
			_count )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Value:

        struct _name {                                                                             \
                uint32_t frame[_count];                                                            \
        } __packed;

Define a variant of tdf_exception_stack_frame with a constant length.

TDF_LORA_RX_VAR

#define TDF_LORA_RX_VAR	(		_name,
			_count )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Value:

        struct _name {                                                                             \
                int8_t snr;                                                                        \
                int16_t rssi;                                                                      \
                uint8_t payload[_count];                                                           \
        } __packed;

Define a variant of tdf_lora_rx with a constant length.

TDF_LORA_TX_VAR

#define TDF_LORA_TX_VAR	(		_name,
			_count )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Value:

        struct _name {                                                                             \
                uint8_t payload[_count];                                                           \
        } __packed;

Define a variant of tdf_lora_tx with a constant length.

TDF_LTE_TAC_CELLS_VAR

#define TDF_LTE_TAC_CELLS_VAR	(		_name,
			_count )

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Value:

        struct _name {                                                                             \
                struct tdf_struct_lte_cell_id_global cell;                                         \
                uint32_t earfcn;                                                                   \
                uint8_t rsrp;                                                                      \
                int8_t rsrq;                                                                       \
                struct tdf_struct_lte_cell_neighbour neighbours[_count];                           \
        } __packed;

Define a variant of tdf_lte_tac_cells with a constant length.

Enumeration Type Documentation

tdf_builtin_id

enum tdf_builtin_id

#include </__w/infuse-sdk/infuse-sdk/infuse-sdk/generated/include/infuse/tdf/definitions.h>

Infuse-IoT builtin TDF definitions.

Enumerator
TDF_ANNOUNCE	Common announcement packet.
TDF_BATTERY_STATE	General battery state.
TDF_AMBIENT_TEMP_PRES_HUM	Ambient temperature, pressure & humidity.
TDF_AMBIENT_TEMPERATURE	Ambient temperature.
TDF_TIME_SYNC	Time synchronised to new source.
TDF_REBOOT_INFO	Information pertaining to the previous reboot.
TDF_ACC_2G	Accelerometer +-2G.
TDF_ACC_4G	Accelerometer +-4G.
TDF_ACC_8G	Accelerometer +-8G.
TDF_ACC_16G	Accelerometer +-16G.
TDF_GYR_125DPS	Gyroscope +-125 DPS.
TDF_GYR_250DPS	Gyroscope +-250 DPS.
TDF_GYR_500DPS	Gyroscope +-500 DPS.
TDF_GYR_1000DPS	Gyroscope +-1000 DPS.
TDF_GYR_2000DPS	Gyroscope +-2000 DPS.
TDF_GCS_WGS84_LLHA	Geo-location (WGS-84) + accuracy.
TDF_UBX_NAV_PVT	u-blox GNSS NAV-PVT message
TDF_LTE_CONN_STATUS	Information on service cell and registration status.
TDF_GLOBALSTAR_PKT	9 byte payload transmitted over the Globalstar Simplex network
TDF_ACC_MAGNITUDE_STD_DEV	Accelerometer magnitude standard deviation over a window.
TDF_ACTIVITY_METRIC	Generic activity metric.
TDF_ALGORITHM_OUTPUT	Instantaneous algorithm output.
TDF_RUNTIME_ERROR	Runtime error logging.
TDF_CHARGER_EN_CONTROL	Battery charging enable state.
TDF_GNSS_FIX_INFO	Metadata about a GNSS location fix.
TDF_BLUETOOTH_CONNECTION	Bluetooth connection state change.
TDF_BLUETOOTH_RSSI	Received signal strength of Bluetooth device.
TDF_BLUETOOTH_DATA_THROUGHPUT	Data throughput of Bluetooth link.
TDF_ALGORITHM_CLASS_HISTOGRAM	Algorithm output class histogram over a time window.
TDF_ALGORITHM_CLASS_TIME_SERIES	Algorithm output class time series vector.
TDF_LTE_TAC_CELLS	Information on cells in a tracking area.
TDF_WIFI_AP_INFO	Wi-Fi access point information.
TDF_DEVICE_TILT	Tilt angle of the device.
TDF_NRF9X_GNSS_PVT	nRF9x GNSS PVT data frame
TDF_BATTERY_CHARGE_ACCUMULATED	Battery charge accumulated over time (+ve entering battery, -ve exiting battery)
TDF_INFUSE_BLUETOOTH_RSSI	Received signal strength of Infuse-IoT Bluetooth device.
TDF_ADC_RAW_8	Generic 8bit raw ADC reading.
TDF_ADC_RAW_16	Generic 16bit raw ADC reading.
TDF_ADC_RAW_32	Generic 32bit raw ADC reading.
TDF_ANNOTATION	Generic event annotation.
TDF_LORA_RX	Received LoRa packet.
TDF_LORA_TX	Transmitted LoRa packet.
TDF_IDX_ARRAY_FREQ	Sample frequency metadata for a TDF_DATA_FORMAT_IDX_ARRAY array.
TDF_IDX_ARRAY_PERIOD	Sample frequency metadata for a TDF_DATA_FORMAT_IDX_ARRAY array.
TDF_WIFI_CONNECTED	WiFi network is now connected.
TDF_WIFI_CONNECTION_FAILED	Failed to connect to a WiFi network.
TDF_WIFI_DISCONNECTED	Wi-Fi network is now disconnected.
TDF_NETWORK_SCAN_COUNT	Counts associated with scanning Wi-Fi and LTE networks.
TDF_EXCEPTION_STACK_FRAME	Generic exception stack frame.
TDF_BATTERY_VOLTAGE	Battery voltage.
TDF_BATTERY_SOC	Battery state of charge.
TDF_BUILTIN_END	End of builtin TDF range.