ezocarrierec 2.1.0.0
ezocarrierec.h File Reference

This file contains API for EZO Carrier EC Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  ezocarrierec_t
 EZO Carrier EC Click context object. More...
 
struct  ezocarrierec_cfg_t
 EZO Carrier EC Click configuration object. More...
 

Enumerations

enum  ezocarrierec_drv_t { EZOCARRIEREC_DRV_SEL_I2C , EZOCARRIEREC_DRV_SEL_UART }
 EZO Carrier EC Click driver selector. More...
 
enum  ezocarrierec_return_value_t { EZOCARRIEREC_OK = 0 , EZOCARRIEREC_ERROR = -1 , EZOCARRIEREC_ERROR_TIMEOUT = -2 }
 EZO Carrier EC Click return value data. More...
 

Functions

void ezocarrierec_cfg_setup (ezocarrierec_cfg_t *cfg)
 EZO Carrier EC configuration object setup function.
 
void ezocarrierec_drv_interface_sel (ezocarrierec_cfg_t *cfg, ezocarrierec_drv_t drv_sel)
 EZO Carrier EC driver interface setup function.
 
err_t ezocarrierec_init (ezocarrierec_t *ctx, ezocarrierec_cfg_t *cfg)
 EZO Carrier EC initialization function.
 
err_t ezocarrierec_generic_write (ezocarrierec_t *ctx, uint8_t *data_in, uint16_t len)
 EZO Carrier EC data writing function.
 
err_t ezocarrierec_generic_read (ezocarrierec_t *ctx, uint8_t *data_out, uint16_t len)
 EZO Carrier EC data reading function.
 
void ezocarrierec_send_cmd (ezocarrierec_t *ctx, uint8_t *cmd)
 Send command function.
 
void ezocarrierec_send_cmd_with_par (ezocarrierec_t *ctx, uint8_t *cmd, uint8_t *param_buf)
 Send command function with parameter.
 
void ezocarrierec_send_cmd_check (ezocarrierec_t *ctx, uint8_t *cmd)
 Check the sent command.
 

Detailed Description

This file contains API for EZO Carrier EC Click Driver.

Enumeration Type Documentation

◆ ezocarrierec_drv_t

EZO Carrier EC Click driver selector.

Selects target driver interface of EZO Carrier EC Click driver.

Enumerator
EZOCARRIEREC_DRV_SEL_I2C 

I2C driver descriptor.

EZOCARRIEREC_DRV_SEL_UART 

UART driver descriptor.

◆ ezocarrierec_return_value_t

EZO Carrier EC Click return value data.

Predefined enum values for driver return values.

Enumerator
EZOCARRIEREC_OK 
EZOCARRIEREC_ERROR 
EZOCARRIEREC_ERROR_TIMEOUT