@hello.nrfcloud.com/proto-map 4.0.0

package/models/check-model-rules.ts

@@ -0,0 +1,125 @@
+import chalk from 'chalk'
+import jsonata from 'jsonata'
+import assert from 'node:assert/strict'
+import { readFile, readdir, stat } from 'node:fs/promises'
+import path from 'node:path'
+import { FrontMatter, ModelIDRegExp } from './types.js'
+import { senMLtoLwM2M } from '../senml/senMLtoLwM2M.js'
+import { getCodeBlock } from '../markdown/getCodeBlock.js'
+import { getFrontMatter } from '../markdown/getFrontMatter.js'
+import { validateSenML } from '../senml/validateSenML.js'
+import { isRegisteredLwM2MObject } from '../lwm2m/isRegisteredLwM2MObject.js'
+import { hasValue } from '../senml/hasValue.js'
+import { parseREADME } from 'markdown/parseREADME.js'
+
+console.log(chalk.gray('Models rules check'))
+console.log('')
+const modelsDir = path.join(process.cwd(), 'models')
+for (const model of await readdir(modelsDir)) {
+	const modelDir = path.join(modelsDir, model)
+	if (!(await stat(modelDir)).isDirectory()) continue
+	console.log(chalk.white('·'), chalk.white.bold(model))
+	assert.match(
+		model,
+		ModelIDRegExp,
+		'Model identifiers must consist of numbers, letters, dash, plus, and underscore only',
+	)
+	console.log(chalk.green('✔'), chalk.gray('Model name is correct'))
+
+	// A README.md should exist
+	try {
+		await stat(path.join(modelDir, 'README.md'))
+	} catch {
+		throw new Error(`No README.md defined for model ${model}!`)
+	}
+	console.log(chalk.green('✔'), chalk.gray(`README.md exists`))
+	try {
+		parseREADME(await readFile(path.join(modelDir, 'README.md'), 'utf-8'))
+	} catch (err) {
+		console.error(err)
+		throw new Error(`README is not valid for ${model}!`)
+	}
+	console.log(chalk.green('✔'), chalk.gray(`README.md is valid`))
+
+	// Validate jsonata expressions
+	let hasTransforms = false
+	const transformsFolder = path.join(modelDir, 'transforms')
+	try {
+		await stat(transformsFolder)
+		hasTransforms = true
+		console.log(' ', chalk.gray('Transforms:'))
+	} catch {
+		console.log(' ', chalk.gray('No transforms found.'))
+	}
+	if (hasTransforms) {
+		for (const transform of (await readdir(transformsFolder)).filter((f) =>
+			f.endsWith('.md'),
+		)) {
+			console.log(' ', chalk.white('·'), chalk.white.bold(transform))
+			const markdown = await readFile(
+				path.join(modelDir, 'transforms', transform),
+				'utf-8',
+			)
+
+			// Validate front-matter
+			const type = getFrontMatter(markdown, FrontMatter).type
+			console.log(' ', chalk.green('✔'), chalk.gray(`Type ${type} is valid`))
+			const findBlock = getCodeBlock(markdown)
+			const matchExpression = findBlock('jsonata', 'Match Expression')
+			const transformExpression = findBlock('jsonata', 'Transform Expression')
+			const inputExample = JSON.parse(findBlock('json', 'Input Example'))
+			const resultExample = JSON.parse(findBlock('json', 'Result Example'))
+
+			const selectResult = await jsonata(matchExpression).evaluate(inputExample)
+			if (selectResult !== true) {
+				throw new Error(
+					`The select expression did not evaluate to true with the given example.`,
+				)
+			}
+			console.log(
+				' ',
+				chalk.green('✔'),
+				chalk.gray('Select expression evaluated to true for the example input'),
+			)
+
+			const transformResult = await jsonata(
+				// For testing purposes this function call result is hardcoded
+				transformExpression.replace('$millis()', '1699999999999'),
+			).evaluate(inputExample)
+
+			const maybeValidSenML = validateSenML(transformResult.filter(hasValue))
+			if ('errors' in maybeValidSenML) {
+				console.error(maybeValidSenML.errors)
+				throw new Error('The JSONata expression must produce valid SenML')
+			}
+
+			assert.deepEqual(maybeValidSenML.value, resultExample)
+			console.log(
+				' ',
+				chalk.green('✔'),
+				chalk.gray('Transformation result is valid SenML'),
+			)
+
+			assert.deepEqual(maybeValidSenML.value, resultExample)
+			console.log(
+				' ',
+				chalk.green('✔'),
+				chalk.gray('The transformation result matches the example'),
+			)
+
+			// Validate
+			for (const object of senMLtoLwM2M(maybeValidSenML.value)) {
+				if (!isRegisteredLwM2MObject(object, console.error)) {
+					throw new Error(
+						'The LwM2M object must follow LwM2M schema definition',
+					)
+				}
+				console.log(
+					' ',
+					chalk.green('✔'),
+					chalk.gray('SenML object is valid LwM2M'),
+				)
+			}
+		}
+	}
+}

