nbiot2.h File Reference

This file contains API for NB IoT 2 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	nbiot2_t
	NB IoT 2 Click context object. More...
struct	nbiot2_cfg_t
	NB IoT 2 Click configuration object. More...

Macros
#define	NBIOT2_CMD_AT   "AT"
	NB IoT 2 control commands.
#define	NBIOT2_CMD_ATI   "ATI"
#define	NBIOT2_CMD_CGMR   "AT+CGMR"
#define	NBIOT2_CMD_CFUN   "AT+CFUN"
#define	NBIOT2_CMD_CREG   "AT+CREG"
#define	NBIOT2_CMD_CEREG   "AT+CEREG"
#define	NBIOT2_CMD_CGDCONT   "AT+CGDCONT"
#define	NBIOT2_CMD_CIMI   "AT+CIMI"
#define	NBIOT2_CMD_CGATT   "AT+CGATT"
#define	NBIOT2_CMD_CSQ   "AT+CSQ"
#define	NBIOT2_CMD_CESQ   "AT+CESQ"
#define	NBIOT2_CMD_COPS   "AT+COPS"
#define	NBIOT2_CMD_CSCON   "AT+CSCON"
#define	NBIOT2_CMD_CMEE   "AT+CMEE"
#define	NBIOT2_CMD_CMGS   "AT+CMGS"
#define	NBIOT2_CMD_CGACT   "AT+CGACT"
#define	NBIOT2_CMD_URAT   "AT+URAT"
#define	NBIOT2_CMD_UBANDMASK   "AT+UBANDMASK"
#define	NBIOT2_CMD_URATCONF   "AT+URATCONF"
#define	NBIOT2_CMD_UAUTHREQ   "AT+UAUTHREQ"
#define	NBIOT2_CMD_UUICC   "AT+UUICC"
#define	NBIOT2_CMD_UCGED   "AT+UCGED"
#define	NBIOT2_CMD_UCELLINFO   "AT+UCELLINFO"
#define	NBIOT2_CMD_UANTR   "AT+UANTR"
#define	NBIOT2_CMD_CMGF   "AT+CMGF"
#define	NBIOT2_CMD_QSPCHSC   "AT+QSPCHSC"
#define	NBIOT2_CMD_CPSMS   "AT+CPSMS"
#define	NBIOT2_CMD_QRST   "AT+QRST"
#define	NBIOT2_CMD_QBAND   "AT+QBAND"
#define	NBIOT2_CMD_QNBIOTEVENT   "AT+QNBIOTEVENT"
#define	NBIOT2_CMD_SM   "AT+SM"
#define	NBIOT2_CMD_QSCLK   "AT+QSCLK"
#define	NBIOT2_CMD_QIOPEN   "AT+QIOPEN"
#define	NBIOT2_CMD_QISEND   "AT+QISEND"
#define	NBIOT2_CMD_QIRD   "AT+QIRD"
#define	NBIOT2_CMD_QICLOSE   "AT+QICLOSE"
#define	NBIOT2_PIN_STATE_HIGH   0x01
	NB IoT 2 device pin state commands.
#define	NBIOT2_PIN_STATE_LOW   0x00
#define	NBIOT2_RSP_OK   "OK"
	NB IoT 2 device response for AT commands.
#define	NBIOT2_RSP_ERROR   "ERROR"
#define	NBIOT2_TX_DRV_BUFFER_SIZE   100
	NB IoT 2 driver buffer size.
#define	NBIOT2_RX_DRV_BUFFER_SIZE   300
#define	NBIOT2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	nbiot2_return_value_t { NBIOT2_OK = 0 , NBIOT2_ERROR = -1 , NBIOT2_ERROR_OVERFLOW = -2 , NBIOT2_ERROR_TIMEOUT = -3 }
	NB IoT 2 Click return value data. More...

Functions
void	nbiot2_cfg_setup (nbiot2_cfg_t *cfg)
	NB IoT 2 configuration object setup function.
err_t	nbiot2_init (nbiot2_t *ctx, nbiot2_cfg_t *cfg)
	NB IoT 2 initialization function.
err_t	nbiot2_generic_write (nbiot2_t *ctx, char *data_in, uint16_t len)
	NB IoT 2 data writing function.
err_t	nbiot2_generic_read (nbiot2_t *ctx, char *data_out, uint16_t len)
	NB IoT 2 data reading function.
void	nbiot2_set_rst_pin_state (nbiot2_t *ctx, uint8_t state)
	NB IoT 2 sets state of the RST pin.
void	nbiot2_set_wup_pin_state (nbiot2_t *ctx, uint8_t state)
	NB IoT 2 sets state of the WUP pin.
void	nbiot2_hw_reset (nbiot2_t *ctx)
	NB IoT 2 hardware reset function.
void	nbiot2_send_cmd (nbiot2_t *ctx, char *cmd)
	NB IoT 2 send command function.
void	nbiot2_send_cmd_with_parameter (nbiot2_t *ctx, char *at_cmd_buf, char *param_buf)
	NB IoT 2 send command function with parameter.
void	nbiot2_send_cmd_check (nbiot2_t *ctx, char *at_cmd_buf)
	NB IoT 2 check the sent command.
void	nbiot2_send_cmd_parameter_check (nbiot2_t *ctx, char *at_cmd_buf)
	NB IoT 2 check the command parameters.
void	nbiot2_set_apn (nbiot2_t *ctx, char *apn)
	NB IoT 2 set sim card APN.
void	nbiot2_send_sms_text_mode (nbiot2_t *ctx, char *phone_number, char *message_context)
	NB IoT 2 send SMS in text mode.
err_t	nbiot2_send_sms_pdu (nbiot2_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
	NB IoT 2 send SMS in PDU mode.

Detailed Description

This file contains API for NB IoT 2 Click Driver.

Enumeration Type Documentation

nbiot2_return_value_t

enum nbiot2_return_value_t

NB IoT 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
NBIOT2_OK
NBIOT2_ERROR
NBIOT2_ERROR_OVERFLOW
NBIOT2_ERROR_TIMEOUT