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

package/models/PCA20035+solar/transforms/deviceInfo.md

@@ -1,72 +0,0 @@
----
-type: messages
----
-
-# Device info
-
-## Match Expression
-
-```jsonata
-appId = 'DEVICE' and $exists(data.deviceInfo)
-```
-
-## Transform Expression
-
-```jsonata
-[
-    {"bn": "14204/0/", "n": "0", "vs": data.deviceInfo.imei, "bt": ts },
-    {"n": "1", "vs": data.deviceInfo.iccid },
-    {"n": "2", "vs": data.deviceInfo.modemFirmware },
-    {"n": "3", "vs": data.deviceInfo.appVersion },
-    {"n": "4", "vs": data.deviceInfo.board },
-    {"n": "5", "vs": data.deviceInfo.bat }
-]
-```
-
-## Input Example
-
-```json
-{
-  "appId": "DEVICE",
-  "messageType": "DATA",
-  "ts": 1676369307189,
-  "data": {
-    "deviceInfo": {
-      "imei": "350457794611739",
-      "iccid": "8931080620054223678",
-      "modemFirmware": "mfw_nrf9160_1.3.3",
-      "board": "thingy91_nrf9160",
-      "appVersion": "0.0.0-development"
-    }
-  }
-}
-```
-
-## Result Example
-
-```json
-[
-  {
-    "bn": "14204/0/",
-    "n": "0",
-    "vs": "350457794611739",
-    "bt": 1676369307189
-  },
-  {
-    "n": "1",
-    "vs": "8931080620054223678"
-  },
-  {
-    "n": "2",
-    "vs": "mfw_nrf9160_1.3.3"
-  },
-  {
-    "n": "3",
-    "vs": "0.0.0-development"
-  },
-  {
-    "n": "4",
-    "vs": "thingy91_nrf9160"
-  }
-]
-```

package/models/PCA20035+solar/transforms/gain.md

@@ -1,45 +0,0 @@
----
-type: messages
----
-
-# Solar Charge gain
-
-The gain measured from the solar shield.
-
-## Match Expression
-
-```jsonata
-appId = 'SOLAR'
-```
-
-## Transform Expression
-
-```jsonata
-[
-    {"bn": "14210/0/", "n": "0", "v": $number(data), "bt": ts }
-]
-```
-
-## Input Example
-
-```json
-{
-  "appId": "SOLAR",
-  "messageType": "DATA",
-  "ts": 1681985624779,
-  "data": "3.123456"
-}
-```
-
-## Result Example
-
-```json
-[
-  {
-    "bn": "14210/0/",
-    "n": "0",
-    "v": 3.123456,
-    "bt": 1681985624779
-  }
-]
-```

package/models/PCA20035+solar/transforms/geolocationFromGroundfix.md

@@ -1,67 +0,0 @@
----
-type: messages
----
-
-# Geo Location from ground fix
-
-Uses the ground fix response from nRF Cloud location services for a device geo
-location.
-
-The geo location is written to instance `1` of the object `14201`.
-
-## Match Expression
-
-```jsonata
-appId = 'GROUND_FIX' and $exists(data.lat) and $exists(data.lon) and $exists(data.uncertainty) and $exists(data.fulfilledWith)
-```
-
-## Transform Expression
-
-```jsonata
-[
-    {"bn": "14201/1/", "n": "0", "v": data.lat, "bt": $millis() },
-    {"n": "1", "v": data.lon },
-    {"n": "3", "v": data.uncertainty },
-    {"n": "6", "vs": data.fulfilledWith }
-]
-```
-
-## Input Example
-
-```json
-{
-  "appId": "GROUND_FIX",
-  "messageType": "DATA",
-  "data": {
-    "lat": 59.3381238,
-    "lon": 18.00908089,
-    "uncertainty": 883.66,
-    "fulfilledWith": "MCELL"
-  }
-}
-```
-
-## Result Example
-
-```json
-[
-  {
-    "bn": "14201/1/",
-    "n": "0",
-    "v": 59.3381238,
-    "bt": 1699999999999
-  },
-  {
-    "n": "1",
-    "v": 18.00908089
-  },
-  {
-    "n": "3",
-    "v": 883.66
-  },
-  {
-    "n": "6",
-    "vs": "MCELL"
-  }
-]
-```