package/models/kartverket-vasstandsdata/README.md

@@ -0,0 +1,13 @@
+# Kartverket Vasstandsdata
+
+A simulated device reporting the current sea level as provided by the
+[Kartverket](https://www.kartverket.no/)'s (Norwegian Mapping Authority)
+[API for vasstandsdata](https://api.sehavniva.no/tideapi_no.html) (API for water
+level data).
+
+Reports sea water level using the Object [`14230`](../../lwm2m/14230.xml).
+
+The data is licensed by the
+[Norwegian Mapping Authority](https://www.kartverket.no/)’s under the
+[Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/)
+license.

package/models/models.ts

@@ -0,0 +1,36 @@
+import { type Transform, TransformType } from "./types.js";
+/**
+ * The Model IDs defined in this repo.
+ */
+export enum ModelID {
+    PCA20035_solar = "PCA20035+solar",
+    Asset_tracker_v2_AWS = "asset_tracker_v2+AWS",
+    Kartverket_vasstandsdata = "kartverket-vasstandsdata"
+}
+export type Model = {
+    /**
+     * The Model ID
+     */
+    "id": ModelID;
+    /**
+     * The transforms defined for this model.
+     */
+    "transforms": Array<Transform>;
+    /**
+     * Description of the Model from the README.md
+     */
+    "about": {
+        /**
+         * The text of the H1 headline
+         */
+        "title": string;
+        /**
+         * The text of the paragraphs following the H1 headline
+         */
+        "description": string;
+    };
+};
+/**
+ * The models defined for hello.nrfcloud.com
+ */
+export const models: Readonly<Record<ModelID, Model>> = { [ModelID.PCA20035_solar]: { "id": ModelID.PCA20035_solar, "transforms": [{ "type": TransformType.Messages, "match": "appId = 'AIR_QUAL'", "transform": "[\n    {\"bn\": \"/14205/0/\", \"n\": \"10\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'BATTERY'", "transform": "[\n    {\"bn\": \"/14202/0/\", \"n\": \"0\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'BUTTON'", "transform": "[\n    {\"bn\": \"/14220/0/\", \"n\": \"0\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'DEVICE' and $exists(data.deviceInfo)", "transform": "[\n    {\"bn\": \"/14204/0/\", \"n\": \"0\", \"vs\": data.deviceInfo.imei, \"bt\": ts },\n    {\"n\": \"1\", \"vs\": data.deviceInfo.iccid },\n    {\"n\": \"2\", \"vs\": data.deviceInfo.modemFirmware },\n    {\"n\": \"3\", \"vs\": data.deviceInfo.appVersion },\n    {\"n\": \"4\", \"vs\": data.deviceInfo.board },\n    {\"n\": \"5\", \"vs\": data.deviceInfo.bat }\n]" }, { "type": TransformType.Messages, "match": "appId = 'SOLAR'", "transform": "[\n    {\"bn\": \"/14210/0/\", \"n\": \"0\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'GROUND_FIX' and $exists(data.lat) and $exists(data.lon) and $exists(data.uncertainty) and $exists(data.fulfilledWith)", "transform": "[\n    {\"bn\": \"/14201/1/\", \"n\": \"0\", \"v\": data.lat, \"bt\": $millis() },\n    {\"n\": \"1\", \"v\": data.lon },\n    {\"n\": \"3\", \"v\": data.uncertainty },\n    {\"n\": \"6\", \"vs\": data.fulfilledWith }\n]" }, { "type": TransformType.Messages, "match": "appId = 'GNSS'", "transform": "[\n    {\"bn\": \"/14201/0/\", \"n\": \"0\", \"v\": data.lat, \"bt\": ts },\n    {\"n\": \"1\", \"v\": data.lng },\n    {\"n\": \"2\", \"v\": data.alt },\n    {\"n\": \"3\", \"v\": data.acc },\n    {\"n\": \"4\", \"v\": data.spd },\n    {\"n\": \"5\", \"v\": data.hdg },\n    {\"n\": \"6\", \"vs\": \"GNSS\" }\n]" }, { "type": TransformType.Messages, "match": "appId = 'HUMID'", "transform": "[\n    {\"bn\": \"/14205/0/\", \"n\": \"1\", \"v\": $number(data), \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'DEVICE' and $exists(data.networkInfo)", "transform": "[\n    {\"bn\": \"/14203/0/\", \"n\": \"0\", \"vs\": data.networkInfo.networkMode, \"bt\": ts },\n    {\"n\": \"1\", \"v\": data.networkInfo.currentBand },\n    {\"n\": \"2\", \"v\": data.networkInfo.rsrp },\n    {\"n\": \"3\", \"v\": data.networkInfo.areaCode },\n    {\"n\": \"4\", \"v\": data.networkInfo.cellID },\n    {\"n\": \"5\", \"v\": data.networkInfo.mccmnc },\n    {\"n\": \"6\", \"vs\": data.networkInfo.ipAddress },\n    {\"n\": \"11\", \"v\": data.networkInfo.eest }\n]" }, { "type": TransformType.Messages, "match": "appId = 'AIR_PRESS'", "transform": "[\n    {\"bn\": \"/14205/0/\", \"n\": \"2\", \"v\": $number(data)*10, \"bt\": ts }\n]" }, { "type": TransformType.Messages, "match": "appId = 'TEMP'", "transform": "[\n    {\"bn\": \"/14205/0/\", \"n\": \"0\", \"v\": $number(data), \"bt\": ts }\n]" }], "about": { "title": "Thingy:91 with Solar Shield", "description": "The Nordic Thingy:91 Solar Shield is a plug-and-play prototyping platform. Powerfoyle solar cell is mounted onto the Thingy to quickly get started exploring the endless possibilities with solar powered IoT applications and to develop products with eternal life or even battery-free products.\u200B\nThe Thingy:91 runs the asset_tracker_v2 application and sends messages to nRF Cloud using MQTT." } }, [ModelID.Asset_tracker_v2_AWS]: { "id": ModelID.Asset_tracker_v2_AWS, "transforms": [{ "type": TransformType.Shadow, "match": "$exists(state.reported.gnss)", "transform": "[\n    {\"bn\": \"/14201/0/\", \"n\": \"0\", \"v\": state.reported.gnss.v.lat, \"bt\": state.reported.gnss.ts },\n    {\"n\": \"1\", \"v\": state.reported.gnss.v.lng },\n    {\"n\": \"2\", \"v\": state.reported.gnss.v.alt },\n    {\"n\": \"3\", \"v\": state.reported.gnss.v.acc },\n    {\"n\": \"4\", \"v\": state.reported.gnss.v.spd },\n    {\"n\": \"5\", \"v\": state.reported.gnss.v.hdg },\n    {\"n\": \"6\", \"vs\": \"GNSS\" }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.bat)", "transform": "[\n    {\"bn\": \"/14202/0/\", \"n\": \"1\", \"v\": state.reported.bat.v/1000, \"bt\": state.reported.bat.ts }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.dev)", "transform": "[\n    {\"bn\": \"/14204/0/\", \"n\": \"0\", \"vs\": state.reported.dev.v.imei, \"bt\": state.reported.dev.ts },\n    {\"n\": \"1\", \"vs\": state.reported.dev.v.iccid },\n    {\"n\": \"2\", \"vs\": state.reported.dev.v.modV },\n    {\"n\": \"3\", \"vs\": state.reported.dev.v.appV },\n    {\"n\": \"4\", \"vs\": state.reported.dev.v.brdV }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.env)", "transform": "[\n    {\"bn\": \"/14205/0/\", \"n\": \"0\", \"v\": state.reported.env.v.temp, \"bt\": state.reported.env.ts },\n    {\"n\": \"1\", \"v\": state.reported.env.v.hum },\n    {\"n\": \"2\", \"v\": state.reported.env.v.atmp },\n    {\"n\": \"10\", \"v\": state.reported.env.v.bsec_iaq }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.fg)", "transform": "[\n    {\"bn\": \"/14202/0/\", \"n\": \"0\", \"v\": state.reported.fg.v.SoC, \"bt\": state.reported.fg.ts },\n    {\"n\": \"1\", \"v\": state.reported.fg.v.V/1000 },\n    {\"n\": \"2\", \"v\": state.reported.fg.v.I },\n    {\"n\": \"3\", \"v\": state.reported.fg.v.T = null ? null : state.reported.fg.v.T/10 },\n    {\"n\": \"4\", \"v\": state.reported.fg.v.TTF },\n    {\"n\": \"5\", \"v\": state.reported.fg.v.TTE }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.roam)", "transform": "[\n    {\"bn\": \"/14203/0/\", \"n\": \"0\", \"vs\": state.reported.roam.v.nw, \"bt\": state.reported.roam.ts },\n    {\"n\": \"1\", \"v\": state.reported.roam.v.band },\n    {\"bn\": \"/14203/0/\", \"n\": \"2\", \"v\": state.reported.roam.v.rsrp, \"bt\": state.reported.roam.ts },\n    {\"n\": \"3\", \"v\": state.reported.roam.v.area },\n    {\"n\": \"4\", \"v\": state.reported.roam.v.cell },\n    {\"n\": \"5\", \"v\": state.reported.roam.v.mccmnc },\n    {\"n\": \"6\", \"vs\": state.reported.roam.v.ip },\n    {\"bn\": \"/14203/0/\", \"n\": \"11\", \"v\": state.reported.roam.v.eest, \"bt\": state.reported.roam.ts }\n]" }, { "type": TransformType.Shadow, "match": "$exists(state.reported.sol)", "transform": "[\n    {\"bn\": \"/14210/0/\", \"n\": \"0\", \"v\": state.reported.sol.v.gain, \"bt\": state.reported.sol.ts },\n    {\"n\": \"1\", \"v\": state.reported.sol.v.bat }\n]" }], "about": { "title": "asset_tracker_v2 on AWS", "description": "This implements the conversion for the asset_tracker_v2 message protocol when connected to AWS IoT." } }, [ModelID.Kartverket_vasstandsdata]: { "id": ModelID.Kartverket_vasstandsdata, "transforms": [], "about": { "title": "Kartverket Vasstandsdata", "description": "A simulated device reporting the current sea level as provided by the Kartverket's (Norwegian Mapping Authority) API for vasstandsdata (API for water level data).\nReports sea water level using the Object 14230.\nThe data is licensed by the Norwegian Mapping Authority\u2019s under the Creative Commons Attribution 4.0 International (CC BY 4.0) license." } } } as const;

package/models/types.ts

@@ -0,0 +1,17 @@
+import { Type } from '@sinclair/typebox'
+
+export const ModelIDRegExp = /^[A-Za-z0-9+_-]+$/
+
+export enum TransformType {
+	Shadow = 'shadow',
+	Messages = 'messages',
+}
+export type Transform = {
+	type: TransformType
+	match: string
+	transform: string
+}
+
+export const FrontMatter = Type.Object({
+	type: Type.Union([Type.Literal('shadow'), Type.Literal('messages')]),
+})

package/package.json

@@ -0,0 +1,111 @@
+{
+  "name": "@hello.nrfcloud.com/proto-map",
+  "version": "4.0.0",
+  "description": "Documents the communication protocol between devices, the hello.nrfcloud.com/map backend and web application",
+  "type": "module",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./export.js",
+      "node": "./export.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hello-nrfcloud/proto-map.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hello-nrfcloud/proto-map/issues"
+  },
+  "homepage": "https://hello.nrfcloud.com",
+  "keywords": [
+    "nordicsemiconductor",
+    "cellular-iot",
+    "hello-nrfcloud",
+    "hello-nrfcloud-map"
+  ],
+  "author": "Nordic Semiconductor ASA | nordicsemi.no",
+  "license": "BSD-3-Clause",
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=9.0.0"
+  },
+  "scripts": {
+    "prepare": "husky",
+    "test": "find ./ -type f -name \\*.spec.ts -not -path './node_modules/*' | xargs npx tsx --test --test-reporter spec",
+    "prepublishOnly": "./compile.sh"
+  },
+  "devDependencies": {
+    "@bifravst/eslint-config-typescript": "6.0.11",
+    "@bifravst/prettier-config": "1.0.0",
+    "@commitlint/config-conventional": "19.1.0",
+    "@swc/cli": "0.3.10",
+    "@swc/core": "1.4.8",
+    "@types/node": "20.11.27",
+    "@types/xml2js": "0.4.14",
+    "chalk": "5.3.0",
+    "husky": "9.0.11",
+    "lint-staged": "15.2.2",
+    "prettier-plugin-organize-imports": "3.2.4",
+    "remark": "15.0.1",
+    "remark-frontmatter": "5.0.0",
+    "tsmatchers": "5.0.2",
+    "tsx": "4.7.1",
+    "xml2js": "0.6.2",
+    "yaml": "2.4.1"
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "prettier --write",
+      "eslint"
+    ],
+    "*.{md,json,yaml,yml,html}": [
+      "prettier --write"
+    ],
+    "*.xml": [
+      "./lwm2m/format.sh"
+    ]
+  },
+  "prettier": "@bifravst/prettier-config",
+  "release": {
+    "branches": [
+      "saga",
+      {
+        "name": "!(saga|v[0-9].[0-9].x|*_*|*/*)",
+        "prerelease": true
+      }
+    ],
+    "remoteTags": true,
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      [
+        "@semantic-release/github",
+        {
+          "successComment": false,
+          "failTitle": false
+        }
+      ]
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "package-lock.json",
+    "LICENSE",
+    "README.md",
+    "dist",
+    "export.js",
+    "index.d.ts",
+    "senml",
+    "models",
+    "lwm2m"
+  ],
+  "dependencies": {
+    "@sinclair/typebox": "0.32.15",
+    "ajv": "8.12.0",
+    "jsonata": "2.0.4"
+  }
+}

