@hello.nrfcloud.com/proto-map 4.0.0

package/lwm2m/LWM2MObjectInfo.ts

@@ -0,0 +1,42 @@
+import type { LwM2MObjectID } from './LwM2MObjectID.js'
+
+/**
+ * Provides information about the the LwM2M objects defined in this project.
+ */
+export type LWM2MObjectInfo = {
+	ObjectID: LwM2MObjectID
+	ObjectVersion: string
+	Name: string
+	Description: string
+	Resources: Record<number, LwM2MResourceInfo>
+}
+
+export type LwM2MResourceInfo = {
+	ResourceID: number
+	Name: string
+	Mandatory: boolean
+	Type: ResourceType
+	Description: string // e.g. 'The decimal notation of latitude, e.g. -43.5723 [World Geodetic System 1984].'
+	RangeEnumeration?: Range
+	Units?: string // e.g. 'lat'
+}
+
+export type Range = {
+	/**
+	 * The minimum inclusive value of the range. Always smaller than max.
+	 */
+	min: number
+	/**
+	 * The maximum inclusive value of the range. Always larger than min.
+	 */
+	max: number
+}
+
+export enum ResourceType {
+	String = 'String',
+	Integer = 'Integer',
+	Float = 'Float',
+	Boolean = 'Boolean',
+	Opaque = 'Opaque',
+	Time = 'Time',
+}

package/lwm2m/LwM2MObject.d.ts

@@ -0,0 +1,19 @@
+import type { LwM2MResourceValue } from '../senml/senMLtoLwM2M.js'
+import type { LwM2MObjectID } from './LwM2MObjectID.js'
+
+export type LwM2MObject<
+	ObjectDef extends {
+		ObjectID: LwM2MObjectID
+		/**
+		 * The Object Version of an Object is composed of 2 digits separated by a dot '.'
+		 *
+		 * @see https://www.openmobilealliance.org/release/LightweightM2M/V1_1_1-20190617-A/OMA-TS-LightweightM2M_Core-V1_1_1-20190617-A.pdf Section 7.2.2
+		 */
+		ObjectVersion: string
+		Resources: Record<number, LwM2MResourceValue | undefined>
+	},
+> = {
+	ObjectID: ObjectDef['ObjectID']
+	ObjectVersion: ObjectDef['ObjectVersion']
+	Resources: ObjectDef['Resources']
+}

package/lwm2m/LwM2MObjectID.ts

@@ -0,0 +1,73 @@
+/**
+ * The LwM2M Object IDs defined in this repo.
+ */
+export enum LwM2MObjectID {
+    /**
+     * Geolocation (14201)
+     *
+     * Describes the geo location of a device
+     */
+    Geolocation_14201 = 14201,
+    /**
+     * Battery and Power (14202)
+     *
+     * Information about the battery and power status of the device.
+     */
+    BatteryAndPower_14202 = 14202,
+    /**
+     * Connection information (14203)
+     *
+     * Details about the device's connection.
+     */
+    ConnectionInformation_14203 = 14203,
+    /**
+     * Device information (14204)
+     *
+     * Details about the device's connection.
+     */
+    DeviceInformation_14204 = 14204,
+    /**
+     * Environment (14205)
+     *
+     * Environment information.
+     */
+    Environment_14205 = 14205,
+    /**
+     * Solar charge (14210)
+     *
+     * Measurements from the solar shield.
+     */
+    SolarCharge_14210 = 14210,
+    /**
+     * Button press (14220)
+     *
+     * Describes a button press event.
+     */
+    ButtonPress_14220 = 14220,
+    /**
+     * Sea Water Level (14230)
+     *
+     * Describes observed sea water level.
+     */
+    SeaWaterLevel_14230 = 14230
+}
+/**
+ * The LwM2M Object IDs defined in this repo.
+ */
+export const LwM2MObjectIDs = [
+    // Geolocation (14201)
+    LwM2MObjectID.Geolocation_14201, 
+    // Battery and Power (14202)
+    LwM2MObjectID.BatteryAndPower_14202, 
+    // Connection information (14203)
+    LwM2MObjectID.ConnectionInformation_14203, 
+    // Device information (14204)
+    LwM2MObjectID.DeviceInformation_14204, 
+    // Environment (14205)
+    LwM2MObjectID.Environment_14205, 
+    // Solar charge (14210)
+    LwM2MObjectID.SolarCharge_14210, 
+    // Button press (14220)
+    LwM2MObjectID.ButtonPress_14220, 
+    // Sea Water Level (14230)
+    LwM2MObjectID.SeaWaterLevel_14230];

