Collaboration diagram for LIS302DL:

Detailed Description

Macros
#define	lis302dlAccelerometerGetAxesNumber(devp) accelerometerGetAxesNumber(&((devp)->acc_if))
	Return the number of axes of the BaseAccelerometer. More...

#define	lis302dlAccelerometerReadRaw(devp, axes) accelerometerReadRaw(&((devp)->acc_if), axes)
	Retrieves raw data from the BaseAccelerometer. More...

#define	lis302dlAccelerometerReadCooked(devp, axes) accelerometerReadCooked(&((devp)->acc_if), axes)
	Retrieves cooked data from the BaseAccelerometer. More...

#define	lis302dlAccelerometerSetBias(devp, bp) accelerometerSetBias(&((devp)->acc_if), bp)
	Set bias values for the BaseAccelerometer. More...

#define	lis302dlAccelerometerResetBias(devp) accelerometerResetBias(&((devp)->acc_if))
	Reset bias values for the BaseAccelerometer. More...

#define	lis302dlAccelerometerSetSensitivity(devp, sp) accelerometerSetSensitivity(&((devp)->acc_if), sp)
	Set sensitivity values for the BaseAccelerometer. More...

#define	lis302dlAccelerometerResetSensitivity(devp) accelerometerResetSensitivity(&((devp)->acc_if))
	Reset sensitivity values for the BaseAccelerometer. More...

#define	lis302dlAccelerometerSetFullScale(devp, fs) (devp)->vmt->acc_set_full_scale(devp, fs)
	Changes the LIS302DLDriver accelerometer fullscale value. More...

Version identification
#define	EX_LIS302DL_VERSION "1.1.1"
	LIS302DL driver version string. More...

#define	EX_LIS302DL_MAJOR 1
	LIS302DL driver version major number. More...

#define	EX_LIS302DL_MINOR 1
	LIS302DL driver version minor number. More...

#define	EX_LIS302DL_PATCH 1
	LIS302DL driver version patch number. More...

#define	LIS302DL_ACC_NUMBER_OF_AXES 3U
	LIS302DL accelerometer subsystem characteristics. More...

LIS302DL communication interfaces related bit masks
#define	LIS302DL_DI_MASK 0xFF

#define	LIS302DL_DI(n) (1 << n)

#define	LIS302DL_AD_MASK 0x3F

#define	LIS302DL_AD(n) (1 << n)

#define	LIS302DL_MS (1 << 6)

#define	LIS302DL_RW (1 << 7)

LIS302DL register addresses
#define	LIS302DL_AD_WHO_AM_I 0x0F

#define	LIS302DL_AD_CTRL_REG1 0x20

#define	LIS302DL_AD_CTRL_REG2 0x21

#define	LIS302DL_AD_CTRL_REG3 0x22

#define	LIS302DL_AD_HP_FILER_RESET 0x23

#define	LIS302DL_AD_STATUS_REG 0x27

#define	LIS302DL_AD_OUT_X 0x29

#define	LIS302DL_AD_OUT_Y 0x2B

#define	LIS302DL_AD_OUT_Z 0x2D

#define	LIS302DL_AD_FF_WU_CFG_1 0x30

#define	LIS302DL_AD_FF_WU_SRC_1 0x31

#define	LIS302DL_AD_FF_WU_THS_1 0x32

#define	LIS302DL_AD_FF_WU_DURATION_1 0x33

#define	LIS302DL_AD_FF_WU_CFG_2 0x34

#define	LIS302DL_AD_FF_WU_SRC_2 0x35

#define	LIS302DL_AD_FF_WU_THS_2 0x36

#define	LIS302DL_AD_FF_WU_DURATION_2 0x37

#define	LIS302DL_AD_CLICK_CFG 0x38

#define	LIS302DL_AD_CLICK_SRC 0x39

#define	LIS302DL_AD_CLICK_THSY_X 0x3B

#define	LIS302DL_AD_CLICK_THSZ 0x3C

#define	LIS302DL_AD_CLICK_TIME_LIMIT 0x3D

#define	LIS302DL_AD_CLICK_LATENCY 0x3E

#define	LIS302DL_AD_CLICK_WINDOW 0x3F

