@wemap/providers 12.10.8 → 12.10.9

package/src/providers/imu/ImuProvider.ts

@@ -1,110 +0,0 @@
-import { deg2rad, Vector3_t } from '@wemap/maths';
-import { Browser, BrowserUtils } from '@wemap/utils';
-
-import Provider from '../Provider.js';
-import AskImuOnDesktopError from '../../errors/AskImuOnDesktopError.js';
-import { Acceleration, AngularRate } from '../../events/Types.js';
-
-// https://stackoverflow.com/a/73369838/2239938
-interface DeviceMotionEventiOS extends DeviceMotionEvent {
-    requestPermission?: () => Promise<'granted' | 'denied'>;
-}
-
-/**
- * Imu (Inertial Measurement Unit) provider retrieve acceleration data
- *  and/or angular rate data from inertial sensors.
- *
- * -----------------------------------
- * Overview of compatibilities:
- * -----------------------------------
- *
- * Chrome Android (v72.0.3626): YES (via devicemotion)
- * Safari iOS (v12.0): YES (via devicemotion)
- * Opera Android (v50.2.2426): NO {@link https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent}
- * Firefox Android (v65.0.1): YES (via devicemotion)
- *
- * -----------------------------------
- */
-
-type ImuEvent = { readonly acceleration?: Acceleration, readonly angularRate?: AngularRate };
-class ImuProvider extends Provider<ImuEvent> {
-
-    getName = () => 'IMU';
-
-    availability() {
-        return BrowserUtils.isMobile
-            ? Promise.resolve()
-            : Promise.resolve(new AskImuOnDesktopError());
-    }
-
-    start() {
-        const subscribe = () => window.addEventListener('devicemotion', this.parseDeviceMotionEvent, true);
-
-        const requestPermission = (DeviceMotionEvent as unknown as DeviceMotionEventiOS).requestPermission || undefined;
-
-        if (requestPermission) {
-            requestPermission()
-                .then(response => {
-                    if (response !== 'granted') {
-                        throw new Error('Permission not granted');
-                    }
-                    subscribe();
-                })
-                .catch(this.notifyError);
-        } else {
-            subscribe();
-        }
-    }
-
-    stop() {
-        window.removeEventListener('devicemotion', this.parseDeviceMotionEvent, true);
-    }
-
-    /**
-     * devicemotion callback
-     */
-    private parseDeviceMotionEvent = (e: DeviceMotionEvent) => {
-
-        const timestamp = e.timeStamp / 1e3;
-
-        let acc: Vector3_t | undefined;
-        if (e.accelerationIncludingGravity) {
-            const {
-                x, y, z
-            } = e.accelerationIncludingGravity;
-
-            if (typeof x === 'number' && typeof y === 'number' && typeof z === 'number') {
-                acc = [x, y, z];
-
-                if (BrowserUtils.getName() === Browser.SAFARI
-                    || BrowserUtils.getName() === Browser.IOS_WEBVIEW) {
-                    acc[0] *= -1;
-                    acc[1] *= -1;
-                    acc[2] *= -1;
-                }
-            }
-        }
-
-        let gyr: [number, number, number] | undefined;
-        if (e.rotationRate) {
-            const {
-                alpha, beta, gamma
-            } = e.rotationRate;
-
-            if (typeof alpha === 'number' && typeof beta === 'number' && typeof gamma === 'number') {
-                gyr = [deg2rad(alpha), deg2rad(beta), deg2rad(gamma)];
-            }
-        }
-
-
-        if (acc || gyr) {
-            this.notify({
-                ...(acc && { acceleration: { timestamp, values: acc } }),
-                ...(gyr && { angularRate: { timestamp, values: gyr } })
-            });
-        }
-    }
-
-}
-
-export default new ImuProvider();

package/src/providers/imu/MagnetometerCalibrationProvider.ts

@@ -1,21 +0,0 @@
-import Provider from '../Provider.js';
-import AbsoluteAttitudeProvider from '../attitude/absolute/AbsoluteAttitudeProvider.js';
-import { MagnetometerNeedCalibration } from '../../events/Types.js';
-
-class MagnetometerCalibrationProvider extends Provider<MagnetometerNeedCalibration> {
-
-    getName = () => 'MagnetometerCalibrationProvider';
-
-    availability = () => AbsoluteAttitudeProvider.getAvailability();
-
-    constructor() {
-        super();
-        AbsoluteAttitudeProvider._setCallbackMagCalibration(e => this.state === 'started' && this.notify(e));
-    }
-
-    start() { /* do nothing */ }
-    stop() { /* do nothing */ }
-
-}
-
-export default new MagnetometerCalibrationProvider();

package/src/providers/inclination/InclinationFromAccProvider.ts

