@zaber/motion 2.15.4 → 3.0.1

package/dist/lib/ascii/axis_settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"axis_settings.js","sourceRoot":"","sources":["../../../src/ascii/axis_settings.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,2DAAuD;AACvD,oCAAiC;AACjC,oDAAsC;AAEtC;;GAEG;AACH,MAAa,YAAY;IAGvB,YAAY,IAAU;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,OAAe,EACf,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oBAAoB,EACpB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,OAAe,EACf,KAAa,EACb,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,OAAe,EACf,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CACzB,OAAe,EACf,KAAa,EACb,IAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,sBAAsB,CAC3B,OAAe,EACf,KAAa,EACb,IAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,UAAU,CACf,OAAe,EACf,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,4BAA4B,EAC5B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CACrB,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,gCAAgC,EAChC,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAC1B,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,4BAA4B,EAC5B,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,wBAAwB,CACnC,WAA+B;QAE/B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,+BAA+B,EAAE,CAAC;QAC9D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,oCAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AA1OD,oCA0OC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Axis } from './axis';\nimport { ConversionFactor } from './conversion_factor';\nimport { Units } from '../units';\nimport * as gateway from '../gateway';\n\n/**\n * Class providing access to various axis settings and properties.\n */\nexport class AxisSettings {\n  private _axis: Axis;\n\n  constructor(axis: Axis) {\n    this._axis = axis;\n  }\n\n  /**\n   * Returns any axis setting or property.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @param unit Units of setting.\n   * @return Setting value.\n   */\n  public async get(\n    setting: string,\n    unit: Units = Units.NATIVE\n  ): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setUnit(unit);\n\n    const response = await gateway.callAsync<gateway.DoubleResponse>(\n      'device/get_setting',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets any axis setting.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @param value Value of the setting.\n   * @param unit Units of setting.\n   */\n  public async set(\n    setting: string,\n    value: number,\n    unit: Units = Units.NATIVE\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Returns any axis setting or property as a string.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @return Setting value.\n   */\n  public async getString(\n    setting: string\n  ): Promise<string> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n\n    const response = await gateway.callAsync<gateway.StringResponse>(\n      'device/get_setting_str',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets any axis setting as a string.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @param value Value of the setting.\n   */\n  public async setString(\n    setting: string,\n    value: string\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingStrRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_setting_str', request);\n  }\n\n  /**\n   * Convert arbitrary setting value to Zaber native units.\n   * @param setting Name of the setting.\n   * @param value Value of the setting in units specified by following argument.\n   * @param unit Units of the value.\n   * @return Setting value.\n   */\n  public convertToNativeUnits(\n    setting: string,\n    value: number,\n    unit: Units\n  ): number {\n    const request = new gateway.DeviceConvertSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'device/convert_setting',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Convert arbitrary setting value from Zaber native units.\n   * @param setting Name of the setting.\n   * @param value Value of the setting in Zaber native units.\n   * @param unit Units to convert value to.\n   * @return Setting value.\n   */\n  public convertFromNativeUnits(\n    setting: string,\n    value: number,\n    unit: Units\n  ): number {\n    const request = new gateway.DeviceConvertSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setFromNative(true);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'device/convert_setting',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns the default value of a setting.\n   * @param setting Name of the setting.\n   * @param unit Units of setting.\n   * @return Default setting value.\n   */\n  public getDefault(\n    setting: string,\n    unit: Units = Units.NATIVE\n  ): number {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'device/get_setting_default',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns the default value of a setting as a string.\n   * @param setting Name of the setting.\n   * @return Default setting value.\n   */\n  public getDefaultString(\n    setting: string\n  ): string {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n\n    const response = gateway.callSync<gateway.StringResponse>(\n      'device/get_setting_default_str',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Indicates if given setting can be converted from and to native units.\n   * @param setting Name of the setting.\n   * @return True if unit conversion can be performed.\n   */\n  public canConvertNativeUnits(\n    setting: string\n  ): boolean {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n\n    const response = gateway.callSync<gateway.BoolResponse>(\n      'device/can_convert_setting',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Overrides default unit conversions.\n   * Conversion factors are specified by setting names representing underlying dimensions.\n   * @param conversions Factors of all conversions to override.\n   */\n  public async setCustomUnitConversions(\n    conversions: ConversionFactor[]\n  ): Promise<void> {\n    const request = new gateway.DeviceSetUnitConversionsRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setConversionsList(conversions.map(ConversionFactor.toProtobuf));\n\n    await gateway.callAsync('device/set_unit_conversions', request);\n  }\n}\n"]}
+{"version":3,"file":"axis_settings.js","sourceRoot":"","sources":["../../../src/ascii/axis_settings.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,2DAAuD;AACvD,oCAAiC;AACjC,oDAAsC;AAEtC;;GAEG;AACH,MAAa,YAAY;IAGvB,YAAY,IAAU;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,OAAe,EACf,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oBAAoB,EACpB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACd,OAAe,EACf,KAAa,EACb,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CACpB,OAAe,EACf,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CACzB,OAAe,EACf,KAAa,EACb,IAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,sBAAsB,CAC3B,OAAe,EACf,KAAa,EACb,IAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,wBAAwB,EACxB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,UAAU,CACf,OAAe,EACf,OAAc,aAAK,CAAC,MAAM;QAE1B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,4BAA4B,EAC5B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CACrB,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,gCAAgC,EAChC,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAC1B,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAC/B,4BAA4B,EAC5B,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,wBAAwB,CACnC,WAA+B;QAE/B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,+BAA+B,EAAE,CAAC;QAC9D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,oCAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;QAEzE,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AA3OD,oCA2OC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Axis } from './axis';\nimport { ConversionFactor } from './conversion_factor';\nimport { Units } from '../units';\nimport * as gateway from '../gateway';\n\n/**\n * Class providing access to various axis settings and properties.\n */\nexport class AxisSettings {\n  private _axis: Axis;\n\n  constructor(axis: Axis) {\n    this._axis = axis;\n  }\n\n  /**\n   * Returns any axis setting or property.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @param [unit=Units.NATIVE] Units of setting.\n   * @returns Setting value.\n   */\n  public async get(\n    setting: string,\n    unit: Units = Units.NATIVE\n  ): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setUnit(unit);\n\n    const response = await gateway.callAsync<gateway.DoubleResponse>(\n      'device/get_setting',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets any axis setting.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @param value Value of the setting.\n   * @param [unit=Units.NATIVE] Units of setting.\n   */\n  public async set(\n    setting: string,\n    value: number,\n    unit: Units = Units.NATIVE\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Returns any axis setting or property as a string.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @returns Setting value.\n   */\n  public async getString(\n    setting: string\n  ): Promise<string> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n\n    const response = await gateway.callAsync<gateway.StringResponse>(\n      'device/get_setting_str',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets any axis setting as a string.\n   * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_settings).\n   * @param setting Name of the setting.\n   * @param value Value of the setting.\n   */\n  public async setString(\n    setting: string,\n    value: string\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingStrRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_setting_str', request);\n  }\n\n  /**\n   * Convert arbitrary setting value to Zaber native units.\n   * @param setting Name of the setting.\n   * @param value Value of the setting in units specified by following argument.\n   * @param unit Units of the value.\n   * @returns Setting value.\n   */\n  public convertToNativeUnits(\n    setting: string,\n    value: number,\n    unit: Units\n  ): number {\n    const request = new gateway.DeviceConvertSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'device/convert_setting',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Convert arbitrary setting value from Zaber native units.\n   * @param setting Name of the setting.\n   * @param value Value of the setting in Zaber native units.\n   * @param unit Units to convert value to.\n   * @returns Setting value.\n   */\n  public convertFromNativeUnits(\n    setting: string,\n    value: number,\n    unit: Units\n  ): number {\n    const request = new gateway.DeviceConvertSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setFromNative(true);\n    request.setSetting(setting);\n    request.setValue(value);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'device/convert_setting',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns the default value of a setting.\n   * @param setting Name of the setting.\n   * @param [unit=Units.NATIVE] Units of setting.\n   * @returns Default setting value.\n   */\n  public getDefault(\n    setting: string,\n    unit: Units = Units.NATIVE\n  ): number {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n    request.setUnit(unit);\n\n    const response = gateway.callSync<gateway.DoubleResponse>(\n      'device/get_setting_default',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Returns the default value of a setting as a string.\n   * @param setting Name of the setting.\n   * @returns Default setting value.\n   */\n  public getDefaultString(\n    setting: string\n  ): string {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n\n    const response = gateway.callSync<gateway.StringResponse>(\n      'device/get_setting_default_str',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Indicates if given setting can be converted from and to native units.\n   * @param setting Name of the setting.\n   * @returns True if unit conversion can be performed.\n   */\n  public canConvertNativeUnits(\n    setting: string\n  ): boolean {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setSetting(setting);\n\n    const response = gateway.callSync<gateway.BoolResponse>(\n      'device/can_convert_setting',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Overrides default unit conversions.\n   * Conversion factors are specified by setting names representing underlying dimensions.\n   * Requires at least Firmware 7.30.\n   * @param conversions Factors of all conversions to override.\n   */\n  public async setCustomUnitConversions(\n    conversions: ConversionFactor[]\n  ): Promise<void> {\n    const request = new gateway.DeviceSetUnitConversionsRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setConversionsList(conversions.map(ConversionFactor.toProtobuf));\n\n    await gateway.callAsync('device/set_unit_conversions', request);\n  }\n}\n"]}

package/dist/lib/ascii/connection.d.ts

@@ -51,107 +51,89 @@ export declare class Connection {
     constructor(interfaceId: number);
     /**
      * Opens a serial port, if Zaber Launcher controls the port, the port will be opened through Zaber Launcher.
-     * Zaber Launcher allows sharing of the port between multiple applications.
-     * Use openSerialPortDirectly if sharing is not desirable.
+     * Zaber Launcher allows sharing of the port between multiple applications,
+     * If port sharing is not desirable, use the `direct` parameter.
      * @param portName Name of the port to open.
-     * @param baudRate Optional baud rate (defaults to 115200).
-     * @return An object representing the port.
+     * @param [options.baudRate=Connection.DEFAULT_BAUD_RATE] Optional baud rate (defaults to 115200).
+     * @param [options.direct=false] If true will connect to the serial port directly,
+     * failing if the connection is already opened by a message router instance.
+     * @returns An object representing the port.
      */
-    static openSerialPort(portName: string, baudRate?: number): Promise<Connection>;
-    /**
-     * Opens a serial port, bypassing Zaber Launcher.
-     * If the port is already opened by Zaber Launcher, this will fail.
-     * @param portName Name of the port to open.
-     * @param baudRate Optional baud rate (defaults to 115200).
-     * @return An object representing the port.
-     */
-    static openSerialPortDirectly(portName: string, baudRate?: number): Promise<Connection>;
+    static openSerialPort(portName: string, options?: Connection.OpenSerialPortOptions): Promise<Connection>;
     /**
      * Opens a TCP connection.
      * @param hostName Hostname or IP address.
-     * @param port Port number.
-     * @return An object representing the connection.
+     * @param [port=Connection.TCP_PORT_CHAIN] Optional port number (defaults to 55550).
+     * @returns An object representing the connection.
      */
-    static openTcp(hostName: string, port: number): Promise<Connection>;
+    static openTcp(hostName: string, port?: number): Promise<Connection>;
     /**
      * Opens a connection using a custom transport.
      * @param transport The custom connection transport.
-     * @return An object representing the connection.
+     * @returns An object representing the connection.
      */
     static openCustom(transport: Transport): Promise<Connection>;
-    /**
-     * Opens a unauthenticated connection to a cloud connected device chain.
-     * Use this method to connect to Virtual Device free trial instances.
-     * The connection is not secured.
-     * @param cloudId The cloud ID to connect to.
-     * @param connectionName The name of the connection to open.
-     * Can be left empty to default to the only connection present.
-     * Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
-     * @param api The URL of the API to receive connection info from.
-     * @return An object representing the connection.
-     */
-    static openIotUnauthenticated(cloudId: string, connectionName?: string, api?: string): Promise<Connection>;
     /**
      * Opens a secured connection to a cloud connected device chain.
      * Use this method to connect to devices on your account.
      * @param cloudId The cloud ID to connect to.
-     * @param token The token to authenticate with.
-     * @param connectionName The name of the connection to open.
+     * @param [options.token='unauthenticated'] The token to authenticate with. By default the connection will be unauthenticated.
+     * @param [options.connectionName=''] The name of the connection to open.
      * Can be left empty to default to the only connection present.
      * Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
-     * @param realm The realm to connect to.
+     * @param [options.realm=''] The realm to connect to.
      * Can be left empty for the default account realm.
-     * @param api The URL of the API to receive connection info from.
-     * @return An object representing the connection.
+     * @param [options.api='https://api.zaber.io'] The URL of the API to receive connection info from.
+     * @returns An object representing the connection.
      */
-    static openIotAuthenticated(cloudId: string, token: string, connectionName?: string, realm?: string, api?: string): Promise<Connection>;
+    static openIot(cloudId: string, options?: Connection.OpenIotOptions): Promise<Connection>;
     /**
      * Opens a connection to Zaber Launcher in your Local Area Network.
      * The connection is not secured.
      * @param hostName Hostname or IP address.
      * @param port Port number.
-     * @param connectionName The name of the connection to open.
+     * @param [connectionName=''] The name of the connection to open.
      * Can be left empty to default to the only connection present.
      * Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
-     * @return An object representing the connection.
+     * @returns An object representing the connection.
      */
     static openNetworkShare(hostName: string, port: number, connectionName?: string): Promise<Connection>;
     /**
      * Sends a generic ASCII command to this connection.
      * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param command Command and its parameters.
-     * @param device Optional device address to send the command to.
-     * @param axis Optional axis number to send the command to.
-     * @param checkErrors Controls whether to throw an exception when the device rejects the command.
-     * @param timeout The timeout, in milliseconds, for a device to respond to the command.
+     * @param [options.device=0] Optional device address to send the command to.
+     * @param [options.axis=0] Optional axis number to send the command to.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
      * Overrides the connection default request timeout.
-     * @return A response to the command.
+     * @returns A response to the command.
      */
-    genericCommand(command: string, device?: number, axis?: number, checkErrors?: boolean, timeout?: number): Promise<Response>;
+    genericCommand(command: string, options?: Connection.GenericCommandOptions): Promise<Response>;
     /**
      * Sends a generic ASCII command to this connection without expecting a response and without adding a message ID.
      * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param command Command and its parameters.
-     * @param device Optional device address to send the command to.
+     * @param [options.device=0] Optional device address to send the command to.
      * Specifying -1 omits the number completely.
-     * @param axis Optional axis number to send the command to.
+     * @param [options.axis=0] Optional axis number to send the command to.
      * Specifying -1 omits the number completely.
      */
-    genericCommandNoResponse(command: string, device?: number, axis?: number): Promise<void>;
+    genericCommandNoResponse(command: string, options?: Connection.GenericCommandNoResponseOptions): Promise<void>;
     /**
      * Sends a generic ASCII command to this connection and expect multiple responses,
      * either from one device or from many devices.
      * Responses are returned in order of arrival.
      * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param command Command and its parameters.
-     * @param device Optional device address to send the command to.
-     * @param axis Optional axis number to send the command to.
-     * @param checkErrors Controls whether to throw an exception when a device rejects the command.
-     * @param timeout The timeout, in milliseconds, for a device to respond to the command.
+     * @param [options.device=0] Optional device address to send the command to.
+     * @param [options.axis=0] Optional axis number to send the command to.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
      * Overrides the connection default request timeout.
-     * @return All responses to the command.
+     * @returns All responses to the command.
      */
-    genericCommandMultiResponse(command: string, device?: number, axis?: number, checkErrors?: boolean, timeout?: number): Promise<Response[]>;
+    genericCommandMultiResponse(command: string, options?: Connection.GenericCommandMultiResponseOptions): Promise<Response[]>;
     /**
      * Resets ASCII protocol message IDs. Only for testing purposes.
      */
@@ -164,44 +146,44 @@ export declare class Connection {
      * Gets a Device class instance which allows you to control a particular device on this connection.
      * Devices are numbered from 1.
      * @param deviceAddress Address of device intended to control. Address is configured for each device.
-     * @return Device instance.
+     * @returns Device instance.
      */
     getDevice(deviceAddress: number): Device;
     /**
      * Renumbers devices present on this connection. After renumbering, devices need to be identified again.
-     * @param firstAddress This is the address that the device closest to the computer is given.
+     * @param [options.firstAddress=1] This is the address that the device closest to the computer is given.
      * Remaining devices are numbered consecutively.
-     * @return Total number of devices that responded to the renumber.
+     * @returns Total number of devices that responded to the renumber.
      */
-    renumberDevices(firstAddress?: number): Promise<number>;
+    renumberDevices(options?: Connection.RenumberDevicesOptions): Promise<number>;
     /**
      * Attempts to detect any devices present on this connection.
-     * @param identifyDevices Determines whether device identification should be performed as well.
-     * @return Array of detected devices.
+     * @param [options.identifyDevices=true] Determines whether device identification should be performed as well.
+     * @returns Array of detected devices.
      */
-    detectDevices(identifyDevices?: boolean): Promise<Device[]>;
+    detectDevices(options?: Connection.DetectDevicesOptions): Promise<Device[]>;
     /**
      * Stops all of the devices on this connection.
-     * @param waitUntilIdle Determines whether the function should return immediately
+     * @param [options.waitUntilIdle=true] Determines whether the function should return immediately
      * or wait until the devices are stopped.
-     * @return The addresses of the devices that were stopped by this command.
+     * @returns The addresses of the devices that were stopped by this command.
      */
-    stopAll(waitUntilIdle?: boolean): Promise<number[]>;
+    stopAll(options?: Connection.StopAllOptions): Promise<number[]>;
     /**
      * Homes all of the devices on this connection.
-     * @param waitUntilIdle Determines whether the function should return immediately
+     * @param [options.waitUntilIdle=true] Determines whether the function should return immediately
      * or wait until the devices are homed.
-     * @return The addresses of the devices that were homed by this command.
+     * @returns The addresses of the devices that were homed by this command.
      */
-    homeAll(waitUntilIdle?: boolean): Promise<number[]>;
+    homeAll(options?: Connection.HomeAllOptions): Promise<number[]>;
     /**
      * Returns a string that represents the connection.
-     * @return A string that represents the connection.
+     * @returns A string that represents the connection.
      */
     toString(): string;
     /**
      * Returns default request timeout.
-     * @return Default request timeout.
+     * @returns Default request timeout.
      */
     private _retrieveTimeout;
     /**
@@ -211,7 +193,7 @@ export declare class Connection {
     private _changeTimeout;
     /**
      * Returns checksum enabled.
-     * @return Checksum enabled.
+     * @returns Checksum enabled.
      */
     private _retrieveChecksumEnabled;
     /**
@@ -226,3 +208,44 @@ export declare class Connection {
     get disconnected(): Observable<MotionLibException>;
     private _subscribe;
 }
+declare namespace Connection {
+    interface OpenSerialPortOptions {
+        baudRate?: number;
+        direct?: boolean;
+    }
+    interface OpenIotOptions {
+        token?: string;
+        connectionName?: string;
+        realm?: string;
+        api?: string;
+    }
+    interface GenericCommandOptions {
+        device?: number;
+        axis?: number;
+        checkErrors?: boolean;
+        timeout?: number;
+    }
+    interface GenericCommandNoResponseOptions {
+        device?: number;
+        axis?: number;
+    }
+    interface GenericCommandMultiResponseOptions {
+        device?: number;
+        axis?: number;
+        checkErrors?: boolean;
+        timeout?: number;
+    }
+    interface RenumberDevicesOptions {
+        firstAddress?: number;
+    }
+    interface DetectDevicesOptions {
+        identifyDevices?: boolean;
+    }
+    interface StopAllOptions {
+        waitUntilIdle?: boolean;
+    }
+    interface HomeAllOptions {
+        waitUntilIdle?: boolean;
+    }
+}
+export {};

package/dist/lib/ascii/connection.js

@@ -70,43 +70,31 @@ class Connection {
     }
     /**
      * Opens a serial port, if Zaber Launcher controls the port, the port will be opened through Zaber Launcher.
-     * Zaber Launcher allows sharing of the port between multiple applications.
-     * Use openSerialPortDirectly if sharing is not desirable.
+     * Zaber Launcher allows sharing of the port between multiple applications,
+     * If port sharing is not desirable, use the `direct` parameter.
      * @param portName Name of the port to open.
-     * @param baudRate Optional baud rate (defaults to 115200).
-     * @return An object representing the port.
+     * @param [options.baudRate=Connection.DEFAULT_BAUD_RATE] Optional baud rate (defaults to 115200).
+     * @param [options.direct=false] If true will connect to the serial port directly,
+     * failing if the connection is already opened by a message router instance.
+     * @returns An object representing the port.
      */
-    static async openSerialPort(portName, baudRate = Connection.DEFAULT_BAUD_RATE) {
+    static async openSerialPort(portName, options = {}) {
+        const { baudRate = Connection.DEFAULT_BAUD_RATE, direct = false, } = options;
         const request = new gateway.OpenInterfaceRequest();
         request.setInterfaceType(gateway.InterfaceType.SERIAL_PORT);
         request.setPortName(portName);
         request.setBaudRate(baudRate);
-        const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
-        return new Connection(response.getInterfaceId());
-    }
-    /**
-     * Opens a serial port, bypassing Zaber Launcher.
-     * If the port is already opened by Zaber Launcher, this will fail.
-     * @param portName Name of the port to open.
-     * @param baudRate Optional baud rate (defaults to 115200).
-     * @return An object representing the port.
-     */
-    static async openSerialPortDirectly(portName, baudRate = Connection.DEFAULT_BAUD_RATE) {
-        const request = new gateway.OpenInterfaceRequest();
-        request.setInterfaceType(gateway.InterfaceType.SERIAL_PORT);
-        request.setRejectRoutedConnection(true);
-        request.setPortName(portName);
-        request.setBaudRate(baudRate);
+        request.setRejectRoutedConnection(direct);
         const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
         return new Connection(response.getInterfaceId());
     }
     /**
      * Opens a TCP connection.
      * @param hostName Hostname or IP address.
-     * @param port Port number.
-     * @return An object representing the connection.
+     * @param [port=Connection.TCP_PORT_CHAIN] Optional port number (defaults to 55550).
+     * @returns An object representing the connection.
      */
-    static async openTcp(hostName, port) {
+    static async openTcp(hostName, port = Connection.TCP_PORT_CHAIN) {
         const request = new gateway.OpenInterfaceRequest();
         request.setInterfaceType(gateway.InterfaceType.TCP);
         request.setHostName(hostName);
@@ -117,7 +105,7 @@ class Connection {
     /**
      * Opens a connection using a custom transport.
      * @param transport The custom connection transport.
-     * @return An object representing the connection.
+     * @returns An object representing the connection.
      */
     static async openCustom(transport) {
         const request = new gateway.OpenInterfaceRequest();
@@ -126,42 +114,21 @@ class Connection {
         const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
         return new Connection(response.getInterfaceId());
     }
-    /**
-     * Opens a unauthenticated connection to a cloud connected device chain.
-     * Use this method to connect to Virtual Device free trial instances.
-     * The connection is not secured.
-     * @param cloudId The cloud ID to connect to.
-     * @param connectionName The name of the connection to open.
-     * Can be left empty to default to the only connection present.
-     * Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
-     * @param api The URL of the API to receive connection info from.
-     * @return An object representing the connection.
-     */
-    static async openIotUnauthenticated(cloudId, connectionName = '', api = 'https://api.zaber.io') {
-        const request = new gateway.OpenInterfaceRequest();
-        request.setInterfaceType(gateway.InterfaceType.IOT);
-        request.setRealm('unauthenticated');
-        request.setToken('unauthenticated');
-        request.setCloudId(cloudId);
-        request.setConnectionName(connectionName);
-        request.setApi(api);
-        const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
-        return new Connection(response.getInterfaceId());
-    }
     /**
      * Opens a secured connection to a cloud connected device chain.
      * Use this method to connect to devices on your account.
      * @param cloudId The cloud ID to connect to.
-     * @param token The token to authenticate with.
-     * @param connectionName The name of the connection to open.
+     * @param [options.token='unauthenticated'] The token to authenticate with. By default the connection will be unauthenticated.
+     * @param [options.connectionName=''] The name of the connection to open.
      * Can be left empty to default to the only connection present.
      * Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
-     * @param realm The realm to connect to.
+     * @param [options.realm=''] The realm to connect to.
      * Can be left empty for the default account realm.
-     * @param api The URL of the API to receive connection info from.
-     * @return An object representing the connection.
+     * @param [options.api='https://api.zaber.io'] The URL of the API to receive connection info from.
+     * @returns An object representing the connection.
      */
-    static async openIotAuthenticated(cloudId, token, connectionName = '', realm = '', api = 'https://api.zaber.io') {
+    static async openIot(cloudId, options = {}) {
+        const { token = 'unauthenticated', connectionName = '', realm = '', api = 'https://api.zaber.io', } = options;
         const request = new gateway.OpenInterfaceRequest();
         request.setInterfaceType(gateway.InterfaceType.IOT);
         request.setCloudId(cloudId);
@@ -177,10 +144,10 @@ class Connection {
      * The connection is not secured.
      * @param hostName Hostname or IP address.
      * @param port Port number.
-     * @param connectionName The name of the connection to open.
+     * @param [connectionName=''] The name of the connection to open.
      * Can be left empty to default to the only connection present.
      * Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
-     * @return An object representing the connection.
+     * @returns An object representing the connection.
      */
     static async openNetworkShare(hostName, port, connectionName = '') {
         const request = new gateway.OpenInterfaceRequest();
@@ -195,14 +162,15 @@ class Connection {
      * Sends a generic ASCII command to this connection.
      * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param command Command and its parameters.
-     * @param device Optional device address to send the command to.
-     * @param axis Optional axis number to send the command to.
-     * @param checkErrors Controls whether to throw an exception when the device rejects the command.
-     * @param timeout The timeout, in milliseconds, for a device to respond to the command.
+     * @param [options.device=0] Optional device address to send the command to.
+     * @param [options.axis=0] Optional axis number to send the command to.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
      * Overrides the connection default request timeout.
-     * @return A response to the command.
+     * @returns A response to the command.
      */
-    async genericCommand(command, device = 0, axis = 0, checkErrors = true, timeout = 0) {
+    async genericCommand(command, options = {}) {
+        const { device = 0, axis = 0, checkErrors = true, timeout = 0, } = options;
         const request = new gateway.GenericCommandRequest();
         request.setInterfaceId(this.interfaceId);
         request.setCommand(command);
@@ -217,12 +185,13 @@ class Connection {
      * Sends a generic ASCII command to this connection without expecting a response and without adding a message ID.
      * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param command Command and its parameters.
-     * @param device Optional device address to send the command to.
+     * @param [options.device=0] Optional device address to send the command to.
      * Specifying -1 omits the number completely.
-     * @param axis Optional axis number to send the command to.
+     * @param [options.axis=0] Optional axis number to send the command to.
      * Specifying -1 omits the number completely.
      */
-    async genericCommandNoResponse(command, device = 0, axis = 0) {
+    async genericCommandNoResponse(command, options = {}) {
+        const { device = 0, axis = 0, } = options;
         const request = new gateway.GenericCommandRequest();
         request.setInterfaceId(this.interfaceId);
         request.setCommand(command);
@@ -236,14 +205,15 @@ class Connection {
      * Responses are returned in order of arrival.
      * For more information refer to the [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
      * @param command Command and its parameters.
-     * @param device Optional device address to send the command to.
-     * @param axis Optional axis number to send the command to.
-     * @param checkErrors Controls whether to throw an exception when a device rejects the command.
-     * @param timeout The timeout, in milliseconds, for a device to respond to the command.
+     * @param [options.device=0] Optional device address to send the command to.
+     * @param [options.axis=0] Optional axis number to send the command to.
+     * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.
+     * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.
      * Overrides the connection default request timeout.
-     * @return All responses to the command.
+     * @returns All responses to the command.
      */
-    async genericCommandMultiResponse(command, device = 0, axis = 0, checkErrors = true, timeout = 0) {
+    async genericCommandMultiResponse(command, options = {}) {
+        const { device = 0, axis = 0, checkErrors = true, timeout = 0, } = options;
         const request = new gateway.GenericCommandRequest();
         request.setInterfaceId(this.interfaceId);
         request.setCommand(command);
@@ -274,7 +244,7 @@ class Connection {
      * Gets a Device class instance which allows you to control a particular device on this connection.
      * Devices are numbered from 1.
      * @param deviceAddress Address of device intended to control. Address is configured for each device.
-     * @return Device instance.
+     * @returns Device instance.
      */
     getDevice(deviceAddress) {
         if (deviceAddress <= 0) {
@@ -284,11 +254,12 @@ class Connection {
     }
     /**
      * Renumbers devices present on this connection. After renumbering, devices need to be identified again.
-     * @param firstAddress This is the address that the device closest to the computer is given.
+     * @param [options.firstAddress=1] This is the address that the device closest to the computer is given.
      * Remaining devices are numbered consecutively.
-     * @return Total number of devices that responded to the renumber.
+     * @returns Total number of devices that responded to the renumber.
      */
-    async renumberDevices(firstAddress = 1) {
+    async renumberDevices(options = {}) {
+        const { firstAddress = 1, } = options;
         if (firstAddress <= 0) {
             throw new TypeError('Invalid value; device addresses are numbered from 1.');
         }
@@ -300,10 +271,11 @@ class Connection {
     }
     /**
      * Attempts to detect any devices present on this connection.
-     * @param identifyDevices Determines whether device identification should be performed as well.
-     * @return Array of detected devices.
+     * @param [options.identifyDevices=true] Determines whether device identification should be performed as well.
+     * @returns Array of detected devices.
      */
-    async detectDevices(identifyDevices = true) {
+    async detectDevices(options = {}) {
+        const { identifyDevices = true, } = options;
         const request = new gateway.DeviceDetectRequest();
         request.setInterfaceId(this.interfaceId);
         request.setIdentifyDevices(identifyDevices);
@@ -312,11 +284,12 @@ class Connection {
     }
     /**
      * Stops all of the devices on this connection.
-     * @param waitUntilIdle Determines whether the function should return immediately
+     * @param [options.waitUntilIdle=true] Determines whether the function should return immediately
      * or wait until the devices are stopped.
-     * @return The addresses of the devices that were stopped by this command.
+     * @returns The addresses of the devices that were stopped by this command.
      */
-    async stopAll(waitUntilIdle = true) {
+    async stopAll(options = {}) {
+        const { waitUntilIdle = true, } = options;
         const request = new gateway.DeviceOnAllRequest();
         request.setInterfaceId(this.interfaceId);
         request.setWaitUntilIdle(waitUntilIdle);
@@ -325,11 +298,12 @@ class Connection {
     }
     /**
      * Homes all of the devices on this connection.
-     * @param waitUntilIdle Determines whether the function should return immediately
+     * @param [options.waitUntilIdle=true] Determines whether the function should return immediately
      * or wait until the devices are homed.
-     * @return The addresses of the devices that were homed by this command.
+     * @returns The addresses of the devices that were homed by this command.
      */
-    async homeAll(waitUntilIdle = true) {
+    async homeAll(options = {}) {
+        const { waitUntilIdle = true, } = options;
         const request = new gateway.DeviceOnAllRequest();
         request.setInterfaceId(this.interfaceId);
         request.setWaitUntilIdle(waitUntilIdle);
@@ -338,7 +312,7 @@ class Connection {
     }
     /**
      * Returns a string that represents the connection.
-     * @return A string that represents the connection.
+     * @returns A string that represents the connection.
      */
     toString() {
         const request = new gateway.InterfaceEmptyRequest();
@@ -348,7 +322,7 @@ class Connection {
     }
     /**
      * Returns default request timeout.
-     * @return Default request timeout.
+     * @returns Default request timeout.
      */
     _retrieveTimeout() {
         const request = new gateway.InterfaceEmptyRequest();
@@ -368,7 +342,7 @@ class Connection {
     }
     /**
      * Returns checksum enabled.
-     * @return Checksum enabled.
+     * @returns Checksum enabled.
      */
     _retrieveChecksumEnabled() {
         const request = new gateway.InterfaceEmptyRequest();