LIS302DL_CTRL_REG1 register bits definitions
#define	LIS302DL_CTRL_REG1_MASK 0xFF

#define	LIS302DL_CTRL_REG1_XEN (1 << 0)

#define	LIS302DL_CTRL_REG1_YEN (1 << 1)

#define	LIS302DL_CTRL_REG1_ZEN (1 << 2)

#define	LIS302DL_CTRL_REG1_STM (1 << 3)

#define	LIS302DL_CTRL_REG1_STP (1 << 4)

#define	LIS302DL_CTRL_REG1_FS_MASK 0x20

#define	LIS302DL_CTRL_REG1_FS (1 << 5)

#define	LIS302DL_CTRL_REG1_PD (1 << 6)

#define	LIS302DL_CTRL_REG1_DR (1 << 7)

LIS302DL_CTRL_REG2 register bits definitions
#define	LIS302DL_CTRL_REG2_MASK 0xDF

#define	LIS302DL_CTRL_REG2_HPCF1 (1 << 0)

#define	LIS302DL_CTRL_REG2_HPCF2 (1 << 1)

#define	LIS302DL_CTRL_REG2_HPFFWU1 (1 << 2)

#define	LIS302DL_CTRL_REG2_HPFFWU2 (1 << 3)

#define	LIS302DL_CTRL_REG2_FDS (1 << 4)

#define	LIS302DL_CTRL_REG2_BOOT (1 << 6)

#define	LIS302DL_CTRL_REG2_SIM (1 << 7)

LIS302DL_CTRL_REG3 register bits definitions
#define	LIS302DL_CTRL_REG3_MASK 0xFF

#define	LIS302DL_CTRL_REG3_I1CFG0 (1 << 0)

#define	LIS302DL_CTRL_REG3_I1CFG1 (1 << 1)

#define	LIS302DL_CTRL_REG3_I1CFG2 (1 << 2)

#define	LIS302DL_CTRL_REG3_I2CFG0 (1 << 3)

#define	LIS302DL_CTRL_REG3_I2CFG1 (1 << 4)

#define	LIS302DL_CTRL_REG3_I2CFG2 (1 << 5)

#define	LIS302DL_CTRL_REG3_PP_OD (1 << 6)

#define	LIS302DL_CTRL_REG3_IHL (1 << 7)

Configuration options
#define	LIS302DL_USE_SPI TRUE
	LIS302DL SPI interface switch. More...

#define	LIS302DL_SHARED_SPI FALSE
	LIS302DL shared SPI switch. More...

#define	LIS302DL_USE_I2C FALSE
	LIS302DL I2C interface switch. More...

#define	LIS302DL_SHARED_I2C FALSE
	LIS302DL shared I2C switch. More...

#define	LIS302DL_USE_ADVANCED FALSE
	LIS302DL advanced configurations switch. More...

LIS302DL data structures and types
enum	lis302dl_acc_fs_t { LIS302DL_ACC_FS_2G = 0x00, LIS302DL_ACC_FS_8G = 0x20 }
	LIS302DL full scale. More...

enum	lis302dl_acc_odr_t { LIS302DL_ACC_ODR_100HZ = 0x00, LIS302DL_ACC_ODR_400HZ = 0x80 }
	LIS302DL output data rate and bandwidth. More...

enum	lis302dl_acc_hp_t { LIS302DL_ACC_HP_DISABLED = 0x00, LIS302DL_ACC_HP_0 = 0x10, LIS302DL_ACC_HP_1 = 0x11, LIS302DL_ACC_HP_2 = 0x12, LIS302DL_ACC_HP_3 = 0x13 }
	LIS302DL high pass filtering. More...

enum	lis302dl_state_t { LIS302DL_UNINIT = 0, LIS302DL_STOP = 1, LIS302DL_READY = 2 }
	Driver state machine possible states. More...

typedef struct LIS302DLDriver	LIS302DLDriver
	Structure representing a LIS302DL driver. More...

#define	_lis302dl_methods_alone
	`LIS302DL` specific methods. More...

#define	_lis302dl_methods
	`LIS302DL` specific methods with inherited ones. More...

#define	_lis302dl_data
	`LIS302DLDriver` specific data. More...

