A magnetic field detector plugin ideal for science toolkit or metal detector apps.
The API can be accessed via single call or by placing a listener that fires a callback function repeatedly.
It displays the raw x, y, and z magnetometer values as well as a computed magnitude of the magnetic field.
- iOS Support by Rameez Raja
- Android Support by Steven de Salas
See this page for a basic sample cordova app using this plugin.
For an in-depth article try this article I wrote: How to Build a Cross-Platform Metal Detector App
cordova plugin add https://github.com/sdesalas/cordova-plugin-magnetometer
- cordova.plugins.magnetometer.getReading
- cordova.plugins.magnetometer.watchReadings
- cordova.plugins.magnetometer.stop
Gets a single reading from the magenetometer sensor.
cordova.plugins.magnetometer.getReading(
function success(reading){
console.log(JSON.stringify(reading));
// Output: {x: 23.113, y:-37.245, z:6.172, magnitude: 44.266}
},
function error(message){
console.log(message);
}
)
reading object properties:
xyzmagnitude(calculated total - always positive)
Gets regular magnetometer readings sent by the internal sensor, will fire success callback repeatedly.
var watchID = cordova.plugins.magnetometer.watchReadings(
function success(reading){
console.log(JSON.stringify(reading));
// Output: {x: 23.113, y:-37.245, z:6.172, magnitude: 44.266}
},
function error(message){
console.log(message);
}
)
reading object properties:
xyzmagnitude(calculated total - always positive)
Stops getting readings from the magnetometer sensor. Optional watchID parameter.
cordova.plugins.magnetometer.stop([watchID])
- iOS
- Android