PhidgetMagnetometerMBS.Constructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Phidgets	MBS Phidgets Plugin	22.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

The constructor.

PhidgetMagnetometerMBS.MagneticField as Double()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Phidgets	MBS Phidgets Plugin	22.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

The most recent field strength value that the channel has reported.

This value will always be between MinMagneticField and MaxMagneticField.

PhidgetMagnetometerMBS.MaxMagneticField as Double()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Phidgets	MBS Phidgets Plugin	22.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

The maximum value the MagneticFieldChange event will report.Any readings outside this range will result in a Saturation event.

This check is done after calibration values have been applied, which will affect your magnetometer's range accordingly.

PhidgetMagnetometerMBS.MinMagneticField as Double()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Phidgets	MBS Phidgets Plugin	22.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

The minimum value the MagneticFieldChange event will report.Any readings outside this range will result in a Saturation event.

This check is done after calibration values have been applied, which will affect your magnetometer's range accordingly.

PhidgetMagnetometerMBS.resetCorrectionParameters

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Phidgets	MBS Phidgets Plugin	22.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Resets the CompassCorrectionParameters to their default values.

Due to physical location, hard and soft iron offsets, and even bias errors, your device should be calibrated. We have created a calibration program that will provide you with the CompassCorrectionParameters for your specific situation. See your device's User Guide for more information.

PhidgetMagnetometerMBS.saveCorrectionParameters

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Phidgets	MBS Phidgets Plugin	22.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Saves the CalibrationParameters.

Due to physical location, hard and soft iron offsets, and even bias errors, your device should be calibrated. We have created a calibration program that will provide you with the CompassCorrectionParameters for your specific situation. See your device's User Guide for more information.

PhidgetMagnetometerMBS.setCorrectionParameters(magneticField as double, offset0 as double, offset1 as double, offset2 as double, gain0 as double, gain1 as double, gain2 as double, T0 as double, T1 as double, T2 as double, T3 as double, T4 as double, T5 as double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Phidgets	MBS Phidgets Plugin	22.1	✅ Yes	✅ Yes	✅ Yes	❌ No	Desktop, Console & Web

Calibrate your device for the environment it will be used in.

Due to physical location, hard and soft iron offsets, and even bias errors, your device should be calibrated. We have created a calibration program that will provide you with the CompassCorrectionParameters for your specific situation. See your device's User Guide for more information.

magneticField: Ambient magnetic field value.
offset0: Provided by calibration program.
offset1: Provided by calibration program.
offset2: Provided by calibration program.
gain0: Provided by calibration program.
gain1: Provided by calibration program.
gain2: Provided by calibration program.
T0: Provided by calibration program.
T1: Provided by calibration program.
T2: Provided by calibration program.
T3: Provided by calibration program.
T4: Provided by calibration program.
T5: Provided by calibration program.