Compass

http://docs.phonegap.com/es/1.0.0/phonegap_compass_compass.md.html#Compass

Obtiene la dirección a la que apunta el dispositivo.

compass.getCurrentHeading

Obtiene la dirección actual del dispositivo.

navigator.compass.getCurrentHeading(compassSuccess, compassError, compassOptions);

El compás es un sensor que detecta la dirección a la que el dispositivo está orientado. Estos valores están representadas en grados, desde 0 a 359.99.

La dirección del compás se retorna usando la función 'callback' compassSuccess.

function onSuccess(heading) {
alert('Dirección: ' + heading);
};
function onError() {
alert('onError!');
};
navigator.compass.getCurrentHeading(onSuccess, onError);

compass.watchHeading

Obtiene la dirección del compás en grados cada un cierto intervalo de tiempo.

var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);

El metodo compass.watchHeading obtiene la dirección del compás cada ciertos intervalos de tiempo. Cada vez que la dirección se retorna, se dispara la función 'callback' headingSuccess. Puedes especificar el intervalo de tiempo en milisegundos usando la opción frequency del objeto compassOptions.

Un ID es retornado por la función, ese ID apunta a este visor de dirección, puedes usarlo en la función compass.clearWatch para detener el visor.

function onSuccess(heading) {
var element = document.getElementById('heading');
element.innerHTML = 'Dirección: ' + heading;
};
function onError() {
alert('onError!');
};
var options = { frequency: 3000 }; // Actualizar cada 3 segundos
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);

compassSuccess

Retrollamada (callback) onSuccess que proporciona informacion sobre la direccion del compas.

function(heading) {
// Hacer algo
}

Argumentos

heading: La direccion del compas en grados (de 0 a 359.99), al que apunta en ese preciso momento. (Number)

function onSuccess(heading) {
alert('Heading: ' + heading);
};

compassOptions

Argumento opcional para personalizar la obtención de la dirección del compas.

frequency: Cada cuantos milisegundos obtener la direccion del compas. (Number) (Por defecto: 100)