@hello.nrfcloud.com/proto-map 4.0.0

package/dist/senml/parseResourceId.spec.js

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

package/dist/senml/senMLtoLwM2M.js

@@ -0,0 +1,126 @@
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+function _object_spread(target) {
+    for(var i = 1; i < arguments.length; i++){
+        var source = arguments[i] != null ? arguments[i] : {};
+        var ownKeys = Object.keys(source);
+        if (typeof Object.getOwnPropertySymbols === "function") {
+            ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(source, sym).enumerable;
+            }));
+        }
+        ownKeys.forEach(function(key) {
+            _define_property(target, key, source[key]);
+        });
+    }
+    return target;
+}
+function ownKeys(object, enumerableOnly) {
+    var keys = Object.keys(object);
+    if (Object.getOwnPropertySymbols) {
+        var symbols = Object.getOwnPropertySymbols(object);
+        if (enumerableOnly) {
+            symbols = symbols.filter(function(sym) {
+                return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+            });
+        }
+        keys.push.apply(keys, symbols);
+    }
+    return keys;
+}
+function _object_spread_props(target, source) {
+    source = source != null ? source : {};
+    if (Object.getOwnPropertyDescriptors) {
+        Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
+    } else {
+        ownKeys(Object(source)).forEach(function(key) {
+            Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+        });
+    }
+    return target;
+}
+import { timestampResources } from "../lwm2m/timestampResources.js";
+import { parseResourceId } from "./parseResourceId.js";
+import { hasValue } from "./hasValue.js";
+var isInfoForDifferentInstance = function(currentObject, resourceID, currentBaseTime) {
+    var _currentObject_Resources_tsRes, _currentObject_Resources;
+    if (currentObject === undefined) return true;
+    if (currentObject.ObjectID !== resourceID.ObjectID) return true;
+    var _currentObject_ObjectInstanceID;
+    if (((_currentObject_ObjectInstanceID = currentObject.ObjectInstanceID) !== null && _currentObject_ObjectInstanceID !== void 0 ? _currentObject_ObjectInstanceID : 0) !== resourceID.ObjectInstanceID) return true;
+    var tsRes = timestampResources[resourceID.ObjectID];
+    if (tsRes === undefined) throw new Error("Unknown LwM2M Object ID: ".concat(resourceID.ObjectID, "!"));
+    if (currentBaseTime !== ((_currentObject_Resources = currentObject.Resources) === null || _currentObject_Resources === void 0 ? void 0 : (_currentObject_Resources_tsRes = _currentObject_Resources[tsRes]) === null || _currentObject_Resources_tsRes === void 0 ? void 0 : _currentObject_Resources_tsRes.getTime())) return true;
+    return false;
+};
+var getValue = function(measurement) {
+    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 var senMLtoLwM2M = function(senML) {
+    var currentBaseName = "";
+    var currentBaseTime = undefined;
+    var currentObject = undefined;
+    var items = [];
+    var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+    try {
+        for(var _iterator = senML[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+            var item = _step.value;
+            if ("bn" in item && item.bn !== undefined) currentBaseName = item.bn;
+            if ("bt" in item && item.bt !== undefined) currentBaseTime = item.bt;
+            if (!hasValue(item)) continue;
+            var _item_n;
+            var itemResourceId = "".concat(currentBaseName).concat((_item_n = item.n) !== null && _item_n !== void 0 ? _item_n : "", "/0");
+            var resourceId = parseResourceId(itemResourceId);
+            if (resourceId === null) throw new Error("Invalid resource ID: ".concat(itemResourceId));
+            if (currentObject === undefined || currentBaseTime !== undefined && isInfoForDifferentInstance(currentObject, resourceId, currentBaseTime)) {
+                if (currentObject !== undefined) items.push(currentObject);
+                var tsRes = timestampResources[resourceId.ObjectID];
+                if (tsRes === undefined) throw new Error("Unknown LwM2M Object ID: ".concat(resourceId.ObjectID, "!"));
+                if (currentBaseTime === undefined) throw new Error("No base time defined for object!");
+                currentObject = {
+                    ObjectID: resourceId.ObjectID,
+                    Resources: _define_property({}, tsRes, new Date(currentBaseTime))
+                };
+                if (resourceId.ObjectInstanceID !== 0) currentObject.ObjectInstanceID = resourceId.ObjectInstanceID;
+                if ("blv" in item) currentObject.ObjectVersion = item.blv;
+            }
+            if ((currentObject === null || currentObject === void 0 ? void 0 : currentObject.Resources) === undefined) continue;
+            var value = getValue(item);
+            if (value !== undefined) {
+                currentObject.Resources = _object_spread_props(_object_spread({}, currentObject.Resources), _define_property({}, item.n, value));
+            }
+        }
+    } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                _iterator.return();
+            }
+        } finally{
+            if (_didIteratorError) {
+                throw _iteratorError;
+            }
+        }
+    }
+    if (currentObject !== undefined) items.push(currentObject);
+    return items;
+};