package/models/PCA20035+solar/transforms/geolocationFromMessage.md

@@ -1,80 +0,0 @@
----
-type: messages
----
-
-# Geo Location from a device message
-
-## Match Expression
-
-```jsonata
-appId = 'GNSS'
-```
-
-## Transform Expression
-
-```jsonata
-[
-    {"bn": "14201/0/", "n": "0", "v": data.lat, "bt": ts },
-    {"n": "1", "v": data.lng },
-    {"n": "2", "v": data.alt },
-    {"n": "3", "v": data.acc },
-    {"n": "4", "v": data.spd },
-    {"n": "5", "v": data.hdg },
-    {"n": "6", "vs": "GNSS" }
-]
-```
-
-## Input Example
-
-```json
-{
-  "appId": "GNSS",
-  "messageType": "DATA",
-  "ts": 1690820492999,
-  "data": {
-    "lng": 10.437692463102255,
-    "lat": 63.43308707524497,
-    "acc": 4.703136444091797,
-    "alt": 138.33331298828125,
-    "spd": 0.02938256226480007,
-    "hdg": 185.11207580566406
-  }
-}
-```
-
-## Result Example
-
-```json
-[
-  {
-    "bn": "14201/0/",
-    "n": "0",
-    "v": 63.43308707524497,
-    "bt": 1690820492999
-  },
-  {
-    "n": "1",
-    "v": 10.437692463102255
-  },
-  {
-    "n": "2",
-    "v": 138.33331298828125
-  },
-  {
-    "n": "3",
-    "v": 4.703136444091797
-  },
-  {
-    "n": "4",
-    "v": 0.02938256226480007
-  },
-  {
-    "n": "5",
-    "v": 185.11207580566406
-  },
-  {
-    "n": "6",
-    "vs": "GNSS"
-  }
-]
-```

package/models/PCA20035+solar/transforms/humidity.md

@@ -1,43 +0,0 @@
----
-type: messages
----
-
-# Environment sensor: humidity
-
-## Match Expression
-
-```jsonata
-appId = 'HUMID'
-```
-
-## Transform Expression
-
-```jsonata
-[
-    {"bn": "14205/0/", "n": "1", "v": $number(data), "bt": ts }
-]
-```
-
-## Input Example
-
-```json
-{
-  "appId": "HUMID",
-  "messageType": "DATA",
-  "ts": 1681985384511,
-  "data": "23.16"
-}
-```
-
-## Result Example
-
-```json
-[
-  {
-    "bn": "14205/0/",
-    "n": "1",
-    "v": 23.16,
-    "bt": 1681985384511
-  }
-]
-```

package/models/PCA20035+solar/transforms/networkInfo.md

@@ -1,84 +0,0 @@
----
-type: messages
----
-
-# Network info
-
-## Match Expression
-
-```jsonata
-appId = 'DEVICE' and $exists(data.networkInfo)
-```
-
-## Transform Expression
-
-```jsonata
-[
-    {"bn": "14203/0/", "n": "0", "vs": data.networkInfo.networkMode, "bt": ts },
-    {"n": "1", "v": data.networkInfo.currentBand },
-    {"n": "2", "v": data.networkInfo.rsrp },
-    {"n": "3", "v": data.networkInfo.areaCode },
-    {"n": "4", "v": data.networkInfo.cellID },
-    {"n": "5", "v": data.networkInfo.mccmnc },
-    {"n": "6", "vs": data.networkInfo.ipAddress },
-    {"n": "11", "v": data.networkInfo.eest }
-]
-```
-
-## Input Example
-
-```json
-{
-  "appId": "DEVICE",
-  "messageType": "DATA",
-  "ts": 1676369307222,
-  "data": {
-    "networkInfo": {
-      "currentBand": 20,
-      "networkMode": "LTE-M",
-      "rsrp": -79,
-      "areaCode": 6,
-      "mccmnc": 24001,
-      "cellID": 56879116,
-      "ipAddress": "10.160.243.113"
-    }
-  }
-}
-```
-
-## Result Example
-
-```json
-[
-  {
-    "bn": "14203/0/",
-    "n": "0",
-    "vs": "LTE-M",
-    "bt": 1676369307222
-  },
-  {
-    "n": "1",
-    "v": 20
-  },
-  {
-    "n": "2",
-    "v": -79
-  },
-  {
-    "n": "3",
-    "v": 6
-  },
-  {
-    "n": "4",
-    "v": 56879116
-  },
-  {
-    "n": "5",
-    "v": 24001
-  },
-  {
-    "n": "6",
-    "vs": "10.160.243.113"
-  }
-]
-```

