tiltnshake  2.0.0.0
Functions

Functions

void tiltnshake_cfg_setup (tiltnshake_cfg_t *cfg)
 Config Object Initialization function. More...
 
TILTNSHAKE_RETVAL tiltnshake_init (tiltnshake_t *ctx, tiltnshake_cfg_t *cfg)
 Initialization function. More...
 
void tiltnshake_generic_write (tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void tiltnshake_generic_read (tiltnshake_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
void tiltnshake_enable (tiltnshake_t *ctx, uint8_t en)
 Function for enabled chip. More...
 
void tiltnshake_read_status_and_axis (tiltnshake_t *ctx, uint8_t *status, uint16_t *out_x, uint16_t *out_y, uint16_t *out_z)
 Function for read status and axis. More...
 
void tiltnshake_conversion (uint16_t *out_x, uint16_t *out_y, uint16_t *out_z, float *out_x_flo, float *out_y_flo, float *out_z_flo)
 Function for conversion. More...
 

Detailed Description

Function Documentation

◆ tiltnshake_cfg_setup()

void tiltnshake_cfg_setup ( tiltnshake_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ tiltnshake_conversion()

void tiltnshake_conversion ( uint16_t *  out_x,
uint16_t *  out_y,
uint16_t *  out_z,
float *  out_x_flo,
float *  out_y_flo,
float *  out_z_flo 
)

Function for conversion.

Parameters
ctxClick object.
out_xAxis x
out_yAxis y
out_zAxis z
out_x_flo
out_y_flo
out_z_flo

Accelerometer output conversion data from uint16_t to float

◆ tiltnshake_enable()

void tiltnshake_enable ( tiltnshake_t ctx,
uint8_t  en 
)

Function for enabled chip.

Parameters
ctxClick object.
en

Enables chip select with 1, disable with 0

◆ tiltnshake_generic_read()

void tiltnshake_generic_read ( tiltnshake_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

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

This function reads data from the desired register.

◆ tiltnshake_generic_write()

void tiltnshake_generic_write ( tiltnshake_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

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

This function writes data to the desired register.

◆ tiltnshake_init()

TILTNSHAKE_RETVAL tiltnshake_init ( tiltnshake_t ctx,
tiltnshake_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ tiltnshake_read_status_and_axis()

void tiltnshake_read_status_and_axis ( tiltnshake_t ctx,
uint8_t *  status,
uint16_t *  out_x,
uint16_t *  out_y,
uint16_t *  out_z 
)

Function for read status and axis.

Parameters
ctxClick object.
state
out_xAxis x
out_yAxis y
out_zAxis z

Reads status register and then reads axis X Y Z like 14 bit data and places them in addresses