nbiot5  2.0.0.0
Data Structures | Macros | Functions
nbiot5.h File Reference

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"

Go to the source code of this file.

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_ATI   "ATI"
 NB IoT 5 description setting. More...
 
#define NBIOT5_CMD_CIMI   "AT+CIMI"
 
#define NBIOT5_CMD_CSQ   "AT+CSQ"
 
#define NBIOT5_SET_CFUN   "AT+CFUN=1"
 
#define NBIOT5_SET_CREG   "AT+CREG=2"
 
#define NBIOT5_SET_COPS   "AT+COPS=0"
 
#define NBIOT5_SET_CMGF   "AT+CMGF=1"
 
#define NBIOT5_CHECK_CGATT   "AT+CGATT?"
 
#define NBIOT5_CHECK_CREG   "AT+CREG?"
 
#define DRV_BUFFER_SIZE   200
 NB IoT 5 driver buffer size. More...
 
#define NBIOT5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Functions

void nbiot5_cfg_setup (nbiot5_cfg_t *cfg)
 NB IoT 5 configuration object setup function. More...
 
err_t nbiot5_init (nbiot5_t *ctx, nbiot5_cfg_t *cfg)
 NB IoT 5 initialization function. More...
 
err_t nbiot5_default_cfg (nbiot5_t *ctx)
 NB IoT 5 default configuration function. More...
 
err_t nbiot5_generic_write (nbiot5_t *ctx, char *data_buf, uint16_t len)
 NB IoT 5 data writing function. More...
 
err_t nbiot5_generic_read (nbiot5_t *ctx, char *data_buf, uint16_t max_len)
 NB IoT 5 data reading function. More...
 
void nbiot5_set_wkp (nbiot5_t *ctx, uint8_t state)
 Sets state of the wkp pin setting. More...
 
void nbiot5_set_en (nbiot5_t *ctx, uint8_t state)
 Sets state of the en pin setting. More...
 
void nbiot5_set_rst (nbiot5_t *ctx, uint8_t state)
 Sets state of the rst pin setting. More...
 
void nbiot5_set_cs (nbiot5_t *ctx, uint8_t state)
 Sets state of the cs pin setting. More...
 
void nbiot5_send_cmd (nbiot5_t *ctx, char *cmd)
 Send command function. More...
 
void nbiot5_set_sim_apn (nbiot5_t *ctx, char *sim_apn)
 Set sim card APN. More...
 
void nbiot5_send_text_message (nbiot5_t *ctx, char *phone_number, char *message_context)
 NB IoT 5 send text message. More...
 

Detailed Description

This file contains API for NB IoT 5 Click Driver.