package/models/PCA20035+solar/transforms/pressure.md

@@ -1,43 +0,0 @@
----
-type: messages
----
-
-# Environment sensor: atmospheric pressure
-
-## Match Expression
-
-```jsonata
-appId = 'AIR_PRESS'
-```
-
-## Transform Expression
-
-```jsonata
-[
-    {"bn": "14205/0/", "n": "2", "v": $number(data)*10, "bt": ts }
-]
-```
-
-## Input Example
-
-```json
-{
-  "appId": "AIR_PRESS",
-  "messageType": "DATA",
-  "ts": 1681985384511,
-  "data": "102.31"
-}
-```
-
-## Result Example
-
-```json
-[
-  {
-    "bn": "14205/0/",
-    "n": "2",
-    "v": 1023.1,
-    "bt": 1681985384511
-  }
-]
-```

package/models/PCA20035+solar/transforms/temperature.md

@@ -1,43 +0,0 @@
----
-type: messages
----
-
-# Environment sensor: temperature
-
-## Match Expression
-
-```jsonata
-appId = 'TEMP'
-```
-
-## Transform Expression
-
-```jsonata
-[
-    {"bn": "14205/0/", "n": "0", "v": $number(data), "bt": ts }
-]
-```
-
-## Input Example
-
-```json
-{
-  "appId": "TEMP",
-  "messageType": "DATA",
-  "ts": 1676366336476,
-  "data": "25.73"
-}
-```
-
-## Result Example
-
-```json
-[
-  {
-    "bn": "14205/0/",
-    "n": "0",
-    "v": 25.73,
-    "bt": 1676366336476
-  }
-]
-```

package/models/asset_tracker_v2+AWS/README.md

