nbiot  2.0.0.0
Data Structures | Macros | Typedefs | Functions
nbiot.h File Reference

This file contains API for NB IoT 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  nbiot_t
 Click ctx object definition. More...
 
struct  nbiot_cfg_t
 Click configuration structure definition. More...
 

Macros

#define NBIOT_MAP_MIKROBUS(cfg, mikrobus)
 
#define NBIOT_RETVAL   uint8_t
 
#define NBIOT_OK   0x00
 
#define NBIOT_INIT_ERROR   0xFF
 
#define NBIOT_PARSER_NO_ERROR   0x00
 
#define NBIOT_PARSER_ERROR_REF   0x01
 
#define NBIOT_PARSER_ERROR_CMD   0x02
 
#define NBIOT_PARSER_ERROR_DATA   0x04
 
#define NBIOT_STATUS_DEVICE_READY   1
 
#define NBIOT_STATUS_ACT_NETWORK_AND_BROKER   4
 
#define NBIOT_STATUS_ACT_NETWORK   2
 
#define NBIOT_STATUS_ACT_BROKER   3
 
#define NBIOT_STATUS_DEVICE_BUSY   0
 
#define NBIOT_MODULE_POWER_ON   1
 
#define NBIOT_MODULE_POWER_OFF   0
 
#define NBIOT_SINGLE_CMD_AT   "AT"
 
#define NBIOT_SINGLE_CMD_ATI   "ATI"
 
#define NBIOT_SINGLE_CMD_AT_W   "AT+W"
 
#define NBIOT_SINGLE_CMD_AT_R   "AT+R"
 
#define NBIOT_SINGLE_CMD_ATE0   "ATE0"
 
#define NBIOT_SINGLE_CMD_ATE1   "ATE1"
 
#define NBIOT_SINGLE_CMD_AT_RST   "AT+RST"
 
#define NBIOT_SINGLE_CMD_AT_CRST   "AT+CRST"
 
#define NBIOT_SINGLE_CMD_AT_GMR   "AT+GMR"
 
#define NBIOT_SINGLE_CMD_AT_GMSTA   "AT+GMSTA"
 
#define NBIOT_SINGLE_CMD_AT_PUB   "AT+PUB"
 
#define NBIOT_SINGLE_CMD_AT_CIMI   "AT+CIMI"
 
#define NBIOT_SINGLE_CMD_SET_AT_LRSP_1   "AT+LRSP=1"
 
#define NBIOT_SINGLE_CMD_SET_AT_LRSP_0   "AT+LRSP=0"
 
#define NBIOT_SINGLE_CMD_SET_AT_CEN_1   "AT+CEN=1"
 
#define NBIOT_SINGLE_CMD_SET_AT_CEN_0   "AT+CEN=0"
 
#define NBIOT_SINGLE_CMD_SET_AT_NWC_1   "AT+NWC=1"
 
#define NBIOT_SINGLE_CMD_SET_AT_NWC_0   "AT+NWC=0"
 
#define NBIOT_SINGLE_CMD_SET_AT_BRC_1   "AT+BRC=1"
 
#define NBIOT_SINGLE_CMD_SET_AT_BRC_0   "AT+BRC=0"
 
#define NBIOT_SINGLE_CMD_SET_AT_GPEN_0   "AT+GPEN=0"
 
#define NBIOT_SINGLE_CMD_SET_AT_GPEN_1   "AT+GPEN=1"
 
#define NBIOT_SINGLE_CMD_SET_AT_CFUN   "AT+CFUN=1"
 
#define NBIOT_SINGLE_CMD_GET_AT_LRSP   "AT+LRSP?"
 
#define NBIOT_SINGLE_CMD_GET_AT_CEN   "AT+CEN?"
 
#define NBIOT_SINGLE_CMD_GET_AT_NWC   "AT+NWC?"
 
#define NBIOT_SINGLE_CMD_GET_AT_BRC   "AT+BRC?"
 
