accel13 2.0.0.0
Public function

Functions

void accel13_cfg_setup (accel13_cfg_t *cfg)
 Config Object Initialization function.
 
ACCEL13_RETVAL accel13_init (accel13_t *ctx, accel13_cfg_t *cfg)
 Initialization function.
 
void accel13_default_cfg (accel13_t *ctx)
 Click Default Configuration function.
 
void accel13_generic_write_bytes (accel13_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void accel13_generic_write_single_byte (accel13_t *ctx, uint8_t reg, uint8_t data_in)
 Single byte write function.
 
void accel13_generic_read_bytes (accel13_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic 8bit read function.
 
int16_t accel13_generic_read_word (accel13_t *ctx, uint8_t reg)
 16bit read function.
 
float accel13_get_temperature (accel13_t *ctx)
 Temperature functions.
 
void accel13_get_axis_data (accel13_t *ctx, accel13_axis_t *axis)
 Read function for Accel axis data.
 
void accel13_get_status (accel13_t *ctx, accel13_status_t *status)
 Read functions for Status data.
 
void accel13_get_wake_up_status (accel13_t *ctx, accel13_wake_up_t *wu_status)
 Read function for Wake-up status data.
 
void accel13_get_tap_status (accel13_t *ctx, accel13_tap_t *tap_status)
 Read function for Tap status data.
 
void accel13_get_6d_status (accel13_t *ctx, accel13_6d_t *sixd_status)
 Read function for 6D status data.
 
void accel13_get_user_offset (accel13_t *ctx, accel13_user_offset_t *axis)
 Read function for User offset data.
 
void accel13_set_user_offset (accel13_t *ctx, accel13_user_offset_t *axis)
 Set function for User offset data.
 
uint8_t accel13_get_interrupt (accel13_t *ctx, uint8_t int_num)
 Interrupt functions.
 

Detailed Description

Function Documentation

◆ accel13_cfg_setup()

void accel13_cfg_setup ( accel13_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ accel13_default_cfg()

void accel13_default_cfg ( accel13_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for Accel 13 click.

Note
: This functions contains some basic initial setups that we have set for start-up wake-up and configuration of the chip All settings can be changed by You as well by writing your new setup and settings.

List of registers and their set values:

   #  ACCEL13_REG_CTRL_1  
      ACCEL13_CTRL1_ODR_LOW_POWER_MODE_400_200Hz,
      ACCEL13_CTRL1_MODE_HIGH_PERFORMANCE_MODE_14bit,
      ACCEL13_CTRL1_LP_MODE_1.

   # ACCEL13_REG_CTRL_2
     ACCEL13_CTRL2_BOOT_ENABLE,
     ACCEL13_CTRL2_SOFT_RESET_DISABLE,
     ACCEL13_CTRL2_PULLUP_CS_PIN_ENABLE,
     ACCEL13_CTRL2_BDU_CONTINUOUS_UPDATE,
     ACCEL13_CTRL2_IF_ADD_INC_ENABLED,
     ACCEL13_CTRL2_I2C_AND_SPI_ENABLE,
     ACCEL13_CTRL2_SPI_4_WIRE.

    # ACCEL13_REG_CTRL_3
      ACCEL13_CTRL3_SELF_TEST_DISABLE,
      ACCEL13_CTRL3_OPEN_DRAIN_INT_PAD,
      ACCEL13_CTRL3_LATCHED_INT_DISABLE,
      ACCEL13_CTRL3_INT_ACTIVE_HIGH,
      ACCEL13_CTRL3_SLP_MODE_SEL_EN_INT2.

    # ACCEL13_REG_CTRL_4_INT1
      ACCEL13_CTRL4_INT1_6D_DISABLED,
      ACCEL13_CTRL4_INT1_SINGLE_TAP_DISABLED,
      ACCEL13_CTRL4_INT1_WAKEUP_DISABLED,
      ACCEL13_CTRL4_INT1_FREE_FALL_DISABLED,
      ACCEL13_CTRL4_INT1_TAP_ENABLED,
      ACCEL13_CTRL4_INT1_DIFF5_DISABLED,
      ACCEL13_CTRL4_INT1_FTH_DISABLED,
      ACCEL13_CTRL4_INT1_DRDY_DISABLED.


    # ACCEL13_REG_CTRL_5_INT2
      ACCEL13_CTRL5_INT2_SLEEP_STATE_DISABLED
      ACCEL13_CTRL5_INT2_SLEEP_CHG_DISABLED,
      ACCEL13_CTRL5_INT2_BOOT_DISABLED,
      ACCEL13_CTRL5_INT2_T_DRDY_DISABLED,
      ACCEL13_CTRL5_INT2_OVR_DISABLED,
      ACCEL13_CTRL4_INT2_DIFF5_DISABLED,
      ACCEL13_CTRL4_INT2_DRDY_ENABLED.

     # ACCEL13_REG_WAKE_UP_DURATION -  0x00
     # ACCEL13_REG_FREE_FALL_CONFIG -  0x33
     # ACCEL13_REG_CTRL_7 -  0x20
     # ACCEL13_REG_TAP_AXIS_X - 0x09
     # ACCEL13_REG_TAP_AXIS_Y - 0xE9
     # ACCEL13_REG_TAP_AXIS_Z - 0xE9
     # ACCEL13_REG_INT_DURATION - 0x06
     # ACCEL13_REG_X_OFFSET_USER - 0x00
     # ACCEL13_REG_Y_OFFSET_USER - 0x00
     # ACCEL13_REG_Z_OFFSET_USER - 0x40
   

◆ accel13_generic_read_bytes()

void accel13_generic_read_bytes ( accel13_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic 8bit read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ accel13_generic_read_word()

int16_t accel13_generic_read_word ( accel13_t * ctx,
uint8_t reg )

16bit read function.

Parameters
ctxClick object.
regRegister address.
Return values
read16bit value.

@description This function returns single 16bit value read from the desired registers.

◆ accel13_generic_write_bytes()

void accel13_generic_write_bytes ( accel13_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufInput data buf
lenNumber of the bytes to be written

@description This function writes data to the desired register.

◆ accel13_generic_write_single_byte()

void accel13_generic_write_single_byte ( accel13_t * ctx,
uint8_t reg,
uint8_t data_in )

Single byte write function.

Parameters
ctxClick object.
regRegister address.
data_inInput data

@description This function writes 1 byte to the desired register.

◆ accel13_get_6d_status()

void accel13_get_6d_status ( accel13_t * ctx,
accel13_6d_t * sixd_status )

Read function for 6D status data.

Parameters
ctxClick object.
sixd_statusAn object that contains 6D status data.

@description This function reads the 6D status data and stores it in the sixd_status object.

◆ accel13_get_axis_data()

void accel13_get_axis_data ( accel13_t * ctx,
accel13_axis_t * axis )

Read function for Accel axis data.

Parameters
ctxClick object.
axisAn object that contains X , Y and Z axis data.

@description This function reads the axis data and stores it in the axis object.

◆ accel13_get_interrupt()

uint8_t accel13_get_interrupt ( accel13_t * ctx,
uint8_t int_num )

Interrupt functions.

Parameters
ctxClick object.
intNumInterrupt pin.
Returns
Interrupt state on the this select pin

@description This function returns value of interupt state from the selected pin

◆ accel13_get_status()

void accel13_get_status ( accel13_t * ctx,
accel13_status_t * status )

Read functions for Status data.

Parameters
ctxClick object.
statusAn object that contains status data.

@description This function reads the status data and stores it in the status object.

◆ accel13_get_tap_status()

void accel13_get_tap_status ( accel13_t * ctx,
accel13_tap_t * tap_status )

Read function for Tap status data.

Parameters
ctxClick object.
tap_statusAn object that contains wake-up status data.

@description This function reads the tap status data and stores it in the tap_status object.

◆ accel13_get_temperature()

float accel13_get_temperature ( accel13_t * ctx)

Temperature functions.

Parameters
ctxClick object.
Return values
Temperaturedata in C.

◆ accel13_get_user_offset()

void accel13_get_user_offset ( accel13_t * ctx,
accel13_user_offset_t * axis )

Read function for User offset data.

Parameters
ctxClick object.
axisAn object that contains user offset data.

@description This function reads the 6D status data and stores it in the axis object.

◆ accel13_get_wake_up_status()

void accel13_get_wake_up_status ( accel13_t * ctx,
accel13_wake_up_t * wu_status )

Read function for Wake-up status data.

Parameters
ctxClick object.
wu_statusAn object that contains wake-up status data.

@description This function reads the wake-up status data and stores it in the wu_status object.

◆ accel13_init()

ACCEL13_RETVAL accel13_init ( accel13_t * ctx,
accel13_cfg_t * cfg )

Initialization function.

Parameters
accel13Click object.
cfgClick configuration structure.

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

◆ accel13_set_user_offset()

void accel13_set_user_offset ( accel13_t * ctx,
accel13_user_offset_t * axis )

Set function for User offset data.

Parameters
ctxClick object.
axisAn object that contains user offset data.

@description This function sets the User offset data from the axis object.