Functions for interacting with the MMA8452Q accelerometer. More...

#include "sensor_common.h"

Enumerations
enum	MblMwAccMma8452qRange { MBL_MW_ACC_MMA8452Q_RANGE_2G = 0 , MBL_MW_ACC_MMA8452Q_RANGE_4G , MBL_MW_ACC_MMA8452Q_RANGE_8G }
	Available g-ranges on the MMA8452Q accelerometer. More...

enum	MblMwAccMma8452qOdr { MBL_MW_ACC_MMA8452Q_ODR_800Hz = 0 , MBL_MW_ACC_MMA8452Q_ODR_400Hz , MBL_MW_ACC_MMA8452Q_ODR_200Hz , MBL_MW_ACC_MMA8452Q_ODR_100Hz , MBL_MW_ACC_MMA8452Q_ODR_50Hz , MBL_MW_ACC_MMA8452Q_ODR_12_5Hz , MBL_MW_ACC_MMA8452Q_ODR_6_25Hz , MBL_MW_ACC_MMA8452Q_ODR_1_56Hz }
	Available output data rates on the MMA8452Q accelerometer.

enum	MblMwAccMma8452qCutoffFreq { MBL_MW_ACC_MMA8452Q_CUTOFF_FREQ_HIGHEST = 0 , MBL_MW_ACC_MMA8452Q_CUTOFF_FREQ_HIGH = 1 , MBL_MW_ACC_MMA8452Q_CUTOFF_FREQ_MEDIUM = 2 , MBL_MW_ACC_MMA8452Q_CUTOFF_FREQ_LOW = 3 }
	Available cutoff frequencies for the MMA8452Q high pass filter.

Functions
METAWEAR_API MblMwDataSignal *	mbl_mw_acc_mma8452q_get_acceleration_data_signal (const MblMwMetaWearBoard *board)
	Retrieves the data signal representing acceleration data for the MMA8452Q accelerometer This signal is timestamp,x,y,z acc data. More...

METAWEAR_API MblMwDataSignal *	mbl_mw_acc_mma8452q_get_high_freq_acceleration_data_signal (const MblMwMetaWearBoard *board)

METAWEAR_API MblMwDataSignal *	mbl_mw_acc_mma8452q_get_packed_acceleration_data_signal (const MblMwMetaWearBoard *board)
	Variant of acceleration data that packs multiple data samples into 1 BLE packet to increase the data throughput. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_set_odr (MblMwMetaWearBoard *board, MblMwAccMma8452qOdr odr)
	Sets the output data rate The ODR sets the output data frequency in Hz. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_set_range (MblMwMetaWearBoard *board, MblMwAccMma8452qRange range)
	Sets the acceleration range The range is in units of Gs. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_set_high_pass_cutoff (MblMwMetaWearBoard *board, float frequency)
	Sets the cutoff frequency for the high-pass filter The high-pass filter cutoff frequency can be set by the user to four different frequencies which are dependent on the output data rate (ODR) Cutoff frequency is set to 16 Hz @ 800 Hz by default. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_write_acceleration_config (const MblMwMetaWearBoard *board)
	Writes the acceleration settings to the sensor Applies the ODR and RANGE values set in set_range() and set_odr(). More...

METAWEAR_API void	mbl_mw_acc_mma8452q_start (const MblMwMetaWearBoard *board)
	Switches the accelerometer to active mode. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_stop (const MblMwMetaWearBoard *board)
	Switches the accelerometer to standby mode. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_enable_acceleration_sampling (const MblMwMetaWearBoard *board)
	Enables acceleration sampling The board will start gathering data from the accelerometer. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_disable_acceleration_sampling (const MblMwMetaWearBoard *board)
	Disables acceleration sampling The board will stop gathering data from the accelerometer. More...

METAWEAR_API MblMwDataSignal *	mbl_mw_acc_mma8452q_get_orientation_detection_data_signal (const MblMwMetaWearBoard *board)
	Retrieves the data signal representing data from the orientation detection algorithm This signal is static orientation detection (portrait/landscape, up/down, left/right, back/front position) More...

