navigation.magnetometer_source_if.MagnetometerSourceIf Class Reference

Provide normalized three-axis magnetic-field measurements. More...

Inheritance diagram for navigation.magnetometer_source_if.MagnetometerSourceIf:

Public Member Functions
bool	is_connected (self)
	Return whether the source is connected and ready.
None	connect (self)
	Connect to the magnetometer source.
None	disconnect (self)
	Disconnect from the magnetometer source.
MagnetometerSample	read_magnetometer (self)
	Read magnetic field strength in microteslas along each device axis.

Detailed Description

Provide normalized three-axis magnetic-field measurements.

Member Function Documentation

is_connected()

bool navigation.magnetometer_source_if.MagnetometerSourceIf.is_connected

(

self

)

Return whether the source is connected and ready.

Returns

True when the source is connected and ready for measurements.

Reimplemented in navigation.android_magnetometer_adapter.AndroidMagnetometerAdapter.

read_magnetometer()

MagnetometerSample navigation.magnetometer_source_if.MagnetometerSourceIf.read_magnetometer

(

self

)

Read magnetic field strength in microteslas along each device axis.

Returns

Latest normalized magnetic-field sample.

Reimplemented in navigation.android_magnetometer_adapter.AndroidMagnetometerAdapter.

---

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

• controllers/navigation/magnetometer_source_if.py