@hello.nrfcloud.com/proto-map 5.6.3 → 6.0.0

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 (42) hide show
  1. package/README.md +0 -16
  2. package/dist/generator/generateModels.js +0 -85
  3. package/dist/generator/models.js +1 -83
  4. package/dist/markdown/getCodeBlock.js +0 -26
  5. package/dist/models/check-model-rules.js +1 -91
  6. package/dist/models/models.js +5 -114
  7. package/dist/models/types.js +0 -12
  8. package/models/README.md +0 -4
  9. package/models/check-model-rules.ts +1 -90
  10. package/models/models.ts +1 -8
  11. package/models/types.ts +0 -16
  12. package/package.json +2 -3
  13. package/dist/generator/isDir.js +0 -163
  14. package/dist/generator/isDir.spec.js +0 -212
  15. package/dist/markdown/getFrontMatter.js +0 -15
  16. package/dist/models/asset_tracker_v2+AWS/examples/examples.spec.js +0 -489
  17. package/models/PCA20035+solar/README.md +0 -10
  18. package/models/PCA20035+solar/transforms/airQuality.md +0 -48
  19. package/models/PCA20035+solar/transforms/battery.md +0 -46
  20. package/models/PCA20035+solar/transforms/button.md +0 -45
  21. package/models/PCA20035+solar/transforms/deviceInfo.md +0 -72
  22. package/models/PCA20035+solar/transforms/gain.md +0 -45
  23. package/models/PCA20035+solar/transforms/geolocationFromGroundfix.md +0 -67
  24. package/models/PCA20035+solar/transforms/geolocationFromMessage.md +0 -80
  25. package/models/PCA20035+solar/transforms/humidity.md +0 -43
  26. package/models/PCA20035+solar/transforms/networkInfo.md +0 -84
  27. package/models/PCA20035+solar/transforms/pressure.md +0 -43
  28. package/models/PCA20035+solar/transforms/temperature.md +0 -43
  29. package/models/asset_tracker_v2+AWS/README.md +0 -6
  30. package/models/asset_tracker_v2+AWS/examples/examples.spec.ts +0 -229
  31. package/models/asset_tracker_v2+AWS/examples/shadow/example-1.json +0 -24
  32. package/models/asset_tracker_v2+AWS/examples/shadow/example-2.json +0 -30
  33. package/models/asset_tracker_v2+AWS/examples/shadow/example-3.json +0 -37
  34. package/models/asset_tracker_v2+AWS/examples/shadow/example-4.json +0 -48
  35. package/models/asset_tracker_v2+AWS/examples/shadow/example-5.json +0 -43
  36. package/models/asset_tracker_v2+AWS/transforms/GNSS.md +0 -66
  37. package/models/asset_tracker_v2+AWS/transforms/battery-voltage.md +0 -50
  38. package/models/asset_tracker_v2+AWS/transforms/device-info.md +0 -61
  39. package/models/asset_tracker_v2+AWS/transforms/env.md +0 -69
  40. package/models/asset_tracker_v2+AWS/transforms/fuel-gauge.md +0 -62
  41. package/models/asset_tracker_v2+AWS/transforms/roam.md +0 -100
  42. package/models/asset_tracker_v2+AWS/transforms/solar.md +0 -58
