@utiliread/primitives 1.0.0-14 → 1.0.0-141

package/src/register-convention.ts

@@ -1,61 +1,70 @@
-import { RegisterDefinition } from ".";
-import { AggregateId } from "./aggregate-id";
-import { RegisterId } from "./register-id";
-import { getRegisterId } from "./register-utils";
-
-export const aggregatePrefixes: { [aggregateId in AggregateId]: string } = {
-    instant: "",
-    diff: "diff",
-    min: "min",
-    max: "max",
-    avg: "avg",
-    sum: "sum",
-    cnt: "cnt",
-    ssq: "ssq",
-};
-
-class Convention {
-    public getAggregate(register: RegisterId | RegisterDefinition) {
-        const registerId = getRegisterId(register);
-        // Brute force all prefixes - if none of them, then it must be instant.
-        for (const aggregateString of Object.keys(aggregatePrefixes)) {
-            const aggregate = <AggregateId>aggregateString;
-            const prefix = aggregatePrefixes[aggregate];
-            if (prefix.length && isPrefix(registerId, prefix)) {
-                // Not instant - it was any of the others.
-                return aggregate;
-            }
-        }
-        return "instant";
-    }
-
-    toInstant(register: RegisterId | RegisterDefinition) {
-        const registerId = getRegisterId(register);
-        for (const prefix of Object.values(aggregatePrefixes)) {
-            if (prefix.length && isPrefix(registerId, prefix)) {
-                const tail = registerId.substr(prefix.length);
-                return <RegisterId>(tail[0].toLowerCase() + tail.substr(1));
-            }
-        }
-        return registerId;
-    }
-
-    toAggregate(register: RegisterId | RegisterDefinition, aggregate: AggregateId) {
-        const instantRegisterId = this.toInstant(register);
-        if (aggregate === "instant") {
-            return instantRegisterId;
-        }
-        const prefix = aggregatePrefixes[aggregate];
-        return <RegisterId>(prefix + instantRegisterId[0].toUpperCase() + instantRegisterId.substr(1));
-    }
-}
-
-export function isPrefix(registerId: RegisterId, prefix: string) {
-    return registerId.startsWith(prefix) && isUppercase(registerId[prefix.length]);
-}
-
-function isUppercase(input: string) {
-    return input.toUpperCase() === input;
-}
-
-export const RegisterConvention = new Convention();
+import type { RegisterDefinition } from "./register-definition";
+import { AggregateId } from "./aggregate-id";
+import type { RegisterId } from "./register-id";
+import { getRegisterId } from "./register-utils";
+
+export const aggregatePrefixes: { [aggregateId in AggregateId]: string } = {
+    instant: "",
+    diff: "diff",
+    min: "min",
+    max: "max",
+    avg: "avg",
+    sum: "sum",
+    cnt: "cnt",
+    ssq: "ssq",
+};
+
+class Convention {
+    public getAggregate(register: RegisterId | RegisterDefinition) {
+        const registerId = getRegisterId(register);
+        // Brute force all prefixes - if none of them, then it must be instant.
+        for (const aggregateString of Object.keys(aggregatePrefixes)) {
+            const aggregate = <AggregateId>aggregateString;
+            const prefix = aggregatePrefixes[aggregate];
+            if (prefix.length && isPrefix(registerId, prefix)) {
+                // Not instant - it was any of the others.
+                return aggregate;
+            }
+        }
+        return "instant";
+    }
+
+    toInstant(register: RegisterId | RegisterDefinition) {
+        const registerId = getRegisterId(register);
+        for (const prefix of Object.values(aggregatePrefixes)) {
+            if (prefix.length && isPrefix(registerId, prefix)) {
+                const tail = registerId.substr(prefix.length);
+                return <RegisterId>(tail[0].toLowerCase() + tail.substr(1));
+            }
+        }
+        return registerId;
+    }
+
+    toAggregate(
+        register: RegisterId | RegisterDefinition,
+        aggregate: AggregateId,
+    ) {
+        const instantRegisterId = this.toInstant(register);
+        if (aggregate === "instant") {
+            return instantRegisterId;
+        }
+        const prefix = aggregatePrefixes[aggregate];
+        return <RegisterId>(
+            (prefix +
+                instantRegisterId[0].toUpperCase() +
+                instantRegisterId.substr(1))
+        );
+    }
+}
+
+export function isPrefix(registerId: RegisterId, prefix: string) {
+    return (
+        registerId.startsWith(prefix) && isUppercase(registerId[prefix.length])
+    );
+}
+
+function isUppercase(input: string) {
+    return input.toUpperCase() === input;
+}
+
+export const RegisterConvention = new Convention();

package/src/register-definition.ts