package/lwm2m/ParsedLwM2MObjectDefinition.ts

@@ -0,0 +1,28 @@
+export type Resource = {
+	$: {
+		ID: string // e.g. '0'
+	}
+	Name: string // e.g. 'Latitude'
+	Operations: 'R'
+	MultipleInstances: 'Single'
+	Mandatory: 'Optional' | 'Mandatory'
+	Type: 'String' | 'Integer' | 'Float' | 'Boolean' | 'Opaque' | 'Time'
+	RangeEnumeration: string // e.g. -10..10
+	Units: string // e.g. 'lat'
+	Description: string // e.g. 'The decimal notation of latitude, e.g. -43.5723 [World Geodetic System 1984].'
+}
+
+export type ParsedLwM2MObjectDefinition = {
+	$: { ObjectType: 'MODefinition' }
+	Name: string // e.g. 'Location'
+	Description1: string // e.g. 'This LwM2M Object provides a range of location telemetry related information which can be queried by the LwM2M Server.'
+	ObjectID: string // e.g. '14201'
+	ObjectURN: string // e.g. 'urn:oma:lwm2m:x:14201'
+	ObjectVersion?: string // e.g. '1.0'
+	MultipleInstances: 'Multiple'
+	Mandatory: 'Optional'
+	Resources: {
+		Item: Resource[]
+	}
+	Description2: string // e.g. ''
+}

package/lwm2m/check-lwm2m-rules.ts

