@hello.nrfcloud.com/proto-map 4.0.0

package/senml/senMLtoLwM2M.spec.ts

@@ -0,0 +1,181 @@
+import assert from 'node:assert/strict'
+import { describe, it } from 'node:test'
+import { senMLtoLwM2M, type LwM2MObjectInstance } from './senMLtoLwM2M.js'
+import type { SenMLType } from './SenMLSchema.js'
+
+void describe('senMLtoLwM2M()', () => {
+	void it('should resolve a senML message into objects', () => {
+		const input: SenMLType = [
+			{
+				bn: '/14201/1/',
+				blv: '1.1',
+				bt: 1698155694999,
+				n: '0',
+				v: 33.98755678796222,
+			},
+			{
+				n: '1',
+				v: -84.506132079174634,
+			},
+			{
+				n: '2',
+				v: 295.468994140625,
+			},
+			{
+				n: '3',
+				v: 17.74077033996582,
+			},
+			{
+				n: '4',
+				v: 26.376304626464844,
+			},
+			{
+				n: '5',
+				v: 359.1545715332,
+			},
+		]
+		const expected: LwM2MObjectInstance[] = [
+			{
+				ObjectID: 14201,
+				ObjectInstanceID: 1,
+				ObjectVersion: '1.1',
+				Resources: {
+					0: 33.98755678796222,
+					1: -84.506132079174634,
+					2: 295.468994140625,
+					3: 17.74077033996582,
+					4: 26.376304626464844,
+					5: 359.1545715332,
+					99: new Date(1698155694999),
+				},
+			},
+		]
+		assert.deepEqual(senMLtoLwM2M(input), expected)
+	})
+
+	void it('should drop empty resources', () => {
+		const input: SenMLType = [
+			{
+				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',
+			},
+			{
+				n: '11',
+			},
+		]
+		const expected: LwM2MObjectInstance[] = [
+			{
+				ObjectID: 14203,
+				Resources: {
+					0: 'LTE-M',
+					1: 20,
+					2: -79,
+					3: 6,
+					4: 56879116,
+					5: 24001,
+					6: '10.160.243.113',
+					99: new Date(1676369307222),
+				},
+			},
+		]
+		assert.deepEqual(senMLtoLwM2M(input), expected)
+	})
+
+	void it('should ignore repeated base properties', () => {
+		const input: SenMLType = [
+			{ bn: '/14203/0/', n: '0', vs: 'LTE-M', bt: 1699049665511 },
+			{ n: '1', v: 20 },
+			{ bn: '/14203/0/', n: '2', v: -89, bt: 1699049665511 },
+			{ n: '3', v: 2305 },
+			{ n: '4', v: 34784790 },
+			{ n: '5', v: 24202 },
+			{ n: '6', vs: '100.81.95.75' },
+			{ bn: '/14203/0/', n: '11', v: 7, bt: 1699049665511 },
+		]
+		const expected: LwM2MObjectInstance[] = [
+			{
+				ObjectID: 14203,
+				Resources: {
+					0: 'LTE-M',
+					1: 20,
+					2: -89,
+					3: 2305,
+					4: 34784790,
+					5: 24202,
+					6: '100.81.95.75',
+					11: 7,
+					99: new Date(1699049665511),
+				},
+			},
+		]
+		assert.deepEqual(senMLtoLwM2M(input), expected)
+	})
+
+	void it('should handle multiple measurements for the same resource', () => {
+		const input: SenMLType = [
+			{ bn: '/14205/0/', n: '0', v: 21, bt: 1699049600000 },
+			{ bn: '/14205/1/', n: '0', v: 31, bt: 1699049600000 },
+			{ bn: '/14205/0/', n: '0', v: 22, bt: 1699049700000 },
+			{ bn: '/14205/1/', n: '0', v: 32, bt: 1699049700000 },
+		]
+		const expected: LwM2MObjectInstance[] = [
+			{
+				ObjectID: 14205,
+				Resources: {
+					0: 21,
+					99: new Date(1699049600000),
+				},
+			},
+			{
+				ObjectID: 14205,
+				ObjectInstanceID: 1,
+				Resources: {
+					0: 31,
+					99: new Date(1699049600000),
+				},
+			},
+			{
+				ObjectID: 14205,
+				Resources: {
+					0: 22,
+					99: new Date(1699049700000),
+				},
+			},
+			{
+				ObjectID: 14205,
+				ObjectInstanceID: 1,
+				Resources: {
+					0: 32,
+					99: new Date(1699049700000),
+				},
+			},
+		]
+		assert.deepEqual(senMLtoLwM2M(input), expected)
+	})
+})

package/senml/senMLtoLwM2M.ts

