![]() |
WE310F5
39.00.000
|
This section describes the M2MB APIs for Web Provisioning. More...
This section describes the M2MB APIs for Web Provisioning.
To initiate web provisioning, the system must be connected to a network or should create a network to communicate with other devices. HTTP server must be started and to make it secure SSL module must be initialized. The following steps must be performed:
#define M2MB_PROV_2_4_GHZ_BAND "2.4GHz" |
2.4GHz
Definition at line 77 of file m2mb_web_prov.h.
#define M2MB_PROV_5_GHZ_BAND "5GHz" |
5 GHz
Definition at line 78 of file m2mb_web_prov.h.
#define M2MB_PROV_HTTPD_DEFAULT_PASSWORD "admin" |
Default password
Definition at line 89 of file m2mb_web_prov.h.
#define M2MB_PROV_HTTPD_DEFAULT_USERNAME "admin" |
Default username
Definition at line 88 of file m2mb_web_prov.h.
#define M2MB_PROV_HTTPD_MAX_PASSWORD_LEN 32 |
Maximum length of password
Definition at line 86 of file m2mb_web_prov.h.
#define M2MB_PROV_HTTPD_MAX_USERNAME_LEN 32 |
Maximum length of username
Definition at line 85 of file m2mb_web_prov.h.
#define M2MB_PROV_MAC_SSID_LEN 32 |
Maximum length of SSID
Definition at line 62 of file m2mb_web_prov.h.
#define M2MB_PROV_MAX_DNS_DOMAIN_LEN 64 |
Maximum length of DNS Domain name
Definition at line 63 of file m2mb_web_prov.h.
#define M2MB_PROV_MAX_SYS_ID_LEN 64 |
Maximum length of System Identifier
Definition at line 64 of file m2mb_web_prov.h.
#define M2MB_PROV_NWIF_HOST_NAME_MAX_LEN 15 |
Maximum length of Network Interface Host name
Definition at line 65 of file m2mb_web_prov.h.
#define M2MB_PROV_REG_DOMAIN_ETSI_MEXS_STR "etsi_mex" |
ETSI Mexico regulatory domain
Definition at line 73 of file m2mb_web_prov.h.
#define M2MB_PROV_REG_DOMAIN_ETSI_STR "etsi" |
ETSI regulatoty domain
Definition at line 72 of file m2mb_web_prov.h.
#define M2MB_PROV_REG_DOMAIN_FCC_STR "fcc" |
FCC regulatory domain
Definition at line 71 of file m2mb_web_prov.h.
#define M2MB_PROV_REG_DOMAIN_TELEC_STR "telec" |
Telecom regulatory domain
Definition at line 74 of file m2mb_web_prov.h.
#define M2MB_PROV_REG_DOMAIN_UNKNOWN_MAX_CH 14 |
Maximum channel count of unknown regulatory domain
Definition at line 69 of file m2mb_web_prov.h.
#define M2MB_PROV_REG_DOMAIN_UNKNOWN_STR "unknown" |
Unknown regulatory domain
Definition at line 75 of file m2mb_web_prov.h.
#define M2MB_PROV_SEC_MAX_WEP_KEY_LEN M2MB_PROV_SEC_WEP104_KEY_LEN |
Maximul WEP Key length
Definition at line 67 of file m2mb_web_prov.h.
#define M2MB_PROV_SEC_PASSPHRASE_LEN 64 |
Maximum length of security passphrase
Definition at line 66 of file m2mb_web_prov.h.
#define M2MB_PROV_SECURITY_NONE_STR "none" |
No security
Definition at line 80 of file m2mb_web_prov.h.
#define M2MB_PROV_WEP_STR "wep" |
WEP security
Definition at line 81 of file m2mb_web_prov.h.
#define M2MB_PROV_WPA_ENTERPRISE_STR "wpa-enterprise" |
WPA enterprise security
Definition at line 83 of file m2mb_web_prov.h.
#define M2MB_PROV_WPA_PERSONAL_STR "wpa-personal" |
WPA Personal security
Definition at line 82 of file m2mb_web_prov.h.
#define WEB_PROV_DEBUG_PRINT | ( | ... | ) |
typedef struct M2MB_PROV_AP_CONFIG M2MB_PROV_AP_CONFIG_T |
AP Configuration structure.
Structure for storing AP configuration.
typedef enum M2MB_PROV_AP_MODE M2MB_PROV_AP_MODE_T |
AP mode enumeration.
This enum defines macros for modes of AP supported by provisioning module.
typedef struct M2MB_PROV_CLIENT_CONFIG M2MB_PROV_CLIENT_CONFIG_T |
Client Configuration structure.
Structure for storing client configuration.
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.
Type definition of the user callback to handle provision configuration.
Definition at line 338 of file m2mb_web_prov.h.
typedef struct M2MB_PROV_CONFIG_S M2MB_PROV_CONFIG_T |
Provisioning Configuration structure.
Structure for storing provisioning configuration.
typedef enum M2MB_PROV_ENCODE_TYPE M2MB_PROV_ENCODE_TYPE_T |
Encoding types enumeration.
This enum defines macros for types of encoding supported by provisioning module.
typedef struct M2MB_PROV_IP_CONFIG M2MB_PROV_IP_CONFIG_T |
IP Configuration structure.
Structure for storing IP configuration.
typedef struct M2MB_PROV_NETWORK_CONFIG M2MB_PROV_NETWORK_CONFIG_T |
Network Configuration structure.
Structure for storing Network configuration.
typedef enum M2MB_PROV_NETWORK_MODE M2MB_PROV_NETWORK_MODE_T |
Network mode enumeration.
This enum defines macros for network modes supported by provisioning module.
typedef enum M2MB_PROV_OBJECT_TYPE M2MB_PROV_OBJECT_TYPE_T |
Object types enumeration.
This enum defines macros for types of objects supported by provisioning module.
typedef enum M2MB_PROV_REG_DOMAIN M2MB_PROV_REG_DOMAIN_T |
Regulatory domains enumeration.
This enum defines macros for regulatory domains supported by provisioning module.
typedef struct M2MB_PROV_SEC_PSK M2MB_PROV_SEC_PSK_T |
PSK structure.
Structure for storing PSK and its length.
typedef enum M2MB_PROV_SEC_TYPE M2MB_PROV_SEC_TYPE_T |
Security type enumeration.
This enum defines macros for types of security supported by provisioning module.
typedef struct M2MB_PROV_SEC_WEP_CONFIG M2MB_PROV_SEC_WEP_CONFIG_T |
WEP Configuration structure.
Structure for storing WEP Key and its configurations.
typedef struct M2MB_PROV_SSID M2MB_PROV_SSID_T |
SSID structure.
Structure for storing SSID and its length.
typedef enum M2MB_PROV_SYS_CONFIG_OPTION M2MB_PROV_SYS_CONFIG_OPTION_T |
Configuration opetions enumeration.
This enum defines macros for configuration options supported by provisioning module.
typedef struct M2MB_PROV_SYS_CONFIG_SYS_ID M2MB_PROV_SYS_CONFIG_SYS_ID_T |
System Configuration Identifier structure.
Structure for storing system configuration identifier.
typedef struct M2MB_PROV_SYS_CONFIG M2MB_PROV_SYS_CONFIG_T |
System Configuration structure.
Structure for storing system configuration.
typedef enum M2MB_PROV_WEP_AUTH_TYPE M2MB_PROV_WEP_AUTH_TYPE_T |
WEP authentication type enumeration.
This enum defines macros for authentication type of WEP security.
typedef enum M2MB_PROV_WEP_KEY_LEN M2MB_PROV_WEP_KEY_LEN_T |
WEP key length enumeration.
This enum defines macros for Key lengths of WEP security.
enum M2MB_PROV_AP_MODE |
AP mode enumeration.
This enum defines macros for modes of AP supported by provisioning module.
Enumerator | |
---|---|
M2MB_PROV_AP_MODE_PROV | Provisioning mode |
M2MB_PROV_AP_MODE_USER | User mode |
Definition at line 149 of file m2mb_web_prov.h.
Encoding types enumeration.
This enum defines macros for types of encoding supported by provisioning module.
Enumerator | |
---|---|
M2MB_PROV_ENCODE_TYPE_XML | XML encoding |
M2MB_PROV_ENCODE_TYPE_JSON | JSON encoding - Currently not supported in Provisioning |
Definition at line 184 of file m2mb_web_prov.h.
Network mode enumeration.
This enum defines macros for network modes supported by provisioning module.
Definition at line 160 of file m2mb_web_prov.h.
Object types enumeration.
This enum defines macros for types of objects supported by provisioning module.
Definition at line 195 of file m2mb_web_prov.h.
enum M2MB_PROV_REG_DOMAIN |
Regulatory domains enumeration.
This enum defines macros for regulatory domains supported by provisioning module.
Definition at line 135 of file m2mb_web_prov.h.
enum M2MB_PROV_SEC_TYPE |
Security type enumeration.
This enum defines macros for types of security supported by provisioning module.
Enumerator | |
---|---|
M2MB_PROV_SEC_TYPE_NONE | Open security |
M2MB_PROV_SEC_TYPE_WEP | WEP security |
M2MB_PROV_SEC_TYPE_WPA_PERSONAL | WPA personal security |
M2MB_PROV_SEC_TYPE_WPA_ENTERPRISE | Enterprise security |
Definition at line 122 of file m2mb_web_prov.h.
Configuration opetions enumeration.
This enum defines macros for configuration options supported by provisioning module.
Enumerator | |
---|---|
M2MB_PROV_SYS_CONFIG_OPTION_GET | Option to get configuration |
M2MB_PROV_SYS_CONFIG_OPTION_SET | Option to set configuration |
Definition at line 173 of file m2mb_web_prov.h.
WEP authentication type enumeration.
This enum defines macros for authentication type of WEP security.
Enumerator | |
---|---|
M2MB_PROV_SEC_WEP_OPEN | WEP-40 Key length in bytes. |
M2MB_PROV_SEC_WEP_SHARED | WEP-104 Key length in bytes. |
Definition at line 99 of file m2mb_web_prov.h.
WEP key length enumeration.
This enum defines macros for Key lengths of WEP security.
Enumerator | |
---|---|
M2MB_PROV_SEC_WEP_KEY_INVLAID | WEP-40 Key length in bytes. |
M2MB_PROV_SEC_WEP40_KEY_LEN | WEP-40 Key length in bytes. |
M2MB_PROV_SEC_WEP104_KEY_LEN | WEP-104 Key length in bytes. |
Definition at line 110 of file m2mb_web_prov.h.
M2MB_STATUS_T m2mb_httpd_prov_start | ( | M2MB_PROV_CONFIG_T * | pProvcfg, |
M2MB_HTTPD_CONFIG_T * | pHTTPDcfg | ||
) |
HTTP Provision Start.
This API starts HTTP provisioning.
[in] | pProvcfg | Pointer to the provisioning related configuration. |
[in] | pHTTPDcfg | Pointer to the HTTP server related configuration. |
m2mb_httpd_prov_start( M2MB_PROV_CONFIG_T pProvcfg, M2MB_HTTPD_CONFIG_T pHTTPDcfg );