WE310F5  39.00.000
m2mb_web_prov.h File Reference

This file contains the public APIs and structures for plugin for Wi-Fi provisioning module. More...

Go to the source code of this file.

Data Structures

struct  M2MB_PROV_SSID
 SSID structure. More...
 
struct  M2MB_PROV_SEC_PSK
 PSK structure. More...
 
struct  M2MB_PROV_SEC_WEP_CONFIG
 WEP Configuration structure. More...
 
struct  M2MB_PROV_CLIENT_CONFIG
 Client Configuration structure. More...
 
struct  M2MB_PROV_IP_CONFIG
 IP Configuration structure. More...
 
struct  M2MB_PROV_AP_CONFIG
 AP Configuration structure. More...
 
struct  M2MB_PROV_NETWORK_CONFIG
 Network Configuration structure. More...
 
struct  M2MB_PROV_SYS_CONFIG_SYS_ID
 System Configuration Identifier structure. More...
 
struct  M2MB_PROV_SYS_CONFIG
 System Configuration structure. More...
 
struct  M2MB_PROV_CONFIG_S
 Provisioning Configuration structure. More...
 
#define WEB_PROV_DEBUG_PRINT(...)
 
#define M2MB_PROV_MAC_SSID_LEN   32
 
#define M2MB_PROV_MAX_DNS_DOMAIN_LEN   64
 
#define M2MB_PROV_MAX_SYS_ID_LEN   64
 
#define M2MB_PROV_NWIF_HOST_NAME_MAX_LEN   15
 
#define M2MB_PROV_SEC_PASSPHRASE_LEN   64
 
#define M2MB_PROV_SEC_MAX_WEP_KEY_LEN   M2MB_PROV_SEC_WEP104_KEY_LEN
 
#define M2MB_PROV_REG_DOMAIN_UNKNOWN_MAX_CH   14
 
#define M2MB_PROV_REG_DOMAIN_FCC_STR   "fcc"
 
#define M2MB_PROV_REG_DOMAIN_ETSI_STR   "etsi"
 
#define M2MB_PROV_REG_DOMAIN_ETSI_MEXS_STR   "etsi_mex"
 
#define M2MB_PROV_REG_DOMAIN_TELEC_STR   "telec"
 
#define M2MB_PROV_REG_DOMAIN_UNKNOWN_STR   "unknown"
 
#define M2MB_PROV_2_4_GHZ_BAND   "2.4GHz"
 
#define M2MB_PROV_5_GHZ_BAND   "5GHz"
 
#define M2MB_PROV_SECURITY_NONE_STR   "none"
 
#define M2MB_PROV_WEP_STR   "wep"
 
#define M2MB_PROV_WPA_PERSONAL_STR   "wpa-personal"
 
#define M2MB_PROV_WPA_ENTERPRISE_STR   "wpa-enterprise"
 
#define M2MB_PROV_HTTPD_MAX_USERNAME_LEN   32
 
#define M2MB_PROV_HTTPD_MAX_PASSWORD_LEN   32
 
#define M2MB_PROV_HTTPD_DEFAULT_USERNAME   "admin"
 
#define M2MB_PROV_HTTPD_DEFAULT_PASSWORD   "admin"
 
enum  M2MB_PROV_WEP_AUTH_TYPE {
  M2MB_PROV_SEC_WEP_OPEN,
  M2MB_PROV_SEC_WEP_SHARED
}
 WEP authentication type enumeration. More...
 
enum  M2MB_PROV_WEP_KEY_LEN {
  M2MB_PROV_SEC_WEP_KEY_INVLAID = 0,
  M2MB_PROV_SEC_WEP40_KEY_LEN = 5,
  M2MB_PROV_SEC_WEP104_KEY_LEN = 13
}
 WEP key length enumeration. More...
 
enum  M2MB_PROV_SEC_TYPE {
  M2MB_PROV_SEC_TYPE_NONE = 1,
  M2MB_PROV_SEC_TYPE_WEP,
  M2MB_PROV_SEC_TYPE_WPA_PERSONAL,
  M2MB_PROV_SEC_TYPE_WPA_ENTERPRISE
}
 Security type enumeration. More...
 
enum  M2MB_PROV_REG_DOMAIN {
  M2MB_PROV_REG_DOMAIN_FCC = 0,
  M2MB_PROV_REG_DOMAIN_ETSI,
  M2MB_PROV_REG_DOMAIN_TELEC,
  M2MB_PROV_REG_DOMAIN_ETSI_MEXS,
  M2MB_PROV_REG_DOMAIN_UNKNOWN
}
 Regulatory domains enumeration. More...
 
enum  M2MB_PROV_AP_MODE {
  M2MB_PROV_AP_MODE_PROV = 1,
  M2MB_PROV_AP_MODE_USER
}
 AP mode enumeration. More...
 
