accel4 2.0.0.0
Topics | Functions
Accel 4 Click Driver

API for configuring and manipulating Accel 4 Click driver. More...

Topics

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

Functions

void accel4_cfg_setup (accel4_cfg_t *cfg)
 Accel 4 configuration object setup function.
 
void accel4_drv_interface_selection (accel4_cfg_t *cfg, accel4_drv_t drv_sel)
 Accel 4 driver interface setup function.
 
err_t accel4_init (accel4_t *ctx, accel4_cfg_t *cfg)
 Accel 4 initialization function.
 
err_t accel4_default_cfg (accel4_t *ctx)
 Accel 4 default configuration function.
 
err_t accel4_generic_write (accel4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 Accel 4 data writing function.
 
err_t accel4_generic_read (accel4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 Accel 4 data reading function.
 
uint8_t accel4_get_int1 (accel4_t *ctx)
 Get interrupt 1 pin state.
 
uint8_t accel4_get_int2 (accel4_t *ctx)
 Get interrupt 2 pin state.
 
err_t accel4_get_axes_data (accel4_t *ctx, accel4_axes_t *axes)
 Accel data reading.
 
float accel4_axes_get_resolution (accel4_t *ctx)
 Reads current resolution of output data.
 

Detailed Description

API for configuring and manipulating Accel 4 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

◆ accel4_axes_get_resolution()

float accel4_axes_get_resolution ( accel4_t * ctx)

Reads current resolution of output data.

This function reads current configuration for resolution of output data.

Parameters
[in]ctx: Click context object. See accel4_t object definition for detailed explanation.
Returns
Resolution of the output data.
Note
User should call this function and set updated data to context object whenever the configuration is changed.

◆ accel4_cfg_setup()

void accel4_cfg_setup ( accel4_cfg_t * cfg)

Accel 4 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ accel4_default_cfg()

err_t accel4_default_cfg ( accel4_t * ctx)

Accel 4 default configuration function.

This function executes a default configuration of Accel 4 click board.

Parameters
[in]ctx: Click context object. See accel4_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.

◆ accel4_drv_interface_selection()

void accel4_drv_interface_selection ( accel4_cfg_t * cfg,
accel4_drv_t drv_sel )

Accel 4 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 accel4_cfg_t object definition for detailed explanation.
[in]drv_sel: Driver interface selection. See accel4_drv_t object definition for detailed explanation.
Returns
Nothing.
Note
This driver selection should be call 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.

◆ accel4_generic_read()

err_t accel4_generic_read ( accel4_t * ctx,
uint8_t reg,
uint8_t * data_out,
uint8_t len )

Accel 4 data reading function.

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

Parameters
[in]ctx: Click context object. See accel4_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.

◆ accel4_generic_write()

err_t accel4_generic_write ( accel4_t * ctx,
uint8_t reg,
uint8_t * data_in,
uint8_t len )

Accel 4 data writing function.

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

Parameters
[in]ctx: Click context object. See accel4_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.

◆ accel4_get_axes_data()

err_t accel4_get_axes_data ( accel4_t * ctx,
accel4_axes_t * axes )

Accel data reading.

This function reads a accel data and calculates it with resolution set in ctx object. Data will be set in axes object.

Parameters
[in]ctx: Click context object. See accel4_t object definition for detailed explanation.
[out]axes: Axes data object. See accel4_axes_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.

◆ accel4_get_int1()

uint8_t accel4_get_int1 ( accel4_t * ctx)

Get interrupt 1 pin state.

This function reads logic state of interrupt 1 pin.

Parameters
[in]ctx: Click context object. See accel4_t object definition for detailed explanation.
Returns
State of interrupt pin.

◆ accel4_get_int2()

uint8_t accel4_get_int2 ( accel4_t * ctx)

Get interrupt 2 pin state.

This function reads logic state of interrupt 2 pin.

Parameters
[in]ctx: Click context object. See accel4_t object definition for detailed explanation.
Returns
State of interrupt pin.

◆ accel4_init()

err_t accel4_init ( accel4_t * ctx,
accel4_cfg_t * cfg )

Accel 4 initialization function.

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

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