@zaber/motion 4.2.4 → 4.2.5

package/dist/lib/library.d.ts

@@ -32,4 +32,11 @@ export declare class Library {
      * @param mode Whether to turn internal mode on or off.
      */
     static setInternalMode(mode: boolean): void;
+    /**
+     * Sets the period between polling for IDLE during movements.
+     * Caution: Setting the period too low may cause performance issues.
+     * @param period Period in milliseconds.
+     * Negative value restores the default period.
+     */
+    static setIdlePollingPeriod(period: number): void;
 }

package/dist/lib/library.js

@@ -81,6 +81,17 @@ class Library {
         request.setMode(mode);
         gateway.callSync('library/set_internal_mode', request);
     }
+    /**
+     * Sets the period between polling for IDLE during movements.
+     * Caution: Setting the period too low may cause performance issues.
+     * @param period Period in milliseconds.
+     * Negative value restores the default period.
+     */
+    static setIdlePollingPeriod(period) {
+        const request = new gateway.IntRequest();
+        request.setValue(period);
+        gateway.callSync('library/set_idle_polling_period', request);
+    }
 }
 exports.Library = Library;
 //# sourceMappingURL=library.js.map

package/dist/lib/library.js.map

@@ -1 +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"]}
+{"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;IAED;;;;;OAKG;IACI,MAAM,CAAC,oBAAoB,CAChC,MAAc;QAEd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,CAAC,QAAQ,CAAC,iCAAiC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAxFD,0BAwFC","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  /**\n   * Sets the period between polling for IDLE during movements.\n   * Caution: Setting the period too low may cause performance issues.\n   * @param period Period in milliseconds.\n   * Negative value restores the default period.\n   */\n  public static setIdlePollingPeriod(\n    period: number\n  ): void {\n    const request = new gateway.IntRequest();\n    request.setValue(period);\n\n    gateway.callSync('library/set_idle_polling_period', request);\n  }\n}\n"]}

package/dist/lib/protobufs/main_pb.d.ts

@@ -92,6 +92,26 @@ export namespace EmptyRequest {
   }
 }
 
