@wemap/providers 13.2.2 → 14.1.0-beta.0

package/README.md

@@ -1,26 +1,51 @@
-# Positioning / Navigation
+# Positioning Package
 
-## Algorithm description
+The positioning package provides location tracking and positioning capabilities using various location sources.
 
-The positioning/navigation algorithm can be described as follow:
+## Features
 
-+ If an absolute position is received by the system (GNSS, Wifi, Bluetooth, manually input...), this one is considered (by the system) only if one of the three following condition is true:
-  * It is the first absolute position received by the system
-  * Distance between this new position and the previously known position is higher than the new position accuracy (+ epsilon)
-  * Accuracy of the new position is clearly better than the previously known position accuracy
-This is the **relocalization** phase.
+- **Multiple Location Sources**: Support for VPS (Visual Positioning System) and GNSS/WiFi positioning
+- **Map Matching**: Project user positions onto predefined routes for accurate navigation
+- **Pose Tracking**: Complete 3D position and orientation tracking
+- **Event-Based Updates**: Real-time position updates via callbacks
 
-+ If a relative position is received by the system (PDR or ArCore), this one is only considered if a relocalization phase already occurred.
+## Location Sources
 
-+ If an itinerary is sent to the system, this one is used for map-matching. Map-matching is processed using the "point-to-network" algorithm at each step for the PDR and every 400ms for ArCore. Current constants of the map-matching algorithm are: min-distance: 1m, max-distance: 15m, max-angle: 20deg.
+### VPSLocationSource
+Visual positioning using camera for indoor navigation. Combines VPS with PDR (Pedestrian Dead Reckoning) and attitude tracking.
 
-## Remarks about the behavior
+### GnssWifiLocationSource
+GPS and WiFi-based positioning for outdoor navigation. Includes PDR and optional attitude tracking.
+
+## Getting Started
+
+```typescript
+import { VPSLocationSource } from '@wemap/positioning';
+
+const locationSource = new VPSLocationSource({
+  vps: {
+    endpoint: 'https://vps.example.com'
+  }
+});
+
+locationSource.onUpdate((pose) => {
+  console.log('Position:', pose.position);
+  console.log('Attitude:', pose.attitude);
+});
+
+await locationSource.start();
+```
+
+## Map Matching
+
+Use map matching to project positions onto a route:
+
+```typescript
+import { MapMatching } from '@wemap/positioning';
+import { Router } from '@wemap/routing';
+
+const router = new Router();
+const itineraries = await router.directions(origin, destination, 'WALK');
+MapMatching.setItinerary(itineraries[0]);
+```
 
