pxt-calliope/docs/reference/input/magnetic-force.md

Magnetic Force

Get the magnetic force (micro Teslas), in one of three specified dimensions.

input.magneticForce(Dimension.X);

Parameters

• dimension : String - one of three values specifying the axis of the force: x (left/right); y (forward/backwards); z (up/down); strength (the length of the vector)

Returns

• Number - magnetic force, in micro-Teslas.

Example: metal detector

The following example uses the magnetic force to control the brightness of the screen. When the magnetic force increases, the center LED will appear brighter.

led.plot(2, 2)
basic.forever(() => {
    let f = input.magneticForce(Dimension.X)
    led.setBrightness(f / 2000)
})

See also

compass heading