Files
pxt-calliope/docs/reference/input/magnetic-force.md
2019-12-16 21:25:19 -08:00

1.1 KiB

Magnetic Force

Find the amount of magnetic force (the strength of a magnet) in one of the three directions.

input.magneticForce(Dimension.X);

~hint

The @boardname@ measures magnetic force with microteslas.

You are asked to calibrate the compass the first time run a program that uses the compass.

~

Parameters

  • dimension: this is the direction the @boardname@ 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 of microteslas that means the strength of the magnet

Example

Create a metal detector my measuring the strength of magnetic force in the X direction. Display a bar graph to show the current level of magnetic force measured by the magnetometer.

basic.forever(function() {
    led.plotBarGraph(input.magneticForce(Dimension.X) / 2000, 0)
})

See also

compass heading