@@ -1,57 +0,0 @@
-import Provider from '../Provider.js';
-import AccelerometerProvider from '../imu/AccelerometerProvider.js';
-import { Acceleration, Inclination } from '../../events/Types.js';
-
-/**
- * Inclination provider gives the inclination of the device using Imu Sensor
- * For example, when the top of the device is pointing the sky, inclination = Math.PI/2
- *              when the device is layed on a table, inclination = 0
- * This provider use window.orientation to return a result in function of screen orientation
- */
-class InclinationFromAccProvider extends Provider<Inclination> {
-
-    providerId?: number;
-
-    getName = () => 'InclinationFromAcc';
-
-    availability = () => AccelerometerProvider.getAvailability();
-
-    start() {
-        this.providerId = AccelerometerProvider.addEventListener(
-            this.onAccelerometerEvent,
-            this.notifyError
-        );
-    }
-
-    stop() {
-        AccelerometerProvider.removeEventListener(this.providerId);
-    }
-
-    private onAccelerometerEvent = (accelerometerEvent: Acceleration) => {
-        const acc = accelerometerEvent.values;
-
-        const screenOrientation = window.orientation || 0;
-
-        const sizeAcc = Math.sqrt(acc[0] * acc[0] + acc[1] * acc[1] + acc[2] * acc[2]);
-        const accNormalized = [acc[0] / sizeAcc, acc[1] / sizeAcc, acc[2] / sizeAcc];
-
-        const q = [accNormalized[2] + 1, accNormalized[1], -accNormalized[0], 0];
-        const qSize = Math.sqrt(q[0] * q[0] + q[1] * q[1] + q[2] * q[2]);
-        const qNormalized = [q[0] / qSize, q[1] / qSize, q[2] / qSize, 0];
-
-        let inclination;
-        if (screenOrientation === 0) {
-            inclination = Math.asin(2 * qNormalized[1] * qNormalized[0]);
-        } else if (screenOrientation === 90) {
-            inclination = -Math.asin(2 * qNormalized[2] * qNormalized[0]);
-        } else if (screenOrientation === -90) {
-            inclination = Math.asin(2 * qNormalized[2] * qNormalized[0]);
-        } else { // if (screenOrientation === 180) {
-            inclination = -Math.asin(2 * qNormalized[1] * qNormalized[0]);
-        }
-
-        this.notify(inclination);
-    };
-}
-
-export default new InclinationFromAccProvider();

package/src/providers/inclination/InclinationFromRelativeAttitudeProvider.ts

@@ -1,51 +0,0 @@
-import { Quaternion_t } from '@wemap/maths';
-
-import Provider from '../Provider.js';
-import RelativeAttitudeFromInertialProvider from '../attitude/relative/RelativeAttitudeFromInertialProvider.js';
-import { Inclination } from '../../events/Types.js';
-
-
-/**
- * Inclination provider gives the inclination of the device using Relative Attitude
- * For example, when the top of the device is pointing the sky, inclination = Math.PI/2
- *              when the device is layed on a table, inclination = 0
- * This provider use window.orientation to return a result in function of screen orientation
- */
-class InclinationFromRelativeAttitudeProvider extends Provider<Inclination> {
-
-    providerId?: number;
-
-    getName = () => 'InclinationFromRelativeAttitude';
-
-    availability = () => RelativeAttitudeFromInertialProvider.getAvailability();
-
-    start() {
-        this.providerId = RelativeAttitudeFromInertialProvider.addEventListener(
-            attitudeEvent => {
-                const inclination = this.enuQuatToInclination(attitudeEvent.quaternion);
-                this.notify(inclination);
-            },
-            this.notifyError
-        );
-    }
-
-    stop() {
-        RelativeAttitudeFromInertialProvider.removeEventListener(this.providerId);
-    }
-
-    enuQuatToInclination(q: Quaternion_t) {
-        const screenOrientation = window.orientation || 0;
-
-        if (screenOrientation === 0) {
-            return Math.asin(2 * (q[2] * q[3] + q[1] * q[0]));
-        } else if (screenOrientation === 90) {
-            return Math.asin(2 * (q[1] * q[3] - q[2] * q[0]));
-        } else if (screenOrientation === -90) {
-            return Math.asin(2 * (q[2] * q[0] - q[1] * q[3]));
-        }
-        // else if (screenOrientation === 180)
-        return -Math.asin(2 * (q[2] * q[3] + q[1] * q[0]));
-    }
-}
-
-export default new InclinationFromRelativeAttitudeProvider();

package/src/providers/inclination/InclinationProvider.ts

