@zaber/motion 2.9.0 → 2.10.1

package/dist/lib/gcode/{translator_axis_definition.js → axis_definition.js}

@@ -21,28 +21,29 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TranslatorAxisDefinition = void 0;
+exports.AxisDefinition = void 0;
 const gateway = __importStar(require("../gateway"));
-var TranslatorAxisDefinition;
-(function (TranslatorAxisDefinition) {
-    TranslatorAxisDefinition.__type = 'TranslatorAxisDefinition';
+var AxisDefinition;
+(function (AxisDefinition) {
+    AxisDefinition.__type = 'AxisDefinition';
     /** @internal */
     function fromProtobuf(pbData) {
         return {
-            axisLetter: pbData.axisLetter,
             peripheralId: pbData.peripheralId,
             microstepResolution: pbData.microstepResolution,
         };
     }
-    TranslatorAxisDefinition.fromProtobuf = fromProtobuf;
+    AxisDefinition.fromProtobuf = fromProtobuf;
     /** @internal */
     function toProtobuf(source) {
         const pbData = new gateway.TranslatorAxisDefinition();
-        pbData.setAxisLetter(source.axisLetter);
+        if (source == null) {
+            return pbData;
+        }
         pbData.setPeripheralId(source.peripheralId);
         pbData.setMicrostepResolution(source.microstepResolution);
         return pbData;
     }
-    TranslatorAxisDefinition.toProtobuf = toProtobuf;
-})(TranslatorAxisDefinition = exports.TranslatorAxisDefinition || (exports.TranslatorAxisDefinition = {}));
-//# sourceMappingURL=translator_axis_definition.js.map
+    AxisDefinition.toProtobuf = toProtobuf;
+})(AxisDefinition = exports.AxisDefinition || (exports.AxisDefinition = {}));
+//# sourceMappingURL=axis_definition.js.map

package/dist/lib/gcode/axis_definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"axis_definition.js","sourceRoot":"","sources":["../../../src/gcode/axis_definition.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AAoBtC,IAAiB,cAAc,CAqB9B;AArBD,WAAiB,cAAc;IAChB,qBAAM,GAAG,gBAAgB,CAAC;IAEvC,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAAiD;QAC5E,OAAO;YACL,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;SAChD,CAAC;IACJ,CAAC;IALe,2BAAY,eAK3B,CAAA;IACD,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAAyC;QAClE,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACtD,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,OAAO,MAAM,CAAC;SACf;QAED,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,mBAAoB,CAAC,CAAC;QAC3D,OAAO,MAAM,CAAC;IAChB,CAAC;IATe,yBAAU,aASzB,CAAA;AACH,CAAC,EArBgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAqB9B","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\n\n/**\n * Defines an axis of the translator.\n */\nexport interface AxisDefinition {\n  /**\n   * ID of the peripheral.\n   */\n  peripheralId: number;\n\n  /**\n   * Microstep resolution of the axis.\n   * Can be obtained by reading the resolution setting.\n   * Leave empty if the axis does not have the setting.\n   */\n  microstepResolution?: number;\n\n}\n\nexport namespace AxisDefinition {\n  export const __type = 'AxisDefinition';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.TranslatorAxisDefinition.AsObject): AxisDefinition {\n    return {\n      peripheralId: pbData.peripheralId,\n      microstepResolution: pbData.microstepResolution,\n    };\n  }\n  /** @internal */\n  export function toProtobuf(source: AxisDefinition | null | undefined): gateway.TranslatorAxisDefinition {\n    const pbData = new gateway.TranslatorAxisDefinition();\n    if (source == null) {\n      return pbData;\n    }\n\n    pbData.setPeripheralId(source.peripheralId);\n    pbData.setMicrostepResolution(source.microstepResolution!);\n    return pbData;\n  }\n}\n"]}

package/dist/lib/gcode/axis_mapping.js

@@ -29,6 +29,9 @@ var AxisMapping;
     /** @internal */
     function toProtobuf(source) {
         const pbData = new gateway.TranslatorAxisMapping();
+        if (source == null) {
+            return pbData;
+        }
         pbData.setAxisLetter(source.axisLetter);
         pbData.setAxisIndex(source.axisIndex);
         return pbData;

package/dist/lib/gcode/axis_mapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"axis_mapping.js","sourceRoot":"","sources":["../../../src/gcode/axis_mapping.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AAkBtC,IAAiB,WAAW,CAU3B;AAVD,WAAiB,WAAW;IACb,kBAAM,GAAG,aAAa,CAAC;IAEpC,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAAmB;QAC5C,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACnD,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC;IAChB,CAAC;IALe,sBAAU,aAKzB,CAAA;AACH,CAAC,EAVgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAU3B","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\n\n/**\n * Maps a translator axis to a Zaber stream axis.\n */\nexport interface AxisMapping {\n  /**\n   * Letter of the translator axis (X,Y,Z,A,B,C,E).\n   */\n  axisLetter: string;\n\n  /**\n   * Index of the stream axis.\n   */\n  axisIndex: number;\n\n}\n\nexport namespace AxisMapping {\n  export const __type = 'AxisMapping';\n\n  /** @internal */\n  export function toProtobuf(source: AxisMapping): gateway.TranslatorAxisMapping {\n    const pbData = new gateway.TranslatorAxisMapping();\n    pbData.setAxisLetter(source.axisLetter);\n    pbData.setAxisIndex(source.axisIndex);\n    return pbData;\n  }\n}\n"]}
+{"version":3,"file":"axis_mapping.js","sourceRoot":"","sources":["../../../src/gcode/axis_mapping.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AAkBtC,IAAiB,WAAW,CAc3B;AAdD,WAAiB,WAAW;IACb,kBAAM,GAAG,aAAa,CAAC;IAEpC,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAAsC;QAC/D,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACnD,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,OAAO,MAAM,CAAC;SACf;QAED,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC;IAChB,CAAC;IATe,sBAAU,aASzB,CAAA;AACH,CAAC,EAdgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAc3B","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\n\n/**\n * Maps a translator axis to a Zaber stream axis.\n */\nexport interface AxisMapping {\n  /**\n   * Letter of the translator axis (X,Y,Z,A,B,C,E).\n   */\n  axisLetter: string;\n\n  /**\n   * Index of the stream axis.\n   */\n  axisIndex: number;\n\n}\n\nexport namespace AxisMapping {\n  export const __type = 'AxisMapping';\n\n  /** @internal */\n  export function toProtobuf(source: AxisMapping | null | undefined): gateway.TranslatorAxisMapping {\n    const pbData = new gateway.TranslatorAxisMapping();\n    if (source == null) {\n      return pbData;\n    }\n\n    pbData.setAxisLetter(source.axisLetter);\n    pbData.setAxisIndex(source.axisIndex);\n    return pbData;\n  }\n}\n"]}

