mlvibrosens  2.1.0.0
Modules | Functions
ML Vibro Sens Click Driver

API for configuring and manipulating ML Vibro Sens Click driver. More...

Modules

 ML Vibro Sens Registers List
 List of registers of ML Vibro Sens Click driver.
 
 ML Vibro Sens Registers Settings
 Settings for registers of ML Vibro Sens Click driver.
 
 ML Vibro Sens MikroBUS Map
 MikroBUS pin mapping of ML Vibro Sens Click driver.
 

Functions

void mlvibrosens_cfg_setup (mlvibrosens_cfg_t *cfg)
 ML Vibro Sens configuration object setup function. More...
 
err_t mlvibrosens_init (mlvibrosens_t *ctx, mlvibrosens_cfg_t *cfg)
 ML Vibro Sens initialization function. More...
 
err_t mlvibrosens_default_cfg (mlvibrosens_t *ctx)
 ML Vibro Sens default configuration function. More...
 
err_t mlvibrosens_write_regs (mlvibrosens_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 ML Vibro Sens write regs function. More...
 
err_t mlvibrosens_read_regs (mlvibrosens_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 ML Vibro Sens read regs function. More...
 
err_t mlvibrosens_write_reg (mlvibrosens_t *ctx, uint8_t reg, uint8_t data_in)
 ML Vibro Sens write reg function. More...
 
err_t mlvibrosens_read_reg (mlvibrosens_t *ctx, uint8_t reg, uint8_t *data_out)
 ML Vibro Sens read reg function. More...
 
void mlvibrosens_balanced_enable (mlvibrosens_t *ctx)
 ML Vibro Sens balanced enable function. More...
 
void mlvibrosens_balanced_disable (mlvibrosens_t *ctx)
 ML Vibro Sens balanced disable function. More...
 
void mlvibrosens_unbalanced_enable (mlvibrosens_t *ctx)
 ML Vibro Sens unbalanced enable function. More...
 
void mlvibrosens_unbalanced_disable (mlvibrosens_t *ctx)
 ML Vibro Sens unbalanced disable function. More...
 
uint8_t mlvibrosens_get_int_pin (mlvibrosens_t *ctx)
 ML Vibro Sens get int1 pin function. More...
 
void mlvibrosens_set_vibro_state (mlvibrosens_t *ctx, uint8_t state)
 ML Vibro Sens set vibro state function. More...
 
err_t mlvibrosens_check_comm (mlvibrosens_t *ctx)
 ML Vibro Sens check comm function. More...
 
err_t mlvibrosens_get_status (mlvibrosens_t *ctx, uint8_t *status)
 ML Vibro Sens get status function. More...
 
err_t mlvibrosens_sw_reset (mlvibrosens_t *ctx)
 ML Vibro Sens sw reset function. More...
 
err_t mlvibrosens_set_mode (mlvibrosens_t *ctx, uint8_t mode)
 ML Vibro Sens set mode function. More...
 
err_t mlvibrosens_set_fsr (mlvibrosens_t *ctx, uint8_t fsr)
 ML Vibro Sens set fsr function. More...
 
err_t mlvibrosens_set_odr (mlvibrosens_t *ctx, uint8_t odr)
 ML Vibro Sens set odr function. More...
 
err_t mlvibrosens_get_data (mlvibrosens_t *ctx, mlvibrosens_data_t *data_out)
 ML Vibro Sens get data function. More...
 

Detailed Description

API for configuring and manipulating ML Vibro Sens 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

◆ mlvibrosens_balanced_disable()

void mlvibrosens_balanced_disable ( mlvibrosens_t ctx)

ML Vibro Sens balanced disable function.

This function disables balanced vibro motor by setting the BAL pin to low logic state.

Parameters
[in]ctx: Click context object. See mlvibrosens_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ mlvibrosens_balanced_enable()

void mlvibrosens_balanced_enable ( mlvibrosens_t ctx)

ML Vibro Sens balanced enable function.

This function enables balanced vibro motor by setting the BAL pin to high logic state.

Parameters
[in]ctx: Click context object. See mlvibrosens_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ mlvibrosens_cfg_setup()

void mlvibrosens_cfg_setup ( mlvibrosens_cfg_t cfg)

ML Vibro Sens configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ mlvibrosens_check_comm()

err_t mlvibrosens_check_comm ( mlvibrosens_t ctx)

ML Vibro Sens check comm function.

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

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

◆ mlvibrosens_default_cfg()

err_t mlvibrosens_default_cfg ( mlvibrosens_t ctx)

ML Vibro Sens default configuration function.

This function executes a default configuration of ML Vibro Sens Click board.

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

◆ mlvibrosens_get_data()

err_t mlvibrosens_get_data ( mlvibrosens_t ctx,
mlvibrosens_data_t data_out 
)

ML Vibro Sens get data function.

This function reads accel X, Y, and Z axis data in g and temperature in degrees Celsius.

Parameters
[in]ctx: Click context object. See mlvibrosens_t object definition for detailed explanation.
[out]data_out: X, Y, and Z axis data in g, and temperature in degrees Celsius. See mlvibrosens_data_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ mlvibrosens_get_int_pin()

uint8_t mlvibrosens_get_int_pin ( mlvibrosens_t ctx)

ML Vibro Sens get int1 pin function.

This function returns the interrupt pin logic state.

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

◆ mlvibrosens_get_status()

err_t mlvibrosens_get_status ( mlvibrosens_t ctx,
uint8_t *  status 
)

ML Vibro Sens get status function.

This function reads the interrupt status register.

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

◆ mlvibrosens_init()

err_t mlvibrosens_init ( mlvibrosens_t ctx,
mlvibrosens_cfg_t cfg 
)

ML Vibro Sens initialization function.

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

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

◆ mlvibrosens_read_reg()

err_t mlvibrosens_read_reg ( mlvibrosens_t ctx,
uint8_t  reg,
uint8_t *  data_out 
)

ML Vibro Sens read reg function.

This function reads a data byte from the selected register.

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

◆ mlvibrosens_read_regs()

err_t mlvibrosens_read_regs ( mlvibrosens_t ctx,
uint8_t  reg,
uint8_t *  data_out,
uint8_t  len 
)

ML Vibro Sens read regs function.

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

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

◆ mlvibrosens_set_fsr()

err_t mlvibrosens_set_fsr ( mlvibrosens_t ctx,
uint8_t  fsr 
)

ML Vibro Sens set fsr function.

This function sets the accel measurement full scale range.

Parameters
[in]ctx: Click context object. See mlvibrosens_t object definition for detailed explanation.
[in]fsr:
  • 0 - 2G,
  • 1 - 4G,
  • 2 - 8G,
  • 3 - 16G.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ mlvibrosens_set_mode()

err_t mlvibrosens_set_mode ( mlvibrosens_t ctx,
uint8_t  mode 
)

ML Vibro Sens set mode function.

This function sets the device operating mode to standby or active.

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

◆ mlvibrosens_set_odr()

err_t mlvibrosens_set_odr ( mlvibrosens_t ctx,
uint8_t  odr 
)

ML Vibro Sens set odr function.

This function sets the measurement output data rate.

Parameters
[in]ctx: Click context object. See mlvibrosens_t object definition for detailed explanation.
[in]odr:
  • 0 - 3200Hz,
  • 1 - 1600Hz,
  • 2 - 800Hz,
  • 3 - 400Hz,
  • 4 - 200Hz,
  • 5 - 100Hz,
  • 6 - 50Hz,
  • 7 - 25Hz,
  • 8 - 12.5Hz,
  • 9 - 6.25Hz,
  • 10 - 3.125Hz,
  • 11 - 1.563Hz,
  • 12 - 0.781Hz,
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ mlvibrosens_set_vibro_state()

void mlvibrosens_set_vibro_state ( mlvibrosens_t ctx,
uint8_t  state 
)

ML Vibro Sens set vibro state function.

This function sets the vibro motors state.

Parameters
[in]ctx: Click context object. See mlvibrosens_t object definition for detailed explanation.
[in]state:
  • 0 - IDLE (both motors disabled),
  • 1 - BALANCED (balanced motor enabled),
  • 2 - UNBALANCED (unbalanced motor enabled),
  • 3 - BOTH (both motors enabled),
Returns
None.
Note
None.

◆ mlvibrosens_sw_reset()

err_t mlvibrosens_sw_reset ( mlvibrosens_t ctx)

ML Vibro Sens sw reset function.

This function performs the device software reset.

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

◆ mlvibrosens_unbalanced_disable()

void mlvibrosens_unbalanced_disable ( mlvibrosens_t ctx)

ML Vibro Sens unbalanced disable function.

This function disables unbalanced vibro motor by setting the UNB pin to low logic state.

Parameters
[in]ctx: Click context object. See mlvibrosens_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ mlvibrosens_unbalanced_enable()

void mlvibrosens_unbalanced_enable ( mlvibrosens_t ctx)

ML Vibro Sens unbalanced enable function.

This function enables unbalanced vibro motor by setting the UNB pin to high logic state.

Parameters
[in]ctx: Click context object. See mlvibrosens_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ mlvibrosens_write_reg()

err_t mlvibrosens_write_reg ( mlvibrosens_t ctx,
uint8_t  reg,
uint8_t  data_in 
)

ML Vibro Sens write reg function.

This function write a data byte to the selected register.

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

◆ mlvibrosens_write_regs()

err_t mlvibrosens_write_regs ( mlvibrosens_t ctx,
uint8_t  reg,
uint8_t *  data_in,
uint8_t  len 
)

ML Vibro Sens write regs function.

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

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