Data Structures
struct	LIS302DLConfig
	LIS302DL configuration structure. More...

struct	LIS302DLVMT
	`LIS302DL` accelerometer virtual methods table. More...

struct	LIS302DLDriver
	LIS302DL 3-axis accelerometer class. More...

Functions
static void	lis302dlSPIReadRegister (SPIDriver spip, uint8_t reg, size_t n, uint8_t b)
	Reads a generic register value using SPI. More...

static void	lis302dlSPIWriteRegister (SPIDriver spip, uint8_t reg, size_t n, uint8_t b)
	Writes a value into a generic register using SPI. More...

static size_t	acc_get_axes_number (void *ip)
	Return the number of axes of the BaseAccelerometer. More...

static msg_t	acc_read_raw (void *ip, int32_t axes[])
	Retrieves raw data from the BaseAccelerometer. More...

static msg_t	acc_read_cooked (void *ip, float axes[])
	Retrieves cooked data from the BaseAccelerometer. More...

static msg_t	acc_set_bias (void ip, float bp)
	Set bias values for the BaseAccelerometer. More...

static msg_t	acc_reset_bias (void *ip)
	Reset bias values for the BaseAccelerometer. More...

static msg_t	acc_set_sensivity (void ip, float sp)
	Set sensitivity values for the BaseAccelerometer. More...

static msg_t	acc_reset_sensivity (void *ip)
	Reset sensitivity values for the BaseAccelerometer. More...

static msg_t	acc_set_full_scale (LIS302DLDriver *devp, lis302dl_acc_fs_t fs)
	Changes the LIS302DLDriver accelerometer fullscale value. More...

void	lis302dlObjectInit (LIS302DLDriver *devp)
	Initializes an instance. More...

void	lis302dlStart (LIS302DLDriver devp, const LIS302DLConfig config)
	Configures and activates LIS302DL Complex Driver peripheral. More...

void	lis302dlStop (LIS302DLDriver *devp)
	Deactivates the LIS302DL Complex Driver peripheral. More...

Macro Definition Documentation

◆ EX_LIS302DL_VERSION

#define EX_LIS302DL_VERSION "1.1.1"

LIS302DL driver version string.

Definition at line 46 of file lis302dl.h.

◆ EX_LIS302DL_MAJOR

#define EX_LIS302DL_MAJOR 1

LIS302DL driver version major number.

Definition at line 51 of file lis302dl.h.

◆ EX_LIS302DL_MINOR

#define EX_LIS302DL_MINOR 1

LIS302DL driver version minor number.

Definition at line 56 of file lis302dl.h.

◆ EX_LIS302DL_PATCH

#define EX_LIS302DL_PATCH 1

LIS302DL driver version patch number.

Definition at line 61 of file lis302dl.h.

◆ LIS302DL_ACC_NUMBER_OF_AXES

#define LIS302DL_ACC_NUMBER_OF_AXES 3U

LIS302DL accelerometer subsystem characteristics.

Note: Sensitivity is expressed as milli-G/LSB whereas 1 milli-G = 0.00980665 m/s^2.; Bias is expressed as milli-G.

Definition at line 72 of file lis302dl.h.

◆ LIS302DL_USE_SPI

#define LIS302DL_USE_SPI TRUE

LIS302DL SPI interface switch.

If set to TRUE the support for SPI is included.

Note: The default is TRUE.

Definition at line 184 of file lis302dl.h.

◆ LIS302DL_SHARED_SPI

#define LIS302DL_SHARED_SPI FALSE

LIS302DL shared SPI switch.

If set to TRUE the device acquires SPI bus ownership on each transaction.

Note: The default is FALSE. Requires SPI_USE_MUTUAL_EXCLUSION.

Definition at line 194 of file lis302dl.h.

◆ LIS302DL_USE_I2C

#define LIS302DL_USE_I2C FALSE

LIS302DL I2C interface switch.

If set to TRUE the support for I2C is included.

Note: The default is FALSE.

Definition at line 203 of file lis302dl.h.

◆ LIS302DL_SHARED_I2C

#define LIS302DL_SHARED_I2C FALSE

LIS302DL shared I2C switch.

