@zaber/motion 2.9.1 → 2.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/dist/binding/wasm/zaber-motion-lib.wasm +0 -0
  2. package/dist/lib/ascii/connection.d.ts +11 -0
  3. package/dist/lib/ascii/connection.js +11 -0
  4. package/dist/lib/ascii/connection.js.map +1 -1
  5. package/dist/lib/ascii/device.d.ts +6 -0
  6. package/dist/lib/ascii/device.js +8 -0
  7. package/dist/lib/ascii/device.js.map +1 -1
  8. package/dist/lib/ascii/index.d.ts +9 -0
  9. package/dist/lib/ascii/index.js +19 -1
  10. package/dist/lib/ascii/index.js.map +1 -1
  11. package/dist/lib/ascii/oscilloscope.d.ts +62 -0
  12. package/dist/lib/ascii/oscilloscope.js +153 -0
  13. package/dist/lib/ascii/oscilloscope.js.map +1 -0
  14. package/dist/lib/ascii/oscilloscope_capture_properties.d.ts +16 -0
  15. package/dist/lib/ascii/oscilloscope_capture_properties.js +18 -0
  16. package/dist/lib/ascii/oscilloscope_capture_properties.js.map +1 -0
  17. package/dist/lib/ascii/oscilloscope_data.d.ts +67 -0
  18. package/dist/lib/ascii/oscilloscope_data.js +151 -0
  19. package/dist/lib/ascii/oscilloscope_data.js.map +1 -0
  20. package/dist/lib/ascii/paramset_info.d.ts +17 -0
  21. package/dist/lib/ascii/paramset_info.js +19 -0
  22. package/dist/lib/ascii/paramset_info.js.map +1 -0
  23. package/dist/lib/ascii/pid_tuning.d.ts +32 -0
  24. package/dist/lib/ascii/pid_tuning.js +22 -0
  25. package/dist/lib/ascii/pid_tuning.js.map +1 -0
  26. package/dist/lib/ascii/servo_tuner.d.ts +77 -0
  27. package/dist/lib/ascii/servo_tuner.js +180 -0
  28. package/dist/lib/ascii/servo_tuner.js.map +1 -0
  29. package/dist/lib/ascii/servo_tuning_param.d.ts +16 -0
  30. package/dist/lib/ascii/servo_tuning_param.js +49 -0
  31. package/dist/lib/ascii/servo_tuning_param.js.map +1 -0
  32. package/dist/lib/ascii/servo_tuning_paramset.d.ts +17 -0
  33. package/dist/lib/ascii/servo_tuning_paramset.js +24 -0
  34. package/dist/lib/ascii/servo_tuning_paramset.js.map +1 -0
  35. package/dist/lib/ascii/simple_tuning_param.d.ts +24 -0
  36. package/dist/lib/ascii/simple_tuning_param.js +20 -0
  37. package/dist/lib/ascii/simple_tuning_param.js.map +1 -0
  38. package/dist/lib/ascii/stream.d.ts +7 -0
  39. package/dist/lib/ascii/stream.js +14 -0
  40. package/dist/lib/ascii/stream.js.map +1 -1
  41. package/dist/lib/ascii/stream_axis_definition.js +3 -0
  42. package/dist/lib/ascii/stream_axis_definition.js.map +1 -1
  43. package/dist/lib/ascii/transport.d.ts +4 -0
  44. package/dist/lib/ascii/transport.js +4 -0
  45. package/dist/lib/ascii/transport.js.map +1 -1
  46. package/dist/lib/ascii_ns.d.ts +18 -0
  47. package/dist/lib/ascii_ns.js +9 -0
  48. package/dist/lib/ascii_ns.js.map +1 -1
  49. package/dist/lib/exceptions/index.d.ts +1 -0
  50. package/dist/lib/exceptions/index.js +4 -2
  51. package/dist/lib/exceptions/index.js.map +1 -1
  52. package/dist/lib/exceptions/invalid_operation_exception.d.ts +7 -0
  53. package/dist/lib/exceptions/invalid_operation_exception.js +17 -0
  54. package/dist/lib/exceptions/invalid_operation_exception.js.map +1 -0
  55. package/dist/lib/gateway/convert_exceptions.js +1 -0
  56. package/dist/lib/gateway/convert_exceptions.js.map +1 -1
  57. package/dist/lib/gcode/axis_definition.d.ts +18 -0
  58. package/dist/lib/gcode/{translator_axis_definition.js → axis_definition.js} +11 -10
  59. package/dist/lib/gcode/axis_definition.js.map +1 -0
  60. package/dist/lib/gcode/axis_mapping.js +3 -0
  61. package/dist/lib/gcode/axis_mapping.js.map +1 -1
  62. package/dist/lib/gcode/axis_transformation.d.ts +21 -0
  63. package/dist/lib/gcode/axis_transformation.js +43 -0
  64. package/dist/lib/gcode/axis_transformation.js.map +1 -0
  65. package/dist/lib/gcode/device_definition.d.ts +24 -0
  66. package/dist/lib/gcode/{translator_definition.js → device_definition.js} +14 -9
  67. package/dist/lib/gcode/device_definition.js.map +1 -0
  68. package/dist/lib/gcode/index.d.ts +4 -3
  69. package/dist/lib/gcode/index.js +9 -7
  70. package/dist/lib/gcode/index.js.map +1 -1
  71. package/dist/lib/gcode/offline_translator.d.ts +114 -0
  72. package/dist/lib/gcode/offline_translator.js +226 -0
  73. package/dist/lib/gcode/offline_translator.js.map +1 -0
  74. package/dist/lib/gcode/translator.d.ts +66 -12
  75. package/dist/lib/gcode/translator.js +113 -17
  76. package/dist/lib/gcode/translator.js.map +1 -1
  77. package/dist/lib/gcode/translator_config.d.ts +6 -6
  78. package/dist/lib/gcode/translator_config.js +7 -4
  79. package/dist/lib/gcode/translator_config.js.map +1 -1
  80. package/dist/lib/gcode_ns.d.ts +8 -6
  81. package/dist/lib/gcode_ns.js +4 -3
  82. package/dist/lib/gcode_ns.js.map +1 -1
  83. package/dist/lib/measurement.js +3 -0
  84. package/dist/lib/measurement.js.map +1 -1
  85. package/dist/lib/protobufs/main_pb.d.ts +1011 -30
  86. package/dist/lib/protobufs/main_pb.js +12857 -5306
  87. package/dist/lib/protobufs/main_pb.js.map +1 -1
  88. package/dist/lib/tools.d.ts +6 -0
  89. package/dist/lib/tools.js +10 -0
  90. package/dist/lib/tools.js.map +1 -1
  91. package/package.json +1 -1
  92. package/dist/lib/gcode/translator_axis_definition.d.ts +0 -20
  93. package/dist/lib/gcode/translator_axis_definition.js.map +0 -1
  94. package/dist/lib/gcode/translator_definition.d.ts +0 -18
  95. package/dist/lib/gcode/translator_definition.js.map +0 -1
  96. package/dist/lib/gcode/translator_live.d.ts +0 -70
  97. package/dist/lib/gcode/translator_live.js +0 -147
  98. package/dist/lib/gcode/translator_live.js.map +0 -1