enum  M2MB_PROV_NETWORK_MODE {
  M2MB_PROV_NETWORK_MODE_INFRA_CLIENT = 1,
  M2MB_PROV_NETWORK_MODE_LIMITED_AP,
  M2MB_PROV_NETWORK_MODE_INFRA_CLIENT_VERIFY,
  M2MB_PROV_NETWORK_MODE_CONCURRENT
}
 Network mode enumeration. More...
 
enum  M2MB_PROV_SYS_CONFIG_OPTION {
  M2MB_PROV_SYS_CONFIG_OPTION_GET,
  M2MB_PROV_SYS_CONFIG_OPTION_SET
}
 Configuration opetions enumeration. More...
 
enum  M2MB_PROV_ENCODE_TYPE {
  M2MB_PROV_ENCODE_TYPE_XML,
  M2MB_PROV_ENCODE_TYPE_JSON
}
 Encoding types enumeration. More...
 
enum  M2MB_PROV_OBJECT_TYPE {
  M2MB_PROV_OBJECT_TYPE_NWK,
  M2MB_PROV_OBJECT_TYPE_SYSID,
  M2MB_PROV_OBJECT_TYPE_AUTH,
  M2MB_PROV_OBJECT_TYPE_VERIFIED_SUCCESS,
  M2MB_PROV_OBJECT_TYPE_VERIFIED_FAILURE,
  M2MB_PROV_OBJECT_TYPE_MAX
}
 Object types enumeration. More...
 
typedef enum M2MB_PROV_WEP_AUTH_TYPE M2MB_PROV_WEP_AUTH_TYPE_T
 WEP authentication type enumeration. More...
 
typedef enum M2MB_PROV_WEP_KEY_LEN M2MB_PROV_WEP_KEY_LEN_T
 WEP key length enumeration. More...
 
typedef enum M2MB_PROV_SEC_TYPE M2MB_PROV_SEC_TYPE_T
 Security type enumeration. More...
 
typedef enum M2MB_PROV_REG_DOMAIN M2MB_PROV_REG_DOMAIN_T
 Regulatory domains enumeration. More...
 
typedef enum M2MB_PROV_AP_MODE M2MB_PROV_AP_MODE_T
 AP mode enumeration. More...
 
typedef enum M2MB_PROV_NETWORK_MODE M2MB_PROV_NETWORK_MODE_T
 Network mode enumeration. More...
 
typedef enum M2MB_PROV_SYS_CONFIG_OPTION M2MB_PROV_SYS_CONFIG_OPTION_T
 Configuration opetions enumeration. More...
 
typedef enum M2MB_PROV_ENCODE_TYPE M2MB_PROV_ENCODE_TYPE_T
 Encoding types enumeration. More...
 
typedef enum M2MB_PROV_OBJECT_TYPE M2MB_PROV_OBJECT_TYPE_T
 Object types enumeration. More...
 
typedef struct M2MB_PROV_SSID M2MB_PROV_SSID_T
 SSID structure. More...
 
typedef struct M2MB_PROV_SEC_PSK M2MB_PROV_SEC_PSK_T
 PSK structure. More...
 
typedef struct M2MB_PROV_SEC_WEP_CONFIG M2MB_PROV_SEC_WEP_CONFIG_T
 WEP Configuration structure. More...
 
typedef struct M2MB_PROV_CLIENT_CONFIG M2MB_PROV_CLIENT_CONFIG_T
 Client Configuration structure. More...
 
typedef struct M2MB_PROV_IP_CONFIG M2MB_PROV_IP_CONFIG_T
 IP Configuration structure. More...
 
typedef struct M2MB_PROV_AP_CONFIG M2MB_PROV_AP_CONFIG_T
 AP Configuration structure. More...
 
typedef struct M2MB_PROV_NETWORK_CONFIG M2MB_PROV_NETWORK_CONFIG_T
 Network Configuration structure. More...
 
typedef struct M2MB_PROV_SYS_CONFIG_SYS_ID M2MB_PROV_SYS_CONFIG_SYS_ID_T
 System Configuration Identifier structure. More...
 
typedef struct M2MB_PROV_SYS_CONFIG M2MB_PROV_SYS_CONFIG_T
 System Configuration structure. More...
 
typedef int(* M2MB_PROV_CONFIG_CB_T) (M2MB_PROV_SYS_CONFIG_T *cfg, M2MB_PROV_SYS_CONFIG_OPTION_T option)
 Provision configuration call back prototype. More...
 
typedef struct M2MB_PROV_CONFIG_S M2MB_PROV_CONFIG_T
 Provisioning Configuration structure. More...
 
M2MB_STATUS_T m2mb_httpd_prov_start (M2MB_PROV_CONFIG_T *pProvcfg, M2MB_HTTPD_CONFIG_T *pHTTPDcfg)
 HTTP Provision Start. More...
 

Detailed Description

This file contains the public APIs and structures for plugin for Wi-Fi provisioning module.

m2mb_web_prov.h

Note
<Notes, dependencies mandatory> Dependencies: m2mb_types.h m2mb_status.h m2mb_httpd.h
Author
Sandeep Itha
Date
22/01/2018

Definition in file m2mb_web_prov.h.