package/dist/lib/gcode/axis_transformation.d.ts

@@ -0,0 +1,21 @@
+import { Measurement } from '../measurement';
+/**
+ * Represents a transformation of a translator axis.
+ */
+export interface AxisTransformation {
+    /**
+     * Letter of the translator axis (X,Y,Z,A,B,C,E).
+     */
+    axisLetter: string;
+    /**
+     * Scaling factor.
+     */
+    scaling?: number;
+    /**
+     * Translation distance.
+     */
+    translation?: Measurement;
+}
+export declare namespace AxisTransformation {
+    const __type = "AxisTransformation";
+}

package/dist/lib/gcode/axis_transformation.js

@@ -0,0 +1,43 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AxisTransformation = void 0;
+const gateway = __importStar(require("../gateway"));
+const measurement_1 = require("../measurement");
+var AxisTransformation;
+(function (AxisTransformation) {
+    AxisTransformation.__type = 'AxisTransformation';
+    /** @internal */
+    function toProtobuf(source) {
+        const pbData = new gateway.TranslatorAxisTransformation();
+        if (source == null) {
+            return pbData;
+        }
+        pbData.setAxisLetter(source.axisLetter);
+        pbData.setScaling(source.scaling);
+        pbData.setTranslation(measurement_1.Measurement.toProtobuf(source.translation));
+        return pbData;
+    }
+    AxisTransformation.toProtobuf = toProtobuf;
+})(AxisTransformation = exports.AxisTransformation || (exports.AxisTransformation = {}));
+//# sourceMappingURL=axis_transformation.js.map

package/dist/lib/gcode/axis_transformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"axis_transformation.js","sourceRoot":"","sources":["../../../src/gcode/axis_transformation.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,gDAA6C;AAuB7C,IAAiB,kBAAkB,CAelC;AAfD,WAAiB,kBAAkB;IACpB,yBAAM,GAAG,oBAAoB,CAAC;IAE3C,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAA6C;QACtE,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC1D,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,OAAO,MAAM,CAAC;SACf;QAED,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,OAAQ,CAAC,CAAC;QACnC,MAAM,CAAC,cAAc,CAAC,yBAAW,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAClE,OAAO,MAAM,CAAC;IAChB,CAAC;IAVe,6BAAU,aAUzB,CAAA;AACH,CAAC,EAfgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAelC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { Measurement } from '../measurement';\n\n/**\n * Represents a transformation of a translator axis.\n */\nexport interface AxisTransformation {\n  /**\n   * Letter of the translator axis (X,Y,Z,A,B,C,E).\n   */\n  axisLetter: string;\n\n  /**\n   * Scaling factor.\n   */\n  scaling?: number;\n\n  /**\n   * Translation distance.\n   */\n  translation?: Measurement;\n\n}\n\nexport namespace AxisTransformation {\n  export const __type = 'AxisTransformation';\n\n  /** @internal */\n  export function toProtobuf(source: AxisTransformation | null | undefined): gateway.TranslatorAxisTransformation {\n    const pbData = new gateway.TranslatorAxisTransformation();\n    if (source == null) {\n      return pbData;\n    }\n\n    pbData.setAxisLetter(source.axisLetter);\n    pbData.setScaling(source.scaling!);\n    pbData.setTranslation(Measurement.toProtobuf(source.translation));\n    return pbData;\n  }\n}\n"]}

package/dist/lib/gcode/device_definition.d.ts

@@ -0,0 +1,24 @@
+import { AxisDefinition } from './axis_definition';
+import { Measurement } from '../measurement';
+/**
+ * Holds information about device and its axes for purpose of a translator.
+ */
+export interface DeviceDefinition {
+    /**
+     * Device ID of the controller.
+     * Can be obtained from device settings.
+     */
+    deviceId: number;
+    /**
+     * Applicable axes of the device.
+     */
+    axes: AxisDefinition[];
+    /**
+     * The smallest of each axis' maxspeed setting value.
+     * This value becomes the traverse rate of the translator.
+     */
+    maxSpeed: Measurement;
+}
+export declare namespace DeviceDefinition {
+    const __type = "DeviceDefinition";
+}

