@utiliread/primitives 1.0.0-6 → 1.0.0-62

package/src/register-definition.ts

@@ -1,10 +1,23 @@
-import { UnitId } from ".";
-import { AggregateId } from "./aggregate-id";
-import { RegisterId } from "./register-id";
-
-export interface RegisterDefinition {
-    id: RegisterId;
-    aggregate: AggregateId;
-    units: ReadonlyArray<UnitId>;
-    immediate?: true;
-}
+import { UnitId } from ".";
+import { AggregateId } from "./aggregate-id";
+import { MeasureId } from "./measure-id";
+import { RegisterId } from "./register-id";
+
+export interface RegisterDefinition {
+    /// The id of the register
+    id: RegisterId;
+    /// The register measure
+    measure: MeasureId;
+    /// The aggregate of the register
+    aggregate: AggregateId;
+    /// The possible register units
+    units: ReadonlyArray<UnitId>;
+    /// Whether the register can only be resolved by "present value".
+    immediate?: true;
+    /// An optional concise register name.
+    /// Only used for custom registers as locales exist for standard registers.
+    name?: string;
+    /// An optional register description.
+    /// Only used for custom registers as locales exist for standard registers.
+    description?: string;
+}

package/src/register-id.ts

@@ -1,191 +1,271 @@
-export type RegisterId =
-    "none" |
-    
-    "heatEnergy" |
-    "diffHeatEnergy" |
-
-    "heatEnergyVolumeInInlet" |
-    "diffHeatEnergyVolumeInInlet" |
-
-    "heatEnergyVolumeInOutlet" |
-    "diffHeatEnergyVolumeInOutlet" |
-
-    "coolingEnergy" |
-    "diffCoolingEnergy" |
-
-    "coolingEnergyVolumeInInlet" |
-    "diffCoolingEnergyVolumeInInlet" |
-
-    "coolingEnergyVolumeInOutlet" |
-    "diffCoolingEnergyVolumeInOutlet" |
-
-    "electricalEnergy" |
-    "diffElectricalEnergy" |
-
-    "reactiveEnergy" |
-    "diffReactiveEnergy" |
-
-    "volume" |
-    "diffVolume" |
-
-    "inletVolume" |
-    "diffInletVolume" |
-
-    "outletVolume" |
-    "diffOutletVolume" |
-
-    "pulseInputAVolume" |
-    "diffPulseInputAVolume" |
-
-    "pulseInputBVolume" |
-    "diffPulseInputBVolume" |
-
-    "mass" |
-    "diffMass" |
-
-    "inletMass" |
-    "diffInletMass" |
-
-    "outletMass" |
-    "diffOutletMass" |
-
-    "power" |
-    "maxPower" |
-    "minPower" |
-    "avgPower" |
-
-    "inletPower" |
-    "maxInletPower" |
-    "minInletPower" |
-    "avgInletPower" |
-
-    "outletPower" |
-    "maxOutletPower" |
-    "minOutletPower" |
-    "avgOutletPower" |
-
-    "volumeFlow" |
-    "maxVolumeFlow" |
-    "minVolumeFlow" |
-    "avgVolumeFlow" |
-
-    "inletVolumeFlow" |
-    "maxInletVolumeFlow" |
-    "minInletVolumeFlow" |
-    "avgInletVolumeFlow" |
-
-    "outletVolumeFlow" |
-    "maxOutletVolumeFlow" |
-    "minOutletVolumeFlow" |
-    "avgOutletVolumeFlow" |
-
-    "massFlow" |
-    "maxMassFlow" |
-    "minMassFlow" |
-    "avgMassFlow" |
-
-    "inletMassFlow" |
-    "maxInletMassFlow" |
-    "minInletMassFlow" |
-    "avgInletMassFlow" |
-
-    "outletMassFlow" |
-    "maxOutletMassFlow" |
-    "minOutletMassFlow" |
-    "avgOutletMassFlow" |
-
-    "flowTemperature" |
-    "maxFlowTemperature" |
-    "minFlowTemperature" |
-    "avgFlowTemperature" |
-
-    "inletFlowTemperature" |
-    "maxInletFlowTemperature" |
-    "minInletFlowTemperature" |
-    "avgInletFlowTemperature" |
-
-    "outletFlowTemperature" |
-    "maxOutletFlowTemperature" |
-    "minOutletFlowTemperature" |
-    "avgOutletFlowTemperature" |
-
-    "inletMinusOutletFlowTemperatureDifference" |
-    "maxInletMinusOutletFlowTemperatureDifference" |
-    "minInletMinusOutletFlowTemperatureDifference" |
-    "avgInletMinusOutletFlowTemperatureDifference" |
-
-    "outletMinusInletFlowTemperatureDifference" |
-    "maxOutletMinusInletFlowTemperatureDifference" |
-    "minOutletMinusInletFlowTemperatureDifference" |
-    "avgOutletMinusInletFlowTemperatureDifference" |
-
-    "ambientTemperature" |
-    "maxAmbientTemperature" |
-    "minAmbientTemperature" |
-    "avgAmbientTemperature" |
-
-    "radiatorTemperature" |
-    "maxRadiatorTemperature" |
-    "minRadiatorTemperature" |
-    "avgRadiatorTemperature" |
-
-    "relativeHumidity" |
-
-    "kamstrupE8Inlet" |
-    "diffKamstrupE8Inlet" |
-    "kamstrupE9Outlet" |
-    "diffKamstrupE9Outlet" |
-
-    "operatingTime" |
-    "diffOperatingTime" |
-
-    "remainingBatteryTime" |
-    "diffRemainingBatteryTime" |
-
-    "deviceDate" |
-    "deviceTime" |
-    "deviceDateTime" |
-
-    "timeSinceLastExactOverhearingArrived" |
-    "timeAtLastExactOverhearingArrived" |
-
-    "timeSinceLastPossibleCandidateOverhearingArrived" |
-    "timeAtLastPossibleCandidateOverhearingArrived" |
-    
-    "timeSinceLastSampled" |
-    "timeAtLastSampled" |
-    
-    "timeSinceLastInstallationMounted" |
-    "timeAtLastInstallationMounted" |
-
-    "basetime" |
-
-    "device" |
-    "wMBusDeviceAddresses" |
-    "kamdraftDeviceAddresses" |
-    "tchlrDeviceAddresses" |
-    "kamdaDeviceAddresses" |
-    "msisdnDeviceAddresses" |
-    "deviceRegisters" |
-    "consumptionZone" |
-
-    "mBusFormatStringSignature" |
-
-    "kamstrupMulticalInfocodeType1" |
-    "kamstrupMulticalInfocodeType2" |
-    "kamstrupMulticalInfocodeType3" |
-    "kamstrupMulticalInfocodeType4" |
-    "kamstrupMulticalInfocode" |
-    "kamstrupModuleType" |
-    
-    "diehlInfocodeType1" |
-    "diehlInfocode" |
-
-    "landisGyrMBusStatusType1" |
-    "landisGyrMBusStatusType2" |
-    "landisGyrMBusStatus" |
-    "landisGyrInfocodeType1" |
-    "landisGyrInfocodeType2" |
-    "landisGyrInfocode" |
-    
-    "infocode";
+export type RegisterId =
+    "none" |
+
+    "heatEnergy" |
+    "diffHeatEnergy" |
+    "cntHeatEnergy" |
+
+    "heatEnergyVolumeInInlet" |
+    "diffHeatEnergyVolumeInInlet" |
+    "cntHeatEnergyVolumeInInlet" |
+
+    "heatEnergyVolumeInOutlet" |
+    "diffHeatEnergyVolumeInOutlet" |
+    "cntHeatEnergyVolumeInOutlet" |
+
+    "coolingEnergy" |
+    "diffCoolingEnergy" |
+    "cntCoolingEnergy" |
+
+    "coolingEnergyVolumeInInlet" |
+    "diffCoolingEnergyVolumeInInlet" |
+    "cntCoolingEnergyVolumeInInlet" |
+
+    "coolingEnergyVolumeInOutlet" |
+    "diffCoolingEnergyVolumeInOutlet" |
+    "cntCoolingEnergyVolumeInOutlet" |
+
+    "electricalEnergy" |
+    "diffElectricalEnergy" |
+    "cntElectricalEnergy" |
+
+    "reactiveEnergy" |
+    "diffReactiveEnergy" |
+    "cntReactiveEnergy" |
+
+    "volume" |
+    "diffVolume" |
+    "cntVolume" |
+
+    "inletVolume" |
+    "diffInletVolume" |
+    "cntInletVolume" |
+
+    "outletVolume" |
+    "diffOutletVolume" |
+    "cntOutletVolume" |
+
+    "pulseInputAVolume" |
+    "diffPulseInputAVolume" |
+    "cntPulseInputAVolume" |
+
+    "pulseInputBVolume" |
+    "diffPulseInputBVolume" |
+    "cntPulseInputBVolume" |
+
+    "mass" |
+    "diffMass" |
+    "cntMass" |
+
+    "inletMass" |
+    "diffInletMass" |
+    "cntInletMass" |
+
+    "outletMass" |
+    "diffOutletMass" |
+    "cntOutletMass" |
+
+    "power" |
+    "maxPower" |
+    "minPower" |
+    "avgPower" |
+    "sumPower" |
+    "cntPower" |
+    "ssqPower" |
+
+    "inletPower" |
+    "maxInletPower" |
+    "minInletPower" |
+    "avgInletPower" |
+    "sumInletPower" |
+    "cntInletPower" |
+    "ssqInletPower" |
+
+    "outletPower" |
+    "maxOutletPower" |
+    "minOutletPower" |
+    "avgOutletPower" |
+    "sumOutletPower" |
+    "cntOutletPower" |
+    "ssqOutletPower" |
+
+    "volumeFlow" |
+    "maxVolumeFlow" |
+    "minVolumeFlow" |
+    "avgVolumeFlow" |
+    "sumVolumeFlow" |
+    "cntVolumeFlow" |
+    "ssqVolumeFlow" |
+
+    "inletVolumeFlow" |
+    "maxInletVolumeFlow" |
+    "minInletVolumeFlow" |
+    "avgInletVolumeFlow" |
+    "sumInletVolumeFlow" |
+    "cntInletVolumeFlow" |
+    "ssqInletVolumeFlow" |
+
+    "outletVolumeFlow" |
+    "maxOutletVolumeFlow" |
+    "minOutletVolumeFlow" |
+    "avgOutletVolumeFlow" |
+    "sumOutletVolumeFlow" |
+    "cntOutletVolumeFlow" |
+    "ssqOutletVolumeFlow" |
+
+    "massFlow" |
+    "maxMassFlow" |
+    "minMassFlow" |
+    "avgMassFlow" |
+    "sumMassFlow" |
+    "cntMassFlow" |
+    "ssqMassFlow" |
+
+    "inletMassFlow" |
+    "maxInletMassFlow" |
+    "minInletMassFlow" |
+    "avgInletMassFlow" |
+    "sumInletMassFlow" |
+    "cntInletMassFlow" |
+    "ssqInletMassFlow" |
+
+    "outletMassFlow" |
+    "maxOutletMassFlow" |
+    "minOutletMassFlow" |
+    "avgOutletMassFlow" |
+    "sumOutletMassFlow" |
+    "cntOutletMassFlow" |
+    "ssqOutletMassFlow" |
+
+    "flowTemperature" |
+    "maxFlowTemperature" |
+    "minFlowTemperature" |
+    "avgFlowTemperature" |
+    "sumFlowTemperature" |
+    "cntFlowTemperature" |
+    "ssqFlowTemperature" |
+
+    "inletFlowTemperature" |
+    "maxInletFlowTemperature" |
+    "minInletFlowTemperature" |
+    "avgInletFlowTemperature" |
+    "sumInletFlowTemperature" |
+    "cntInletFlowTemperature" |
+    "ssqInletFlowTemperature" |
+
+    "outletFlowTemperature" |
+    "maxOutletFlowTemperature" |
+    "minOutletFlowTemperature" |
+    "avgOutletFlowTemperature" |
+    "sumOutletFlowTemperature" |
+    "cntOutletFlowTemperature" |
+    "ssqOutletFlowTemperature" |
+
+    "inletMinusOutletFlowTemperatureDifference" |
+    "maxInletMinusOutletFlowTemperatureDifference" |
+    "minInletMinusOutletFlowTemperatureDifference" |
+    "avgInletMinusOutletFlowTemperatureDifference" |
+    "sumInletMinusOutletFlowTemperatureDifference" |
+    "cntInletMinusOutletFlowTemperatureDifference" |
+    "ssqInletMinusOutletFlowTemperatureDifference" |
+
+    "outletMinusInletFlowTemperatureDifference" |
+    "maxOutletMinusInletFlowTemperatureDifference" |
+    "minOutletMinusInletFlowTemperatureDifference" |
+    "avgOutletMinusInletFlowTemperatureDifference" |
+    "sumOutletMinusInletFlowTemperatureDifference" |
+    "cntOutletMinusInletFlowTemperatureDifference" |
+    "ssqOutletMinusInletFlowTemperatureDifference" |
+
+    "ambientTemperature" |
+    "maxAmbientTemperature" |
+    "minAmbientTemperature" |
+    "avgAmbientTemperature" |
+    "sumAmbientTemperature" |
+    "cntAmbientTemperature" |
+    "ssqAmbientTemperature" |
+
+    "radiatorTemperature" |
+    "maxRadiatorTemperature" |
+    "minRadiatorTemperature" |
+    "avgRadiatorTemperature" |
+    "sumRadiatorTemperature" |
+    "cntRadiatorTemperature" |
+    "ssqRadiatorTemperature" |
+
+    "relativeHumidity" |
+
+    "kamstrupE8Inlet" |
+    "diffKamstrupE8Inlet" |
+    "cntKamstrupE8Inlet" |
+    "kamstrupE9Outlet" |
+    "diffKamstrupE9Outlet" |
+    "cntKamstrupE9Outlet" |
+
+    "operatingTime" |
+    "diffOperatingTime" |
+    "cntOperatingTime" |
+
+    "errorOperatingTime" |
+    "diffErrorOperatingTime" |
+    "cntErrorOperatingTime" |
+
+    "remainingBatteryTime" |
+    "diffRemainingBatteryTime" |
+    "cntRemainingBatteryTime" |
+
+    "deviceDate" |
+    "deviceTime" |
+    "deviceDateTime" |
+
+    "timeSinceLastExactOverhearingArrived" |
+    "timeAtLastExactOverhearingArrived" |
+
+    "timeSinceLastPossibleCandidateOverhearingArrived" |
+    "timeAtLastPossibleCandidateOverhearingArrived" |
+
+    "timeSinceLastSampled" |
+    "timeAtLastSampled" |
+
+    "timeSinceLastInstallationMounted" |
+    "timeAtLastInstallationMounted" |
+
+    "basetime" |
+    "instantTime" |
+    "periodStartTime" |
+    "periodEndTime" |
+    "instantOrPeriodStartTime" |
+    "instantOrPeriodEndTime" |
+
+    "device" |
+    "wMBusDeviceAddresses" |
+    "kamdraftDeviceAddresses" |
+    "tchlrDeviceAddresses" |
+    "kamdaDeviceAddresses" |
+    "msisdnDeviceAddresses" |
+
+    "deviceRegisters" |
+
+    "consumptionZone" |
+
+    "mBusFormatStringSignature" |
+    "deviceSoftwareVersion" |
+
+    "kamstrupMulticalInfocodeType1" |
+    "kamstrupMulticalInfocodeType2" |
+    "kamstrupMulticalInfocodeType3" |
+    "kamstrupMulticalInfocodeType4" |
+    "kamstrupMulticalInfocode" |
+    "kamstrupModuleType" |
+
+    "diehlInfocodeType1" |
+    "diehlInfocode" |
+
+    "landisGyrMBusStatusType1" |
+    "landisGyrMBusStatusType2" |
+    "landisGyrMBusStatus" |
+    "landisGyrInfocodeType1" |
+    "landisGyrInfocodeType2" |
+    "landisGyrInfocode" |
+
+    "infocode";

