@zaber/motion 2.15.4 → 3.0.1

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 (126) hide show
  1. package/dist/binding/wasm/zaber-motion-lib.wasm +0 -0
  2. package/dist/lib/ascii/all_axes.d.ts +21 -9
  3. package/dist/lib/ascii/all_axes.js +12 -9
  4. package/dist/lib/ascii/all_axes.js.map +1 -1
  5. package/dist/lib/ascii/axis.d.ts +116 -58
  6. package/dist/lib/ascii/axis.js +74 -58
  7. package/dist/lib/ascii/axis.js.map +1 -1
  8. package/dist/lib/ascii/axis_settings.d.ts +11 -10
  9. package/dist/lib/ascii/axis_settings.js +11 -10
  10. package/dist/lib/ascii/axis_settings.js.map +1 -1
  11. package/dist/lib/ascii/connection.d.ts +91 -68
  12. package/dist/lib/ascii/connection.js +60 -86
  13. package/dist/lib/ascii/connection.js.map +1 -1
  14. package/dist/lib/ascii/device.d.ts +46 -25
  15. package/dist/lib/ascii/device.js +31 -25
  16. package/dist/lib/ascii/device.js.map +1 -1
  17. package/dist/lib/ascii/device_io.d.ts +9 -9
  18. package/dist/lib/ascii/device_io.js +9 -9
  19. package/dist/lib/ascii/device_io.js.map +1 -1
  20. package/dist/lib/ascii/device_settings.d.ts +10 -10
  21. package/dist/lib/ascii/device_settings.js +10 -10
  22. package/dist/lib/ascii/device_settings.js.map +1 -1
  23. package/dist/lib/ascii/lockstep.d.ts +99 -49
  24. package/dist/lib/ascii/lockstep.js +63 -49
  25. package/dist/lib/ascii/lockstep.js.map +1 -1
  26. package/dist/lib/ascii/oscilloscope.d.ts +14 -13
  27. package/dist/lib/ascii/oscilloscope.js +14 -13
  28. package/dist/lib/ascii/oscilloscope.js.map +1 -1
  29. package/dist/lib/ascii/oscilloscope_data.d.ts +9 -9
  30. package/dist/lib/ascii/oscilloscope_data.js +9 -9
  31. package/dist/lib/ascii/oscilloscope_data.js.map +1 -1
  32. package/dist/lib/ascii/servo_tuner.d.ts +20 -10
  33. package/dist/lib/ascii/servo_tuner.js +13 -10
  34. package/dist/lib/ascii/servo_tuner.js.map +1 -1
  35. package/dist/lib/ascii/setting_constants.d.ts +2 -2
  36. package/dist/lib/ascii/setting_constants.js +2 -2
  37. package/dist/lib/ascii/setting_constants.js.map +1 -1
  38. package/dist/lib/ascii/storage.d.ts +49 -24
  39. package/dist/lib/ascii/storage.js +32 -24
  40. package/dist/lib/ascii/storage.js.map +1 -1
  41. package/dist/lib/ascii/stream.d.ts +29 -17
  42. package/dist/lib/ascii/stream.js +24 -17
  43. package/dist/lib/ascii/stream.js.map +1 -1
  44. package/dist/lib/ascii/stream_buffer.d.ts +1 -1
  45. package/dist/lib/ascii/stream_buffer.js +1 -1
  46. package/dist/lib/ascii/stream_buffer.js.map +1 -1
  47. package/dist/lib/ascii/transport.d.ts +2 -2
  48. package/dist/lib/ascii/transport.js +2 -2
  49. package/dist/lib/ascii/transport.js.map +1 -1
  50. package/dist/lib/ascii/warnings.d.ts +2 -2
  51. package/dist/lib/ascii/warnings.js +2 -2
  52. package/dist/lib/ascii/warnings.js.map +1 -1
  53. package/dist/lib/binary/connection.d.ts +46 -25
  54. package/dist/lib/binary/connection.js +30 -25
  55. package/dist/lib/binary/connection.js.map +1 -1
  56. package/dist/lib/binary/device.d.ts +66 -38
  57. package/dist/lib/binary/device.js +48 -38
  58. package/dist/lib/binary/device.js.map +1 -1
  59. package/dist/lib/binary/device_identity.d.ts +1 -0
  60. package/dist/lib/binary/device_identity.js.map +1 -1
  61. package/dist/lib/binary/device_settings.d.ts +3 -3
  62. package/dist/lib/binary/device_settings.js +3 -3
  63. package/dist/lib/binary/device_settings.js.map +1 -1
  64. package/dist/lib/exceptions/binary_command_failed_exception.js.map +1 -1
  65. package/dist/lib/exceptions/command_failed_exception.js.map +1 -1
  66. package/dist/lib/exceptions/command_preempted_exception.js.map +1 -1
  67. package/dist/lib/exceptions/command_too_long_exception.js.map +1 -1
  68. package/dist/lib/exceptions/connection_closed_exception.js.map +1 -1
  69. package/dist/lib/exceptions/connection_failed_exception.js.map +1 -1
  70. package/dist/lib/exceptions/conversion_failed_exception.js.map +1 -1
  71. package/dist/lib/exceptions/device_address_conflict_exception.js.map +1 -1
  72. package/dist/lib/exceptions/device_busy_exception.js.map +1 -1
  73. package/dist/lib/exceptions/device_db_failed_exception.js.map +1 -1
  74. package/dist/lib/exceptions/device_failed_exception.js.map +1 -1
  75. package/dist/lib/exceptions/device_not_identified_exception.js.map +1 -1
  76. package/dist/lib/exceptions/g_code_execution_exception.js.map +1 -1
  77. package/dist/lib/exceptions/g_code_syntax_exception.js.map +1 -1
  78. package/dist/lib/exceptions/internal_error_exception.js.map +1 -1
  79. package/dist/lib/exceptions/invalid_argument_exception.js.map +1 -1
  80. package/dist/lib/exceptions/invalid_data_exception.js.map +1 -1
  81. package/dist/lib/exceptions/invalid_operation_exception.js.map +1 -1
  82. package/dist/lib/exceptions/invalid_packet_exception.js.map +1 -1
  83. package/dist/lib/exceptions/invalid_park_state_exception.js.map +1 -1
  84. package/dist/lib/exceptions/invalid_response_exception.js.map +1 -1
  85. package/dist/lib/exceptions/io_channel_out_of_range_exception.js.map +1 -1
  86. package/dist/lib/exceptions/io_failed_exception.js.map +1 -1
  87. package/dist/lib/exceptions/lockstep_enabled_exception.js.map +1 -1
  88. package/dist/lib/exceptions/lockstep_not_enabled_exception.js.map +1 -1
  89. package/dist/lib/exceptions/motion_lib_exception.js.map +1 -1
  90. package/dist/lib/exceptions/movement_failed_exception.js.map +1 -1
  91. package/dist/lib/exceptions/movement_interrupted_exception.js.map +1 -1
  92. package/dist/lib/exceptions/no_device_found_exception.js.map +1 -1
  93. package/dist/lib/exceptions/no_value_for_key_exception.js.map +1 -1
  94. package/dist/lib/exceptions/not_supported_exception.js.map +1 -1
  95. package/dist/lib/exceptions/os_failed_exception.js.map +1 -1
  96. package/dist/lib/exceptions/out_of_request_ids_exception.js.map +1 -1
  97. package/dist/lib/exceptions/request_timeout_exception.js.map +1 -1
  98. package/dist/lib/exceptions/serial_port_busy_exception.js.map +1 -1
  99. package/dist/lib/exceptions/set_device_state_failed_exception.js.map +1 -1
  100. package/dist/lib/exceptions/set_peripheral_state_failed_exception.js.map +1 -1
  101. package/dist/lib/exceptions/setting_not_found_exception.js.map +1 -1
  102. package/dist/lib/exceptions/stream_execution_exception.js.map +1 -1
  103. package/dist/lib/exceptions/stream_mode_exception.js.map +1 -1
  104. package/dist/lib/exceptions/stream_movement_failed_exception.js.map +1 -1
  105. package/dist/lib/exceptions/stream_movement_interrupted_exception.js.map +1 -1
  106. package/dist/lib/exceptions/stream_setup_failed_exception.js.map +1 -1
  107. package/dist/lib/exceptions/transport_already_used_exception.js.map +1 -1
  108. package/dist/lib/exceptions/unknown_request_exception.js.map +1 -1
  109. package/dist/lib/gateway/events.js +4 -5
  110. package/dist/lib/gateway/events.js.map +1 -1
  111. package/dist/lib/gateway/serialization.js.map +1 -1
  112. package/dist/lib/gcode/offline_translator.d.ts +8 -7
  113. package/dist/lib/gcode/offline_translator.js +8 -7
  114. package/dist/lib/gcode/offline_translator.js.map +1 -1
  115. package/dist/lib/gcode/translator.d.ts +15 -8
  116. package/dist/lib/gcode/translator.js +10 -8
  117. package/dist/lib/gcode/translator.js.map +1 -1
  118. package/dist/lib/library.d.ts +3 -3
  119. package/dist/lib/library.js +3 -3
  120. package/dist/lib/library.js.map +1 -1
  121. package/dist/lib/tools.d.ts +3 -3
  122. package/dist/lib/tools.js +3 -3
  123. package/dist/lib/tools.js.map +1 -1
  124. package/dist/lib/wasm.js +1 -3
  125. package/dist/lib/wasm.js.map +1 -1
  126. package/package.json +3 -3