@@ -1,17 +1,23 @@
-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;
-}
+import type { AggregateId } from "./aggregate-id";
+import type { MeasureId } from "./measure-id";
+import type { RegisterId } from "./register-id";
+import type { UnitId } from "./unit-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,288 @@
-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"
+    | "heatEnergyTariff1"
+    | "diffHeatEnergyTariff1"
+    | "cntHeatEnergyTariff1"
+    | "heatEnergyTariff1VolumeInInlet"
+    | "diffHeatEnergyTariff1VolumeInInlet"
+    | "cntHeatEnergyTariff1VolumeInInlet"
+    | "heatEnergyTariff1VolumeInOutlet"
+    | "diffHeatEnergyTariff1VolumeInOutlet"
+    | "cntHeatEnergyTariff1VolumeInOutlet"
+    | "heatEnergyTariff2"
+    | "diffHeatEnergyTariff2"
+    | "cntHeatEnergyTariff2"
+    | "heatEnergyTariff2VolumeInInlet"
+    | "diffHeatEnergyTariff2VolumeInInlet"
+    | "cntHeatEnergyTariff2VolumeInInlet"
+    | "heatEnergyTariff2VolumeInOutlet"
+    | "diffHeatEnergyTariff2VolumeInOutlet"
+    | "cntHeatEnergyTariff2VolumeInOutlet"
+    | "volume"
+    | "diffVolume"
+    | "cntVolume"
+    | "inletVolume"
+    | "diffInletVolume"
+    | "cntInletVolume"
+    | "outletVolume"
+    | "diffOutletVolume"
+    | "cntOutletVolume"
+    | "pulseInputAVolume"
+    | "diffPulseInputAVolume"
+    | "cntPulseInputAVolume"
+    | "pulseInputBVolume"
+    | "diffPulseInputBVolume"
+    | "cntPulseInputBVolume"
+    | "mass"
+    | "diffMass"
+    | "cntMass"
+    | "inletMass"
+    | "diffInletMass"
+    | "cntInletMass"
+    | "outletMass"
+    | "diffOutletMass"
+    | "cntOutletMass"
+    | "pressure"
+    | "maxPressure"
+    | "minPressure"
+    | "avgPressure"
+    | "sumPressure"
+    | "cntPressure"
+    | "ssqPressure"
+    | "inletPressure"
+    | "maxInletPressure"
+    | "minInletPressure"
+    | "avgInletPressure"
+    | "sumInletPressure"
+    | "cntInletPressure"
+    | "ssqInletPressure"
+    | "outletPressure"
+    | "maxOutletPressure"
+    | "minOutletPressure"
+    | "avgOutletPressure"
+    | "sumOutletPressure"
+    | "cntOutletPressure"
+    | "ssqOutletPressure"
+    | "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"
+    | "auxFlowTemperature"
+    | "maxAuxFlowTemperature"
+    | "minAuxFlowTemperature"
+    | "avgAuxFlowTemperature"
+    | "sumAuxFlowTemperature"
+    | "cntAuxFlowTemperature"
+    | "ssqAuxFlowTemperature"
+    | "acousticNoise"
+    | "maxAcousticNoise"
+    | "minAcousticNoise"
+    | "avgAcousticNoise"
+    | "sumAcousticNoise"
+    | "cntAcousticNoise"
+    | "ssqAcousticNoise"
+    | "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"
+    | "msisdnDeviceAddresses"
+    | "deviceRegisters"
+    | "devicePermanentVolumeFlow"
+    | "deviceNominalDiameter"
+    | "place"
+    | "lastPlace"
+    | "mBusFormatStringSignature"
+    | "deviceSoftwareVersion"
+    | "legacyDeviceSamples"
+    | "deviceSamplesOnLastMount"
+    | "deviceSamplesOnLastUnmount"
+    | "consumer"
+    | "kamstrupMulticalInfocodeType1"
+    | "kamstrupMulticalInfocodeType2"
+    | "kamstrupMulticalInfocodeType3"
+    | "kamstrupMulticalInfocodeType4"
+    | "kamstrupMulticalInfocodeType5"
+    | "kamstrupMulticalInfocodeType6"
+    | "kamstrupMulticalInfocodeType7"
+    | "kamstrupMulticalInfocode"
+    | "kamstrupModuleType"
+    | "diehlInfocodeType1"
+    | "diehlInfocodeType2"
+    | "diehlInfocodeType3"
+    | "diehlInfocodeType4"
+    | "diehlInfocodeType5"
+    | "diehlInfocode"
+    | "landisGyrMBusStatusType1"
+    | "landisGyrMBusStatusType2"
+    | "landisGyrMBusStatus"
+    | "landisGyrInfocodeType1"
+    | "landisGyrInfocodeType2"
+    | "landisGyrInfocode"
+    | "axiomaInfocodeType1"
+    | "axiomaInfocode"
+    | "infocode";