package/src/register-library.spec.ts

@@ -1,33 +1,41 @@
-import { expect } from "chai";
-import { RegisterDefinition } from ".";
-import { RegisterLibrary } from "./register-library";
-
-const volume: RegisterDefinition = {
-    id: "volume",
-    aggregate: "instant",
-    units: ["cubicMeter"]
-};
-
-describe("library", () => {
-    beforeEach(() => {
-        RegisterLibrary.reset();
-    });
-
-    it("should get added definition", () => {
-        RegisterLibrary.add(volume);
-        const definition = RegisterLibrary.get("volume");
-        expect(definition.id).to.equal("volume");
-    });
-
-    it("should add all definitions in pack", () => {
-        RegisterLibrary.add({
-            someRandomKey: volume
-        });
-        const definition = RegisterLibrary.get("volume");
-        expect(definition.id).to.equal("volume");
-    });
-
-    it("should throw when getting not added register", () => {
-        expect(() => RegisterLibrary.get("volume")).to.throw();
-    });
-});
+import { expect } from "chai";
+import { RegisterDefinition } from ".";
+import { RegisterLibrary } from "./register-library";
+
+const volume: RegisterDefinition = {
+    id: "volume",
+    measure: "volume",
+    aggregate: "instant",
+    units: ["cubicMeter"]
+};
+
+describe("library", () => {
+    beforeEach(() => {
+        RegisterLibrary.reset();
+    });
+
+    it("should get added definition", () => {
+        RegisterLibrary.add(volume);
+        const definition = RegisterLibrary.get("volume");
+        expect(definition.id).to.equal("volume");
+    });
+
+    it("should add all definitions in pack", () => {
+        RegisterLibrary.add({
+            someRandomKey: volume
+        });
+        const definition = RegisterLibrary.get("volume");
+        expect(definition.id).to.equal("volume");
+    });
+
+    it("should throw when getting not added register", () => {
+        expect(() => RegisterLibrary.get("volume")).to.throw();
+    });
+
+    it("should return all definitions when invoking all()", () => {
+        RegisterLibrary.add(volume);
+        RegisterLibrary.add(volume); // Only added once.
+        const all = RegisterLibrary.all();
+        expect(all.length).to.equal(1);
+    })
+});

