wifinora  2.1.0.0
Data Structures | Macros | Enumerations | Functions
wifinora.h File Reference

This file contains API for WiFi NORA Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  wifinora_t
 WiFi NORA Click context object. More...
 
struct  wifinora_cfg_t
 WiFi NORA Click configuration object. More...
 

Macros

#define WIFINORA_CMD_AT   "AT"
 WiFi NORA control commands. More...
 
#define WIFINORA_CMD_AT_USYFR   "AT+USYFR"
 
#define WIFINORA_CMD_AT_GMM   "AT+GMM"
 
#define WIFINORA_CMD_AT_SW_RESET   "AT+CPWROFF"
 
#define WIFINORA_CMD_AT_UWAPC   "AT+UWAPC"
 
#define WIFINORA_CMD_AT_UWSCP   "AT+UWSCP"
 
#define WIFINORA_CMD_AT_UWSIPD   "AT+UWSIPD"
 
#define WIFINORA_CMD_AT_UWSSW   "AT+UWSSW"
 
#define WIFINORA_CMD_AT_UWSC   "AT+UWSC"
 
#define WIFINORA_CMD_AT_USOCR   "AT+USOCR"
 
#define WIFINORA_CMD_AT_USOC   "AT+USOC"
 
#define WIFINORA_CMD_AT_USOWS   "AT+USOWS"
 
#define WIFINORA_CMD_AT_USORS   "AT+USORS"
 
#define WIFINORA_CMD_AT_USOCL   "AT+USOCL"
 
#define WIFINORA_RSP_OK   "OK"
 WiFi NORA response codes. More...
 
#define WIFINORA_RSP_ERROR   "ERROR"
 
#define WIFINORA_RSP_READY   "+STARTUP"
 
#define WIFINORA_PIN_STATE_HIGH   0x01
 WiFi NORA pin states. More...
 
#define WIFINORA_PIN_STATE_LOW   0x00
 
#define WIFINORA_TX_DRV_BUFFER_SIZE   100
 WiFi NORA driver buffer size. More...
 
#define WIFINORA_RX_DRV_BUFFER_SIZE   300
 
#define WIFINORA_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  wifinora_return_value_t {
  WIFINORA_OK = 0, WIFINORA_ERROR = -1, WIFINORA_ERROR_TIMEOUT = -2, WIFINORA_ERROR_CMD = -3,
  WIFINORA_ERROR_UNKNOWN = -4
}
 WiFi NORA Click return value data. More...
 

Functions

void wifinora_cfg_setup (wifinora_cfg_t *cfg)
 WiFi NORA configuration object setup function. More...
 
err_t wifinora_init (wifinora_t *ctx, wifinora_cfg_t *cfg)
 WiFi NORA initialization function. More...
 
err_t wifinora_generic_write (wifinora_t *ctx, uint8_t *data_in, uint16_t len)
 WiFi NORA data writing function. More...
 
err_t wifinora_generic_read (wifinora_t *ctx, uint8_t *data_out, uint16_t len)
 WiFi NORA data reading function. More...
 
void wifinora_set_rst_pin (wifinora_t *ctx, uint8_t pin_state)
 WiFi NORA set RST pin function. More...
 
void wifinora_set_wkp_pin (wifinora_t *ctx, uint8_t pin_state)
 WiFi NORA set WKP pin function. More...
 
void wifinora_set_cts_pin (wifinora_t *ctx, uint8_t pin_state)
 WiFi NORA set CTS pin function. More...
 
uint8_t wifinora_get_whs_pin (wifinora_t *ctx)
 WiFi NORA get WHS pin state function. More...
 
uint8_t wifinora_get_rts_pin (wifinora_t *ctx)
 WiFi NORA get RTS pin state function. More...
 
void wifinora_hw_reset (wifinora_t *ctx)
 WiFi NORA HW reset function. More...
 
void wifinora_send_cmd (wifinora_t *ctx, uint8_t *at_cmd_buf)
 WiFi NORA send command function. More...
 
void wifinora_send_cmd_with_par (wifinora_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 WiFi NORA send command with parameter function. More...
 
void wifinora_send_cmd_check (wifinora_t *ctx, uint8_t *at_cmd_buf)
 WiFi NORA send command check function. More...
 

Detailed Description

This file contains API for WiFi NORA Click Driver.

Enumeration Type Documentation

◆ wifinora_return_value_t

WiFi NORA Click return value data.

Predefined enum values for driver return values.

Enumerator
WIFINORA_OK 
WIFINORA_ERROR 
WIFINORA_ERROR_TIMEOUT 
WIFINORA_ERROR_CMD 
WIFINORA_ERROR_UNKNOWN