METAWEAR_API void	mbl_mw_acc_mma8452q_set_orientation_delay (MblMwMetaWearBoard *board, uint16_t delay)
	Set the orientation calculation mode. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_enable_orientation_detection (const MblMwMetaWearBoard *board)
	Enables orientation detection The board will start gathering orientation data from the accelerometer. More...

METAWEAR_API void	mbl_mw_acc_mma8452q_disable_orientation_detection (const MblMwMetaWearBoard *board)
	Disables orientation detection The board will stop gathering orientation data from the accelerometer. More...

Variables
const uint8_t	MBL_MW_MODULE_ACC_TYPE_MMA8452Q = 0
	Constant identifying the MMA8452Q accelerometer type.

Detailed Description

Functions for interacting with the MMA8452Q accelerometer.

Copyright: MbientLab License

This sensor is only available on MetaWear R boards.

Enumeration Type Documentation

◆ MblMwAccMma8452qRange

enum MblMwAccMma8452qRange

Available g-ranges on the MMA8452Q accelerometer.

Enumerator
MBL_MW_ACC_MMA8452Q_RANGE_2G	+/- 2g
MBL_MW_ACC_MMA8452Q_RANGE_4G	+/- 4g
MBL_MW_ACC_MMA8452Q_RANGE_8G	+/- 8g

Function Documentation

◆ mbl_mw_acc_mma8452q_disable_acceleration_sampling()

METAWEAR_API void mbl_mw_acc_mma8452q_disable_acceleration_sampling ( const MblMwMetaWearBoard * board )

Disables acceleration sampling The board will stop gathering data from the accelerometer.

Parameters

board Calling object

◆ mbl_mw_acc_mma8452q_disable_orientation_detection()

METAWEAR_API void mbl_mw_acc_mma8452q_disable_orientation_detection ( const MblMwMetaWearBoard * board )

Disables orientation detection The board will stop gathering orientation data from the accelerometer.

Parameters

board Calling object

◆ mbl_mw_acc_mma8452q_enable_acceleration_sampling()

METAWEAR_API void mbl_mw_acc_mma8452q_enable_acceleration_sampling ( const MblMwMetaWearBoard * board )

Enables acceleration sampling The board will start gathering data from the accelerometer.

Parameters

board Calling object

◆ mbl_mw_acc_mma8452q_enable_orientation_detection()

METAWEAR_API void mbl_mw_acc_mma8452q_enable_orientation_detection ( const MblMwMetaWearBoard * board )

Enables orientation detection The board will start gathering orientation data from the accelerometer.

Parameters

board Calling object

◆ mbl_mw_acc_mma8452q_get_acceleration_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_acc_mma8452q_get_acceleration_data_signal ( const MblMwMetaWearBoard * board )

Retrieves the data signal representing acceleration data for the MMA8452Q accelerometer This signal is timestamp,x,y,z acc data.

Parameters

board Pointer to the board to retrieve the signal from

Returns: Pointer to the board's MMA8452Q acceleration data signal MblMwCartesianFloat is return signal data type

◆ mbl_mw_acc_mma8452q_get_high_freq_acceleration_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_acc_mma8452q_get_high_freq_acceleration_data_signal ( const MblMwMetaWearBoard * board )

Deprecated:: As of v0.8.0 and will be removed in v1.0.0.

Use mbl_mw_acc_mma8452q_get_packed_acceleration_data_signal instead.

◆ mbl_mw_acc_mma8452q_get_orientation_detection_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_acc_mma8452q_get_orientation_detection_data_signal ( const MblMwMetaWearBoard * board )

Retrieves the data signal representing data from the orientation detection algorithm This signal is static orientation detection (portrait/landscape, up/down, left/right, back/front position)

Parameters

board Calling object

Returns: Pointer to MMA8452Q's orientation detection data signal MblMwSensorOrientation is return signal data type

◆ mbl_mw_acc_mma8452q_get_packed_acceleration_data_signal()

METAWEAR_API MblMwDataSignal* mbl_mw_acc_mma8452q_get_packed_acceleration_data_signal ( const MblMwMetaWearBoard * board )

Variant of acceleration data that packs multiple data samples into 1 BLE packet to increase the data throughput.

