Verified Telemetry
|
#include "FreeRTOS_vt_fallcurve_component.h"
#include "FreeRTOS_vt_currentsense_component.h"
#include "vt_defs.h"
Go to the source code of this file.
Data Structures | |
union | FreeRTOS_VT_SIGNATURE_COMPONENT_UNION_TAG |
struct | FreeRTOS_VT_OBJECT_TAG |
struct | FreeRTOS_VERIFIED_TELEMETRY_DB_TAG |
Typedefs | |
typedef struct FreeRTOS_VT_OBJECT_TAG | FreeRTOS_VT_OBJECT |
typedef struct FreeRTOS_VERIFIED_TELEMETRY_DB_TAG | FreeRTOS_VERIFIED_TELEMETRY_DB |
Functions | |
AzureIoTResult_t | FreeRTOS_vt_init (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, UCHAR *component_name_ptr, bool enable_verified_telemetry, VT_DEVICE_DRIVER *device_driver, CHAR *scratch_buffer, UINT scratch_buffer_length) |
Initializes Global Verified Telemetry using platform specific device drivers. More... | |
AzureIoTResult_t | FreeRTOS_vt_signature_init (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, FreeRTOS_VT_OBJECT *handle, UCHAR *component_name_ptr, UINT signature_type, UCHAR *associated_telemetry, bool telemetry_status_auto_update, VT_SENSOR_HANDLE *sensor_handle) |
Initializes Verified Telemetry for a particular sensor data stream. More... | |
AzureIoTResult_t | FreeRTOS_vt_verified_telemetry_message_create_send (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, AzureIoTHubClient_t *xAzureIoTHubClient, const UCHAR *component_name_ptr, UINT component_name_length, const UCHAR *telemetry_data, UINT data_size) |
Creates and sends telemetry JSON with message properties containing telemetry status. More... | |
AzureIoTResult_t | FreeRTOS_vt_process_command (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, AzureIoTHubClient_t *xAzureIoTHubClient, UCHAR *component_name_ptr, UINT component_name_length, UCHAR *pnp_command_name_ptr, UINT pnp_command_name_length, UINT *status_code) |
Processes all commands supported by VT Middleware. More... | |
AzureIoTResult_t | FreeRTOS_vt_properties (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, AzureIoTHubClient_t *xAzureIoTHubClient) |
Updates Digital Twin with default desired property values when device is booted for the first time. More... | |
UINT | MultiCalibration_store_cs_object (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, int32_t MultiCalibrationCount) |
Processes all desired property updates supported by vT Middleware. More... | |
AzureIoTResult_t | FreeRTOS_vt_process_property_update (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, AzureIoTHubClient_t *xAzureIoTHubClient, const UCHAR *component_name_ptr, UINT component_name_length, AzureIoTJSONReader_t *xReader, UINT version) |
AzureIoTResult_t | FreeRTOS_vt_compute_evaluate_fingerprint_all_sensors (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB) |
Computes status of all telemetries which have been initialized to provide Verified Telemetry. More... | |
AzureIoTResult_t | FreeRTOS_vt_send_desired_property_after_boot (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, AzureIoTHubClient_t *xAzureIoTHubClient, UINT message_type) |
Updates Digital Twin with default desired property values when device is booted for the first time. More... | |
AzureIoTResult_t | FreeRTOS_vt_process_reported_property_sync (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, const UCHAR *component_name_ptr, UINT component_name_length, AzureIoTJSONReader_t *json_reader_ptr) |
Synchronizes VT Settings stored in digital Twin as reported properties at startup. More... | |
AzureIoTResult_t | FreeRTOS_vt_signature_read (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, UCHAR *associated_telemetry, UINT associated_telemetry_length, UINT mode) |
UINT | FreeRTOS_vt_signature_process (FreeRTOS_VERIFIED_TELEMETRY_DB *verified_telemetry_DB, UCHAR *associated_telemetry, UINT associated_telemetry_length) |
AzureIoTResult_t FreeRTOS_vt_compute_evaluate_fingerprint_all_sensors | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB | ) |
Computes status of all telemetries which have been initialized to provide Verified Telemetry.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |
AzureIoTResult_t FreeRTOS_vt_init | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB, |
UCHAR * | component_name_ptr, | ||
bool | enable_verified_telemetry, | ||
VT_DEVICE_DRIVER * | device_driver, | ||
CHAR * | scratch_buffer, | ||
UINT | scratch_buffer_length | ||
) |
Initializes Global Verified Telemetry using platform specific device drivers.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
[in] | component_name_ptr | Name of the PnP component. Example - "vTDevice" |
[in] | enable_verified_telemetry | User specified value to set Verified Telemetry active or inactive, can also be configured during runtime from a writable Digital Twin property. |
[in] | device_driver | The platform specific device driver components for interacting with the device hardware. |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |
AzureIoTResult_t FreeRTOS_vt_process_command | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB, |
AzureIoTHubClient_t * | xAzureIoTHubClient, | ||
UCHAR * | component_name_ptr, | ||
UINT | component_name_length, | ||
UCHAR * | pnp_command_name_ptr, | ||
UINT | pnp_command_name_length, | ||
UINT * | status_code | ||
) |
Processes all commands supported by VT Middleware.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
[in] | xAzureIoTHubClient | Pointer to initialized Azure IoT PnP instance. |
[in] | component_name_ptr | Name of the component. |
[in] | component_name_length | Length of name of the component. |
[in] | pnp_command_name_ptr | Name of the command invoked. |
[in] | pnp_command_name_length | Length of name of the command invoked. |
[out] | status_code | Status updated by function based on command execution. |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |
AzureIoTResult_t FreeRTOS_vt_process_reported_property_sync | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB, |
const UCHAR * | component_name_ptr, | ||
UINT | component_name_length, | ||
AzureIoTJSONReader_t * | json_reader_ptr | ||
) |
Synchronizes VT Settings stored in digital Twin as reported properties at startup.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
[in] | component_name_ptr | Name of the component. |
[in] | component_name_length | Length of name of the component. |
[in] | json_reader_ptr | Pointer to read the JSON payload of command. |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |
AzureIoTResult_t FreeRTOS_vt_properties | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB, |
AzureIoTHubClient_t * | xAzureIoTHubClient | ||
) |
Updates Digital Twin with default desired property values when device is booted for the first time.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
[in] | xAzureIoTHubClient | Pointer to initialized Azure IoT PnP instance. |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |
AzureIoTResult_t FreeRTOS_vt_send_desired_property_after_boot | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB, |
AzureIoTHubClient_t * | xAzureIoTHubClient, | ||
UINT | message_type | ||
) |
Updates Digital Twin with default desired property values when device is booted for the first time.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
[in] | xAzureIoTHubClient | Pointer to initialized Azure IoT PnP instance. |
[in] | message_type | Type of document, only valid value are NX_AZURE_IOT_PNP_DESIRED_PROPERTIES or NX_AZURE_IOT_PNP_PROPERTIES |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |
AzureIoTResult_t FreeRTOS_vt_signature_init | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB, |
FreeRTOS_VT_OBJECT * | handle, | ||
UCHAR * | component_name_ptr, | ||
UINT | signature_type, | ||
UCHAR * | associated_telemetry, | ||
bool | telemetry_status_auto_update, | ||
VT_SENSOR_HANDLE * | sensor_handle | ||
) |
Initializes Verified Telemetry for a particular sensor data stream.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
[in] | handle | Pointer to variable of type NX_VT_OBJECT storing collection settings and configuration data for a particular sensor telemetry. |
[in] | component_name_ptr | Name of the sensor. Example - "accelerometer" This would be prepended with 'vT' by VT library |
[in] | signature_type | One of the defined signature types. Currently available types - VT_SIGNATURE_TYPE_FALLCURVE |
[in] | associated_telemetry | Telmetries associated with this sensor, separated by commas Example - "accelerometerX, accelerometerY, accelerometerZ" |
[in] | telemetry_status_auto_update | User specified value to control whether fingerprint computation for the sensor should be invoked when nx_vt_compute_evaluate_fingerprint_all_sensors is called |
[in] | sensor_handle | The sensor specific connection configuration for collecting VT signatures. |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |
AzureIoTResult_t FreeRTOS_vt_verified_telemetry_message_create_send | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB, |
AzureIoTHubClient_t * | xAzureIoTHubClient, | ||
const UCHAR * | component_name_ptr, | ||
UINT | component_name_length, | ||
const UCHAR * | telemetry_data, | ||
UINT | data_size | ||
) |
Creates and sends telemetry JSON with message properties containing telemetry status.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
[in] | xAzureIoTHubClient | Pointer to initialized Azure IoT PnP instance. |
[in] | component_name_ptr | Name of the component. |
[in] | component_name_length | Length of name of the component. |
[in] | telemetry_data | Pointer to buffer containing telemetry data. |
[in] | data_size | Length of telemetry data passed in the buffer. |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |
UINT MultiCalibration_store_cs_object | ( | FreeRTOS_VERIFIED_TELEMETRY_DB * | verified_telemetry_DB, |
int32_t | MultiCalibrationCount | ||
) |
Processes all desired property updates supported by vT Middleware.
[in] | verified_telemetry_DB | Pointer to variable of type VERIFIED_TELEMETRY_DB storing Verified Telemetry data. |
[in] | xAzureIoTHubClient | Pointer to initialized Azure IoT PnP instance. |
[in] | component_name_ptr | Name of the component. |
[in] | component_name_length | Length of name of the component. |
[in] | xReader | Pointer to read the JSON payload of command. |
[in] | version | Property version stored in digital twin. |
NX_AZURE_IOT_SUCCESS | upon success or an error code upon failure. |