c_meyer/pxt-calliope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rewrote with simple language

Browse Source
This commit is contained in:
Ron Hale-Evans 2016-06-09 15:09:48 -07:00
parent c9d4807f25
commit 8239329c2e
1 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/reference/input/compass-heading.md
View File

@ -1,6 +1,10 @@
# Compass Heading # Compass Heading
Get the compass heading of the micro:bit in degrees. Your micro:bit has a built-in **magnetometer** so it can your direction with respect to the North Magnetic Pole. Find which direction on a compass the micro:bit is facing.
The micro:bit measures the **compass heading** from `0` to `360`
degrees with its **magnetometer** chip. Different numbers mean north,
east, south, and west.
```sig ```sig
input.compassHeading(); input.compassHeading();
@ -8,15 +12,12 @@ input.compassHeading();
### Returns ### Returns
* [Number](/reference/types/number) - the heading in degrees (0 to 360 degrees). If the compass is calibrating, it returns ``-1003``. * a [number](/reference/types/number) from `0` to `360` degrees, which means the compass heading. If the compass isn't ready, it returns `-1003`.
## Simulator
Calibration does not work on the simulator.
### Example ### Example
The following code gets the compass heading and stores it in the `degrees` variable: This program finds the compass heading and stores it in the
`degrees` variable.
```blocks ```blocks
let degrees = input.compassHeading() let degrees = input.compassHeading()
@ -24,13 +25,16 @@ let degrees = input.compassHeading()
### ~hint ### ~hint
When running code with this function in a web browser, click and drag the on-screen compass needle to change heading. When you run a program that uses this function in a browser, click and drag
the compass needle on the screen to change the compass heading.
### ~ ### ~
### Example: compass ### Example: compass
The following example gets the `compass heading` and then displays a letter depending on the value of `degrees`: N for north, E for East, S for South, and W for West. This program finds the compass heading and then shows a letter
that means whether the micro:bit is facing north (N), south (S),
east (E), or west (W).
```blocks ```blocks
basic.forever(() => { basic.forever(() => {
@ -47,11 +51,13 @@ basic.forever(() => {
### Calibration ### Calibration
On the first use of the compass, the **calibration** procedure will automatically start. The user must draw a circle with the device until it is fully calibrated. Every time you start to use the compass (for example, if you have just
turned the micro:bit on), the micro:bit will start to **calibrate**
(adjust itself). It will ask you to draw a circle by tilting the
micro:bit.
An enclosure made from metal, or using in proximity of metal objects, might affect the accuracy of the reading and calibration. If you are calibrating or using the compass near metal, it might
confuse the micro:bit.
During calibration, ``compass heading`` returns ``-1003``.
### Lessons ### Lessons
@ -60,4 +66,3 @@ During calibration, ``compass heading`` returns ``-1003``.
### See also ### See also
[acceleration](/reference/input/acceleration) [acceleration](/reference/input/acceleration)