@@ -7,4 +7,10 @@ export declare class Tools {
7
7
  * @return Array of serial port names.
8
8
  */
9
9
  static listSerialPorts(): Promise<string[]>;
10
+ /**
11
+ * Returns path of message router named pipe on Windows
12
+ * or file path of unix domain socket on UNIX.
13
+ * @return Path of message router's named pipe or unix domain socket.
14
+ */
15
+ static getMessageRouterPipePath(): string;
10
16
  }
package/dist/lib/tools.js CHANGED
@@ -36,6 +36,16 @@ class Tools {
36
36
  const response = await gateway.callAsync('tools/list_serial_ports', request, gateway.ToolsListSerialPortsResponse);
37
37
  return response.getPortsList();
38
38
  }
39
+ /**
40
+ * Returns path of message router named pipe on Windows
41
+ * or file path of unix domain socket on UNIX.
42
+ * @return Path of message router's named pipe or unix domain socket.
43
+ */
44
+ static getMessageRouterPipePath() {
45
+ const request = new gateway.EmptyRequest();
46
+ const response = gateway.callSync('tools/get_message_router_pipe', request, gateway.GetMessageRouterPipeResponse);
47
+ return response.getValue();
48
+ }
39
49
  }
40
50
  exports.Tools = Tools;
41
51
  //# sourceMappingURL=tools.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/tools.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,mDAAqC;AAErC;;GAEG;AACH,MAAa,KAAK;IAEhB;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,4BAA4B,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,YAAY,EAAE,CAAC;IACjC,CAAC;CACF;AAfD,sBAeC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from './gateway';\n\n/**\n * Class providing various utility functions.\n */\nexport class Tools {\n\n /**\n * Lists all serial ports on the computer.\n * @return Array of serial port names.\n */\n public static async listSerialPorts(): Promise<string[]> {\n const request = new gateway.EmptyRequest();\n\n const response = await gateway.callAsync<gateway.ToolsListSerialPortsResponse>(\n 'tools/list_serial_ports',\n request,\n gateway.ToolsListSerialPortsResponse);\n return response.getPortsList();\n }\n}\n"]}
