nx_verified_telemetry.h

Go to the documentation of this file.

/* Copyright (c) Microsoft Corporation.
   Licensed under the MIT License. */
 
#ifndef NX_VERIFIED_TELEMETRY_H
#define NX_VERIFIED_TELEMETRY_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "nx_azure_iot_json_reader.h"
#include "nx_azure_iot_json_writer.h"
#include "nx_azure_iot_pnp_client.h"
 
/* Verified Telemetry Components */
#include "nx_vt_currentsense_component.h"
#include "nx_vt_fallcurve_component.h"
 
#define VT_SIGNATURE_TYPE_FALLCURVE    0x01
#define VT_SIGNATURE_TYPE_CURRENTSENSE 0x02
 
#define VT_MINIMUM_BUFFER_SIZE_BYTES sizeof(VT_CURRENTSENSE_RAW_SIGNATURES_READER)
 
union NX_VT_SIGNATURE_COMPONENT_UNION_TAG {
 
    /* FallCurve Component */
    NX_VT_FALLCURVE_COMPONENT fc;
 
    /* CurrentSense Component */
    NX_VT_CURRENTSENSE_COMPONENT cs;
};
 
typedef struct NX_VT_OBJECT_TAG
{
    /* Signature Object Union */
    union NX_VT_SIGNATURE_COMPONENT_UNION_TAG component;
 
    /* Signature Type */
    UINT signature_type;
 
    /* Pointer to next component */
    void* next_component;
 
} NX_VT_OBJECT;
 
typedef struct NX_VERIFIED_TELEMETRY_DB_TAG
{
    /* Name of this component */
    UCHAR component_name_ptr[VT_COMPONENT_NAME_MAX_LENGTH];
 
    UINT component_name_length;
 
    /* Pointer to first component */
    void* first_component;
 
    /* Pointer to last component */
    void* last_component;
 
    /* Number of component*/
    UINT components_num;
 
    /* Device specific implementations*/
    VT_DEVICE_DRIVER* device_driver;
 
    /* Enable Verified Telemetry*/
    bool enable_verified_telemetry;
 
    /* Device Status*/
    bool device_status;
 
    /* Device Status Property Sent*/
    bool device_status_property_sent;
 
    /* Pointer to byte buffer passed from application layer, used for fingerprint calculation/storage */
    CHAR* scratch_buffer;
 
    /* Length of byte buffer passed from application layer, used for fingerprint calculation/storage */
    UINT scratch_buffer_length;
 
} NX_VERIFIED_TELEMETRY_DB;
 
UINT nx_vt_init(NX_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);
 
UINT nx_vt_signature_init(NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB,
    NX_VT_OBJECT* handle,
    UCHAR* component_name_ptr,
    UINT signature_type,
    UCHAR* associated_telemetry,
    bool telemetry_status_auto_update,
    VT_SENSOR_HANDLE* sensor_handle);
 
UINT nx_vt_process_command(NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB,
    NX_AZURE_IOT_PNP_CLIENT* iotpnp_client_ptr,
    UCHAR* component_name_ptr,
    UINT component_name_length,
    UCHAR* pnp_command_name_ptr,
    UINT pnp_command_name_length,
    NX_AZURE_IOT_JSON_READER* json_reader_ptr,
    NX_AZURE_IOT_JSON_WRITER* json_response_ptr,
    UINT* status_code);
 
UINT nx_vt_process_property_update(NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB,
    NX_AZURE_IOT_PNP_CLIENT* iotpnp_client_ptr,
    const UCHAR* component_name_ptr,
    UINT component_name_length,
    NX_AZURE_IOT_JSON_READER* name_value_reader_ptr,
    UINT version);
 
UINT nx_vt_properties(NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB, NX_AZURE_IOT_PNP_CLIENT* iotpnp_client_ptr);
 
UINT nx_vt_send_desired_property_after_boot(
    NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB, NX_AZURE_IOT_PNP_CLIENT* iotpnp_client_ptr, UINT message_type);
 
UINT nx_vt_process_reported_property_sync(NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB,
    NX_AZURE_IOT_PNP_CLIENT* iotpnp_client_ptr,
    const UCHAR* component_name_ptr,
    UINT component_name_length,
    NX_AZURE_IOT_JSON_READER* name_value_reader_ptr,
    UINT version);
 
UINT nx_vt_verified_telemetry_message_create_send(NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB,
    NX_AZURE_IOT_PNP_CLIENT* pnp_client_ptr,
    const UCHAR* component_name_ptr,
    UINT component_name_length,
    UINT wait_option,
    const UCHAR* telemetry_data,
    UINT data_size);
 
UINT nx_vt_compute_evaluate_fingerprint_all_sensors(NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB);
 
UINT nx_vt_azure_iot_pnp_client_component_add(
    NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB, NX_AZURE_IOT_PNP_CLIENT* pnp_client_ptr);
 
UINT nx_vt_signature_read(
    NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB, UCHAR* associated_telemetry, UINT associated_telemetry_length,UINT mode);
 
UINT nx_vt_signature_process(
    NX_VERIFIED_TELEMETRY_DB* verified_telemetry_DB, UCHAR* associated_telemetry, UINT associated_telemetry_length);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NX_VERIFIED_TELEMETRY_H */