cordova-plugin-magnetometer
v1.0.0
Published
Cordova Magnetometer Plugin
Downloads
21
Maintainers
Readme
cordova-plugin-magnetometer
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.
Installation
cordova plugin add https://github.com/sdesalas/cordova-plugin-magnetometer
Methods
- cordova.plugins.magnetometer.getReading
- cordova.plugins.magnetometer.watchReadings
- cordova.plugins.magnetometer.stop
cordova.plugins.magnetometer.getReading
Gets a single reading from the magenetometer sensor.
reading
object properties:
x
y
z
magnitude
(calculated total - always positive)
cordova.plugins.magnetometer.watchReadings
Gets regular magnetometer readings sent by the internal sensor, will fire success callback repeatedly.
reading
object properties:
x
y
z
magnitude
(calculated total - always positive)
cordova.plugins.magnetometer.stop
Stops getting readings from the magnetometer sensor. Optional watchID parameter.
Supported Platforms
- iOS
- Android