package/dist/lib/gcode/{translator_definition.js → device_definition.js}

@@ -21,19 +21,24 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TranslatorDefinition = void 0;
+exports.DeviceDefinition = void 0;
 const gateway = __importStar(require("../gateway"));
-const translator_axis_definition_1 = require("./translator_axis_definition");
-var TranslatorDefinition;
-(function (TranslatorDefinition) {
-    TranslatorDefinition.__type = 'TranslatorDefinition';
+const axis_definition_1 = require("./axis_definition");
+const measurement_1 = require("../measurement");
+var DeviceDefinition;
+(function (DeviceDefinition) {
+    DeviceDefinition.__type = 'DeviceDefinition';
     /** @internal */
     function toProtobuf(source) {
         const pbData = new gateway.TranslatorDefinition();
+        if (source == null) {
+            return pbData;
+        }
         pbData.setDeviceId(source.deviceId);
-        pbData.setAxesList(source.axes.map(item => translator_axis_definition_1.TranslatorAxisDefinition.toProtobuf(item)));
+        pbData.setAxesList(source.axes.map(item => axis_definition_1.AxisDefinition.toProtobuf(item)));
+        pbData.setMaxSpeed(measurement_1.Measurement.toProtobuf(source.maxSpeed));
         return pbData;
     }
-    TranslatorDefinition.toProtobuf = toProtobuf;
-})(TranslatorDefinition = exports.TranslatorDefinition || (exports.TranslatorDefinition = {}));
-//# sourceMappingURL=translator_definition.js.map
+    DeviceDefinition.toProtobuf = toProtobuf;
+})(DeviceDefinition = exports.DeviceDefinition || (exports.DeviceDefinition = {}));
+//# sourceMappingURL=device_definition.js.map

package/dist/lib/gcode/device_definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device_definition.js","sourceRoot":"","sources":["../../../src/gcode/device_definition.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,uDAAmD;AACnD,gDAA6C;AAyB7C,IAAiB,gBAAgB,CAehC;AAfD,WAAiB,gBAAgB;IAClB,uBAAM,GAAG,kBAAkB,CAAC;IAEzC,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAA2C;QACpE,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QAClD,IAAI,MAAM,IAAI,IAAI,EAAE;YAClB,OAAO,MAAM,CAAC;SACf;QAED,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gCAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7E,MAAM,CAAC,WAAW,CAAC,yBAAW,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC;IAChB,CAAC;IAVe,2BAAU,aAUzB,CAAA;AACH,CAAC,EAfgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAehC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { AxisDefinition } from './axis_definition';\nimport { Measurement } from '../measurement';\n\n/**\n * Holds information about device and its axes for purpose of a translator.\n */\nexport interface DeviceDefinition {\n  /**\n   * Device ID of the controller.\n   * Can be obtained from device settings.\n   */\n  deviceId: number;\n\n  /**\n   * Applicable axes of the device.\n   */\n  axes: AxisDefinition[];\n\n  /**\n   * The smallest of each axis' maxspeed setting value.\n   * This value becomes the traverse rate of the translator.\n   */\n  maxSpeed: Measurement;\n\n}\n\nexport namespace DeviceDefinition {\n  export const __type = 'DeviceDefinition';\n\n  /** @internal */\n  export function toProtobuf(source: DeviceDefinition | null | undefined): gateway.TranslatorDefinition {\n    const pbData = new gateway.TranslatorDefinition();\n    if (source == null) {\n      return pbData;\n    }\n\n    pbData.setDeviceId(source.deviceId);\n    pbData.setAxesList(source.axes.map(item => AxisDefinition.toProtobuf(item)));\n    pbData.setMaxSpeed(Measurement.toProtobuf(source.maxSpeed));\n    return pbData;\n  }\n}\n"]}

package/dist/lib/gcode/index.d.ts

@@ -1,8 +1,9 @@
 export { TranslateMessage } from './translate_message';
 export { TranslateResult } from './translate_result';
 export { TranslatorConfig } from './translator_config';
-export { TranslatorAxisDefinition } from './translator_axis_definition';
-export { TranslatorDefinition } from './translator_definition';
+export { AxisDefinition } from './axis_definition';
+export { DeviceDefinition } from './device_definition';
 export { AxisMapping } from './axis_mapping';
+export { AxisTransformation } from './axis_transformation';
 export { Translator } from './translator';
-export { TranslatorLive } from './translator_live';
+export { OfflineTranslator } from './offline_translator';

package/dist/lib/gcode/index.js

@@ -1,20 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TranslatorLive = exports.Translator = exports.AxisMapping = exports.TranslatorDefinition = exports.TranslatorAxisDefinition = exports.TranslatorConfig = exports.TranslateResult = exports.TranslateMessage = void 0;
+exports.OfflineTranslator = exports.Translator = exports.AxisTransformation = exports.AxisMapping = exports.DeviceDefinition = exports.AxisDefinition = exports.TranslatorConfig = exports.TranslateResult = exports.TranslateMessage = void 0;
 var translate_message_1 = require("./translate_message");
 Object.defineProperty(exports, "TranslateMessage", { enumerable: true, get: function () { return translate_message_1.TranslateMessage; } });
 var translate_result_1 = require("./translate_result");
 Object.defineProperty(exports, "TranslateResult", { enumerable: true, get: function () { return translate_result_1.TranslateResult; } });
 var translator_config_1 = require("./translator_config");
 Object.defineProperty(exports, "TranslatorConfig", { enumerable: true, get: function () { return translator_config_1.TranslatorConfig; } });
