|
wizfi360 2.2.0
|
API for configuring and manipulating WIZFI360 Click driver. More...
Topics | |
| WIZFI360 Device Settings | |
| Settings for registers of WIZFI360 Click driver. | |
| WIZFI360 MikroBUS Map | |
| MikroBUS pin mapping of WIZFI360 Click driver. | |
Functions | |
| void | wizfi360_cfg_setup (wizfi360_cfg_t *cfg) |
| WIZFI360 configuration object setup function. | |
| err_t | wizfi360_init (wizfi360_t *ctx, wizfi360_cfg_t *cfg) |
| WIZFI360 initialization function. | |
| void | wizfi360_set_rst_pin (wizfi360_t *ctx, uint8_t state) |
| WIZFI360 set RST pin state function. | |
| void | wizfi360_set_bt_pin (wizfi360_t *ctx, uint8_t state) |
| WIZFI360 set BT pin state function. | |
| void | wizfi360_wake_up (wizfi360_t *ctx) |
| WIZFI360 wake up function. | |
| void | wizfi360_standby (wizfi360_t *ctx) |
| WIZFI360 standby function. | |
| uint8_t | wizfi360_request_to_send (wizfi360_t *ctx) |
| WIZFI360 get request to send pin state function. | |
| void | wizfi360_clear_to_send (wizfi360_t *ctx, uint8_t state) |
| WIZFI360 set clear to send pin state function. | |
| err_t | wizfi360_generic_write (wizfi360_t *ctx, uint8_t *data_in, uint16_t len) |
| WIZFI360 data writing function. | |
| err_t | wizfi360_generic_read (wizfi360_t *ctx, uint8_t *data_out, uint16_t len) |
| WIZFI360 data reading function. | |
| err_t | wizfi360_write_command (wizfi360_t *ctx, uint8_t *command) |
| WIZFI360 command writing function. | |
| err_t | wizfi360_write_cmd_param (wizfi360_t *ctx, uint8_t *command, uint8_t *prefix, uint8_t *param) |
| WIZFI360 command - prefix - parameter writing function. | |
| err_t | wizfi360_inquire_command (wizfi360_t *ctx, uint8_t *command) |
| WIZFI360 inquire command function. | |
| err_t | wizfi360_send_message (wizfi360_t *ctx, uint8_t *message) |
| WIZFI360 send message function. | |
API for configuring and manipulating WIZFI360 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void wizfi360_cfg_setup | ( | wizfi360_cfg_t * | cfg | ) |
WIZFI360 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See wizfi360_cfg_t object definition for detailed explanation. |
| void wizfi360_clear_to_send | ( | wizfi360_t * | ctx, |
| uint8_t | state ) |
WIZFI360 set clear to send pin state function.
This function sets a desired logic state of the CTS pin.
| [in] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| err_t wizfi360_generic_read | ( | wizfi360_t * | ctx, |
| uint8_t * | data_out, | ||
| uint16_t | len ) |
WIZFI360 data reading function.
This function reads a desired number of data bytes by using the UART serial interface.
| [in] | ctx | : Click context object. See wizfi360_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 wizfi360_generic_write | ( | wizfi360_t * | ctx, |
| uint8_t * | data_in, | ||
| uint16_t | len ) |
WIZFI360 data writing function.
This function writes a desired number of data bytes by using the UART serial interface.
| [in] | ctx | : Click context object. See wizfi360_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. | err_t wizfi360_init | ( | wizfi360_t * | ctx, |
| wizfi360_cfg_t * | cfg ) |
WIZFI360 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See wizfi360_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t wizfi360_inquire_command | ( | wizfi360_t * | ctx, |
| uint8_t * | command ) |
WIZFI360 inquire command function.
This function writes a desired inquire command by using UART serial interface.
| [in] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| [in] | command | : Inquire command buffer for sending. |
>=0 - Success, <0 - Error. See #err_t definition for detailed explanation. | uint8_t wizfi360_request_to_send | ( | wizfi360_t * | ctx | ) |
WIZFI360 get request to send pin state function.
This function return logic state of the RTS pin. to the normal operating mode.
| [out] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| err_t wizfi360_send_message | ( | wizfi360_t * | ctx, |
| uint8_t * | message ) |
WIZFI360 send message function.
This function sends messages to the host in normal transmission mode using the UART serial interface.
| [in] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| [in] | message | : Message data buffer for sending. |
>=0 - Success, <0 - Error. See #err_t definition for detailed explanation. | void wizfi360_set_bt_pin | ( | wizfi360_t * | ctx, |
| uint8_t | state ) |
WIZFI360 set BT pin state function.
This function sets a desired logic state of the BT pin.
| [out] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| void wizfi360_set_rst_pin | ( | wizfi360_t * | ctx, |
| uint8_t | state ) |
WIZFI360 set RST pin state function.
This function sets a desired logic state of the RST pin.
| [out] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| void wizfi360_standby | ( | wizfi360_t * | ctx | ) |
WIZFI360 standby function.
This function performs the standby mode.
| [out] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| void wizfi360_wake_up | ( | wizfi360_t * | ctx | ) |
WIZFI360 wake up function.
This function performs the wake-up and the module is reset to the normal operating mode.
| [out] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| err_t wizfi360_write_cmd_param | ( | wizfi360_t * | ctx, |
| uint8_t * | command, | ||
| uint8_t * | prefix, | ||
| uint8_t * | param ) |
WIZFI360 command - prefix - parameter writing function.
This function writes a desired command, prefix and parameter by using UART serial interface.
| [in] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| [in] | command | : Command buffer for sending. |
| [in] | prefix | : Prefix buffer for sending. |
| [in] | param | : Parameter buffer for sending. |
>=0 - Success, <0 - Error. See #err_t definition for detailed explanation. | err_t wizfi360_write_command | ( | wizfi360_t * | ctx, |
| uint8_t * | command ) |
WIZFI360 command writing function.
This function writes a desired command by using the UART serial interface.
| [in] | ctx | : Click context object. See wizfi360_t object definition for detailed explanation. |
| [in] | command | : Command buffer for sending. |
>=0 - Success, <0 - Error. See #err_t definition for detailed explanation.