lteiot12  2.1.0.0
Modules | Functions
LTE IoT 12 Click Driver

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

Modules

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

Functions

void lteiot12_cfg_setup (lteiot12_cfg_t *cfg)
 LTE IoT 12 configuration object setup function. More...
 
err_t lteiot12_init (lteiot12_t *ctx, lteiot12_cfg_t *cfg)
 LTE IoT 12 initialization function. More...
 
err_t lteiot12_generic_write (lteiot12_t *ctx, uint8_t *data_in, uint16_t len)
 LTE IoT 12 data writing function. More...
 
err_t lteiot12_generic_read (lteiot12_t *ctx, uint8_t *data_out, uint16_t len)
 LTE IoT 12 data reading function. More...
 
void lteiot12_set_pwr_pin (lteiot12_t *ctx, uint8_t state)
 LTE IoT 12 set PWR pin function. More...
 
void lteiot12_set_rts_pin (lteiot12_t *ctx, uint8_t state)
 LTE IoT 12 set RTS pin function. More...
 
uint8_t lteiot12_get_sta_pin (lteiot12_t *ctx)
 LTE IoT 12 get STA pin function. More...
 
uint8_t lteiot12_get_ring_pin (lteiot12_t *ctx)
 LTE IoT 12 get RING pin function. More...
 
uint8_t lteiot12_get_cts_pin (lteiot12_t *ctx)
 LTE IoT 12 get CTS pin function. More...
 
void lteiot12_set_power_state (lteiot12_t *ctx, uint8_t state)
 LTE IoT 12 set power state function. More...
 
void lteiot12_cmd_run (lteiot12_t *ctx, uint8_t *cmd)
 LTE IoT 12 cmd run function. More...
 
void lteiot12_cmd_set (lteiot12_t *ctx, uint8_t *cmd, uint8_t *value)
 LTE IoT 12 cmd set function. More...
 
void lteiot12_cmd_get (lteiot12_t *ctx, uint8_t *cmd)
 LTE IoT 12 cmd get function. More...
 
void lteiot12_cmd_help (lteiot12_t *ctx, uint8_t *cmd)
 LTE IoT 12 cmd help function. More...
 
void lteiot12_set_sim_apn (lteiot12_t *ctx, uint8_t *sim_apn)
 LTE IoT 12 set SIM card APN function. More...
 
