azure_iot_hub_dps.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef AZURE_IOT_HUB_DPS__
#define AZURE_IOT_HUB_DPS__
 
#include <stdint.h>
#include <net/azure_iot_hub.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum azure_iot_hub_dps_reg_status {
        AZURE_IOT_HUB_DPS_REG_STATUS_NOT_STARTED,
 
        AZURE_IOT_HUB_DPS_REG_STATUS_ASSIGNING,
        AZURE_IOT_HUB_DPS_REG_STATUS_ASSIGNED,
        AZURE_IOT_HUB_DPS_REG_STATUS_FAILED,
};
 
typedef void (*azure_iot_hub_dps_handler_t)(enum azure_iot_hub_dps_reg_status status);
 
struct azure_iot_hub_dps_config {
        azure_iot_hub_dps_handler_t handler;
 
        struct azure_iot_hub_buf id_scope;
 
        struct azure_iot_hub_buf reg_id;
};
 
int azure_iot_hub_dps_init(struct azure_iot_hub_dps_config *cfg);
 
/* @brief Start Device Provisioning Service (DPS) to obtain device ID and assigmnent
 *        to an IoT hub. The information can later be used to connect to the assigned IoT hub.
 *
 * @retval 0 if successful.
 * @retval -EACCESS if the library is in the wrong state to start DPS.
 * @retval -EALREADY if DPS has already started and is ongoing.
 */
int azure_iot_hub_dps_start(void);
 
int azure_iot_hub_dps_hostname_get(struct azure_iot_hub_buf *buf);
 
int azure_iot_hub_dps_hostname_delete(void);
 
int azure_iot_hub_dps_device_id_get(struct azure_iot_hub_buf *buf);
 
int azure_iot_hub_dps_device_id_delete(void);
 
int azure_iot_hub_dps_reset(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* AZURE_IOT_HUB_DPS__ */