#define NBIOT_SINGLE_CMD_GET_AT_GPEN   "AT+GPEN?"
 
#define NBIOT_SINGLE_CMD_GET_AT_NWCR   "AT+NWCR?"
 
#define NBIOT_SINGLE_CMD_GET_AT_BRCR   "AT+BRCR?"
 
#define NBIOT_SINGLE_CMD_GET_AT_DSET   "AT+DSET?"
 
#define NBIOT_SINGLE_CMD_TEST_AT_LRSP   "AT+LRSP=?"
 
#define NBIOT_SINGLE_CMD_TEST_AT_CEN   "AT+CEN=?"
 
#define NBIOT_SINGLE_CMD_TEST_AT_NWC   "AT+NWC=?"
 
#define NBIOT_SINGLE_CMD_TEST_AT_BRC   "AT+BRC=?"
 
#define NBIOT_SINGLE_CMD_TEST_AT_GPEN   "AT+GPEN=?"
 
#define NBIOT_SINGLE_CMD_TEST_AT_NWCR   "AT+NWCR=?"
 
#define NBIOT_SINGLE_CMD_TEST_AT_BRCR   "AT+BRCR=?"
 
#define NBIOT_SINGLE_CMD_TEST_AT_DSET   "AT+DSET=?"
 
#define NBIOT_SINGLE_CMD_TEST_ATAT_CGDCONT   "AT+CGDCONT?"
 
#define C5GNBIOT_SINGLE_CMD_GET_AT_CGATT   "AT+CGATT?"
 
#define NBIOT_MULTI_CMD_AT_DSET   "AT+DSET"
 
#define NBIOT_MULTI_CMD_AT_BRCR   "AT+BRCR"
 
#define NBIOT_MULTI_CMD_AT_NWCR   "AT+NWCR"
 
#define C5GNBIOT_SINGLE_CMD_SET_AT_CGDCONT_1   "AT+CGDCONT=1,\"IP\",\"vip.iot\""
 
#define NBIOT_CMD_AT_NCONFIG   "AT+NCONFIG=CR_0354_0338_SCRAMBLING,TRUE"
 
#define NBIOT_CMD_AT_NCONFIG1   "AT+NCONFIG=CR_0859_SI_AVOID,TRUE"
 
#define NBIOT_CMD_AT_NCONFIG2   "AT+NCONFIG=AUTOCONNECT,FALSE"
 
#define NBIOT_CMD_AT_NBAND   "AT+NBAND=8"
 
#define NBIOT_CMD_AT_CEREG   "AT+CEREG=2"
 
#define NBIOT_CMD_AT_COPS   "AT+COPS=1,2,\"12345\""
 
#define NBIOT_CMD_AT_NSOCR   "AT+NSOCR= DGRAM,17,16666,1"
 
#define NBIOT_CMD_AT_NSOST   "AT+NSOST=0,83.58.228.64,16666,2,ABCD"
 
#define NBIOT_CMD_AT_NSOCL   "AT+NSOCL=0"
 
#define DRV_RX_BUFFER_SIZE   500
 

Typedefs

typedef uint8_t nbiot_actuator_sw_t
 Error type. More...
 
typedef int16_t nbiot_actuator_cnt_t
 
typedef char nbiot_actuator_str_t
 
typedef uint8_t nbiot_error_t
 

Functions

void nbiot_cfg_setup (nbiot_cfg_t *cfg)
 Config Object Initialization function. More...
 
NBIOT_RETVAL nbiot_init (nbiot_t *ctx, nbiot_cfg_t *cfg)
 Initialization function. More...
 
void nbiot_module_power (nbiot_t *ctx)
 Power up modules. More...
 
void nbiot_reset (nbiot_t *ctx)
 Reset module. More...
 
void nbiot_generic_write (nbiot_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t nbiot_generic_read (nbiot_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void nbiot_send_command (nbiot_t *ctx, char *command)
 Send Command function. More...
 

Detailed Description

This file contains API for NB IoT Click driver.