accelqvar  2.1.0.0
Modules | Functions
AccelQvar Click Driver

API for configuring and manipulating AccelQvar Click driver. More...

Modules

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

Functions

void accelqvar_cfg_setup (accelqvar_cfg_t *cfg)
 AccelQvar configuration object setup function. More...
 
void accelqvar_drv_interface_sel (accelqvar_cfg_t *cfg, accelqvar_drv_t drv_sel)
 AccelQvar driver interface setup function. More...
 
err_t accelqvar_init (accelqvar_t *ctx, accelqvar_cfg_t *cfg)
 AccelQvar initialization function. More...
 
err_t accelqvar_default_cfg (accelqvar_t *ctx)
 AccelQvar default configuration function. More...
 
err_t accelqvar_generic_write (accelqvar_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 AccelQvar data writing function. More...
 
err_t accelqvar_generic_read (accelqvar_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 AccelQvar data reading function. More...
 
err_t accelqvar_get_device_id (accelqvar_t *ctx, uint8_t *device_id)
 AccelQvar get device ID function. More...
 
err_t accelqvar_sw_reset (accelqvar_t *ctx)
 AccelQvar software reset function. More...
 
err_t accelqvar_set_odr (accelqvar_t *ctx, uint8_t odr)
 AccelQvar ODR selection function. More...
 
err_t accelqvar_set_fsr (accelqvar_t *ctx, uint8_t fsr)
 AccelQvar set full scale function. More...
 
err_t accelqvar_get_axes_data (accelqvar_t *ctx, accelqvar_axes_t *axes)
 AccelQvar get the accel sensor axes function. More...
 
err_t accelqvar_spi_wake_up (accelqvar_t *ctx)
 AccelQvar SPI wake up function. More...
 
err_t accelqvar_en_qvar (accelqvar_t *ctx)
 AccelQvar enable QVAR function. More...
 
err_t accelqvar_get_qvar_data (accelqvar_t *ctx, float *qvar)
 AccelQvar get QVAR data function. More...
 
uint8_t accelqvar_get_int1 (accelqvar_t *ctx)
 AccelQvar get interrupt 1 function. More...
 
uint8_t accelqvar_get_int2 (accelqvar_t *ctx)
 AccelQvar get interrupt 2 function. More...
 

Detailed Description

API for configuring and manipulating AccelQvar Click driver.

Function Documentation

◆ accelqvar_cfg_setup()

void accelqvar_cfg_setup ( accelqvar_cfg_t cfg)

AccelQvar configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ accelqvar_default_cfg()

err_t accelqvar_default_cfg ( accelqvar_t ctx)

AccelQvar default configuration function.

This function executes a default configuration of AccelQvar click board.

Parameters
[in]ctx: Click context object. See accelqvar_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ accelqvar_drv_interface_sel()

void accelqvar_drv_interface_sel ( accelqvar_cfg_t cfg,
accelqvar_drv_t  drv_sel 
)

AccelQvar driver interface setup function.

This function sets a serial driver interface which will be used further in the click driver.

Parameters
[out]cfg: Click configuration structure. See accelqvar_cfg_t object definition for detailed explanation.
[in]drv_sel: Driver interface selection. See accelqvar_drv_t object definition for detailed explanation.
Returns
Nothing.
Note
This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

◆ accelqvar_en_qvar()

err_t accelqvar_en_qvar ( accelqvar_t ctx)

AccelQvar enable QVAR function.

This function enables the analog hub and Qvar chain of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

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

◆ accelqvar_generic_read()

err_t accelqvar_generic_read ( accelqvar_t ctx,
uint8_t  reg,
uint8_t *  data_out,
uint8_t  len 
)

AccelQvar data reading function.

This function reads a desired number of data bytes starting from the selected register.

Parameters
[in]ctx: Click context object. See accelqvar_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ accelqvar_generic_write()

err_t accelqvar_generic_write ( accelqvar_t ctx,
uint8_t  reg,
uint8_t *  data_in,
uint8_t  len 
)

AccelQvar data writing function.

This function writes a desired number of data bytes starting from the selected register.

Parameters
[in]ctx: Click context object. See accelqvar_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Data to be written.
[in]len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ accelqvar_get_axes_data()

err_t accelqvar_get_axes_data ( accelqvar_t ctx,
accelqvar_axes_t axes 
)

AccelQvar get the accel sensor axes function.

This function reads the accelerometer sensor axes data of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

Parameters
[in]ctx: Click context object. See accelqvar_t object definition for detailed explanation.
[out]axes: Linear acceleration output data object [mg]. See accelqvar_axes_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ accelqvar_get_device_id()

err_t accelqvar_get_device_id ( accelqvar_t ctx,
uint8_t *  device_id 
)

AccelQvar get device ID function.

This function reads the device identification data of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

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

◆ accelqvar_get_int1()

uint8_t accelqvar_get_int1 ( accelqvar_t ctx)

AccelQvar get interrupt 1 function.

This function get states of the interrupt 1 [AN] pin of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

Parameters
[in]ctx: Click context object. See accelqvar_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ accelqvar_get_int2()

uint8_t accelqvar_get_int2 ( accelqvar_t ctx)

AccelQvar get interrupt 2 function.

This function get states of the interrupt 2 [INT] pin of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

Parameters
[in]ctx: Click context object. See accelqvar_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ accelqvar_get_qvar_data()

err_t accelqvar_get_qvar_data ( accelqvar_t ctx,
float *  qvar 
)

AccelQvar get QVAR data function.

This function reads the Qvar electrostatic sensor data output of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

Parameters
[in]ctx: Click context object. See accelqvar_t object definition for detailed explanation.
[out]qvar: Qvar electrostatic sensor data output [mV].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ accelqvar_init()

err_t accelqvar_init ( accelqvar_t ctx,
accelqvar_cfg_t cfg 
)

AccelQvar initialization function.

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

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

◆ accelqvar_set_fsr()

err_t accelqvar_set_fsr ( accelqvar_t ctx,
uint8_t  fsr 
)

AccelQvar set full scale function.

This function sets the full scale data of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

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

◆ accelqvar_set_odr()

err_t accelqvar_set_odr ( accelqvar_t ctx,
uint8_t  odr 
)

AccelQvar ODR selection function.

This function is used for the ODR selection of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

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

◆ accelqvar_spi_wake_up()

err_t accelqvar_spi_wake_up ( accelqvar_t ctx)

AccelQvar SPI wake up function.

This function performs deep power-down to soft power-down when the SPI interface of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

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

◆ accelqvar_sw_reset()

err_t accelqvar_sw_reset ( accelqvar_t ctx)

AccelQvar software reset function.

This function trigger the soft reset sequence of the LIS2DUXS12, Ultralow-power accelerometer with Qvar, AI, & anti-aliasing on the AccelQvar Click board?.

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