-var translator_axis_definition_1 = require("./translator_axis_definition");
-Object.defineProperty(exports, "TranslatorAxisDefinition", { enumerable: true, get: function () { return translator_axis_definition_1.TranslatorAxisDefinition; } });
-var translator_definition_1 = require("./translator_definition");
-Object.defineProperty(exports, "TranslatorDefinition", { enumerable: true, get: function () { return translator_definition_1.TranslatorDefinition; } });
+var axis_definition_1 = require("./axis_definition");
+Object.defineProperty(exports, "AxisDefinition", { enumerable: true, get: function () { return axis_definition_1.AxisDefinition; } });
+var device_definition_1 = require("./device_definition");
+Object.defineProperty(exports, "DeviceDefinition", { enumerable: true, get: function () { return device_definition_1.DeviceDefinition; } });
 var axis_mapping_1 = require("./axis_mapping");
 Object.defineProperty(exports, "AxisMapping", { enumerable: true, get: function () { return axis_mapping_1.AxisMapping; } });
+var axis_transformation_1 = require("./axis_transformation");
+Object.defineProperty(exports, "AxisTransformation", { enumerable: true, get: function () { return axis_transformation_1.AxisTransformation; } });
 var translator_1 = require("./translator");
 Object.defineProperty(exports, "Translator", { enumerable: true, get: function () { return translator_1.Translator; } });
-var translator_live_1 = require("./translator_live");
-Object.defineProperty(exports, "TranslatorLive", { enumerable: true, get: function () { return translator_live_1.TranslatorLive; } });
+var offline_translator_1 = require("./offline_translator");
+Object.defineProperty(exports, "OfflineTranslator", { enumerable: true, get: function () { return offline_translator_1.OfflineTranslator; } });
 //# sourceMappingURL=index.js.map

package/dist/lib/gcode/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gcode/index.ts"],"names":[],"mappings":";;;AAAA,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,uDAAqD;AAA5C,mHAAA,eAAe,OAAA;AACxB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,2EAAwE;AAA/D,sIAAA,wBAAwB,OAAA;AACjC,iEAA+D;AAAtD,6HAAA,oBAAoB,OAAA;AAC7B,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AACpB,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,qDAAmD;AAA1C,iHAAA,cAAc,OAAA","sourcesContent":["export { TranslateMessage } from './translate_message';\nexport { TranslateResult } from './translate_result';\nexport { TranslatorConfig } from './translator_config';\nexport { TranslatorAxisDefinition } from './translator_axis_definition';\nexport { TranslatorDefinition } from './translator_definition';\nexport { AxisMapping } from './axis_mapping';\nexport { Translator } from './translator';\nexport { TranslatorLive } from './translator_live';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gcode/index.ts"],"names":[],"mappings":";;;AAAA,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,uDAAqD;AAA5C,mHAAA,eAAe,OAAA;AACxB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,yDAAuD;AAA9C,qHAAA,gBAAgB,OAAA;AACzB,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AACpB,6DAA2D;AAAlD,yHAAA,kBAAkB,OAAA;AAC3B,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,2DAAyD;AAAhD,uHAAA,iBAAiB,OAAA","sourcesContent":["export { TranslateMessage } from './translate_message';\nexport { TranslateResult } from './translate_result';\nexport { TranslatorConfig } from './translator_config';\nexport { AxisDefinition } from './axis_definition';\nexport { DeviceDefinition } from './device_definition';\nexport { AxisMapping } from './axis_mapping';\nexport { AxisTransformation } from './axis_transformation';\nexport { Translator } from './translator';\nexport { OfflineTranslator } from './offline_translator';\n"]}

package/dist/lib/gcode/offline_translator.d.ts

