@zaber/motion 2.9.1 → 2.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zaber/motion",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "description": "Zaber Motion Library is a multi-platform library used to operate Zaber devices.",
   "keywords": [],
   "main": "dist/lib/index.js",

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

@@ -1,20 +0,0 @@
-/**
- * Defines an axis of the translator.
- */
-export interface TranslatorAxisDefinition {
-    /**
-     * Letter of the axis (X,Y,Z,A,B,C,E).
-     */
-    axisLetter: string;
-    /**
-     * ID of the peripheral.
-     */
-    peripheralId: number;
-    /**
-     * Microstep resolution of the axis.
-     */
-    microstepResolution: number;
-}
-export declare namespace TranslatorAxisDefinition {
-    const __type = "TranslatorAxisDefinition";
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"translator_axis_definition.js","sourceRoot":"","sources":["../../../src/gcode/translator_axis_definition.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AAuBtC,IAAiB,wBAAwB,CAmBxC;AAnBD,WAAiB,wBAAwB;IAC1B,+BAAM,GAAG,0BAA0B,CAAC;IAEjD,gBAAgB;IAChB,SAAgB,YAAY,CAAC,MAAiD;QAC5E,OAAO;YACL,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;SAChD,CAAC;IACJ,CAAC;IANe,qCAAY,eAM3B,CAAA;IACD,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAAgC;QACzD,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACtD,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,CAAC,sBAAsB,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;QAC1D,OAAO,MAAM,CAAC;IAChB,CAAC;IANe,mCAAU,aAMzB,CAAA;AACH,CAAC,EAnBgB,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAmBxC","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 TranslatorAxisDefinition {\n  /**\n   * Letter of the axis (X,Y,Z,A,B,C,E).\n   */\n  axisLetter: string;\n\n  /**\n   * ID of the peripheral.\n   */\n  peripheralId: number;\n\n  /**\n   * Microstep resolution of the axis.\n   */\n  microstepResolution: number;\n\n}\n\nexport namespace TranslatorAxisDefinition {\n  export const __type = 'TranslatorAxisDefinition';\n\n  /** @internal */\n  export function fromProtobuf(pbData: gateway.TranslatorAxisDefinition.AsObject): TranslatorAxisDefinition {\n    return {\n      axisLetter: pbData.axisLetter,\n      peripheralId: pbData.peripheralId,\n      microstepResolution: pbData.microstepResolution,\n    };\n  }\n  /** @internal */\n  export function toProtobuf(source: TranslatorAxisDefinition): gateway.TranslatorAxisDefinition {\n    const pbData = new gateway.TranslatorAxisDefinition();\n    pbData.setAxisLetter(source.axisLetter);\n    pbData.setPeripheralId(source.peripheralId);\n    pbData.setMicrostepResolution(source.microstepResolution);\n    return pbData;\n  }\n}\n"]}

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

@@ -1,18 +0,0 @@
-import { TranslatorAxisDefinition } from './translator_axis_definition';
-/**
- * Defines an axis of the translator.
- */
-export interface TranslatorDefinition {
-    /**
-     * Device ID of the controller.
-     * Can be obtained from device settings.
-     */
-    deviceId: number;
-    /**
-     * Axes of translator.
-     */
-    axes: TranslatorAxisDefinition[];
-}
-export declare namespace TranslatorDefinition {
-    const __type = "TranslatorDefinition";
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"translator_definition.js","sourceRoot":"","sources":["../../../src/gcode/translator_definition.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,6EAAwE;AAmBxE,IAAiB,oBAAoB,CAUpC;AAVD,WAAiB,oBAAoB;IACtB,2BAAM,GAAG,sBAAsB,CAAC;IAE7C,gBAAgB;IAChB,SAAgB,UAAU,CAAC,MAA4B;QACrD,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,qDAAwB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvF,OAAO,MAAM,CAAC;IAChB,CAAC;IALe,+BAAU,aAKzB,CAAA;AACH,CAAC,EAVgB,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAUpC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { TranslatorAxisDefinition } from './translator_axis_definition';\n\n/**\n * Defines an axis of the translator.\n */\nexport interface TranslatorDefinition {\n  /**\n   * Device ID of the controller.\n   * Can be obtained from device settings.\n   */\n  deviceId: number;\n\n  /**\n   * Axes of translator.\n   */\n  axes: TranslatorAxisDefinition[];\n\n}\n\nexport namespace TranslatorDefinition {\n  export const __type = 'TranslatorDefinition';\n\n  /** @internal */\n  export function toProtobuf(source: TranslatorDefinition): gateway.TranslatorDefinition {\n    const pbData = new gateway.TranslatorDefinition();\n    pbData.setDeviceId(source.deviceId);\n    pbData.setAxesList(source.axes.map(item => TranslatorAxisDefinition.toProtobuf(item)));\n    return pbData;\n  }\n}\n"]}

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

