|
lteiot10 2.2.1
|
API for configuring and manipulating LTE IoT 10 Click driver. More...
Topics | |
| LTE IoT 10 Device Settings | |
| Settings for registers of LTE IoT 10 Click driver. | |
| LTE IoT 10 MikroBUS Map | |
| MikroBUS pin mapping of LTE IoT 10 Click driver. | |
Functions | |
| void | lteiot10_cfg_setup (lteiot10_cfg_t *cfg) |
| LTE IoT 10 configuration object setup function. | |
| err_t | lteiot10_init (lteiot10_t *ctx, lteiot10_cfg_t *cfg) |
| LTE IoT 10 initialization function. | |
| err_t | lteiot10_generic_write (lteiot10_t *ctx, uint8_t *data_in, uint16_t len) |
| LTE IoT 10 data writing function. | |
| err_t | lteiot10_generic_read (lteiot10_t *ctx, uint8_t *data_out, uint16_t len) |
| LTE IoT 10 data reading function. | |
| void | lteiot10_set_wkp_pin (lteiot10_t *ctx, uint8_t state) |
| LTE IoT 10 set WKP pin function. | |
| void | lteiot10_set_rst_pin (lteiot10_t *ctx, uint8_t state) |
| LTE IoT 10 set RST pin function. | |
| void | lteiot10_set_rts_pin (lteiot10_t *ctx, uint8_t state) |
| LTE IoT 10 set RTS pin function. | |
| uint8_t | lteiot10_get_ring_pin (lteiot10_t *ctx) |
| LTE IoT 10 get RING pin function. | |
| uint8_t | lteiot10_get_cts_pin (lteiot10_t *ctx) |
| LTE IoT 10 get CTS pin function. | |
| void | lteiot10_reset_device (lteiot10_t *ctx) |
| LTE IoT 10 reset device function. | |
| void | lteiot10_cmd_run (lteiot10_t *ctx, uint8_t *cmd) |
| LTE IoT 10 cmd run function. | |
| void | lteiot10_cmd_set (lteiot10_t *ctx, uint8_t *cmd, uint8_t *value) |
| LTE IoT 10 cmd set function. | |
| void | lteiot10_cmd_get (lteiot10_t *ctx, uint8_t *cmd) |
| LTE IoT 10 cmd get function. | |
| void | lteiot10_cmd_help (lteiot10_t *ctx, uint8_t *cmd) |
| LTE IoT 10 cmd help function. | |
| void | lteiot10_set_sim_apn (lteiot10_t *ctx, uint8_t *sim_apn) |
| Set sim card APN. | |
| void | lteiot10_send_sms_text (lteiot10_t *ctx, uint8_t *phone_number, uint8_t *sms_text) |
| LTE IoT 10 send SMS in text mode. | |
| err_t | lteiot10_send_sms_pdu (lteiot10_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text) |
| LTE IoT 10 send SMS in PDU mode. | |
API for configuring and manipulating LTE IoT 10 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void lteiot10_cfg_setup | ( | lteiot10_cfg_t * | cfg | ) |
LTE IoT 10 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See lteiot10_cfg_t object definition for detailed explanation. |
| void lteiot10_cmd_get | ( | lteiot10_t * | ctx, |
| uint8_t * | cmd ) |
LTE IoT 10 cmd get function.
This function is used to get the value of a given command from the Click module.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | cmd | : Command string. |
| void lteiot10_cmd_help | ( | lteiot10_t * | ctx, |
| uint8_t * | cmd ) |
LTE IoT 10 cmd help function.
This function provides a short description of the given command of the Click module.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | cmd | : Command string. |
| void lteiot10_cmd_run | ( | lteiot10_t * | ctx, |
| uint8_t * | cmd ) |
LTE IoT 10 cmd run function.
This function sends a specified command to the Click module.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | cmd | : Command string. |
| void lteiot10_cmd_set | ( | lteiot10_t * | ctx, |
| uint8_t * | cmd, | ||
| uint8_t * | value ) |
LTE IoT 10 cmd set function.
This function sets a value to a specified command of the Click module.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | cmd | : Command string. |
| [in] | value | : Value string. |
| err_t lteiot10_generic_read | ( | lteiot10_t * | ctx, |
| uint8_t * | data_out, | ||
| uint16_t | len ) |
LTE IoT 10 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
| [in] | ctx | : Click context object. See lteiot10_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 lteiot10_generic_write | ( | lteiot10_t * | ctx, |
| uint8_t * | data_in, | ||
| uint16_t | len ) |
LTE IoT 10 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
| [in] | ctx | : Click context object. See lteiot10_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 lteiot10_get_cts_pin | ( | lteiot10_t * | ctx | ) |
LTE IoT 10 get CTS pin function.
This function returns the clear to send (CTS) pin logic state.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| uint8_t lteiot10_get_ring_pin | ( | lteiot10_t * | ctx | ) |
LTE IoT 10 get RING pin function.
This function returns the ring indication (RING) pin logic state.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| err_t lteiot10_init | ( | lteiot10_t * | ctx, |
| lteiot10_cfg_t * | cfg ) |
LTE IoT 10 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See lteiot10_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | void lteiot10_reset_device | ( | lteiot10_t * | ctx | ) |
LTE IoT 10 reset device function.
This function resets the device by toggling the reset pin logic state.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| err_t lteiot10_send_sms_pdu | ( | lteiot10_t * | ctx, |
| uint8_t * | service_center_number, | ||
| uint8_t * | phone_number, | ||
| uint8_t * | sms_text ) |
LTE IoT 10 send SMS in PDU mode.
This function sends text message to a phone number in PDU mode.
| [in] | ctx | : Click context object. See lteiot10_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 lteiot10_send_sms_text | ( | lteiot10_t * | ctx, |
| uint8_t * | phone_number, | ||
| uint8_t * | sms_text ) |
LTE IoT 10 send SMS in text mode.
This function sends text message to a phone number.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | phone_number | : Phone number to message. |
| [in] | sms_text | : Message to be sent. |
| void lteiot10_set_rst_pin | ( | lteiot10_t * | ctx, |
| uint8_t | state ) |
LTE IoT 10 set RST pin function.
This function sets the RESET pin logic state.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| void lteiot10_set_rts_pin | ( | lteiot10_t * | ctx, |
| uint8_t | state ) |
LTE IoT 10 set RTS pin function.
This function sets the request to send (RTS) pin logic state.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| void lteiot10_set_sim_apn | ( | lteiot10_t * | ctx, |
| uint8_t * | sim_apn ) |
Set sim card APN.
This function sets APN for sim card.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | sim_apn | : SIM card APN. |
| void lteiot10_set_wkp_pin | ( | lteiot10_t * | ctx, |
| uint8_t | state ) |
LTE IoT 10 set WKP pin function.
This function sets the WAKE0 pin logic state.
| [in] | ctx | : Click context object. See lteiot10_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |