dac10 2.0.0.0
Topics | Functions
DAC 10 Click Driver

API for configuring and manipulating DAC 10 Click driver. More...

Topics

 DAC 10 Registers List
 List of registers of DAC 10 Click driver.
 
 DAC 10 Registers Settings
 Settings for registers of DAC 10 Click driver.
 
 DAC 10 MikroBUS Map
 MikroBUS pin mapping of DAC 10 Click driver.
 

Functions

void dac10_cfg_setup (dac10_cfg_t *cfg)
 DAC 10 configuration object setup function.
 
err_t dac10_init (dac10_t *ctx, dac10_cfg_t *cfg)
 DAC 10 initialization function.
 
err_t dac10_reg_write (dac10_t *ctx, uint8_t reg, uint16_t data_in)
 DAC 10 I2C writing function.
 
err_t dac10_reg_read (dac10_t *ctx, uint8_t reg, uint16_t *data_in)
 DAC 10 I2C reading function.
 
err_t dac10_set_dac_value (dac10_t *ctx, uint16_t data_in)
 DAC 10 set dac value function.
 
err_t dac10_set_output_voltage (dac10_t *ctx, float vref, float voltage)
 DAC 10 set output voltage function.
 
err_t dac10_set_output_voltage_int_vref (dac10_t *ctx, float voltage)
 DAC 10 set output voltage with internal reference function.
 
err_t dac10_set_dac_margin_high (dac10_t *ctx, uint16_t data_in)
 DAC 10 set dac margin high function.
 
err_t dac10_set_dac_margin_low (dac10_t *ctx, uint16_t data_in)
 DAC 10 set dac margin low function.
 
err_t dac10_check_device_id (dac10_t *ctx)
 DAC 10 check device ID function.
 
err_t dac10_enable_dac (dac10_t *ctx)
 DAC 10 enable DAC output function.
 

Detailed Description

API for configuring and manipulating DAC 10 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ dac10_cfg_setup()

void dac10_cfg_setup ( dac10_cfg_t * cfg)

DAC 10 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ dac10_check_device_id()

err_t dac10_check_device_id ( dac10_t * ctx)

DAC 10 check device ID function.

This function checks the communication by reading and verifying the device ID.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ dac10_enable_dac()

err_t dac10_enable_dac ( dac10_t * ctx)

DAC 10 enable DAC output function.

This function enables the DAC output.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ dac10_init()

err_t dac10_init ( dac10_t * ctx,
dac10_cfg_t * cfg )

DAC 10 initialization function.

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

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

◆ dac10_reg_read()

err_t dac10_reg_read ( dac10_t * ctx,
uint8_t reg,
uint16_t * data_in )

DAC 10 I2C reading function.

This function reads two bytes of data from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
[in]reg: Register address.
[out]data_in: Output read data.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ dac10_reg_write()

err_t dac10_reg_write ( dac10_t * ctx,
uint8_t reg,
uint16_t data_in )

DAC 10 I2C writing function.

This function writes a two bytes of data to the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
[in]reg: Register address.
[in]data_in: Data to be written.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ dac10_set_dac_margin_high()

err_t dac10_set_dac_margin_high ( dac10_t * ctx,
uint16_t data_in )

DAC 10 set dac margin high function.

This function sets the DAC MARGIH HIGH register to a desired value.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
[in]data_in: 10-bit data input.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ dac10_set_dac_margin_low()

err_t dac10_set_dac_margin_low ( dac10_t * ctx,
uint16_t data_in )

DAC 10 set dac margin low function.

This function sets the DAC MARGIH LOW register to a desired value.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
[in]data_in: 10-bit data input.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ dac10_set_dac_value()

err_t dac10_set_dac_value ( dac10_t * ctx,
uint16_t data_in )

DAC 10 set dac value function.

This function sets the DAC DATA register to a desired value.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
[in]data_in: 10-bit DAC data.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ dac10_set_output_voltage()

err_t dac10_set_output_voltage ( dac10_t * ctx,
float vref,
float voltage )

DAC 10 set output voltage function.

This function sets the output voltage depending on the vref value defined by the VCC SEL on-board jumper. VREF and Voltage values can be either in Volts or Milivolts.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
[in]vref: VREF value defined by VCC SEL on-board jumper.
[in]voltage: Float value to be set as output voltage.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ dac10_set_output_voltage_int_vref()

err_t dac10_set_output_voltage_int_vref ( dac10_t * ctx,
float voltage )

DAC 10 set output voltage with internal reference function.

This function sets the output voltage with the internal reference enabled.

Parameters
[in]ctx: Click context object. See dac10_t object definition for detailed explanation.
[in]voltage: Float value to be set as output voltage ( in Volts ).
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.