piezoaccel225g  2.1.0.0
Modules | Functions
Piezo Accel 2 25g Click Driver

API for configuring and manipulating Piezo Accel 2 25g Click driver. More...

Modules

 Piezo Accel 2 25g Fast Commands List
 List of fast commands of Piezo Accel 2 25g Click driver.
 
 Piezo Accel 2 25g Registers List
 List of registers of Piezo Accel 2 25g Click driver.
 
 Piezo Accel 2 25g Registers Settings
 Settings for registers of Piezo Accel 2 25g Click driver.
 
 Piezo Accel 2 25g MikroBUS Map
 MikroBUS pin mapping of Piezo Accel 2 25g Click driver.
 

Functions

void piezoaccel225g_cfg_setup (piezoaccel225g_cfg_t *cfg)
 Piezo Accel 2 25g configuration object setup function. More...
 
err_t piezoaccel225g_init (piezoaccel225g_t *ctx, piezoaccel225g_cfg_t *cfg)
 Piezo Accel 2 25g initialization function. More...
 
err_t piezoaccel225g_default_cfg (piezoaccel225g_t *ctx)
 Piezo Accel 2 25g default configuration function. More...
 
err_t piezoaccel225g_fast_cmd_write (piezoaccel225g_t *ctx, uint8_t fast_cmd)
 Piezo Accel 2 25g fast cmd write function. More...
 
