c4glte3e 2.1.0.0
|
API for configuring and manipulating 4G LTE 3 E Click driver. More...
Topics | |
4G LTE 3 E Device Settings | |
Settings for registers of 4G LTE 3 E Click driver. | |
4G LTE 3 E MikroBUS Map | |
MikroBUS pin mapping of 4G LTE 3 E Click driver. | |
Functions | |
void | c4glte3e_cfg_setup (c4glte3e_cfg_t *cfg) |
4G LTE 3 E configuration object setup function. | |
err_t | c4glte3e_init (c4glte3e_t *ctx, c4glte3e_cfg_t *cfg) |
4G LTE 3 E initialization function. | |
err_t | c4glte3e_generic_write (c4glte3e_t *ctx, uint8_t *data_in, uint16_t len) |
4G LTE 3 E data writing function. | |
err_t | c4glte3e_generic_read (c4glte3e_t *ctx, uint8_t *data_out, uint16_t len) |
4G LTE 3 E data reading function. | |
void | c4glte3e_set_pwr_pin (c4glte3e_t *ctx, uint8_t state) |
4G LTE 3 E set PWR pin function. | |
void | c4glte3e_set_rst_pin (c4glte3e_t *ctx, uint8_t state) |
4G LTE 3 E set RST pin function. | |
void | c4glte3e_set_rts_pin (c4glte3e_t *ctx, uint8_t state) |
4G LTE 3 E set RTS pin function. | |
uint8_t | c4glte3e_get_ring_pin (c4glte3e_t *ctx) |
4G LTE 3 E get RING pin function. | |
uint8_t | c4glte3e_get_cts_pin (c4glte3e_t *ctx) |
4G LTE 3 E get CTS pin function. | |
void | c4glte3e_set_power_state (c4glte3e_t *ctx, uint8_t state) |
4G LTE 3 E set power state function. | |
void | c4glte3e_cmd_run (c4glte3e_t *ctx, uint8_t *cmd) |
4G LTE 3 E cmd run function. | |
void | c4glte3e_cmd_set (c4glte3e_t *ctx, uint8_t *cmd, uint8_t *value) |
4G LTE 3 E cmd set function. | |
void | c4glte3e_cmd_get (c4glte3e_t *ctx, uint8_t *cmd) |
4G LTE 3 E cmd get function. | |
void | c4glte3e_cmd_help (c4glte3e_t *ctx, uint8_t *cmd) |
4G LTE 3 E cmd help function. | |
void | c4glte3e_set_sim_apn (c4glte3e_t *ctx, uint8_t *sim_apn) |
Set sim card APN. | |
void | c4glte3e_send_sms_text (c4glte3e_t *ctx, uint8_t *phone_number, uint8_t *sms_text) |
4G LTE 3 E send SMS in text mode. | |
err_t | c4glte3e_send_sms_pdu (c4glte3e_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text) |
4G LTE 3 E send SMS in PDU mode. | |
API for configuring and manipulating 4G LTE 3 E Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void c4glte3e_cfg_setup | ( | c4glte3e_cfg_t * | cfg | ) |
4G LTE 3 E configuration object setup function.
This function initializes Click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See c4glte3e_cfg_t object definition for detailed explanation. |
void c4glte3e_cmd_get | ( | c4glte3e_t * | ctx, |
uint8_t * | cmd ) |
4G LTE 3 E 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 c4glte3e_t object definition for detailed explanation. |
[in] | cmd | : Command string. |
void c4glte3e_cmd_help | ( | c4glte3e_t * | ctx, |
uint8_t * | cmd ) |
4G LTE 3 E cmd help function.
This function provides a short description of the given command of the Click module.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | cmd | : Command string. |
void c4glte3e_cmd_run | ( | c4glte3e_t * | ctx, |
uint8_t * | cmd ) |
4G LTE 3 E cmd run function.
This function sends a specified command to the Click module.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | cmd | : Command string. |
void c4glte3e_cmd_set | ( | c4glte3e_t * | ctx, |
uint8_t * | cmd, | ||
uint8_t * | value ) |
4G LTE 3 E cmd set function.
This function sets a value to a specified command of the Click module.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | cmd | : Command string. |
[in] | value | : Value string. |
err_t c4glte3e_generic_read | ( | c4glte3e_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len ) |
4G LTE 3 E data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See c4glte3e_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 c4glte3e_generic_write | ( | c4glte3e_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len ) |
4G LTE 3 E data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See c4glte3e_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 c4glte3e_get_cts_pin | ( | c4glte3e_t * | ctx | ) |
4G LTE 3 E get CTS pin function.
This function returns the clear to send (CTS) pin logic state.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
uint8_t c4glte3e_get_ring_pin | ( | c4glte3e_t * | ctx | ) |
4G LTE 3 E get RING pin function.
This function returns the ring indication (RING) pin logic state.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
err_t c4glte3e_init | ( | c4glte3e_t * | ctx, |
c4glte3e_cfg_t * | cfg ) |
4G LTE 3 E initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
[out] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See c4glte3e_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t c4glte3e_send_sms_pdu | ( | c4glte3e_t * | ctx, |
uint8_t * | service_center_number, | ||
uint8_t * | phone_number, | ||
uint8_t * | sms_text ) |
4G LTE 3 E send SMS in PDU mode.
This function sends text message to a phone number in PDU mode.
[in] | ctx | : Click context object. See c4glte3e_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 c4glte3e_send_sms_text | ( | c4glte3e_t * | ctx, |
uint8_t * | phone_number, | ||
uint8_t * | sms_text ) |
4G LTE 3 E send SMS in text mode.
This function sends text message to a phone number.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | phone_number | Phone number to message. |
[in] | sms_text | Message to be sent. |
void c4glte3e_set_power_state | ( | c4glte3e_t * | ctx, |
uint8_t | state ) |
4G LTE 3 E set power state function.
This function sets a desired power state by toggling PWR and RST pins with a specific timing.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | state | :
|
void c4glte3e_set_pwr_pin | ( | c4glte3e_t * | ctx, |
uint8_t | state ) |
4G LTE 3 E set PWR pin function.
This function sets the PWRKEY pin logic state.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void c4glte3e_set_rst_pin | ( | c4glte3e_t * | ctx, |
uint8_t | state ) |
4G LTE 3 E set RST pin function.
This function sets the RESET pin logic state.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void c4glte3e_set_rts_pin | ( | c4glte3e_t * | ctx, |
uint8_t | state ) |
4G LTE 3 E set RTS pin function.
This function sets the request to send (RTS) pin logic state.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void c4glte3e_set_sim_apn | ( | c4glte3e_t * | ctx, |
uint8_t * | sim_apn ) |
Set sim card APN.
This function sets APN for sim card.
[in] | ctx | : Click context object. See c4glte3e_t object definition for detailed explanation. |
[in] | sim_apn | SIM card APN. |