@@ -0,0 +1,160 @@
+import chalk from 'chalk'
+import { readFile, readdir, stat } from 'node:fs/promises'
+import path, { parse } from 'node:path'
+import assert from 'node:assert/strict'
+import xml2js from 'xml2js'
+import { exec } from 'node:child_process'
+import { unwrapNestedArray } from './unwrapNestedArray.js'
+import {
+	LWM2MObjectDefinition,
+	type LWM2MObjectDefinitionType,
+} from './LWM2MObjectDefinition.js'
+import type { ParsedLwM2MObjectDefinition } from './ParsedLwM2MObjectDefinition.js'
+import { validate } from '../validate.js'
+import { parseRangeEnumeration } from './parseRangeEnumeration.js'
+
+const v = validate(LWM2MObjectDefinition)
+
+const listLwm2mDefinitions = async (
+	modelDir: string,
+): Promise<LWM2MObjectDefinitionType[]> => {
+	const defs: LWM2MObjectDefinitionType[] = []
+	const files = await readdir(modelDir)
+	for (const file of files) {
+		if (!file.endsWith('.xml')) continue
+		console.log(chalk.white('·'), chalk.white.bold(file))
+		assert.match(
+			file,
+			/^[0-9]+\.xml$/,
+			'LwM2M object definition files must only have numbers in their file names',
+		)
+		console.log(chalk.green('✔'), chalk.gray('File name is correct'))
+		const objectDefinitionFile = path.join(modelDir, file)
+		if ((await stat(objectDefinitionFile)).isDirectory()) continue
+
+		// validate
+		const schemaValidated = await new Promise<boolean>((resolve) =>
+			exec(
+				`xmllint --noout --schema ${path.join(
+					process.cwd(),
+					'lwm2m',
+					'LWM2M-v1_1.xsd',
+				)} ${objectDefinitionFile}`,
+				(error, _, stderr) => {
+					if (error) {
+						console.error(stderr)
+						return resolve(false)
+					}
+					resolve(true)
+				},
+			),
+		)
+		assert.equal(schemaValidated, true, '')
+		console.log(
+			chalk.green('✔'),
+			chalk.gray('Is a valid LwM2M object definition'),
+		)
+		const ObjectID = parseInt(parse(objectDefinitionFile).name, 10)
+		assert.equal(ObjectID > 14200, true, 'ObjectID must be greater than 14200')
+		assert.equal(ObjectID < 15000, true, 'ObjectID must be smaller than 15000')
+		const ObjectURN = `urn:oma:lwm2m:x:${ObjectID}`
+
+		const definition = (
+			unwrapNestedArray(
+				await xml2js.parseStringPromise(
+					await readFile(objectDefinitionFile, 'utf-8'),
+				),
+			) as any
+		).LWM2M.Object as ParsedLwM2MObjectDefinition
+
+		assert.equal(
+			ObjectID.toString(),
+			definition.ObjectID,
+			`ObjectID must match filename`,
+		)
+		assert.equal(
+			ObjectURN,
+			definition.ObjectURN,
+			`ObjectURN must follow schema`,
+		)
+
+		console.log(
+			chalk.green('✔'),
+			chalk.blue(ObjectURN),
+			chalk.gray('ObjectID and URN match filename and schema'),
+		)
+
+		const objectDef: LWM2MObjectDefinitionType = {
+			...definition,
+			LWM2MVersion: '1.1',
+			Resources: definition.Resources.Item.reduce<Record<string, any>>(
+				(resources, { $, ...item }) => {
+					if (resources[$.ID] !== undefined)
+						throw new Error(`Duplicate resource ID: ${$.ID}`)
+					if (item.RangeEnumeration.length > 0) {
+						const maybeRange = parseRangeEnumeration(item.RangeEnumeration)
+						if ('error' in maybeRange) throw maybeRange.error
+					}
+					return {
+						...resources,
+						[$.ID]: item,
+					}
+				},
+				{},
+			),
+		}
+
+		const maybeValid = v(objectDef)
+		if ('errors' in maybeValid) {
+			console.error(maybeValid.errors)
+			throw new Error(`The definition should be valid!`)
+		}
+
+		console.log(chalk.green('✔'), chalk.gray('LwM2M limitations are honored'))
+
+		defs.push(maybeValid.value)
+
+		const { Name, Resources } = maybeValid.value
+
+		const TimeResources = Object.values(Resources).filter(
+			({ Type }) => Type === 'Time',
+		)
+		assert.equal(
+			TimeResources.length,
+			1,
+			'Objects must define one Time resource',
+		)
+		assert.equal(
+			TimeResources[0]?.Mandatory,
+			'Mandatory',
+			'The Time resources must be mandatory.',
+		)
+		console.log(
+			chalk.green('✔'),
+			chalk.gray(`Object has one time resource (${TimeResources[0]?.Name})`),
+		)
+
+		console.log(`${chalk.yellow(ObjectID)}:`, chalk.white(Name))
+		for (const [id, resource] of Object.entries(Resources)) {
+			console.log(
+				`${chalk.gray(ObjectID)}.${chalk.yellow(id)}:`,
+				chalk.white(resource.Name),
+				`${chalk.gray(resource.Type)} ${chalk.gray(
+					`(${resource.Units ?? 'no unit'})`,
+				)}`,
+			)
+		}
+	}
+	return defs
+}
+
+// LwM2M
+console.log(chalk.gray('LwM2M rules check'))
+console.log('')
+const lwm2mDir = path.join(process.cwd(), 'lwm2m')
+const lwm2mDefinitions = await listLwm2mDefinitions(lwm2mDir)
+assert.equal(
+	lwm2mDefinitions.length > 0,
+	true,
+	'LwM2M objects must be defined.',
+)

package/lwm2m/definitions.ts

