This file contains API for NB IoT 5 Click Driver. More...

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

Data Structures
struct	nbiot5_t
	NB IoT 5 Click context object. More...

struct	nbiot5_cfg_t
	NB IoT 5 Click configuration object. More...

Macros
#define	NBIOT5_CMD_AT "AT"
	NB IoT 5 control commands.

#define	NBIOT5_CMD_CFUN "AT+CFUN"

#define	NBIOT5_CMD_CEREG "AT+CEREG"

#define	NBIOT5_CMD_CGDCONT "AT+CGDCONT"

#define	NBIOT5_CMD_CSQ "AT+CSQ"

#define	NBIOT5_CMD_COPS "AT+COPS"

#define	NBIOT5_CMD_CMGS "AT+CMGS"

#define	NBIOT5_CMD_CMGF "AT+CMGF"

#define	NBIOT5_CMD_ESOC "AT+ESOC"

#define	NBIOT5_CMD_ESOCON "AT+ESOCON"

#define	NBIOT5_CMD_ESOSEND "AT+ESOSEND"

#define	NBIOT5_CMD_ESOCL "AT+ESOCL"

#define	NBIOT5_RSP_OK "OK"
	NB IoT 5 device response for AT commands.

#define	NBIOT5_RSP_ERROR "ERROR"

#define	NBIOT5_RX_DRV_BUFFER_SIZE 256
	NB IoT 5 driver buffer size.

#define	NBIOT5_TX_DRV_BUFFER_SIZE 256

#define	NBIOT5_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	nbiot5_return_value_t { NBIOT5_OK = 0 , NBIOT5_ERROR = -1 , NBIOT5_ERROR_TIMEOUT = -2 , NBIOT5_ERROR_CMD = -3 , NBIOT5_ERROR_UNKNOWN = -4 }
	NB IoT 5 Click return value data. More...

Functions
void	nbiot5_cfg_setup (nbiot5_cfg_t *cfg)
	NB IoT 5 configuration object setup function.

err_t	nbiot5_init (nbiot5_t ctx, nbiot5_cfg_t cfg)
	NB IoT 5 initialization function.

err_t	nbiot5_generic_write (nbiot5_t ctx, uint8_t data_in, uint16_t len)
	NB IoT 5 data writing function.

err_t	nbiot5_generic_read (nbiot5_t ctx, uint8_t data_out, uint16_t len)
	NB IoT 5 data reading function.

void	nbiot5_set_rst_pin (nbiot5_t *ctx, uint8_t state)
	NB IoT 5 set rst pin function.

void	nbiot5_set_cs_pin (nbiot5_t *ctx, uint8_t state)
	NB IoT 5 set cs pin function.

void	nbiot5_set_wup_pin (nbiot5_t *ctx, uint8_t state)
	NB IoT 5 set wup pin function.

void	nbiot5_set_en_pin (nbiot5_t *ctx, uint8_t state)
	NB IoT 5 set en pin function.

void	nbiot5_send_cmd (nbiot5_t ctx, uint8_t cmd)
	Send command function.

void	nbiot5_send_cmd_with_par (nbiot5_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.

void	nbiot5_send_cmd_check (nbiot5_t ctx, uint8_t at_cmd_buf)
	Check the sent command.

void	nbiot5_send_cmd_par_check (nbiot5_t ctx, uint8_t at_cmd_buf)
	Check the command parameters.

void	nbiot5_set_sim_apn (nbiot5_t ctx, uint8_t sim_apn)
	Set sim card APN.

void	nbiot5_send_sms_text (nbiot5_t ctx, uint8_t phone_number, uint8_t *sms_text)
	NB IoT 5 send SMS in text mode.

err_t	nbiot5_send_sms_pdu (nbiot5_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	NB IoT 5 send SMS in PDU mode.

Detailed Description

This file contains API for NB IoT 5 Click Driver.

Enumeration Type Documentation

NB IoT 5 Click return value data.

Predefined enum values for driver return values.