motion-master-client 0.0.65 → 0.0.67

package/src/lib/os-command.js

@@ -0,0 +1,270 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPhaseInductanceMeasurementOsCommand = exports.createPhaseResistanceMeasurementOsCommand = exports.createPolePairDetectionOsCommand = exports.openPhaseDetectionErrors = exports.createOpenPhaseDetectionOsCommand = exports.createCommutationOffsetMeasurementOsCommand = exports.createMotorPhaseOrderDetectionOsCommand = exports.createEncoderRegisterCommunicationOsCommand = exports.createOsCommandTypedArray = exports.osCommandErrorCode = exports.OsCommandId = exports.OsCommandMode = exports.parseOsCommandResponse = void 0;
+;
+function parseOsCommandResponse(response) {
+    const status = response.at(0);
+    if (status === undefined) {
+        throw new Error(`No status is available in the typed array response ${JSON.stringify(response)}`);
+    }
+    let data;
+    let errorCode;
+    let errorName;
+    let errorDescription;
+    let progress;
+    let request = 'started';
+    // Determine the status of the OS command.
+    if (status === 0 || status === 1) {
+        request = 'succeeded';
+    }
+    else if (status === 2 || status === 3) {
+        request = 'failed';
+    }
+    else if ((status >= 100 && status <= 200) || status === 255) {
+        request = 'running';
+    }
+    else {
+        throw new Error(`Unknown OS command response status: ${status}`);
+    }
+    // Command in progress with percentage.
+    if (status >= 100 && status <= 200) {
+        progress = status - 100;
+    }
+    // Command completed with error and with response.
+    if (status === 3) {
+        errorCode = response.at(2);
+        if (errorCode !== undefined) {
+            errorName = exports.osCommandErrorCode[errorCode];
+        }
+    }
+    if (status === 1) {
+        // 6 bytes for data when last command completed, no errors, response data available
+        data = Array.from(response.slice(2));
+    }
+    else if (status === 3) {
+        // 5 bytes for data when last command completed, error, response data available
+        data = Array.from(response.slice(3));
+    }
+    return { data, errorCode, errorName, errorDescription, progress, request, response };
+}
+exports.parseOsCommandResponse = parseOsCommandResponse;
+var OsCommandMode;
+(function (OsCommandMode) {
+    OsCommandMode[OsCommandMode["EXECUTE_THE_NEXT_COMMAND_IMMEDIATELY"] = 0] = "EXECUTE_THE_NEXT_COMMAND_IMMEDIATELY";
+    OsCommandMode[OsCommandMode["ABORT_THE_CURRENT_COMMAND_AND_ALL_COMMANDS_IN_THE_BUFFER"] = 3] = "ABORT_THE_CURRENT_COMMAND_AND_ALL_COMMANDS_IN_THE_BUFFER";
+})(OsCommandMode = exports.OsCommandMode || (exports.OsCommandMode = {}));
+;
+var OsCommandId;
+(function (OsCommandId) {
+    OsCommandId[OsCommandId["ENCODER_REGISTER_COMMUNICATION"] = 0] = "ENCODER_REGISTER_COMMUNICATION";
+    OsCommandId[OsCommandId["ICMU_CALIBRATION_MODE"] = 1] = "ICMU_CALIBRATION_MODE";
+    OsCommandId[OsCommandId["OPEN_LOOP_FIELD_MODE"] = 2] = "OPEN_LOOP_FIELD_MODE";
+    OsCommandId[OsCommandId["HRD_STREAMING"] = 3] = "HRD_STREAMING";
+    OsCommandId[OsCommandId["MOTOR_PHASE_ORDER_DETECTION"] = 4] = "MOTOR_PHASE_ORDER_DETECTION";
+    OsCommandId[OsCommandId["COMMUTATION_OFFSET_MEASUREMENT"] = 5] = "COMMUTATION_OFFSET_MEASUREMENT";
+    OsCommandId[OsCommandId["OPEN_PHASE_DETECTION"] = 6] = "OPEN_PHASE_DETECTION";
+    OsCommandId[OsCommandId["POLE_PAIR_DETECTION"] = 7] = "POLE_PAIR_DETECTION";
+    OsCommandId[OsCommandId["PHASE_RESISTANCE_MEASUREMENT"] = 8] = "PHASE_RESISTANCE_MEASUREMENT";
+    OsCommandId[OsCommandId["PHASE_INDUCTANCE_MEASUREMENT"] = 9] = "PHASE_INDUCTANCE_MEASUREMENT";
+    OsCommandId[OsCommandId["TORQUE_CONSTANT_MEASUREMENT"] = 10] = "TORQUE_CONSTANT_MEASUREMENT";
+    OsCommandId[OsCommandId["SMM"] = 11] = "SMM";
+})(OsCommandId = exports.OsCommandId || (exports.OsCommandId = {}));
+;
+exports.osCommandErrorCode = {
+    251: 'Command not allowed',
+    252: 'Command aborted',
+    253: 'Command timeout',
+    254: 'Command unsupported',
+};
+function createOsCommandTypedArray(elements) {
+    return new Uint8Array(elements.concat(new Array(8 - elements.length).fill(0)));
+}
+exports.createOsCommandTypedArray = createOsCommandTypedArray;
+/**
+ * OS command 0: Encoder register communication
+ *
+ * This OS command is utilized for reading or writing registers from an encoder service.
+ * Presently, the only service supporting this functionality is BiSS, but it can be easily extended to other encoder services.
+ * For more information on how BiSS register communication operates, please consult the official BiSS C Interface Protocol Description.
+ *
+ * |        | Bit 7 | Bit 6 | Bit 5 | Bit 4 | Bit 3 | Bit 2 | Bit 1 | Bit 0 |
+ * |--------|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|
+ * | Byte 0 |   0   |   0   |   0   |   0   |   0   |   0   |   0   |   0   |
+ * | Byte 1 |   -   |   -   |   -   |   -   |   -   |   A   |   A   |   A   |
+ * | Byte 2 |   B   |   B   |   B   |   B   |   B   |   B   |   B   |   C   |
+ * | Byte 3 |   D   |   D   |   D   |   D   |   D   |   D   |   D   |   D   |
+ * | Byte 4 |   E   |   E   |   E   |   E   |   E   |   E   |   E   |   E   |
+ * | Byte 5 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
+ * | Byte 6 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
+ * | Byte 7 |   -   |   -   |   -   |   -   |   -   |   -   |   -   |   -   |
+ *
+ * @param encoderOrdinal (A) 2^3=8 encoder ordinals. Counting starts from 1, so '1' refers to Encoder 1 configured in 0x2110.
+ * @param slaveAddress (B) 2^7=128 slave addresses. Select the address of the slave to read (BiSS protocol level). Since our BiSS service doesn't support multiple slaves in the same device, this value should always be 0.
+ * @param rw (C) Read or write the encoder register. Select the direction of the command: 0 for reading a register, and 1 for writing it.
+ * @param registerAddress (D) Register to be read/written.
+ * @param registerWriteValue (E) The value to write to the register. This value is ignored when reading a register (when rw is set to 0).
+ */
+function createEncoderRegisterCommunicationOsCommand(encoderOrdinal = 1, slaveAddress = 0, rw = 0, registerAddress = 0, registerWriteValue = 0) {
+    const byte2 = (slaveAddress << 1) | rw;
+    const elements = [OsCommandId.ENCODER_REGISTER_COMMUNICATION, encoderOrdinal, byte2, registerAddress, registerWriteValue];
+    return createOsCommandTypedArray(elements);
+}
+exports.createEncoderRegisterCommunicationOsCommand = createEncoderRegisterCommunicationOsCommand;
+;
+/**
+ * Command 4: Motor phase order detection
+ *
+ * This command is used to detect the order of the motor phases.
+ * When this command finishes successfully, the found value is automatically written to the object 0x2003:5 Motor phases inverted.
+ * This command rotates the motor.
+ *
+ * This OS command has no arguments.
+ *
+ * When the command finishes successfully, it will return a value of 0 for normal and 1 for inverted motor phases.
+ *
+ * This command doesn't have any command-specific OS error code, so this status will only happen when a general OS error code occurs.
+ *
+ * This command will report its progress without indicating a percentage.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled, there is no active limit switch,
+ * and the brake status is disengaged (in case there is a configured brake). If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (command not allowed).
+ */
+function createMotorPhaseOrderDetectionOsCommand() {
+    const elements = [OsCommandId.MOTOR_PHASE_ORDER_DETECTION];
+    return createOsCommandTypedArray(elements);
+}
+exports.createMotorPhaseOrderDetectionOsCommand = createMotorPhaseOrderDetectionOsCommand;
+;
+/**
+ * Command 5: Commutation offset measurement
+ *
+ * This command is used to measure the commutation angle offset.
+ * The configuration of the procedure is derived from the pre-existing and previously used commutation offset objects in the object dictionary.
+ * Upon successful completion of this command, the determined value is automatically written to:
+ * - 0x2001:00 Commutation angle offset
+ * - 0x2009:01 State is set to OFFSET_VALID
+ *
+ * In version 5.0, three different methods can be selected for command 5. These methods are named:
+ * - Commutation offset measurement - method 0
+ * - Commutation offset measurement - method 1
+ * - Commutation offset measurement - method 2
+ * Among these three methods, "method 0" and "method 1" involve rotating the rotor.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS) and the CIA402 state is Operation enabled.
+ * Additionally, if the commutation offset measurement method (0x2009:3) is set to 0 or 1,
+ * the command is permissible only when there are no active limit switches, and the brake status is disengaged (in case a brake is configured).
+ * If any of these conditions is not met during the execution of the command, the execution will be halted,
+ * and it will return the OS error code 251 (Command not allowed).
+ */
+function createCommutationOffsetMeasurementOsCommand() {
+    const elements = [OsCommandId.COMMUTATION_OFFSET_MEASUREMENT];
+    return createOsCommandTypedArray(elements);
+}
+exports.createCommutationOffsetMeasurementOsCommand = createCommutationOffsetMeasurementOsCommand;
+;
+/**
+ * Command 6: Open phase detection
+ *
+ * This command is used to detect whether one of the phases is open.
+ * It might rotate the motor if there is no brake or if it is disengaged.
+ *
+ * If this command finishes successfully, it indicates that all motor phases seem to be fine.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
+ * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (Command not allowed).
+ */
+function createOpenPhaseDetectionOsCommand() {
+    const elements = [OsCommandId.OPEN_PHASE_DETECTION];
+    return createOsCommandTypedArray(elements);
+}
+exports.createOpenPhaseDetectionOsCommand = createOpenPhaseDetectionOsCommand;
+;
+exports.openPhaseDetectionErrors = {
+    0: {
+        errorName: 'Open terminal A',
+        errorDescription: 'Terminal A of the Drive is not connected',
+    },
+    1: {
+        errorName: 'Open terminal B',
+        errorDescription: 'Terminal B of the Drive is not connected',
+    },
+    2: {
+        errorName: 'Open terminal C',
+        errorDescription: 'Terminal C of the Drive is not connected',
+    },
+    3: {
+        errorName: 'Open FET A high',
+        errorDescription: 'Upper FET in leg A of the Drive is not conducting (open circuit fault)',
+    },
+    4: {
+        errorName: 'Open FET A low',
+        errorDescription: 'Lower  FET in leg A of the Drive is not conducting (open circuit fault)',
+    },
+    5: {
+        errorName: 'Open FET B high',
+        errorDescription: 'Upper FET in leg B of the Drive is not conducting (open circuit fault)',
+    },
+    6: {
+        errorName: 'Open FET B low',
+        errorDescription: 'Lower  FET in leg B of the Drive is not conducting (open circuit fault)',
+    },
+    7: {
+        errorName: 'Open FET C high',
+        errorDescription: 'Upper FET in leg C of the Drive is not conducting (open circuit fault)',
+    },
+    8: {
+        errorName: 'Open FET C low',
+        errorDescription: 'Lower  FET in leg C of the Drive is not conducting (open circuit fault)',
+    },
+};
+/**
+ * Command 7: Pole pair detection
+ *
+ * This command is used to detect the number of pole pairs that the connected motor has.
+ * It requires the rotation of the rotor.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
+ * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (Command not allowed).
+ */
+function createPolePairDetectionOsCommand() {
+    const elements = [OsCommandId.POLE_PAIR_DETECTION];
+    return createOsCommandTypedArray(elements);
+}
+exports.createPolePairDetectionOsCommand = createPolePairDetectionOsCommand;
+;
+/**
+ * Command 8: Phase resistance measurement
+ *
+ * This command is used to measure the phase resistance of the motor in milliohms (mΩ).
+ * It might rotate the motor if there is no brake or if it is disengaged.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
+ * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (Command not allowed).
+ */
+function createPhaseResistanceMeasurementOsCommand() {
+    const elements = [OsCommandId.PHASE_RESISTANCE_MEASUREMENT];
+    return createOsCommandTypedArray(elements);
+}
+exports.createPhaseResistanceMeasurementOsCommand = createPhaseResistanceMeasurementOsCommand;
+;
+/**
+ * Command 9: Phase inductance measurement
+ *
+ * This command is used to measure the phase inductance of the motor in microhenries (μH).
+ * It might rotate the motor if there is no brake or if it is disengaged.
+ *
+ * This command can only be run when the opmode is -2 (OPMODE_DIAGNOSTICS), the CIA402 state is Operation enabled,
+ * and there is no limit switch active. If any of these conditions is not true during the execution of the command,
+ * the execution will stop, and it will return the OS error code 251 (Command not allowed).
+ */
+function createPhaseInductanceMeasurementOsCommand() {
+    const elements = [OsCommandId.PHASE_INDUCTANCE_MEASUREMENT];
+    return createOsCommandTypedArray(elements);
+}
+exports.createPhaseInductanceMeasurementOsCommand = createPhaseInductanceMeasurementOsCommand;
+;
+//# sourceMappingURL=os-command.js.map

