inclinometer3  2.1.0.0
Modules | Functions
Inclinometer 3 Click Driver

API for configuring and manipulating Inclinometer 3 Click driver. More...

Modules

 Inclinometer 3 Registers List
 List of registers of Inclinometer 3 Click driver.
 
 Inclinometer 3 Registers Settings
 Settings for registers of Inclinometer 3 Click driver.
 
 Inclinometer 3 MikroBUS Map
 MikroBUS pin mapping of Inclinometer 3 Click driver.
 

Functions

void inclinometer3_cfg_setup (inclinometer3_cfg_t *cfg)
 Inclinometer 3 configuration object setup function. More...
 
err_t inclinometer3_init (inclinometer3_t *ctx, inclinometer3_cfg_t *cfg)
 Inclinometer 3 initialization function. More...
 
err_t inclinometer3_default_cfg (inclinometer3_t *ctx)
 Inclinometer 3 default configuration function. More...
 
err_t inclinometer3_reg_write (inclinometer3_t *ctx, uint8_t reg, uint16_t data_in)
 Inclinometer 3 data writing function. More...
 
err_t inclinometer3_reg_read (inclinometer3_t *ctx, uint8_t reg, uint16_t *data_out)
 Inclinometer 3 data reading function. More...
 
err_t inclinometer3_cmd_write (inclinometer3_t *ctx, uint32_t op_cmd)
 Inclinometer 3 command writing function. More...
 
err_t inclinometer3_cmd_read (inclinometer3_t *ctx, uint32_t op_cmd, uint32_t *data_out)
 Inclinometer 3 command reading function. More...
 
err_t inclinometer3_set_bank (inclinometer3_t *ctx, uint8_t bank)
 Inclinometer 3 set bank function. More...
 
err_t inclinometer3_sw_reset (inclinometer3_t *ctx)
 Inclinometer 3 software reset function. More...
 
err_t inclinometer3_get_sensor_id (inclinometer3_t *ctx, uint8_t *device_id)
 Inclinometer 3 get sensor ID function. More...
 
err_t inclinometer3_get_status (inclinometer3_t *ctx, uint32_t *status)
 Inclinometer 3 get status function. More...
 
err_t inclinometer3_set_mode (inclinometer3_t *ctx, uint8_t mode)
 Inclinometer 3 set mode function. More...
 
err_t inclinometer3_get_axes_data (inclinometer3_t *ctx, int16_t *x_data, int16_t *y_data)
 Inclinometer 3 get the accel data function. More...
 
err_t inclinometer3_get_axes (inclinometer3_t *ctx, float *x_axes, float *y_axes)
 Inclinometer 3 get the accel sensor axes function. More...
 
err_t inclinometer3_get_temp_data (inclinometer3_t *ctx, int16_t *temp_data)
 Inclinometer 3 get the temperature data function. More...
 
err_t inclinometer3_get_temperature (inclinometer3_t *ctx, float *temperature)
 Inclinometer 3 get the temperature function. More...
 

Detailed Description

API for configuring and manipulating Inclinometer 3 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

◆ inclinometer3_cfg_setup()

void inclinometer3_cfg_setup ( inclinometer3_cfg_t cfg)

Inclinometer 3 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ inclinometer3_cmd_read()

err_t inclinometer3_cmd_read ( inclinometer3_t ctx,
uint32_t  op_cmd,
uint32_t *  data_out 
)

Inclinometer 3 command reading function.

This function reads 32-bit data by using SPI serial interface.

Parameters
[in]ctx: Click context object. See inclinometer3_t object definition for detailed explanation.
[in]op_cmd: Operation command - SPI frame.
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ inclinometer3_cmd_write()

err_t inclinometer3_cmd_write ( inclinometer3_t ctx,
uint32_t  op_cmd 
)

Inclinometer 3 command writing function.

This function writes a desired command - SPI frame by using SPI serial interface.

Parameters
[in]ctx: Click context object. See inclinometer3_t object definition for detailed explanation.
[in]op_cmd: Operation command - SPI frame.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ inclinometer3_default_cfg()

