lteiot7  2.1.0.0
Modules | Functions
LTE IoT 7 Click Driver

API for configuring and manipulating LTE IoT 7 Click driver. More...

Modules

 LTE IoT 7 Device Settings
 Settings for registers of LTE IoT 7 Click driver.
 
 LTE IoT 7 MikroBUS Map
 MikroBUS pin mapping of LTE IoT 7 Click driver.
 

Functions

void lteiot7_cfg_setup (lteiot7_cfg_t *cfg)
 LTE IoT 7 configuration object setup function. More...
 
err_t lteiot7_init (lteiot7_t *ctx, lteiot7_cfg_t *cfg)
 LTE IoT 7 initialization function. More...
 
err_t lteiot7_generic_write (lteiot7_t *ctx, char *data_in, uint16_t len)
 LTE IoT 7 data writing function. More...
 
err_t lteiot7_generic_read (lteiot7_t *ctx, char *data_out, uint16_t len)
 LTE IoT 7 data reading function. More...
 
void lteiot7_set_pwr_pin (lteiot7_t *ctx, uint8_t state)
 LTE IoT 7 set PWR pin function. More...
 
void lteiot7_set_ein_pin (lteiot7_t *ctx, uint8_t state)
 LTE IoT 7 set EIN pin function. More...
 
void lteiot7_set_rts_pin (lteiot7_t *ctx, uint8_t state)
 LTE IoT 7 set RTS pin function. More...
 
uint8_t lteiot7_get_ri_pin (lteiot7_t *ctx)
 LTE IoT 7 get RI pin function. More...
 
uint8_t lteiot7_get_cts_pin (lteiot7_t *ctx)
 LTE IoT 7 get CTS pin function. More...
 
void lteiot7_set_power_state (lteiot7_t *ctx, uint8_t state)
 LTE IoT 7 set power state function. More...
 
void lteiot7_send_cmd (lteiot7_t *ctx, char *cmd)
 Send command function. More...
 
void lteiot7_send_cmd_with_parameter (lteiot7_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command function with parameter. More...
 
void lteiot7_send_cmd_check (lteiot7_t *ctx, char *at_cmd_buf)
 Check the sent command. More...
 
void lteiot7_send_cmd_parameter_check (lteiot7_t *ctx, char *at_cmd_buf)
 Check the command parameters. More...
 
void lteiot7_set_sim_apn (lteiot7_t *ctx, char *sim_apn)
 Set sim card APN. More...
 
void lteiot7_send_sms_text (lteiot7_t *ctx, char *phone_number, char *sms_text)
 LTE IoT 7 send SMS in text mode. More...
 
err_t lteiot7_send_sms_pdu (lteiot7_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
 LTE IoT 7 send SMS in PDU mode. More...
 
err_t lteiot7_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data)
 LTE IoT 7 parse GPGGA function. More...
 

Detailed Description

API for configuring and manipulating LTE IoT 7 Click driver.

Function Documentation

◆ lteiot7_cfg_setup()

void lteiot7_cfg_setup ( lteiot7_cfg_t cfg)

LTE IoT 7 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ lteiot7_generic_read()

err_t lteiot7_generic_read ( lteiot7_t ctx,
char *  data_out,
uint16_t  len 
)

LTE IoT 7 data reading function.

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

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

◆ lteiot7_generic_write()

err_t lteiot7_generic_write ( lteiot7_t ctx,
char *  data_in,
uint16_t  len 
)

LTE IoT 7 data writing function.

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

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

◆ lteiot7_get_cts_pin()

uint8_t lteiot7_get_cts_pin ( lteiot7_t ctx)

LTE IoT 7 get CTS pin function.

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

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

◆ lteiot7_get_ri_pin()

uint8_t lteiot7_get_ri_pin ( lteiot7_t ctx)

LTE IoT 7 get RI pin function.

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

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

◆ lteiot7_init()

err_t lteiot7_init ( lteiot7_t ctx,
lteiot7_cfg_t cfg 
)

LTE IoT 7 initialization function.

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

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

◆ lteiot7_parse_gpgga()

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

LTE IoT 7 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.

◆ lteiot7_send_cmd()

void lteiot7_send_cmd ( lteiot7_t ctx,
char *  cmd 
)

Send command function.

This function sends a specified command to the click module.

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

◆ lteiot7_send_cmd_check()

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

◆ lteiot7_send_cmd_parameter_check()

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

◆ lteiot7_send_cmd_with_parameter()

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

◆ lteiot7_send_sms_pdu()

err_t lteiot7_send_sms_pdu ( lteiot7_t ctx,
char *  service_center_number,
char *  phone_number,
char *  sms_text 
)

LTE IoT 7 send SMS in PDU mode.

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

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

◆ lteiot7_send_sms_text()

void lteiot7_send_sms_text ( lteiot7_t ctx,
char *  phone_number,
char *  sms_text 
)

LTE IoT 7 send SMS in text mode.

This function sends text message to a phone number.

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

◆ lteiot7_set_ein_pin()

void lteiot7_set_ein_pin ( lteiot7_t ctx,
uint8_t  state 
)

LTE IoT 7 set EIN pin function.

This function sets the EXTINT pin logic state.

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

◆ lteiot7_set_power_state()

void lteiot7_set_power_state ( lteiot7_t ctx,
uint8_t  state 
)

LTE IoT 7 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 lteiot7_t object definition for detailed explanation.
[in]state:
  • 0 - Switch power state,
  • 1 - Power ON.
  • 2 - Reboot.
Returns
None.
Note
None.

◆ lteiot7_set_pwr_pin()

void lteiot7_set_pwr_pin ( lteiot7_t ctx,
uint8_t  state 
)

LTE IoT 7 set PWR pin function.

This function sets the PWR pin logic state.

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

◆ lteiot7_set_rts_pin()

void lteiot7_set_rts_pin ( lteiot7_t ctx,
uint8_t  state 
)

LTE IoT 7 set RTS pin function.

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

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

◆ lteiot7_set_sim_apn()

void lteiot7_set_sim_apn ( lteiot7_t ctx,
char *  sim_apn 
)

Set sim card APN.

This function sets APN for sim card.

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