@wemap/providers 10.0.0 → 10.2.0

package/helpers/CustomMapProvider.js

@@ -1,4 +1,5 @@
 import { Evented } from 'mapbox-gl';
+import Logger from '@wemap/logger';
 import {
     PositionSmoother, AbsoluteAttitude, AbsolutePosition
 } from '@wemap/providers';
@@ -22,7 +23,8 @@ export default class CustomMapProvider extends Evented {
          * Attitude
          */
         this.attitudeProviderId = AbsoluteAttitude.addEventListener(
-            events => this.fire('heading.changed', { heading: events[0].data.headingDegrees })
+            events => this.fire('heading.changed', { heading: events[0].data.headingDegrees }),
+            Logger.warn
         );
 
         // There is no sense to show the last known attitude on the map
@@ -38,7 +40,8 @@ export default class CustomMapProvider extends Evented {
         });
 
         this.positionProviderId = AbsolutePosition.addEventListener(
-            events => this.smoother.feed(events[0].data)
+            events => this.smoother.feed(events[0].data),
+            Logger.warn
         );
 
         const lastKnownPosition = AbsolutePosition.lastEvent ? AbsolutePosition.lastEvent.data : null;

package/package.json

@@ -8,15 +8,15 @@
     "Guillaume Pannetier <guillaume.pannetier@getwemap.com>"
   ],
   "dependencies": {
-    "@wemap/camera": "^10.0.0",
-    "@wemap/geo": "^10.0.0",
+    "@wemap/camera": "^10.1.0",
+    "@wemap/geo": "^10.1.0",
     "@wemap/geomagnetism": "^0.1.1",
     "@wemap/logger": "^10.0.0",
-    "@wemap/map": "^10.0.0",
+    "@wemap/map": "^10.1.0",
     "@wemap/maths": "^10.0.0",
-    "@wemap/osm": "^10.0.0",
-    "@wemap/routers": "^10.0.0",
-    "@wemap/utils": "^10.0.0"
+    "@wemap/osm": "^10.1.0",
+    "@wemap/routers": "^10.1.0",
+    "@wemap/utils": "^10.1.0"
   },
   "description": "A package using different geoloc systems",
   "devDependencies": {
@@ -42,6 +42,6 @@
     "url": "git+https://github.com/wemap/wemap-modules-js.git"
   },
   "type": "module",
-  "version": "10.0.0",
-  "gitHead": "dabdfdf7dbb6dcdf507ec148160ef228457b0519"
+  "version": "10.2.0",
+  "gitHead": "c90d603fbed21b566a197eb5ad3a30c54921bf54"
 }

package/src/ProvidersInterface.js

@@ -94,7 +94,6 @@ class ProvidersInterface {
             return AbsoluteAttitude;
 
         case EventType.AbsolutePosition:
-        case EventType.ForceVps:
             return AbsolutePosition;
 
         case EventType.RelativeAttitude:
@@ -150,8 +149,6 @@ class ProvidersInterface {
                 throw errorFn('Itinerary');
             }
             break;
-        case EventType.ForceVps:
-            break;
         default:
             throw new Error(`Unable to deal with this event type: ${eventType}`);
         }

package/src/ProvidersOptions.js