@@ -0,0 +1,278 @@
+import { type LWM2MObjectInfo, ResourceType } from "./LWM2MObjectInfo.js";
+import { LwM2MObjectID } from "./LwM2MObjectID.js";
+/**
+ * Contains the ID of the resource that defines the timestamp for each LwM2M object definition
+ */
+export const definitions: Record<LwM2MObjectID, LWM2MObjectInfo> = { /**
+     * Geolocation (14201)
+     *
+     * Describes the geo location of a device
+     */
+    [LwM2MObjectID.Geolocation_14201]: { ObjectID: LwM2MObjectID.Geolocation_14201, ObjectVersion: "1.0", Name: "Geolocation", Description: "Describes the geo location of a device", Resources: { /**
+             * Latitude (Float)
+             *
+             * The decimal notation of latitude in degrees, e.g. -43.5723 [World Geodetic System 1984].
+             *
+             * Minimum: -90
+             * Maximum: 90
+             */
+            0: { ResourceID: 0, Name: "Latitude", Mandatory: true, Type: ResourceType.Float, Description: "The decimal notation of latitude in degrees, e.g. -43.5723 [World Geodetic System 1984].", RangeEnumeration: { min: -90, max: 90 }, Units: "\u00B0" }, /**
+             * Longitude (Float)
+             *
+             * The decimal notation of longitude in degrees, e.g. 153.21760 [World Geodetic System 1984].
+             *
+             * Minimum: -180
+             * Maximum: 180
+             */
+            1: { ResourceID: 1, Name: "Longitude", Mandatory: true, Type: ResourceType.Float, Description: "The decimal notation of longitude in degrees, e.g. 153.21760 [World Geodetic System 1984].", RangeEnumeration: { min: -180, max: 180 }, Units: "\u00B0" }, /**
+             * Altitude (Float)
+             *
+             * The decimal notation of altitude in meters above sea level.
+             */
+            2: { ResourceID: 2, Name: "Altitude", Mandatory: false, Type: ResourceType.Float, Description: "The decimal notation of altitude in meters above sea level.", Units: "m" }, /**
+             * Radius (Float)
+             *
+             * The value in this resource indicates the radius of a circular area in meters. The circular area is used to describe uncertainty about a point for coordinates in a two-dimensional coordinate reference systems (CRS). The center point of a circular area is specified by using the Latitude and the Longitude Resources.
+             */
+            3: { ResourceID: 3, Name: "Radius", Mandatory: false, Type: ResourceType.Float, Description: "The value in this resource indicates the radius of a circular area in meters. The circular area is used to describe uncertainty about a point for coordinates in a two-dimensional coordinate reference systems (CRS). The center point of a circular area is specified by using the Latitude and the Longitude Resources.", Units: "m" }, /**
+             * Speed (Float)
+             *
+             * Speed is the time rate of change in position.
+             */
+            4: { ResourceID: 4, Name: "Speed", Mandatory: false, Type: ResourceType.Float, Description: "Speed is the time rate of change in position.", Units: "m/s" }, /**
+             * Heading (Float)
+             *
+             * The angle of movement in degrees.
+             *
+             * Minimum: 0
+             * Maximum: 360
+             */
+            5: { ResourceID: 5, Name: "Heading", Mandatory: false, Type: ResourceType.Float, Description: "The angle of movement in degrees.", RangeEnumeration: { min: 0, max: 360 }, Units: "\u00B0" }, /**
+             * Source (String)
+             *
+             * The source of the geo location, e.g. GNSS, SCELL, MCELL, WIFI.
+             */
+            6: { ResourceID: 6, Name: "Source", Mandatory: true, Type: ResourceType.String, Description: "The source of the geo location, e.g. GNSS, SCELL, MCELL, WIFI." }, /**
+             * Timestamp (Time)
+             *
+             * The timestamp of when the location measurement was performed.
+             */
+            99: { ResourceID: 99, Name: "Timestamp", Mandatory: true, Type: ResourceType.Time, Description: "The timestamp of when the location measurement was performed." } } }, /**
+     * Battery and Power (14202)
+     *
+     * Information about the battery and power status of the device.
+     */
+    [LwM2MObjectID.BatteryAndPower_14202]: { ObjectID: LwM2MObjectID.BatteryAndPower_14202, ObjectVersion: "1.0", Name: "Battery and Power", Description: "Information about the battery and power status of the device.", Resources: { /**
+             * State of charge (Integer)
+             *
+             * State of charge in percent. Examples: 23, 1, 100.
+             *
+             * Minimum: 0
+             * Maximum: 100
+             */
+            0: { ResourceID: 0, Name: "State of charge", Mandatory: false, Type: ResourceType.Integer, Description: "State of charge in percent. Examples: 23, 1, 100.", RangeEnumeration: { min: 0, max: 100 }, Units: "%" }, /**
+             * Voltage (Float)
+             *
+             * Battery voltage in Volt. Examples: 2.754, 3.3.
+             */
+            1: { ResourceID: 1, Name: "Voltage", Mandatory: false, Type: ResourceType.Float, Description: "Battery voltage in Volt. Examples: 2.754, 3.3.", Units: "V" }, /**
+             * Charge current (Float)
+             *
+             * Charge current in mA. Examples: 429, -244.
+             */
+            2: { ResourceID: 2, Name: "Charge current", Mandatory: false, Type: ResourceType.Float, Description: "Charge current in mA. Examples: 429, -244.", Units: "mA" }, /**
+             * Battery temperature (Float)
+             *
+             * Battery temperature in Celsius. Examples: 21.7, 23.123.
+             */
+            3: { ResourceID: 3, Name: "Battery temperature", Mandatory: false, Type: ResourceType.Float, Description: "Battery temperature in Celsius. Examples: 21.7, 23.123.", Units: "C" }, /**
+             * Time to full (Integer)
+             *
+             * Time to full in seconds. Examples: 4652.
+             */
+            4: { ResourceID: 4, Name: "Time to full", Mandatory: false, Type: ResourceType.Integer, Description: "Time to full in seconds. Examples: 4652.", Units: "s" }, /**
+             * Time to empty (Integer)
+             *
+             * Time to empty in seconds. Examples: 4652.
+             */
+            5: { ResourceID: 5, Name: "Time to empty", Mandatory: false, Type: ResourceType.Integer, Description: "Time to empty in seconds. Examples: 4652.", Units: "s" }, /**
+             * Timestamp (Time)
+             *
+             * The timestamp of when the measurement was performed.
+             */
+            99: { ResourceID: 99, Name: "Timestamp", Mandatory: true, Type: ResourceType.Time, Description: "The timestamp of when the measurement was performed." } } }, /**
+     * Connection information (14203)
+     *
+     * Details about the device's connection.
+     */
+    [LwM2MObjectID.ConnectionInformation_14203]: { ObjectID: LwM2MObjectID.ConnectionInformation_14203, ObjectVersion: "1.0", Name: "Connection information", Description: "Details about the device's connection.", Resources: { /**
+             * Network mode (String)
+             *
+             * Examples: LTE-M, NB-IoT.
+             */
+            0: { ResourceID: 0, Name: "Network mode", Mandatory: false, Type: ResourceType.String, Description: "Examples: LTE-M, NB-IoT." }, /**
+             * Band (Integer)
+             *
+             * E-UTRA Absolute Radio Frequency Channel Number (EARFCN) of the current cell where the EARFCN is as defined in 3GPP TS 36.101. LTE carrier channel number for unique identification of LTE band and carrier frequency. Examples: 262143
+             */
+            1: { ResourceID: 1, Name: "Band", Mandatory: false, Type: ResourceType.Integer, Description: "E-UTRA Absolute Radio Frequency Channel Number (EARFCN) of the current cell where the EARFCN is as defined in 3GPP TS 36.101. LTE carrier channel number for unique identification of LTE band and carrier frequency. Examples: 262143" }, /**
+             * RSRP (Integer)
+             *
+             * Reference Signal Received Power (RSRP). The average power level in dBm received from a single reference signal in an LTE (Long-term Evolution) network. Typically this value ranges from -140 to -40 dBm. Examples: -97, -104.
+             */
+            2: { ResourceID: 2, Name: "RSRP", Mandatory: false, Type: ResourceType.Integer, Description: "Reference Signal Received Power (RSRP). The average power level in dBm received from a single reference signal in an LTE (Long-term Evolution) network. Typically this value ranges from -140 to -40 dBm. Examples: -97, -104.", Units: "dBm" }, /**
+             * Area (Integer)
+             *
+             * Area code. Examples: 12
+             */
+            3: { ResourceID: 3, Name: "Area", Mandatory: false, Type: ResourceType.Integer, Description: "Area code. Examples: 12" }, /**
+             * Cell (Integer)
+             *
+             * The cell ID the User Equipment (UE) is camped on. 4-byte Evolved Terrestrial Radio Access Network (E-UTRAN) cell ID. Examples: 33703719
+             */
+            4: { ResourceID: 4, Name: "Cell", Mandatory: false, Type: ResourceType.Integer, Description: "The cell ID the User Equipment (UE) is camped on. 4-byte Evolved Terrestrial Radio Access Network (E-UTRAN) cell ID. Examples: 33703719" }, /**
+             * Mobile country code and mobile network code (Integer)
+             *
+             * Examples: 24202, 310410
+             */
+            5: { ResourceID: 5, Name: "Mobile country code and mobile network code", Mandatory: false, Type: ResourceType.Integer, Description: "Examples: 24202, 310410" }, /**
+             * IP address (String)
+             *
+             * Examples: 10.81.183.99, 2001:0db8:85a3:0000:0000:8a2e:0370:7334, 2001:db8:85a3::8a2e:370:7334
+             */
+            6: { ResourceID: 6, Name: "IP address", Mandatory: false, Type: ResourceType.String, Description: "Examples: 10.81.183.99, 2001:0db8:85a3:0000:0000:8a2e:0370:7334, 2001:db8:85a3::8a2e:370:7334" }, /**
+             * Energy Estimate (Integer)
+             *
+             * The %CONEVAL AT command returns amongst other data the energy estimate: Relative estimated energy consumption of data transmission compared to nominal consumption. A higher value means smaller energy consumption. 5: Difficulties in setting up connections. Maximum number of repetitions might be needed for data. 6: Poor conditions. Setting up a connection might require retries and a higher number of repetitions for data. 7: Normal conditions for cIoT device. No repetitions for data or only a few repetitions in the worst case. 8: Good conditions. Possibly very good conditions for small amounts of data. 9: Very good conditions. Efficient data transfer estimated also for larger amounts of data. Examples: 5, 7
+             */
+            11: { ResourceID: 11, Name: "Energy Estimate", Mandatory: false, Type: ResourceType.Integer, Description: "The %CONEVAL AT command returns amongst other data the energy estimate: Relative estimated energy consumption of data transmission compared to nominal consumption. A higher value means smaller energy consumption. 5: Difficulties in setting up connections. Maximum number of repetitions might be needed for data. 6: Poor conditions. Setting up a connection might require retries and a higher number of repetitions for data. 7: Normal conditions for cIoT device. No repetitions for data or only a few repetitions in the worst case. 8: Good conditions. Possibly very good conditions for small amounts of data. 9: Very good conditions. Efficient data transfer estimated also for larger amounts of data. Examples: 5, 7" }, /**
+             * Timestamp (Time)
+             *
+             * The timestamp of when the measurement was performed.
+             */
+            99: { ResourceID: 99, Name: "Timestamp", Mandatory: true, Type: ResourceType.Time, Description: "The timestamp of when the measurement was performed." } } }, /**
+     * Device information (14204)
+     *
+     * Details about the device's connection.
+     */
+    [LwM2MObjectID.DeviceInformation_14204]: { ObjectID: LwM2MObjectID.DeviceInformation_14204, ObjectVersion: "1.0", Name: "Device information", Description: "Details about the device's connection.", Resources: { /**
+             * IMEI (String)
+             *
+             * Board IMEI. Examples: 352656106111232.
+             */
+            0: { ResourceID: 0, Name: "IMEI", Mandatory: true, Type: ResourceType.String, Description: "Board IMEI. Examples: 352656106111232." }, /**
+             * SIM ICCID (String)
+             *
+             * Examples: 89450421180216216095.
+             */
+            1: { ResourceID: 1, Name: "SIM ICCID", Mandatory: false, Type: ResourceType.String, Description: "Examples: 89450421180216216095." }, /**
+             * Modem firmware version (String)
+             *
+             * Examples: mfw_nrf9160_1.0.0.
+             */
+            2: { ResourceID: 2, Name: "Modem firmware version", Mandatory: true, Type: ResourceType.String, Description: "Examples: mfw_nrf9160_1.0.0." }, /**
+             * Application firmware version (String)
+             *
+             * Examples: v1.0.0-rc1-327-g6fc8c16b239f.
+             */
+            3: { ResourceID: 3, Name: "Application firmware version", Mandatory: true, Type: ResourceType.String, Description: "Examples: v1.0.0-rc1-327-g6fc8c16b239f." }, /**
+             * Board version (String)
+             *
+             * Examples: thingy91_nrf9160.
+             */
+            4: { ResourceID: 4, Name: "Board version", Mandatory: true, Type: ResourceType.String, Description: "Examples: thingy91_nrf9160." }, /**
+             * Battery model (String)
+             *
+             * Examples: LP302535, LP502540, LP803035.
+             */
+            5: { ResourceID: 5, Name: "Battery model", Mandatory: false, Type: ResourceType.String, Description: "Examples: LP302535, LP502540, LP803035." }, /**
+             * Timestamp (Time)
+             *
+             * The timestamp of when the measurement was performed.
+             */
+            99: { ResourceID: 99, Name: "Timestamp", Mandatory: true, Type: ResourceType.Time, Description: "The timestamp of when the measurement was performed." } } }, /**
+     * Environment (14205)
+     *
+     * Environment information.
+     */
+    [LwM2MObjectID.Environment_14205]: { ObjectID: LwM2MObjectID.Environment_14205, ObjectVersion: "1.0", Name: "Environment", Description: "Environment information.", Resources: { /**
+             * Temperature (Float)
+             *
+             * Environmental temperature in Celsius. Examples: 23.5, -10.2.
+             */
+            0: { ResourceID: 0, Name: "Temperature", Mandatory: false, Type: ResourceType.Float, Description: "Environmental temperature in Celsius. Examples: 23.5, -10.2.", Units: "\u00B0C" }, /**
+             * Humidity (Float)
+             *
+             * Environmental humidity in percent. Examples: 44.2, 72.
+             */
+            1: { ResourceID: 1, Name: "Humidity", Mandatory: false, Type: ResourceType.Float, Description: "Environmental humidity in percent. Examples: 44.2, 72.", Units: "%" }, /**
+             * Atmospheric pressure (Float)
+             *
+             * Atmospheric pressure in pascal. Examples: 1003.6, 977.
+             */
+            2: { ResourceID: 2, Name: "Atmospheric pressure", Mandatory: false, Type: ResourceType.Float, Description: "Atmospheric pressure in pascal. Examples: 1003.6, 977.", Units: "Pa" }, /**
+             * Air Quality Index (Integer)
+             *
+             * The Bosch BME680 sensor calculates an Air Quality Index. See https://www.bosch-sensortec.com/media/boschsensortec/downloads/datasheets/bst-bme680-ds001.pdf
+             */
+            10: { ResourceID: 10, Name: "Air Quality Index", Mandatory: false, Type: ResourceType.Integer, Description: "The Bosch BME680 sensor calculates an Air Quality Index. See https://www.bosch-sensortec.com/media/boschsensortec/downloads/datasheets/bst-bme680-ds001.pdf" }, /**
+             * Timestamp (Time)
+             *
+             * The timestamp of when the measurement was performed.
+             */
+            99: { ResourceID: 99, Name: "Timestamp", Mandatory: true, Type: ResourceType.Time, Description: "The timestamp of when the measurement was performed." } } }, /**
+     * Solar charge (14210)
+     *
+     * Measurements from the solar shield.
+     */
+    [LwM2MObjectID.SolarCharge_14210]: { ObjectID: LwM2MObjectID.SolarCharge_14210, ObjectVersion: "1.0", Name: "Solar charge", Description: "Measurements from the solar shield.", Resources: { /**
+             * Gain (Float)
+             *
+             * The current gain from the solar shield, measured in mA. Example: 3.123, -0.0032.
+             */
+            0: { ResourceID: 0, Name: "Gain", Mandatory: true, Type: ResourceType.Float, Description: "The current gain from the solar shield, measured in mA. Example: 3.123, -0.0032.", Units: "mA" }, /**
+             * Voltage (Float)
+             *
+             * Battery voltage in Volt. Examples: 2.754, 3.3.
+             */
+            1: { ResourceID: 1, Name: "Voltage", Mandatory: false, Type: ResourceType.Float, Description: "Battery voltage in Volt. Examples: 2.754, 3.3.", Units: "V" }, /**
+             * Timestamp (Time)
+             *
+             * The timestamp of when the measurement was performed.
+             */
+            99: { ResourceID: 99, Name: "Timestamp", Mandatory: true, Type: ResourceType.Time, Description: "The timestamp of when the measurement was performed." } } }, /**
+     * Button press (14220)
+     *
+     * Describes a button press event.
+     */
+    [LwM2MObjectID.ButtonPress_14220]: { ObjectID: LwM2MObjectID.ButtonPress_14220, ObjectVersion: "1.0", Name: "Button press", Description: "Describes a button press event.", Resources: { /**
+             * Button ID (Integer)
+             *
+             * The ID of the button that was pressed. Examples: 1, 2.
+             */
+            0: { ResourceID: 0, Name: "Button ID", Mandatory: true, Type: ResourceType.Integer, Description: "The ID of the button that was pressed. Examples: 1, 2." }, /**
+             * Timestamp (Time)
+             *
+             * The timestamp of when the button was pressed.
+             */
+            99: { ResourceID: 99, Name: "Timestamp", Mandatory: true, Type: ResourceType.Time, Description: "The timestamp of when the button was pressed." } } }, /**
+     * Sea Water Level (14230)
+     *
+     * Describes observed sea water level.
+     */
+    [LwM2MObjectID.SeaWaterLevel_14230]: { ObjectID: LwM2MObjectID.SeaWaterLevel_14230, ObjectVersion: "1.0", Name: "Sea Water Level", Description: "Describes observed sea water level.", Resources: { /**
+             * Sea Water Level (Float)
+             *
+             * The observed sea water level relative the the sea level elevation of the sea map. Examples: 134.2, 104.5.
+             */
+            0: { ResourceID: 0, Name: "Sea Water Level", Mandatory: true, Type: ResourceType.Float, Description: "The observed sea water level relative the the sea level elevation of the sea map. Examples: 134.2, 104.5.", Units: "cm" }, /**
+             * Station code (String)
+             *
+             * The code of the observation station. Examples: TRD, SVG.
+             */
+            1: { ResourceID: 1, Name: "Station code", Mandatory: true, Type: ResourceType.String, Description: "The code of the observation station. Examples: TRD, SVG." }, /**
+             * Timestamp (Time)
+             *
+             * The timestamp of when the observation was made.
+             */
+            99: { ResourceID: 99, Name: "Timestamp", Mandatory: true, Type: ResourceType.Time, Description: "The timestamp of when the observation was made." } } } };

