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

This file contains API for NINA-W152 Click Driver. More...

#include "mikrosdk_version.h"
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures

struct  ninaw152_t
 NINA-W152 Click context object. More...
 
struct  ninaw152_cfg_t
 NINA-W152 Click configuration object. More...
 

Macros

#define NINAW152_CMD_AT   "AT"
 NINA-W152 control commands. More...
 
#define NINAW152_CMD_GET_MODEL_ID   "AT+GMM"
 
#define NINAW152_CMD_GET_SW_VERSION   "AT+GMR"
 
#define NINAW152_CMD_GET_SERIAL_NUM   "AT+GSN"
 
#define NINAW152_CMD_FACTORY_RESET   "AT+UFACTORY"
 
#define NINAW152_CMD_REBOOT_DEVICE   "AT+CPWROFF"
 
#define NINAW152_CMD_NETWORK_HOST_NAME   "AT+UNHN"
 
#define NINAW152_CMD_BT_LOCAL_NAME   "AT+UBTLN"
 
#define NINAW152_CMD_WIFI_STATION_CONFIG   "AT+UWSC"
 
#define NINAW152_CMD_WIFI_STATION_CONFIG_ACTION   "AT+UWSCA"
 
#define NINAW152_CMD_WIFI_STATION_STATUS   "AT+UWSSTAT"
 
#define NINAW152_CMD_CONNECT_PEER   "AT+UDCP"
 
#define NINAW152_CMD_WRITE_DATA   "AT+UDATW"
 
#define NINAW152_CMD_READ_DATA   "AT+UDATR"
 
#define NINAW152_CMD_CLOSE_PEER   "AT+UDCPC"
 
#define NINAW152_CMD_ENTER_DATA_MODE   "ATO1"
 
#define NINAW152_CMD_ENTER_CMD_MODE   "+++"
 
#define NINAW152_RSP_OK   "OK"
 NINA-W152 device response to AT commands. More...
 
#define NINAW152_RSP_ERROR   "ERROR"
 
#define NINAW152_URC_GREETING   "+STARTUP"
 NINA-W152 device unsolicited response code (URC) settings. More...
 
#define NINAW152_URC_WIFI_LINK_CONNECTED   "+UUWLE:"
 
#define NINAW152_URC_NETWORK_UP   "+UUNU:"
 
#define NINAW152_URC_PEER_CONNECTED   "+UUDPC:"
 
#define NINAW152_URC_PEER_DISCONNECTED   "+UUDPD:"
 
#define NINAW152_URC_READ_SOCKET_DATA   "+UUDATA:"
 
#define NINAW152_TX_DRV_BUFFER_SIZE   200
 NINA-W152 driver buffer size. More...
 
#define NINAW152_RX_DRV_BUFFER_SIZE   600
 
#define NINAW152_SPI_HEADER_0   0xBA
 NINA-W152 SPI packet settings. More...
 
#define NINAW152_SPI_HEADER_1   0x15
 
#define NINAW152_SPI_NORX   0x80
 
#define NINAW152_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection. More...
 
#define NINAW152_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
#define NINAW152_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  ninaw152_drv_t { NINAW152_DRV_SEL_UART, NINAW152_DRV_SEL_SPI }
 NINA-W152 Click driver selector. More...
 
enum  ninaw152_return_value_t {
  NINAW152_OK = 0, NINAW152_ERROR = -1, NINAW152_ERROR_TIMEOUT = -2, NINAW152_ERROR_CMD = -3,
  NINAW152_ERROR_UNKNOWN = -4
}
 NINA-W152 Click return value data. More...
 

Functions

void ninaw152_cfg_setup (ninaw152_cfg_t *cfg)
 NINA-W152 configuration object setup function. More...
 
err_t ninaw152_init (ninaw152_t *ctx, ninaw152_cfg_t *cfg)
 NINA-W152 initialization function. More...
 
void ninaw152_drv_interface_sel (ninaw152_cfg_t *cfg, ninaw152_drv_t drv_sel)
 NINA-W152 driver interface setup function. More...
 
err_t ninaw152_generic_write (ninaw152_t *ctx, uint8_t *data_in, uint16_t len)
 NINA-W152 data writing function. More...
 
err_t ninaw152_generic_read (ninaw152_t *ctx, uint8_t *data_out, uint16_t len)
 NINA-W152 data reading function. More...
 
void ninaw152_set_rst_pin (ninaw152_t *ctx, uint8_t state)
 NINA-W152 set rst pin function. More...
 
void ninaw152_reset_device (ninaw152_t *ctx)
 NINA-W152 reset device function. More...
 
void ninaw152_set_cts_pin (ninaw152_t *ctx, uint8_t state)
 NINA-W152 set cts pin function. More...
 
void ninaw152_set_esc_pin (ninaw152_t *ctx, uint8_t state)
 NINA-W152 set esc pin function. More...
 
uint8_t ninaw152_get_rts_pin (ninaw152_t *ctx)
 NINA-W152 get rts pin function. More...
 
uint8_t ninaw152_get_sry_pin (ninaw152_t *ctx)
 NINA-W152 get sry pin function. More...
 
void ninaw152_send_cmd (ninaw152_t *ctx, uint8_t *cmd)
 NINA-W152 send command function. More...
 
void ninaw152_send_cmd_with_par (ninaw152_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 NINA-W152 send command with parameter function. More...
 
void ninaw152_send_cmd_check (ninaw152_t *ctx, uint8_t *at_cmd_buf)
 NINA-W152 send command check function. More...
 

Detailed Description

This file contains API for NINA-W152 Click Driver.

Enumeration Type Documentation

◆ ninaw152_drv_t

NINA-W152 Click driver selector.

Selects target driver interface of NINA-W152 Click driver.

Enumerator
NINAW152_DRV_SEL_UART 

UART driver descriptor.

NINAW152_DRV_SEL_SPI 

SPI driver descriptor.

◆ ninaw152_return_value_t

NINA-W152 Click return value data.

Predefined enum values for driver return values.

Enumerator
NINAW152_OK 
NINAW152_ERROR 
NINAW152_ERROR_TIMEOUT 
NINAW152_ERROR_CMD 
NINAW152_ERROR_UNKNOWN