com.mbientlab.metawear.module

Interface Bmm150Magnetometer

All Superinterfaces:

MetaWearBoard.Module

public interface Bmm150Magnetometer
extends MetaWearBoard.Module

Interacts with the BMM150 magnetometer on the MetaWear C Pro boards

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Bmm150Magnetometer.BfieldSamplingConfigEditor Interface for configuring b field sampling, for advanced users only.
static class	Bmm150Magnetometer.OutputDataRate Supported output data rates
static class	Bmm150Magnetometer.PowerPreset Preset power modes for the magnetometer as outlined in the specs sheet.
static interface	Bmm150Magnetometer.SourceSelector Selector for available data sources on the BMM150 chip
static interface	Bmm150Magnetometer.ThresholdDetectionConfigEditor Interface for configuring threshold detection
static class	Bmm150Magnetometer.ThresholdDetectionType Threshold detection types supported on the BMM150 magnetometer
static interface	Bmm150Magnetometer.ThresholdInterrupt Wrapper class encapsulating data from a threshold interrupt

Method Summary

Modifier and Type	Method and Description
Bmm150Magnetometer.BfieldSamplingConfigEditor	configureBFieldSampling() Configures b field sampling
Bmm150Magnetometer.ThresholdDetectionConfigEditor	configureThresholdDetection() Configure the threshold detection
void	disableBFieldSampling() Enables magnetic field sampling
void	disableThresholdDetection() Disables threshold detection
void	enableBFieldSampling() Disables magnetic field sampling
void	enableThresholdDetection(Bmm150Magnetometer.ThresholdDetectionType... types) Enables threshold detection
Bmm150Magnetometer.SourceSelector	routeData() Initiates the creation of a route for BMM150 sensor data
void	setPowerPreset(Bmm150Magnetometer.PowerPreset preset) Sets the power mode to one of the preset configurations
void	setPowerPrsest(Bmm150Magnetometer.PowerPreset preset) Deprecated. As of v2.6.0, replaced with the correctly spelled setPowerPreset(PowerPreset) function
void	start() Switch the magnetometer into normal mode
void	stop() Switch the magnetometer into sleep mode

Method Detail

routeData

Bmm150Magnetometer.SourceSelector routeData()

Initiates the creation of a route for BMM150 sensor data

Returns:

Selection of available data sources

setPowerPrsest

@Deprecated
void setPowerPrsest(Bmm150Magnetometer.PowerPreset preset)

Deprecated. As of v2.6.0, replaced with the correctly spelled setPowerPreset(PowerPreset) function

Sets the power mode to one of the preset configurations

Parameters:

preset - Power preset to use

setPowerPreset

void setPowerPreset(Bmm150Magnetometer.PowerPreset preset)

Sets the power mode to one of the preset configurations

Parameters:

preset - Power preset to use

disableBFieldSampling

void disableBFieldSampling()

Enables magnetic field sampling

enableBFieldSampling

void enableBFieldSampling()

Disables magnetic field sampling

configureBFieldSampling

Bmm150Magnetometer.BfieldSamplingConfigEditor configureBFieldSampling()

Configures b field sampling

Returns:

Editor object to configure the sensor

configureThresholdDetection

Bmm150Magnetometer.ThresholdDetectionConfigEditor configureThresholdDetection()

Configure the threshold detection

Returns:

Editor object to configure the settings

enableThresholdDetection

void enableThresholdDetection(Bmm150Magnetometer.ThresholdDetectionType... types)

Enables threshold detection

Parameters:

types - Threshold detection types to enable

disableThresholdDetection

void disableThresholdDetection()

Disables threshold detection

start

void start()

Switch the magnetometer into normal mode

stop

void stop()

Switch the magnetometer into sleep mode