package/senml/SenMLSchema.spec.ts

@@ -0,0 +1,21 @@
+import { describe, it } from 'node:test'
+import { SenML, type SenMLType } from './SenMLSchema.js'
+import assert from 'node:assert/strict'
+import { validate } from '../validate.js'
+
+void describe('SenMLType', () => {
+	void it('it should validate a SenML payload', () => {
+		const example: SenMLType = [
+			{
+				bn: '/14201/0/',
+				n: '0',
+				v: 33.98755678796222,
+				bt: 1698155694999,
+			},
+			{ n: '1', v: -84.506132079174634 },
+		]
+		const res = validate(SenML)(example)
+		assert.equal('errors' in res, false)
+		assert.deepEqual('value' in res && res.value, example)
+	})
+})

package/senml/SenMLSchema.ts

@@ -0,0 +1,74 @@
+import { Type, type Static } from '@sinclair/typebox'
+
+const ResourceIDPart = Type.RegExp(/^[0-9/]+$/, {
+	title: 'ResourceIDPart',
+	description:
+		'Combines `bn` and `n` to a fully qualified resource identifier in the form of `/<object ID>/<object instance ID>/<resource ID>/0`. (Multiple resource instances are not supported right now.).',
+	examples: ['/', '/14201/0/', '5'],
+})
+const BaseValue = Type.Number({ title: 'Base Value' })
+const Value = Type.Number({ title: 'Value' })
+const Time = Type.Integer({ minimum: 0, title: 'Time' })
+
+/**
+ * Defines a SenML type with some unsupported elements removed: Sum, Base Sum, Update Time
+ *
+ * @see https://datatracker.ietf.org/doc/html/rfc8428
+ */
+export const Measurement = Type.Intersect(
+	[
+		Type.Union([
+			Type.Object({
+				n: ResourceIDPart,
+			}),
+			Type.Object({
+				bn: ResourceIDPart,
+				n: ResourceIDPart,
+				blv: Type.String({
+					minLength: 1,
+					description: 'The LwM2M object version used',
+					default: '1.0',
+				}),
+				bt: Type.Optional(Time),
+			}),
+		]),
+		// Value combinations
+		Type.Union([
+			Type.Union([
+				Type.Object({
+					bv: BaseValue,
+				}),
+				Type.Object({
+					bv: BaseValue,
+					v: Value,
+				}),
+				Type.Object({
+					// Value can be undefined, if it is not mandatory
+					v: Type.Optional(Value),
+				}),
+			]),
+			Type.Object({
+				vs: Type.String({ minLength: 1, title: 'String Value' }),
+			}),
+			Type.Object({
+				vb: Type.Boolean({ title: 'Boolean Value' }),
+			}),
+			Type.Object({
+				vd: Type.String({
+					title: 'Data Value.',
+					description:
+						'Octets in the Data Value are base64 encoded with the URL-safe alphabet as defined in Section 5 of [RFC4648], with padding omitted.',
+				}),
+			}),
+		]),
+	],
+	{
+		description:
+			'SenML schema for conversion results. This is limited to properties useful for the hello.nrfcloud.com/map application.',
+	},
+)
+
+export const SenML = Type.Array(Measurement, { minItems: 1 })
+
+export type SenMLType = Static<typeof SenML>
+export type MeasurementType = Static<typeof Measurement>

