lteiot17
2.1.0.0
|
API for configuring and manipulating LTE IoT 17 Click driver. More...
Modules | |
LTE IoT 17 Device Settings | |
Settings for registers of LTE IoT 17 Click driver. | |
LTE IoT 17 MikroBUS Map | |
MikroBUS pin mapping of LTE IoT 17 Click driver. | |
Functions | |
void | lteiot17_cfg_setup (lteiot17_cfg_t *cfg) |
LTE IoT 17 configuration object setup function. More... | |
err_t | lteiot17_init (lteiot17_t *ctx, lteiot17_cfg_t *cfg) |
LTE IoT 17 initialization function. More... | |
err_t | lteiot17_generic_write (lteiot17_t *ctx, uint8_t *data_in, uint16_t len) |
LTE IoT 17 data writing function. More... | |
err_t | lteiot17_generic_read (lteiot17_t *ctx, uint8_t *data_out, uint16_t len) |
LTE IoT 17 data reading function. More... | |
void | lteiot17_set_pwr_pin (lteiot17_t *ctx, uint8_t state) |
LTE IoT 17 set PWR pin function. More... | |
void | lteiot17_set_rts_pin (lteiot17_t *ctx, uint8_t state) |
LTE IoT 17 set RTS pin function. More... | |
uint8_t | lteiot17_get_ring_pin (lteiot17_t *ctx) |
LTE IoT 17 get RING pin function. More... | |
uint8_t | lteiot17_get_cts_pin (lteiot17_t *ctx) |
LTE IoT 17 get CTS pin function. More... | |
void | lteiot17_set_power_state (lteiot17_t *ctx, uint8_t state) |
LTE IoT 17 set power state function. More... | |
void | lteiot17_send_cmd (lteiot17_t *ctx, uint8_t *cmd) |
Send command function. More... | |
void | lteiot17_send_cmd_par (lteiot17_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf) |
Send command function with parameter. More... | |
void | lteiot17_send_cmd_check (lteiot17_t *ctx, uint8_t *at_cmd_buf) |
Check the sent command. More... | |
void | lteiot17_set_sim_apn (lteiot17_t *ctx, uint8_t *sim_apn) |
Set sim card APN. More... | |
void | lteiot17_send_sms_text (lteiot17_t *ctx, uint8_t *phone_number, uint8_t *sms_text) |
LTE IoT 17 send SMS in text mode. More... | |
err_t | lteiot17_send_sms_pdu (lteiot17_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text) |
LTE IoT 17 send SMS in PDU mode. More... | |
API for configuring and manipulating LTE IoT 17 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void lteiot17_cfg_setup | ( | lteiot17_cfg_t * | cfg | ) |
LTE IoT 17 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See lteiot17_cfg_t object definition for detailed explanation. |
err_t lteiot17_generic_read | ( | lteiot17_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
LTE IoT 17 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See lteiot17_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 lteiot17_generic_write | ( | lteiot17_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
LTE IoT 17 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See lteiot17_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 lteiot17_get_cts_pin | ( | lteiot17_t * | ctx | ) |
LTE IoT 17 get CTS pin function.
This function returns the clear to send (CTS) pin logic state.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
uint8_t lteiot17_get_ring_pin | ( | lteiot17_t * | ctx | ) |
LTE IoT 17 get RING pin function.
This function returns the ring indication (RING) pin logic state.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
err_t lteiot17_init | ( | lteiot17_t * | ctx, |
lteiot17_cfg_t * | cfg | ||
) |
LTE IoT 17 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See lteiot17_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void lteiot17_send_cmd | ( | lteiot17_t * | ctx, |
uint8_t * | cmd | ||
) |
Send command function.
This function sends a specified command to the click module.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | cmd | Command variable. |
void lteiot17_send_cmd_check | ( | lteiot17_t * | ctx, |
uint8_t * | at_cmd_buf | ||
) |
Check the sent command.
This function checks the command that is sent.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void lteiot17_send_cmd_par | ( | lteiot17_t * | ctx, |
uint8_t * | at_cmd_buf, | ||
uint8_t * | param_buf | ||
) |
Send command function with parameter.
This function sends a command with specified parameter to the click module.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
[in] | param_buf | Parameter buffer. |
err_t lteiot17_send_sms_pdu | ( | lteiot17_t * | ctx, |
uint8_t * | service_center_number, | ||
uint8_t * | phone_number, | ||
uint8_t * | sms_text | ||
) |
LTE IoT 17 send SMS in PDU mode.
This function sends text message to a phone number in PDU mode.
[in] | ctx | : Click context object. See lteiot17_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 lteiot17_send_sms_text | ( | lteiot17_t * | ctx, |
uint8_t * | phone_number, | ||
uint8_t * | sms_text | ||
) |
LTE IoT 17 send SMS in text mode.
This function sends text message to a phone number.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | phone_number | Phone number to message. |
[in] | sms_text | Message to be sent. |
void lteiot17_set_power_state | ( | lteiot17_t * | ctx, |
uint8_t | state | ||
) |
LTE IoT 17 set power state function.
This function sets a desired power state by toggling PWR pin with a specific time for high state.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | state | :
|
void lteiot17_set_pwr_pin | ( | lteiot17_t * | ctx, |
uint8_t | state | ||
) |
LTE IoT 17 set PWR pin function.
This function sets the PWRKEY pin logic state.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void lteiot17_set_rts_pin | ( | lteiot17_t * | ctx, |
uint8_t | state | ||
) |
LTE IoT 17 set RTS pin function.
This function sets the request to send (RTS) pin logic state.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void lteiot17_set_sim_apn | ( | lteiot17_t * | ctx, |
uint8_t * | sim_apn | ||
) |
Set sim card APN.
This function sets APN for sim card.
[in] | ctx | : Click context object. See lteiot17_t object definition for detailed explanation. |
[in] | sim_apn | SIM card APN. |