err_t piezoaccel225g_reg_write_multi (piezoaccel225g_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 Piezo Accel 2 25g reg write multi function. More...
 
err_t piezoaccel225g_reg_write_8 (piezoaccel225g_t *ctx, uint8_t reg, uint8_t data_in)
 Piezo Accel 2 25g reg write 8 function. More...
 
err_t piezoaccel225g_reg_write_24 (piezoaccel225g_t *ctx, uint8_t reg, uint32_t data_in)
 Piezo Accel 2 25g reg write 24 function. More...
 
err_t piezoaccel225g_reg_read_multi (piezoaccel225g_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 Piezo Accel 2 25g reg read multi function. More...
 
err_t piezoaccel225g_reg_read_8 (piezoaccel225g_t *ctx, uint8_t reg, uint8_t *data_out)
 Piezo Accel 2 25g reg read 8 function. More...
 
err_t piezoaccel225g_reg_read_24 (piezoaccel225g_t *ctx, uint8_t reg, uint32_t *data_out)
 Piezo Accel 2 25g reg read 24 function. More...
 
err_t piezoaccel225g_reg_read_32 (piezoaccel225g_t *ctx, uint8_t reg, uint32_t *data_out)
 Piezo Accel 2 25g reg read 32 function. More...
 
err_t piezoaccel225g_unlock_reg_write (piezoaccel225g_t *ctx)
 Piezo Accel 2 25g unlock reg write function. More...
 
err_t piezoaccel225g_lock_reg_write (piezoaccel225g_t *ctx)
 Piezo Accel 2 25g lock reg write function. More...
 
uint8_t piezoaccel225g_get_clk_pin (piezoaccel225g_t *ctx)
 Piezo Accel 2 25g get clk pin function. More...
 
uint8_t piezoaccel225g_get_irq_pin (piezoaccel225g_t *ctx)
 Piezo Accel 2 25g get irq pin function. More...
 
err_t piezoaccel225g_wait_data_ready (piezoaccel225g_t *ctx, uint16_t timeout_ms)
 Piezo Accel 2 25g wait data ready function. More...
 
err_t piezoaccel225g_read_adc_data (piezoaccel225g_t *ctx, piezoaccel225g_adc_data_t *data_out)
 Piezo Accel 2 25g read adc data function. More...
 

Detailed Description

API for configuring and manipulating Piezo Accel 2 25g 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

◆ piezoaccel225g_cfg_setup()

void piezoaccel225g_cfg_setup ( piezoaccel225g_cfg_t cfg)

Piezo Accel 2 25g configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ piezoaccel225g_default_cfg()

err_t piezoaccel225g_default_cfg ( piezoaccel225g_t ctx)

Piezo Accel 2 25g default configuration function.

This function executes a default configuration of Piezo Accel 2 25g Click board.

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

◆ piezoaccel225g_fast_cmd_write()

err_t piezoaccel225g_fast_cmd_write ( piezoaccel225g_t ctx,
uint8_t  fast_cmd 
)

Piezo Accel 2 25g fast cmd write function.

This function writes the selected fast command by using SPI serial interface.

Parameters
[in]ctx: Click context object. See piezoaccel225g_t object definition for detailed explanation.
[in]fast_cmd: Fast command to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ piezoaccel225g_get_clk_pin()

uint8_t piezoaccel225g_get_clk_pin ( piezoaccel225g_t ctx)

Piezo Accel 2 25g get clk pin function.

This function returns the CLK pin logic state.

Parameters
[in]ctx: Click context object. See piezoaccel225g_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ piezoaccel225g_get_irq_pin()

uint8_t piezoaccel225g_get_irq_pin ( piezoaccel225g_t ctx)

Piezo Accel 2 25g get irq pin function.

This function returns the IRQ pin logic state.

Parameters
[in]ctx: Click context object. See piezoaccel225g_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ piezoaccel225g_init()

err_t piezoaccel225g_init ( piezoaccel225g_t ctx,
piezoaccel225g_cfg_t cfg 
)

Piezo Accel 2 25g initialization function.

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

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

◆ piezoaccel225g_lock_reg_write()

err_t piezoaccel225g_lock_reg_write ( piezoaccel225g_t ctx)

Piezo Accel 2 25g lock reg write function.

This function locks writing to registers.

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

◆ piezoaccel225g_read_adc_data()

err_t piezoaccel225g_read_adc_data ( piezoaccel225g_t ctx,
piezoaccel225g_adc_data_t data_out 
)

Piezo Accel 2 25g read adc data function.

This function reads raw ADC values of X, Y, and Z axis, and the internal temperature sensor measurements.

Parameters
[in]ctx: Click context object. See piezoaccel225g_t object definition for detailed explanation.
[in]data_out: RAW ADC data read. See piezoaccel225g_adc_data_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ piezoaccel225g_reg_read_24()

err_t piezoaccel225g_reg_read_24 ( piezoaccel225g_t ctx,
uint8_t  reg,
uint32_t *  data_out 
)

Piezo Accel 2 25g reg read 24 function.

This function reads 24-bit data from the selected register by using SPI serial interface.

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

◆ piezoaccel225g_reg_read_32()

err_t piezoaccel225g_reg_read_32 ( piezoaccel225g_t ctx,
uint8_t  reg,
uint32_t *  data_out 
)

Piezo Accel 2 25g reg read 32 function.

This function reads 32-bit data from the selected register by using SPI serial interface.

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

◆ piezoaccel225g_reg_read_8()

err_t piezoaccel225g_reg_read_8 ( piezoaccel225g_t ctx,
uint8_t  reg,
uint8_t *  data_out 
)

Piezo Accel 2 25g reg read 8 function.

This function reads 8-bit data from the selected register by using SPI serial interface.

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

◆ piezoaccel225g_reg_read_multi()

err_t piezoaccel225g_reg_read_multi ( piezoaccel225g_t ctx,
uint8_t  reg,
uint8_t *  data_out,
uint8_t  len 
)

Piezo Accel 2 25g reg read multi function.

This function reads a desired number of data bytes starting from the selected register by using SPI serial interface.

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

◆ piezoaccel225g_reg_write_24()

err_t piezoaccel225g_reg_write_24 ( piezoaccel225g_t ctx,
uint8_t  reg,
uint32_t  data_in 
)

Piezo Accel 2 25g reg write 24 function.

This function writes 24-bit data to the selected register by using SPI serial interface.

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

◆ piezoaccel225g_reg_write_8()

err_t piezoaccel225g_reg_write_8 ( piezoaccel225g_t ctx,
uint8_t  reg,
uint8_t  data_in 
)

Piezo Accel 2 25g reg write 8 function.

This function writes 8-bit data to the selected register by using SPI serial interface.

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

◆ piezoaccel225g_reg_write_multi()

err_t piezoaccel225g_reg_write_multi ( piezoaccel225g_t ctx,
uint8_t  reg,
uint8_t *  data_in,
uint8_t  len 
)

Piezo Accel 2 25g reg write multi function.

This function writes a desired number of data bytes starting from the selected register by using SPI serial interface.

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

◆ piezoaccel225g_unlock_reg_write()

err_t piezoaccel225g_unlock_reg_write ( piezoaccel225g_t ctx)

Piezo Accel 2 25g unlock reg write function.

This function unlocks writing to registers.

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

◆ piezoaccel225g_wait_data_ready()

err_t piezoaccel225g_wait_data_ready ( piezoaccel225g_t ctx,
uint16_t  timeout_ms 
)

Piezo Accel 2 25g wait data ready function.

This function waits a desired period for a data ready indication.

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