package/src/lib/os-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"os-command.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/os-command.ts"],"names":[],"mappings":";;;AAUC,CAAC;AAEF,SAAgB,sBAAsB,CAAC,QAAoB;IACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE9B,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;KACnG;IAED,IAAI,IAA0B,CAAC;IAC/B,IAAI,SAA6B,CAAC;IAClC,IAAI,SAA6B,CAAC;IAClC,IAAI,gBAAoC,CAAC;IACzC,IAAI,QAA4B,CAAC;IACjC,IAAI,OAAO,GAAkB,SAAS,CAAC;IAEvC,0CAA0C;IAC1C,IAAI,MAAM,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,EAAE;QAChC,OAAO,GAAG,WAAW,CAAC;KACvB;SAAM,IAAI,MAAM,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,EAAE;QACvC,OAAO,GAAG,QAAQ,CAAC;KACpB;SAAM,IAAI,CAAC,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC,IAAI,MAAM,KAAK,GAAG,EAAE;QAC7D,OAAO,GAAG,SAAS,CAAC;KACrB;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,uCAAuC,MAAM,EAAE,CAAC,CAAC;KAClE;IAED,uCAAuC;IACvC,IAAI,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,EAAE;QAClC,QAAQ,GAAG,MAAM,GAAG,GAAG,CAAC;KACzB;IAED,kDAAkD;IAClD,IAAI,MAAM,KAAK,CAAC,EAAE;QAChB,SAAS,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,SAAS,GAAG,0BAAkB,CAAC,SAAS,CAAC,CAAC;SAC3C;KACF;IAED,IAAI,MAAM,KAAK,CAAC,EAAE;QAChB,mFAAmF;QACnF,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KACtC;SAAM,IAAI,MAAM,KAAK,CAAC,EAAE;QACvB,+EAA+E;QAC/E,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KACtC;IAED,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;AACvF,CAAC;AA/CD,wDA+CC;AAED,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,iHAAwC,CAAA;IACxC,yJAA4D,CAAA;AAC9D,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAAA,CAAC;AAEF,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB,iGAAkC,CAAA;IAClC,+EAAyB,CAAA;IACzB,6EAAwB,CAAA;IACxB,+DAAiB,CAAA;IACjB,2FAA+B,CAAA;IAC/B,iGAAkC,CAAA;IAClC,6EAAwB,CAAA;IACxB,2EAAuB,CAAA;IACvB,6FAAgC,CAAA;IAChC,6FAAgC,CAAA;IAChC,4FAAgC,CAAA;IAChC,4CAAQ,CAAA;AACV,CAAC,EAbW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAatB;AAAA,CAAC;AAEW,QAAA,kBAAkB,GAA8B;IAC3D,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,qBAAqB;CAC3B,CAAC;AAEF,SAAgB,yBAAyB,CAAC,QAAkB;IAC1D,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAFD,8DAEC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,2CAA2C,CAAC,iBAAyB,CAAC,EAAE,eAAuB,CAAC,EAAE,KAAa,CAAC,EAAE,kBAA0B,CAAC,EAAE,qBAA6B,CAAC;IAC3L,MAAM,KAAK,GAAG,CAAC,YAAY,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC;IACvC,MAAM,QAAQ,GAAa,CAAC,WAAW,CAAC,8BAA8B,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,EAAE,kBAAkB,CAAC,CAAC;IACpI,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAJD,kGAIC;AAIA,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,uCAAuC;IACrD,MAAM,QAAQ,GAAa,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC;IACrE,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAHD,0FAGC;AAIA,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,2CAA2C;IACzD,MAAM,QAAQ,GAAa,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;IACxE,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAHD,kGAGC;AAIA,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAgB,iCAAiC;IAC/C,MAAM,QAAQ,GAAa,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAC9D,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAHD,8EAGC;AAIA,CAAC;AAEW,QAAA,wBAAwB,GAAuE;IAC1G,CAAC,EAAE;QACD,SAAS,EAAE,iBAAiB;QAC5B,gBAAgB,EAAE,0CAA0C;KAC7D;IACD,CAAC,EAAE;QACD,SAAS,EAAE,iBAAiB;QAC5B,gBAAgB,EAAE,0CAA0C;KAC7D;IACD,CAAC,EAAE;QACD,SAAS,EAAE,iBAAiB;QAC5B,gBAAgB,EAAE,0CAA0C;KAC7D;IACD,CAAC,EAAE;QACD,SAAS,EAAE,iBAAiB;QAC5B,gBAAgB,EAAE,wEAAwE;KAC3F;IACD,CAAC,EAAE;QACD,SAAS,EAAE,gBAAgB;QAC3B,gBAAgB,EAAE,yEAAyE;KAC5F;IACD,CAAC,EAAE;QACD,SAAS,EAAE,iBAAiB;QAC5B,gBAAgB,EAAE,wEAAwE;KAC3F;IACD,CAAC,EAAE;QACD,SAAS,EAAE,gBAAgB;QAC3B,gBAAgB,EAAE,yEAAyE;KAC5F;IACD,CAAC,EAAE;QACD,SAAS,EAAE,iBAAiB;QAC5B,gBAAgB,EAAE,wEAAwE;KAC3F;IACD,CAAC,EAAE;QACD,SAAS,EAAE,gBAAgB;QAC3B,gBAAgB,EAAE,yEAAyE;KAC5F;CACF,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAgB,gCAAgC;IAC9C,MAAM,QAAQ,GAAa,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAC7D,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAHD,4EAGC;AAIA,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAgB,yCAAyC;IACvD,MAAM,QAAQ,GAAa,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAAC;IACtE,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAHD,8FAGC;AAIA,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAgB,yCAAyC;IACvD,MAAM,QAAQ,GAAa,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAAC;IACtE,OAAO,yBAAyB,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAHD,8FAGC;AAIA,CAAC"}

package/src/lib/types.d.ts

@@ -2,7 +2,32 @@ import { motionmaster } from "./motion-master.proto";
 export import MotionMasterMessage = motionmaster.MotionMasterMessage;
 export import IMotionMasterMessage = motionmaster.IMotionMasterMessage;
 export type StatusKey = keyof MotionMasterMessage.IStatus;
-export type RequestStatus = 'running' | 'succeeded' | 'failed';
+/**
+ * Request can be:
+ * - started on the client side,
+ * - running where Motion Master reports that the procedure is in progress,
+ * - succeeded if the request was completed successfully or the progress has reached 100%,
+ * - failed if anything goes wrong.
+ */
+export type RequestStatus = 'started' | 'running' | 'succeeded' | 'failed';
+export type StatusMessageExtension = {
+    request: RequestStatus;
+    messageId?: string;
+    /**
+     * @deprecated used in OBLAC Drives with the old client library to signify that a request has started
+     */
+    begin?: {
+        code?: (number | null);
+        message?: (string | null);
+    };
+    /**
+     * @deprecated used in OBLAC Drives with the old client library to signify that a request has timed out
+     */
+    timeout?: {
+        code?: (number | null);
+        message?: (string | null);
+    };
+};
 export declare class RequestError extends Error {
 }
 export type ParameterAddress = [number, number];
