lteiot12 2.1.0.0
|
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 pin_state) |
LTE IoT 12 set PWR pin function. More... | |
void | lteiot12_set_rts_pin (lteiot12_t *ctx, uint8_t pin_state) |
LTE IoT 12 set RTS pin function. More... | |
uint8_t | lteiot12_get_cts_pin (lteiot12_t *ctx) |
LTE IoT 12 get cts pin function. More... | |
void | lteiot12_hw_reset (lteiot12_t *ctx) |
LTE IoT 12 hardware reset function. More... | |
void | lteiot12_send_cmd (lteiot12_t *ctx, uint8_t *cmd) |
LTE IoT 12 send command function. More... | |
void | lteiot12_send_cmd_with_params (lteiot12_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf) |
LTE IoT 12 send command function with parameter. More... | |
void | lteiot12_send_cmd_check (lteiot12_t *ctx, uint8_t *at_cmd_buf) |
LTE IoT 12 check the sent command. More... | |
void | lteiot12_send_cmd_params_check (lteiot12_t *ctx, uint8_t *at_cmd_buf) |
LTE IoT 12 check the command parameters. More... | |
void | lteiot12_set_sim_apn (lteiot12_t *ctx, uint8_t *sim_apn) |
LTE IoT 12 set sim card APN. More... | |
void | lteiot12_send_sms_text_mode (lteiot12_t *ctx, uint8_t *phone_number, uint8_t *sms_text) |
LTE IoT 12 send SMS in text mode. 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. More... | |
err_t | lteiot12_parse_gngga (uint8_t *rsp_buf, uint8_t gngga_element, uint8_t *element_data) |
LTE IoT 12 parse GNGGA function. More... | |
API for configuring and manipulating LTE IoT 12 Click driver.
void lteiot12_cfg_setup | ( | lteiot12_cfg_t * | cfg | ) |
LTE IoT 12 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See lteiot12_cfg_t object definition for detailed explanation. |
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.
[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. |
>0
- Number of data bytes read, <=0
- Error/Empty Ring buffer. See #err_t definition for detailed explanation. 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.
[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. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. 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.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
void lteiot12_hw_reset | ( | lteiot12_t * | ctx | ) |
LTE IoT 12 hardware reset function.
This function is used to perform hardware reset.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
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.
[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. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t lteiot12_parse_gngga | ( | uint8_t * | rsp_buf, |
uint8_t | gngga_element, | ||
uint8_t * | element_data | ||
) |
LTE IoT 12 parse GNGGA function.
This function parses the GNGGA data from the read response buffer.
[in] | rsp_buf | : Response buffer. |
[in] | gngga_element | : GNGGA element position [1-14]. |
[out] | element_data | : Element data parsed. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void lteiot12_send_cmd | ( | lteiot12_t * | ctx, |
uint8_t * | cmd | ||
) |
LTE IoT 12 send command function.
This function sends a specified command to the LTE IoT 12 Click module.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
[in] | cmd | Command variable. |
void lteiot12_send_cmd_check | ( | lteiot12_t * | ctx, |
uint8_t * | at_cmd_buf | ||
) |
LTE IoT 12 check the sent command.
This function checks the command that is sent.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void lteiot12_send_cmd_params_check | ( | lteiot12_t * | ctx, |
uint8_t * | at_cmd_buf | ||
) |
LTE IoT 12 check the command parameters.
This function checks the command that is sent.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void lteiot12_send_cmd_with_params | ( | lteiot12_t * | ctx, |
uint8_t * | at_cmd_buf, | ||
uint8_t * | param_buf | ||
) |
LTE IoT 12 send command function with parameter.
This function sends a command with specified parameter to the click module.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
[in] | param_buf | Parameter buffer. |
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.
This function sends text message to a phone number in PDU mode.
[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. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. void lteiot12_send_sms_text_mode | ( | lteiot12_t * | ctx, |
uint8_t * | phone_number, | ||
uint8_t * | sms_text | ||
) |
LTE IoT 12 send SMS in text mode.
This function sends text message to a phone number.
[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. |
void lteiot12_set_pwr_pin | ( | lteiot12_t * | ctx, |
uint8_t | pin_state | ||
) |
LTE IoT 12 set PWR pin function.
This function sets the PWR pin logic state.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
[in] | pin_state | : Pin logic state. |
void lteiot12_set_rts_pin | ( | lteiot12_t * | ctx, |
uint8_t | pin_state | ||
) |
LTE IoT 12 set RTS pin function.
This function sets the RTS pin logic state.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
[in] | pin_state | : Pin logic state. |
void lteiot12_set_sim_apn | ( | lteiot12_t * | ctx, |
uint8_t * | sim_apn | ||
) |
LTE IoT 12 set sim card APN.
This function sets APN for sim card.
[in] | ctx | : Click context object. See lteiot12_t object definition for detailed explanation. |
[in] | sim_apn | SIM card APN. |