@@ -0,0 +1,114 @@
+import { DeviceDefinition } from './device_definition';
+import { TranslatorConfig } from './translator_config';
+import { TranslateResult } from './translate_result';
+import { Angle, Length, Native, AngularVelocity, Velocity } from '../units';
+/**
+ * Represents an offline G-Code translator.
+ * It allows to translate G-Code blocks to Zaber ASCII protocol stream commands.
+ * This translator does not need a connected device to perform translation.
+ */
+export declare class OfflineTranslator {
+    /**
+     * The ID of the translator that serves to identify native resources.
+     */
+    get translatorId(): number;
+    private _translatorId;
+    /**
+     * Current coordinate system.
+     */
+    get coordinateSystem(): string;
+    constructor(translatorId: number);
+    /**
+     * Sets up translator from provided device definition and configuration.
+     * @param definition Definition of device and its peripherals.
+     * The definition must match a device that later performs the commands.
+     * @param config? Configuration of the translator.
+     * @return New instance of translator.
+     */
+    static setup(definition: DeviceDefinition, config?: TranslatorConfig): Promise<OfflineTranslator>;
+    /**
+     * Translates a single block (line) of G-code.
+     * @param block Block (line) of G-code.
+     * @return Result of translation containing the stream commands.
+     */
+    translate(block: string): TranslateResult;
+    /**
+     * Flushes the remaining stream commands waiting in optimization buffer.
+     * The flush is also performed by M2 and M30 codes.
+     * @return The remaining stream commands.
+     */
+    flush(): string[];
+    /**
+     * Sets the speed at which the device moves when traversing (G0).
+     * @param traverseRate The traverse rate.
+     * @param unit Units of the traverse rate.
+     */
+    setTraverseRate(traverseRate: number, unit: Velocity | AngularVelocity | Native): void;
+    /**
+     * Sets position of translator's axis.
+     * Use this method to set position after performing movement outside of the translator.
+     * This method does not cause any movement.
+     * @param axis Letter of the axis.
+     * @param position The position.
+     * @param unit Units of position.
+     */
+    setAxisPosition(axis: string, position: number, unit: Length | Angle | Native): void;
+    /**
+     * Gets position of translator's axis.
+     * This method does not query device but returns value from translator's state.
+     * @param axis Letter of the axis.
+     * @param unit Units of position.
+     * @return Position of translator's axis.
+     */
+    getAxisPosition(axis: string, unit: Length | Angle | Native): number;
+    /**
+     * Sets the home position of translator's axis.
+     * This position is used by G28.
+     * @param axis Letter of the axis.
+     * @param position The home position.
+     * @param unit Units of position.
+     */
+    setAxisHomePosition(axis: string, position: number, unit: Length | Angle | Native): void;
+    /**
+     * Sets the secondary home position of translator's axis.
+     * This position is used by G30.
+     * @param axis Letter of the axis.
+     * @param position The home position.
+     * @param unit Units of position.
+     */
+    setAxisSecondaryHomePosition(axis: string, position: number, unit: Length | Angle | Native): void;
+    /**
+     * Gets offset of an axis in a given coordinate system.
+     * @param coordinateSystem Coordinate system (e.g. G54).
+     * @param axis Letter of the axis.
+     * @param unit Units of position.
+     * @return Offset in translator units of the axis.
+     */
+    getAxisCoordinateSystemOffset(coordinateSystem: string, axis: string, unit: Length | Angle | Native): number;
+    /**
+     * Resets internal state after device rejected generated command.
+     * Axis positions become uninitialized.
+     */
+    resetAfterStreamError(): void;
+    /**
+     * Allows to scale feed rate of the translated code by a coefficient.
+     * @param coefficient Coefficient of the original feed rate.
+     */
+    setFeedRateOverride(coefficient: number): void;
+    /**
+     * Releases native resources of a translator.
+     * @param translatorId The ID of the translator.
+     */
+    private static _free;
+    /**
+     * Gets current coordinate system (e.g. G54).
+     * @return Current coordinate system.
+     */
+    private _getCurrentCoordinateSystem;
+    /**
+     * Releases the native resources of the translator.
+     * Should only be called if your environment does not support FinalizationRegistry.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
+     */
+    free(): void;
+}

package/dist/lib/gcode/offline_translator.js

