Bosch sensor measuring magnetic field strength More...
Inheritance diagram for MbientLab.MetaWear.Sensor.IMagnetometerBmm150:
Public Member Functions | |
| void | Configure (ushort xyReps=9, ushort zReps=15, OutputDataRate odr=OutputDataRate._10Hz) |
| Configure the magnetometer More... | |
| void | Configure (Preset preset) |
| Apply a preset configuration More... | |
| void | Start () |
| Switch the magnetometer into normal mode More... | |
| void | Stop () |
| Switch the magnetometer into sleep mode More... | |
| void | Suspend () |
| Switch the magnetometer into suspend mode. When placed in suspend mode, sensor settings are reset and will need to be reconfigured. More... | |
Properties | |
| IAsyncDataProducer | MagneticField [get] |
| Data producer representing the magnetic field strength More... | |
| IAsyncDataProducer | PackedMagneticField [get] |
| Variant data producer that packs 3 B field samples in to 1 ble packet. Only streaming is supported by this data producer More... | |
Detailed Description
Bosch sensor measuring magnetic field strength
Member Function Documentation
◆ Configure() [1/2]
| void MbientLab.MetaWear.Sensor.IMagnetometerBmm150.Configure | ( | ushort | xyReps = 9, |
| ushort | zReps = 15, |
||
| OutputDataRate | odr = OutputDataRate._10Hz |
||
| ) |
Configure the magnetometer
- Parameters
-
xyReps Number of repetitions on the XY axis, between [1, 511], defauts to 9 reps zReps Number of repetitions on the Z axis, between [1, 256], defaut to 15 reps odr Output data rate, defaults to 10Hz
◆ Configure() [2/2]
| void MbientLab.MetaWear.Sensor.IMagnetometerBmm150.Configure | ( | Preset | preset | ) |
Apply a preset configuration
- Parameters
-
preset Preset configuration to use
◆ Start()
| void MbientLab.MetaWear.Sensor.IMagnetometerBmm150.Start | ( | ) |
Switch the magnetometer into normal mode
◆ Stop()
| void MbientLab.MetaWear.Sensor.IMagnetometerBmm150.Stop | ( | ) |
Switch the magnetometer into sleep mode
◆ Suspend()
| void MbientLab.MetaWear.Sensor.IMagnetometerBmm150.Suspend | ( | ) |
Switch the magnetometer into suspend mode. When placed in suspend mode, sensor settings are reset and will need to be reconfigured.
Property Documentation
◆ MagneticField
|
get |
Data producer representing the magnetic field strength
◆ PackedMagneticField
|
get |
Variant data producer that packs 3 B field samples in to 1 ble packet.
Only streaming is supported by this data producer
The documentation for this interface was generated from the following file:
- MetaWear/Sensor/IMagnetometerBmm150.cs
