wifi11  2.0.0.0
Functions
Public function

Functions

void wifi11_cfg_setup (wifi11_cfg_t *cfg)
 Config Object Initialization function. More...
 
WIFI11_RETVAL wifi11_init (wifi11_t *ctx, wifi11_cfg_t *cfg)
 Initialization function. More...
 
void wifi11_generic_write (wifi11_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t wifi11_generic_read (wifi11_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void wifi11_reset_device (wifi11_t *ctx)
 Device reset function. More...
 
void wifi11_send_cmd (wifi11_t *ctx, char *cmd)
 Send command function. More...
 
void wifi11_send_cmd_with_parameter (wifi11_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command function with parameter. More...
 
void wifi11_connect_to_ap (wifi11_t *ctx, char *ssid, char *password)
 Connect to AP function. More...
 
void wifi11_create_tcp_udp_server (wifi11_t *ctx, uint8_t mode, uint16_t port)
 Create TCP/UDP server function. More...
 

Detailed Description

Function Documentation

◆ wifi11_cfg_setup()

void wifi11_cfg_setup ( wifi11_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ wifi11_connect_to_ap()

void wifi11_connect_to_ap ( wifi11_t ctx,
char *  ssid,
char *  password 
)

Connect to AP function.

This function connects to the desired AP.

Parameters
[in]ctx: Click context object. See wifi11_t object definition for detailed explanation.
[in]ssidSSID of AP.
[in]passwordAP password ( NULL - if the AP is OPEN ).
Returns
Nothing.

◆ wifi11_create_tcp_udp_server()

void wifi11_create_tcp_udp_server ( wifi11_t ctx,
uint8_t  mode,
uint16_t  port 
)

Create TCP/UDP server function.

This function creates TCP/UDP server on the desired port.

Parameters
[in]ctx: Click context object. See wifi11_t object definition for detailed explanation.
[in]modeTCP - 0, UDP - 1.
[in]portLocal port: 1-65535.
Returns
Nothing.

◆ wifi11_generic_read()

int32_t wifi11_generic_read ( wifi11_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Generic read function.

This function reads the specified number of data bytes.

Parameters
[in]ctxClick object. See wifi11_t object definition for detailed explanation.
[out]data_bufData buffer for read data.
[in]max_lenThe maximum length of data that can be read.
Returns
Number of reads data.

◆ wifi11_generic_write()

void wifi11_generic_write ( wifi11_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

This function writes the specified number of data bytes.

Parameters
[in]ctxClick object. See wifi11_t object definition for detailed explanation.
[in]data_bufData buffer for sends.
[in]lenNumber of bytes for sends.

◆ wifi11_init()

WIFI11_RETVAL wifi11_init ( wifi11_t ctx,
wifi11_cfg_t cfg 
)

Initialization function.

Parameters
[in]ctxClick object. See wifi11_t object definition for detailed explanation.
[in]cfgClick configuration structure.

This function initializes all necessary pins and peripherals used for this click.

◆ wifi11_reset_device()

void wifi11_reset_device ( wifi11_t ctx)

Device reset function.

This function resets the device.

Parameters
ctxClick object. See wifi11_t object definition for detailed explanation.
Returns
Nothing.

◆ wifi11_send_cmd()

void wifi11_send_cmd ( wifi11_t ctx,
char *  cmd 
)

Send command function.

This function sends the specified command to the click module.

Parameters
[in]ctx: Click context object. See wifi11_t object definition for detailed explanation.
[in]cmdCommand variable.
Returns
Nothing.

◆ wifi11_send_cmd_with_parameter()

void wifi11_send_cmd_with_parameter ( wifi11_t ctx,
char *  at_cmd_buf,
char *  param_buf 
)

Send command function with parameter.

This function sends commands to the click module.

Parameters
[in]ctx: Click context object. See wifi11_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
[in]param_bufParameter buffer.
Returns
Nothing.