err_t inclinometer3_default_cfg ( inclinometer3_t ctx)

Inclinometer 3 default configuration function.

This function executes a default configuration of Inclinometer 3 click board.

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

◆ inclinometer3_get_axes()

err_t inclinometer3_get_axes ( inclinometer3_t ctx,
float *  x_axes,
float *  y_axes 
)

Inclinometer 3 get the accel sensor axes function.

This function reads the accelerometer sensor axes data by using SPI serial interface.

Parameters
[in]ctx: Click context object. See inclinometer3_t object definition for detailed explanation.
[out]x_data: Linear acceleration X-axis output data object [mg].
[out]y_data: Linear acceleration Y-axis output data object [mg].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ inclinometer3_get_axes_data()

err_t inclinometer3_get_axes_data ( inclinometer3_t ctx,
int16_t *  x_data,
int16_t *  y_data 
)

Inclinometer 3 get the accel data function.

This function reads the accelerometer raw data by using SPI serial interface.

Parameters
[in]ctx: Click context object. See inclinometer3_t object definition for detailed explanation.
[out]x_data: X-axis raw data.
[out]y_data: Y-axis raw data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ inclinometer3_get_sensor_id()

err_t inclinometer3_get_sensor_id ( inclinometer3_t ctx,
uint8_t *  device_id 
)

Inclinometer 3 get sensor ID function.

This function reads the sensor ID data value by using SPI serial interface.

Parameters
[in]ctx: Click context object. See inclinometer3_t object definition for detailed explanation.
[out]device_id: Sensor component identification.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ inclinometer3_get_status()

err_t inclinometer3_get_status ( inclinometer3_t ctx,
uint32_t *  status 
)

Inclinometer 3 get status function.

This function reads the status data value by using SPI serial interface.

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

◆ inclinometer3_get_temp_data()

err_t inclinometer3_get_temp_data ( inclinometer3_t ctx,
int16_t *  temp_data 
)

Inclinometer 3 get the temperature data function.

This function reads the temperature raw data by using SPI serial interface.

Parameters
[in]ctx: Click context object. See inclinometer3_t object definition for detailed explanation.
[out]x_dattemp_dataa: Temperature raw data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ inclinometer3_get_temperature()

err_t inclinometer3_get_temperature ( inclinometer3_t ctx,
float *  temperature 
)

Inclinometer 3 get the temperature function.

This function reads the temperature measurement data by using SPI serial interface.

Parameters
[in]ctx: Click context object. See inclinometer3_t object definition for detailed explanation.
[out]temperature: Temperature data [degree Celsius].
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ inclinometer3_init()

err_t inclinometer3_init ( inclinometer3_t ctx,
inclinometer3_cfg_t cfg 
)

Inclinometer 3 initialization function.

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

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

◆ inclinometer3_reg_read()

err_t inclinometer3_reg_read ( inclinometer3_t ctx,
uint8_t  reg,
uint16_t *  data_out 
)

Inclinometer 3 data reading function.

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

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

◆ inclinometer3_reg_write()

err_t inclinometer3_reg_write ( inclinometer3_t ctx,
uint8_t  reg,
uint16_t  data_in 
)

Inclinometer 3 data writing function.

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

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

◆ inclinometer3_set_bank()

err_t inclinometer3_set_bank ( inclinometer3_t ctx,
uint8_t  bank 
)

Inclinometer 3 set bank function.

This function is used to select the desired memory bank by using SPI serial interface.

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

◆ inclinometer3_set_mode()

err_t inclinometer3_set_mode ( inclinometer3_t ctx,
uint8_t  mode 
)

Inclinometer 3 set mode function.

This function is used to select the desired operation mode by using SPI serial interface.

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

◆ inclinometer3_sw_reset()

err_t inclinometer3_sw_reset ( inclinometer3_t ctx)

Inclinometer 3 software reset function.

This function performs sensor software reset by using SPI serial interface.

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