package/senml/hasValue.spec.ts

@@ -0,0 +1,19 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { hasValue } from './hasValue.js'
+
+void describe('hasValue() should determine whether an object has a value', () => {
+	for (const [record, expected] of [
+		[{ bn: 14202, n: 0, v: 99, bt: 1699049685992 }, true],
+		[{ n: 1, v: 4.179 }, true],
+		[{ n: 2, v: 0 }, true],
+		[{ n: 3, v: 25.7 }, true],
+		[{ n: 4, v: null }, false],
+		[{ n: 5, v: null }, false],
+	]) {
+		void it(`should determine that ${JSON.stringify(
+			record,
+		)} has a value: ${JSON.stringify(expected)}`, () =>
+			assert.equal(hasValue(record), expected))
+	}
+})

package/senml/hasValue.ts

@@ -0,0 +1,12 @@
+export const hasValue = (m: unknown): boolean => {
+	if (m === null) return false
+	if (typeof m !== 'object') return false
+	const v =
+		('bv' in m ? m.bv : undefined) ??
+		('v' in m ? m.v : undefined) ??
+		('vs' in m ? m.vs : undefined) ??
+		('vb' in m ? m.vb : undefined) ??
+		('vd' in m ? m.vd : undefined)
+	if (v === null || v === undefined) return false
+	return true
+}

