az_iot_adu_client.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#ifndef _az_IOT_ADU_H
#define _az_IOT_ADU_H
 
#include <azure/core/az_json.h>
#include <azure/core/az_result.h>
#include <azure/core/az_span.h>
#include <azure/iot/az_iot_hub_client.h>
#include <azure/iot/internal/az_iot_adu_internal.h>
 
#include <stdbool.h>
#include <stdint.h>
 
#include <azure/core/_az_cfg_prefix.h>
 
#define AZ_IOT_ADU_CLIENT_AGENT_MODEL_ID "dtmi:azure:iot:deviceUpdateContractModel;2"
 
#define AZ_IOT_ADU_CLIENT_AGENT_VERSION "DU;agent/1.0.0"
 
#define AZ_IOT_ADU_CLIENT_PROPERTIES_COMPONENT_NAME "deviceUpdate"
 
#define AZ_IOT_ADU_CLIENT_AGENT_DEFAULT_COMPATIBILITY_PROPERTIES "manufacturer,model"
 
typedef enum
{
  AZ_IOT_ADU_CLIENT_REQUEST_DECISION_ACCEPT = 200,
  AZ_IOT_ADU_CLIENT_REQUEST_DECISION_REJECT = 406
} az_iot_adu_client_request_decision;
 
typedef enum
{
  AZ_IOT_ADU_CLIENT_AGENT_STATE_IDLE = 0,
  AZ_IOT_ADU_CLIENT_AGENT_STATE_DEPLOYMENT_IN_PROGRESS = 6,
  AZ_IOT_ADU_CLIENT_AGENT_STATE_FAILED = 255
} az_iot_adu_client_agent_state;
 
typedef enum
{
  AZ_IOT_ADU_CLIENT_SERVICE_ACTION_APPLY_DEPLOYMENT = 3,
  AZ_IOT_ADU_CLIENT_SERVICE_ACTION_CANCEL = 255
} az_iot_adu_client_service_action;
 
typedef struct
{
  az_span provider;
  az_span name;
  az_span version;
} az_iot_adu_update_id;
 
typedef struct
{
  az_span names[_az_IOT_ADU_CLIENT_MAX_DEVICE_CUSTOM_PROPERTIES];
  az_span values[_az_IOT_ADU_CLIENT_MAX_DEVICE_CUSTOM_PROPERTIES];
  int32_t count;
} az_iot_adu_device_custom_properties;
 
typedef struct
{
  az_span manufacturer;
  az_span model;
  az_iot_adu_device_custom_properties* custom_properties;
  az_span adu_version;
  az_span delivery_optimization_agent_version;
  az_span update_id;
} az_iot_adu_client_device_properties;
 
typedef struct
{
  int32_t result_code;
  int32_t extended_result_code;
  az_span result_details;
} az_iot_adu_client_step_result;
 
typedef struct
{
  int32_t result_code;
  int32_t extended_result_code;
  az_span result_details;
  int32_t step_results_count;
  az_iot_adu_client_step_result step_results[_az_IOT_ADU_CLIENT_MAX_INSTRUCTIONS_STEPS];
} az_iot_adu_client_install_result;
 
typedef struct
{
  az_iot_adu_client_service_action action;
  az_span id;
  az_span retry_timestamp;
} az_iot_adu_client_workflow;
 
typedef struct
{
  az_span id;
  az_span url;
} az_iot_adu_client_file_url;
 
typedef struct
{
  az_iot_adu_client_workflow workflow;
  az_span update_manifest;
  az_span update_manifest_signature;
  az_iot_adu_client_file_url file_urls[_az_IOT_ADU_CLIENT_MAX_TOTAL_FILE_COUNT];
  uint32_t file_urls_count;
} az_iot_adu_client_update_request;
 
typedef struct
{
  az_span installed_criteria;
} az_iot_adu_client_update_manifest_instructions_step_handler_properties;
 
typedef struct
{
  az_span handler;
  az_span files[_az_IOT_ADU_CLIENT_MAX_FILE_COUNT_PER_STEP];
  uint32_t files_count;
  az_iot_adu_client_update_manifest_instructions_step_handler_properties handler_properties;
} az_iot_adu_client_update_manifest_instructions_step;
 
typedef struct
{
  az_iot_adu_client_update_manifest_instructions_step
      steps[_az_IOT_ADU_CLIENT_MAX_INSTRUCTIONS_STEPS];
  uint32_t steps_count;
} az_iot_adu_client_update_manifest_instructions;
 
typedef struct
{
  az_span hash_type;
  az_span hash_value;
} az_iot_adu_client_update_manifest_file_hash;
 
typedef struct
{
  az_span id;
  az_span file_name;
  int64_t size_in_bytes;
  az_iot_adu_client_update_manifest_file_hash hashes[_az_IOT_ADU_CLIENT_MAX_FILE_HASH_COUNT];
  uint32_t hashes_count;
} az_iot_adu_client_update_manifest_file;
 
typedef struct
{
  az_span manifest_version;
  az_iot_adu_update_id update_id;
  az_iot_adu_client_update_manifest_instructions instructions;
  az_iot_adu_client_update_manifest_file files[_az_IOT_ADU_CLIENT_MAX_TOTAL_FILE_COUNT];
  uint32_t files_count;
  az_span create_date_time;
} az_iot_adu_client_update_manifest;
 
typedef struct
{
  az_span device_compatibility_properties;
} az_iot_adu_client_options;
 
typedef struct
{
  struct
  {
    az_iot_adu_client_options options;
  } _internal;
} az_iot_adu_client;
 
AZ_NODISCARD az_iot_adu_client_options az_iot_adu_client_options_default();
 
AZ_NODISCARD az_iot_adu_client_device_properties az_iot_adu_client_device_properties_default();
 
AZ_NODISCARD az_result
az_iot_adu_client_init(az_iot_adu_client* client, az_iot_adu_client_options* options);
 
AZ_NODISCARD bool az_iot_adu_client_is_component_device_update(
    az_iot_adu_client* client,
    az_span component_name);
 
AZ_NODISCARD az_result az_iot_adu_client_get_agent_state_payload(
    az_iot_adu_client* client,
    az_iot_adu_client_device_properties* device_properties,
    az_iot_adu_client_agent_state agent_state,
    az_iot_adu_client_workflow* workflow,
    az_iot_adu_client_install_result* last_install_result,
    az_json_writer* ref_json_writer);
 
AZ_NODISCARD az_result az_iot_adu_client_parse_service_properties(
    az_iot_adu_client* client,
    az_json_reader* ref_json_reader,
    az_iot_adu_client_update_request* update_request);
 
AZ_NODISCARD az_result az_iot_adu_client_get_service_properties_response(
    az_iot_adu_client* client,
    int32_t version,
    az_iot_adu_client_request_decision status,
    az_json_writer* ref_json_writer);
 
AZ_NODISCARD az_result az_iot_adu_client_parse_update_manifest(
    az_iot_adu_client* client,
    az_json_reader* ref_json_reader,
    az_iot_adu_client_update_manifest* update_manifest);
 
#include <azure/core/_az_cfg_suffix.h>
 
#endif // _az_IOT_ADU_H