@wemap/providers 3.1.13 → 3.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -0
  2. package/package.json +6 -6
package/README.md ADDED
@@ -0,0 +1,26 @@
1
+ # Positioning / Navigation
2
+
3
+ ## Algorithm description
4
+
5
+ The positioning/navigation algorithm can be described as follow:
6
+
7
+ + 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:
8
+ * It is the first absolute position received by the system
9
+ * Distance between this new position and the previously known position is higher than the new position accuracy (+ epsilon)
10
+ * Accuracy of the new position is clearly better than the previously known position accuracy
11
+ This is the **relocalization** phase.
12
+
13
+ + If a relative position is received by the system (PDR or ArCore), this one is only considered if a relocalization phase already occurred.
14
+
15
+ + 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.
16
+
17
+ ## Remarks about the behavior
18
+
19
+ Few remarks which come out of the previous description:
20
+ - You cannot move with PDR and ArCore until there has been relocalization.
21
+ - On a map, the relocalization phase is a "quick jump" of the blue dot, in AR, the scene camera will translate fast.
22
+ - 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.
23
+ - 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.
24
+ - You cannot mock ArCore; you have to test it by moving.
25
+ - 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.
26
+ - 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/package.json CHANGED
@@ -8,11 +8,11 @@
8
8
  "Guillaume Pannetier <guillaume.pannetier@getwemap.com>"
9
9
  ],
10
10
  "dependencies": {
11
- "@wemap/geo": "^3.1.11",
12
- "@wemap/graph": "^3.1.11",
11
+ "@wemap/geo": "^3.1.14",
12
+ "@wemap/graph": "^3.1.14",
13
13
  "@wemap/logger": "^3.0.0",
14
- "@wemap/maths": "^3.1.11",
15
- "@wemap/osm": "^3.1.12",
14
+ "@wemap/maths": "^3.1.14",
15
+ "@wemap/osm": "^3.1.14",
16
16
  "@wemap/utils": "^3.1.5",
17
17
  "geomagnetism": "^0.1.0",
18
18
  "lodash.isempty": "^4.4.0",
@@ -65,6 +65,6 @@
65
65
  "lint": "eslint --ext .js,.jsx --quiet src",
66
66
  "test": "mocha -r esm \"src/**/*.spec.js\""
67
67
  },
68
- "version": "3.1.13",
69
- "gitHead": "a6d3552236b6c5482b5ebfc330149589447ede66"
68
+ "version": "3.1.14",
69
+ "gitHead": "a79ee51029fda415610ca86a29e7a22d5f3ada60"
70
70
  }