Sens'it SDK  v2.0.0
Functions
FXOS8700 APIs

Accelerometer sample code functions. More...

Functions

error_t FXOS8700_init (void)
 Reset accelerometer & Check part ID. More...
 
error_t FXOS8700_reset (void)
 Reset accelerometer registers seting. More...
 
error_t FXOS8700_set_standby_mode (void)
 Put accelerometer in stand-by mode & Disable interrupt. More...
 
error_t FXOS8700_set_transient_mode (fxos8700_range_e range, u8 threshold, u8 count)
 Put accelerometer in transient mode. More...
 
error_t FXOS8700_clear_transient_interrupt (bool *flag)
 Read transient mode interrupt register. More...
 
error_t FXOS8700_read_acceleration (fxos8700_data_s *acc)
 Read acceleration data. More...
 

Detailed Description

Accelerometer sample code functions.


Function Documentation

◆ FXOS8700_init()

error_t FXOS8700_init ( void  )

Reset accelerometer & Check part ID.


Return values
FXOS8700_ERR_NONENo error
FXOS8700_ERR_I2CError on I2C communication
FXOS8700_ERR_IDBad ID value

◆ FXOS8700_reset()

error_t FXOS8700_reset ( void  )

Reset accelerometer registers seting.


Warning
When reseting accelerometer, you may have the error: SENSIT_ERR_I2C_TIMEOUT. You can ignore it.
Return values
FXOS8700_ERR_NONENo error
FXOS8700_ERR_I2CError on I2C communication

◆ FXOS8700_set_standby_mode()

error_t FXOS8700_set_standby_mode ( void  )

Put accelerometer in stand-by mode & Disable interrupt.


Return values
FXOS8700_ERR_NONENo error
FXOS8700_ERR_I2CError on I2C communication

◆ FXOS8700_set_transient_mode()

error_t FXOS8700_set_transient_mode ( fxos8700_range_e  range,
u8  threshold,
u8  count 
)

Put accelerometer in transient mode.


Parameters
[in]rangeAcceleration measurement range
[in]thresholdAcceleration threshold, resolution depend of range
[in]countNumber of event to trigger an interrupt
Return values
FXOS8700_ERR_NONENo error
FXOS8700_ERR_I2CError on I2C communication
FXOS8700_ERR_RANGEInvalid range value

◆ FXOS8700_clear_transient_interrupt()

error_t FXOS8700_clear_transient_interrupt ( bool flag)

Read transient mode interrupt register.


Parameters
[out]flagTRUE if a transient event has been triggered, otherwise FALSE
Return values
FXOS8700_ERR_NONENo error
FXOS8700_ERR_I2CError on I2C communication

◆ FXOS8700_read_acceleration()

error_t FXOS8700_read_acceleration ( fxos8700_data_s acc)

Read acceleration data.


Parameters
[out]accAcceleration of the 3-axis
Return values
FXOS8700_ERR_NONENo error
FXOS8700_ERR_I2CError on I2C communication