-Few remarks which come out of the previous description:
-- You cannot move with PDR and ArCore until there has been relocalization.
-- On a map, the relocalization phase is a "quick jump" of the blue dot, in AR, the scene camera will translate fast.
-- ArCore is only used in our Android app when the library is available and up-to-date (see here: https://developers.google.com/ar/discover/supported-devices); otherwise, the PDR is used.
-- If you want to mock the PDR, you can hold your phone in the direction you want to go then shake it vertically (ground-sky axis) to fake a step.
-- You cannot mock ArCore; you have to test it by moving.
-- If you fake the relative position with the PDR and you see your blue dot jump back to your initial position, that is probably caused by the relocalization algorithm, and it is normal.
-- If you use a "manually input" and set a position that is not your real position (which is not recommended), your blue dot will probably jump back to your real position at the next GNSS or Wifi fix. That is normal behavior.

package/dist/index.d.ts

@@ -1,44 +1,45 @@
-export * from './src/events/Types.js';
-export * from './src/providers/ProviderState.js';
-export { default as ProvidersOptions } from './src/ProvidersOptions.js';
-export { default as MapMatchingHandler } from './src/mapmatching/MapMatchingHandler.js';
-export { default as PositionSmoother } from './src/smoothers/PositionSmoother.js';
-export { default as AttitudeSmoother } from './src/smoothers/AttitudeSmoother.js';
-export { default as VpsMetadata, type VpsMetadataJson } from './src/providers/vision/vps/VpsMetadata.js';
-export { default as VpsRequest, type VpsRequestJson } from './src/providers/vision/vps/VpsRequest.js';
-export { default as VpsResponse, type VpsResponseJson } from './src/providers/vision/vps/VpsResponse.js';
-export { default as ProvidersLoggerOld } from './src/events/ProvidersLoggerOld.js';
-export { default as ImuProvider } from './src/providers/imu/ImuProvider.js';
-export { default as AccelerometerProvider } from './src/providers/imu/AccelerometerProvider.js';
-export { default as GyroscopeProvider } from './src/providers/imu/GyroscopeProvider.js';
-export { default as HighRotationsProvider } from './src/providers/imu/HighRotationsProvider.js';
-export { default as MagnetometerCalibrationProvider } from './src/providers/imu/MagnetometerCalibrationProvider.js';
-export { default as RelativeAttitudeFromBrowserProvider } from './src/providers/attitude/relative/RelativeAttitudeFromBrowserProvider.js';
-export { default as RelativeAttitudeFromEkfProvider } from './src/providers/attitude/relative/RelativeAttitudeFromEkfProvider.js';
-export { default as RelativeAttitudeFromInertialProvider } from './src/providers/attitude/relative/RelativeAttitudeFromInertialProvider.js';
-export { default as RelativeAttitudeProvider } from './src/providers/attitude/relative/RelativeAttitudeProvider.js';
-export { default as AbsoluteAttitudeFromBrowserProvider, type DeviceOrientationEventiOS } from './src/providers/attitude/absolute/AbsoluteAttitudeFromBrowserProvider.js';
-export { default as AbsoluteAttitudeProvider } from './src/providers/attitude/absolute/AbsoluteAttitudeProvider.js';
-export { default as TurnProvider } from './src/providers/attitude/TurnProvider.js';
-export { default as InclinationFromAccProvider } from './src/providers/inclination/InclinationFromAccProvider.js';
-export { default as InclinationFromRelativeAttitudeProvider } from './src/providers/inclination/InclinationFromRelativeAttitudeProvider.js';
-export { default as InclinationProvider } from './src/providers/inclination/InclinationProvider.js';
-export { default as StepProvider } from './src/providers/steps/StepProvider.js';
-export { default as StraightLineProvider } from './src/providers/steps/StraightLineProvider.js';
-export { default as StepDetectionMinMaxPeaks2 } from './src/providers/steps/StepDetectionMinMaxPeaks2.js';
-export { default as StepDetectionMinMaxPeaks3 } from './src/providers/steps/StepDetectionMinMaxPeaks3.js';
-export { default as PdrProvider } from './src/providers/position/relative/PdrProvider.js';
-export { default as GeoRelativePositionFromArCoreProvider } from './src/providers/position/relative/GeoRelativePositionFromArCoreProvider.js';
-export { default as GeoRelativePositionProvider } from './src/providers/position/relative/GeoRelativePositionProvider.js';
-export { default as GnssWifiProvider } from './src/providers/position/absolute/GnssWifiProvider.js';
-export { default as PoleStarProvider } from './src/providers/position/absolute/PoleStarProvider.js';
-export { default as IpProvider } from './src/providers/position/absolute/IpProvider.js';
-export { default as AbsolutePositionProvider } from './src/providers/position/absolute/AbsolutePositionProvider.js';
-export { default as ArCoreProvider, type Payload as ArCorePayload } from './src/providers/vision/ArCoreProvider.js';
-export { default as ImageRelocalization } from './src/providers/vision/vps/ImageRelocalization.js';
-export { default as VpsProvider, type VpsEvent } from './src/providers/vision/vps/VpsProvider.js';
-export { default as BarcodeProvider } from './src/providers/vision/BarcodeProvider.js';
-export { default as RelativeRotationCalc } from './src/providers/vision/vps/RelativeRotationCalc.js';
-export { default as CameraNativeProvider } from './src/providers/others/CameraNativeProvider.js';
-export { default as CameraProjectionMatrixProvider } from './src/providers/others/CameraProjectionMatrixProvider.js';
-export { default as Constants } from './src/providers/Constants.js';
+export * from './src/events/Types';
+export * from './src/providers/ProviderState';
+export { default as ProvidersOptions } from './src/ProvidersOptions';
+export { default as MapMatchingHandler } from './src/mapmatching/MapMatchingHandler';
+export { default as PositionSmoother } from './src/smoothers/PositionSmoother';
+export { default as AttitudeSmoother } from './src/smoothers/AttitudeSmoother';
+export { default as VpsMetadata, type VpsMetadataJson } from './src/providers/vision/vps/VpsMetadata';
+export { default as VpsRequest, type VpsRequestJson } from './src/providers/vision/vps/VpsRequest';
+export { default as VpsResponse, type VpsResponseJson } from './src/providers/vision/vps/VpsResponse';
+export { default as ProvidersLoggerOld } from './src/events/ProvidersLoggerOld';
+export { default as ImuProvider } from './src/providers/imu/ImuProvider';
+export { default as AccelerometerProvider } from './src/providers/imu/AccelerometerProvider';
+export { default as GyroscopeProvider } from './src/providers/imu/GyroscopeProvider';
+export { default as HighRotationsProvider } from './src/providers/imu/HighRotationsProvider';
+export { default as MagnetometerCalibrationProvider } from './src/providers/imu/MagnetometerCalibrationProvider';
+export { default as RelativeAttitudeFromBrowserProvider } from './src/providers/attitude/relative/RelativeAttitudeFromBrowserProvider';
+export { default as RelativeAttitudeFromEkfProvider } from './src/providers/attitude/relative/RelativeAttitudeFromEkfProvider';
+export { default as RelativeAttitudeFromInertialProvider } from './src/providers/attitude/relative/RelativeAttitudeFromInertialProvider';
+export { default as RelativeAttitudeProvider } from './src/providers/attitude/relative/RelativeAttitudeProvider';
+export { default as AbsoluteAttitudeFromBrowserProvider, type DeviceOrientationEventiOS } from './src/providers/attitude/absolute/AbsoluteAttitudeFromBrowserProvider';
+export { default as AbsoluteAttitudeProvider } from './src/providers/attitude/absolute/AbsoluteAttitudeProvider';
+export { default as TurnProvider } from './src/providers/attitude/TurnProvider';
+export { default as InclinationFromAccProvider } from './src/providers/inclination/InclinationFromAccProvider';
+export { default as InclinationFromRelativeAttitudeProvider } from './src/providers/inclination/InclinationFromRelativeAttitudeProvider';
+export { default as InclinationProvider } from './src/providers/inclination/InclinationProvider';
+export { default as StepProvider } from './src/providers/steps/StepProvider';
+export { default as StraightLineProvider } from './src/providers/steps/StraightLineProvider';
+export { default as StepDetectionMinMaxPeaks2 } from './src/providers/steps/StepDetectionMinMaxPeaks2';
+export { default as StepDetectionMinMaxPeaks3 } from './src/providers/steps/StepDetectionMinMaxPeaks3';
+export { default as PdrProvider } from './src/providers/position/relative/PdrProvider';
+export { default as GeoRelativePositionFromArCoreProvider } from './src/providers/position/relative/GeoRelativePositionFromArCoreProvider';
+export { default as GeoRelativePositionProvider } from './src/providers/position/relative/GeoRelativePositionProvider';
+export { default as GnssWifiProvider } from './src/providers/position/absolute/GnssWifiProvider';
+export { default as PoleStarProvider } from './src/providers/position/absolute/PoleStarProvider';
+export { default as IpProvider } from './src/providers/position/absolute/IpProvider';
+export { default as AbsolutePositionProvider } from './src/providers/position/absolute/AbsolutePositionProvider';
+export { default as ArCoreProvider, type Payload as ArCorePayload } from './src/providers/vision/ArCoreProvider';
+export { default as ImageRelocalization } from './src/providers/vision/vps/ImageRelocalization';
+export { default as VpsProvider, type VpsEvent } from './src/providers/vision/vps/VpsProvider';
+export { default as BarcodeProvider } from './src/providers/vision/BarcodeProvider';
+export { default as RelativeRotationCalc } from './src/providers/vision/vps/RelativeRotationCalc';
+export { default as CameraNativeProvider } from './src/providers/others/CameraNativeProvider';
+export { default as CameraProjectionMatrixProvider } from './src/providers/others/CameraProjectionMatrixProvider';
+export { default as Constants } from './src/providers/Constants';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAErE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAErF,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAE/E,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACtG,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACnG,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAEtG,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAEhF,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,EAAE,OAAO,IAAI,+BAA+B,EAAE,MAAM,qDAAqD,CAAC;AAEjH,OAAO,EAAE,OAAO,IAAI,mCAAmC,EAAE,MAAM,uEAAuE,CAAC;AACvI,OAAO,EAAE,OAAO,IAAI,+BAA+B,EAAE,MAAM,mEAAmE,CAAC;AAC/H,OAAO,EAAE,OAAO,IAAI,oCAAoC,EAAE,MAAM,wEAAwE,CAAC;AACzI,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,4DAA4D,CAAC;AAEjH,OAAO,EAAE,OAAO,IAAI,mCAAmC,EAAE,KAAK,yBAAyB,EAAE,MAAM,uEAAuE,CAAC;AACvK,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,4DAA4D,CAAC;AAEjH,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAEhF,OAAO,EAAE,OAAO,IAAI,0BAA0B,EAAE,MAAM,wDAAwD,CAAC;AAC/G,OAAO,EAAE,OAAO,IAAI,uCAAuC,EAAE,MAAM,qEAAqE,CAAC;AACzI,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAEjG,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAC7F,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,iDAAiD,CAAC;AACvG,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,MAAM,iDAAiD,CAAC;AAEvG,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,+CAA+C,CAAC;AACvF,OAAO,EAAE,OAAO,IAAI,qCAAqC,EAAE,MAAM,yEAAyE,CAAC;AAC3I,OAAO,EAAE,OAAO,IAAI,2BAA2B,EAAE,MAAM,+DAA+D,CAAC;AAEvH,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oDAAoD,CAAC;AACjG,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oDAAoD,CAAC;AACjG,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,8CAA8C,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,4DAA4D,CAAC;AAEjH,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,KAAK,OAAO,IAAI,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACjH,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AAChG,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,KAAK,QAAQ,EAAE,MAAM,wCAAwC,CAAC;AAC/F,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AAElG,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,OAAO,IAAI,8BAA8B,EAAE,MAAM,uDAAuD,CAAC;AAElH,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,2BAA2B,CAAC"}