ltecat4
2.1.0.0
|
API for configuring and manipulating LTE Cat.4 Click driver. More...
Modules | |
LTE Cat.4 Device Settings | |
Settings for registers of LTE Cat.4 Click driver. | |
LTE Cat.4 MikroBUS Map | |
MikroBUS pin mapping of LTE Cat.4 Click driver. | |
Functions | |
void | ltecat4_cfg_setup (ltecat4_cfg_t *cfg) |
LTE Cat.4 configuration object setup function. More... | |
err_t | ltecat4_init (ltecat4_t *ctx, ltecat4_cfg_t *cfg) |
LTE Cat.4 initialization function. More... | |
err_t | ltecat4_write_register (ltecat4_t *ctx, uint8_t reg, uint8_t data_in) |
LTE Cat.4 MAX9860 writing function. More... | |
err_t | ltecat4_read_register (ltecat4_t *ctx, uint8_t reg, uint8_t *data_out) |
LTE Cat.4 MAX9860 reading function. More... | |
err_t | ltecat4_config_codec (ltecat4_t *ctx) |
LTE Cat.4 config codec function. More... | |
err_t | ltecat4_generic_write (ltecat4_t *ctx, uint8_t *data_in, uint16_t len) |
LTE Cat.4 data writing function. More... | |
err_t | ltecat4_generic_read (ltecat4_t *ctx, uint8_t *data_out, uint16_t len) |
LTE Cat.4 data reading function. More... | |
void | ltecat4_set_pwr_pin (ltecat4_t *ctx, uint8_t state) |
LTE Cat.4 set PWR pin function. More... | |
void | ltecat4_set_rts_pin (ltecat4_t *ctx, uint8_t state) |
LTE Cat.4 set RTS pin function. More... | |
uint8_t | ltecat4_get_ring_pin (ltecat4_t *ctx) |
LTE Cat.4 get RING pin function. More... | |
uint8_t | ltecat4_get_cts_pin (ltecat4_t *ctx) |
LTE Cat.4 get CTS pin function. More... | |
void | ltecat4_set_power_state (ltecat4_t *ctx, uint8_t state) |
LTE Cat.4 set power state function. More... | |
void | ltecat4_send_cmd (ltecat4_t *ctx, uint8_t *cmd) |
Send command function. More... | |
void | ltecat4_send_cmd_par (ltecat4_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf) |
Send command function with parameter. More... | |
void | ltecat4_send_cmd_check (ltecat4_t *ctx, uint8_t *at_cmd_buf) |
Check the sent command. More... | |
void | ltecat4_set_sim_apn (ltecat4_t *ctx, uint8_t *sim_apn) |
Set sim card APN. More... | |
void | ltecat4_send_sms_text (ltecat4_t *ctx, uint8_t *phone_number, uint8_t *sms_text) |
LTE Cat.4 send SMS in text mode. More... | |
err_t | ltecat4_send_sms_pdu (ltecat4_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text) |
LTE Cat.4 send SMS in PDU mode. More... | |
void | ltecat4_dial_number (ltecat4_t *ctx, uint8_t *phone_number) |
LTE Cat.4 dial number. More... | |
err_t | ltecat4_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data) |
LTE Cat.4 parse GGA function. More... | |
API for configuring and manipulating LTE Cat.4 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void ltecat4_cfg_setup | ( | ltecat4_cfg_t * | cfg | ) |
LTE Cat.4 configuration object setup function.
This function initializes Click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See ltecat4_cfg_t object definition for detailed explanation. |
err_t ltecat4_config_codec | ( | ltecat4_t * | ctx | ) |
LTE Cat.4 config codec function.
This function is used to set basic config for MAX9860 audio codec of LTE Cat.4 Click board.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void ltecat4_dial_number | ( | ltecat4_t * | ctx, |
uint8_t * | phone_number | ||
) |
LTE Cat.4 dial number.
This function dials the selected phone number.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | phone_number | Phone number to dial. |
err_t ltecat4_generic_read | ( | ltecat4_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
LTE Cat.4 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ltecat4_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 ltecat4_generic_write | ( | ltecat4_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
LTE Cat.4 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ltecat4_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 ltecat4_get_cts_pin | ( | ltecat4_t * | ctx | ) |
LTE Cat.4 get CTS pin function.
This function returns the clear to send (CTS) pin logic state.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
uint8_t ltecat4_get_ring_pin | ( | ltecat4_t * | ctx | ) |
LTE Cat.4 get RING pin function.
This function returns the ring indication (RING) pin logic state.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
err_t ltecat4_init | ( | ltecat4_t * | ctx, |
ltecat4_cfg_t * | cfg | ||
) |
LTE Cat.4 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
[out] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See ltecat4_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t ltecat4_parse_gga | ( | uint8_t * | rsp_buf, |
uint8_t | gga_element, | ||
uint8_t * | element_data | ||
) |
LTE Cat.4 parse GGA function.
This function parses the GGA data from the read response buffer.
[in] | rsp_buf | : Response buffer. |
[in] | gga_element | : GGA element position [1-14]. |
[out] | element_data | : Element data parsed. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t ltecat4_read_register | ( | ltecat4_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
LTE Cat.4 MAX9860 reading function.
This function reads a data byte from the selected register address.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void ltecat4_send_cmd | ( | ltecat4_t * | ctx, |
uint8_t * | cmd | ||
) |
Send command function.
This function sends a specified command to the Click module.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | cmd | Command variable. |
void ltecat4_send_cmd_check | ( | ltecat4_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 ltecat4_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void ltecat4_send_cmd_par | ( | ltecat4_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 ltecat4_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
[in] | param_buf | Parameter buffer. |
err_t ltecat4_send_sms_pdu | ( | ltecat4_t * | ctx, |
uint8_t * | service_center_number, | ||
uint8_t * | phone_number, | ||
uint8_t * | sms_text | ||
) |
LTE Cat.4 send SMS in PDU mode.
This function sends text message to a phone number in PDU mode.
[in] | ctx | : Click context object. See ltecat4_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 ltecat4_send_sms_text | ( | ltecat4_t * | ctx, |
uint8_t * | phone_number, | ||
uint8_t * | sms_text | ||
) |
LTE Cat.4 send SMS in text mode.
This function sends text message to a phone number.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | phone_number | Phone number to message. |
[in] | sms_text | Message to be sent. |
void ltecat4_set_power_state | ( | ltecat4_t * | ctx, |
uint8_t | state | ||
) |
LTE Cat.4 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 ltecat4_t object definition for detailed explanation. |
[in] | state | :
|
void ltecat4_set_pwr_pin | ( | ltecat4_t * | ctx, |
uint8_t | state | ||
) |
LTE Cat.4 set PWR pin function.
This function sets the PWRKEY pin logic state.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void ltecat4_set_rts_pin | ( | ltecat4_t * | ctx, |
uint8_t | state | ||
) |
LTE Cat.4 set RTS pin function.
This function sets the request to send (RTS) pin logic state.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void ltecat4_set_sim_apn | ( | ltecat4_t * | ctx, |
uint8_t * | sim_apn | ||
) |
Set sim card APN.
This function sets APN for sim card.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | sim_apn | SIM card APN. |
err_t ltecat4_write_register | ( | ltecat4_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
LTE Cat.4 MAX9860 writing function.
This function writes a data byte into the selected register address.
[in] | ctx | : Click context object. See ltecat4_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : Data buffer for sending. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.