c3gaa  2.0.0.0
Modules | Functions
3G-AA Click Driver

API for configuring and manipulating 3G-AA Click driver. More...

Modules

 3G-AA Device Settings
 Settings for registers of 3G-AA Click driver.
 
 3G-AA MikroBUS Map
 MikroBUS pin mapping of 3G-AA Click driver.
 

Functions

void c3gaa_cfg_setup (c3gaa_cfg_t *cfg)
 3G-AA configuration object setup function. More...
 
err_t c3gaa_init (c3gaa_t *ctx, c3gaa_cfg_t *cfg)
 3G-AA initialization function. More...
 
void c3gaa_module_power (c3gaa_t *ctx, uint8_t state)
 Power ON/OFF the module. More...
 
err_t c3gaa_generic_write (c3gaa_t *ctx, char *data_buf, uint16_t len)
 3G-AA data writing function. More...
 
err_t c3gaa_generic_read (c3gaa_t *ctx, char *data_buf, uint16_t max_len)
 3G-AA data reading function. More...
 
void c3gaa_set_rts_pin (c3gaa_t *ctx, uint8_t state)
 Sets state of the RTS pin. More...
 
void c3gaa_set_pwk_pin (c3gaa_t *ctx, uint8_t state)
 Sets state of the PWK pin. More...
 
uint8_t c3gaa_get_cts_pin (c3gaa_t *ctx)
 CTS Pin Get function. More...
 
uint8_t c3gaa_get_sta_pin (c3gaa_t *ctx)
 STA Pin Get function. More...
 
uint8_t c3gaa_get_ring_pin (c3gaa_t *ctx)
 RING Pin Get function. More...
 
void c3gaa_send_cmd (c3gaa_t *ctx, char *cmd)
 Send command function. More...
 
void c3gaa_send_cmd_with_parameter (c3gaa_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command function with parameter. More...
 
void c3gaa_send_cmd_check (c3gaa_t *ctx, char *at_cmd_buf)
 Check the sent command. More...
 
void c3gaa_send_cmd_parameter_check (c3gaa_t *ctx, char *at_cmd_buf)
 Check the command parameters. More...
 
void c3gaa_set_sim_apn (c3gaa_t *ctx, char *sim_apn)
 Set sim card APN. More...
 
void c3gaa_send_sms_text (c3gaa_t *ctx, char *phone_number, char *sms_text)
 3G-AA send SMS in text mode. More...
 
err_t c3gaa_send_sms_pdu (c3gaa_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
 3G-AA send SMS in PDU mode. More...
 

Detailed Description

API for configuring and manipulating 3G-AA Click driver.

Function Documentation

◆ c3gaa_cfg_setup()

void c3gaa_cfg_setup ( c3gaa_cfg_t cfg)

3G-AA configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ c3gaa_generic_read()

err_t c3gaa_generic_read ( c3gaa_t ctx,
char *  data_buf,
uint16_t  max_len 
)

3G-AA data reading function.

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

Parameters
[in]ctx: Click context object. See c3gaa_t object definition for detailed explanation.
[out]data_buf: Output read data.
[in]max_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.

◆ c3gaa_generic_write()

err_t c3gaa_generic_write ( c3gaa_t ctx,
char *  data_buf,
uint16_t  len 
)

3G-AA data writing function.

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

Parameters
[in]ctx: Click context object. See c3gaa_t object definition for detailed explanation.
[in]data_buf: 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.

◆ c3gaa_get_cts_pin()

uint8_t c3gaa_get_cts_pin ( c3gaa_t ctx)

CTS Pin Get function.

This function allows user to check state of the CTS pin.

Parameters
[in]ctx: Click context object. See c3gaa_t object definition for detailed explanation.
Returns
  • 0 logical low.
  • 1 logical high.
Note
None.

◆ c3gaa_get_ring_pin()

uint8_t c3gaa_get_ring_pin ( c3gaa_t ctx)

RING Pin Get function.

This function allows user to check state of the RING pin.

Parameters
[in]ctx: Click context object. See c3gaa_t object definition for detailed explanation.
Returns
  • 0 logical low.
  • 1 logical high.
Note
None.

◆ c3gaa_get_sta_pin()

uint8_t c3gaa_get_sta_pin ( c3gaa_t ctx)

STA Pin Get function.

This function allows user to check state of the STA pin.

Parameters
[in]ctx: Click context object. See c3gaa_t object definition for detailed explanation.
Returns
  • 0 logical low.
  • 1 logical high.
Note
None.

◆ c3gaa_init()

err_t c3gaa_init ( c3gaa_t ctx,
c3gaa_cfg_t cfg 
)

3G-AA initialization function.

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

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

◆ c3gaa_module_power()

void c3gaa_module_power ( c3gaa_t ctx,
uint8_t  state 
)

Power ON/OFF the module.

This function powers ON/OFF the module.

Parameters
ctxClick object.
state0 - power OFF, 1 - power ON.
Returns
Nothing.
None.

◆ c3gaa_send_cmd()

void c3gaa_send_cmd ( c3gaa_t ctx,
char *  cmd 
)

Send command function.

This function sends a specified command to the click module.

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

◆ c3gaa_send_cmd_check()

void c3gaa_send_cmd_check ( c3gaa_t ctx,
char *  at_cmd_buf 
)

Check the sent command.

This function checks the command that is sent.

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

◆ c3gaa_send_cmd_parameter_check()

void c3gaa_send_cmd_parameter_check ( c3gaa_t ctx,
char *  at_cmd_buf 
)

Check the command parameters.

This function checks the command that is sent.

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

◆ c3gaa_send_cmd_with_parameter()

void c3gaa_send_cmd_with_parameter ( c3gaa_t ctx,
char *  at_cmd_buf,
char *  param_buf 
)

Send command function with parameter.

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

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

◆ c3gaa_send_sms_pdu()

err_t c3gaa_send_sms_pdu ( c3gaa_t ctx,
char *  service_center_number,
char *  phone_number,
char *  sms_text 
)

3G-AA send SMS in PDU mode.

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

Parameters
[in]ctx: Click context object. See c3gaa_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.

◆ c3gaa_send_sms_text()

void c3gaa_send_sms_text ( c3gaa_t ctx,
char *  phone_number,
char *  sms_text 
)

3G-AA send SMS in text mode.

This function sends text message to a phone number.

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

◆ c3gaa_set_pwk_pin()

void c3gaa_set_pwk_pin ( c3gaa_t ctx,
uint8_t  state 
)

Sets state of the PWK pin.

This function sets PWK pin state.

Parameters
[in]ctx: Click context object. See c3gaa_t object definition for detailed explanation.
[in]statePin state ( 1 or 0 ).
Returns
Nothing.
Note
None.

◆ c3gaa_set_rts_pin()

void c3gaa_set_rts_pin ( c3gaa_t ctx,
uint8_t  state 
)

Sets state of the RTS pin.

This function sets RTS pin state.

Parameters
[in]ctx: Click context object. See c3gaa_t object definition for detailed explanation.
[in]statePin state ( 1 or 0 ).
Returns
Nothing.
Note
None.

◆ c3gaa_set_sim_apn()

void c3gaa_set_sim_apn ( c3gaa_t ctx,
char *  sim_apn 
)

Set sim card APN.

This function sets APN for sim card.

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