pxt-calliope/docs/reference/input/magnetic-force.md
2016-07-15 14:53:52 -07:00

43 lines
941 B
Markdown

# Magnetic Force
Find the amount of magnetic force (the strength of a magnet) in the direction you say.
```sig
input.magneticForce(Dimension.X);
```
## ~hint
The micro:bit measures magnetic force with **microteslas**.
## ~
### Parameters
* ``dimension`` means which direction the micro:bit should measure
magnetic force in: either `Dimension.X` (the left-right direction),
`Dimension.Y` (the forward/backward direction), or `Dimension.Z`
(the up/down direction)
### Returns
* a [number](/reference/types/number) of microteslas that means the strength of the magnet
### Example: metal detector
This program makes the center LED of the micro:bit get brighter when
the magnetic force is stronger, and dimmer when it is weaker.
```blocks
led.plot(2, 2)
basic.forever(() => {
let f = input.magneticForce(Dimension.X)
led.setBrightness(f / 2000)
})
```
### See also
[compass heading](/reference/input/compass-heading)