ltecat13aux  2.1.0.0
Modules | Functions
LTE Cat.1 3 AUX Click Driver

API for configuring and manipulating LTE Cat.1 3 AUX Click driver. More...

Modules

 LTE Cat.1 3 AUX Device Settings
 Settings for registers of LTE Cat.1 3 AUX Click driver.
 
 LTE Cat.1 3 AUX MikroBUS Map
 MikroBUS pin mapping of LTE Cat.1 3 AUX Click driver.
 

Functions

void ltecat13aux_cfg_setup (ltecat13aux_cfg_t *cfg)
 LTE Cat.1 3 AUX configuration object setup function. More...
 
err_t ltecat13aux_init (ltecat13aux_t *ctx, ltecat13aux_cfg_t *cfg)
 LTE Cat.1 3 AUX initialization function. More...
 
err_t ltecat13aux_generic_write (ltecat13aux_t *ctx, uint8_t *data_in, uint16_t len)
 LTE Cat.1 3 AUX data writing function. More...
 
err_t ltecat13aux_generic_read (ltecat13aux_t *ctx, uint8_t *data_out, uint16_t len)
 LTE Cat.1 3 AUX data reading function. More...
 
void ltecat13aux_start_up (ltecat13aux_t *ctx)
 LTE Cat.1 3 AUX start up function. More...
 
void ltecat13aux_set_pwr_pin (ltecat13aux_t *ctx, uint8_t pin_state)
 LTE Cat.1 3 AUX set PWR pin function. More...
 
void ltecat13aux_set_rts_pin (ltecat13aux_t *ctx, uint8_t pin_state)
 LTE Cat.1 3 AUX set RST pin function. More...
 
uint8_t ltecat13aux_get_ri_pin (ltecat13aux_t *ctx)
 LTE Cat.1 3 AUX get RI pin function. More...
 
uint8_t ltecat13aux_get_cts_pin (ltecat13aux_t *ctx)
 LTE Cat.1 3 AUX get cts pin function. More...
 
err_t ltecat13aux_write_register (ltecat13aux_t *ctx, uint8_t reg, uint8_t data_in)
 LTE Cat.1 3 AUX MAX9860 writing function. More...
 
err_t ltecat13aux_read_register (ltecat13aux_t *ctx, uint8_t reg, uint8_t *data_out)
 LTE Cat.1 3 AUX MAX9860 reading function. More...
 
err_t ltecat13aux_max9860_cfg (ltecat13aux_t *ctx)
 LTE Cat.1 3 AUX MAX9860 configuration function. More...
 
void ltecat13aux_send_cmd (ltecat13aux_t *ctx, uint8_t *cmd)
 LTE Cat.1 3 AUX send command function. More...
 
void ltecat13aux_send_cmd_with_params (ltecat13aux_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 LTE Cat.1 3 AUX send command function with parameter. More...
 
void ltecat13aux_send_cmd_check (ltecat13aux_t *ctx, uint8_t *at_cmd_buf)
 LTE Cat.1 3 AUX check the sent command. More...
 
void ltecat13aux_send_cmd_param_check (ltecat13aux_t *ctx, uint8_t *at_cmd_buf)
 LTE Cat.1 3 AUX check the command parameters. More...
 
void ltecat13aux_set_sim_apn (ltecat13aux_t *ctx, uint8_t *sim_apn)
 LTE Cat.1 3 AUX set sim card APN. More...
 
void ltecat13aux_send_sms_text (ltecat13aux_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 LTE Cat.1 3 AUX send SMS in text mode. More...
 
err_t ltecat13aux_send_sms_pdu (ltecat13aux_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 LTE Cat.1 3 AUX send SMS in PDU mode. More...
 
err_t ltecat13aux_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data)
 LTE Cat.1 parse GPGGA function. More...
 

Detailed Description

API for configuring and manipulating LTE Cat.1 3 AUX Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ ltecat13aux_cfg_setup()

void ltecat13aux_cfg_setup ( ltecat13aux_cfg_t cfg)

LTE Cat.1 3 AUX configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See ltecat13aux_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ ltecat13aux_generic_read()

err_t ltecat13aux_generic_read ( ltecat13aux_t ctx,
uint8_t *  data_out,
uint16_t  len 
)

LTE Cat.1 3 AUX data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat13aux_generic_write()

err_t ltecat13aux_generic_write ( ltecat13aux_t ctx,
uint8_t *  data_in,
uint16_t  len 
)

LTE Cat.1 3 AUX data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]data_in: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat13aux_get_cts_pin()

uint8_t ltecat13aux_get_cts_pin ( ltecat13aux_t ctx)

LTE Cat.1 3 AUX get cts pin function.

This function returns the clear to send (CTS) pin logic state.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ ltecat13aux_get_ri_pin()

uint8_t ltecat13aux_get_ri_pin ( ltecat13aux_t ctx)

LTE Cat.1 3 AUX get RI pin function.

This function returns the RI pin logic state.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ ltecat13aux_init()

err_t ltecat13aux_init ( ltecat13aux_t ctx,
ltecat13aux_cfg_t cfg 
)

LTE Cat.1 3 AUX initialization function.

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

Parameters
[out]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See ltecat13aux_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat13aux_max9860_cfg()

err_t ltecat13aux_max9860_cfg ( ltecat13aux_t ctx)

LTE Cat.1 3 AUX MAX9860 configuration function.

This function is used to set basic config for MAX9860 of LTE Cat.1 3 AUX click board.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
Some gain levels need to be configured for different headphones.

◆ ltecat13aux_parse_gpgga()

err_t ltecat13aux_parse_gpgga ( char *  rsp_buf,
uint8_t  gpgga_element,
char *  element_data 
)

LTE Cat.1 parse GPGGA function.

This function parses the GPGGA data from the read response buffer.

Parameters
[in]rsp_buf: Response buffer.
[in]gpgga_element: GPGGA element position [1-14].
[out]element_data: Element data parsed.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat13aux_read_register()

err_t ltecat13aux_read_register ( ltecat13aux_t ctx,
uint8_t  reg,
uint8_t *  data_out 
)

LTE Cat.1 3 AUX MAX9860 reading function.

This function reads a data byte from the selected register address.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]reg: Register address.
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat13aux_send_cmd()

