ezocarrierdo 2.1.0.0
Modules | Macros | Functions
EZO Carrier DO Click Driver

API for configuring and manipulating EZO Carrier DO Click driver. More...

Modules

 EZO Carrier DO Device Settings
 Settings for registers of EZO Carrier DO Click driver.
 
 EZO Carrier DO MikroBUS Map
 MikroBUS pin mapping of EZO Carrier DO Click driver.
 

Macros

#define EZOCARRIERDO_DEVICE_ADDRESS   0x61
 EZO Carrier DO device address setting. More...
 

Functions

void ezocarrierdo_cfg_setup (ezocarrierdo_cfg_t *cfg)
 EZO Carrier DO configuration object setup function. More...
 
err_t ezocarrierdo_init (ezocarrierdo_t *ctx, ezocarrierdo_cfg_t *cfg)
 EZO Carrier DO initialization function. More...
 
err_t ezocarrierdo_generic_write (ezocarrierdo_t *ctx, uint8_t *data_in, uint16_t len)
 EZO Carrier DO data writing function. More...
 
err_t ezocarrierdo_generic_read (ezocarrierdo_t *ctx, uint8_t *data_out, uint16_t len)
 EZO Carrier DO data reading function. More...
 
void ezocarrierdo_send_cmd (ezocarrierdo_t *ctx, uint8_t *cmd)
 Send command function. More...
 
void ezocarrierdo_send_cmd_with_par (ezocarrierdo_t *ctx, uint8_t *cmd, uint8_t *param_buf)
 Send command function with parameter. More...
 
void ezocarrierdo_send_cmd_check (ezocarrierdo_t *ctx, uint8_t *cmd)
 Check the sent command. More...
 

Detailed Description

API for configuring and manipulating EZO Carrier DO Click driver.

Macro Definition Documentation

◆ EZOCARRIERDO_DEVICE_ADDRESS

#define EZOCARRIERDO_DEVICE_ADDRESS   0x61

EZO Carrier DO device address setting.

Specified setting for device slave address selection of EZO Carrier DO Click driver.

Function Documentation

◆ ezocarrierdo_cfg_setup()

void ezocarrierdo_cfg_setup ( ezocarrierdo_cfg_t cfg)

EZO Carrier DO configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See ezocarrierdo_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ ezocarrierdo_generic_read()

err_t ezocarrierdo_generic_read ( ezocarrierdo_t ctx,
uint8_t *  data_out,
uint16_t  len 
)

EZO Carrier DO data reading function.

This function reads a desired number of data bytes by using UART serial interface, or I2C serial interface.

Parameters
[in]ctx: Click context object. See ezocarrierdo_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.
Note
None.

◆ ezocarrierdo_generic_write()

err_t ezocarrierdo_generic_write ( ezocarrierdo_t ctx,
uint8_t *  data_in,
uint16_t  len 
)

EZO Carrier DO data writing function.

This function writes a desired number of data bytes by using UART serial interface, or I2C serial interface.

Parameters
[in]ctx: Click context object. See ezocarrierdo_t object definition for detailed explanation.
[in]data_in: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ezocarrierdo_init()

err_t ezocarrierdo_init ( ezocarrierdo_t ctx,
ezocarrierdo_cfg_t cfg 
)

EZO Carrier DO initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See ezocarrierdo_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See ezocarrierdo_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ezocarrierdo_send_cmd()

void ezocarrierdo_send_cmd ( ezocarrierdo_t ctx,
uint8_t *  cmd 
)

Send command function.

This function sends a specified command to the click module.

Parameters
[in]ctx: Click context object. See ezocarrierdo_t object definition for detailed explanation.
[in]cmd: Command buffer.
Returns
Nothing.
Note
None.

◆ ezocarrierdo_send_cmd_check()

void ezocarrierdo_send_cmd_check ( ezocarrierdo_t ctx,
uint8_t *  cmd 
)

Check the sent command.

This function checks the command that is sent.

Parameters
[in]ctx: Click context object. See ezocarrierdo_t object definition for detailed explanation.
[in]cmd: Command buffer.
Returns
Nothing.
Note
None.

◆ ezocarrierdo_send_cmd_with_par()

void ezocarrierdo_send_cmd_with_par ( ezocarrierdo_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.

Parameters
[in]ctx: Click context object. See ezocarrierdo_t object definition for detailed explanation.
[in]cmd: Command buffer.
[in]param_buf: Parameter buffer.
Returns
Nothing.
Note
None.