@wemap/providers 3.1.23 → 3.2.2

package/src/logger/NavigationLoggerConverter.js

@@ -0,0 +1,263 @@
+/* eslint-disable complexity */
+import {
+    UserPosition, AbsoluteHeading, Attitude
+} from '@wemap/geo';
+import { Network } from '@wemap/graph';
+
+import EventType from '../events/EventType.js';
+
+const SEPARATOR = ',';
+
+const PRECISION = 1e-6;
+const PRECISION_INV = 1 / PRECISION;
+const round = num => typeof num === 'number' ? Math.round(num * PRECISION_INV) / PRECISION_INV : num;
+
+class NavigationLoggerConverter {
+
+    static configToLog(config) {
+        return [1, JSON.stringify(config)].join(SEPARATOR);
+    }
+
+    static geolocationToLog(time, event) {
+        return [
+            2,
+            round(time),
+            round(event.timestamp),
+            event.coords.latitude,
+            event.coords.longitude,
+            typeof event.coords.altitude === 'number' ? round(event.coords.altitude) : null,
+            round(event.coords.accuracy),
+            typeof event.coords.altitudeAccuracy === 'number' ? round(event.coords.altitudeAccuracy) : null,
+            typeof event.coords.heading === 'number' ? round(event.coords.heading) : null,
+            typeof event.coords.speed === 'number' ? round(event.coords.speed) : null
+        ].join(SEPARATOR);
+    }
+
+    static imuDataToLog(time, event) {
+        switch (event.type) {
+
+        case 'devicemotion':
+            const acc = event.accelerationIncludingGravity;
+            const gyr = event.rotationRate;
+            const linearAcc = event.acceleration;
+            return [
+                3,
+                event.type,
+                round(time),
+                round(event.timeStamp),
+                acc && typeof acc.x === 'number' ? round(acc.x) : null,
+                acc && typeof acc.y === 'number' ? round(acc.y) : null,
+                acc && typeof acc.z === 'number' ? round(acc.z) : null,
+                gyr && typeof gyr.alpha === 'number' ? round(gyr.alpha) : null,
+                gyr && typeof gyr.beta === 'number' ? round(gyr.beta) : null,
+                gyr && typeof gyr.gamma === 'number' ? round(gyr.gamma) : null,
+                linearAcc && typeof linearAcc.x === 'number' ? round(linearAcc.x) : null,
+                linearAcc && typeof linearAcc.y === 'number' ? round(linearAcc.y) : null,
+                linearAcc && typeof linearAcc.z === 'number' ? round(linearAcc.z) : null,
+                round(event.interval)
+            ].join(SEPARATOR);
+
+        case 'deviceorientation':
+            return [
+                3,
+                event.type,
+                round(time),
+                round(event.timeStamp),
+                round(event.alpha),
+                round(event.beta),
+                round(event.gamma),
+                round(event.webkitCompassHeading),
+                event.absolute ? 1 : 0
+            ].join(SEPARATOR);
+
+        case 'deviceorientationabsolute':
+            return [
+                3,
+                event.type,
+                round(time),
+                round(event.timeStamp),
+                round(event.alpha),
+                round(event.beta),
+                round(event.gamma),
+                event.absolute ? 1 : 0
+            ].join(SEPARATOR);
+        }
+
+        throw new Error(`Cannot parse event: ${event.type}`, event);
+    }
+
+    static externalDataToLog(time, eventType, data) {
+        switch (eventType) {
+        case EventType.Network:
+            return [4, 'network', round(time), data === null ? null : JSON.stringify(data.toCompressedJson())].join(SEPARATOR);
+        case EventType.AbsolutePosition:
+            return [4, 'absolute-position', round(time), JSON.stringify(data.toJson())].join(SEPARATOR);
+        case EventType.AbsoluteHeading:
+            return [4, 'absolute-heading', round(time), JSON.stringify(data.toJson())].join(SEPARATOR);
+        case EventType.AbsoluteAttitude:
+            return [4, 'absolute-attitude', round(time), JSON.stringify(data.toJson())].join(SEPARATOR);
+        }
+        return [4, 'unknown', eventType].join(SEPARATOR);
+    }
+
+
+    static logToObj(str) {
+        const logType = parseInt(str[0], 10);
+        switch (logType) {
+        case 1:
+            return this.logToConfig(str);
+        case 2:
+            return this.logToGeolocation(str);
+        case 3:
+            return this.logToImu(str);
+        case 4:
+            return this.logToExternalData(str);
+        }
+
+        throw new Error(`Cannot parse log: ${str}`);
+    }
+
+    static logToConfig(str) {
+        const config = JSON.parse(str.substring(2));
+        return {
+            type: 'config',
+            time: config.startTime,
+            data: config
+        };
+    }
+
+    static logToGeolocation(str) {
+        const array = str.split(SEPARATOR).map(parseFloat);
+        return {
+            type: 'geolocation',
+            time: array[1],
+            data: {
+                timestamp: array[2],
+                coords: {
+                    latitude: array[3],
+                    longitude: array[4],
+                    altitude: array[5],
+                    accuracy: array[6],
+                    altitudeAccuracy: array[7],
+                    heading: array[8],
+                    speed: array[9]
+                }
+            }
+        };
+    }
+
+    static logToImu(str) {
+
+        const indexOfSecondComma = str.indexOf(SEPARATOR, 2);
+        const eventName = str.substring(2, indexOfSecondComma);
+        const data = str.substring(indexOfSecondComma + 1).split(SEPARATOR).map(parseFloat);
+
+        const event = new CustomEvent(eventName);
+        Object.defineProperties(event, { timeStamp: { writable: true } });
+
+        switch (eventName) {
+        case 'devicemotion':
+            Object.assign(event, {
+                timeStamp: data[1],
+                accelerationIncludingGravity: {
+                    x: data[2],
+                    y: data[3],
+                    z: data[4]
+                },
+                rotationRate: {
+                    alpha: data[5],
+                    beta: data[6],
+                    gamma: data[7]
+                },
+                acceleration: {
+                    x: data[8],
+                    y: data[9],
+                    z: data[10]
+                }
+            });
+            break;
+
+        case 'deviceorientation':
+            Object.assign(event, {
+                timeStamp: data[1],
+                alpha: data[2],
+                beta: data[3],
+                gamma: data[4],
+                webkitCompassHeading: data[5],
+                absolute: data[6] === 1
+            });
+            break;
+
+
+        case 'deviceorientationabsolute':
+            Object.assign(event, {
+                timeStamp: data[1],
+                alpha: data[2],
+                beta: data[3],
+                gamma: data[4],
+                absolute: data[5] === 1
+            });
+            break;
+        }
+
+        return {
+            type: 'imu',
+            time: data[0],
+            data: event
+        };
+    }
+
+    static logToExternalData(str) {
+
+        const indexOfSecondComma = str.indexOf(SEPARATOR, 2);
+        const eventTypeStr = str.substring(2, indexOfSecondComma);
+
+        const indexOfThirdComma = str.indexOf(SEPARATOR, indexOfSecondComma + 1);
+        const time = parseFloat(str.substring(indexOfSecondComma + 1, indexOfThirdComma));
+
+        const dataStr = str.substring(indexOfThirdComma + 1);
+
+        let data;
+        switch (eventTypeStr) {
+
+        case 'network':
+            data = {
+                eventType: EventType.Network,
+                data: dataStr === null ? null : Network.fromCompressedJson(JSON.parse(dataStr))
+            };
+            break;
+
+        case 'absolute-position':
+            data = {
+                eventType: EventType.AbsolutePosition,
+                data: dataStr === null ? null : UserPosition.fromJson(JSON.parse(dataStr))
+            };
+            break;
+
+        case 'absolute-attitude':
+            data = {
+                eventType: EventType.AbsoluteAttitude,
+                data: dataStr === null ? null : Attitude.fromJson(JSON.parse(dataStr))
+            };
+            break;
+
+        case 'absolute-heading':
+            data = {
+                eventType: EventType.AbsoluteHeading,
+                data: dataStr === null ? null : AbsoluteHeading.fromJson(JSON.parse(dataStr))
+            };
+            break;
+
+        default:
+            throw new Error(`Cannot parse eventType: ${eventTypeStr}`);
+        }
+
+        return {
+            type: 'external',
+            time,
+            data
+        };
+    }
+}
+
+export default NavigationLoggerConverter;

