| commit | eb976dc650d954c721967e2a26808f1cd15635c5 | [log] [tgz] |
|---|---|---|
| author | Tim Barham <tim.barham@microsoft.com> | Wed Jul 29 15:40:06 2015 +1000 |
| committer | Tim Barham <tim.barham@microsoft.com> | Wed Jul 29 15:40:06 2015 +1000 |
| tree | 5378ac4c33b7892627491cd0b180083a248c23bd | |
| parent | 4271adb2c44bd2c2e1ed632a060f3a9500fab28f [diff] |
CB-9426 Fix exception when using device orientation plugin on browser platform. The plugin's plugin.xml defines a general <js-module> with the name 'compass'. It defines another <js-module> for the browser platform (that merges with the general module) with the same name. Modules with the same name is not allowed, so Cordova throws an exception at runtime when trying to define the browser version of the module. Since the only difference in the browser version of the module is to fake up deviceorientation events, I've deleted the browser version and added that logic to the general module, with the following change: rather than starting a new event timer everytime watchHeading() is called (which could happen multiple times resulting in multiple superfluous timers), we have a single event timer going as long as there are active watchers.
This plugin provides access to the device's compass. The compass is a sensor that detects the direction or heading that the device is pointed, typically from the top of the device. It measures the heading in degrees from 0 to 359.99, where 0 is north.
Access is via a global navigator.compass object.
Although the object is attached to the global scoped navigator, it is not available until after the deviceready event.
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log(navigator.compass);
}
cordova plugin add cordova-plugin-device-orientation
Get the current compass heading. The compass heading is returned via a CompassHeading object using the compassSuccess callback function.
navigator.compass.getCurrentHeading(compassSuccess, compassError);
function onSuccess(heading) {
alert('Heading: ' + heading.magneticHeading);
};
function onError(error) {
alert('CompassError: ' + error.code);
};
navigator.compass.getCurrentHeading(onSuccess, onError);
Gets the device's current heading at a regular interval. Each time the heading is retrieved, the headingSuccess callback function is executed.
The returned watch ID references the compass watch interval. The watch ID can be used with navigator.compass.clearWatch to stop watching the navigator.compass.
var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
compassOptions may contain the following keys:
function onSuccess(heading) {
var element = document.getElementById('heading');
element.innerHTML = 'Heading: ' + heading.magneticHeading;
};
function onError(compassError) {
alert('Compass error: ' + compassError.code);
};
var options = {
frequency: 3000
}; // Update every 3 seconds
var watchID = navigator.compass.watchHeading(onSuccess, onError, options);
Values for current heading are randomly generated in order to simulate the compass.
Only one watchHeading can be in effect at one time in iOS. If a watchHeading uses a filter, calling getCurrentHeading or watchHeading uses the existing filter value to specify heading changes. Watching heading changes with a filter is more efficient than with time intervals.
filter is not supported.filter.filter.filter.filter.Stop watching the compass referenced by the watch ID parameter.
navigator.compass.clearWatch(watchID);
navigator.compass.watchHeading.var watchID = navigator.compass.watchHeading(onSuccess, onError, options); // ... later on ... navigator.compass.clearWatch(watchID);
A CompassHeading object is returned to the compassSuccess callback function.
magneticHeading: The heading in degrees from 0-359.99 at a single moment in time. (Number)
trueHeading: The heading relative to the geographic North Pole in degrees 0-359.99 at a single moment in time. A negative value indicates that the true heading can't be determined. (Number)
headingAccuracy: The deviation in degrees between the reported heading and the true heading. (Number)
timestamp: The time at which this heading was determined. (milliseconds)
trueHeading is not supported, but reports the same value as magneticHeading
headingAccuracy is always 0 because there is no difference between the magneticHeading and trueHeading
The trueHeading property is not supported, but reports the same value as magneticHeading.
The headingAccuracy property is always 0 because there is no difference between the magneticHeading and trueHeading.
The trueHeading property is not supported, but reports the same value as magneticHeading.
The headingAccuracy property is always 0 because there is no difference between the magneticHeading and trueHeading.
The trueHeading property is only returned for location services enabled via navigator.geolocation.watchLocation().
For iOS 4 devices and above, heading factors in the device's current orientation, and does not reference its absolute position, for apps that supports that orientation.
A CompassError object is returned to the compassError callback function when an error occurs.
CompassError.COMPASS_INTERNAL_ERRCompassError.COMPASS_NOT_SUPPORTED