gsm4  2.0.0.0
Functions
Public function

Functions

void gsm4_cfg_setup (gsm4_cfg_t *cfg)
 Config Object Initialization function. More...
 
GSM4_RETVAL gsm4_init (gsm4_t *ctx, gsm4_cfg_t *cfg)
 Initialization function. More...
 
void gsm4_module_power (gsm4_t *ctx)
 Enables or disables module power. More...
 
void gsm4_reset (gsm4_t *ctx)
 Reset module. More...
 
void gsm4_generic_write (gsm4_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int16_t gsm4_generic_read (gsm4_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
void gsm4_send_command (gsm4_t *ctx, char *command)
 Command function. More...
 

Detailed Description

Function Documentation

◆ gsm4_cfg_setup()

void gsm4_cfg_setup ( gsm4_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ gsm4_generic_read()

int16_t gsm4_generic_read ( gsm4_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Generic read function.

Parameters
ctxClick object.
data_bufData buff to be written.
max_lenMax number of the bytes in data buf.

@description This function reads data from the desired register.

◆ gsm4_generic_write()

void gsm4_generic_write ( gsm4_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

Parameters
ctxClick object.
data_bufData buff to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ gsm4_init()

GSM4_RETVAL gsm4_init ( gsm4_t ctx,
gsm4_cfg_t cfg 
)

Initialization function.

Parameters
gsm4Click object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ gsm4_module_power()

void gsm4_module_power ( gsm4_t ctx)

Enables or disables module power.

Parameters
ctxClick object.

@description This function Turn ON or OFF the module.

◆ gsm4_reset()

void gsm4_reset ( gsm4_t ctx)

Reset module.

Parameters
ctxClick object.

@description This function reset module.

◆ gsm4_send_command()

void gsm4_send_command ( gsm4_t ctx,
char *  command 
)

Command function.

Parameters
ctxClick object.
commandCommand.

@description This function send comamnd.