pxt-calliope/docs/reference/input/calibrate-compass.md
Juri Wolf 5f7a8e5301
Updates for V4 (#197)
* update yotta defaults for 16kb devices

* refactor deprecated blocks

* updates for button events

* update button events

* update refference

* update docs

* update docs

* update button event blocks

* update docs

* update block id
2022-08-10 09:36:19 -07:00

860 B

Calibrate Compass

Runs the compass calibration sequence.

input.calibrateCompass();

Calibration

The calibration will ask you to draw a circle or fill the LED screen by tilting the @boardname@.

The compass calibration is stored in memory by the @boardname@, so next time you press the reset button or remove and replace the power the calibration will be remembered.

When you flash a new program to your @boardname@ via USB, this memory is cleared so you will have to re-calibrate it.

If you are calibrating or using the compass near metal, it might confuse the @boardname@.

Example

This example runs the calibration when the user presses A+B buttons.

input.onButtonEvent(Button.AB, input.buttonEventClick(), () => {
    input.calibrateCompass();
})

See also

compass heading