@@ -1,6 +0,0 @@
-# `asset_tracker_v2` on AWS
-
-This implements the conversion for the
-[`asset_tracker_v2`](https://github.com/nrfconnect/sdk-nrf/tree/v2.5-branch/applications/asset_tracker_v2)
-[message protocol](https://nordicsemiconductor.github.io/asset-tracker-cloud-docs/v2.2.x/)
-when connected to AWS IoT.

package/models/asset_tracker_v2+AWS/examples/examples.spec.ts

@@ -1,229 +0,0 @@
-import { describe, it } from 'node:test'
-import {
-	senMLtoLwM2M,
-	type LwM2MObjectInstance,
-} from '../../../senml/senMLtoLwM2M.js'
-import { TransformType, type Transform } from '../../types.js'
-import jsonata from 'jsonata'
-import { arrayContaining, check } from 'tsmatchers'
-import { models } from '../../../models/models.js'
-
-void describe('asset_tracker_v2+AWS examples', () => {
-	for (const [input, expected] of [
-		[
-			'./shadow/example-1.json',
-			[
-				{
-					ObjectID: 14202,
-					Resources: {
-						1: 4.398,
-						99: new Date(1699050063028),
-					},
-				},
-				{
-					ObjectID: 14205,
-					Resources: {
-						0: 27.06,
-						1: 31.125,
-						2: 97.748,
-						99: new Date(1699050061608),
-					},
-				},
-				{
-					ObjectID: 14203,
-					Resources: {
-						11: 8,
-						99: new Date(1699050062990),
-					},
-				},
-			],
-		],
-		[
-			'./shadow/example-2.json',
-			[
-				{
-					ObjectID: 14201,
-					Resources: {
-						0: 33.98771459323253,
-						1: -84.50632147267358,
-						2: 241.9342498779297,
-						3: 11.317643165588379,
-						4: 0.03478508070111275,
-						5: 90.31222534179688,
-						6: 'GNSS',
-						99: new Date(1699049744000),
-					},
-				},
-				{
-					ObjectID: 14202,
-					Resources: {
-						1: 4.414,
-						99: new Date(1699049729959),
-					},
-				},
-
-				{
-					ObjectID: 14205,
-					Resources: {
-						0: 21.915307998657227,
-						1: 34.569278717041016,
-						2: 98.846,
-						10: 148,
-						99: new Date(1699049729518),
-					},
-				},
-			],
-		],
-		[
-			'./shadow/example-3.json',
-			[
-				{
-					ObjectID: 14203,
-					Resources: {
-						2: -95,
-						11: 7,
-						99: new Date(1699049610301),
-					},
-				},
-			],
-		],
-		[
-			'./shadow/example-4.json',
-			[
-				{
-					ObjectID: 14204,
-					Resources: {
-						0: '358299840016535',
-						1: '89450421180216254864',
-						2: 'mfw_nrf91x1_2.0.0-77.beta',
-						3: '0.0.0-development',
-						4: 'thingy91x_nrf9161',
-						99: new Date(1699284007851),
-					},
-				},
-				{
-					ObjectID: 14202,
-					Resources: {
-						0: 99,
-						1: 4.179,
-						2: 0,
-						3: 25.7,
-						99: new Date(1699049685992),
-					},
-				},
-			],
-		],
-		[
-			'./shadow/example-5.json',
-			[
-				{
-					ObjectID: 14202,
-					Resources: {
-						0: 89,
-						1: 4.161,
-						99: new Date(1701900277007),
-					},
-				},
-			],
-		],
-	] as [string, Array<LwM2MObjectInstance>][]) {
-		void it(input, async () => {
-			const result = await transformShadowUpdateToLwM2M(
-				(models['asset_tracker_v2+AWS']?.transforms ?? []).filter(
-					({ type }) => type === TransformType.Shadow,
-				),
-			)(
-				await import(input, {
-					assert: { type: 'json' },
-				}),
-			)
-
-			for (const expectedObject of expected) {
-				check(result).is(arrayContaining(expectedObject))
-			}
-		})
-	}
-})
-
-/**
- * Very simple implementation of a converter.
- */
-const transformShadowUpdateToLwM2M = (transforms: Transform[]) => {
-	// Turn the JSONata in the transforms into executable functions
-	const transformFns: Array<{
-		match: ReturnType<typeof jsonata>
-		matchExpression: string
-		transform: ReturnType<typeof jsonata>
-		transformExpression: string
-	}> = []
-
-	for (const {
-		match: matchExpression,
-		transform: transformExpression,
-	} of transforms) {
-		let match: ReturnType<typeof jsonata>
-		let transform: ReturnType<typeof jsonata>
-		try {
-			match = jsonata(matchExpression)
-		} catch {
-			throw new Error(`Failed to parse match expression '${matchExpression}'`)
-		}
-		try {
-			transform = jsonata(transformExpression)
-		} catch {
-			throw new Error(
-				`Failed to parse match expression '${transformExpression}'`,
-			)
-		}
-		transformFns.push({
-			match,
-			matchExpression,
-			transform,
-			transformExpression,
-		})
-	}
-
-	return async (input: {
-		state: {
-			reported?: Record<string, unknown>
-			desired?: Record<string, unknown>
-		}
-	}): Promise<Array<LwM2MObjectInstance>> =>
-		Promise.all(
-			transformFns.map(
-				async ({ match, matchExpression, transform, transformExpression }) => {
-					// Check if the `matched` JSONata returns `true`.
-					try {
-						const matched = await match.evaluate(input)
-						if (typeof matched !== 'boolean') return null
-						if (matched === false) return null
-					} catch (err) {
-						console.error(err)
-						console.error(
-							`Failed to match ${JSON.stringify(
-								input,
-							)} using expression '${matchExpression}'!`,
-						)
-						return false
-					}
-					// Transform
-					try {
-						return await transform.evaluate(input)
-					} catch (err) {
-						console.error(err)
-						console.error(
-							`Failed to transform ${JSON.stringify(
-								input,
-							)} using expression '${transformExpression}'!`,
-						)
-						return null
-					}
-				},
-			),
-		)
-			.then((result) => result.flat())
-			// Ignore unmatched transforms
-			.then((result) => result.filter((item) => item !== null))
-			// Convert it to LwM2M
-			.then(senMLtoLwM2M)
-}