void lteiot12_send_sms_text (lteiot12_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 LTE IoT 12 send SMS in text mode function. More...
 
err_t lteiot12_send_sms_pdu (lteiot12_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 LTE IoT 12 send SMS in PDU mode function. More...
 
err_t lteiot12_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 LTE IoT 12 parse GGA function. More...
 

Detailed Description

API for configuring and manipulating LTE IoT 12 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

◆ lteiot12_cfg_setup()

void lteiot12_cfg_setup ( lteiot12_cfg_t cfg)

LTE IoT 12 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ lteiot12_cmd_get()

void lteiot12_cmd_get ( lteiot12_t ctx,
uint8_t *  cmd 
)

LTE IoT 12 cmd get function.

This function is used to get the value of a given command from the click module.

Parameters
[in]ctx: Click context object. See lteiot12_t object definition for detailed explanation.
[in]cmd: Command string.
Returns
None.
Note
None.

◆ lteiot12_cmd_help()

void lteiot12_cmd_help ( lteiot12_t ctx,
uint8_t *  cmd 
)

LTE IoT 12 cmd help function.

This function provides a short description of the given command of the click module.

Parameters
[in]ctx: Click context object. See lteiot12_t object definition for detailed explanation.
[in]cmd: Command string.
Returns
None.
Note
None.

◆ lteiot12_cmd_run()

void lteiot12_cmd_run ( lteiot12_t ctx,
uint8_t *  cmd 
)

LTE IoT 12 cmd run function.

This function sends a specified command to the click module.

Parameters
[in]ctx: Click context object. See lteiot12_t object definition for detailed explanation.
[in]cmd: Command string.
Returns
None.
Note
None.

◆ lteiot12_cmd_set()

void lteiot12_cmd_set ( lteiot12_t ctx,
uint8_t *  cmd,
uint8_t *  value 
)

LTE IoT 12 cmd set function.

This function sets a value to a specified command of the click module.

Parameters
[in]ctx: Click context object. See lteiot12_t object definition for detailed explanation.
[in]cmd: Command string.
[in]value: Value string.
Returns
None.
Note
None.

◆ lteiot12_generic_read()

err_t lteiot12_generic_read ( lteiot12_t ctx,
uint8_t *  data_out,
uint16_t  len 
)

LTE IoT 12 data reading function.

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

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

◆ lteiot12_generic_write()

err_t lteiot12_generic_write ( lteiot12_t ctx,
uint8_t *  data_in,
uint16_t  len 
)

LTE IoT 12 data writing function.

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

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

◆ lteiot12_get_cts_pin()

uint8_t lteiot12_get_cts_pin ( lteiot12_t ctx)

LTE IoT 12 get CTS pin function.

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

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

◆ lteiot12_get_ring_pin()

uint8_t lteiot12_get_ring_pin ( lteiot12_t ctx)

LTE IoT 12 get RING pin function.

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

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

◆ lteiot12_get_sta_pin()

uint8_t lteiot12_get_sta_pin ( lteiot12_t ctx)

LTE IoT 12 get STA pin function.

This function returns the module operating status (STA) pin logic state.

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

◆ lteiot12_init()

err_t lteiot12_init ( lteiot12_t ctx,
lteiot12_cfg_t cfg 
)

LTE IoT 12 initialization function.

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

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

◆ lteiot12_parse_gga()

err_t lteiot12_parse_gga ( uint8_t *  rsp_buf,
uint8_t  gga_element,
uint8_t *  element_data 
)

LTE IoT 12 parse GGA function.

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

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

◆ lteiot12_send_sms_pdu()

err_t lteiot12_send_sms_pdu ( lteiot12_t ctx,
uint8_t *  service_center_number,
uint8_t *  phone_number,
uint8_t *  sms_text 
)

LTE IoT 12 send SMS in PDU mode function.

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

Parameters
[in]ctx: Click context object. See lteiot12_t object definition for detailed explanation.
[in]service_center_number: SMSC of the SIM card.
[in]phone_number: Phone number to message.
[in]sms_text: Message to be sent.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ lteiot12_send_sms_text()

void lteiot12_send_sms_text ( lteiot12_t ctx,
uint8_t *  phone_number,
uint8_t *  sms_text 
)

LTE IoT 12 send SMS in text mode function.

This function sends text message to a phone number.

Parameters
[in]ctx: Click context object. See lteiot12_t object definition for detailed explanation.
[in]phone_number: Phone number to message.
[in]sms_text: Message to be sent.
Returns
None.
Note
None.

◆ lteiot12_set_power_state()

void lteiot12_set_power_state ( lteiot12_t ctx,
uint8_t  state 
)

LTE IoT 12 set power state function.

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

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

◆ lteiot12_set_pwr_pin()

void lteiot12_set_pwr_pin ( lteiot12_t ctx,
uint8_t  state 
)

LTE IoT 12 set PWR pin function.

This function sets the PWRKEY pin logic state.

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

◆ lteiot12_set_rts_pin()

void lteiot12_set_rts_pin ( lteiot12_t ctx,
uint8_t  state 
)

LTE IoT 12 set RTS pin function.

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

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

◆ lteiot12_set_sim_apn()

void lteiot12_set_sim_apn ( lteiot12_t ctx,
uint8_t *  sim_apn 
)

LTE IoT 12 set SIM card APN function.

This function sets APN for SIM card.

Parameters
[in]ctx: Click context object. See lteiot12_t object definition for detailed explanation.
[in]sim_apn: SIM card APN.
Returns
None.
Note
None.