@@ -4,13 +4,13 @@ export declare class Library {
4
4
  /**
5
5
  * Sets library logging output.
6
6
  * @param mode Logging output mode.
7
- * @param filePath Path of the file to open.
7
+ * @param [filePath=''] Path of the file to open.
8
8
  */
9
9
  static setLogOutput(mode: LogOutputMode, filePath?: string): void;
10
10
  /**
11
11
  * Sets source of Device DB data. Allows selection of a web service or a local file.
12
12
  * @param sourceType Source type.
13
- * @param urlOrFilePath URL of the web service or path to the local file.
13
+ * @param [urlOrFilePath=''] URL of the web service or path to the local file.
14
14
  * Leave empty for the default URL of Zaber web service.
15
15
  */
16
16
  static setDeviceDbSource(sourceType: DeviceDbSourceType, urlOrFilePath?: string): void;
@@ -18,7 +18,7 @@ export declare class Library {
18
18
  * Enables Device DB store.
19
19
  * The store uses filesystem to save information obtained from the Device DB.
20
20
  * The stored data are later used instead of the Device DB.
21
- * @param storeLocation Specifies relative or absolute path of the folder used by the store.
21
+ * @param [storeLocation=''] Specifies relative or absolute path of the folder used by the store.
22
22
  * If left empty defaults to a folder in user home directory.
23
23
  * Must be accessible by the process.
24
24
  */
@@ -31,7 +31,7 @@ class Library {
31
31
  /**
32
32
  * Sets library logging output.
33
33
  * @param mode Logging output mode.
34
- * @param filePath Path of the file to open.
34
+ * @param [filePath=''] Path of the file to open.
35
35
  */
36
36
  static setLogOutput(mode, filePath = '') {
37
37
  const request = new gateway.SetLogOutputRequest();
@@ -42,7 +42,7 @@ class Library {
42
42
  /**
43
43
  * Sets source of Device DB data. Allows selection of a web service or a local file.
44
44
  * @param sourceType Source type.
45
- * @param urlOrFilePath URL of the web service or path to the local file.
45
+ * @param [urlOrFilePath=''] URL of the web service or path to the local file.
46
46
  * Leave empty for the default URL of Zaber web service.
47
47
  */
48
48
  static setDeviceDbSource(sourceType, urlOrFilePath = '') {
@@ -55,7 +55,7 @@ class Library {
55
55
  * Enables Device DB store.
56
56
  * The store uses filesystem to save information obtained from the Device DB.
57
57
  * The stored data are later used instead of the Device DB.
58
- * @param storeLocation Specifies relative or absolute path of the folder used by the store.
58
+ * @param [storeLocation=''] Specifies relative or absolute path of the folder used by the store.
59
59
  * If left empty defaults to a folder in user home directory.
60
60
  * Must be accessible by the process.
61
61
  */
@@ -1 +1 @@
1
- {"version":3,"file":"library.js","sourceRoot":"","sources":["../../src/library.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,mDAAqC;AAIrC,MAAa,OAAO;IAElB;;;;OAIG;IACI,MAAM,CAAC,YAAY,CACxB,IAAmB,EACnB,WAAmB,EAAE;QAErB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAW,CAAC,CAAC;QAC7B,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAE9B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAC7B,UAA8B,EAC9B,gBAAwB,EAAE;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACvD,OAAO,CAAC,aAAa,CAAC,UAAiB,CAAC,CAAC;QACzC,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,mBAAmB,CAC/B,gBAAwB,EAAE;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1B,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,OAAO,CAAC,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oBAAoB;QAChC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QAEzD,OAAO,CAAC,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAC3B,IAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,CAAC,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AA1ED,0BA0EC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from './gateway';\nimport { LogOutputMode } from './log_output_mode';\nimport { DeviceDbSourceType } from './device_db_source_type';\n\nexport class Library {\n\n /**\n * Sets library logging output.\n * @param mode Logging output mode.\n * @param filePath Path of the file to open.\n */\n public static setLogOutput(\n mode: LogOutputMode,\n filePath: string = ''\n ): void {\n const request = new gateway.SetLogOutputRequest();\n request.setMode(mode as any);\n request.setFilePath(filePath);\n\n gateway.callSync('logging/set_output', request);\n }\n\n /**\n * Sets source of Device DB data. Allows selection of a web service or a local file.\n * @param sourceType Source type.\n * @param urlOrFilePath URL of the web service or path to the local file.\n * Leave empty for the default URL of Zaber web service.\n */\n public static setDeviceDbSource(\n sourceType: DeviceDbSourceType,\n urlOrFilePath: string = ''\n ): void {\n const request = new gateway.SetDeviceDbSourceRequest();\n request.setSourceType(sourceType as any);\n request.setUrlOrFilePath(urlOrFilePath);\n\n gateway.callSync('device_db/set_source', request);\n }\n\n /**\n * Enables Device DB store.\n * The store uses filesystem to save information obtained from the Device DB.\n * The stored data are later used instead of the Device DB.\n * @param storeLocation Specifies relative or absolute path of the folder used by the store.\n * If left empty defaults to a folder in user home directory.\n * Must be accessible by the process.\n */\n public static enableDeviceDbStore(\n storeLocation: string = ''\n ): void {\n const request = new gateway.ToggleDeviceDbStoreRequest();\n request.setToggleOn(true);\n request.setStoreLocation(storeLocation);\n\n gateway.callSync('device_db/toggle_store', request);\n }\n\n /**\n * Disables Device DB store.\n */\n public static disableDeviceDbStore(): void {\n const request = new gateway.ToggleDeviceDbStoreRequest();\n\n gateway.callSync('device_db/toggle_store', request);\n }\n\n /**\n * Disables certain customer checks (like FF flag).\n * @param mode Whether to turn internal mode on or off.\n */\n public static setInternalMode(\n mode: boolean\n ): void {\n const request = new gateway.SetInternalModeRequest();\n request.setMode(mode);\n\n gateway.callSync('library/set_internal_mode', request);\n }\n}\n"]}
1
+ {"version":3,"file":"library.js","sourceRoot":"","sources":["../../src/library.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtD,mDAAqC;AAIrC,MAAa,OAAO;IAClB;;;;OAIG;IACI,MAAM,CAAC,YAAY,CACxB,IAAmB,EACnB,WAAmB,EAAE;QAErB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAClD,OAAO,CAAC,OAAO,CAAC,IAAW,CAAC,CAAC;QAC7B,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAE9B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAC7B,UAA8B,EAC9B,gBAAwB,EAAE;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACvD,OAAO,CAAC,aAAa,CAAC,UAAiB,CAAC,CAAC;QACzC,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,mBAAmB,CAC/B,gBAAwB,EAAE;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1B,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,OAAO,CAAC,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,oBAAoB;QAChC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QAEzD,OAAO,CAAC,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAC3B,IAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,sBAAsB,EAAE,CAAC;QACrD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,CAAC,QAAQ,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAzED,0BAyEC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport * as gateway from './gateway';\nimport { LogOutputMode } from './log_output_mode';\nimport { DeviceDbSourceType } from './device_db_source_type';\n\nexport class Library {\n /**\n * Sets library logging output.\n * @param mode Logging output mode.\n * @param [filePath=''] Path of the file to open.\n */\n public static setLogOutput(\n mode: LogOutputMode,\n filePath: string = ''\n ): void {\n const request = new gateway.SetLogOutputRequest();\n request.setMode(mode as any);\n request.setFilePath(filePath);\n\n gateway.callSync('logging/set_output', request);\n }\n\n /**\n * Sets source of Device DB data. Allows selection of a web service or a local file.\n * @param sourceType Source type.\n * @param [urlOrFilePath=''] URL of the web service or path to the local file.\n * Leave empty for the default URL of Zaber web service.\n */\n public static setDeviceDbSource(\n sourceType: DeviceDbSourceType,\n urlOrFilePath: string = ''\n ): void {\n const request = new gateway.SetDeviceDbSourceRequest();\n request.setSourceType(sourceType as any);\n request.setUrlOrFilePath(urlOrFilePath);\n\n gateway.callSync('device_db/set_source', request);\n }\n\n /**\n * Enables Device DB store.\n * The store uses filesystem to save information obtained from the Device DB.\n * The stored data are later used instead of the Device DB.\n * @param [storeLocation=''] Specifies relative or absolute path of the folder used by the store.\n * If left empty defaults to a folder in user home directory.\n * Must be accessible by the process.\n */\n public static enableDeviceDbStore(\n storeLocation: string = ''\n ): void {\n const request = new gateway.ToggleDeviceDbStoreRequest();\n request.setToggleOn(true);\n request.setStoreLocation(storeLocation);\n\n gateway.callSync('device_db/toggle_store', request);\n }\n\n /**\n * Disables Device DB store.\n */\n public static disableDeviceDbStore(): void {\n const request = new gateway.ToggleDeviceDbStoreRequest();\n\n gateway.callSync('device_db/toggle_store', request);\n }\n\n /**\n * Disables certain customer checks (like FF flag).\n * @param mode Whether to turn internal mode on or off.\n */\n public static setInternalMode(\n mode: boolean\n ): void {\n const request = new gateway.SetInternalModeRequest();\n request.setMode(mode);\n\n gateway.callSync('library/set_internal_mode', request);\n }\n}\n"]}
@@ -4,19 +4,19 @@
4
4
  export declare class Tools {
5
5
  /**
6
6
  * Lists all serial ports on the computer.
7
- * @return Array of serial port names.
7
+ * @returns Array of serial port names.
8
8
  */
9
9
  static listSerialPorts(): Promise<string[]>;
10
10
  /**
11
11
  * Returns path of message router named pipe on Windows
12
12
  * or file path of unix domain socket on UNIX.
13
- * @return Path of message router's named pipe or unix domain socket.
13
+ * @returns Path of message router's named pipe or unix domain socket.
14
14
  */
15
15
  static getMessageRouterPipePath(): string;
16
16
  /**
17
17
  * Returns the path for communicating with a local device database service.
18
18
  * This will be a named pipe on Windows and the file path of a unix domain socket on UNIX.
19
- * @return Path of database service's named pipe or unix domain socket.
19
+ * @returns Path of database service's named pipe or unix domain socket.
20
20
  */
21
21
  static getDbServicePipePath(): string;
22
22
  }
package/dist/lib/tools.js CHANGED
@@ -33,7 +33,7 @@ const gateway = __importStar(require("./gateway"));
33
33
  class Tools {
34
34
  /**
35
35
  * Lists all serial ports on the computer.
36
- * @return Array of serial port names.
36
+ * @returns Array of serial port names.
37
37
  */
38
38
  static async listSerialPorts() {
39
39
  const request = new gateway.EmptyRequest();
@@ -43,7 +43,7 @@ class Tools {
43
43
  /**
44
44
  * Returns path of message router named pipe on Windows
45
45
  * or file path of unix domain socket on UNIX.
46
- * @return Path of message router's named pipe or unix domain socket.
46
+ * @returns Path of message router's named pipe or unix domain socket.
47
47
  */
48
48
  static getMessageRouterPipePath() {
49
49
  const request = new gateway.EmptyRequest();
@@ -53,7 +53,7 @@ class Tools {
53
53
  /**
54
54
  * Returns the path for communicating with a local device database service.
55
55
  * This will be a named pipe on Windows and the file path of a unix domain socket on UNIX.
56
- * @return Path of database service's named pipe or unix domain socket.
56
+ * @returns Path of database service's named pipe or unix domain socket.
57
57
  */
58
58
  static getDbServicePipePath() {
59
59
  const request = new gateway.EmptyRequest();
@@ -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;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,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,oBAAoB;QAChC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAE3C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AA7CD,sBA6CC","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.StringResponse>(\n 'tools/get_message_router_pipe',\n request,\n gateway.StringResponse);\n return response.getValue();\n }\n\n /**\n * Returns the path for communicating with a local device database service.\n * This will be a named pipe on Windows and the file path of a unix domain socket on UNIX.\n * @return Path of database service's named pipe or unix domain socket.\n */\n public static getDbServicePipePath(): string {\n const request = new gateway.EmptyRequest();\n\n const response = gateway.callSync<gateway.StringResponse>(\n 'tools/get_db_service_pipe',\n request,\n gateway.StringResponse);\n return response.getValue();\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;IAChB;;;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,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,oBAAoB;QAChC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAE3C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AA5CD,sBA4CC","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 * Lists all serial ports on the computer.\n * @returns 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 * @returns 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.StringResponse>(\n 'tools/get_message_router_pipe',\n request,\n gateway.StringResponse);\n return response.getValue();\n }\n\n /**\n * Returns the path for communicating with a local device database service.\n * This will be a named pipe on Windows and the file path of a unix domain socket on UNIX.\n * @returns Path of database service's named pipe or unix domain socket.\n */\n public static getDbServicePipePath(): string {\n const request = new gateway.EmptyRequest();\n\n const response = gateway.callSync<gateway.StringResponse>(\n 'tools/get_db_service_pipe',\n request,\n gateway.StringResponse);\n return response.getValue();\n }\n}\n"]}
package/dist/lib/wasm.js CHANGED
@@ -5,9 +5,7 @@ const bindings_1 = require("./gateway/bindings");
5
5
  const wasm_1 = require("./gateway/wasm");
6
6
  let initializing = false;
7
7
  let runningWasm = null;
8
- const isRunning = () => {
9
- return runningWasm !== null;
10
- };
8
+ const isRunning = () => runningWasm !== null;
11
9
  exports.isRunning = isRunning;
12
10
  const init = async (fetchResponse) => {
13
11
  if ((0, exports.isRunning)() || initializing) {
@@ -1 +1 @@
1
- {"version":3,"file":"wasm.js","sourceRoot":"","sources":["../../src/wasm.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAC5C,yCAAwD;AAExD,IAAI,YAAY,GAAG,KAAK,CAAC;AACzB,IAAI,WAAW,GAAyB,IAAI,CAAC;AAEtC,MAAM,SAAS,GAAG,GAAY,EAAE;IACrC,OAAO,WAAW,KAAK,IAAI,CAAC;AAC9B,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB;AAEK,MAAM,IAAI,GAAG,KAAK,EAAE,aAA2B,EAA0B,EAAE;IAChF,IAAI,IAAA,iBAAS,GAAE,IAAI,YAAY,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;KAC7E;IAED,IAAA,iBAAM,EAAC,MAAM,CAAC,CAAC;IAEf,IAAI;QACF,YAAY,GAAG,IAAI,CAAC;QAEpB,WAAW,GAAG,MAAM,IAAA,cAAO,EAAC,aAAa,CAAC,CAAC;QAC3C,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;KAEjF;YAAS;QACR,YAAY,GAAG,KAAK,CAAC;KACtB;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAlBW,QAAA,IAAI,QAkBf;AAEK,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;IACjC,MAAM,WAAW,GAAG,WAAW,CAAC;IAChC,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO;KACR;IAED,MAAM,CAAC,aAAa,EAAE,CAAC;IACvB,MAAM,WAAW,CAAC,UAAU,CAAC;AAC/B,CAAC,CAAC;AARW,QAAA,QAAQ,YAQnB","sourcesContent":["import { setEnv } from './gateway/bindings';\nimport { runWasm, RunWasmResult } from './gateway/wasm';\n\nlet initializing = false;\nlet runningWasm: RunWasmResult | null = null;\n\nexport const isRunning = (): boolean => {\n return runningWasm !== null;\n};\n\nexport const init = async (fetchResponse: Promise<any>): Promise<RunWasmResult> => {\n if (isRunning() || initializing) {\n throw new Error('Zaber motion library already running or is initializing.');\n }\n\n setEnv('wasm');\n\n try {\n initializing = true;\n\n runningWasm = await runWasm(fetchResponse);\n runningWasm.runPromise.then(() => runningWasm = null, () => runningWasm = null);\n\n } finally {\n initializing = false;\n }\n\n return runningWasm;\n};\n\nexport const shutdown = async () => {\n const currentWasm = runningWasm;\n if (!currentWasm) {\n return;\n }\n\n window.__zmlShutdown();\n await currentWasm.runPromise;\n};\n"]}
1
+ {"version":3,"file":"wasm.js","sourceRoot":"","sources":["../../src/wasm.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAC5C,yCAAwD;AAExD,IAAI,YAAY,GAAG,KAAK,CAAC;AACzB,IAAI,WAAW,GAAyB,IAAI,CAAC;AAEtC,MAAM,SAAS,GAAG,GAAY,EAAE,CAAC,WAAW,KAAK,IAAI,CAAC;AAAhD,QAAA,SAAS,aAAuC;AAEtD,MAAM,IAAI,GAAG,KAAK,EAAE,aAA2B,EAA0B,EAAE;IAChF,IAAI,IAAA,iBAAS,GAAE,IAAI,YAAY,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;KAC7E;IAED,IAAA,iBAAM,EAAC,MAAM,CAAC,CAAC;IAEf,IAAI;QACF,YAAY,GAAG,IAAI,CAAC;QAEpB,WAAW,GAAG,MAAM,IAAA,cAAO,EAAC,aAAa,CAAC,CAAC;QAC3C,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;KACjF;YAAS;QACR,YAAY,GAAG,KAAK,CAAC;KACtB;IAED,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAjBW,QAAA,IAAI,QAiBf;AAEK,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;IACjC,MAAM,WAAW,GAAG,WAAW,CAAC;IAChC,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO;KACR;IAED,MAAM,CAAC,aAAa,EAAE,CAAC;IACvB,MAAM,WAAW,CAAC,UAAU,CAAC;AAC/B,CAAC,CAAC;AARW,QAAA,QAAQ,YAQnB","sourcesContent":["import { setEnv } from './gateway/bindings';\nimport { runWasm, RunWasmResult } from './gateway/wasm';\n\nlet initializing = false;\nlet runningWasm: RunWasmResult | null = null;\n\nexport const isRunning = (): boolean => runningWasm !== null;\n\nexport const init = async (fetchResponse: Promise<any>): Promise<RunWasmResult> => {\n if (isRunning() || initializing) {\n throw new Error('Zaber motion library already running or is initializing.');\n }\n\n setEnv('wasm');\n\n try {\n initializing = true;\n\n runningWasm = await runWasm(fetchResponse);\n runningWasm.runPromise.then(() => runningWasm = null, () => runningWasm = null);\n } finally {\n initializing = false;\n }\n\n return runningWasm;\n};\n\nexport const shutdown = async () => {\n const currentWasm = runningWasm;\n if (!currentWasm) {\n return;\n }\n\n window.__zmlShutdown();\n await currentWasm.runPromise;\n};\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zaber/motion",
3
- "version": "2.15.4",
3
+ "version": "3.0.1",
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",
@@ -17,7 +17,7 @@
17
17
  "url": "https://gitlab.com/ZaberTech/zaber-motion-lib.git"
18
18
  },
19
19
  "bugs": {
20
- "url": "https://www.zaber.com/software/docs/motion-library/ascii/support/contact/"
20
+ "url": "https://www.zaber.com/software/docs/motion-library/latest/ascii/support/contact/"
21
21
  },
22
22
  "homepage": "https://www.zaber.com/software/docs/motion-library/",
23
23
  "license": "MIT",
@@ -45,7 +45,7 @@
45
45
  "test:filtered": "mocha --opts mocha.opts \"test*/**/*.test.ts\" \"test-e2e/**/*.test.ts\" --grep",
46
46
  "test:coverage": "nyc mocha --opts mocha.opts \"test*/**/*.test.ts\" \"test-e2e/**/*.test.ts\"",
47
47
  "test:watch": "npm run test -- --watch",
48
- "test-web": "npx karma start test-e2e-web/karma.conf.js --single-run --browsers ChromeHeadless",
48
+ "test-web": "npx karma start test-e2e-web/karma.conf.js --single-run",
49
49
  "test-web:watch": "npx karma start test-e2e-web/karma.conf.js --browsers Chrome",
50
50
  "node-pre-gyp": "node-pre-gyp",
51
51
  "ts-node": "ts-node",