package/senml/lwm2mToSenML.spec.ts

@@ -0,0 +1,74 @@
+import { it, describe } from 'node:test'
+import type { SenMLType } from './SenMLSchema.js'
+import type {
+	Geolocation_14201,
+	SeaWaterLevel_14230,
+} from '../lwm2m/objects.js'
+import { LwM2MObjectID } from '../lwm2m/LwM2MObjectID.js'
+import assert from 'node:assert/strict'
+import type { LwM2MObjectInstance } from './senMLtoLwM2M.js'
+import { lwm2mToSenML } from './lwm2mToSenML.js'
+
+void describe('lwm2mToSenML()', () => {
+	void it('should convert LwM2M to SenML', () => {
+		const location: LwM2MObjectInstance<Geolocation_14201> = {
+			ObjectID: LwM2MObjectID.Geolocation_14201,
+			ObjectVersion: '1.0',
+			Resources: {
+				'0': 62.469414,
+				'1': 6.151946,
+				'6': 'Fixed',
+				'3': 1,
+				'99': new Date(1710147413003),
+			},
+		}
+		const level1: LwM2MObjectInstance<SeaWaterLevel_14230> = {
+			ObjectID: LwM2MObjectID.SeaWaterLevel_14230,
+			ObjectVersion: '1.0',
+			Resources: {
+				'0': 84.3,
+				'1': 'AES',
+				'99': new Date(1710140400000),
+			},
+		}
+		const level2: LwM2MObjectInstance<SeaWaterLevel_14230> = {
+			ObjectID: LwM2MObjectID.SeaWaterLevel_14230,
+			ObjectVersion: '1.0',
+			Resources: {
+				'0': 140.4,
+				'1': 'AES',
+				'99': new Date(1710144000000),
+			},
+		}
+		const level3: LwM2MObjectInstance<SeaWaterLevel_14230> = {
+			ObjectID: LwM2MObjectID.SeaWaterLevel_14230,
+			ObjectVersion: '1.0',
+			ObjectInstanceID: 1,
+			Resources: {
+				'0': 140.7,
+				'1': 'AES',
+				'99': new Date(1710144001000),
+			},
+		}
+		const lwm2m: Array<LwM2MObjectInstance<any>> = [
+			location,
+			level1,
+			level2,
+			level3,
+		]
+		const expected: SenMLType = [
+			{ bn: '/14201/0/', n: '0', v: 62.469414, bt: 1710147413003 },
+			{ n: '1', v: 6.151946 },
+			{ n: '3', v: 1 },
+			{ n: '6', vs: 'Fixed' },
+			{ bn: '/14230/0/', n: '0', v: 84.3, bt: 1710140400000 },
+			{ n: '1', vs: 'AES' },
+			{ bn: '/14230/0/', n: '0', v: 140.4, bt: 1710144000000 },
+			{ n: '1', vs: 'AES' },
+			{ bn: '/14230/1/', n: '0', v: 140.7, bt: 1710144001000 },
+			{ n: '1', vs: 'AES' },
+		]
+
+		assert.deepEqual(lwm2mToSenML(lwm2m), expected)
+	})
+})