If set to TRUE the device acquires I2C bus ownership on each transaction.

Note: The default is FALSE. Requires I2C_USE_MUTUAL_EXCLUSION.

Definition at line 213 of file lis302dl.h.

◆ LIS302DL_USE_ADVANCED

#define LIS302DL_USE_ADVANCED FALSE

LIS302DL advanced configurations switch.

If set to TRUE more configurations are available.

Note: The default is FALSE.

Definition at line 222 of file lis302dl.h.

◆ _lis302dl_methods_alone

#define _lis302dl_methods_alone

Value:

/* Change full scale value of LIS302DL .*/ \

msg_t (*set_full_scale)(LIS302DLDriver *devp, lis302dl_acc_fs_t fs);

LIS302DL specific methods.

Definition at line 358 of file lis302dl.h.

◆ _lis302dl_methods

#define _lis302dl_methods

Value:

_base_object_methods \

_lis302dl_methods_alone

LIS302DL specific methods with inherited ones.

Definition at line 366 of file lis302dl.h.

◆ _lis302dl_data

#define _lis302dl_data

Value:

  /* Driver state.*/                                                        \
  lis302dl_state_t          state;                                          \
  /* Current configuration data.*/                                          \
  const LIS302DLConfig      *config;                                        \
  /* Accelerometer subsystem axes number.*/                                 \
  size_t                    accaxes;                                        \
  /* Current sensitivity.*/                                                 \
  float                     accsensitivity[LIS302DL_ACC_NUMBER_OF_AXES];    \
  /* Bias data.*/                                                           \
  int32_t                   accbias[LIS302DL_ACC_NUMBER_OF_AXES];           \
  /* Current full scale value.*/                                            \
  float                     accfullscale;

LIS302DLDriver specific data.

Definition at line 382 of file lis302dl.h.

◆ lis302dlAccelerometerGetAxesNumber

#define lis302dlAccelerometerGetAxesNumber ( devp ) accelerometerGetAxesNumber(&((devp)->acc_if))

Return the number of axes of the BaseAccelerometer.

Parameters

[in] devp pointer to LIS302DLDriver.

Returns: the number of axes.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 421 of file lis302dl.h.

◆ lis302dlAccelerometerReadRaw

#define lis302dlAccelerometerReadRaw	(	devp,
		axes
	)	accelerometerReadRaw(&((devp)->acc_if), axes)

Retrieves raw data from the BaseAccelerometer.

Note: This data is retrieved from MEMS register without any algebraical manipulation.; The axes array must be at least the same size of the BaseAccelerometer axes number.

Parameters

[in]	devp	pointer to `LIS302DLDriver`.
[out]	axes	a buffer which would be filled with raw data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 442 of file lis302dl.h.

◆ lis302dlAccelerometerReadCooked

#define lis302dlAccelerometerReadCooked	(	devp,
		axes
	)	accelerometerReadCooked(&((devp)->acc_if), axes)

Retrieves cooked data from the BaseAccelerometer.

Note: This data is manipulated according to the formula cooked = (raw * sensitivity) - bias.; Final data is expressed as milli-G.; The axes array must be at least the same size of the BaseAccelerometer axes number.

Parameters

[in]	devp	pointer to `LIS302DLDriver`.
[out]	axes	a buffer which would be filled with cooked data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 464 of file lis302dl.h.

◆ lis302dlAccelerometerSetBias

#define lis302dlAccelerometerSetBias	(	devp,
		bp
	)	accelerometerSetBias(&((devp)->acc_if), bp)

Set bias values for the BaseAccelerometer.

Note: Bias must be expressed as milli-G.; The bias buffer must be at least the same size of the BaseAccelerometer axes number.

Parameters

[in]	devp	pointer to `LIS302DLDriver`.
[in]	bp	a buffer which contains biases.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 481 of file lis302dl.h.

◆ lis302dlAccelerometerResetBias

#define lis302dlAccelerometerResetBias ( devp ) accelerometerResetBias(&((devp)->acc_if))

Reset bias values for the BaseAccelerometer.

Note: Default biases value are obtained from device datasheet when available otherwise they are considered zero.

Parameters

[in] devp pointer to LIS302DLDriver.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 496 of file lis302dl.h.