@@ -1,59 +0,0 @@
-import Provider from '../Provider.js';
-import InclinationFromAccProvider from './InclinationFromAccProvider.js';
-import InclinationFromRelativeAttitudeProvider from './InclinationFromRelativeAttitudeProvider.js';
-import AvailabilityHelper from '../../events/AvailabilityHelper.js';
-import { Inclination } from '../../events/Types.js';
-
-/**
- * Inclination provider gives the inclination of the device using Imu Sensor
- * For example, when the top of the device is pointing the sky, inclination = Math.PI/2
- *              when the device is layed on a table, inclination = 0
- * This provider use window.orientation to return a result in function of screen orientation
- */
-class InclinationProvider extends Provider<Inclination> {
-
-    provider?: Provider<Inclination>;
-    providerId?: number;
-
-    getName = () => 'Inclination';
-
-    availability() {
-        return AvailabilityHelper.some([
-            InclinationFromAccProvider.getAvailability(),
-            InclinationFromRelativeAttitudeProvider.getAvailability()
-        ]);
-    }
-
-    async start() {
-
-        const startInclinationFromAcc = () => {
-            this.provider = InclinationFromAccProvider;
-            this.providerId = this.provider.addEventListener(
-                this.notify,
-                this.notifyError
-            );
-        };
-
-        if (await InclinationFromRelativeAttitudeProvider.getAvailability()) {
-            this.provider = InclinationFromRelativeAttitudeProvider;
-            this.providerId = this.provider.addEventListener(
-                this.notify,
-                () => {
-                    InclinationFromRelativeAttitudeProvider.removeEventListener(this.providerId);
-                    startInclinationFromAcc();
-                }
-            );
-        } else {
-            startInclinationFromAcc();
-        }
-    }
-
-
-    stop() {
-        if (this.provider) {
-            this.provider.removeEventListener(this.providerId);
-        }
-    }
-}
-
-export default new InclinationProvider();

package/src/providers/legacy/helpers/HeadingUnlocker.spec.ts

@@ -1,53 +0,0 @@
-import chai from 'chai';
-import chaiAlmost from 'chai-almost';
-
-import { deg2rad } from '@wemap/maths';
-
-import HeadingUnlocker from './HeadingUnlocker.js';
-
-const expect = chai.expect;
-chai.use(chaiAlmost());
-
-describe('HeadingUnlocker', () => {
-
-    it('lock & feed', () => {
-
-        const headingUnlocker = new HeadingUnlocker();
-        headingUnlocker.lock(deg2rad(102));
-
-        headingUnlocker.feedHeading(deg2rad(0));
-        expect(headingUnlocker.locked).to.be.true;
-
-        headingUnlocker.feedHeading(deg2rad(130));
-        expect(headingUnlocker.locked).to.be.true;
-
-        headingUnlocker.feedHeading(deg2rad(100));
-        expect(headingUnlocker.locked).to.be.false;
-
-    });
-
-    it('lock & unlock', () => {
-
-        const headingUnlocker = new HeadingUnlocker();
-        headingUnlocker.lock(deg2rad(102));
-
-        expect(headingUnlocker.locked).to.be.true;
-
-        headingUnlocker.unlock();
-        expect(headingUnlocker.locked).to.be.false;
-
-    });
-
-    it('fails', () => {
-
-        const headingUnlocker = new HeadingUnlocker();
-
-        expect(() => headingUnlocker.feedHeading(0)).throw(Error);
-
-        headingUnlocker.lock(deg2rad(10));
-        headingUnlocker.feedHeading(deg2rad(20));
-        expect(headingUnlocker.locked).to.be.false;
-        expect(() => headingUnlocker.feedHeading(0)).throw(Error);
-
-    });
-});

package/src/providers/legacy/helpers/HeadingUnlocker.ts

@@ -1,44 +0,0 @@
-import { diffAngle, deg2rad } from '@wemap/maths';
-
-/**
- * HeadingUnlocker is designed to block Pdr Step Detection until user is aiming in the right direction
- */
-class HeadingUnlocker {
-
-    static LO_ANGLE = deg2rad(15); // in radians
-
-    // HeadingUnlocker status, by default it is unlocked
-    locked = false;
-
-    waitingOrientation: number | null = null;
-
-
-    unlock() {
-        this.locked = false;
-        this.waitingOrientation = null;
-    }
-
-    lock(waitingOrientation: number) {
-        this.waitingOrientation = waitingOrientation;
-        this.locked = true;
-    }
-
-    feedHeading(heading: number) {
-
-        if (this.waitingOrientation === null) {
-            throw new Error('HeadingUnlocker has not been initialized by lock');
-        }
-
-        if (!this.locked) {
-            throw new Error('HeadingUnlocker is already unlocked');
-        }
-
-        if (Math.abs(diffAngle(heading, this.waitingOrientation)) < HeadingUnlocker.LO_ANGLE) {
-            this.locked = false;
-        }
-
-        return this.locked;
-    }
-}
-
-export default HeadingUnlocker;