package/senml/lwm2mToSenML.ts

@@ -0,0 +1,62 @@
+import type { SenMLType } from './SenMLSchema'
+import { instanceTs } from '../lwm2m/instanceTs.js'
+import type { LwM2MObjectInstance, LwM2MResourceValue } from './senMLtoLwM2M'
+import { timestampResources } from '../lwm2m/timestampResources.js'
+import { definitions } from '../lwm2m/definitions.js'
+import { ResourceType, type LWM2MObjectInfo } from '../lwm2m/LWM2MObjectInfo.js'
+
+/**
+ * Convert LwM2M Object Instances to senML
+ */
+export const lwm2mToSenML = (
+	lwm2m: Array<LwM2MObjectInstance<any>>,
+): SenMLType =>
+	lwm2m
+		.map(asSenML)
+		.flat()
+		.filter((v) => v !== null) as SenMLType
+
+const asSenML = (lwm2m: LwM2MObjectInstance<any>): SenMLType | null => {
+	const def = definitions[lwm2m.ObjectID]
+	const i = instanceTs(lwm2m)
+	const tsResourceId = timestampResources[lwm2m.ObjectID] as number // All registered objects must have a timestamp resource
+	const [first, ...rest] = Object.entries({
+		...lwm2m.Resources,
+		[tsResourceId]: undefined,
+	})
+		// Filter out undefined values (and timestamp resource)
+		.filter((r): r is [string, LwM2MResourceValue] => r[1] !== undefined)
+
+	if (first === undefined) return null
+	return [
+		{
+			bn: `/${lwm2m.ObjectID}/${lwm2m.ObjectInstanceID ?? 0}/`,
+			n: first[0],
+			[toKey(def, parseInt(first[0], 10))]: first[1],
+			bt: i.getTime(),
+		},
+		...rest.map((r) => ({
+			n: r[0],
+			[toKey(def, parseInt(r[0], 10))]: r[1],
+		})),
+	]
+}
+
+const toKey = (def: LWM2MObjectInfo, resourceId: number) => {
+	switch (def.Resources[resourceId]?.Type) {
+		case ResourceType.String:
+			return 'vs'
+		case ResourceType.Boolean:
+			return 'vb'
+		case ResourceType.Float:
+		case ResourceType.Integer:
+		case ResourceType.Time:
+			return 'v'
+		case ResourceType.Opaque:
+			return 'vd'
+		default:
+			throw new Error(
+				`Unknown ResourceID ${resourceId} for LwM2M Object ${def.ObjectID}!`,
+			)
+	}
+}

