c5gnbiot.h File Reference

This file contains API for 5G 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	c5gnbiot_t
	Click ctx object definition. More...
struct	c5gnbiot_cfg_t
	Click configuration structure definition. More...

Macros
#define	C5GNBIOT_MAP_MIKROBUS(cfg, mikrobus)
#define	C5GNBIOT_MODULE_POWER_ON   1
#define	C5GNBIOT_MODULE_POWER_OFF   0
#define	C5GNBIOT_CMD_AT   "AT"
#define	C5GNBIOT_CMD_ATI   "ATI"
#define	C5GNBIOT_CMD_CGMR   "AT+CGMR"
#define	C5GNBIOT_CMD_CFUN   "AT+CFUN"
#define	C5GNBIOT_CMD_CREG   "AT+CREG"
#define	C5GNBIOT_CMD_CEREG   "AT+CEREG"
#define	C5GNBIOT_CMD_CGDCONT   "AT+CGDCONT"
#define	C5GNBIOT_CMD_CIMI   "AT+CIMI"
#define	C5GNBIOT_CMD_CGATT   "AT+CGATT"
#define	C5GNBIOT_CMD_CESQ   "AT+CESQ"
#define	C5GNBIOT_CMD_COPS   "AT+COPS"
#define	C5GNBIOT_CMD_CMGS   "AT+CMGS"
#define	DRV_RX_BUFFER_SIZE   300
#define	DRV_TX_BUFFER_SIZE   300

Enumerations
enum	c5gnbiot_return_value_t { C5GNBIOT_OK = 0 , C5GNBIOT_ERROR = -1 }
	5G NB IoT Click return value data. More...

Functions
void	c5gnbiot_cfg_setup (c5gnbiot_cfg_t *cfg)
	5G NB IoT configuration object setup function.
err_t	c5gnbiot_init (c5gnbiot_t *ctx, c5gnbiot_cfg_t *cfg)
	5G NB IoT initialization function.
err_t	c5gnbiot_generic_write (c5gnbiot_t *ctx, char *data_buf, uint16_t len)
	5G NB IoT data writing function.
err_t	c5gnbiot_generic_read (c5gnbiot_t *ctx, char *data_buf, uint16_t max_len)
	5G NB IoT data reading function.
void	c5gnbiot_power_on (c5gnbiot_t *ctx)
	5G NB IoT module power on.
void	c5gnbiot_set_on (c5gnbiot_t *ctx, uint8_t state)
	Sets state of the ON pin.
void	c5gnbiot_set_rts (c5gnbiot_t *ctx, uint8_t state)
	Sets state of the RTS pin.
uint8_t	c5gnbiot_get_cts (c5gnbiot_t *ctx)
	CTS Pin Get function.
void	c5gnbiot_send_cmd (c5gnbiot_t *ctx, char *cmd)
	Send command function.
void	c5gnbiot_send_cmd_with_parameter (c5gnbiot_t *ctx, char *at_cmd_buf, char *param_buf)
	Send command function with parameter.
void	c5gnbiot_send_cmd_check (c5gnbiot_t *ctx, char *at_cmd_buf)
	Check the sent command.
void	c5gnbiot_send_cmd_parameter_check (c5gnbiot_t *ctx, char *at_cmd_buf)
	Check the command parameters.
void	c5gnbiot_set_sim_apn (c5gnbiot_t *ctx, char *sim_apn)
	Set sim card APN.
err_t	c5gnbiot_send_text_message (c5gnbiot_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
	5G NB IoT send SMS in PDU mode.

Detailed Description

This file contains API for 5G NB IoT Click driver.