ltecat13nax
2.1.0.0
|
API for configuring and manipulating LTE Cat.1 3 NAX Click driver. More...
Modules | |
LTE Cat.1 3 NAX Device Settings | |
Settings for registers of LTE Cat.1 3 NAX Click driver. | |
LTE Cat.1 3 NAX MikroBUS Map | |
MikroBUS pin mapping of LTE Cat.1 3 NAX Click driver. | |
Functions | |
void | ltecat13nax_cfg_setup (ltecat13nax_cfg_t *cfg) |
LTE Cat.1 3 NAX configuration object setup function. More... | |
err_t | ltecat13nax_init (ltecat13nax_t *ctx, ltecat13nax_cfg_t *cfg) |
LTE Cat.1 3 NAX initialization function. More... | |
err_t | ltecat13nax_generic_write (ltecat13nax_t *ctx, uint8_t *data_in, uint16_t len) |
LTE Cat.1 3 NAX data writing function. More... | |
err_t | ltecat13nax_generic_read (ltecat13nax_t *ctx, uint8_t *data_out, uint16_t len) |
LTE Cat.1 3 NAX data reading function. More... | |
void | ltecat13nax_start_up (ltecat13nax_t *ctx) |
LTE Cat.1 3 NAX start up function. More... | |
void | ltecat13nax_set_pwr_pin (ltecat13nax_t *ctx, uint8_t pin_state) |
LTE Cat.1 3 NAX set PWR pin function. More... | |
void | ltecat13nax_set_rts_pin (ltecat13nax_t *ctx, uint8_t pin_state) |
LTE Cat.1 3 NAX set RST pin function. More... | |
uint8_t | ltecat13nax_get_ri_pin (ltecat13nax_t *ctx) |
LTE Cat.1 3 NAX get RI pin function. More... | |
uint8_t | ltecat13nax_get_cts_pin (ltecat13nax_t *ctx) |
LTE Cat.1 3 NAX get cts pin function. More... | |
err_t | ltecat13nax_write_register (ltecat13nax_t *ctx, uint8_t reg, uint8_t data_in) |
LTE Cat.1 3 NAX MAX9860 writing function. More... | |
err_t | ltecat13nax_read_register (ltecat13nax_t *ctx, uint8_t reg, uint8_t *data_out) |
LTE Cat.1 3 NAX MAX9860 reading function. More... | |
err_t | ltecat13nax_max9860_cfg (ltecat13nax_t *ctx) |
LTE Cat.1 3 NAX MAX9860 configuration function. More... | |
void | ltecat13nax_send_cmd (ltecat13nax_t *ctx, uint8_t *cmd) |
LTE Cat.1 3 NAX send command function. More... | |
void | ltecat13nax_send_cmd_with_params (ltecat13nax_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf) |
LTE Cat.1 3 NAX send command function with parameter. More... | |
void | ltecat13nax_send_cmd_check (ltecat13nax_t *ctx, uint8_t *at_cmd_buf) |
LTE Cat.1 3 NAX check the sent command. More... | |
void | ltecat13nax_send_cmd_param_check (ltecat13nax_t *ctx, uint8_t *at_cmd_buf) |
LTE Cat.1 3 NAX check the command parameters. More... | |
void | ltecat13nax_set_sim_apn (ltecat13nax_t *ctx, uint8_t *sim_apn) |
LTE Cat.1 3 NAX set sim card APN. More... | |
void | ltecat13nax_send_sms_text (ltecat13nax_t *ctx, uint8_t *phone_number, uint8_t *sms_text) |
LTE Cat.1 3 NAX send SMS in text mode. More... | |
err_t | ltecat13nax_send_sms_pdu (ltecat13nax_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text) |
LTE Cat.1 3 NAX send SMS in PDU mode. More... | |
err_t | ltecat13nax_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data) |
LTE Cat.1 parse GPGGA function. More... | |
API for configuring and manipulating LTE Cat.1 3 NAX Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void ltecat13nax_cfg_setup | ( | ltecat13nax_cfg_t * | cfg | ) |
LTE Cat.1 3 NAX configuration object setup function.
This function initializes Click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See ltecat13nax_cfg_t object definition for detailed explanation. |
err_t ltecat13nax_generic_read | ( | ltecat13nax_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
LTE Cat.1 3 NAX data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ltecat13nax_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 ltecat13nax_generic_write | ( | ltecat13nax_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
LTE Cat.1 3 NAX data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ltecat13nax_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 ltecat13nax_get_cts_pin | ( | ltecat13nax_t * | ctx | ) |
LTE Cat.1 3 NAX get cts pin function.
This function returns the clear to send (CTS) pin logic state.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
uint8_t ltecat13nax_get_ri_pin | ( | ltecat13nax_t * | ctx | ) |
LTE Cat.1 3 NAX get RI pin function.
This function returns the RI pin logic state.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
err_t ltecat13nax_init | ( | ltecat13nax_t * | ctx, |
ltecat13nax_cfg_t * | cfg | ||
) |
LTE Cat.1 3 NAX initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
[out] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See ltecat13nax_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t ltecat13nax_max9860_cfg | ( | ltecat13nax_t * | ctx | ) |
LTE Cat.1 3 NAX MAX9860 configuration function.
This function is used to set basic config for MAX9860 of LTE Cat.1 3 NAX Click board.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t ltecat13nax_parse_gpgga | ( | char * | rsp_buf, |
uint8_t | gpgga_element, | ||
char * | element_data | ||
) |
LTE Cat.1 parse GPGGA function.
This function parses the GPGGA data from the read response buffer.
[in] | rsp_buf | : Response buffer. |
[in] | gpgga_element | : GPGGA element position [1-14]. |
[out] | element_data | : Element data parsed. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t ltecat13nax_read_register | ( | ltecat13nax_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
LTE Cat.1 3 NAX MAX9860 reading function.
This function reads a data byte from the selected register address.
[in] | ctx | : Click context object. See ltecat13nax_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 ltecat13nax_send_cmd | ( | ltecat13nax_t * | ctx, |
uint8_t * | cmd | ||
) |
LTE Cat.1 3 NAX send command function.
This function sends a specified command to the Click module.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | cmd | Command variable. |
void ltecat13nax_send_cmd_check | ( | ltecat13nax_t * | ctx, |
uint8_t * | at_cmd_buf | ||
) |
LTE Cat.1 3 NAX check the sent command.
This function checks the command that is sent.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void ltecat13nax_send_cmd_param_check | ( | ltecat13nax_t * | ctx, |
uint8_t * | at_cmd_buf | ||
) |
LTE Cat.1 3 NAX check the command parameters.
This function checks the command that is sent.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
void ltecat13nax_send_cmd_with_params | ( | ltecat13nax_t * | ctx, |
uint8_t * | at_cmd_buf, | ||
uint8_t * | param_buf | ||
) |
LTE Cat.1 3 NAX send command function with parameter.
This function sends a command with specified parameter to the Click module.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | at_cmd_buf | Command buffer. |
[in] | param_buf | Parameter buffer. |
err_t ltecat13nax_send_sms_pdu | ( | ltecat13nax_t * | ctx, |
uint8_t * | service_center_number, | ||
uint8_t * | phone_number, | ||
uint8_t * | sms_text | ||
) |
LTE Cat.1 3 NAX send SMS in PDU mode.
This function sends text message to a phone number in PDU mode.
[in] | ctx | : Click context object. See ltecat13nax_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 ltecat13nax_send_sms_text | ( | ltecat13nax_t * | ctx, |
uint8_t * | phone_number, | ||
uint8_t * | sms_text | ||
) |
LTE Cat.1 3 NAX send SMS in text mode.
This function sends text message to a phone number.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | phone_number | Phone number to message. |
[in] | sms_text | Message to be sent. |
void ltecat13nax_set_pwr_pin | ( | ltecat13nax_t * | ctx, |
uint8_t | pin_state | ||
) |
LTE Cat.1 3 NAX set PWR pin function.
This function sets the PWR pin logic state.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | pin_state | : Pin logic state. |
void ltecat13nax_set_rts_pin | ( | ltecat13nax_t * | ctx, |
uint8_t | pin_state | ||
) |
LTE Cat.1 3 NAX set RST pin function.
This function sets the RST pin logic state.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | pin_state | : Pin logic state. |
void ltecat13nax_set_sim_apn | ( | ltecat13nax_t * | ctx, |
uint8_t * | sim_apn | ||
) |
LTE Cat.1 3 NAX set sim card APN.
This function sets APN for sim card.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | sim_apn | SIM card APN. |
void ltecat13nax_start_up | ( | ltecat13nax_t * | ctx | ) |
LTE Cat.1 3 NAX start up function.
This function is used to start device.
[in] | ctx | : Click context object. See ltecat13nax_t object definition for detailed explanation. |
[in] | pin_state | : Pin logic state. |
err_t ltecat13nax_write_register | ( | ltecat13nax_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
LTE Cat.1 3 NAX MAX9860 writing function.
This function writes a data byte into the selected register address.
[in] | ctx | : Click context object. See ltecat13nax_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.