◆ lis302dlAccelerometerSetSensitivity

#define lis302dlAccelerometerSetSensitivity	(	devp,
		sp
	)	accelerometerSetSensitivity(&((devp)->acc_if), sp)

Set sensitivity values for the BaseAccelerometer.

Note: Sensitivity must be expressed as milli-G/LSB.; The sensitivity buffer must be at least the same size of the BaseAccelerometer axes number.

Parameters

[in]	devp	pointer to `LIS302DLDriver`.
[in]	sp	a buffer which contains sensitivities.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 513 of file lis302dl.h.

◆ lis302dlAccelerometerResetSensitivity

#define lis302dlAccelerometerResetSensitivity ( devp ) accelerometerResetSensitivity(&((devp)->acc_if))

Reset sensitivity values for the BaseAccelerometer.

Note: Default sensitivities value are obtained from device datasheet.

Parameters

[in] devp pointer to LIS302DLDriver.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	otherwise.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 528 of file lis302dl.h.

◆ lis302dlAccelerometerSetFullScale

#define lis302dlAccelerometerSetFullScale	(	devp,
		fs
	)	(devp)->vmt->acc_set_full_scale(devp, fs)

Changes the LIS302DLDriver accelerometer fullscale value.

Note: This function also rescale sensitivities and biases based on previous and next fullscale value.; A recalibration is highly suggested after calling this function.

Parameters

[in]	devp	pointer to `LIS302DLDriver`.
[in]	fs	new fullscale value.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	otherwise.

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 546 of file lis302dl.h.

Typedef Documentation

◆ LIS302DLDriver

typedef struct LIS302DLDriver LIS302DLDriver

Structure representing a LIS302DL driver.

Definition at line 268 of file lis302dl.h.

Enumeration Type Documentation

◆ lis302dl_acc_fs_t

enum lis302dl_acc_fs_t

LIS302DL full scale.

Enumerator
LIS302DL_ACC_FS_2G	Full scale �2g.
LIS302DL_ACC_FS_8G	Full scale �8g.

Definition at line 273 of file lis302dl.h.

◆ lis302dl_acc_odr_t

enum lis302dl_acc_odr_t

LIS302DL output data rate and bandwidth.

Enumerator
LIS302DL_ACC_ODR_100HZ	ODR 100 Hz.
LIS302DL_ACC_ODR_400HZ	ODR 400 Hz.

Definition at line 281 of file lis302dl.h.

◆ lis302dl_acc_hp_t

enum lis302dl_acc_hp_t

LIS302DL high pass filtering.

Enumerator
LIS302DL_ACC_HP_DISABLED	HP bypassed.
LIS302DL_ACC_HP_0	HP cutoff 2Hz (ODR 100Hz) or 8Hz
LIS302DL_ACC_HP_1	HP cutoff 1Hz or 4Hz
LIS302DL_ACC_HP_2	HP cutoff 0.5Hz or 2Hz
LIS302DL_ACC_HP_3	HP cutoff 0.25Hz or 1Hz

Definition at line 289 of file lis302dl.h.

◆ lis302dl_state_t

enum lis302dl_state_t

Driver state machine possible states.

Enumerator
LIS302DL_UNINIT	Not initialized.
LIS302DL_STOP	Stopped.
LIS302DL_READY	Ready.

Definition at line 300 of file lis302dl.h.

Function Documentation

◆ lis302dlSPIReadRegister()

static void lis302dlSPIReadRegister	(	SPIDriver *	spip,
		uint8_t	reg,
		size_t	n,
		uint8_t *	b
	)

static

Reads a generic register value using SPI.

Precondition: The SPI interface must be initialized and the driver started.

Parameters

[in]	spip	pointer to the SPI interface
[in]	reg	starting register address
[in]	n	number of adjacent registers to write
[in]	b	pointer to a buffer.

Definition at line 59 of file lis302dl.c.

Referenced by acc_read_raw().

◆ lis302dlSPIWriteRegister()

static void lis302dlSPIWriteRegister	(	SPIDriver *	spip,
		uint8_t	reg,
		size_t	n,
		uint8_t *	b
	)

static