package/lwm2m/format.sh

@@ -0,0 +1,3 @@
+#!/bin/env sh
+
+xmllint --output $1 --format $1

package/lwm2m/fromXML2JSON.ts

@@ -0,0 +1,44 @@
+import xml2js from 'xml2js'
+import { readFile } from 'node:fs/promises'
+import path from 'node:path'
+import type { LwM2MType } from './resourceType.js'
+
+/**
+ * JSON representation of an XML object
+ */
+type jsonObject = {
+	Name: string[]
+	Description1: string[]
+	ObjectID: string[]
+	ObjectURN: string[]
+	LWM2MVersion: string[]
+	ObjectVersion: string[]
+	MultipleInstances: ['Single'] | ['Multiple']
+	Mandatory: ['Optional'] | ['Mandatory']
+	Resources: [{ Item: Resource[] }]
+	Description2: string[]
+}
+
+type Resource = {
+	$: { ID: string }
+	Name: string[]
+	Operations: string[]
+	MultipleInstances: ['Single'] | ['Multiple']
+	Mandatory: ['Optional'] | ['Mandatory']
+	Type: LwM2MType[]
+	RangeEnumeration: string[]
+	Units: string[]
+	Description: string[]
+}
+
+/**
+ * From XML to JSON
+ */
+export const fromXML2JSON = async (id: number): Promise<jsonObject> => {
+	const baseDir = process.cwd()
+	const subDir = (...tree: string[]): string => path.join(baseDir, ...tree)
+	const jsonObject = await xml2js.parseStringPromise(
+		await readFile(subDir('lwm2m', `${id}.xml`), 'utf-8'),
+	)
+	return jsonObject.LWM2M.Object[0]
+}

package/lwm2m/instanceTs.spec.ts

@@ -0,0 +1,19 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { instanceTs } from './instanceTs.js'
+
+void describe('instanceTs()', () => {
+	void it('should return the timestamp of the instance', () =>
+		assert.equal(
+			instanceTs({
+				ObjectID: 14210,
+				ObjectVersion: '1.0',
+				Resources: {
+					'0': 3.5399999618530273,
+					'1': 4.168000221252441,
+					'99': '2024-02-23T10:18:20.474Z',
+				},
+			}).getTime(),
+			new Date('2024-02-23T10:18:20.474Z').getTime(),
+		))
+})