nbiot4  2.0.0.0
Data Structures | Macros | Enumerations | Functions
nbiot4.h File Reference

This file contains API for NB IoT 4 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  nbiot4_t
 NB IoT 4 Click context object. More...
 
struct  nbiot4_cfg_t
 NB IoT 4 Click configuration object. More...
 

Macros

#define NBIOT4_CMD_AT   "AT"
 NB IoT 4 description register. More...
 
#define NBIOT4_CMD_ATI   "ATI"
 
#define NBIOT4_CMD_CGMR   "AT+CGMR"
 
#define NBIOT4_CMD_CFUN   "AT+CFUN"
 
#define NBIOT4_CMD_CREG   "AT+CREG"
 
#define NBIOT4_CMD_CEREG   "AT+CEREG"
 
#define NBIOT4_CMD_CGDCONT   "AT+CGDCONT"
 
#define NBIOT4_CMD_CIMI   "AT+CIMI"
 
#define NBIOT4_CMD_CGATT   "AT+CGATT"
 
#define NBIOT4_CMD_CSQ   "AT+CSQ"
 
#define NBIOT4_CMD_CESQ   "AT+CESQ"
 
#define NBIOT4_CMD_COPS   "AT+COPS"
 
#define NBIOT4_CMD_CMGF   "AT+CMGF"
 
#define NBIOT4_CMD_CMGS   "AT+CMGS"
 
#define NBIOT4_CMD_CSCA   "AT+CSCA"
 
#define NBIOT4_CMD_SQNLED   "AT+SQNLED"
 
#define NBIOT4_CMD_SIMSWAP   "AT^SIMSWAP"
 
#define NBIOT4_CMD_RESTART   "AT+TRB"
 
#define NBIOT4_RSP_OK   "OK"
 LTE IoT 8 device response for AT commands. More...
 
#define NBIOT4_RSP_ERROR   "ERROR"
 
#define NBIOT4_RSP_CMD_NO_RSP   "COMMAND NO RESPONSE!"
 
#define NBIOT4_RSP_NO_RSP   "NO RESPONSE!"
 
#define DRV_TX_BUFFER_SIZE   150
 NB IoT 4 driver buffer size. More...
 
#define DRV_RX_BUFFER_SIZE   600
 
#define NBIOT4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  nbiot4_return_value_t { NBIOT4_OK = 0, NBIOT4_ERROR = -1, NBIOT4_ERROR_CMD = -2, NBIOT4_ERROR_UNKNOWN = -3 }
 NB IoT 4 Click return value data. More...
 

Functions

void nbiot4_cfg_setup (nbiot4_cfg_t *cfg)
 NB IoT 4 configuration object setup function. More...
 
err_t nbiot4_init (nbiot4_t *ctx, nbiot4_cfg_t *cfg)
 NB IoT 4 initialization function. More...
 
err_t nbiot4_default_cfg (nbiot4_t *ctx)
 NB IoT 4 default configuration function. More...
 
err_t nbiot4_generic_write (nbiot4_t *ctx, char *data_buf, uint16_t len)
 NB IoT 4 data writing function. More...
 
err_t nbiot4_generic_read (nbiot4_t *ctx, char *data_buf, uint16_t max_len)
 NB IoT 4 data reading function. More...
 
void nbiot4_send_cmd (nbiot4_t *ctx, char *cmd)
 Send command function. More...
 
void nbiot4_send_cmd_with_parameter (nbiot4_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command with parameters. More...
 
void nbiot4_send_cmd_check (nbiot4_t *ctx, char *at_cmd_buf)
 Send command to check commands current value. More...
 
void nbiot4_send_cmd_syntax_check (nbiot4_t *ctx, char *at_cmd_buf)
 Send command to check commands available parameters. More...
 
void nbiot4_set_sim_apn (nbiot4_t *ctx, char *sim_apn)
 Set SIM APN. More...
 
void nbiot4_send_text_message (nbiot4_t *ctx, char *phone_number, char *message_content)
 Send SMS message to number in text mode. More...
 
err_t nbiot4_send_sms_pdu (nbiot4_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
 Send SMS message to number in pdu mode. More...
 
void nbiot4_set_reset (nbiot4_t *ctx, uint8_t state)
 Set reset pin state. More...
 
void nbiot_set_ri (nbiot4_t *ctx, uint8_t state)
 Set ri pin state. More...
 

Detailed Description

This file contains API for NB IoT 4 Click Driver.

Enumeration Type Documentation

◆ nbiot4_return_value_t

NB IoT 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
NBIOT4_OK 
NBIOT4_ERROR 
NBIOT4_ERROR_CMD 
NBIOT4_ERROR_UNKNOWN