File espos_wifi_sm.h¶

FileList > espos_wifi > include > espos_wifi_sm.h

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "esp_err.h"
#include "sdkconfig.h"

Classes¶

Type	Name
struct	espos_wifi_cfg_t
struct	espos_wifi_ip_t
struct	espos_wifi_link_t
struct	espos_wifi_net_t
struct	espos_wifi_port_t
struct	espos_wifi_sm_status_t
struct	espos_wifi_sm_t

Public Types¶

Type	Name
enum	espos_wifi_event_t
enum	espos_wifi_state_t

Public Functions¶

Type	Name
uint32_t	espos_wifi_backoff_ms (uint32_t round, uint32_t cap_ms, uint32_t rnd)
const char *	espos_wifi_reason_str (int reason)
uint32_t	espos_wifi_sm_backoff_remaining_ms (const espos_wifi_sm_t * sm)
void	espos_wifi_sm_event (espos_wifi_sm_t * sm, espos_wifi_event_t ev, const void * arg)
void	espos_wifi_sm_init (espos_wifi_sm_t * sm, const espos_wifi_port_t * port, void * port_ctx, const espos_wifi_cfg_t * cfg)
const espos_wifi_sm_status_t *	espos_wifi_sm_status (const espos_wifi_sm_t * sm)
const char *	espos_wifi_state_str (espos_wifi_state_t s)

Macros¶

Type	Name
define	ESPOS_WIFI_MAX_NETWORKS `4`
define	ESPOS_WIFI_REASON_CONFIG_CHANGE `1004`
define	ESPOS_WIFI_REASON_CONNECT_TIMEOUT `1002`
define	ESPOS_WIFI_REASON_DHCP_TIMEOUT `1001`
define	ESPOS_WIFI_REASON_DISABLED `1005`
define	ESPOS_WIFI_REASON_LOST_IP `1003`
define	ESPOS_WIFI_REASON_NONE `0`

Public Types Documentation¶

enum espos_wifi_event_t¶

enum espos_wifi_event_t {
    ESPOS_WIFI_EV_START,
    ESPOS_WIFI_EV_STOP,
    ESPOS_WIFI_EV_CONFIG,
    ESPOS_WIFI_EV_STA_CONNECTED,
    ESPOS_WIFI_EV_STA_DISCONNECTED,
    ESPOS_WIFI_EV_GOT_IP,
    ESPOS_WIFI_EV_LOST_IP,
    ESPOS_WIFI_EV_TIMER,
    ESPOS_WIFI_EV_PORTAL_CLIENT,
    ESPOS_WIFI_EV_PORTAL_FAILED,
    ESPOS_WIFI_EV_PORTAL_RECONFIG
};

enum espos_wifi_state_t¶

enum espos_wifi_state_t {
    ESPOS_WIFI_ST_DISABLED = 0,
    ESPOS_WIFI_ST_UNCONFIGURED,
    ESPOS_WIFI_ST_CONNECTING,
    ESPOS_WIFI_ST_OBTAINING_IP,
    ESPOS_WIFI_ST_CONNECTED,
    ESPOS_WIFI_ST_BACKOFF
};

Public Functions Documentation¶

function espos_wifi_backoff_ms¶

uint32_t espos_wifi_backoff_ms (
    uint32_t round,
    uint32_t cap_ms,
    uint32_t rnd
)

function espos_wifi_reason_str¶

const char * espos_wifi_reason_str (
    int reason
)

function espos_wifi_sm_backoff_remaining_ms¶

uint32_t espos_wifi_sm_backoff_remaining_ms (
    const espos_wifi_sm_t * sm
)

function espos_wifi_sm_event¶

void espos_wifi_sm_event (
    espos_wifi_sm_t * sm,
    espos_wifi_event_t ev,
    const void * arg
)

function espos_wifi_sm_init¶

void espos_wifi_sm_init (
    espos_wifi_sm_t * sm,
    const espos_wifi_port_t * port,
    void * port_ctx,
    const espos_wifi_cfg_t * cfg
)

function espos_wifi_sm_status¶

const espos_wifi_sm_status_t * espos_wifi_sm_status (
    const espos_wifi_sm_t * sm
)

function espos_wifi_state_str¶

const char * espos_wifi_state_str (
    espos_wifi_state_t s
)

Macro Definition Documentation¶

define ESPOS_WIFI_MAX_NETWORKS¶

#define ESPOS_WIFI_MAX_NETWORKS `4`

define ESPOS_WIFI_REASON_CONFIG_CHANGE¶

#define ESPOS_WIFI_REASON_CONFIG_CHANGE `1004`

define ESPOS_WIFI_REASON_CONNECT_TIMEOUT¶

#define ESPOS_WIFI_REASON_CONNECT_TIMEOUT `1002`

define ESPOS_WIFI_REASON_DHCP_TIMEOUT¶

#define ESPOS_WIFI_REASON_DHCP_TIMEOUT `1001`

define ESPOS_WIFI_REASON_DISABLED¶

#define ESPOS_WIFI_REASON_DISABLED `1005`

define ESPOS_WIFI_REASON_LOST_IP¶

#define ESPOS_WIFI_REASON_LOST_IP `1003`

define ESPOS_WIFI_REASON_NONE¶

#define ESPOS_WIFI_REASON_NONE `0`

The documentation for this class was generated from the following file espos_wifi/include/espos_wifi_sm.h