c4glte2datana  2.1.0.0
Modules | Functions
4G LTE 2 Data-NA Click Driver

API for configuring and manipulating 4G LTE 2 Data-NA Click driver. More...

Modules

 4G LTE 2 Data-NA Device Settings
 Settings for registers of 4G LTE 2 Data-NA Click driver.
 
 4G LTE 2 Data-NA MikroBUS Map
 MikroBUS pin mapping of 4G LTE 2 Data-NA Click driver.
 

Functions

void c4glte2datana_cfg_setup (c4glte2datana_cfg_t *cfg)
 4G LTE 2 Data-NA configuration object setup function. More...
 
err_t c4glte2datana_init (c4glte2datana_t *ctx, c4glte2datana_cfg_t *cfg)
 4G LTE 2 Data-NA initialization function. More...
 
err_t c4glte2datana_generic_write (c4glte2datana_t *ctx, char *data_in, uint16_t len)
 4G LTE 2 Data-NA data writing function. More...
 
err_t c4glte2datana_generic_read (c4glte2datana_t *ctx, char *data_out, uint16_t len)
 4G LTE 2 Data-NA data reading function. More...
 
void c4glte2datana_set_pwr_pin (c4glte2datana_t *ctx, uint8_t state)
 4G LTE 2 Data-NA set PWR pin function. More...
 
void c4glte2datana_set_sts_pin (c4glte2datana_t *ctx, uint8_t state)
 4G LTE 2 Data-NA set STS pin function. More...
 
void c4glte2datana_set_rts_pin (c4glte2datana_t *ctx, uint8_t state)
 4G LTE 2 Data-NA set RTS pin function. More...
 
uint8_t c4glte2datana_get_ri_pin (c4glte2datana_t *ctx)
 4G LTE 2 Data-NA get RI pin function. More...
 
uint8_t c4glte2datana_get_cts_pin (c4glte2datana_t *ctx)
 4G LTE 2 Data-NA get CTS pin function. More...
 
void c4glte2datana_set_power_state (c4glte2datana_t *ctx, uint8_t state)
 4G LTE 2 Data-NA set power state function. More...
 
void c4glte2datana_send_cmd (c4glte2datana_t *ctx, char *cmd)
 Send command function. More...
 
void c4glte2datana_send_cmd_with_parameter (c4glte2datana_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command function with parameter. More...
 
void c4glte2datana_send_cmd_check (c4glte2datana_t *ctx, char *at_cmd_buf)
 Check the sent command. More...
 
void c4glte2datana_send_cmd_parameter_check (c4glte2datana_t *ctx, char *at_cmd_buf)
 Check the command parameters. More...
 
void c4glte2datana_set_sim_apn (c4glte2datana_t *ctx, char *sim_apn)
 Set sim card APN. More...
 
void c4glte2datana_send_sms_text (c4glte2datana_t *ctx, char *phone_number, char *sms_text)
 4G LTE 2 Data-NA send SMS in text mode. More...
 
err_t c4glte2datana_send_sms_pdu (c4glte2datana_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
 4G LTE 2 Data-NA send SMS in PDU mode. More...
 

Detailed Description

API for configuring and manipulating 4G LTE 2 Data-NA 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

◆ c4glte2datana_cfg_setup()

void c4glte2datana_cfg_setup ( c4glte2datana_cfg_t cfg)

4G LTE 2 Data-NA configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ c4glte2datana_generic_read()

err_t c4glte2datana_generic_read ( c4glte2datana_t ctx,
char *  data_out,
uint16_t  len 
)

4G LTE 2 Data-NA data reading function.

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

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

◆ c4glte2datana_generic_write()

err_t c4glte2datana_generic_write ( c4glte2datana_t ctx,
char *  data_in,
uint16_t  len 
)

4G LTE 2 Data-NA data writing function.

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

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

◆ c4glte2datana_get_cts_pin()

uint8_t c4glte2datana_get_cts_pin ( c4glte2datana_t ctx)

4G LTE 2 Data-NA get CTS pin function.

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

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

◆ c4glte2datana_get_ri_pin()

uint8_t c4glte2datana_get_ri_pin ( c4glte2datana_t ctx)

4G LTE 2 Data-NA get RI pin function.

This function returns the ring indication (RI) pin logic state.

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

◆ c4glte2datana_init()

err_t c4glte2datana_init ( c4glte2datana_t ctx,
c4glte2datana_cfg_t cfg 
)

4G LTE 2 Data-NA initialization function.

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

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

◆ c4glte2datana_send_cmd()

void c4glte2datana_send_cmd ( c4glte2datana_t ctx,
char *  cmd 
)

Send command function.

This function sends a specified command to the Click module.

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

◆ c4glte2datana_send_cmd_check()

void c4glte2datana_send_cmd_check ( c4glte2datana_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 c4glte2datana_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
Returns
Nothing.
Note
None.

◆ c4glte2datana_send_cmd_parameter_check()

void c4glte2datana_send_cmd_parameter_check ( c4glte2datana_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 c4glte2datana_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
Returns
Nothing.
Note
None.

◆ c4glte2datana_send_cmd_with_parameter()

void c4glte2datana_send_cmd_with_parameter ( c4glte2datana_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 c4glte2datana_t object definition for detailed explanation.
[in]at_cmd_bufCommand buffer.
[in]param_bufParameter buffer.
Returns
Nothing.
Note
None.

◆ c4glte2datana_send_sms_pdu()

err_t c4glte2datana_send_sms_pdu ( c4glte2datana_t ctx,
char *  service_center_number,
char *  phone_number,
char *  sms_text 
)

4G LTE 2 Data-NA send SMS in PDU mode.

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

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

◆ c4glte2datana_send_sms_text()

void c4glte2datana_send_sms_text ( c4glte2datana_t ctx,
char *  phone_number,
char *  sms_text 
)

4G LTE 2 Data-NA send SMS in text mode.

This function sends text message to a phone number.

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

◆ c4glte2datana_set_power_state()

void c4glte2datana_set_power_state ( c4glte2datana_t ctx,
uint8_t  state 
)

4G LTE 2 Data-NA set power state function.

This function sets a desired power state by toggling PWR pin with a specific time for high state.

Parameters
[in]ctx: Click context object. See c4glte2datana_t object definition for detailed explanation.
[in]state:
  • 0 - Power OFF,
  • 1 - Power ON.
Returns
None.
Note
None.

◆ c4glte2datana_set_pwr_pin()

void c4glte2datana_set_pwr_pin ( c4glte2datana_t ctx,
uint8_t  state 
)

4G LTE 2 Data-NA set PWR pin function.

This function sets the PWR pin logic state.

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

◆ c4glte2datana_set_rts_pin()

void c4glte2datana_set_rts_pin ( c4glte2datana_t ctx,
uint8_t  state 
)

4G LTE 2 Data-NA set RTS pin function.

This function sets the ready to send (RTS) pin logic state.

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

◆ c4glte2datana_set_sim_apn()

void c4glte2datana_set_sim_apn ( c4glte2datana_t ctx,
char *  sim_apn 
)

Set sim card APN.

This function sets APN for sim card.

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

◆ c4glte2datana_set_sts_pin()

void c4glte2datana_set_sts_pin ( c4glte2datana_t ctx,
uint8_t  state 
)

4G LTE 2 Data-NA set STS pin function.

This function sets the GNSS supply enable (STS) pin logic state.

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