This data signal cannot be used with data processing or logging, only with streaming. This signal is timestamp,x,y,z,x,y,z,x,y,z acc data (it packs three acc data points in one timestamp)

Returns: Pointer to the data singal [MblMwCartesianFloat, MblMwCartesianFloat, MblMwCartesianFloat] is return signal data type

◆ mbl_mw_acc_mma8452q_set_high_pass_cutoff()

METAWEAR_API void mbl_mw_acc_mma8452q_set_high_pass_cutoff	(	MblMwMetaWearBoard *	board,
		float	frequency
	)

Sets the cutoff frequency for the high-pass filter The high-pass filter cutoff frequency can be set by the user to four different frequencies which are dependent on the output data rate (ODR) Cutoff frequency is set to 16 Hz @ 800 Hz by default.

See the MM8452Q datasheet for available options.

Parameters

board	Calling object
frequency	Hpf cutoff frequency, set to 0 to disable the high pass filter

◆ mbl_mw_acc_mma8452q_set_odr()

METAWEAR_API void mbl_mw_acc_mma8452q_set_odr	(	MblMwMetaWearBoard *	board,
		MblMwAccMma8452qOdr	odr
	)

Sets the output data rate The ODR sets the output data frequency in Hz.

Parameters

board	Calling object
odr	Output data rate value to set

◆ mbl_mw_acc_mma8452q_set_orientation_delay()

METAWEAR_API void mbl_mw_acc_mma8452q_set_orientation_delay	(	MblMwMetaWearBoard *	board,
		uint16_t	delay
	)

Set the orientation calculation mode.

Parameters

board	Calling object
delay	Time, in milliseconds, for which the sensor's orientation must remain in the new position before a position change is triggered

◆ mbl_mw_acc_mma8452q_set_range()

METAWEAR_API void mbl_mw_acc_mma8452q_set_range	(	MblMwMetaWearBoard *	board,
		MblMwAccMma8452qRange	range
	)

Sets the acceleration range The range is in units of Gs.

Parameters

board	Calling object
range	Acceleration range value to set

◆ mbl_mw_acc_mma8452q_start()

METAWEAR_API void mbl_mw_acc_mma8452q_start ( const MblMwMetaWearBoard * board )

Switches the accelerometer to active mode.

When in active mode, the accelerometer cannot be configured

Parameters

board Calling object

◆ mbl_mw_acc_mma8452q_stop()

METAWEAR_API void mbl_mw_acc_mma8452q_stop ( const MblMwMetaWearBoard * board )

Switches the accelerometer to standby mode.

Parameters

board Calling object

◆ mbl_mw_acc_mma8452q_write_acceleration_config()

METAWEAR_API void mbl_mw_acc_mma8452q_write_acceleration_config ( const MblMwMetaWearBoard * board )

Writes the acceleration settings to the sensor Applies the ODR and RANGE values set in set_range() and set_odr().

Parameters

board Calling object

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ MblMwAccMma8452qRange

Function Documentation

◆ mbl_mw_acc_mma8452q_disable_acceleration_sampling()

◆ mbl_mw_acc_mma8452q_disable_orientation_detection()

◆ mbl_mw_acc_mma8452q_enable_acceleration_sampling()

◆ mbl_mw_acc_mma8452q_enable_orientation_detection()

◆ mbl_mw_acc_mma8452q_get_acceleration_data_signal()

◆ mbl_mw_acc_mma8452q_get_high_freq_acceleration_data_signal()

◆ mbl_mw_acc_mma8452q_get_orientation_detection_data_signal()

◆ mbl_mw_acc_mma8452q_get_packed_acceleration_data_signal()

◆ mbl_mw_acc_mma8452q_set_high_pass_cutoff()

◆ mbl_mw_acc_mma8452q_set_odr()

◆ mbl_mw_acc_mma8452q_set_orientation_delay()

◆ mbl_mw_acc_mma8452q_set_range()

◆ mbl_mw_acc_mma8452q_start()

◆ mbl_mw_acc_mma8452q_stop()

◆ mbl_mw_acc_mma8452q_write_acceleration_config()