@@ -1 +0,0 @@
-{"version":3,"file":"translator_live.js","sourceRoot":"","sources":["../../../src/gcode/translator_live.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,oDAAsC;AACtC,yDAAqD;AACrD,2DAAuD;AAGvD,4CAAuD;AAEvD,MAAa,cAAc;IASzB,YAAY,YAAoB;QAC9B,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAA,mCAAuB,EAAC,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;IAC/E,CAAC;IAXD;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAQD;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CACjB,MAAc,EACd,MAAwB;QAExB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC7D,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrC,OAAO,CAAC,SAAS,CAAC,oCAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAEvD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,mBAAmB,EACnB,OAAO,EACP,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACpC,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CACpB,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,MAAM,OAAO,CAAC,SAAS,CACtC,sBAAsB,EACtB,OAAO,EACP,OAAO,CAAC,2BAA2B,CAAC,CAAC;QACvC,OAAO,kCAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,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,sBAAsB,CAC3B,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,wBAAwB,EAAE,OAAO,CAAC,CAAC;IACtD,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;;;;OAIG;IACI,IAAI;QACT,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;CACF;AAnKD,wCAmKC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from '../gateway';\nimport { TranslateResult } from './translate_result';\nimport { TranslatorConfig } from './translator_config';\nimport { Stream } from '../ascii/stream';\nimport { Angle, Length, Native, AngularVelocity, Velocity } from '../units';\nimport { registerForFinalization } from '../finalizer';\n\nexport class TranslatorLive {\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  constructor(translatorId: number) {\n    this._translatorId = translatorId;\n    registerForFinalization(this, TranslatorLive._free.bind(null, translatorId));\n  }\n\n  /**\n   * Sets up the translator on top of a provided stream.\n   * @param stream The stream to setup the translator on.\n   * The stream must be already setup in a live or a store mode.\n   * @param config Configuration of the translator.\n   * @return New instance of translator.\n   */\n  public static setup(\n    stream: Stream,\n    config: TranslatorConfig\n  ): TranslatorLive {\n    const request = new gateway.TranslatorCreateLiveRequest();\n    request.setDevice(stream.device.deviceAddress);\n    request.setInterfaceId(stream.device.connection.interfaceId);\n    request.setStreamId(stream.streamId);\n    request.setConfig(TranslatorConfig.toProtobuf(config));\n\n    const response = gateway.callSync<gateway.TranslatorCreateResponse>(\n      'gcode/create_live',\n      request,\n      gateway.TranslatorCreateResponse);\n    return new TranslatorLive(response.getTranslatorId());\n  }\n\n  /**\n   * Translates a single block (line) of G-code.\n   * The commands are queued in the underlying stream to ensure smooth continues movement.\n   * Returning of this method indicates that the commands are queued (not necessarily executed).\n   * @param block Block (line) of G-code.\n   * @return Result of translation containing the commands sent to the device.\n   */\n  public async translate(\n    block: string\n  ): Promise<TranslateResult> {\n    const request = new gateway.TranslatorTranslateRequest();\n    request.setTranslatorId(this.translatorId);\n    request.setBlock(block);\n\n    const response = await gateway.callAsync<gateway.TranslatorTranslateResponse>(\n      'gcode/translate_live',\n      request,\n      gateway.TranslatorTranslateResponse);\n    return TranslateResult.fromProtobuf(response.toObject());\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 default position of translator's axis.\n   * This position is used by G28.\n   * @param axis Letter of the axis.\n   * @param position The default position.\n   * @param unit Units of position.\n   */\n  public setAxisDefaultPosition(\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_default', 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   * 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    TranslatorLive._free(this.translatorId);\n  }\n}\n"]}