@@ -0,0 +1,226 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OfflineTranslator = void 0;
+const gateway = __importStar(require("../gateway"));
+const device_definition_1 = require("./device_definition");
+const translator_config_1 = require("./translator_config");
+const translate_result_1 = require("./translate_result");
+const finalizer_1 = require("../finalizer");
+/**
+ * Represents an offline G-Code translator.
+ * It allows to translate G-Code blocks to Zaber ASCII protocol stream commands.
+ * This translator does not need a connected device to perform translation.
+ */
+class OfflineTranslator {
+    constructor(translatorId) {
+        this._translatorId = translatorId;
+        (0, finalizer_1.registerForFinalization)(this, OfflineTranslator._free.bind(null, translatorId));
+    }
+    /**
+     * The ID of the translator that serves to identify native resources.
+     */
+    get translatorId() {
+        return this._translatorId;
+    }
+    /**
+     * Current coordinate system.
+     */
+    get coordinateSystem() {
+        return this._getCurrentCoordinateSystem();
+    }
+    /**
+     * Sets up translator from provided device definition and configuration.
+     * @param definition Definition of device and its peripherals.
+     * The definition must match a device that later performs the commands.
+     * @param config? Configuration of the translator.
+     * @return New instance of translator.
+     */
+    static async setup(definition, config) {
+        const request = new gateway.TranslatorCreateRequest();
+        request.setDefinition(device_definition_1.DeviceDefinition.toProtobuf(definition));
+        request.setConfig(translator_config_1.TranslatorConfig.toProtobuf(config));
+        const response = await gateway.callAsync('gcode/create', request, gateway.TranslatorCreateResponse);
+        return new OfflineTranslator(response.getTranslatorId());
+    }
+    /**
+     * Translates a single block (line) of G-code.
+     * @param block Block (line) of G-code.
+     * @return Result of translation containing the stream commands.
+     */
+    translate(block) {
+        const request = new gateway.TranslatorTranslateRequest();
+        request.setTranslatorId(this.translatorId);
+        request.setBlock(block);
+        const response = gateway.callSync('gcode/translate', request, gateway.TranslatorTranslateResponse);
+        return translate_result_1.TranslateResult.fromProtobuf(response.toObject());
+    }
+    /**
+     * Flushes the remaining stream commands waiting in optimization buffer.
+     * The flush is also performed by M2 and M30 codes.
+     * @return The remaining stream commands.
+     */
+    flush() {
+        const request = new gateway.TranslatorEmptyRequest();
+        request.setTranslatorId(this.translatorId);
+        const response = gateway.callSync('gcode/flush', request, gateway.TranslatorFlushResponse);
+        return response.getCommandsList();
+    }
+    /**
+     * Sets the speed at which the device moves when traversing (G0).
+     * @param traverseRate The traverse rate.
+     * @param unit Units of the traverse rate.
+     */
+    setTraverseRate(traverseRate, unit) {
+        const request = new gateway.TranslatorSetTraverseRateRequest();
+        request.setTranslatorId(this.translatorId);
+        request.setTraverseRate(traverseRate);
+        request.setUnit(unit);
+        gateway.callSync('gcode/set_traverse_rate', request);
+    }
+    /**
+     * Sets position of translator's axis.
+     * Use this method to set position after performing movement outside of the translator.
+     * This method does not cause any movement.
+     * @param axis Letter of the axis.
+     * @param position The position.
+     * @param unit Units of position.
+     */
+    setAxisPosition(axis, position, unit) {
+        const request = new gateway.TranslatorSetAxisPositionRequest();
+        request.setTranslatorId(this.translatorId);
+        request.setAxis(axis);
+        request.setPosition(position);
+        request.setUnit(unit);
+        gateway.callSync('gcode/set_axis_position', request);
+    }
+    /**
+     * Gets position of translator's axis.
+     * This method does not query device but returns value from translator's state.
+     * @param axis Letter of the axis.
+     * @param unit Units of position.
+     * @return Position of translator's axis.
+     */
+    getAxisPosition(axis, unit) {
+        const request = new gateway.TranslatorGetAxisPositionRequest();
+        request.setTranslatorId(this.translatorId);
+        request.setAxis(axis);
+        request.setUnit(unit);
+        const response = gateway.callSync('gcode/get_axis_position', request, gateway.TranslatorGetAxisPositionResponse);
+        return response.getValue();
+    }
+    /**
+     * Sets the home position of translator's axis.
+     * This position is used by G28.
+     * @param axis Letter of the axis.
+     * @param position The home position.
+     * @param unit Units of position.
+     */
+    setAxisHomePosition(axis, position, unit) {
+        const request = new gateway.TranslatorSetAxisPositionRequest();
+        request.setTranslatorId(this.translatorId);
+        request.setAxis(axis);
+        request.setPosition(position);
+        request.setUnit(unit);
+        gateway.callSync('gcode/set_axis_home', request);
+    }
+    /**
+     * Sets the secondary home position of translator's axis.
+     * This position is used by G30.
+     * @param axis Letter of the axis.
+     * @param position The home position.
+     * @param unit Units of position.
+     */
+    setAxisSecondaryHomePosition(axis, position, unit) {
+        const request = new gateway.TranslatorSetAxisPositionRequest();
+        request.setTranslatorId(this.translatorId);
+        request.setAxis(axis);
+        request.setPosition(position);
+        request.setUnit(unit);
+        gateway.callSync('gcode/set_axis_secondary_home', request);
+    }
+    /**
+     * Gets offset of an axis in a given coordinate system.
+     * @param coordinateSystem Coordinate system (e.g. G54).
+     * @param axis Letter of the axis.
+     * @param unit Units of position.
+     * @return Offset in translator units of the axis.
+     */
+    getAxisCoordinateSystemOffset(coordinateSystem, axis, unit) {
+        const request = new gateway.TranslatorGetAxisOffsetRequest();
+        request.setTranslatorId(this.translatorId);
+        request.setCoordinateSystem(coordinateSystem);
+        request.setAxis(axis);
+        request.setUnit(unit);
+        const response = gateway.callSync('gcode/get_axis_offset', request, gateway.TranslatorGetAxisPositionResponse);
+        return response.getValue();
+    }
+    /**
+     * Resets internal state after device rejected generated command.
+     * Axis positions become uninitialized.
+     */
+    resetAfterStreamError() {
+        const request = new gateway.TranslatorEmptyRequest();
+        request.setTranslatorId(this.translatorId);
+        gateway.callSync('gcode/reset_after_stream_error', request);
+    }
+    /**
+     * Allows to scale feed rate of the translated code by a coefficient.
+     * @param coefficient Coefficient of the original feed rate.
+     */
+    setFeedRateOverride(coefficient) {
+        const request = new gateway.TranslatorSetFeedRateOverrideRequest();
+        request.setTranslatorId(this.translatorId);
+        request.setCoefficient(coefficient);
+        gateway.callSync('gcode/set_feed_rate_override', request);
+    }
+    /**
+     * Releases native resources of a translator.
+     * @param translatorId The ID of the translator.
+     */
+    static _free(translatorId) {
+        const request = new gateway.TranslatorEmptyRequest();
+        request.setTranslatorId(translatorId);
+        gateway.callSync('gcode/free', request);
+    }
+    /**
+     * Gets current coordinate system (e.g. G54).
+     * @return Current coordinate system.
+     */
+    _getCurrentCoordinateSystem() {
+        const request = new gateway.TranslatorEmptyRequest();
+        request.setTranslatorId(this.translatorId);
+        const response = gateway.callSync('gcode/get_current_coordinate_system', request, gateway.TranslatorGetCurrentCoordinateSystemResponse);
+        return response.getValue();
+    }
+    /**
+     * Releases the native resources of the translator.
+     * Should only be called if your environment does not support FinalizationRegistry.
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
+     */
+    free() {
+        OfflineTranslator._free(this.translatorId);
+    }
+}
+exports.OfflineTranslator = OfflineTranslator;
+//# sourceMappingURL=offline_translator.js.map

package/dist/lib/gcode/offline_translator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"offline_translator.js","sourceRoot":"","sources":["../../../src/gcode/offline_translator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,2DAAuD;AACvD,2DAAuD;AACvD,yDAAqD;AAErD,4CAAuD;AAEvD;;;;GAIG;AACH,MAAa,iBAAiB;IAgB5B,YAAY,YAAoB;QAC9B,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAA,mCAAuB,EAAC,IAAI,EAAE,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;IAClF,CAAC;IAlBD;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAGD;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,2BAA2B,EAAE,CAAC;IAC5C,CAAC;IAOD;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CACvB,UAA4B,EAC5B,MAAyB;QAEzB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,aAAa,CAAC,oCAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/D,OAAO,CAAC,SAAS,CAAC,oCAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAEvD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,cAAc,EACd,OAAO,EACP,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACpC,OAAO,IAAI,iBAAiB,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,SAAS,CACd,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,iBAAiB,EACjB,OAAO,EACP,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACvC,OAAO,kCAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,KAAK;QACV,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE3C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,aAAa,EACb,OAAO,EACP,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,eAAe,EAAE,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,eAAe,CACpB,YAAoB,EACpB,IAAyC;QAEzC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gCAAgC,EAAE,CAAC;QAC/D,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACtC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,CAAC,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CACpB,IAAY,EACZ,QAAgB,EAChB,IAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gCAAgC,EAAE,CAAC;QAC/D,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,CAAC,QAAQ,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,eAAe,CACpB,IAAY,EACZ,IAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gCAAgC,EAAE,CAAC;QAC/D,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,iCAAiC,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CACxB,IAAY,EACZ,QAAgB,EAChB,IAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gCAAgC,EAAE,CAAC;QAC/D,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,CAAC,QAAQ,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACI,4BAA4B,CACjC,IAAY,EACZ,QAAgB,EAChB,IAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gCAAgC,EAAE,CAAC;QAC/D,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,CAAC,QAAQ,CAAC,+BAA+B,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,6BAA6B,CAClC,gBAAwB,EACxB,IAAY,EACZ,IAA6B;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,8BAA8B,EAAE,CAAC;QAC7D,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;QAC9C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,uBAAuB,EACvB,OAAO,EACP,OAAO,CAAC,iCAAiC,CAAC,CAAC;QAC7C,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,qBAAqB;QAC1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE3C,OAAO,CAAC,QAAQ,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,mBAAmB,CACxB,WAAmB;QAEnB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oCAAoC,EAAE,CAAC;QACnE,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAEpC,OAAO,CAAC,QAAQ,CAAC,8BAA8B,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,KAAK,CAClB,YAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtC,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACK,2BAA2B;QACjC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE3C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,qCAAqC,EACrC,OAAO,EACP,OAAO,CAAC,4CAA4C,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,IAAI;QACT,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;CACF;AA5QD,8CA4QC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { DeviceDefinition } from './device_definition';\nimport { TranslatorConfig } from './translator_config';\nimport { TranslateResult } from './translate_result';\nimport { Angle, Length, Native, AngularVelocity, Velocity } from '../units';\nimport { registerForFinalization } from '../finalizer';\n\n/**\n * Represents an offline G-Code translator.\n * It allows to translate G-Code blocks to Zaber ASCII protocol stream commands.\n * This translator does not need a connected device to perform translation.\n */\nexport class OfflineTranslator {\n  /**\n   * The ID of the translator that serves to identify native resources.\n   */\n  public get translatorId(): number {\n    return this._translatorId;\n  }\n  private _translatorId: number;\n\n  /**\n   * Current coordinate system.\n   */\n  public get coordinateSystem(): string {\n    return this._getCurrentCoordinateSystem();\n  }\n\n  constructor(translatorId: number) {\n    this._translatorId = translatorId;\n    registerForFinalization(this, OfflineTranslator._free.bind(null, translatorId));\n  }\n\n  /**\n   * Sets up translator from provided device definition and configuration.\n   * @param definition Definition of device and its peripherals.\n   * The definition must match a device that later performs the commands.\n   * @param config? Configuration of the translator.\n   * @return New instance of translator.\n   */\n  public static async setup(\n    definition: DeviceDefinition,\n    config?: TranslatorConfig\n  ): Promise<OfflineTranslator> {\n    const request = new gateway.TranslatorCreateRequest();\n    request.setDefinition(DeviceDefinition.toProtobuf(definition));\n    request.setConfig(TranslatorConfig.toProtobuf(config));\n\n    const response = await gateway.callAsync<gateway.TranslatorCreateResponse>(\n      'gcode/create',\n      request,\n      gateway.TranslatorCreateResponse);\n    return new OfflineTranslator(response.getTranslatorId());\n  }\n\n  /**\n   * Translates a single block (line) of G-code.\n   * @param block Block (line) of G-code.\n   * @return Result of translation containing the stream commands.\n   */\n  public translate(\n    block: string\n  ): TranslateResult {\n    const request = new gateway.TranslatorTranslateRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setBlock(block);\n\n    const response = gateway.callSync<gateway.TranslatorTranslateResponse>(\n      'gcode/translate',\n      request,\n      gateway.TranslatorTranslateResponse);\n    return TranslateResult.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Flushes the remaining stream commands waiting in optimization buffer.\n   * The flush is also performed by M2 and M30 codes.\n   * @return The remaining stream commands.\n   */\n  public flush(): string[] {\n    const request = new gateway.TranslatorEmptyRequest();\n    request.setTranslatorId(this.translatorId);\n\n    const response = gateway.callSync<gateway.TranslatorFlushResponse>(\n      'gcode/flush',\n      request,\n      gateway.TranslatorFlushResponse);\n    return response.getCommandsList();\n  }\n\n  /**\n   * Sets the speed at which the device moves when traversing (G0).\n   * @param traverseRate The traverse rate.\n   * @param unit Units of the traverse rate.\n   */\n  public setTraverseRate(\n    traverseRate: number,\n    unit: Velocity | AngularVelocity | Native\n  ): void {\n    const request = new gateway.TranslatorSetTraverseRateRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setTraverseRate(traverseRate);\n    request.setUnit(unit);\n\n    gateway.callSync('gcode/set_traverse_rate', request);\n  }\n\n  /**\n   * Sets position of translator's axis.\n   * Use this method to set position after performing movement outside of the translator.\n   * This method does not cause any movement.\n   * @param axis Letter of the axis.\n   * @param position The position.\n   * @param unit Units of position.\n   */\n  public setAxisPosition(\n    axis: string,\n    position: number,\n    unit: Length | Angle | Native\n  ): void {\n    const request = new gateway.TranslatorSetAxisPositionRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setAxis(axis);\n    request.setPosition(position);\n    request.setUnit(unit);\n\n    gateway.callSync('gcode/set_axis_position', request);\n  }\n\n  /**\n   * Gets position of translator's axis.\n   * This method does not query device but returns value from translator's state.\n   * @param axis Letter of the axis.\n   * @param unit Units of position.\n   * @return Position of translator's axis.\n   */\n  public getAxisPosition(\n    axis: string,\n    unit: Length | Angle | Native\n  ): number {\n    const request = new gateway.TranslatorGetAxisPositionRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setAxis(axis);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.TranslatorGetAxisPositionResponse>(\n      'gcode/get_axis_position',\n      request,\n      gateway.TranslatorGetAxisPositionResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the home position of translator's axis.\n   * This position is used by G28.\n   * @param axis Letter of the axis.\n   * @param position The home position.\n   * @param unit Units of position.\n   */\n  public setAxisHomePosition(\n    axis: string,\n    position: number,\n    unit: Length | Angle | Native\n  ): void {\n    const request = new gateway.TranslatorSetAxisPositionRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setAxis(axis);\n    request.setPosition(position);\n    request.setUnit(unit);\n\n    gateway.callSync('gcode/set_axis_home', request);\n  }\n\n  /**\n   * Sets the secondary home position of translator's axis.\n   * This position is used by G30.\n   * @param axis Letter of the axis.\n   * @param position The home position.\n   * @param unit Units of position.\n   */\n  public setAxisSecondaryHomePosition(\n    axis: string,\n    position: number,\n    unit: Length | Angle | Native\n  ): void {\n    const request = new gateway.TranslatorSetAxisPositionRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setAxis(axis);\n    request.setPosition(position);\n    request.setUnit(unit);\n\n    gateway.callSync('gcode/set_axis_secondary_home', request);\n  }\n\n  /**\n   * Gets offset of an axis in a given coordinate system.\n   * @param coordinateSystem Coordinate system (e.g. G54).\n   * @param axis Letter of the axis.\n   * @param unit Units of position.\n   * @return Offset in translator units of the axis.\n   */\n  public getAxisCoordinateSystemOffset(\n    coordinateSystem: string,\n    axis: string,\n    unit: Length | Angle | Native\n  ): number {\n    const request = new gateway.TranslatorGetAxisOffsetRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setCoordinateSystem(coordinateSystem);\n    request.setAxis(axis);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.TranslatorGetAxisPositionResponse>(\n      'gcode/get_axis_offset',\n      request,\n      gateway.TranslatorGetAxisPositionResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Resets internal state after device rejected generated command.\n   * Axis positions become uninitialized.\n   */\n  public resetAfterStreamError(): void {\n    const request = new gateway.TranslatorEmptyRequest();\n    request.setTranslatorId(this.translatorId);\n\n    gateway.callSync('gcode/reset_after_stream_error', request);\n  }\n\n  /**\n   * Allows to scale feed rate of the translated code by a coefficient.\n   * @param coefficient Coefficient of the original feed rate.\n   */\n  public setFeedRateOverride(\n    coefficient: number\n  ): void {\n    const request = new gateway.TranslatorSetFeedRateOverrideRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setCoefficient(coefficient);\n\n    gateway.callSync('gcode/set_feed_rate_override', request);\n  }\n\n  /**\n   * Releases native resources of a translator.\n   * @param translatorId The ID of the translator.\n   */\n  private static _free(\n    translatorId: number\n  ): void {\n    const request = new gateway.TranslatorEmptyRequest();\n    request.setTranslatorId(translatorId);\n\n    gateway.callSync('gcode/free', request);\n  }\n\n  /**\n   * Gets current coordinate system (e.g. G54).\n   * @return Current coordinate system.\n   */\n  private _getCurrentCoordinateSystem(): string {\n    const request = new gateway.TranslatorEmptyRequest();\n    request.setTranslatorId(this.translatorId);\n\n    const response = gateway.callSync<gateway.TranslatorGetCurrentCoordinateSystemResponse>(\n      'gcode/get_current_coordinate_system',\n      request,\n      gateway.TranslatorGetCurrentCoordinateSystemResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Releases the native resources of the translator.\n   * Should only be called if your environment does not support FinalizationRegistry.\n   * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry\n   */\n  public free(): void {\n    OfflineTranslator._free(this.translatorId);\n  }\n}\n"]}