npm

Need private packages and team management tools?Check out npm Orgs. »

cordova-plugin-magnetometer

1.0.0 • Public • Published

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.

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.


  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:

  • 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.


  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:

  • x
  • y
  • z
  • magnitude (calculated total - always positive)

cordova.plugins.magnetometer.stop

Stops getting readings from the magnetometer sensor. Optional watchID parameter.


  cordova.plugins.magnetometer.stop([watchID])

Supported Platforms

  • iOS
  • Android

install

npm i cordova-plugin-magnetometer

Downloadsweekly downloads

4

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability