motion-master-client 0.0.77 → 0.0.86

package/src/lib/device.js

@@ -1,3 +1,167 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertFeedConstantAffectedVelocityValue = exports.convertFeedConstantAffectedPositionValue = exports.convertSiUnitVelocityAffectedValue = exports.siUnitVelocityScales = exports.parseDeviceLogContent = exports.parseDeviceLog = exports.isValidDeviceRefObj = exports.isValidDeviceRef = exports.isDeviceRef = exports.makeDeviceRefObj = exports.ensureDeviceRef = exports.getDeviceRefFromDeviceRefObj = void 0;
+function getDeviceRefFromDeviceRefObj(deviceRefObj) {
+    for (const [_, value] of Object.entries(deviceRefObj)) {
+        if (value !== undefined) {
+            return value;
+        }
+    }
+    return null;
+}
+exports.getDeviceRefFromDeviceRefObj = getDeviceRefFromDeviceRefObj;
+function ensureDeviceRef(deviceRef) {
+    const n = Number(deviceRef);
+    return isNaN(n) ? deviceRef : n;
+}
+exports.ensureDeviceRef = ensureDeviceRef;
+function makeDeviceRefObj(deviceRef) {
+    deviceRef = ensureDeviceRef(deviceRef);
+    if (typeof deviceRef === 'number') {
+        if (deviceRef <= 0xFFFF) {
+            return { devicePosition: deviceRef };
+        }
+        else {
+            return { deviceAddress: deviceRef };
+        }
+    }
+    else {
+        return { deviceSerialNumber: deviceRef };
+    }
+}
+exports.makeDeviceRefObj = makeDeviceRefObj;
+function isDeviceRef(deviceRef) {
+    return (typeof deviceRef === 'number' && deviceRef >= 0) || typeof deviceRef === 'string';
+}
+exports.isDeviceRef = isDeviceRef;
+function isValidDeviceRef(deviceRef) {
+    return deviceRef !== undefined && isDeviceRef(deviceRef);
+}
+exports.isValidDeviceRef = isValidDeviceRef;
+function isValidDeviceRefObj(obj) {
+    return Number.isFinite(Number(obj.deviceAddress))
+        || (typeof obj.devicePosition === 'number' && obj.devicePosition >= 0)
+        || typeof obj.deviceSerialNumber === 'string';
+}
+exports.isValidDeviceRefObj = isValidDeviceRefObj;
+function parseDeviceLog(line) {
+    const re = /^(\d{2}:\d{2}:\d{2}\.\d+)\s(.*)\|(.*)$/gm;
+    const result = re.exec(line);
+    if (result) {
+        return {
+            time: result[1].trim(),
+            level: result[2].trim(),
+            message: result[3].trim(),
+        };
+    }
+    return;
+}
+exports.parseDeviceLog = parseDeviceLog;
+function parseDeviceLogContent(content) {
+    return content.split('\n')
+        .map((v) => parseDeviceLog(v))
+        .filter((l) => l !== undefined);
+}
+exports.parseDeviceLogContent = parseDeviceLogContent;
+/**
+ * These are the user-defined velocity units and scales.
+ * For more information, see the description of 0x60A9:00 SI unit velocity object.
+ */
+exports.siUnitVelocityScales = {
+    0x00B44700: {
+        scale: 1,
+        unit: 'RPM',
+        type: 'minute',
+    },
+    0xFFB44700: {
+        scale: 0.1,
+        unit: 'dRPM',
+        type: 'minute',
+    },
+    0xFEB44700: {
+        scale: 0.01,
+        unit: 'cRPM',
+        type: 'minute',
+    },
+    0xFDB44700: {
+        scale: 0.001,
+        unit: 'mRPM',
+        type: 'minute',
+    },
+    0x00B40300: {
+        scale: 1,
+        unit: 'RPS',
+        type: 'second',
+    },
+    0xFFB40300: {
+        scale: 0.1,
+        unit: 'dRPS',
+        type: 'second',
+    },
+    0xFEB40300: {
+        scale: 0.01,
+        unit: 'cRPS',
+        type: 'second',
+    },
+    0xFDB40300: {
+        scale: 0.001,
+        unit: 'mRPS',
+        type: 'second',
+    },
+};
+/**
+ * Use this function when SI unit velocity changes to update the affected parameters.
+ * @example When changing from RPM to mRPM, a value of 2,500 will convert to 2,500,000.
+ */
+function convertSiUnitVelocityAffectedValue(value, oldSiUnitVelocity, newSiUnitVelocity) {
+    const oldScale = exports.siUnitVelocityScales[oldSiUnitVelocity];
+    const newScale = exports.siUnitVelocityScales[newSiUnitVelocity];
+    if (oldScale.type === newScale.type) {
+        return Math.round(oldScale.scale / newScale.scale * value);
+    }
+    else if (oldScale.type === 'minute' && newScale.type === 'second') {
+        return Math.round(oldScale.scale / newScale.scale * value / 60);
+    }
+    else if (oldScale.type === 'second' && newScale.type === 'minute') {
+        return Math.round(oldScale.scale / newScale.scale * value * 60);
+    }
+    return;
+}
+exports.convertSiUnitVelocityAffectedValue = convertSiUnitVelocityAffectedValue;
+/**
+ * Use this function when the Feed constant changes to update the position affected parameters.
+ * Depending on whether the Feed constant gets disabled, enabled, or its value changes, the function will perform conversion, inversion, or scaling.
+ */
+function convertFeedConstantAffectedPositionValue(value, oldFeedConstant, newFeedConstant, resolution) {
+    let out = value;
+    if (oldFeedConstant === 0xFFFFFFFF && (newFeedConstant > 0 && newFeedConstant < 0xFFFFFFFF)) { // conversion
+        out = Math.round(value * newFeedConstant / resolution);
+    }
+    else if ((oldFeedConstant > 0 && oldFeedConstant < 0xFFFFFFFF) && (newFeedConstant > 0 && newFeedConstant < 0xFFFFFFFF)) { // scaling
+        out = Math.round(newFeedConstant / oldFeedConstant * value);
+    }
+    else if ((oldFeedConstant > 0 && oldFeedConstant < 0xFFFFFFFF) && newFeedConstant === 0xFFFFFFFF) { // inversion
+        out = Math.round(value / oldFeedConstant * resolution);
+    }
+    return out;
+}
+exports.convertFeedConstantAffectedPositionValue = convertFeedConstantAffectedPositionValue;
+/**
+ * Use this function when the Feed constant changes to update the velocity affected parameters.
+ * Depending on whether the Feed constant gets disabled, enabled, or its value changes, the function will perform conversion, inversion, or scaling.
+ */
+function convertFeedConstantAffectedVelocityValue(value, oldFeedConstant, newFeedConstant) {
+    let out = value;
+    if (oldFeedConstant === 0xFFFFFFFF && (newFeedConstant > 0 && newFeedConstant < 0xFFFFFFFF)) { // conversion
+        out = Math.round(value * newFeedConstant);
+    }
+    else if ((oldFeedConstant > 0 && oldFeedConstant < 0xFFFFFFFF) && (newFeedConstant > 0 && newFeedConstant < 0xFFFFFFFF)) { // scaling
+        out = Math.round(newFeedConstant / oldFeedConstant * value);
+    }
+    else if ((oldFeedConstant > 0 && oldFeedConstant < 0xFFFFFFFF) && newFeedConstant === 0xFFFFFFFF) { // inversion
+        out = Math.round(value / oldFeedConstant);
+    }
+    return out;
+}
+exports.convertFeedConstantAffectedVelocityValue = convertFeedConstantAffectedVelocityValue;
 //# sourceMappingURL=device.js.map