+export class IntRequest extends jspb.Message {
+  getValue(): number;
+  setValue(value: number): void;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): IntRequest.AsObject;
+  static toObject(includeInstance: boolean, msg: IntRequest): IntRequest.AsObject;
+  static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+  static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+  static serializeBinaryToWriter(message: IntRequest, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): IntRequest;
+  static deserializeBinaryFromReader(message: IntRequest, reader: jspb.BinaryReader): IntRequest;
+}
+
+export namespace IntRequest {
+  export type AsObject = {
+    value: number,
+  }
+}
+
 export class BoolResponse extends jspb.Message {
   getValue(): boolean;
   setValue(value: boolean): void;

package/dist/lib/protobufs/main_pb.js

@@ -99,6 +99,7 @@ goog.exportSymbol('zaber.motion.protobufs.GenericCommandRequest', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.GenericCommandResponse', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.GenericCommandResponseCollection', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.GetSimpleTuningParamDefinitionResponse', null, proto);
+goog.exportSymbol('zaber.motion.protobufs.IntRequest', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.IntResponse', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.InterfaceEmptyRequest', null, proto);
 goog.exportSymbol('zaber.motion.protobufs.InterfaceType', null, proto);
@@ -320,6 +321,27 @@ if (goog.DEBUG && !COMPILED) {
    */
   proto.zaber.motion.protobufs.EmptyRequest.displayName = 'proto.zaber.motion.protobufs.EmptyRequest';
 }
+/**
+ * Generated by JsPbCodeGenerator.
+ * @param {Array=} opt_data Optional initial data array, typically from a
+ * server response, or constructed directly in Javascript. The array is used
+ * in place and becomes part of the constructed object. It is not cloned.
+ * If no data is provided, the constructed object will be empty, but still
+ * valid.
+ * @extends {jspb.Message}
+ * @constructor
+ */
+proto.zaber.motion.protobufs.IntRequest = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
+};
+goog.inherits(proto.zaber.motion.protobufs.IntRequest, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.zaber.motion.protobufs.IntRequest.displayName = 'proto.zaber.motion.protobufs.IntRequest';
+}
 /**
  * Generated by JsPbCodeGenerator.
  * @param {Array=} opt_data Optional initial data array, typically from a
@@ -5145,6 +5167,136 @@ proto.zaber.motion.protobufs.EmptyRequest.serializeBinaryToWriter = function(mes
 
 
 
+if (jspb.Message.GENERATE_TO_OBJECT) {
+/**
+ * Creates an object representation of this proto.
+ * Field names that are reserved in JavaScript and will be renamed to pb_name.
+ * Optional fields that are not set will be set to undefined.
+ * To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
+ * For the list of reserved names please see:
+ *     net/proto2/compiler/js/internal/generator.cc#kKeyword.
+ * @param {boolean=} opt_includeInstance Deprecated. whether to include the
+ *     JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @return {!Object}
+ */
+proto.zaber.motion.protobufs.IntRequest.prototype.toObject = function(opt_includeInstance) {
+  return proto.zaber.motion.protobufs.IntRequest.toObject(opt_includeInstance, this);
+};
+
+
+/**
+ * Static version of the {@see toObject} method.
+ * @param {boolean|undefined} includeInstance Deprecated. Whether to include
+ *     the JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @param {!proto.zaber.motion.protobufs.IntRequest} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.zaber.motion.protobufs.IntRequest.toObject = function(includeInstance, msg) {
+  var f, obj = {
+    value: jspb.Message.getFieldWithDefault(msg, 1, 0)
+  };
+
+  if (includeInstance) {
+    obj.$jspbMessageInstance = msg;
+  }
+  return obj;
+};
+}
+
+
+/**
+ * Deserializes binary data (in protobuf wire format).
+ * @param {jspb.ByteSource} bytes The bytes to deserialize.
+ * @return {!proto.zaber.motion.protobufs.IntRequest}
+ */
+proto.zaber.motion.protobufs.IntRequest.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.zaber.motion.protobufs.IntRequest;
+  return proto.zaber.motion.protobufs.IntRequest.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.zaber.motion.protobufs.IntRequest} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.zaber.motion.protobufs.IntRequest}
+ */
+proto.zaber.motion.protobufs.IntRequest.deserializeBinaryFromReader = function(msg, reader) {
+  while (reader.nextField()) {
+    if (reader.isEndGroup()) {
+      break;
+    }
+    var field = reader.getFieldNumber();
+    switch (field) {
+    case 1:
+      var value = /** @type {number} */ (reader.readInt32());
+      msg.setValue(value);
+      break;
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.zaber.motion.protobufs.IntRequest.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.zaber.motion.protobufs.IntRequest.serializeBinaryToWriter(this, writer);
+  return writer.getResultBuffer();
+};
+
+
+/**
+ * Serializes the given message to binary data (in protobuf wire
+ * format), writing to the given BinaryWriter.
+ * @param {!proto.zaber.motion.protobufs.IntRequest} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.zaber.motion.protobufs.IntRequest.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+  f = message.getValue();
+  if (f !== 0) {
+    writer.writeInt32(
+      1,
+      f
+    );
+  }
+};
+
+
+/**
+ * optional int32 value = 1;
+ * @return {number}
+ */
+proto.zaber.motion.protobufs.IntRequest.prototype.getValue = function() {
+  return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 1, 0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.zaber.motion.protobufs.IntRequest} returns this
+ */
+proto.zaber.motion.protobufs.IntRequest.prototype.setValue = function(value) {
+  return jspb.Message.setProto3IntField(this, 1, value);
+};
+
+
+
+
+
 if (jspb.Message.GENERATE_TO_OBJECT) {
 /**
  * Creates an object representation of this proto.