ezocarrierec 2.1.0.0
|
API for configuring and manipulating EZO Carrier EC Click driver. More...
Modules | |
EZO Carrier EC Device Settings | |
Settings for registers of EZO Carrier EC Click driver. | |
EZO Carrier EC MikroBUS Map | |
MikroBUS pin mapping of EZO Carrier EC Click driver. | |
Functions | |
void | ezocarrierec_cfg_setup (ezocarrierec_cfg_t *cfg) |
EZO Carrier EC configuration object setup function. More... | |
void | ezocarrierec_drv_interface_sel (ezocarrierec_cfg_t *cfg, ezocarrierec_drv_t drv_sel) |
EZO Carrier EC driver interface setup function. More... | |
err_t | ezocarrierec_init (ezocarrierec_t *ctx, ezocarrierec_cfg_t *cfg) |
EZO Carrier EC initialization function. More... | |
err_t | ezocarrierec_generic_write (ezocarrierec_t *ctx, uint8_t *data_in, uint16_t len) |
EZO Carrier EC data writing function. More... | |
err_t | ezocarrierec_generic_read (ezocarrierec_t *ctx, uint8_t *data_out, uint16_t len) |
EZO Carrier EC data reading function. More... | |
void | ezocarrierec_send_cmd (ezocarrierec_t *ctx, uint8_t *cmd) |
Send command function. More... | |
void | ezocarrierec_send_cmd_with_par (ezocarrierec_t *ctx, uint8_t *cmd, uint8_t *param_buf) |
Send command function with parameter. More... | |
void | ezocarrierec_send_cmd_check (ezocarrierec_t *ctx, uint8_t *cmd) |
Check the sent command. More... | |
API for configuring and manipulating EZO Carrier EC Click driver.
void ezocarrierec_cfg_setup | ( | ezocarrierec_cfg_t * | cfg | ) |
EZO Carrier EC configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See ezocarrierec_cfg_t object definition for detailed explanation. |
void ezocarrierec_drv_interface_sel | ( | ezocarrierec_cfg_t * | cfg, |
ezocarrierec_drv_t | drv_sel | ||
) |
EZO Carrier EC driver interface setup function.
This function sets a serial driver interface which will be used further in the click driver.
[out] | cfg | : Click configuration structure. See ezocarrierec_cfg_t object definition for detailed explanation. |
[in] | drv_sel | : Driver interface selection. See ezocarrierec_drv_t object definition for detailed explanation. |
err_t ezocarrierec_generic_read | ( | ezocarrierec_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
EZO Carrier EC data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ezocarrierec_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 ezocarrierec_generic_write | ( | ezocarrierec_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
EZO Carrier EC data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ezocarrierec_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 ezocarrierec_init | ( | ezocarrierec_t * | ctx, |
ezocarrierec_cfg_t * | cfg | ||
) |
EZO Carrier EC initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See ezocarrierec_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See ezocarrierec_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void ezocarrierec_send_cmd | ( | ezocarrierec_t * | ctx, |
uint8_t * | cmd | ||
) |
Send command function.
This function sends a specified command to the click module.
[in] | ctx | : Click context object. See ezocarrierec_t object definition for detailed explanation. |
[in] | cmd | : Command buffer. |
void ezocarrierec_send_cmd_check | ( | ezocarrierec_t * | ctx, |
uint8_t * | cmd | ||
) |
Check the sent command.
This function checks the command that is sent.
[in] | ctx | : Click context object. See ezocarrierec_t object definition for detailed explanation. |
[in] | cmd | : Command buffer. |
void ezocarrierec_send_cmd_with_par | ( | ezocarrierec_t * | ctx, |
uint8_t * | cmd, | ||
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 ezocarrierec_t object definition for detailed explanation. |
[in] | cmd | : Command buffer. |
[in] | param_buf | : Parameter buffer. |