MetaWear C# SDK  1.2.0
C# API for MbientLab's sensor platform
Public Member Functions | List of all members
MbientLab.MetaWear.Sensor.AccelerometerBosch.ILowAndHighGDataProducer Interface Reference

On-board algorithm that detects when low (i.e. free fall) or high g acceleration is measured. Data is represented as a LowHighG object More...

Inheritance diagram for MbientLab.MetaWear.Sensor.AccelerometerBosch.ILowAndHighGDataProducer:
MbientLab.MetaWear.IAsyncDataProducer MbientLab.MetaWear.IDataProducer

Public Member Functions

void Configure (bool enableLowG=false, ushort? lowDuration=null, float? lowThreshold=null, float? lowHysteresis=null, LowGMode? mode=null, bool enableHighGx=false, bool enableHighGy=false, bool enableHighGz=false, ushort? highDuration=null, float? highThreshold=null, float? highHysteresis=null)
 Configure the low/high-g detection algorithm.
More...
 
- Public Member Functions inherited from MbientLab.MetaWear.IAsyncDataProducer
void Start ()
 Begin data collection More...
 
void Stop ()
 End data collection More...
 
- Public Member Functions inherited from MbientLab.MetaWear.IDataProducer
Task< IRouteAddRouteAsync (Action< IRouteComponent > builder)
 Adds a data route to the producer More...
 

Detailed Description

On-board algorithm that detects when low (i.e. free fall) or high g acceleration is measured. Data is represented as a LowHighG object

Member Function Documentation

◆ Configure()

void MbientLab.MetaWear.Sensor.AccelerometerBosch.ILowAndHighGDataProducer.Configure ( bool  enableLowG = false,
ushort?  lowDuration = null,
float?  lowThreshold = null,
float?  lowHysteresis = null,
LowGMode mode = null,
bool  enableHighGx = false,
bool  enableHighGy = false,
bool  enableHighGz = false,
ushort?  highDuration = null,
float?  highThreshold = null,
float?  highHysteresis = null 
)

Configure the low/high-g detection algorithm.

Both detection types are configured at once with this function. All parameters are optional so developers only need to set the ones they are need

Parameters
enableLowGSet to 'true' to enable low-g detection, defaults to 'false'
lowDurationMinimum amount of time the acceleration must stay below (ths + hys) for an interrupt, between [2.5, 640]ms
lowThresholdThreshold that triggers a low-g interrupt, between [0.00391, 2.0]g
lowHysteresisHysteresis level for low-g interrupt, between [0, 0.375]g
modeLow G detection type
enableHighGxSet to 'true' to enable high-g detection on the x-axis, default to 'false'
enableHighGySet to 'true' to enable high-g detection on the y-axis, default to 'false'
enableHighGzSet to 'true' to enable high-g detection on the z-axis, default to 'false'
highDurationMinimum amount of time the acceleration sign does not change for an interrupt
highThresholdThreshold for clearing high-g interrupt
highHysteresisHysteresis level for clearing the high-g interrupt

The documentation for this interface was generated from the following file: