network_prov_mgr.h

Go to the documentation of this file.

/*
 * Network provisioning manager for Zephyr (Wi-Fi over BLE).
 *
 * Implements the Espressif "network provisioning" wire protocol so that the
 * stock ESP BLE Provisioning apps (Android/iOS) can configure a Zephyr
 * device's Wi-Fi credentials over a secure protocomm session.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef NETWORK_PROVISIONING_NETWORK_PROV_MGR_H_
#define NETWORK_PROVISIONING_NETWORK_PROV_MGR_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum network_prov_security {
    NETWORK_PROV_SECURITY_0 = 0,
    NETWORK_PROV_SECURITY_1 = 1,
};
 
enum network_prov_cb_event {
    NETWORK_PROV_INIT,         
    NETWORK_PROV_START,        
    NETWORK_PROV_CRED_RECV,    
    NETWORK_PROV_CRED_FAIL,    
    NETWORK_PROV_CRED_SUCCESS, 
    NETWORK_PROV_END,          
    NETWORK_PROV_DEINIT,       
};
 
enum network_prov_cred_fail_reason {
    NETWORK_PROV_WIFI_AUTH_ERROR,        
    NETWORK_PROV_WIFI_NETWORK_NOT_FOUND, 
};
 
typedef void (*network_prov_cb_t)(void *user_data,
                  enum network_prov_cb_event event,
                  void *event_data);
 
struct network_prov_event_handler {
    network_prov_cb_t event_cb;
    void *user_data;
};
 
struct protocomm; /* forward declaration — the scheme vtable only needs a pointer */
 
struct network_prov_scheme {
    int (*start)(struct protocomm *pc, const char *service_name,
             const char *service_key);
    void (*stop)(void);
};
 
struct network_prov_mgr_config {
    const struct network_prov_scheme *scheme;
    struct network_prov_event_handler app_event_handler;
    uint32_t wifi_conn_attempts;
};
 
int network_prov_mgr_init(struct network_prov_mgr_config config);
 
void network_prov_mgr_deinit(void);
 
typedef int (*network_prov_endpoint_handler_t)(void *user_ctx,
                           const uint8_t *inbuf, size_t inlen,
                           uint8_t **outbuf, size_t *outlen);
 
int network_prov_mgr_endpoint_create(const char *ep_name);
 
int network_prov_mgr_endpoint_register(const char *ep_name,
                       network_prov_endpoint_handler_t handler,
                       void *user_ctx);
 
int network_prov_mgr_endpoint_unregister(const char *ep_name);
 
int network_prov_mgr_set_app_info(const char *label, const char *version,
                  const char *const *capabilities,
                  size_t capabilities_count);
 
int network_prov_mgr_is_provisioned(bool *provisioned);
 
int network_prov_mgr_start_provisioning(enum network_prov_security security,
                    const char *pop,
                    const char *service_name,
                    const char *service_key);
 
void network_prov_mgr_stop_provisioning(void);
 
int network_prov_mgr_disable_auto_stop(uint32_t cleanup_delay_ms);
 
bool network_prov_mgr_is_sm_idle(void);
 
int network_prov_mgr_reset_wifi_sm_state_on_failure(void);
 
int network_prov_mgr_reset_wifi_sm_state_for_reprovision(void);
 
int network_prov_mgr_configure_wifi_sta(const char *ssid, const char *psk);
 
int network_prov_mgr_get_wifi_remaining_conn_attempts(uint32_t *attempts_remaining);
 
void network_prov_mgr_wait(void);
 
int network_prov_mgr_reset_wifi_provisioning(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NETWORK_PROVISIONING_NETWORK_PROV_MGR_H_ */