alcohol2  2.0.0.0
Functions
Public function

Functions

ALCOHOL2_RETVAL alcohol2_init (alcohol2_t *ctx, alcohol2_cfg_t *cfg)
 Initialization function. More...
 
void alcohol2_default_cfg (alcohol2_t *ctx)
 Click Default Configuration function. More...
 
void alcohol2_generic_write (alcohol2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void alcohol2_generic_read (alcohol2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
void alcohol2_write_byte (alcohol2_t *ctx, uint8_t reg, uint8_t w_data)
 Function writes one byte to the register. More...
 
uint8_t alcohol2_read_byte (alcohol2_t *ctx, uint8_t reg)
 Function reads one byte from the register. More...
 
void alcohol2_enable (alcohol2_t *ctx, uint8_t state)
 Device Enable function. More...
 
uint16_t alcohol2_read_alcohol (alcohol2_t *ctx)
 Function for read Alcohol data. More...
 
void alcohol2_wait_ready (alcohol2_t *ctx)
 Function waits until I2C is ready for the next command. More...
 

Detailed Description

Function Documentation

◆ alcohol2_default_cfg()

void alcohol2_default_cfg ( alcohol2_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for Alcohol2 click.

◆ alcohol2_enable()

void alcohol2_enable ( alcohol2_t ctx,
uint8_t  state 
)

Device Enable function.

Parameters
ctxClick object.
stateState.

This function enable device.

◆ alcohol2_generic_read()

void alcohol2_generic_read ( alcohol2_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

This function reads data from the desired register.

◆ alcohol2_generic_write()

void alcohol2_generic_write ( alcohol2_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

This function writes data to the desired register.

◆ alcohol2_init()

ALCOHOL2_RETVAL alcohol2_init ( alcohol2_t ctx,
alcohol2_cfg_t cfg 
)

Initialization function.

Parameters
alcohol2Click object.
cfgClick configuration structure.

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

◆ alcohol2_read_alcohol()

uint16_t alcohol2_read_alcohol ( alcohol2_t ctx)

Function for read Alcohol data.

Parameters
ctxClick object.

This function reads Alcohol data.

◆ alcohol2_read_byte()

uint8_t alcohol2_read_byte ( alcohol2_t ctx,
uint8_t  reg 
)

Function reads one byte from the register.

Parameters
ctxClick object.
regRegister address.

This function reads one byte from the register.

◆ alcohol2_wait_ready()

void alcohol2_wait_ready ( alcohol2_t ctx)

Function waits until I2C is ready for the next command.

Parameters
ctxClick object.

This function waits until I2C is ready for the next command.

◆ alcohol2_write_byte()

void alcohol2_write_byte ( alcohol2_t ctx,
uint8_t  reg,
uint8_t  w_data 
)

Function writes one byte to the register.

Parameters
ctxClick object.
regRegister address.
W_dataData to be written.

This function writes one byte to the register.