package/dist/senml/senMLtoLwM2M.spec.js

@@ -0,0 +1,226 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+import { senMLtoLwM2M } from "./senMLtoLwM2M.js";
+void describe("senMLtoLwM2M()", function() {
+    void it("should resolve a senML message into objects", function() {
+        var input = [
+            {
+                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
+            }
+        ];
+        var expected = [
+            {
+                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", function() {
+        var input = [
+            {
+                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"
+            }
+        ];
+        var expected = [
+            {
+                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", function() {
+        var input = [
+            {
+                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
+            }
+        ];
+        var expected = [
+            {
+                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", function() {
+        var input = [
+            {
+                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
+            }
+        ];
+        var expected = [
+            {
+                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/dist/senml/validateSenML.js

@@ -0,0 +1,6 @@
+import { SenML } from "../senml/SenMLSchema.js";
+import { validate } from "../validate.js";
+var validator = validate(SenML);
+export var validateSenML = function(maybeSenML) {
+    return validator(maybeSenML);
+};

package/dist/senml/validateSenML.spec.js

@@ -0,0 +1,31 @@
+import { describe, it } from "node:test";
+import assert from "node:assert/strict";
+import { validateSenML } from "./validateSenML.js";
+void describe("validateSenML()", function() {
+    void it("should validate", function() {
+        var senMl = [
+            {
+                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/export.js

@@ -0,0 +1,13 @@
+export * from './dist/senml/SenMLSchema.js'
+export * from './dist/senml/senMLtoLwM2M.js'
+export * from './dist/senml/lwm2mToSenML.js'
+export * from './dist/models/models.js'
+export * from './dist/models/types.js'
+export * from './dist/lwm2m/timestampResources.js'
+export * from './dist/lwm2m/objects.js'
+export * from './dist/lwm2m/definitions.js'
+export * from './dist/lwm2m/LWM2MObjectInfo.js'
+export * from './dist/lwm2m/validators.js'
+export * from './dist/lwm2m/LwM2MObjectID.js'
+export * from './dist/lwm2m/validation.js'
+export * from './dist/lwm2m/instanceTs.js'

package/index.d.ts

@@ -0,0 +1,14 @@
+export * from './senml/SenMLSchema.js'
+export * from './senml/senMLtoLwM2M.js'
+export * from './senml/lwm2mToSenML.js'
+export * from './models/models.js'
+export * from './models/types.js'
+export * from './lwm2m/timestampResources.js'
+export * from './lwm2m/LwM2MObject.js'
+export * from './lwm2m/LwM2MObjectID.js'
+export * from './lwm2m/objects.js'
+export * from './lwm2m/definitions.js'
+export * from './lwm2m/LWM2MObjectInfo.js'
+export * from './lwm2m/validators.js'
+export * from './lwm2m/validation.js'
+export * from './lwm2m/instanceTs.js'

package/lwm2m/14201.xml

@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LWM2M xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://openmobilealliance.org/tech/profiles/LWM2M-v1_1.xsd">
+  <Object ObjectType="MODefinition">
+    <Name>Geolocation</Name>
+    <Description1><![CDATA[Describes the geo location of a device]]></Description1>
+    <ObjectID>14201</ObjectID>
+    <ObjectURN>urn:oma:lwm2m:x:14201</ObjectURN>
+    <MultipleInstances>Multiple</MultipleInstances>
+    <Mandatory>Optional</Mandatory>
+    <Resources>
+      <Item ID="0">
+        <Name>Latitude</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Mandatory</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration>-90..90</RangeEnumeration>
+        <Units>°</Units>
+        <Description><![CDATA[The decimal notation of latitude in degrees, e.g. -43.5723 [World Geodetic System 1984].]]></Description>
+      </Item>
+      <Item ID="1">
+        <Name>Longitude</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Mandatory</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration>-180..180</RangeEnumeration>
+        <Units>°</Units>
+        <Description><![CDATA[The decimal notation of longitude in degrees, e.g. 153.21760 [World Geodetic System 1984].]]></Description>
+      </Item>
+      <Item ID="2">
+        <Name>Altitude</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration/>
+        <Units>m</Units>
+        <Description><![CDATA[The decimal notation of altitude in meters above sea level.]]></Description>
+      </Item>
+      <Item ID="3">
+        <Name>Radius</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration/>
+        <Units>m</Units>
+        <Description><![CDATA[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.]]></Description>
+      </Item>
+      <Item ID="4">
+        <Name>Speed</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration/>
+        <Units>m/s</Units>
+        <Description><![CDATA[Speed is the time rate of change in position.]]></Description>
+      </Item>
+      <Item ID="5">
+        <Name>Heading</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration>0..360</RangeEnumeration>
+        <Units>°</Units>
+        <Description><![CDATA[The angle of movement in degrees.]]></Description>
+      </Item>
+      <Item ID="6">
+        <Name>Source</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Mandatory</Mandatory>
+        <Type>String</Type>
+        <RangeEnumeration/>
+        <Units/>
+        <Description><![CDATA[The source of the geo location, e.g. GNSS, SCELL, MCELL, WIFI.]]></Description>
+      </Item>
+      <Item ID="99">
+        <Name>Timestamp</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Mandatory</Mandatory>
+        <Type>Time</Type>
+        <RangeEnumeration/>
+        <Units/>
+        <Description><![CDATA[The timestamp of when the location measurement was performed.]]></Description>
+      </Item>
+    </Resources>
+    <Description2/>
+  </Object>
+</LWM2M>

package/lwm2m/14202.xml

@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LWM2M xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://openmobilealliance.org/tech/profiles/LWM2M-v1_1.xsd">
+  <Object ObjectType="MODefinition">
+    <Name>Battery and Power</Name>
+    <Description1><![CDATA[Information about the battery and power status of the device.]]></Description1>
+    <ObjectID>14202</ObjectID>
+    <ObjectURN>urn:oma:lwm2m:x:14202</ObjectURN>
+    <MultipleInstances>Multiple</MultipleInstances>
+    <Mandatory>Optional</Mandatory>
+    <Resources>
+      <Item ID="0">
+        <Name>State of charge</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Integer</Type>
+        <RangeEnumeration>0..100</RangeEnumeration>
+        <Units>%</Units>
+        <Description><![CDATA[State of charge in percent. Examples: 23, 1, 100.]]></Description>
+      </Item>
+      <Item ID="1">
+        <Name>Voltage</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration/>
+        <Units>V</Units>
+        <Description><![CDATA[Battery voltage in Volt. Examples: 2.754, 3.3.]]></Description>
+      </Item>
+      <Item ID="2">
+        <Name>Charge current</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration/>
+        <Units>mA</Units>
+        <Description><![CDATA[Charge current in mA. Examples: 429, -244.]]></Description>
+      </Item>
+      <Item ID="3">
+        <Name>Battery temperature</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Float</Type>
+        <RangeEnumeration/>
+        <Units>C</Units>
+        <Description><![CDATA[Battery temperature in Celsius. Examples: 21.7, 23.123.]]></Description>
+      </Item>
+      <Item ID="4">
+        <Name>Time to full</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Integer</Type>
+        <RangeEnumeration/>
+        <Units>s</Units>
+        <Description><![CDATA[Time to full in seconds. Examples: 4652.]]></Description>
+      </Item>
+      <Item ID="5">
+        <Name>Time to empty</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Optional</Mandatory>
+        <Type>Integer</Type>
+        <RangeEnumeration/>
+        <Units>s</Units>
+        <Description><![CDATA[Time to empty in seconds. Examples: 4652.]]></Description>
+      </Item>
+      <Item ID="99">
+        <Name>Timestamp</Name>
+        <Operations>R</Operations>
+        <MultipleInstances>Single</MultipleInstances>
+        <Mandatory>Mandatory</Mandatory>
+        <Type>Time</Type>
+        <RangeEnumeration/>
+        <Units/>
+        <Description><![CDATA[The timestamp of when the measurement was performed.]]></Description>
+      </Item>
+    </Resources>
+    <Description2/>
+  </Object>
+</LWM2M>