wifinora
2.1.0.0
|
API for configuring and manipulating WiFi NORA Click driver. More...
Modules | |
WiFi NORA Device Settings | |
Settings for registers of WiFi NORA Click driver. | |
WiFi NORA MikroBUS Map | |
MikroBUS pin mapping of WiFi NORA Click driver. | |
Functions | |
void | wifinora_cfg_setup (wifinora_cfg_t *cfg) |
WiFi NORA configuration object setup function. More... | |
err_t | wifinora_init (wifinora_t *ctx, wifinora_cfg_t *cfg) |
WiFi NORA initialization function. More... | |
err_t | wifinora_generic_write (wifinora_t *ctx, uint8_t *data_in, uint16_t len) |
WiFi NORA data writing function. More... | |
err_t | wifinora_generic_read (wifinora_t *ctx, uint8_t *data_out, uint16_t len) |
WiFi NORA data reading function. More... | |
void | wifinora_set_rst_pin (wifinora_t *ctx, uint8_t pin_state) |
WiFi NORA set RST pin function. More... | |
void | wifinora_set_wkp_pin (wifinora_t *ctx, uint8_t pin_state) |
WiFi NORA set WKP pin function. More... | |
void | wifinora_set_cts_pin (wifinora_t *ctx, uint8_t pin_state) |
WiFi NORA set CTS pin function. More... | |
uint8_t | wifinora_get_whs_pin (wifinora_t *ctx) |
WiFi NORA get WHS pin state function. More... | |
uint8_t | wifinora_get_rts_pin (wifinora_t *ctx) |
WiFi NORA get RTS pin state function. More... | |
void | wifinora_hw_reset (wifinora_t *ctx) |
WiFi NORA HW reset function. More... | |
void | wifinora_send_cmd (wifinora_t *ctx, uint8_t *at_cmd_buf) |
WiFi NORA send command function. More... | |
void | wifinora_send_cmd_with_par (wifinora_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf) |
WiFi NORA send command with parameter function. More... | |
void | wifinora_send_cmd_check (wifinora_t *ctx, uint8_t *at_cmd_buf) |
WiFi NORA send command check function. More... | |
API for configuring and manipulating WiFi NORA Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void wifinora_cfg_setup | ( | wifinora_cfg_t * | cfg | ) |
WiFi NORA configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See wifinora_cfg_t object definition for detailed explanation. |
err_t wifinora_generic_read | ( | wifinora_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
WiFi NORA data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See wifinora_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 wifinora_generic_write | ( | wifinora_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
WiFi NORA data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See wifinora_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 wifinora_get_rts_pin | ( | wifinora_t * | ctx | ) |
WiFi NORA get RTS pin state function.
This function is used to get RTS pin state.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
uint8_t wifinora_get_whs_pin | ( | wifinora_t * | ctx | ) |
WiFi NORA get WHS pin state function.
This function is used to get WHS pin state.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
void wifinora_hw_reset | ( | wifinora_t * | ctx | ) |
WiFi NORA HW reset function.
This function is used to perform HW reset.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
err_t wifinora_init | ( | wifinora_t * | ctx, |
wifinora_cfg_t * | cfg | ||
) |
WiFi NORA initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See wifinora_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void wifinora_send_cmd | ( | wifinora_t * | ctx, |
uint8_t * | at_cmd_buf | ||
) |
WiFi NORA send command function.
This function is used to send a desired command.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
[in] | at_cmd_buf | : Command string. |
void wifinora_send_cmd_check | ( | wifinora_t * | ctx, |
uint8_t * | at_cmd_buf | ||
) |
WiFi NORA send command check function.
This function sends a desired command with the question mark for checking parameters.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
[in] | at_cmd_buf | : Command string. |
void wifinora_send_cmd_with_par | ( | wifinora_t * | ctx, |
uint8_t * | at_cmd_buf, | ||
uint8_t * | param_buf | ||
) |
WiFi NORA send command with parameter function.
This function sends a desired command with the parameter.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
[in] | at_cmd_buf | : Command string. |
[in] | param_buf | : Parameters string. |
void wifinora_set_cts_pin | ( | wifinora_t * | ctx, |
uint8_t | pin_state | ||
) |
WiFi NORA set CTS pin function.
This function is used to set CTS pin state.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
[in] | pin_state | : State of the CTS pin. |
void wifinora_set_rst_pin | ( | wifinora_t * | ctx, |
uint8_t | pin_state | ||
) |
WiFi NORA set RST pin function.
This function is used to set RST pin state.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
[in] | pin_state | : State of the RST pin. |
void wifinora_set_wkp_pin | ( | wifinora_t * | ctx, |
uint8_t | pin_state | ||
) |
WiFi NORA set WKP pin function.
This function is used to set WKP pin state.
[in] | ctx | : Click context object. See wifinora_t object definition for detailed explanation. |
[in] | pin_state | : State of the WKP pin. |