@@ -0,0 +1,121 @@
+import type { MeasurementType, SenMLType } from './SenMLSchema'
+import { timestampResources } from '../lwm2m/timestampResources.js'
+import { parseResourceId, type ResourceID } from './parseResourceId.js'
+import { hasValue } from './hasValue.js'
+import type { LwM2MObjectID } from '../lwm2m/LwM2MObjectID.js'
+
+export type LwM2MResourceValue = string | number | boolean | Date
+type GenericLwM2MObjectInstance = {
+	ObjectID: LwM2MObjectID
+	/**
+	 * @default 0
+	 */
+	ObjectInstanceID?: number
+	/**
+	 * @default '1.0'
+	 */
+	ObjectVersion?: string
+	/**
+	 * Key range: 0..65534
+	 */
+	Resources: Partial<Record<number, LwM2MResourceValue>>
+}
+export type LwM2MObjectInstance<
+	Instance extends GenericLwM2MObjectInstance = GenericLwM2MObjectInstance,
+> = {
+	ObjectID: LwM2MObjectID
+	/**
+	 * @default 0
+	 */
+	ObjectInstanceID?: number
+	/**
+	 * @default '1.0'
+	 */
+	ObjectVersion?: Instance['ObjectVersion']
+	/**
+	 * Key range: 0..65534
+	 */
+	Resources: Instance['Resources']
+}
+
+const isInfoForDifferentInstance = (
+	currentObject: LwM2MObjectInstance,
+	resourceID: ResourceID,
+	currentBaseTime: number,
+): boolean => {
+	if (currentObject === undefined) return true
+	if (currentObject.ObjectID !== resourceID.ObjectID) return true
+	if ((currentObject.ObjectInstanceID ?? 0) !== resourceID.ObjectInstanceID)
+		return true
+	const tsRes = timestampResources[resourceID.ObjectID]
+	if (tsRes === undefined)
+		throw new Error(`Unknown LwM2M Object ID: ${resourceID.ObjectID}!`)
+	if (
+		currentBaseTime !==
+		(currentObject.Resources?.[tsRes] as Date | undefined)?.getTime()
+	)
+		return true
+	return false
+}
+
+const getValue = (
+	measurement: MeasurementType,
+): string | number | boolean | undefined => {
+	if ('bv' in measurement && !('v' in measurement)) return measurement.bv
+	if ('bv' in measurement && 'v' in measurement)
+		return measurement.bv + measurement.v
+	if ('v' in measurement) return measurement.v
+	if ('vs' in measurement) return measurement.vs
+	if ('vb' in measurement) return measurement.vb
+	if ('vd' in measurement) return measurement.vd
+	return undefined
+}
+export const senMLtoLwM2M = (senML: SenMLType): Array<LwM2MObjectInstance> => {
+	let currentBaseName: string = ''
+	let currentBaseTime: number | undefined = undefined
+	let currentObject: LwM2MObjectInstance | undefined = undefined
+	const items: LwM2MObjectInstance[] = []
+
+	for (const item of senML) {
+		if ('bn' in item && item.bn !== undefined) currentBaseName = item.bn
+		if ('bt' in item && item.bt !== undefined) currentBaseTime = item.bt
+		if (!hasValue(item)) continue
+		const itemResourceId = `${currentBaseName}${item.n ?? ''}/0`
+		const resourceId = parseResourceId(itemResourceId)
+		if (resourceId === null)
+			throw new Error(`Invalid resource ID: ${itemResourceId}`)
+
+		if (
+			currentObject === undefined ||
+			(currentBaseTime !== undefined &&
+				isInfoForDifferentInstance(currentObject, resourceId, currentBaseTime))
+		) {
+			if (currentObject !== undefined) items.push(currentObject)
+			const tsRes = timestampResources[resourceId.ObjectID]
+			if (tsRes === undefined)
+				throw new Error(`Unknown LwM2M Object ID: ${resourceId.ObjectID}!`)
+			if (currentBaseTime === undefined)
+				throw new Error(`No base time defined for object!`)
+			currentObject = {
+				ObjectID: resourceId.ObjectID,
+				Resources: {
+					[tsRes]: new Date(currentBaseTime),
+				},
+			}
+			if (resourceId.ObjectInstanceID !== 0)
+				currentObject.ObjectInstanceID = resourceId.ObjectInstanceID
+			if ('blv' in item) currentObject.ObjectVersion = item.blv
+		}
+		if (currentObject?.Resources === undefined) continue
+		const value = getValue(item)
+		if (value !== undefined) {
+			currentObject.Resources = {
+				...currentObject.Resources,
+				[item.n]: value,
+			}
+		}
+	}
+	if (currentObject !== undefined) items.push(currentObject)
+
+	return items
+}

package/senml/validateSenML.spec.ts

@@ -0,0 +1,16 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { validateSenML } from './validateSenML.js'
+import type { SenMLType } from './SenMLSchema.js'
+
+void describe('validateSenML()', () => {
+	void it('should validate', () => {
+		const senMl: SenMLType = [
+			{ bn: '/14202/1/', blv: '1.1', n: '0', v: 99, bt: 1699049685992 },
+			{ n: '1', v: 4.179 },
+			{ n: '2', v: 0 },
+			{ n: '3', v: 25.7 },
+		]
+		assert.deepEqual(validateSenML(senMl), { value: senMl })
+	})
+})

package/senml/validateSenML.ts

@@ -0,0 +1,8 @@
+import { SenML } from '../senml/SenMLSchema.js'
+import { validate } from '../validate.js'
+
+const validator = validate(SenML)
+
+export const validateSenML = (
+	maybeSenML: unknown,
+): ReturnType<typeof validator> => validator(maybeSenML)