package/src/register-library.ts

@@ -1,37 +1,57 @@
-import { RegisterDefinition } from "./register-definition";
-import { RegisterId } from "./register-id";
-import { RegisterPack } from "./register-pack";
-
-class Library {
-    private definitions: Partial<{ [id in RegisterId]: RegisterDefinition }> = {};
-    public add(...definitions: (RegisterDefinition | RegisterPack)[]) {
-        for (const definition of definitions) {
-            if (isDefinition(definition)) {
-                this.definitions[definition.id] = definition;
-            }
-            else {
-                for (const definitionInPack of Object.values(definition)) {
-                    this.definitions[definitionInPack.id] = definitionInPack;
-                }
-            }
-        }
-    }
-
-    public get(id: RegisterId) {
-        const definition = this.definitions[id];
-        if (!definition) {
-            throw new Error(`Defintion was not loaded for register ${id}`);
-        }
-        return definition;
-    }
-
-    public reset() {
-        this.definitions = {};
-    }
-}
-
-function isDefinition(definitionOrPack: RegisterDefinition | RegisterPack): definitionOrPack is RegisterDefinition {
-    return !!(definitionOrPack.id && definitionOrPack.aggregate && definitionOrPack.units);
-}
-
-export const RegisterLibrary = new Library();
+import { RegisterDefinition } from "./register-definition";
+import { RegisterId } from "./register-id";
+import { RegisterPack } from "./register-pack";
+
+class Library {
+    private definitions: Partial<{ [id in RegisterId]: RegisterDefinition }> = {};
+    public add(...definitions: (RegisterDefinition | RegisterPack)[]) {
+        for (const definition of definitions) {
+            if (isDefinition(definition)) {
+                this.tryAdd(definition);
+            }
+            else {
+                for (const definitionInPack of Object.values(definition)) {
+                    this.tryAdd(definitionInPack);
+                }
+            }
+        }
+    }
+
+    private tryAdd(definition: RegisterDefinition) {
+        if (!this.definitions[definition.id]) {
+            this.definitions[definition.id] = definition;
+            return true;
+        }
+        return false;
+    }
+
+    public has(id: RegisterId) {
+        return !!this.definitions[id];
+    }
+
+    public tryGet(id: RegisterId) {
+        return this.definitions[id];
+    }
+
+    public get(id: RegisterId) {
+        const definition = this.definitions[id];
+        if (!definition) {
+            throw new Error(`Defintion was not loaded for register ${id}`);
+        }
+        return definition;
+    }
+
+    public all() {
+        return Object.values(this.definitions).map(x => x!);
+    }
+
+    public reset() {
+        this.definitions = {};
+    }
+}
+
+function isDefinition(definitionOrPack: RegisterDefinition | RegisterPack): definitionOrPack is RegisterDefinition {
+    return !!(definitionOrPack.id && definitionOrPack.aggregate && definitionOrPack.units);
+}
+
+export const RegisterLibrary = new Library();