package/senml/parseResourceId.spec.ts

@@ -0,0 +1,13 @@
+import assert from 'node:assert'
+import { describe, it } from 'node:test'
+import { parseResourceId } from './parseResourceId.js'
+
+void describe('parseResourceId()', () => {
+	void it('should parse an LwM2M resource ID', () =>
+		assert.deepEqual(parseResourceId('/14201/1/2/0'), {
+			ObjectID: 14201,
+			ObjectInstanceID: 1,
+			ResourceID: 2,
+			ResourceInstanceId: 0,
+		}))
+})

package/senml/parseResourceId.ts

@@ -0,0 +1,23 @@
+export type ResourceID = {
+	ObjectID: number
+	ObjectInstanceID: number
+	ResourceID: number
+	ResourceInstanceId: number
+}
+
+export const parseResourceId = (resourceId: string): ResourceID | null => {
+	if (!/^\/\d+\/\d+\/\d+\/\d+$/.test(resourceId)) return null
+
+	const [ObjectID, ObjectInstanceID, ResourceID, ResourceInstanceId] =
+		resourceId
+			.slice(1)
+			.split('/')
+			.map((s) => parseInt(s, 10)) as [number, number, number, number]
+
+	return {
+		ObjectID,
+		ObjectInstanceID,
+		ResourceID,
+		ResourceInstanceId,
+	}
+}