void ltecat13aux_send_cmd ( ltecat13aux_t ctx,
uint8_t *  cmd 
)

LTE Cat.1 3 AUX send command function.

This function sends a specified command to the click module.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]cmdCommand variable.
Returns
Nothing.
Note
None.

◆ ltecat13aux_send_cmd_check()

void ltecat13aux_send_cmd_check ( ltecat13aux_t ctx,
uint8_t *  at_cmd_buf 
)

LTE Cat.1 3 AUX check the sent command.

This function checks the command that is sent.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
Returns
Nothing.
Note
None.

◆ ltecat13aux_send_cmd_param_check()

void ltecat13aux_send_cmd_param_check ( ltecat13aux_t ctx,
uint8_t *  at_cmd_buf 
)

LTE Cat.1 3 AUX check the command parameters.

This function checks the command that is sent.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
Returns
Nothing.
Note
None.

◆ ltecat13aux_send_cmd_with_params()

void ltecat13aux_send_cmd_with_params ( ltecat13aux_t ctx,
uint8_t *  at_cmd_buf,
uint8_t *  param_buf 
)

LTE Cat.1 3 AUX send command function with parameter.

This function sends a command with specified parameter to the click module.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
[in]param_bufParameter buffer.
Returns
Nothing.
Note
None.

◆ ltecat13aux_send_sms_pdu()

err_t ltecat13aux_send_sms_pdu ( ltecat13aux_t ctx,
uint8_t *  service_center_number,
uint8_t *  phone_number,
uint8_t *  sms_text 
)

LTE Cat.1 3 AUX send SMS in PDU mode.

This function sends text message to a phone number in PDU mode.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]service_center_numberSMSC of the SIM card.
[in]phone_numberPhone number to message.
[in]sms_textMessage to be sent.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ltecat13aux_send_sms_text()

void ltecat13aux_send_sms_text ( ltecat13aux_t ctx,
uint8_t *  phone_number,
uint8_t *  sms_text 
)

LTE Cat.1 3 AUX send SMS in text mode.

This function sends text message to a phone number.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]phone_numberPhone number to message.
[in]sms_textMessage to be sent.
Returns
Nothing.
Note
None.

◆ ltecat13aux_set_pwr_pin()

void ltecat13aux_set_pwr_pin ( ltecat13aux_t ctx,
uint8_t  pin_state 
)

LTE Cat.1 3 AUX set PWR pin function.

This function sets the PWR pin logic state.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]pin_state: Pin logic state.
Returns
None.
Note
None.

◆ ltecat13aux_set_rts_pin()

void ltecat13aux_set_rts_pin ( ltecat13aux_t ctx,
uint8_t  pin_state 
)

LTE Cat.1 3 AUX set RST pin function.

This function sets the RST pin logic state.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]pin_state: Pin logic state.
Returns
None.
Note
None.

◆ ltecat13aux_set_sim_apn()

void ltecat13aux_set_sim_apn ( ltecat13aux_t ctx,
uint8_t *  sim_apn 
)

LTE Cat.1 3 AUX set sim card APN.

This function sets APN for sim card.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]sim_apnSIM card APN.
Returns
Nothing.
Note
None.

◆ ltecat13aux_start_up()

void ltecat13aux_start_up ( ltecat13aux_t ctx)

LTE Cat.1 3 AUX start up function.

This function is used to start device.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]pin_state: Pin logic state.
Returns
None.
Note
None.

◆ ltecat13aux_write_register()

err_t ltecat13aux_write_register ( ltecat13aux_t ctx,
uint8_t  reg,
uint8_t  data_in 
)

LTE Cat.1 3 AUX MAX9860 writing function.

This function writes a data byte into the selected register address.

Parameters
[in]ctx: Click context object. See ltecat13aux_t object definition for detailed explanation.
[in]reg: Register address.
[in]data_in: Data buffer for sending.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.