This module lets you access the built-in electronic compass. Before using, the compass should be calibrated, otherwise the readings may be wrong.
Warning
Calibrating the compass will cause your program to pause until calibration is complete. Calibration consists of a little game to draw a circle on the LED display by rotating the device.
Functions
microbit.compass.
calibrate
()Starts the calibration process. An instructive message will be scrolled to the user after which they will need to rotate the device in order to draw a circle on the LED display.
microbit.compass.
is_calibrated
()Returns
True
if the compass has been successfully calibrated, and returnsFalse
otherwise.
microbit.compass.
get_x
()Gives the reading of the magnetic field strength on the
x
axis in nano tesla, as a positive or negative integer, depending on the direction of the field.
microbit.compass.
get_y
()Gives the reading of the magnetic field strength on the
y
axis in nano tesla, as a positive or negative integer, depending on the direction of the field.
microbit.compass.
get_z
()Gives the reading of the magnetic field strength on the
z
axis in nano tesla, as a positive or negative integer, depending on the direction of the field.