Writes a value into a generic register using SPI.

Precondition: The SPI interface must be initialized and the driver started.

Parameters

[in]	spip	pointer to the SPI interface
[in]	reg	starting register address
[in]	n	number of adjacent registers to write
[in]	b	pointer to a buffer of values.

Definition at line 78 of file lis302dl.c.

Referenced by lis302dlStop().

◆ acc_get_axes_number()

static size_t acc_get_axes_number ( void * ip )

static

Return the number of axes of the BaseAccelerometer.

Parameters

[in] ip pointer to BaseAccelerometer interface.

Returns: the number of axes.

Definition at line 96 of file lis302dl.c.

References LIS302DL_ACC_NUMBER_OF_AXES.

◆ acc_read_raw()

static msg_t acc_read_raw	(	void *	ip,
		int32_t	axes[]
	)

static

Retrieves raw data from the BaseAccelerometer.

Note: This data is retrieved from MEMS register without any algebraical manipulation.; The axes array must be at least the same size of the BaseAccelerometer axes number.

Parameters

[in]	ip	pointer to `BaseAccelerometer` interface.
[out]	axes	a buffer which would be filled with raw data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Definition at line 118 of file lis302dl.c.

References LIS302DL_ACC_NUMBER_OF_AXES, LIS302DL_READY, and lis302dlSPIReadRegister().

Referenced by acc_read_cooked().

Here is the call graph for this function:

◆ acc_read_cooked()

static msg_t acc_read_cooked	(	void *	ip,
		float	axes[]
	)

static

Retrieves cooked data from the BaseAccelerometer.

Note: This data is manipulated according to the formula cooked = (raw * sensitivity) - bias.; Final data is expressed as milli-G.; The axes array must be at least the same size of the BaseAccelerometer axes number.

Parameters

[in]	ip	pointer to `BaseAccelerometer` interface.
[out]	axes	a buffer which would be filled with cooked data.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	if one or more I2C errors occurred, the errors can be retrieved using `i2cGetErrors()`.
MSG_TIMEOUT	if a timeout occurred before operation end.

Definition at line 171 of file lis302dl.c.

References acc_read_raw(), LIS302DL_ACC_NUMBER_OF_AXES, and LIS302DL_READY.

Here is the call graph for this function:

◆ acc_set_bias()

static msg_t acc_set_bias	(	void *	ip,
		float *	bp
	)

static

Set bias values for the BaseAccelerometer.

Note: Bias must be expressed as milli-G.; The bias buffer must be at least the same size of the BaseAccelerometer axes number.

Parameters

[in]	ip	pointer to `BaseAccelerometer` interface.
[in]	bp	a buffer which contains biases.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 204 of file lis302dl.c.

References LIS302DL_ACC_NUMBER_OF_AXES, and LIS302DL_READY.

◆ acc_reset_bias()

static msg_t acc_reset_bias ( void * ip )

static

Reset bias values for the BaseAccelerometer.

Note: Default biases value are obtained from device datasheet when available otherwise they are considered zero.

Parameters

[in] ip pointer to BaseAccelerometer interface.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 233 of file lis302dl.c.

References LIS302DL_ACC_NUMBER_OF_AXES, and LIS302DL_READY.

◆ acc_set_sensivity()

static msg_t acc_set_sensivity	(	void *	ip,
		float *	sp
	)

static

Set sensitivity values for the BaseAccelerometer.

Note: Sensitivity must be expressed as milli-G/LSB.; The sensitivity buffer must be at least the same size of the BaseAccelerometer axes number.

Parameters

[in]	ip	pointer to `BaseAccelerometer` interface.
[in]	sp	a buffer which contains sensitivities.

Returns: The operation status.

Return values

MSG_OK if the function succeeded.

Definition at line 263 of file lis302dl.c.

References LIS302DL_ACC_NUMBER_OF_AXES, and LIS302DL_READY.

◆ acc_reset_sensivity()

static msg_t acc_reset_sensivity ( void * ip )

static

Reset sensitivity values for the BaseAccelerometer.

Note: Default sensitivities value are obtained from device datasheet.

Parameters

[in] ip pointer to BaseAccelerometer interface.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	otherwise.