package/src/providers/FakeProvider.spec.js

@@ -1,10 +1,9 @@
 import { UserPosition } from '@wemap/geo';
-
-import Provider from './Provider';
-
-import EventType from '../events/EventType';
 import { TimeUtils } from '@wemap/utils';
 
+import Provider from './Provider.js';
+import EventType from '../events/EventType.js';
+
 class FakeProvider1 extends Provider {
     static get pname() {
         return 'FakeProvider1';

package/src/providers/MetaProvider.js

@@ -1,6 +1,6 @@
-import EventType from '../events/EventType';
-import Provider from './Provider';
-import ProviderEvent from '../events/ProviderEvent';
+import EventType from '../events/EventType.js';
+import Provider from './Provider.js';
+import ProviderEvent from '../events/ProviderEvent.js';
 
 class MetaProvider extends Provider {
 

package/src/providers/Provider.js

@@ -2,12 +2,12 @@ import noop from 'lodash.noop';
 
 import { TimeUtils } from '@wemap/utils';
 
-import EventType from '../events/EventType';
-import ProviderEvent from '../events/ProviderEvent';
-import ProvidersLogger from '../events/ProvidersLogger';
-import ContainsIgnoredProviderError from '../errors/ContainsIgnoredProviderError';
-import ProvidersOptions from '../ProvidersOptions';
-import ProviderState from './ProviderState';
+import EventType from '../events/EventType.js';
+import ProviderEvent from '../events/ProviderEvent.js';
+import ProvidersLoggerOld from '../events/ProvidersLoggerOld.js';
+import ContainsIgnoredProviderError from '../errors/ContainsIgnoredProviderError.js';
+import ProvidersOptions from '../ProvidersOptions.js';
+import ProviderState from './ProviderState.js';
 
 let uniqueId = 1;
 
@@ -52,7 +52,7 @@ class Provider {
 
         this.id = uniqueId++;
 
-        ProvidersLogger.addEvent(this, 'constructor');
+        ProvidersLoggerOld.addEvent(this, 'constructor');
     }
 
     /**
@@ -166,6 +166,7 @@ class Provider {
         if (this.state !== ProviderState.STOPPPED) {
             return id;
         }
+        this.state = ProviderState.STARTING;
 
         // Check availability on start if defined in options
         let availabilityPromise = Promise.resolve();
@@ -175,9 +176,8 @@ class Provider {
 
         availabilityPromise
             .then(() => {
-                this.state = ProviderState.STARTING;
 
-                ProvidersLogger.addEvent(this, 'start');
+                ProvidersLoggerOld.addEvent(this, 'start');
                 // Call the child start function
                 this.start();
 
@@ -186,6 +186,7 @@ class Provider {
                 this._monitoringCallbacks.forEach(({ onStarted }) => onStarted());
             })
             .catch(e => {
+                this.state = ProviderState.STOPPPED;
                 this.notifyError(e);
             })
             // notifyError can throw an error if onStop is not defined
@@ -226,7 +227,7 @@ class Provider {
             return;
         }
 
-        ProvidersLogger.addEvent(this, 'stop');
+        ProvidersLoggerOld.addEvent(this, 'stop');
         // Call the child stop function
         this.stop();
 
@@ -283,7 +284,7 @@ class Provider {
      */
     notify(...events) {
         // Logging
-        ProvidersLogger.incrementNotifications(this);
+        ProvidersLoggerOld.incrementNotifications(this);
 
         // Add current provider to the list of providers for this event.
         events.forEach(event => event.providersStack.unshift(this.pname));

package/src/providers/Provider.spec.js

@@ -5,15 +5,13 @@ import noop from 'lodash.noop';
 
 import Logger from '@wemap/logger';
 
-import Provider from './Provider';
-
-import ContainsIgnoredProviderError from '../errors/ContainsIgnoredProviderError';
-
+import Provider from './Provider.js';
+import ContainsIgnoredProviderError from '../errors/ContainsIgnoredProviderError.js';
 import {
     FakeProvider1, FakeProvider2, FakeProvider3, FakeProvider4
-} from './FakeProvider.spec';
-import ProvidersOptions from '../ProvidersOptions';
-import ProviderState from './ProviderState';
+} from './FakeProvider.spec.js';
+import ProvidersOptions from '../ProvidersOptions.js';
+import ProviderState from './ProviderState.js';
 
 chai.use(chaiAsPromised);
 Logger.enable(false);

package/src/providers/attitude/EkfAttitude.spec.js

@@ -2,7 +2,7 @@ import chai from 'chai';
 
 import { Quaternion } from '@wemap/maths';
 
-import EkfAttitude from './EkfAttitude';
+import EkfAttitude from './EkfAttitude.js';
 
 const expect = chai.expect;
 

package/src/providers/attitude/absolute/AbsoluteAttitudeFromBrowserProvider.js

@@ -10,12 +10,13 @@ import {
     Browser, BrowserUtils
 } from '@wemap/utils';
 
-import Provider from '../../Provider';
-import EventType from '../../../events/EventType';
-import AskImuOnDesktopError from '../../../errors/AskImuOnDesktopError';
-import MissingMagnetometerError from '../../../errors/MissingMagnetometerError';
-import MissingSensorError from '../../../errors/MissingSensorError';
-import { AbsolutePosition } from '../../../Providers';
+import Provider from '../../Provider.js';
+import EventType from '../../../events/EventType.js';
+import NavigationLogger from '../../../logger/NavigationLogger.js';
+import AskImuOnDesktopError from '../../../errors/AskImuOnDesktopError.js';
+import MissingMagnetometerError from '../../../errors/MissingMagnetometerError.js';
+import MissingSensorError from '../../../errors/MissingSensorError.js';
+import { AbsolutePosition } from '../../../Providers.js';
 
 
 /**
@@ -78,7 +79,6 @@ class AbsoluteAttitudeFromBrowserProvider extends Provider {
                 break;
 
             case Browser.SAFARI:
-            case Browser.IOS_WEBVIEW:
                 window.addEventListener('deviceorientation',
                     this.onDeviceOrientationSafariEvent, true);
                 break;
@@ -124,7 +124,6 @@ class AbsoluteAttitudeFromBrowserProvider extends Provider {
             break;
 
         case Browser.SAFARI:
-        case Browser.IOS_WEBVIEW:
             window.removeEventListener('deviceorientation',
                 this.onDeviceOrientationSafariEvent, true);
             break;
@@ -137,6 +136,7 @@ class AbsoluteAttitudeFromBrowserProvider extends Provider {
 
 
     onDeviceOrientationChromeEvent = e => {
+        NavigationLogger.feedImuData(e);
 
         this.magQuaternionTimestamp = e.timeStamp / 1e3;
 
@@ -153,6 +153,7 @@ class AbsoluteAttitudeFromBrowserProvider extends Provider {
 
 
     onDeviceOrientationSafariEvent = e => {
+        NavigationLogger.feedImuData(e);
 
         this.magQuaternionTimestamp = e.timeStamp / 1e3;
 

package/src/providers/attitude/absolute/AbsoluteAttitudeFromRelAttProvider.js

@@ -1,10 +1,10 @@
 import { Quaternion } from '@wemap/maths';
 import { Attitude } from '@wemap/geo';
 
-import Provider from '../../Provider';
-import EventType from '../../../events/EventType';
+import Provider from '../../Provider.js';
+import EventType from '../../../events/EventType.js';
 import {
-    RelativeAttitude, AbsoluteAttitude, AbsoluteAttitudeFromBrowser
+    RelativeAttitude, AbsoluteAttitude
 } from '../../../Providers.js';
 
 /**
@@ -90,8 +90,7 @@ class AbsoluteAttitudeFromRelAttProvider extends Provider {
         /**
          * Use absolute attitude events only when they are not from this provider
          */
-        if (absoluteAttitudeEvent.providersStack.includes(this.pname)
-            || absoluteAttitudeEvent.providersStack.includes(AbsoluteAttitudeFromBrowser.pname)) {
+        if (absoluteAttitudeEvent.providersStack.includes(this.pname)) {
             return;
         }
         this.absoluteAttitudeEvent = absoluteAttitudeEvent;
@@ -115,7 +114,7 @@ class AbsoluteAttitudeFromRelAttProvider extends Provider {
         const absoluteAttitudeAccuracy = this.absoluteAttitudeEvent.data.accuracy;
 
         const absoluteQuat = Quaternion.multiply(this.zOffset, quaternion);
-        const newAccuracy = absoluteAttitudeAccuracy + this.accuracy;
+        const newAccuracy = Math.min(absoluteAttitudeAccuracy + this.accuracy, Math.PI);
         const attitude = new Attitude(absoluteQuat, time, newAccuracy, this.pname);
 
         this.notify(this.createEvent(

package/src/providers/attitude/absolute/AbsoluteAttitudeProvider.js

@@ -3,11 +3,11 @@ import {
 } from '@wemap/geo';
 import { PromiseUtils } from '@wemap/utils';
 
-import MetaProvider from '../../MetaProvider';
-import EventType from '../../../events/EventType';
+import MetaProvider from '../../MetaProvider.js';
+import EventType from '../../../events/EventType.js';
 import {
     AbsoluteAttitudeFromBrowser, AbsoluteAttitudeFromRelAtt
-} from '../../../Providers';
+} from '../../../Providers.js';
 
 
 /**

package/src/providers/attitude/relative/RelativeAttitudeFromBrowserProvider.js

@@ -2,11 +2,12 @@ import { Attitude } from '@wemap/geo';
 import { Rotations } from '@wemap/maths';
 import { BrowserUtils } from '@wemap/utils';
 
-import Provider from '../../Provider';
-import EventType from '../../../events/EventType';
-import AskImuOnDesktopError from '../../../errors/AskImuOnDesktopError';
-import MissingSensorError from '../../../errors/MissingSensorError';
-import RelativeAttitudeFromInertialProvider from './RelativeAttitudeFromInertialProvider';
+import Provider from '../../Provider.js';
+import EventType from '../../../events/EventType.js';
+import AskImuOnDesktopError from '../../../errors/AskImuOnDesktopError.js';
+import MissingSensorError from '../../../errors/MissingSensorError.js';
+import RelativeAttitudeFromInertialProvider from './RelativeAttitudeFromInertialProvider.js';
+import NavigationLogger from '../../../logger/NavigationLogger.js';
 
 
 /**
@@ -79,6 +80,7 @@ class RelativeAttitudeFromBrowserProvider extends Provider {
 
 
     onDeviceOrientationEvent = e => {
+        NavigationLogger.feedImuData(e);
 
         const timestamp = e.timeStamp / 1e3;
 

package/src/providers/attitude/relative/RelativeAttitudeFromEkfProvider.js

@@ -1,12 +1,12 @@
 import { Attitude } from '@wemap/geo';
 
-import Provider from '../../Provider';
-import EventType from '../../../events/EventType';
-import EkfAttitude from '../EkfAttitude';
-import RelativeAttitudeFromInertialProvider from './RelativeAttitudeFromInertialProvider';
+import Provider from '../../Provider.js';
+import EventType from '../../../events/EventType.js';
+import EkfAttitude from '../EkfAttitude.js';
+import RelativeAttitudeFromInertialProvider from './RelativeAttitudeFromInertialProvider.js';
 import {
     Accelerometer, Gyroscope
-} from '../../../Providers';
+} from '../../../Providers.js';
 
 
 /**

package/src/providers/attitude/relative/RelativeAttitudeFromInertialProvider.js

@@ -1,11 +1,11 @@
 import { deg2rad } from '@wemap/maths';
 import { PromiseUtils } from '@wemap/utils';
 
-import Provider from '../../Provider';
-import EventType from '../../../events/EventType';
+import Provider from '../../Provider.js';
+import EventType from '../../../events/EventType.js';
 import {
     RelativeAttitudeFromEkf, RelativeAttitudeFromBrowser
-} from '../../../Providers';
+} from '../../../Providers.js';
 
 class RelativeAttitudeFromInertialProvider extends Provider {
 

package/src/providers/attitude/relative/RelativeAttitudeProvider.js

@@ -1,10 +1,11 @@
-import Provider from '../../Provider';
-import EventType from '../../../events/EventType';
 import noop from 'lodash.noop';
-import ProviderState from '../../ProviderState';
+
+import Provider from '../../Provider.js';
+import EventType from '../../../events/EventType.js';
+import ProviderState from '../../ProviderState.js';
 import {
     RelativeAttitudeFromInertial, ArCore
-} from '../../../Providers';
+} from '../../../Providers.js';
 
 
 /**

package/src/providers/imu/AccelerometerProvider.js

@@ -1,7 +1,7 @@
-import Provider from '../Provider';
-import EventType from '../../events/EventType';
-import MissingAccelerometerError from '../../errors/MissingAccelerometerError';
-import { Imu } from '../../Providers';
+import Provider from '../Provider.js';
+import EventType from '../../events/EventType.js';
+import MissingAccelerometerError from '../../errors/MissingAccelerometerError.js';
+import { Imu } from '../../Providers.js';
 
 class AccelerometerProvider extends Provider {
 

package/src/providers/imu/GyroscopeProvider.js

@@ -1,7 +1,7 @@
-import Provider from '../Provider';
-import EventType from '../../events/EventType';
-import MissingGyroscopeError from '../../errors/MissingGyroscopeError';
-import { Imu } from '../../Providers';
+import Provider from '../Provider.js';
+import EventType from '../../events/EventType.js';
+import MissingGyroscopeError from '../../errors/MissingGyroscopeError.js';
+import { Imu } from '../../Providers.js';
 
 class GyroscopeProvider extends Provider {
 

package/src/providers/imu/ImuProvider.js

@@ -3,9 +3,10 @@ import {
     Browser, BrowserUtils
 } from '@wemap/utils';
 
-import Provider from '../Provider';
+import Provider from '../Provider.js';
 import EventType from '../../events/EventType';
-import AskImuOnDesktopError from '../../errors/AskImuOnDesktopError';
+import AskImuOnDesktopError from '../../errors/AskImuOnDesktopError.js';
+import NavigationLogger from '../../logger/NavigationLogger.js';
 
 /**
  * Imu (Inertial Measurement Unit) provider retrieve acceleration data
@@ -82,6 +83,7 @@ class ImuProvider extends Provider {
      * @private
      */
     parseDeviceMotionEvent = e => {
+        NavigationLogger.feedImuData(e);
 
         const events = [];
 
@@ -96,8 +98,7 @@ class ImuProvider extends Provider {
             if (typeof x === 'number' && typeof y === 'number' && typeof z === 'number') {
                 acc = [x, y, z];
 
-                if (BrowserUtils.name === Browser.SAFARI
-                    || BrowserUtils.name === Browser.IOS_WEBVIEW) {
+                if (BrowserUtils.name === Browser.SAFARI) {
                     acc[0] *= -1;
                     acc[1] *= -1;
                     acc[2] *= -1;

package/src/providers/inclination/InclinationFromAccProvider.js

@@ -1,6 +1,6 @@
-import Provider from '../Provider';
-import EventType from '../../events/EventType';
-import { Accelerometer } from '../../Providers';
+import Provider from '../Provider.js';
+import EventType from '../../events/EventType.js';
+import { Accelerometer } from '../../Providers.js';
 
 /**
  * Inclination provider gives the inclination of the device using Imu Sensor

package/src/providers/inclination/InclinationFromRelativeAttitudeProvider.js

@@ -1,6 +1,6 @@
-import Provider from '../Provider';
-import EventType from '../../events/EventType';
-import { RelativeAttitudeFromInertial } from '../../Providers';
+import Provider from '../Provider.js';
+import EventType from '../../events/EventType.js';
+import { RelativeAttitudeFromInertial } from '../../Providers.js';
 
 /**
  * Inclination provider gives the inclination of the device using Relative Attitude

package/src/providers/inclination/InclinationProvider.js

@@ -1,10 +1,10 @@
 import { PromiseUtils } from '@wemap/utils';
 
-import MetaProvider from '../MetaProvider';
-import EventType from '../../events/EventType';
+import MetaProvider from '../MetaProvider.js';
+import EventType from '../../events/EventType.js';
 import {
     InclinationFromRelativeAttitude, InclinationFromAcc
-} from '../../Providers';
+} from '../../Providers.js';
 
 /**
  * Inclination provider gives the inclination of the device using Imu Sensor