@@ -12,7 +12,7 @@ const ProvidersOptions = {
     ignoreProviders: [],
 
     /**
-     * Some providers are not used by default (VPS, QRCodeScanner) because they
+     * Some providers are not used by default (i.e. PoleStar) because they
      * require data from an optional external service or because they drain more
      * battery. They can be added to this list to be used
      * List of {@link Provider#pname}
@@ -34,10 +34,6 @@ const ProvidersOptions = {
 
     smoother: true,
 
-    get hasVps() {
-        return this.optionalProviders.includes('Vps');
-    },
-
     get hasPoleStar() {
         return this.optionalProviders.includes('PoleStar');
     }

package/src/events/EventType.js

@@ -34,7 +34,5 @@ export default {
     CameraNative: 'CAMERA_NATIVE',
 
     Itinerary: 'ITINERARY',
-    Network: 'NETWORK',
-
-    ForceVps: 'FORCE_VPS'
+    Network: 'NETWORK'
 };

package/src/mapmatching/MapMatchingHandler.js

@@ -623,14 +623,6 @@ class MapMatchingHandler extends Provider {
         this._disableMMCloseToATurnDistance = disableMMCloseToATurnDistance;
     }
 
-    get useOrientationMatching() {
-        return this._useOrientationMatching;
-    }
-
-    set useOrientationMatching(useOrientationMatching) {
-        this._useOrientationMatching = useOrientationMatching;
-    }
-
     get minStepsBetweenOrientationMatching() {
         return this._minStepsBetweenOrientationMatching;
     }

package/src/providers/Provider.js

@@ -144,12 +144,12 @@ class Provider {
 
     /**
      *
-     * @param {onEventsFunction} onEvents
-     * @param {Function} onError
+     * @param {onEventsFunction|null|undefined} onEvents
+     * @param {Function|null|undefined} onError
      * @param {Boolean} startIfNecessary
      * @returns {Number}
      */
-    addEventListener(onEvents = () => { }, onError = () => { }, startIfNecessary = true) {
+    addEventListener(onEvents = null, onError = null, startIfNecessary = true) {
         const id = ++Provider._callbackUniqueId;
 
         /**
@@ -157,8 +157,8 @@ class Provider {
          */
         this._eventsCallbacks.push({
             id,
-            onEvents,
-            onError,
+            onEvents: onEvents || (() => {}),
+            onError: onError || (() => {}),
             optional: !startIfNecessary
         });
 

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

@@ -9,7 +9,6 @@ import RelativeAttitude from '../relative/RelativeAttitude.js';
 import Inclination from '../../inclination/Inclination.js';
 import ProviderEvent from '../../../events/ProviderEvent.js';
 import HighRotationsDetector from '../../imu/HighRotationsDetector.js';
-import ProvidersOptions from '../../../ProvidersOptions.js';
 import Vps from '../../vision/vps/Vps.js';
 import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
 
@@ -101,13 +100,11 @@ class AbsoluteAttitude extends Provider {
         );
 
         // Vps
-        if (ProvidersOptions.hasVps) {
-            this._vpsProviderId = Vps.addEventListener(
-                events => this._onAttitudeFromVps(events.find(event => event.dataType === EventType.AbsoluteAttitude)),
-                error => this.notifyError(error),
-                false
-            );
-        }
+        this._vpsProviderId = Vps.addEventListener(
+            events => this._onAttitudeFromVps(events.find(event => event.dataType === EventType.AbsoluteAttitude)),
+            error => this.notifyError(error),
+            false
+        );
 
         this.relativeAttitudeProviderId = RelativeAttitude.addEventListener(
             events => this._onRelativeAttitudeEvent(events[0]),

package/src/providers/position/absolute/AbsolutePosition.js

@@ -8,7 +8,6 @@ import MapMatchingHandler from '../../../mapmatching/MapMatchingHandler.js';
 import GnssWifi from './GnssWifi.js';
 import { default as GeoRelativePositionProvider } from '../relative/GeoRelativePosition.js';
 import ProvidersOptions from '../../../ProvidersOptions.js';
-import ProviderState from '../../ProviderState.js';
 import Vps from '../../vision/vps/Vps.js';
 import PoleStar from './PoleStar.js';
 import AvailabilityHelper from '../../../events/AvailabilityHelper.js';
@@ -62,9 +61,7 @@ class AbsolutePosition extends Provider {
         if (ProvidersOptions.hasPoleStar) {
             providersToCheck.push(PoleStar.availability);
         }
-        if (ProvidersOptions.hasVps) {
-            providersToCheck.push(Vps.availability);
-        }
+        providersToCheck.push(Vps.availability);
         return AvailabilityHelper.some(providersToCheck);
     }
 
@@ -94,13 +91,11 @@ class AbsolutePosition extends Provider {
         );
 
         // Vps
-        if (ProvidersOptions.hasVps) {
-            this._vpsProviderId = Vps.addEventListener(
-                events => this._onAbsolutePosition(events.find(event => event.dataType === EventType.AbsolutePosition)),
-                error => this.notifyError(error),
-                false
-            );
-        }
+        this._vpsProviderId = Vps.addEventListener(
+            events => this._onAbsolutePosition(events.find(event => event.dataType === EventType.AbsolutePosition)),
+            error => this.notifyError(error),
+            false
+        );
 
         // PoleStar
         if (ProvidersOptions.hasPoleStar) {
@@ -292,28 +287,12 @@ class AbsolutePosition extends Provider {
     /**
      * @override
      * @param {UserPosition|ProviderEvent} data
-     * @param {EventType} eventType
      */
-    feed(data, eventType) {
+    feed(data) {
 
         /** @type {ProviderEvent<UserPosition>} */
         let newPositionEvent;
 
-        if (eventType === EventType.ForceVps) {
-            if (!this._vpsProviderId && this.state === ProviderState.STARTED) {
-                this._waitUntilNextVpsPosition = true;
-                this._vpsProviderId = Vps.addEventListener(events => {
-                    this._waitUntilNextVpsPosition = false;
-                    this._onAbsolutePosition(events.find(event => event.dataType === EventType.AbsolutePosition));
-                    Vps.removeEventListener(this._vpsProviderId);
-                    this._vpsProviderId = null;
-                });
-            }
-
-            return;
-
-        }
-
         if (data instanceof UserPosition) {
 
             if (data.time === null) {
@@ -346,6 +325,21 @@ class AbsolutePosition extends Provider {
 
         MapMatchingHandler.notifyPositionFromFeed(newPositionEvent);
     }
+
+    getBestPositionEvent(...absolutePositionEvents) {
+        return absolutePositionEvents.reduce((best, value) => {
+            if (!best) {
+                return value;
+            }
+            if (!value || value.data.accuracy === null || value.data.time === null) {
+                return best;
+            }
+            const {accuracy: curAccuracy, time: curTime} = value.data;
+            const {accuracy: bestAccuracy, time: bestTime} = best.data;
+            // 1.3888 corresponds to 1.3888 m/s (5 km/h)
+            return curAccuracy < (bestAccuracy + 1.3888 * (curTime - bestTime)) ? value : best;
+        }, null);
+    }
 }
 
 export default new AbsolutePosition();

package/src/providers/position/absolute/AbsolutePosition.spec.js

@@ -0,0 +1,35 @@
+/* eslint-disable max-nested-callbacks */
+import { UserPosition } from '@wemap/geo';
+import chai from 'chai';
+
+import EventType from '../../../events/EventType.js';
+import ProviderEvent from '../../../events/ProviderEvent.js';
+import AbsolutePosition from './AbsolutePosition.js';
+
+const { expect } = chai;
+
+
+describe('AbsolutePosition', () => {
+
+    it('getBestPositionEvent', () => {
+
+        const createEvent = (time, accuracy) =>
+            new ProviderEvent(EventType.AbsolutePosition, new UserPosition(0, 0, null, null, time, accuracy));
+
+        const evt1 = createEvent(4, 1);
+        const evt2 = createEvent(4, 5);
+        const evt3 = createEvent(2, 1);
+        const evt4 = createEvent(2, 2);
+
+        expect(AbsolutePosition.getBestPositionEvent(evt1, evt2)).equals(evt1);
+        expect(AbsolutePosition.getBestPositionEvent(evt1, evt3)).equals(evt1);
+        expect(AbsolutePosition.getBestPositionEvent(evt2, evt4)).equals(evt4);
+        expect(AbsolutePosition.getBestPositionEvent(null, evt1)).equals(evt1);
+        expect(AbsolutePosition.getBestPositionEvent(null, evt1, null)).equals(evt1);
+        expect(AbsolutePosition.getBestPositionEvent(null, evt2, evt4)).equals(evt4);
+        expect(AbsolutePosition.getBestPositionEvent(null)).equals(null);
+        expect(AbsolutePosition.getBestPositionEvent(null, null)).equals(null);
+        expect(AbsolutePosition.getBestPositionEvent()).equals(null);
+    });
+
+});

package/src/providers/steps/StepDetector.js

@@ -147,6 +147,10 @@ class StepDetector extends Provider {
         }
         this._algorithm = algorithm;
     }
+
+    get algorithm() {
+        return this._algorithm;
+    }
 }
 
 export default new StepDetector();

package/src/providers/steps/StraightLineDetector.js

@@ -87,7 +87,7 @@ class StraightLineDetector extends Provider {
      * @returns {boolean}
      */
     isStraight() {
-        return this._countSteps >= StraightLineDetector.STEPS_CONSIDERED_FOR_STRAIGHT_LINE;
+        return this._countSteps >= this._stepsConsideredForStraightLine;
     }
 
     get numStepsDetectedFromLastTurn() {

package/src/providers/vision/vps/ImageRelocalization.js

@@ -1,5 +1,6 @@
 import { CameraUtils } from '@wemap/camera';
 import { Attitude, Coordinates, UserPosition } from '@wemap/geo';
+import Logger from '@wemap/logger';
 import { TimeUtils, UserAgentUtils } from '@wemap/utils';
 
 import VpsRequest from './VpsRequest.js';
@@ -48,25 +49,31 @@ class ImageRelocalization {
         // 2. Send the request
         let serverResponse;
         try {
+            const body = JSON.stringify(vpsRequest.toJson());
+            Logger.debug(`[VPS] Request (${(body.length / 1024).toFixed(0)} kB) sent to server ${endpointUrl}`);
             serverResponse = await fetch(endpointUrl, {
                 method: 'POST',
-                body: JSON.stringify(vpsRequest.toJson()),
+                body,
                 headers: Object.assign(
                     { 'Content-Type': 'application/json', 'Accept': 'application/json' },
                     customHeaders ? customHeaders : {}
                 )
             });
         } catch (e) {
+            Logger.debug('[VPS] Server respond error');
             return null;
         }
 
         if (serverResponse.status !== 200) {
+            Logger.debug('[VPS] Server respond error');
             return null;
         }
 
         // 3. Parse the response
         const json = await serverResponse.json();
-        return VpsResponse.fromJson(json, timeBeforeRequest);
+        const res = VpsResponse.fromJson(json, timeBeforeRequest);
+        Logger.debug(`[VPS] Server respond ${res.success ? 'success' : 'not found'}`);
+        return res;
     }
 
     static getHeadingFromQuaternion(quaternion) {

package/src/providers/vision/vps/Vps.js

@@ -11,9 +11,11 @@ import Inclination from '../../inclination/Inclination.js';
 import Provider from '../../Provider.js';
 import ProviderState from '../../ProviderState.js';
 import ImageRelocalization from './ImageRelocalization.js';
-import AbsolutePosition from '../../position/absolute/AbsolutePosition.js';
 import AbsoluteAttitude from '../../attitude/absolute/AbsoluteAttitude.js';
 import RelativeRotationCalc from './RelativeRotationCalc.js';
+import GnssWifi from '../../position/absolute/GnssWifi.js';
+import AbsolutePosition from '../../position/absolute/AbsolutePosition.js';
+import PoleStar from '../../position/absolute/PoleStar.js';
 
 class Vps extends Provider {
 
@@ -179,20 +181,26 @@ class Vps extends Provider {
             }
 
             // 3. Get current image from camera and relocalize it.
+
+            // 3.a. Get current image and time it.
             this._relativeRotationCalc.tickStart();
             const image = await this._camera.currentImage;
+
+            // 3.b. Retrieve coarse position if necessary.
             let coarsePose = null;
-            if (this._useCoarsePose && (AbsolutePosition.lastEvent || AbsoluteAttitude.lastEvent)) {
+            const bestCoarsePosition = AbsolutePosition.getBestPositionEvent(GnssWifi.lastEvent, PoleStar.lastEvent);
+            if (this._useCoarsePose && (bestCoarsePosition || AbsoluteAttitude.lastEvent)) {
                 coarsePose = {};
-                if (AbsolutePosition.lastEvent) {
-                    coarsePose.position = AbsolutePosition.lastEvent.data;
+                if (bestCoarsePosition) {
+                    coarsePose.position = bestCoarsePosition.data;
                 }
                 if (AbsoluteAttitude.lastEvent) {
                     coarsePose.attitude = AbsoluteAttitude.lastEvent.data;
                 }
             }
-            const res = await ImageRelocalization.relocalize(this._endpoint, image, null, coarsePose);
 
+            // 3.c. Send image and metadata.
+            const res = await ImageRelocalization.relocalize(this._endpoint, image, null, coarsePose);
             if (!res || !res.success) {
                 continue;
             }