package/src/providers/legacy/helpers/ThugDetector.ts

@@ -1,30 +0,0 @@
-import { Constants as GeoConstants } from '@wemap/geo';
-import { Vector3, Vector3_t } from '@wemap/maths';
-
-
-class ThugDetector {
-    
-    static MIN_TIME_BETWEEN_DETECTIONS = 0.5; // in seconds
-    static EXT_ACC_NORM_THRESHOLD = 4; // in m.s^-2
-
-    lastDetectionTimestamp = 0;
-
-    compute(timestamp: number, acceleration: Vector3_t) {
-
-        let detection = false;
-
-        if (timestamp - this.lastDetectionTimestamp < ThugDetector.MIN_TIME_BETWEEN_DETECTIONS) {
-            return detection;
-        }
-
-        const extAccNorm = Vector3.norm(acceleration) - GeoConstants.EARTH_GRAVITY;
-        if (Math.abs(extAccNorm) > ThugDetector.EXT_ACC_NORM_THRESHOLD) {
-            detection = true;
-            this.lastDetectionTimestamp = timestamp;
-        }
-
-        return detection;
-    }
-}
-
-export default ThugDetector;

package/src/providers/others/CameraNativeProvider.ts

@@ -1,29 +0,0 @@
-import Provider from '../Provider.js';
-import ArCoreProvider from '../vision/ArCoreProvider.js';
-import { CameraNativeState } from '../../events/Types.js';
-
-class CameraNativeProvider extends Provider<CameraNativeState> {
-
-    providerId?: number;
-
-    getName = () => 'CameraNative';
-
-    availability = () => Promise.resolve();
-
-    start() {
-
-        if (ArCoreProvider.state !== 'stopped') {
-            this.notify('started');
-        }
-        this.providerId = ArCoreProvider.addMonitoringListener(
-            () => this.notify('started'),
-            () => this.notify('stopped')
-        );
-    }
-
-    stop() {
-        ArCoreProvider.removeMonitoringListener(this.providerId);
-    }
-}
-
-export default new CameraNativeProvider();

package/src/providers/others/CameraProjectionMatrixProvider.ts

@@ -1,25 +0,0 @@
-import Provider from '../Provider.js';
-import ArCoreProvider from '../vision/ArCoreProvider.js';
-import { CameraProjectionMatrix } from '../../events/Types.js';
-
-class CameraProjectionMatrixProvider extends Provider<CameraProjectionMatrix> {
-
-    providerId?: number;
-
-    getName = () => 'CameraProjectionMatrix';
-
-    availability = () => ArCoreProvider.getAvailability();
-
-    start() {
-        this.providerId = ArCoreProvider.addEventListener(
-            event => event.cameraProjection && this.notify(event.cameraProjection),
-            this.notifyError
-        );
-    }
-
-    stop() {
-        ArCoreProvider.removeEventListener(this.providerId);
-    }
-}
-
-export default new CameraProjectionMatrixProvider();

package/src/providers/position/absolute/AbsolutePositionProvider.spec.ts

@@ -1,31 +0,0 @@
-import chai from 'chai';
-
-import AbsolutePositionProvider from './AbsolutePositionProvider.js';
-import { AbsolutePosition } from '../../../events/Types.js';
-
-const { expect } = chai;
-
-describe('AbsolutePositionProvider', () => {
-
-    it('getBestPositionEvent', () => {
-
-        const createPosition = (time: number, accuracy: number) =>
-            new AbsolutePosition(0, 0, null, null, time, accuracy);
-
-        const evt1 = createPosition(4, 1);
-        const evt2 = createPosition(4, 5);
-        const evt3 = createPosition(2, 1);
-        const evt4 = createPosition(2, 2);
-
-        expect(AbsolutePositionProvider.getBestPositionEvent(evt1, evt2)).equals(evt1);
-        expect(AbsolutePositionProvider.getBestPositionEvent(evt1, evt3)).equals(evt1);
-        expect(AbsolutePositionProvider.getBestPositionEvent(evt2, evt4)).equals(evt4);
-        expect(AbsolutePositionProvider.getBestPositionEvent(null, evt1)).equals(evt1);
-        expect(AbsolutePositionProvider.getBestPositionEvent(null, evt1, null)).equals(evt1);
-        expect(AbsolutePositionProvider.getBestPositionEvent(null, evt2, evt4)).equals(evt4);
-        expect(AbsolutePositionProvider.getBestPositionEvent(null)).equals(null);
-        expect(AbsolutePositionProvider.getBestPositionEvent(null, null)).equals(null);
-        expect(AbsolutePositionProvider.getBestPositionEvent()).equals(null);
-    });
-
-});