1
+ {"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/tools.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;AAEtD,mDAAqC;AAErC;;GAEG;AACH,MAAa,KAAK;IAEhB;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,4BAA4B,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,YAAY,EAAE,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,wBAAwB;QACpC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAE3C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,+BAA+B,EAC/B,OAAO,EACP,OAAO,CAAC,4BAA4B,CAAC,CAAC;QACxC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AA9BD,sBA8BC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from './gateway';\n\n/**\n * Class providing various utility functions.\n */\nexport class Tools {\n\n /**\n * Lists all serial ports on the computer.\n * @return Array of serial port names.\n */\n public static async listSerialPorts(): Promise<string[]> {\n const request = new gateway.EmptyRequest();\n\n const response = await gateway.callAsync<gateway.ToolsListSerialPortsResponse>(\n 'tools/list_serial_ports',\n request,\n gateway.ToolsListSerialPortsResponse);\n return response.getPortsList();\n }\n\n /**\n * Returns path of message router named pipe on Windows\n * or file path of unix domain socket on UNIX.\n * @return Path of message router's named pipe or unix domain socket.\n */\n public static getMessageRouterPipePath(): string {\n const request = new gateway.EmptyRequest();\n\n const response = gateway.callSync<gateway.GetMessageRouterPipeResponse>(\n 'tools/get_message_router_pipe',\n request,\n gateway.GetMessageRouterPipeResponse);\n return response.getValue();\n }\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zaber/motion",
3
- "version": "2.9.1",
3
+ "version": "2.11.0",
4
4
  "description": "Zaber Motion Library is a multi-platform library used to operate Zaber devices.",
5
5
  "keywords": [],
6
6
  "main": "dist/lib/index.js",
@@ -1,20 +0,0 @@
1
- /**
2
- * Defines an axis of the translator.
3
- */
4
- export interface TranslatorAxisDefinition {
5
- /**
6
- * Letter of the axis (X,Y,Z,A,B,C,E).
7
- */
8
- axisLetter: string;
9
- /**
10
- * ID of the peripheral.
11
- */
12
- peripheralId: number;
13
- /**
14
- * Microstep resolution of the axis.
15
- */
16
- microstepResolution: number;
17
- }
18
- export declare namespace TranslatorAxisDefinition {
19
- const __type = "TranslatorAxisDefinition";
20
- }
@@ -1 +0,0 @@
1
- {"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"]}
@@ -1,18 +0,0 @@
1
- import { TranslatorAxisDefinition } from './translator_axis_definition';
2
- /**
3
- * Defines an axis of the translator.
4
- */
5
- export interface TranslatorDefinition {
6
- /**
7
- * Device ID of the controller.
8
- * Can be obtained from device settings.
9
- */
10
- deviceId: number;
11
- /**
12
- * Axes of translator.
13
- */
14
- axes: TranslatorAxisDefinition[];
15
- }
16
- export declare namespace TranslatorDefinition {
17
- const __type = "TranslatorDefinition";
18
- }
@@ -1 +0,0 @@
1
- {"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"]}
@@ -1,70 +0,0 @@
1
- import { TranslateResult } from './translate_result';
2
- import { TranslatorConfig } from './translator_config';
3
- import { Stream } from '../ascii/stream';
4
- import { Angle, Length, Native, AngularVelocity, Velocity } from '../units';
5
- export declare class TranslatorLive {
6
- /**
7
- * The ID of the translator that serves to identify native resources.
8
- */
9
- get translatorId(): number;
10
- private _translatorId;
11
- constructor(translatorId: number);
12
- /**
13
- * Sets up the translator on top of a provided stream.
14
- * @param stream The stream to setup the translator on.
15
- * The stream must be already setup in a live or a store mode.
16
- * @param config Configuration of the translator.
17
- * @return New instance of translator.
18
- */
19
- static setup(stream: Stream, config: TranslatorConfig): TranslatorLive;
20
- /**
21
- * Translates a single block (line) of G-code.
22
- * The commands are queued in the underlying stream to ensure smooth continues movement.
23
- * Returning of this method indicates that the commands are queued (not necessarily executed).
24
- * @param block Block (line) of G-code.
25
- * @return Result of translation containing the commands sent to the device.
26
- */
27
- translate(block: string): Promise<TranslateResult>;
28
- /**
29
- * Sets the speed at which the device moves when traversing (G0).
30
- * @param traverseRate The traverse rate.
31
- * @param unit Units of the traverse rate.
32
- */
33
- setTraverseRate(traverseRate: number, unit: Velocity | AngularVelocity | Native): void;
34
- /**
35
- * Sets position of translator's axis.
36
- * Use this method to set position after performing movement outside of the translator.
37
- * This method does not cause any movement.
38
- * @param axis Letter of the axis.
39
- * @param position The position.
40
- * @param unit Units of position.
41
- */
42
- setAxisPosition(axis: string, position: number, unit: Length | Angle | Native): void;
43
- /**
44
- * Gets position of translator's axis.
45
- * This method does not query device but returns value from translator's state.
46
- * @param axis Letter of the axis.
47
- * @param unit Units of position.
48
- * @return Position of translator's axis.
49
- */
50
- getAxisPosition(axis: string, unit: Length | Angle | Native): number;
51
- /**
52
- * Sets default position of translator's axis.
53
- * This position is used by G28.
54
- * @param axis Letter of the axis.
55
- * @param position The default position.
56
- * @param unit Units of position.
57
- */
58
- setAxisDefaultPosition(axis: string, position: number, unit: Length | Angle | Native): void;
59
- /**
60
- * Releases native resources of a translator.
61
- * @param translatorId The ID of the translator.
62
- */
63
- private static _free;
64
- /**
65
- * Releases the native resources of the translator.
66
- * Should only be called if your environment does not support FinalizationRegistry.
67
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
68
- */
69
- free(): void;
70
- }
@@ -1,147 +0,0 @@
1
- "use strict";
2
- // ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
3
- // ============= DO NOT EDIT DIRECTLY ============= //
4
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
5
- if (k2 === undefined) k2 = k;
6
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
7
- }) : (function(o, m, k, k2) {
8
- if (k2 === undefined) k2 = k;
9
- o[k2] = m[k];
10
- }));
11
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
12
- Object.defineProperty(o, "default", { enumerable: true, value: v });
13
- }) : function(o, v) {
14
- o["default"] = v;
15
- });
16
- var __importStar = (this && this.__importStar) || function (mod) {
17
- if (mod && mod.__esModule) return mod;
18
- var result = {};
19
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
20
- __setModuleDefault(result, mod);
21
- return result;
22
- };
23
- Object.defineProperty(exports, "__esModule", { value: true });
24
- exports.TranslatorLive = void 0;
25
- const gateway = __importStar(require("../gateway"));
26
- const translate_result_1 = require("./translate_result");
27
- const translator_config_1 = require("./translator_config");
28
- const finalizer_1 = require("../finalizer");
29
- class TranslatorLive {
30
- constructor(translatorId) {
31
- this._translatorId = translatorId;
32
- (0, finalizer_1.registerForFinalization)(this, TranslatorLive._free.bind(null, translatorId));
33
- }
34
- /**
35
- * The ID of the translator that serves to identify native resources.
36
- */
37
- get translatorId() {
38
- return this._translatorId;
39
- }
40
- /**
41
- * Sets up the translator on top of a provided stream.
42
- * @param stream The stream to setup the translator on.
43
- * The stream must be already setup in a live or a store mode.
44
- * @param config Configuration of the translator.
45
- * @return New instance of translator.
46
- */
47
- static setup(stream, config) {
48
- const request = new gateway.TranslatorCreateLiveRequest();
49
- request.setDevice(stream.device.deviceAddress);
50
- request.setInterfaceId(stream.device.connection.interfaceId);
51
- request.setStreamId(stream.streamId);
52
- request.setConfig(translator_config_1.TranslatorConfig.toProtobuf(config));
53
- const response = gateway.callSync('gcode/create_live', request, gateway.TranslatorCreateResponse);
54
- return new TranslatorLive(response.getTranslatorId());
55
- }
56
- /**
57
- * Translates a single block (line) of G-code.
58
- * The commands are queued in the underlying stream to ensure smooth continues movement.
59
- * Returning of this method indicates that the commands are queued (not necessarily executed).
60
- * @param block Block (line) of G-code.
61
- * @return Result of translation containing the commands sent to the device.
62
- */
63
- async translate(block) {
64
- const request = new gateway.TranslatorTranslateRequest();
65
- request.setTranslatorId(this.translatorId);
66
- request.setBlock(block);
67
- const response = await gateway.callAsync('gcode/translate_live', request, gateway.TranslatorTranslateResponse);
68
- return translate_result_1.TranslateResult.fromProtobuf(response.toObject());
69
- }
70
- /**
71
- * Sets the speed at which the device moves when traversing (G0).
72
- * @param traverseRate The traverse rate.
73
- * @param unit Units of the traverse rate.
74
- */
75
- setTraverseRate(traverseRate, unit) {
76
- const request = new gateway.TranslatorSetTraverseRateRequest();
77
- request.setTranslatorId(this.translatorId);
78
- request.setTraverseRate(traverseRate);
79
- request.setUnit(unit);
80
- gateway.callSync('gcode/set_traverse_rate', request);
81
- }
82
- /**
83
- * Sets position of translator's axis.
84
- * Use this method to set position after performing movement outside of the translator.
85
- * This method does not cause any movement.
86
- * @param axis Letter of the axis.
87
- * @param position The position.
88
- * @param unit Units of position.
89
- */
90
- setAxisPosition(axis, position, unit) {
91
- const request = new gateway.TranslatorSetAxisPositionRequest();
92
- request.setTranslatorId(this.translatorId);
93
- request.setAxis(axis);
94
- request.setPosition(position);
95
- request.setUnit(unit);
96
- gateway.callSync('gcode/set_axis_position', request);
97
- }
98
- /**
99
- * Gets position of translator's axis.
100
- * This method does not query device but returns value from translator's state.
101
- * @param axis Letter of the axis.
102
- * @param unit Units of position.
103
- * @return Position of translator's axis.
104
- */
105
- getAxisPosition(axis, unit) {
106
- const request = new gateway.TranslatorGetAxisPositionRequest();
107
- request.setTranslatorId(this.translatorId);
108
- request.setAxis(axis);
109
- request.setUnit(unit);
110
- const response = gateway.callSync('gcode/get_axis_position', request, gateway.TranslatorGetAxisPositionResponse);
111
- return response.getValue();
112
- }
113
- /**
114
- * Sets default position of translator's axis.
115
- * This position is used by G28.
116
- * @param axis Letter of the axis.
117
- * @param position The default position.
118
- * @param unit Units of position.
119
- */
120
- setAxisDefaultPosition(axis, position, unit) {
121
- const request = new gateway.TranslatorSetAxisPositionRequest();
122
- request.setTranslatorId(this.translatorId);
123
- request.setAxis(axis);
124
- request.setPosition(position);
125
- request.setUnit(unit);
126
- gateway.callSync('gcode/set_axis_default', request);
127
- }
128
- /**
129
- * Releases native resources of a translator.
130
- * @param translatorId The ID of the translator.
131
- */
132
- static _free(translatorId) {
133
- const request = new gateway.TranslatorEmptyRequest();
134
- request.setTranslatorId(translatorId);
135
- gateway.callSync('gcode/free', request);
136
- }
137
- /**
138
- * Releases the native resources of the translator.
139
- * Should only be called if your environment does not support FinalizationRegistry.
140
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/FinalizationRegistry
141
- */
142
- free() {
143
- TranslatorLive._free(this.translatorId);
144
- }
145
- }
146
- exports.TranslatorLive = TranslatorLive;
147
- //# sourceMappingURL=translator_live.js.map
@@ -1 +0,0 @@
1
- {"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"]}