package/src/lib/device.js.map

@@ -1 +1 @@
-{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/device.ts"],"names":[],"mappings":""}
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/device.ts"],"names":[],"mappings":";;;AAaA,SAAgB,4BAA4B,CAAC,YAA0B;IACrE,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QACrD,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,KAAK,CAAC;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAPD,oEAOC;AAED,SAAgB,eAAe,CAAC,SAAoB;IAClD,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC5B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAHD,0CAGC;AAED,SAAgB,gBAAgB,CAAC,SAAoB;IACnD,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IACvC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,IAAI,SAAS,IAAI,MAAM,EAAE;YACvB,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;SACtC;aAAM;YACL,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;SACrC;KACF;SAAM;QACL,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,CAAC;KAC1C;AACH,CAAC;AAXD,4CAWC;AAED,SAAgB,WAAW,CAAC,SAAc;IACxC,OAAO,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,IAAI,CAAC,CAAC,IAAI,OAAO,SAAS,KAAK,QAAQ,CAAC;AAC5F,CAAC;AAFD,kCAEC;AAED,SAAgB,gBAAgB,CAAC,SAAqB;IACpD,OAAO,SAAS,KAAK,SAAS,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC;AAC3D,CAAC;AAFD,4CAEC;AAED,SAAgB,mBAAmB,CAAC,GAAiB;IACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;WAC5C,CAAC,OAAO,GAAG,CAAC,cAAc,KAAK,QAAQ,IAAI,GAAG,CAAC,cAAc,IAAI,CAAC,CAAC;WACnE,OAAO,GAAG,CAAC,kBAAkB,KAAK,QAAQ,CAAC;AAClD,CAAC;AAJD,kDAIC;AAED,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,EAAE,GAAG,0CAA0C,CAAC;IACtD,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,IAAI,MAAM,EAAE;QACV,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YACtB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YACvB,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;SAC1B,CAAC;KACH;IACD,OAAO;AACT,CAAC;AAXD,wCAWC;AAED,SAAgB,qBAAqB,CAAC,OAAe;IACnD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;SACvB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;SAC7B,MAAM,CAAC,CAAC,CAAC,EAAsB,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;AACxD,CAAC;AAJD,sDAIC;AAQD;;;GAGG;AACU,QAAA,oBAAoB,GAA2C;IAC1E,UAAU,EAAE;QACV,KAAK,EAAE,CAAC;QACR,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,CAAC;QACR,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,QAAQ;KACf;IACD,UAAU,EAAE;QACV,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,QAAQ;KACf;CACF,CAAC;AAEF;;;GAGG;AACH,SAAgB,kCAAkC,CAAC,KAAa,EAAE,iBAAyB,EAAE,iBAAyB;IACpH,MAAM,QAAQ,GAAG,4BAAoB,CAAC,iBAAiB,CAAC,CAAC;IACzD,MAAM,QAAQ,GAAG,4BAAoB,CAAC,iBAAiB,CAAC,CAAC;IAEzD,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;KAC5D;SAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;QACnE,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,GAAG,KAAK,GAAG,EAAE,CAAC,CAAC;KACjE;SAAM,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;QACnE,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,GAAG,KAAK,GAAG,EAAE,CAAC,CAAC;KACjE;IAED,OAAO;AACT,CAAC;AAbD,gFAaC;AAED;;;GAGG;AACH,SAAgB,wCAAwC,CAAC,KAAa,EAAE,eAAuB,EAAE,eAAuB,EAAE,UAAkB;IAC1I,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,IAAI,eAAe,KAAK,UAAU,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,UAAU,CAAC,EAAE,EAAE,aAAa;QAC1G,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,eAAe,GAAG,UAAU,CAAC,CAAC;KACxD;SAAM,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,UAAU,CAAC,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,UAAU,CAAC,EAAE,EAAE,UAAU;QACrI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,eAAe,GAAG,KAAK,CAAC,CAAC;KAC7D;SAAM,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,UAAU,CAAC,IAAI,eAAe,KAAK,UAAU,EAAE,EAAE,YAAY;QAChH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,eAAe,GAAG,UAAU,CAAC,CAAC;KACxD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAVD,4FAUC;AAED;;;GAGG;AACH,SAAgB,wCAAwC,CAAC,KAAa,EAAE,eAAuB,EAAE,eAAuB;IACtH,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,IAAI,eAAe,KAAK,UAAU,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,UAAU,CAAC,EAAE,EAAE,aAAa;QAC1G,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,eAAe,CAAC,CAAC;KAC3C;SAAM,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,UAAU,CAAC,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,UAAU,CAAC,EAAE,EAAE,UAAU;QACrI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,eAAe,GAAG,KAAK,CAAC,CAAC;KAC7D;SAAM,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,UAAU,CAAC,IAAI,eAAe,KAAK,UAAU,EAAE,EAAE,YAAY;QAChH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,eAAe,CAAC,CAAC;KAC3C;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAVD,4FAUC"}

package/src/lib/encoder-register.d.ts

@@ -1,16 +1,16 @@
-export declare enum EncoderRegisterAddress {
-    STATUS0 = 118,
-    STATUS1 = 119,
-    OUT_ZERO_OUT_MSB = 17
-}
-export interface EncoderRegisterError {
-    name: string;
-    error: string;
-    description: string;
-    remedy: string;
-    fullDescription: string;
-}
-export declare const encoderRegisterErrors: {
-    [key: number]: EncoderRegisterError;
-}[];
-export declare function mapEncoderRegisterValueToErrors(registerValue: number, statusIndex: 0 | 1): EncoderRegisterError[];
+export declare enum EncoderRegisterAddress {
+    STATUS0 = 118,
+    STATUS1 = 119,
+    OUT_ZERO_OUT_MSB = 17
+}
+export interface EncoderRegisterError {
+    name: string;
+    error: string;
+    description: string;
+    remedy: string;
+    fullDescription: string;
+}
+export declare const encoderRegisterErrors: {
+    [key: number]: EncoderRegisterError;
+}[];
+export declare function mapEncoderRegisterValueToErrors(registerValue: number, statusIndex: 0 | 1): EncoderRegisterError[];

package/src/lib/encoder-register.js

@@ -1,117 +1,117 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapEncoderRegisterValueToErrors = exports.encoderRegisterErrors = exports.EncoderRegisterAddress = void 0;
-var EncoderRegisterAddress;
-(function (EncoderRegisterAddress) {
-    EncoderRegisterAddress[EncoderRegisterAddress["STATUS0"] = 118] = "STATUS0";
-    EncoderRegisterAddress[EncoderRegisterAddress["STATUS1"] = 119] = "STATUS1";
-    EncoderRegisterAddress[EncoderRegisterAddress["OUT_ZERO_OUT_MSB"] = 17] = "OUT_ZERO_OUT_MSB";
-})(EncoderRegisterAddress = exports.EncoderRegisterAddress || (exports.EncoderRegisterAddress = {}));
-;
-;
-exports.encoderRegisterErrors = [
-    {
-        1: {
-            name: "AM_MIN",
-            error: "Signal error: poor level (master track)",
-            description: "Magnetic field strength is too low for encoder operation.",
-            remedy: "Check positioning of the encoder ring.",
-            fullDescription: "An encoder magnetic ring is too far from the encoder chip or isn't detected. Check the mechanical assembly. In some rare cases can be provoked by demagnetized ring or field strength drop due to high temperatures. A magnetic ring is too far from the encoder chip. Check the mechanical assembly."
-        },
-        2: {
-            name: "AM_MAX",
-            error: "Signal error: clipping (master track)",
-            description: "Magnetic field strength is too high.",
-            remedy: "Check mechanical assembly and external fields.",
-            fullDescription: "The outer track of the encoder chip detects too strong a field. Typically, it can't be generated by the magnetic ring itself at normal conditions. Please check the influence of external fields, especially brakes. A magnetic ring is too close to the encoder chip. Check the mechanical assembly."
-        },
-        4: {
-            name: "AN_MIN",
-            error: "Signal error: poor level (nonius track)",
-            description: "Magnetic field strength is too low for encoder operation.",
-            remedy: "Check positioning of the encoder ring.",
-            fullDescription: "An encoder magnetic ring is too far from the encoder chip or isn't detected. Check the mechanical assembly. In some rare cases can be provoked by demagnetized ring or field strength drop due to high temperatures."
-        },
-        8: {
-            name: "AN_MAX",
-            error: "Signal error: clipping (nonius track)",
-            description: "Magnetic field strength is too high.",
-            remedy: "Check mechanical assembly and external fields.",
-            fullDescription: "The inner track of the encoder chip detects too strong a field. Typically, it can't be generated by the magnetic ring itself at normal conditions. Please check the influence of external fields, especially brakes."
-        },
-        16: {
-            name: "STUP",
-            error: "Startup iC-MU",
-            description: "Encoder startup error. Can appear during Multiturn configuration.",
-            remedy: "Power cycle the drive.",
-            fullDescription: "Encoder initialization error. The typical reason is: not saved Multiturn Counter configuration. Connect the multiturn battery, check the battery voltage, configure the multiturn bits in OBLAC Drives, configure internal encoder and save changes. Power cycle the drive. If the error is always present, contact support."
-        },
-    },
-    {
-        2: {
-            name: "FRQ_CNV",
-            error: "Excessive signal frequency for internal 12 Bit converter",
-            description: "Encoder maximum speed was exceeded.",
-            remedy: "",
-            fullDescription: "Encoder maximum speed was exceeded. Circulo 7 - 12000 RPM or Circulo 9 - 6000 RPM"
-        },
-        4: {
-            name: "FRQ_ABZ",
-            error: "Excessive signal frequency for ABZ-converter",
-            description: "Encoder maximum speed was exceeded.",
-            remedy: "",
-            fullDescription: "Encoder maximum speed was exceeded. Circulo 7 - 12000 RPM or Circulo 9 - 6000 RPM"
-        },
-        8: {
-            name: "NON_CTR",
-            error: "Period counter consistency error: counted period <-> calculated Nonius position",
-            description: "Internal Encoder calibration parameters are outdated or non-existing.",
-            remedy: "Please calibrate the internal encoder.",
-            fullDescription: "The absolute position value can't be computed reliably at the current position. This can be caused by: encoder wasn't calibrated, change of encoder mechanics, severe thermal expansion or magnetic target damage. Run diagnostics and repeat the calibration procedure. If this error prevents you from performing calibration - disable it or contact support."
-        },
-        16: {
-            name: "MT_CTR",
-            error: "Multiturn data consistency error: counted multiturn <-> external MT data",
-            description: "Multiturn Counter synchronization error.",
-            remedy: "Check MT configuration, connect a battery. Power cycle the drive.",
-            fullDescription: "Can happen because of not saved Multiturn Counter configuration. Connect the multiturn battery, check the battery voltage, configure the multiturn bits in OBLAC Drives, configure internal encoder and save changes. If the error is still present, please contact support."
-        },
-        32: {
-            name: "MT_ERR",
-            error: "Multiturn communication error: MTD line not 1 when trying to read MT data, MTD line is not 0 right after the last clock pulse, or SSI error bit active on MT interface",
-            description: "Multiturn Counter communication error.",
-            remedy: "Check MT configuration, connect a battery. Power cycle the drive.",
-            fullDescription: "The Multiturn counter is in error state. Connect the multiturn battery, check the battery voltage, configure the multiturn bits in OBLAC Drives, configure internal encoder and save changes. Power cycle the drive. If the error is still present, please contact support."
-        },
-        64: {
-            name: "EPR_ERR",
-            error: "I2C communication error: No EEPROM or I2C communication error",
-            description: "Encoder EEPROM memory communication error.",
-            remedy: "Power Cycle the drive.",
-            fullDescription: "Communication with the EEPROM memory of the chip is distorted. Power Cycle the drive. If this can't be reset, there is a hardware problem. Please contact support."
-        },
-        128: {
-            name: "",
-            error: "Invalid check sum internal RAM",
-            description: "Invalid check sum internal RAM",
-            remedy: "",
-            fullDescription: ""
-        },
-    }
-];
-function mapEncoderRegisterValueToErrors(registerValue, statusIndex) {
-    const errors = [];
-    let i = 1;
-    while (i < 256) {
-        if ((registerValue & i) === i) {
-            const error = exports.encoderRegisterErrors[statusIndex][i];
-            if (error) {
-                errors.push(error);
-            }
-        }
-        i *= 2;
-    }
-    return errors;
-}
-exports.mapEncoderRegisterValueToErrors = mapEncoderRegisterValueToErrors;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapEncoderRegisterValueToErrors = exports.encoderRegisterErrors = exports.EncoderRegisterAddress = void 0;
+var EncoderRegisterAddress;
+(function (EncoderRegisterAddress) {
+    EncoderRegisterAddress[EncoderRegisterAddress["STATUS0"] = 118] = "STATUS0";
+    EncoderRegisterAddress[EncoderRegisterAddress["STATUS1"] = 119] = "STATUS1";
+    EncoderRegisterAddress[EncoderRegisterAddress["OUT_ZERO_OUT_MSB"] = 17] = "OUT_ZERO_OUT_MSB";
+})(EncoderRegisterAddress = exports.EncoderRegisterAddress || (exports.EncoderRegisterAddress = {}));
+;
+;
+exports.encoderRegisterErrors = [
+    {
+        1: {
+            name: "AM_MIN",
+            error: "Signal error: poor level (master track)",
+            description: "Magnetic field strength is too low for encoder operation.",
+            remedy: "Check positioning of the encoder ring.",
+            fullDescription: "An encoder magnetic ring is too far from the encoder chip or isn't detected. Check the mechanical assembly. In some rare cases can be provoked by demagnetized ring or field strength drop due to high temperatures. A magnetic ring is too far from the encoder chip. Check the mechanical assembly."
+        },
+        2: {
+            name: "AM_MAX",
+            error: "Signal error: clipping (master track)",
+            description: "Magnetic field strength is too high.",
+            remedy: "Check mechanical assembly and external fields.",
+            fullDescription: "The outer track of the encoder chip detects too strong a field. Typically, it can't be generated by the magnetic ring itself at normal conditions. Please check the influence of external fields, especially brakes. A magnetic ring is too close to the encoder chip. Check the mechanical assembly."
+        },
+        4: {
+            name: "AN_MIN",
+            error: "Signal error: poor level (nonius track)",
+            description: "Magnetic field strength is too low for encoder operation.",
+            remedy: "Check positioning of the encoder ring.",
+            fullDescription: "An encoder magnetic ring is too far from the encoder chip or isn't detected. Check the mechanical assembly. In some rare cases can be provoked by demagnetized ring or field strength drop due to high temperatures."
+        },
+        8: {
+            name: "AN_MAX",
+            error: "Signal error: clipping (nonius track)",
+            description: "Magnetic field strength is too high.",
+            remedy: "Check mechanical assembly and external fields.",
+            fullDescription: "The inner track of the encoder chip detects too strong a field. Typically, it can't be generated by the magnetic ring itself at normal conditions. Please check the influence of external fields, especially brakes."
+        },
+        16: {
+            name: "STUP",
+            error: "Startup iC-MU",
+            description: "Encoder startup error. Can appear during Multiturn configuration.",
+            remedy: "Power cycle the drive.",
+            fullDescription: "Encoder initialization error. The typical reason is: not saved Multiturn Counter configuration. Connect the multiturn battery, check the battery voltage, configure the multiturn bits in OBLAC Drives, configure internal encoder and save changes. Power cycle the drive. If the error is always present, contact support."
+        },
+    },
+    {
+        2: {
+            name: "FRQ_CNV",
+            error: "Excessive signal frequency for internal 12 Bit converter",
+            description: "Encoder maximum speed was exceeded.",
+            remedy: "",
+            fullDescription: "Encoder maximum speed was exceeded. Circulo 7 - 12000 RPM or Circulo 9 - 6000 RPM"
+        },
+        4: {
+            name: "FRQ_ABZ",
+            error: "Excessive signal frequency for ABZ-converter",
+            description: "Encoder maximum speed was exceeded.",
+            remedy: "",
+            fullDescription: "Encoder maximum speed was exceeded. Circulo 7 - 12000 RPM or Circulo 9 - 6000 RPM"
+        },
+        8: {
+            name: "NON_CTR",
+            error: "Period counter consistency error: counted period <-> calculated Nonius position",
+            description: "Internal Encoder calibration parameters are outdated or non-existing.",
+            remedy: "Please calibrate the internal encoder.",
+            fullDescription: "The absolute position value can't be computed reliably at the current position. This can be caused by: encoder wasn't calibrated, change of encoder mechanics, severe thermal expansion or magnetic target damage. Run diagnostics and repeat the calibration procedure. If this error prevents you from performing calibration - disable it or contact support."
+        },
+        16: {
+            name: "MT_CTR",
+            error: "Multiturn data consistency error: counted multiturn <-> external MT data",
+            description: "Multiturn Counter synchronization error.",
+            remedy: "Check MT configuration, connect a battery. Power cycle the drive.",
+            fullDescription: "Can happen because of not saved Multiturn Counter configuration. Connect the multiturn battery, check the battery voltage, configure the multiturn bits in OBLAC Drives, configure internal encoder and save changes. If the error is still present, please contact support."
+        },
+        32: {
+            name: "MT_ERR",
+            error: "Multiturn communication error: MTD line not 1 when trying to read MT data, MTD line is not 0 right after the last clock pulse, or SSI error bit active on MT interface",
+            description: "Multiturn Counter communication error.",
+            remedy: "Check MT configuration, connect a battery. Power cycle the drive.",
+            fullDescription: "The Multiturn counter is in error state. Connect the multiturn battery, check the battery voltage, configure the multiturn bits in OBLAC Drives, configure internal encoder and save changes. Power cycle the drive. If the error is still present, please contact support."
+        },
+        64: {
+            name: "EPR_ERR",
+            error: "I2C communication error: No EEPROM or I2C communication error",
+            description: "Encoder EEPROM memory communication error.",
+            remedy: "Power Cycle the drive.",
+            fullDescription: "Communication with the EEPROM memory of the chip is distorted. Power Cycle the drive. If this can't be reset, there is a hardware problem. Please contact support."
+        },
+        128: {
+            name: "",
+            error: "Invalid check sum internal RAM",
+            description: "Invalid check sum internal RAM",
+            remedy: "",
+            fullDescription: ""
+        },
+    }
+];
+function mapEncoderRegisterValueToErrors(registerValue, statusIndex) {
+    const errors = [];
+    let i = 1;
+    while (i < 256) {
+        if ((registerValue & i) === i) {
+            const error = exports.encoderRegisterErrors[statusIndex][i];
+            if (error) {
+                errors.push(error);
+            }
+        }
+        i *= 2;
+    }
+    return errors;
+}
+exports.mapEncoderRegisterValueToErrors = mapEncoderRegisterValueToErrors;
 //# sourceMappingURL=encoder-register.js.map

package/src/lib/hardware-description.d.ts

@@ -1,46 +1,46 @@
-export interface HardwareComponent {
-    name: string;
-    version: string;
-    serialNumber: string;
-}
-export type AssemblyComponent = HardwareComponent;
-export type DeviceComponent = HardwareComponent;
-export interface Assembly {
-    name: string;
-    id: string;
-    version: string;
-    serialNumber: string;
-    components: AssemblyComponent[];
-}
-export interface HardwareDevice {
-    name: string;
-    id: string;
-    version: string;
-    keyId: string;
-    serialNumber: string;
-    macAddress: string;
-    components: DeviceComponent[];
-}
-/**
- * @link https://docs.google.com/document/d/1N00-ZjxHkjoWNIsnoTtza9CUHrxm8-e54298DXLuD94
- */
-export interface HardwareDescription {
-    fileVersion: string;
-    assembly?: Assembly;
-    device: HardwareDevice;
-}
-export declare function getIdFromHardwareDescription(hd: HardwareDescription): string;
-export declare function getApiIdentifierFromHardwareDescription(hd: HardwareDescription, skipKeyId?: boolean): string;
-export declare function getNameFromHardwareDescription(hd: HardwareDescription): string;
-export declare function getSerialNumberFromHardwareDescription(hd: HardwareDescription): string;
-export declare function getAllComponentsFromHardwareDescription(hd: HardwareDescription): HardwareComponent[];
-export declare function hardwareComponentsMatch(a: HardwareComponent[], b: HardwareComponent[]): boolean;
-export declare function isHardwareDescriptionCompatibleWithPackageFilename(hardwareDescription: HardwareDescription, packageFilename: string): boolean;
-export declare function getHardwareComponentsFromPackageFilename(packageFilename: string): HardwareComponent[];
-export declare function getVersionFromPackageFilename(packageFilename: string): string | undefined;
-export declare function getApiIdentifierFromPackageFilename(packageFilename: string): string | undefined;
-/**
- * This template is to be used in cases where hardware description file is not available on a device.
- * It is imperative to replace the serial number with a unique identifier.
- */
-export declare const dummyHardwareDescriptionFileContentTemplate: HardwareDescription;
+export interface HardwareComponent {
+    name: string;
+    version: string;
+    serialNumber: string;
+}
+export type AssemblyComponent = HardwareComponent;
+export type DeviceComponent = HardwareComponent;
+export interface Assembly {
+    name: string;
+    id: string;
+    version: string;
+    serialNumber: string;
+    components: AssemblyComponent[];
+}
+export interface HardwareDevice {
+    name: string;
+    id: string;
+    version: string;
+    keyId: string;
+    serialNumber: string;
+    macAddress: string;
+    components: DeviceComponent[];
+}
+/**
+ * @link https://docs.google.com/document/d/1N00-ZjxHkjoWNIsnoTtza9CUHrxm8-e54298DXLuD94
+ */
+export interface HardwareDescription {
+    fileVersion: string;
+    assembly?: Assembly;
+    device: HardwareDevice;
+}
+export declare function getIdFromHardwareDescription(hd: HardwareDescription): string;
+export declare function getApiIdentifierFromHardwareDescription(hd: HardwareDescription, skipKeyId?: boolean): string;
+export declare function getNameFromHardwareDescription(hd: HardwareDescription): string;
+export declare function getSerialNumberFromHardwareDescription(hd: HardwareDescription): string;
+export declare function getAllComponentsFromHardwareDescription(hd: HardwareDescription): HardwareComponent[];
+export declare function hardwareComponentsMatch(a: HardwareComponent[], b: HardwareComponent[]): boolean;
+export declare function isHardwareDescriptionCompatibleWithPackageFilename(hardwareDescription: HardwareDescription, packageFilename: string): boolean;
+export declare function getHardwareComponentsFromPackageFilename(packageFilename: string): HardwareComponent[];
+export declare function getVersionFromPackageFilename(packageFilename: string): string | undefined;
+export declare function getApiIdentifierFromPackageFilename(packageFilename: string): string | undefined;
+/**
+ * This template is to be used in cases where hardware description file is not available on a device.
+ * It is imperative to replace the serial number with a unique identifier.
+ */
+export declare const dummyHardwareDescriptionFileContentTemplate: HardwareDescription;