pxt-calliope/docs/reference/input/calibrate-compass.md
Juri Wolf a93febb5b7
Map and clean deprecated functions (#175)
* add image and deprecated arrow functions

* update locales

* map basic.showArrow

* map arrow blocks

* map & remove arrow images

* remove arrow blocks

* update locales

* remove & patch:
rgbw -> rgb
button/pin pressed -> button/pin event
loudness -> soundLevel

* update ts mappings for arrows

* add wip ts patch rules

* update .blocks files

* use Click instead of Down as default in Documentation and tests

* patch test.blocks

* fix lowercase name tag

* update test.blocks

* update blocks test files

* update blocks test files

* format block files

* pass blocks file tests

* fix ts mapping

* fix color.defl value

closes https://github.com/microsoft/pxt-calliope/issues/136

* fix ts mappings

- add optional spacing at the end of rgbw()
- map up to v4.0.19

* add suggested changes

* replace innerText by textContent

Co-authored-by: JW <gitkraken@juriwolf.de>
Co-authored-by: Juri <info@juriwolf.de>
2022-04-26 10:28:42 -07:00

34 lines
853 B
Markdown

# Calibrate Compass
Runs the compass calibration sequence.
```sig
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.
```blocks
input.onButtonEvent(Button.AB, ButtonEvent.Click, () => {
input.calibrateCompass();
})
```
## See also
[compass heading](/reference/input/compass-heading)