@@ -1,24 +0,0 @@
1
- {
2
- "state": {
3
- "reported": {
4
- "roam": {
5
- "v": {
6
- "eest": 8
7
- },
8
- "ts": 1699050062990
9
- },
10
- "env": {
11
- "v": {
12
- "temp": 27.06,
13
- "hum": 31.125,
14
- "atmp": 97.748
15
- },
16
- "ts": 1699050061608
17
- },
18
- "bat": {
19
- "v": 4398,
20
- "ts": 1699050063028
21
- }
22
- }
23
- }
24
- }
@@ -1,30 +0,0 @@
1
- {
2
- "state": {
3
- "reported": {
4
- "gnss": {
5
- "v": {
6
- "lng": -84.50632147267358,
7
- "lat": 33.98771459323253,
8
- "acc": 11.317643165588379,
9
- "alt": 241.9342498779297,
10
- "spd": 0.03478508070111275,
11
- "hdg": 90.31222534179688
12
- },
13
- "ts": 1699049744000
14
- },
15
- "env": {
16
- "v": {
17
- "temp": 21.915307998657227,
18
- "hum": 34.569278717041016,
19
- "atmp": 98.846,
20
- "bsec_iaq": 148
21
- },
22
- "ts": 1699049729518
23
- },
24
- "bat": {
25
- "v": 4414,
26
- "ts": 1699049729959
27
- }
28
- }
29
- }
30
- }
@@ -1,37 +0,0 @@
1
- {
2
- "state": {
3
- "reported": {
4
- "roam": {
5
- "v": {
6
- "rsrp": -95,
7
- "eest": 7
8
- },
9
- "ts": 1699049610301
10
- },
11
- "gnss": {
12
- "v": {
13
- "lng": -84.50601876875358,
14
- "lat": 33.98740758563776,
15
- "acc": 9.021012306213379,
16
- "alt": 316.54864501953125,
17
- "spd": 0.261059045791626,
18
- "hdg": 90.31222534179688
19
- },
20
- "ts": 1699049614000
21
- },
22
- "env": {
23
- "v": {
24
- "temp": 21.915307998657227,
25
- "hum": 34.57707214355469,
26
- "atmp": 98.844,
27
- "bsec_iaq": 142
28
- },
29
- "ts": 1699049609686
30
- },
31
- "bat": {
32
- "v": 4414,
33
- "ts": 1699049610317
34
- }
35
- }
36
- }
37
- }
@@ -1,48 +0,0 @@
1
- {
2
- "state": {
3
- "reported": {
4
- "dev": {
5
- "v": {
6
- "imei": "358299840016535",
7
- "iccid": "89450421180216254864",
8
- "modV": "mfw_nrf91x1_2.0.0-77.beta",
9
- "brdV": "thingy91x_nrf9161",
10
- "appV": "0.0.0-development"
11
- },
12
- "ts": 1699284007851
13
- },
14
- "roam": {
15
- "v": {
16
- "band": 20,
17
- "nw": "LTE-M",
18
- "rsrp": -89,
19
- "area": 2305,
20
- "mccmnc": 24202,
21
- "cell": 34784790,
22
- "ip": "100.81.95.75",
23
- "eest": 7
24
- },
25
- "ts": 1699049665511
26
- },
27
- "env": {
28
- "v": {
29
- "temp": 27.39,
30
- "hum": 15.617,
31
- "atmp": 98.03
32
- },
33
- "ts": 1699049665421
34
- },
35
- "fg": {
36
- "ts": 1699049685992,
37
- "v": {
38
- "V": 4179,
39
- "SoC": 99,
40
- "I": 0,
41
- "T": 257,
42
- "TTE": null,
43
- "TTF": null
44
- }
45
- }
46
- }
47
- }
48
- }
@@ -1,43 +0,0 @@
1
- {
2
- "state": {
3
- "reported": {
4
- "roam": {
5
- "v": {
6
- "band": 20,
7
- "nw": "LTE-M",
8
- "rsrp": -90,
9
- "area": 33129,
10
- "mccmnc": 24201,
11
- "cell": 21679616,
12
- "ip": "100.73.120.2",
13
- "eest": 7
14
- },
15
- "ts": 1701900276787
16
- },
17
- "env": {
18
- "v": {
19
- "temp": 20.794578,
20
- "hum": 9.73001,
21
- "atmp": 101.054242187,
22
- "bsec_iaq": 199
23
- },
24
- "ts": 1701900276736
25
- },
26
- "fg": {
27
- "ts": 1701900277007,
28
- "v": {
29
- "V": 4161,
30
- "SoC": 89,
31
- "I": null,
32
- "T": null,
33
- "TTE": null,
34
- "TTF": null
35
- }
36
- },
37
- "sol": {
38
- "v": { "gain": 0, "bat": 4.15999984741211 },
39
- "ts": 1701900277005
40
- }
41
- }
42
- }
43
- }
@@ -1,66 +0,0 @@
1
- ---
2
- type: shadow
3
- ---
4
-
5
- # GNSS fix
6
-
7
- ## Match Expression
8
-
9
- ```jsonata
10
- $exists(state.reported.gnss)
11
- ```
12
-
13
- ## Transform Expression
14
-
15
- ```jsonata
16
- [
17
- {"bn": "14201/0/", "n": "0", "v": state.reported.gnss.v.lat, "bt": state.reported.gnss.ts },
18
- {"n": "1", "v": state.reported.gnss.v.lng },
19
- {"n": "2", "v": state.reported.gnss.v.alt },
20
- {"n": "3", "v": state.reported.gnss.v.acc },
21
- {"n": "4", "v": state.reported.gnss.v.spd },
22
- {"n": "5", "v": state.reported.gnss.v.hdg },
23
- {"n": "6", "vs": "GNSS" }
24
- ]
25
- ```
26
-
27
- ## Input Example
28
-
29
- ```json
30
- {
31
- "state": {
32
- "reported": {
33
- "gnss": {
34
- "v": {
35
- "lng": -84.50632147267358,
36
- "lat": 33.98771459323253,
37
- "acc": 11.317643165588379,
38
- "alt": 241.9342498779297,
39
- "spd": 0.03478508070111275,
40
- "hdg": 90.31222534179688
41
- },
42
- "ts": 1699049744000
43
- }
44
- }
45
- }
46
- }
47
- ```
48
-
49
- ## Result Example
50
-
51
- ```json
52
- [
53
- {
54
- "bn": "14201/0/",
55
- "n": "0",
56
- "v": 33.98771459323253,
57
- "bt": 1699049744000
58
- },
59
- { "n": "1", "v": -84.50632147267358 },
60
- { "n": "2", "v": 241.9342498779297 },
61
- { "n": "3", "v": 11.317643165588379 },
62
- { "n": "4", "v": 0.03478508070111275 },
63
- { "n": "5", "v": 90.31222534179688 },
64
- { "n": "6", "vs": "GNSS" }
65
- ]
66
- ```
@@ -1,50 +0,0 @@
1
- ---
2
- type: shadow
3
- ---
4
-
5
- # Battery voltage (legacy)
6
-
7
- The battery voltage reading is legacy and new firmware versions report the stat
8
- of charge instead.
9
-
10
- ## Match Expression
11
-
12
- ```jsonata
13
- $exists(state.reported.bat)
14
- ```
15
-
16
- ## Transform Expression
17
-
18
- ```jsonata
19
- [
20
- {"bn": "14202/0/", "n": "1", "v": state.reported.bat.v/1000, "bt": state.reported.bat.ts }
21
- ]
22
- ```
23
-
24
- ## Input Example
25
-
26
- ```json
27
- {
28
- "state": {
29
- "reported": {
30
- "bat": {
31
- "v": 4398,
32
- "ts": 1699050063028
33
- }
34
- }
35
- }
36
- }
37
- ```
38
-
39
- ## Result Example
40
-
41
- ```json
42
- [
43
- {
44
- "bn": "14202/0/",
45
- "n": "1",
46
- "v": 4.398,
47
- "bt": 1699050063028
48
- }
49
- ]
50
- ```
@@ -1,61 +0,0 @@
1
- ---
2
- type: shadow
3
- ---
4
-
5
- # Device Information
6
-
7
- ## Match Expression
8
-
9
- ```jsonata
10
- $exists(state.reported.dev)
11
- ```
12
-
13
- ## Transform Expression
14
-
15
- ```jsonata
16
- [
17
- {"bn": "14204/0/", "n": "0", "vs": state.reported.dev.v.imei, "bt": state.reported.dev.ts },
18
- {"n": "1", "vs": state.reported.dev.v.iccid },
19
- {"n": "2", "vs": state.reported.dev.v.modV },
20
- {"n": "3", "vs": state.reported.dev.v.appV },
21
- {"n": "4", "vs": state.reported.dev.v.brdV }
22
- ]
23
- ```
24
-
25
- ## Input Example
26
-
27
- ```json
28
- {
29
- "state": {
30
- "reported": {
31
- "dev": {
32
- "v": {
33
- "imei": "358299840016535",
34
- "iccid": "89450421180216254864",
35
- "modV": "mfw_nrf91x1_2.0.0-77.beta",
36
- "brdV": "thingy91x_nrf9161",
37
- "appV": "0.0.0-development"
38
- },
39
- "ts": 1699284007851
40
- }
41
- }
42
- }
43
- }
44
- ```
45
-
46
- ## Result Example
47
-
48
- ```json
49
- [
50
- {
51
- "bn": "14204/0/",
52
- "n": "0",
53
- "vs": "358299840016535",
54
- "bt": 1699284007851
55
- },
56
- { "n": "1", "vs": "89450421180216254864" },
57
- { "n": "2", "vs": "mfw_nrf91x1_2.0.0-77.beta" },
58
- { "n": "3", "vs": "0.0.0-development" },
59
- { "n": "4", "vs": "thingy91x_nrf9161" }
60
- ]
61
- ```
@@ -1,69 +0,0 @@
1
- ---
2
- type: shadow
3
- ---
4
-
5
- # Environment
6
-
7
- Creates the environment data from the asset_tracker_v2 shadow document.
8
-
9
- ## Match Expression
10
-
11
- ```jsonata
12
- $exists(state.reported.env)
13
- ```
14
-
15
- ## Transform Expression
16
-
17
- ```jsonata
18
- [
19
- {"bn": "14205/0/", "n": "0", "v": state.reported.env.v.temp, "bt": state.reported.env.ts },
20
- {"n": "1", "v": state.reported.env.v.hum },
21
- {"n": "2", "v": state.reported.env.v.atmp },
22
- {"n": "10", "v": state.reported.env.v.bsec_iaq }
23
- ]
24
- ```
25
-
26
- ## Input Example
27
-
28
- ```json
29
- {
30
- "state": {
31
- "reported": {
32
- "env": {
33
- "v": {
34
- "temp": 27.06,
35
- "hum": 31.125,
36
- "atmp": 97.748,
37
- "bsec_iaq": 148
38
- },
39
- "ts": 1699050061608
40
- }
41
- }
42
- }
43
- }
44
- ```
45
-
46
- ## Result Example
47
-
48
- ```json
49
- [
50
- {
51
- "bn": "14205/0/",
52
- "n": "0",
53
- "v": 27.06,
54
- "bt": 1699050061608
55
- },
56
- {
57
- "n": "1",
58
- "v": 31.125
59
- },
60
- {
61
- "n": "2",
62
- "v": 97.748
63
- },
64
- {
65
- "n": "10",
66
- "v": 148
67
- }
68
- ]
69
- ```
@@ -1,62 +0,0 @@
1
- ---
2
- type: shadow
3
- ---
4
-
5
- # Battery and Power data from NPM fuel gauge
6
-
7
- ## Match Expression
8
-
9
- ```jsonata
10
- $exists(state.reported.fg)
11
- ```
12
-
13
- ## Transform Expression
14
-
15
- ```jsonata
16
- [
17
- {"bn": "14202/0/", "n": "0", "v": state.reported.fg.v.SoC, "bt": state.reported.fg.ts },
18
- {"n": "1", "v": state.reported.fg.v.V/1000 },
19
- {"n": "2", "v": state.reported.fg.v.I },
20
- {"n": "3", "v": state.reported.fg.v.T = null ? null : state.reported.fg.v.T/10 },
21
- {"n": "4", "v": state.reported.fg.v.TTF },
22
- {"n": "5", "v": state.reported.fg.v.TTE }
23
- ]
24
- ```
25
-
26
- ## Input Example
27
-
28
- ```json
29
- {
30
- "state": {
31
- "reported": {
32
- "fg": {
33
- "ts": 1699049685992,
34
- "v": {
35
- "V": 4179,
36
- "SoC": 99,
37
- "I": 0,
38
- "T": 257,
39
- "TTE": null,
40
- "TTF": null
41
- }
42
- }
43
- }
44
- }
45
- }
46
- ```
47
-
48
- ## Result Example
49
-
50
- ```json
51
- [
52
- {
53
- "bn": "14202/0/",
54
- "n": "0",
55
- "v": 99,
56
- "bt": 1699049685992
57
- },
58
- { "n": "1", "v": 4.179 },
59
- { "n": "2", "v": 0 },
60
- { "n": "3", "v": 25.7 }
61
- ]
62
- ```
@@ -1,100 +0,0 @@
1
- ---
2
- type: shadow
3
- ---
4
-
5
- # Roaming information
6
-
7
- Creates the roaming data from the asset_tracker_v2 shadow document.
8
-
9
- ## Match Expression
10
-
11
- ```jsonata
12
- $exists(state.reported.roam)
13
- ```
14
-
15
- ## Transform Expression
16
-
17
- ```jsonata
18
- [
19
- {"bn": "14203/0/", "n": "0", "vs": state.reported.roam.v.nw, "bt": state.reported.roam.ts },
20
- {"n": "1", "v": state.reported.roam.v.band },
21
- {"bn": "14203/0/", "n": "2", "v": state.reported.roam.v.rsrp, "bt": state.reported.roam.ts },
22
- {"n": "3", "v": state.reported.roam.v.area },
23
- {"n": "4", "v": state.reported.roam.v.cell },
24
- {"n": "5", "v": state.reported.roam.v.mccmnc },
25
- {"n": "6", "vs": state.reported.roam.v.ip },
26
- {"bn": "14203/0/", "n": "11", "v": state.reported.roam.v.eest, "bt": state.reported.roam.ts }
27
- ]
28
- ```
29
-
30
- `rsrp` and `eest` are also reported in a message only containing these
31
- properties, so the `bn` and `bt` properties are repeated.
32
-
33
- ## Input Example
34
-
35
- ```json
36
- {
37
- "state": {
38
- "reported": {
39
- "roam": {
40
- "v": {
41
- "band": 20,
42
- "nw": "LTE-M",
43
- "rsrp": -89,
44
- "area": 2305,
45
- "mccmnc": 24202,
46
- "cell": 34784790,
47
- "ip": "100.81.95.75",
48
- "eest": 7
49
- },
50
- "ts": 1699049665511
51
- }
52
- }
53
- }
54
- }
55
- ```
56
-
57
- ## Result Example
58
-
59
- ```json
60
- [
61
- {
62
- "bn": "14203/0/",
63
- "n": "0",
64
- "vs": "LTE-M",
65
- "bt": 1699049665511
66
- },
67
- {
68
- "n": "1",
69
- "v": 20
70
- },
71
- {
72
- "bn": "14203/0/",
73
- "n": "2",
74
- "v": -89,
75
- "bt": 1699049665511
76
- },
77
- {
78
- "n": "3",
79
- "v": 2305
80
- },
81
- {
82
- "n": "4",
83
- "v": 34784790
84
- },
85
- {
86
- "n": "5",
87
- "v": 24202
88
- },
89
- {
90
- "n": "6",
91
- "vs": "100.81.95.75"
92
- },
93
- {
94
- "bn": "14203/0/",
95
- "n": "11",
96
- "v": 7,
97
- "bt": 1699049665511
98
- }
99
- ]
100
- ```
@@ -1,58 +0,0 @@
1
- ---
2
- type: shadow
3
- ---
4
-
5
- # Solar shield
6
-
7
- Data from the solar shield:
8
- https://www.nordicsemi.com/Nordic-news/2023/08/exegers-powerfoyle-shield-enables-unlimited-battery-life-in-development-projects-using-thingy91
9
-
10
- ## Match Expression
11
-
12
- ```jsonata
13
- $exists(state.reported.sol)
14
- ```
15
-
16
- ## Transform Expression
17
-
18
- ```jsonata
19
- [
20
- {"bn": "14210/0/", "n": "0", "v": state.reported.sol.v.gain, "bt": state.reported.sol.ts },
21
- {"n": "1", "v": state.reported.sol.v.bat }
22
- ]
23
- ```
24
-
25
- ## Input Example
26
-
27
- ```json
28
- {
29
- "state": {
30
- "reported": {
31
- "sol": {
32
- "v": {
33
- "gain": 4.391489028930664,
34
- "bat": 3.872000217437744
35
- },
36
- "ts": 1699050063028
37
- }
38
- }
39
- }
40
- }
41
- ```
42
-
43
- ## Result Example
44
-
45
- ```json
46
- [
47
- {
48
- "bn": "14210/0/",
49
- "n": "0",
50
- "v": 4.391489028930664,
51
- "bt": 1699050063028
52
- },
53
- {
54
- "n": "1",
55
- "v": 3.872000217437744
56
- }
57
- ]
58
- ```