Definition at line 292 of file lis302dl.c.

References LIS302DL_ACC_FS_2G, LIS302DL_ACC_NUMBER_OF_AXES, and LIS302DL_READY.

◆ acc_set_full_scale()

static msg_t acc_set_full_scale	(	LIS302DLDriver *	devp,
		lis302dl_acc_fs_t	fs
	)

static

Changes the LIS302DLDriver accelerometer fullscale value.

Note: This function also rescale sensitivities and biases based on previous and next fullscale value.; A recalibration is highly suggested after calling this function.

Parameters

[in]	devp	pointer to `LIS302DLDriver` interface.
[in]	fs	new fullscale value.

Returns: The operation status.

Return values

MSG_OK	if the function succeeded.
MSG_RESET	otherwise.

Definition at line 332 of file lis302dl.c.

References LIS302DL_ACC_FS_2G, and LIS302DL_READY.

◆ lis302dlObjectInit()

void lis302dlObjectInit ( LIS302DLDriver * devp )

Initializes an instance.

Parameters

[out] devp pointer to the LIS302DLDriver object

Function Class:: Initializer, this function just initializes an object and can be invoked before the kernel is initialized.

Definition at line 425 of file lis302dl.c.

References LIS302DLDriver::vmt.

◆ lis302dlStart()

void lis302dlStart	(	LIS302DLDriver *	devp,
		const LIS302DLConfig *	config
	)

Configures and activates LIS302DL Complex Driver peripheral.

Parameters

[in]	devp	pointer to the `LIS302DLDriver` object
[in]	config	pointer to the `LIS302DLConfig` object

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 444 of file lis302dl.c.

References LIS302DL_READY, and LIS302DL_STOP.

◆ lis302dlStop()

void lis302dlStop ( LIS302DLDriver * devp )

Deactivates the LIS302DL Complex Driver peripheral.

Parameters

[in] devp pointer to the LIS302DLDriver object

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 528 of file lis302dl.c.

References LIS302DL_READY, LIS302DL_STOP, and lis302dlSPIWriteRegister().

Here is the call graph for this function:

Detailed Description

Macros

Version identification

LIS302DL communication interfaces related bit masks

LIS302DL register addresses

LIS302DL_CTRL_REG1 register bits definitions

LIS302DL_CTRL_REG2 register bits definitions

LIS302DL_CTRL_REG3 register bits definitions

Configuration options

LIS302DL data structures and types

Data Structures

Functions

Macro Definition Documentation

◆ EX_LIS302DL_VERSION

◆ EX_LIS302DL_MAJOR

◆ EX_LIS302DL_MINOR

◆ EX_LIS302DL_PATCH

◆ LIS302DL_ACC_NUMBER_OF_AXES

◆ LIS302DL_USE_SPI

◆ LIS302DL_SHARED_SPI

◆ LIS302DL_USE_I2C

◆ LIS302DL_SHARED_I2C

◆ LIS302DL_USE_ADVANCED

◆ _lis302dl_methods_alone

◆ _lis302dl_methods

◆ _lis302dl_data

◆ lis302dlAccelerometerGetAxesNumber

◆ lis302dlAccelerometerReadRaw

◆ lis302dlAccelerometerReadCooked

◆ lis302dlAccelerometerSetBias

◆ lis302dlAccelerometerResetBias

◆ lis302dlAccelerometerSetSensitivity

◆ lis302dlAccelerometerResetSensitivity

◆ lis302dlAccelerometerSetFullScale

Typedef Documentation

◆ LIS302DLDriver

Enumeration Type Documentation

◆ lis302dl_acc_fs_t

◆ lis302dl_acc_odr_t

◆ lis302dl_acc_hp_t

◆ lis302dl_state_t

Function Documentation

◆ lis302dlSPIReadRegister()

◆ lis302dlSPIWriteRegister()

◆ acc_get_axes_number()

◆ acc_read_raw()

◆ acc_read_cooked()

◆ acc_set_bias()

◆ acc_reset_bias()

◆ acc_set_sensivity()

◆ acc_reset_sensivity()

◆ acc_set_full_scale()

◆ lis302dlObjectInit()

◆ lis302dlStart()

◆ lis302dlStop()