c4glte2voice.h File Reference

This file contains API for 4G LTE 2 Voice 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	c4glte2voice_t
	4G LTE 2 Voice Click context object. More...
struct	c4glte2voice_cfg_t
	4G LTE 2 Voice Click configuration object. More...

Macros
#define	C4GLTE2VOICE_CMD_AT   "AT"
	4G LTE 2 Voice control commands.
#define	C4GLTE2VOICE_CMD_ATI   "ATI"
#define	C4GLTE2VOICE_CMD_CGMR   "AT+CGMR"
#define	C4GLTE2VOICE_CMD_CFUN   "AT+CFUN"
#define	C4GLTE2VOICE_CMD_CREG   "AT+CREG"
#define	C4GLTE2VOICE_CMD_CGREG   "AT+CGREG"
#define	C4GLTE2VOICE_CMD_CGDCONT   "AT+CGDCONT"
#define	C4GLTE2VOICE_CMD_CIMI   "AT+CIMI"
#define	C4GLTE2VOICE_CMD_CMEE   "AT+CMEE"
#define	C4GLTE2VOICE_CMD_CGATT   "AT+CGATT"
#define	C4GLTE2VOICE_CMD_CSQ   "AT+CSQ"
#define	C4GLTE2VOICE_CMD_COPS   "AT+COPS"
#define	C4GLTE2VOICE_CMD_CMGS   "AT+CMGS"
#define	C4GLTE2VOICE_CMD_CMGF   "AT+CMGF"
#define	C4GLTE2VOICE_CMD_CGACT   "AT+CGACT"
#define	C4GLTE2VOICE_CMD_USOCR   "AT+USOCR"
#define	C4GLTE2VOICE_CMD_USOCO   "AT+USOCO"
#define	C4GLTE2VOICE_CMD_USOWR   "AT+USOWR"
#define	C4GLTE2VOICE_CMD_USOST   "AT+USOST"
#define	C4GLTE2VOICE_CMD_USORD   "AT+USORD"
#define	C4GLTE2VOICE_CMD_USORF   "AT+USORF"
#define	C4GLTE2VOICE_CMD_USOCL   "AT+USOCL"
#define	C4GLTE2VOICE_CMD_UGPS   "AT+UGPS"
#define	C4GLTE2VOICE_CMD_UGGGA   "AT+UGGGA"
#define	C4GLTE2VOICE_RSP_OK   "OK"
	4G LTE 2 Voice device response for AT commands.
#define	C4GLTE2VOICE_RSP_ERROR   "ERROR"
#define	C4GLTE2VOICE_POWER_STATE_OFF   0
	4G LTE 2 Voice power state settings.
#define	C4GLTE2VOICE_POWER_STATE_ON   1
#define	DRV_BUFFER_SIZE   256
	4G LTE 2 Voice driver buffer size.
#define	C4GLTE2VOICE_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	c4glte2voice_return_value_t {   C4GLTE2VOICE_OK = 0 , C4GLTE2VOICE_ERROR = -1 , C4GLTE2VOICE_ERROR_TIMEOUT = -2 , C4GLTE2VOICE_ERROR_CMD = -3 ,   C4GLTE2VOICE_ERROR_UNKNOWN = -4 }
	4G LTE 2 Voice Click return value data. More...

Functions
void	c4glte2voice_cfg_setup (c4glte2voice_cfg_t *cfg)
	4G LTE 2 Voice configuration object setup function.
err_t	c4glte2voice_init (c4glte2voice_t *ctx, c4glte2voice_cfg_t *cfg)
	4G LTE 2 Voice initialization function.
err_t	c4glte2voice_generic_write (c4glte2voice_t *ctx, char *data_in, uint16_t len)
	4G LTE 2 Voice data writing function.
err_t	c4glte2voice_generic_read (c4glte2voice_t *ctx, char *data_out, uint16_t len)
	4G LTE 2 Voice data reading function.
void	c4glte2voice_set_pwr_pin (c4glte2voice_t *ctx, uint8_t state)
	4G LTE 2 Voice set PWR pin function.
void	c4glte2voice_set_sts_pin (c4glte2voice_t *ctx, uint8_t state)
	4G LTE 2 Voice set STS pin function.
void	c4glte2voice_set_rts_pin (c4glte2voice_t *ctx, uint8_t state)
	4G LTE 2 Voice set RTS pin function.
uint8_t	c4glte2voice_get_ri_pin (c4glte2voice_t *ctx)
	4G LTE 2 Voice get RI pin function.
uint8_t	c4glte2voice_get_cts_pin (c4glte2voice_t *ctx)
	4G LTE 2 Voice get CTS pin function.
void	c4glte2voice_set_power_state (c4glte2voice_t *ctx, uint8_t state)
	4G LTE 2 Voice set power state function.
void	c4glte2voice_send_cmd (c4glte2voice_t *ctx, char *cmd)
	Send command function.
void	c4glte2voice_send_cmd_with_parameter (c4glte2voice_t *ctx, char *at_cmd_buf, char *param_buf)
	Send command function with parameter.
void	c4glte2voice_send_cmd_check (c4glte2voice_t *ctx, char *at_cmd_buf)
	Check the sent command.
void	c4glte2voice_send_cmd_parameter_check (c4glte2voice_t *ctx, char *at_cmd_buf)
	Check the command parameters.
void	c4glte2voice_set_sim_apn (c4glte2voice_t *ctx, char *sim_apn)
	Set sim card APN.
void	c4glte2voice_send_sms_text (c4glte2voice_t *ctx, char *phone_number, char *sms_text)
	4G LTE 2 Voice send SMS in text mode.
err_t	c4glte2voice_send_sms_pdu (c4glte2voice_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
	4G LTE 2 Voice send SMS in PDU mode.

Detailed Description

This file contains API for 4G LTE 2 Voice Click Driver.

Enumeration Type Documentation

c4glte2voice_return_value_t

enum c4glte2voice_return_value_t

4G LTE 2 Voice Click return value data.

Predefined enum values for driver return values.

Enumerator
C4GLTE2VOICE_OK
C4GLTE2VOICE_ERROR
C4GLTE2VOICE_ERROR_TIMEOUT
C4GLTE2VOICE_ERROR_CMD
C4GLTE2VOICE_ERROR_UNKNOWN