@@ -71,130 +96,37 @@ export type StopFullAutoTuningRequest = MotionMasterMessage.Request.IStopFullAut
 export type StartCirculoEncoderConfigurationRequest = MotionMasterMessage.Request.IStartCirculoEncoderConfiguration & DeviceRefObj;
 export type StopCirculoEncoderNarrowAngleCalibrationProcedureRequest = MotionMasterMessage.Request.IStopCirculoEncoderNarrowAngleCalibrationProcedure & DeviceRefObj;
 export type StartOsCommandRequest = MotionMasterMessage.Request.IStartOsCommand & DeviceRefObj;
-export type SystemVersionStatus = MotionMasterMessage.Status.ISystemVersion & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceInfoStatus = MotionMasterMessage.Status.IDeviceInfo & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceParameterInfoStatus = MotionMasterMessage.Status.IDeviceParameterInfo & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceParameterValuesStatus = MotionMasterMessage.Status.IDeviceParameterValues & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type MultiDeviceParameterValuesStatus = MotionMasterMessage.Status.IMultiDeviceParameterValues & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceFileListStatus = MotionMasterMessage.Status.IDeviceFileList & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceFileStatus = MotionMasterMessage.Status.IDeviceFile & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceFaultResetStatus = MotionMasterMessage.Status.IDeviceFaultReset & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceStopStatus = MotionMasterMessage.Status.IDeviceStop & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceFirmwareInstallationStatus = MotionMasterMessage.Status.IDeviceFirmwareInstallation & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceLogStatus = MotionMasterMessage.Status.IDeviceLog & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type CoggingTorqueRecordingStatus = MotionMasterMessage.Status.ICoggingTorqueRecording & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type CoggingTorqueDataStatus = MotionMasterMessage.Status.ICoggingTorqueData & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type OffsetDetectionStatus = MotionMasterMessage.Status.IOffsetDetection & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type PlantIdentificationStatus = MotionMasterMessage.Status.IPlantIdentification & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type AutoTuningStatus = MotionMasterMessage.Status.IAutoTuning & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type MotionControllerStatus = MotionMasterMessage.Status.IMotionController & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type SignalGeneratorStatus = MotionMasterMessage.Status.ISignalGenerator & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type MonitoringParameterValuesStatus = MotionMasterMessage.Status.IMonitoringParameterValues & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type EthercatNetworkStateStatus = MotionMasterMessage.Status.IEthercatNetworkState & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type NarrowAngleCalibrationStatus = MotionMasterMessage.Status.INarrowAngleCalibration & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type SystemIdentificationStatus = MotionMasterMessage.Status.ISystemIdentification & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type CirculoEncoderMagnetDistanceStatus = MotionMasterMessage.Status.ICirculoEncoderMagnetDistance & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type CirculoEncoderNarrowAngleCalibrationProcedureStatus = MotionMasterMessage.Status.ICirculoEncoderNarrowAngleCalibrationProcedure & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceCiA402StateStatus = MotionMasterMessage.Status.IDeviceCiA402State & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type SystemLogStatus = MotionMasterMessage.Status.ISystemLog & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type DeviceSiiRestoreStatus = MotionMasterMessage.Status.IDeviceSiiRestore & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type OpenLoopFieldControlStatus = MotionMasterMessage.Status.IOpenLoopFieldControl & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type FullAutoTuningStatus = MotionMasterMessage.Status.IFullAutoTuning & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type CirculoEncoderConfigurationStatus = MotionMasterMessage.Status.ICirculoEncoderConfiguration & {
-    request: RequestStatus;
-    messageId?: string;
-};
-export type OsCommandStatus = MotionMasterMessage.Status.IOsCommand & {
-    request: RequestStatus;
-    messageId?: string;
-};
+export type SystemVersionStatus = MotionMasterMessage.Status.ISystemVersion & StatusMessageExtension;
+export type DeviceInfoStatus = MotionMasterMessage.Status.IDeviceInfo & StatusMessageExtension;
+export type DeviceParameterInfoStatus = MotionMasterMessage.Status.IDeviceParameterInfo & StatusMessageExtension;
+export type DeviceParameterValuesStatus = MotionMasterMessage.Status.IDeviceParameterValues & StatusMessageExtension;
+export type MultiDeviceParameterValuesStatus = MotionMasterMessage.Status.IMultiDeviceParameterValues & StatusMessageExtension;
+export type DeviceFileListStatus = MotionMasterMessage.Status.IDeviceFileList & StatusMessageExtension;
+export type DeviceFileStatus = MotionMasterMessage.Status.IDeviceFile & StatusMessageExtension;
+export type DeviceFaultResetStatus = MotionMasterMessage.Status.IDeviceFaultReset & StatusMessageExtension;
+export type DeviceStopStatus = MotionMasterMessage.Status.IDeviceStop & StatusMessageExtension;
+export type DeviceFirmwareInstallationStatus = MotionMasterMessage.Status.IDeviceFirmwareInstallation & StatusMessageExtension;
+export type DeviceLogStatus = MotionMasterMessage.Status.IDeviceLog & StatusMessageExtension;
+export type CoggingTorqueRecordingStatus = MotionMasterMessage.Status.ICoggingTorqueRecording & StatusMessageExtension;
+export type CoggingTorqueDataStatus = MotionMasterMessage.Status.ICoggingTorqueData & StatusMessageExtension;
+export type OffsetDetectionStatus = MotionMasterMessage.Status.IOffsetDetection & StatusMessageExtension;
+export type PlantIdentificationStatus = MotionMasterMessage.Status.IPlantIdentification & StatusMessageExtension;
+export type AutoTuningStatus = MotionMasterMessage.Status.IAutoTuning & StatusMessageExtension;
+export type MotionControllerStatus = MotionMasterMessage.Status.IMotionController & StatusMessageExtension;
+export type SignalGeneratorStatus = MotionMasterMessage.Status.ISignalGenerator & StatusMessageExtension;
+export type MonitoringParameterValuesStatus = MotionMasterMessage.Status.IMonitoringParameterValues & StatusMessageExtension;
+export type EthercatNetworkStateStatus = MotionMasterMessage.Status.IEthercatNetworkState & StatusMessageExtension;
+export type NarrowAngleCalibrationStatus = MotionMasterMessage.Status.INarrowAngleCalibration & StatusMessageExtension;
+export type SystemIdentificationStatus = MotionMasterMessage.Status.ISystemIdentification & StatusMessageExtension;
+export type CirculoEncoderMagnetDistanceStatus = MotionMasterMessage.Status.ICirculoEncoderMagnetDistance & StatusMessageExtension;
+export type CirculoEncoderNarrowAngleCalibrationProcedureStatus = MotionMasterMessage.Status.ICirculoEncoderNarrowAngleCalibrationProcedure & StatusMessageExtension;
+export type DeviceCiA402StateStatus = MotionMasterMessage.Status.IDeviceCiA402State & StatusMessageExtension;
+export type SystemLogStatus = MotionMasterMessage.Status.ISystemLog & StatusMessageExtension;
+export type DeviceSiiRestoreStatus = MotionMasterMessage.Status.IDeviceSiiRestore & StatusMessageExtension;
+export type OpenLoopFieldControlStatus = MotionMasterMessage.Status.IOpenLoopFieldControl & StatusMessageExtension;
+export type FullAutoTuningStatus = MotionMasterMessage.Status.IFullAutoTuning & StatusMessageExtension;
+export type CirculoEncoderConfigurationStatus = MotionMasterMessage.Status.ICirculoEncoderConfiguration & StatusMessageExtension;
+export type OsCommandStatus = MotionMasterMessage.Status.IOsCommand & StatusMessageExtension;
 export import ValueType = MotionMasterMessage.Status.DeviceParameterInfo.Parameter.ValueType;
 export declare function isArrayOfDeviceSerialNumbers(ids: DeviceParameterIds): ids is string[];
 export declare function isObjectOfDeviceSerialNumberToValues(ids: {

package/src/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/types.ts"],"names":[],"mappings":";;;AAAA,+DAAqD;AAEvC,QAAA,mBAAmB,GAAG,kCAAY,CAAC,mBAAmB,CAAC;AAWrE,MAAa,YAAa,SAAQ,KAAK;CAAI;AAA3C,oCAA2C;AAgB1C,CAAC;AAaF,6DAA6D;AAC/C,QAAA,oBAAoB,GAAG,2BAAmB,CAAC,OAAO,CAAC,uBAAuB,CAAC,KAAK,CAAC;AAE/F,6DAA6D;AAC/C,QAAA,cAAc,GAAG,2BAAmB,CAAC,OAAO,CAAC,sBAAsB,CAAC,cAAc,CAAC;AA8EjG,6DAA6D;AAC/C,QAAA,SAAS,GAAG,2BAAmB,CAAC,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,SAAS,CAAC;AAE7F,SAAgB,4BAA4B,CAAC,GAAuB;IAClE,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;AACtD,CAAC;AAFD,oEAEC;AAED,SAAgB,oCAAoC,CAAC,GAAwF;IAC3I,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAFD,oFAEC;AAED,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACtC,mIAAkC,CAAA;IAClC,qJAA2C,CAAA;AAC7C,CAAC,EAHW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAGvC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/types.ts"],"names":[],"mappings":";;;AAAA,+DAAqD;AAEvC,QAAA,mBAAmB,GAAG,kCAAY,CAAC,mBAAmB,CAAC;AAkCrE,MAAa,YAAa,SAAQ,KAAK;CAAI;AAA3C,oCAA2C;AAgB1C,CAAC;AAaF,6DAA6D;AAC/C,QAAA,oBAAoB,GAAG,2BAAmB,CAAC,OAAO,CAAC,uBAAuB,CAAC,KAAK,CAAC;AAE/F,6DAA6D;AAC/C,QAAA,cAAc,GAAG,2BAAmB,CAAC,OAAO,CAAC,sBAAsB,CAAC,cAAc,CAAC;AA8EjG,6DAA6D;AAC/C,QAAA,SAAS,GAAG,2BAAmB,CAAC,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,SAAS,CAAC;AAE7F,SAAgB,4BAA4B,CAAC,GAAuB;IAClE,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC;AACtD,CAAC;AAFD,oEAEC;AAED,SAAgB,oCAAoC,CAAC,GAAwF;IAC3I,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAFD,oFAEC;AAED,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACtC,mIAAkC,CAAA;IAClC,qJAA2C,CAAA;AAC7C,CAAC,EAHW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAGvC"}