ltecat1eu 2.0.0.0
|
API for configuring and manipulating LTE Cat.1-EU Click driver. More...
Topics | |
LTE Cat.1-EU Device Settings | |
Settings for registers of LTE Cat.1-EU Click driver. | |
LTE Cat.1-EU MikroBUS Map | |
MikroBUS pin mapping of LTE Cat.1-EU Click driver. | |
Functions | |
void | ltecat1eu_cfg_setup (ltecat1eu_cfg_t *cfg) |
LTE Cat.1-EU configuration object setup function. | |
err_t | ltecat1eu_init (ltecat1eu_t *ctx, ltecat1eu_cfg_t *cfg) |
LTE Cat.1-EU initialization function. | |
void | ltecat1eu_generic_write (ltecat1eu_t *ctx, char *data_buf, uint16_t len) |
LTE Cat.1-EU data writing function. | |
err_t | ltecat1eu_generic_read (ltecat1eu_t *ctx, char *data_buf, uint16_t max_len) |
LTE Cat.1-EU data reading function. | |
void | ltecat1eu_power_on (ltecat1eu_t *ctx) |
LTE Cat.1-EU module power on. | |
void | ltecat1eu_set_rst (ltecat1eu_t *ctx, uint8_t state) |
Sets state of the RST pin. | |
void | ltecat1eu_set_rts (ltecat1eu_t *ctx, uint8_t state) |
Sets state of the RTS pin. | |
uint8_t | ltecat1eu_get_cts (ltecat1eu_t *ctx) |
CTS Pin Get function. | |
void | ltecat1eu_send_cmd (ltecat1eu_t *ctx, char *cmd) |
Send command function. | |
void | ltecat1eu_send_cmd_with_parameter (ltecat1eu_t *ctx, char *at_cmd_buf, char *param_buf) |
Send command function with parameter. | |
void | ltecat1eu_send_cmd_check (ltecat1eu_t *ctx, char *at_cmd_buf) |
Check the sent command. | |
void | ltecat1eu_send_cmd_parameter_check (ltecat1eu_t *ctx, char *at_cmd_buf) |
Check the command parameters. | |
void | ltecat1eu_set_sim_apn (ltecat1eu_t *ctx, char *sim_apn) |
Set sim card APN. | |
void | ltecat1eu_send_text_message (ltecat1eu_t *ctx, char *phone_number, char *message_context) |
LTE Cat.1-EU send text message. | |
API for configuring and manipulating LTE Cat.1-EU Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void ltecat1eu_cfg_setup | ( | ltecat1eu_cfg_t * | cfg | ) |
LTE Cat.1-EU configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See ltecat1eu_cfg_t object definition for detailed explanation. |
err_t ltecat1eu_generic_read | ( | ltecat1eu_t * | ctx, |
char * | data_buf, | ||
uint16_t | max_len ) |
LTE Cat.1-EU data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[out] | data_buf | : Output read data. |
[in] | max_len | : Number of bytes to be read. |
>0
- Number of data bytes read, <=0
- Error/Empty Ring buffer.void ltecat1eu_generic_write | ( | ltecat1eu_t * | ctx, |
char * | data_buf, | ||
uint16_t | len ) |
LTE Cat.1-EU data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | data_buf | : Data buffer for sending. |
[in] | len | : Number of bytes for sending. |
uint8_t ltecat1eu_get_cts | ( | ltecat1eu_t * | ctx | ) |
CTS Pin Get function.
This function allows user to check state of the CTS pin.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
0
logical low. 1
logical high. err_t ltecat1eu_init | ( | ltecat1eu_t * | ctx, |
ltecat1eu_cfg_t * | cfg ) |
LTE Cat.1-EU initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See ltecat1eu_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void ltecat1eu_power_on | ( | ltecat1eu_t * | ctx | ) |
LTE Cat.1-EU module power on.
This function resets the chip on LTE Cat.1-EU click.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
void ltecat1eu_send_cmd | ( | ltecat1eu_t * | ctx, |
char * | cmd ) |
Send command function.
This function sends the specified command to the click module.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | cmd | Command variable. |
void ltecat1eu_send_cmd_check | ( | ltecat1eu_t * | ctx, |
char * | at_cmd_buf ) |
Check the sent command.
This function checks the command that is sent.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void ltecat1eu_send_cmd_parameter_check | ( | ltecat1eu_t * | ctx, |
char * | at_cmd_buf ) |
Check the command parameters.
This function checks the command that is sent.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void ltecat1eu_send_cmd_with_parameter | ( | ltecat1eu_t * | ctx, |
char * | at_cmd_buf, | ||
char * | param_buf ) |
Send command function with parameter.
This function sends commands to the click module.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
[in] | param_buf | Parameter buffer. |
void ltecat1eu_send_text_message | ( | ltecat1eu_t * | ctx, |
char * | phone_number, | ||
char * | message_context ) |
LTE Cat.1-EU send text message.
This function sends text message to a phone number.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | phone_number | Phone number to message. |
[in] | message_context | Message to be sent. |
void ltecat1eu_set_rst | ( | ltecat1eu_t * | ctx, |
uint8_t | state ) |
Sets state of the RST pin.
This function sets RST pin state.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | state | Pin state ( 1 or 0 ). |
void ltecat1eu_set_rts | ( | ltecat1eu_t * | ctx, |
uint8_t | state ) |
Sets state of the RTS pin.
This function sets RTS pin state.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | state | Pin state ( 1 or 0 ). |
void ltecat1eu_set_sim_apn | ( | ltecat1eu_t * | ctx, |
char * | sim_apn ) |
Set sim card APN.
This function sets APN for sim card.
[in] | ctx | : Click context object. See ltecat1eu_t object definition for detailed explanation. |
[in] | sim_apn | SIM card APN. |