@zaber/motion 4.0.0 → 4.2.1

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

@@ -1 +1 @@
-{"version":3,"file":"oscilloscope.js","sourceRoot":"","sources":["../../../src/ascii/oscilloscope.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAItD,2DAAuD;AACvD,oCAA+C;AAC/C,oDAAsC;AAEtC;;;;GAIG;AACH,MAAa,YAAY;IACvB;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CACrB,IAAY,EACZ,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oCAAoC,EAAE,CAAC;QACnE,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,OAAO,CAAC,SAAS,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CACvB,MAAkB,EAClB,SAAiB;QAEjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,+BAA+B,EAAE,CAAC;QAC9D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,SAAS,CAAC,MAAa,CAAC,CAAC;QACjC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAEhC,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CACtB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACrC,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;;;;OAIG;IACI,KAAK,CAAC,WAAW,CACtB,QAAgB,EAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAClC,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;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,QAAgB,EAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAExC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB;QAC3B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa;QACxB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAChB,gBAAwB,CAAC;QAEzB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvB,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,OAAO,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,mBAAmB,EACnB,OAAO,EACP,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC,cAAc,EAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,oCAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AA5OD,oCA4OC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Device } from './device';\nimport { IoPortType } from './io_port_type';\nimport { OscilloscopeData } from './oscilloscope_data';\nimport { Native, Time, Units } from '../units';\nimport * as gateway from '../gateway';\n\n/**\n * Provides a convenient way to control the oscilloscope data recording feature of some devices.\n * The oscilloscope can record the values of some settings over time at high resolution.\n * Requires at least Firmware 7.00.\n */\nexport class Oscilloscope {\n  /**\n   * Device that this Oscilloscope measures.\n   */\n  public get device(): Device {\n    return this._device;\n  }\n  private _device: Device;\n\n  constructor(device: Device) {\n    this._device = device;\n  }\n\n  /**\n   * Select a setting to be recorded.\n   * @param axis The 1-based index of the axis to record the value from.\n   * @param setting The name of a setting to record.\n   */\n  public async addChannel(\n    axis: number,\n    setting: string\n  ): Promise<void> {\n    const request = new gateway.OscilloscopeAddSettingChannelRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(axis);\n    request.setSetting(setting);\n\n    await gateway.callAsync('oscilloscope/add_setting_channel', request);\n  }\n\n  /**\n   * Select an I/O pin to be recorded.\n   * @param ioType The I/O port type to read data from.\n   * @param ioChannel The 1-based index of the I/O pin to read from.\n   */\n  public async addIoChannel(\n    ioType: IoPortType,\n    ioChannel: number\n  ): Promise<void> {\n    const request = new gateway.OscilloscopeAddIoChannelRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setIoType(ioType as any);\n    request.setIoChannel(ioChannel);\n\n    await gateway.callAsync('oscilloscope/add_io_channel', request);\n  }\n\n  /**\n   * Clear the list of channels to record.\n   */\n  public async clear(): Promise<void> {\n    const request = new gateway.DeviceEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n\n    await gateway.callAsync('oscilloscope/clear_channels', request);\n  }\n\n  /**\n   * Get the current sampling interval.\n   * @param [unit=Units.NATIVE] Unit of measure to represent the timebase in.\n   * @returns The current sampling interval in the selected time units.\n   */\n  public async getTimebase(\n    unit: Time | Native = Units.NATIVE\n  ): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.timebase');\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   * Set the sampling interval.\n   * @param interval Sample interval for the next oscilloscope recording. Minimum value is 100µs.\n   * @param [unit=Units.NATIVE] Unit of measure the timebase is represented in.\n   */\n  public async setTimebase(\n    interval: number,\n    unit: Time | Native = Units.NATIVE\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.timebase');\n    request.setValue(interval);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Get the delay before oscilloscope recording starts.\n   * @param [unit=Units.NATIVE] Unit of measure to represent the delay in.\n   * @returns The current start delay in the selected time units.\n   */\n  public async getDelay(\n    unit: Time | Native = Units.NATIVE\n  ): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.delay');\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   * Set the sampling start delay.\n   * @param interval Delay time between triggering a recording and the first data point being recorded.\n   * @param [unit=Units.NATIVE] Unit of measure the delay is represented in.\n   */\n  public async setDelay(\n    interval: number,\n    unit: Time | Native = Units.NATIVE\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.delay');\n    request.setValue(interval);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Get the maximum number of channels that can be recorded.\n   * @returns The maximum number of channels that can be added to an Oscilloscope recording.\n   */\n  public async getMaxChannels(): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.numchannels');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the maximum number of samples that can be recorded per Oscilloscope channel.\n   * @returns The maximum number of samples that can be recorded per Oscilloscope channel.\n   */\n  public async getMaxBufferSize(): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.channel.size.max');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the number of samples that can be recorded per channel given the current number of channels added.\n   * @returns Number of samples that will be recorded per channel with the current channels. Zero if none have been added.\n   */\n  public async getBufferSize(): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.channel.size');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Trigger data recording.\n   * @param [captureLength=0] Optional number of samples to record per channel.\n   * If left empty, the device records samples until the buffer fills.\n   * Requires at least Firmware 7.29.\n   */\n  public async start(\n    captureLength: number = 0\n  ): Promise<void> {\n    const request = new gateway.OscilloscopeStartStopRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setStart(true);\n    request.setCaptureLength(captureLength);\n\n    await gateway.callAsync('oscilloscope/start_or_stop', request);\n  }\n\n  /**\n   * End data recording if currently in progress.\n   */\n  public async stop(): Promise<void> {\n    const request = new gateway.OscilloscopeStartStopRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setStart(false);\n\n    await gateway.callAsync('oscilloscope/start_or_stop', request);\n  }\n\n  /**\n   * Reads the last-recorded data from the oscilloscope. Will block until any in-progress recording completes.\n   * @returns Array of recorded channel data arrays, in the order added.\n   */\n  public async read(): Promise<OscilloscopeData[]> {\n    const request = new gateway.DeviceEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n\n    const response = await gateway.callAsync<gateway.OscilloscopeReadResponse>(\n      'oscilloscope/read',\n      request,\n      gateway.OscilloscopeReadResponse);\n    return response.getDataIdsList()!.map(id => new OscilloscopeData(id));\n  }\n}\n"]}
+{"version":3,"file":"oscilloscope.js","sourceRoot":"","sources":["../../../src/ascii/oscilloscope.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAItD,2DAAuD;AACvD,oCAA+C;AAC/C,oDAAsC;AAEtC;;;;GAIG;AACH,MAAa,YAAY;IACvB;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAGD,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CACrB,IAAY,EACZ,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oCAAoC,EAAE,CAAC;QACnE,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,OAAO,CAAC,SAAS,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CACvB,MAAkB,EAClB,SAAiB;QAEjB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,+BAA+B,EAAE,CAAC;QAC9D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,SAAS,CAAC,MAAa,CAAC,CAAC;QACjC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAEhC,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,MAAM,OAAO,CAAC,SAAS,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CACtB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACrC,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;;;;OAIG;IACI,KAAK,CAAC,WAAW,CACtB,QAAgB,EAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAClC,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;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,QAAgB,EAChB,OAAsB,aAAK,CAAC,MAAM;QAElC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3B,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc;QACzB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAExC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB;QAC3B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa;QACxB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QAEzC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,KAAK,CAChB,gBAAwB,CAAC;QAEzB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvB,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,OAAO,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,mBAAmB,EACnB,OAAO,EACP,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC,cAAc,EAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,oCAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AA7OD,oCA6OC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Device } from './device';\nimport { IoPortType } from './io_port_type';\nimport { OscilloscopeData } from './oscilloscope_data';\nimport { Native, Time, Units } from '../units';\nimport * as gateway from '../gateway';\n\n/**\n * Provides a convenient way to control the oscilloscope data recording feature of some devices.\n * The oscilloscope can record the values of some settings over time at high resolution.\n * Requires at least Firmware 7.00.\n */\nexport class Oscilloscope {\n  /**\n   * Device that this Oscilloscope measures.\n   */\n  public get device(): Device {\n    return this._device;\n  }\n  private _device: Device;\n\n  constructor(device: Device) {\n    this._device = device;\n  }\n\n  /**\n   * Select a setting to be recorded.\n   * @param axis The 1-based index of the axis to record the value from.\n   * @param setting The name of a setting to record.\n   */\n  public async addChannel(\n    axis: number,\n    setting: string\n  ): Promise<void> {\n    const request = new gateway.OscilloscopeAddSettingChannelRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setAxis(axis);\n    request.setSetting(setting);\n\n    await gateway.callAsync('oscilloscope/add_setting_channel', request);\n  }\n\n  /**\n   * Select an I/O pin to be recorded.\n   * Requires at least Firmware 7.33.\n   * @param ioType The I/O port type to read data from.\n   * @param ioChannel The 1-based index of the I/O pin to read from.\n   */\n  public async addIoChannel(\n    ioType: IoPortType,\n    ioChannel: number\n  ): Promise<void> {\n    const request = new gateway.OscilloscopeAddIoChannelRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setIoType(ioType as any);\n    request.setIoChannel(ioChannel);\n\n    await gateway.callAsync('oscilloscope/add_io_channel', request);\n  }\n\n  /**\n   * Clear the list of channels to record.\n   */\n  public async clear(): Promise<void> {\n    const request = new gateway.DeviceEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n\n    await gateway.callAsync('oscilloscope/clear_channels', request);\n  }\n\n  /**\n   * Get the current sampling interval.\n   * @param [unit=Units.NATIVE] Unit of measure to represent the timebase in.\n   * @returns The current sampling interval in the selected time units.\n   */\n  public async getTimebase(\n    unit: Time | Native = Units.NATIVE\n  ): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.timebase');\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   * Set the sampling interval.\n   * @param interval Sample interval for the next oscilloscope recording. Minimum value is 100µs.\n   * @param [unit=Units.NATIVE] Unit of measure the timebase is represented in.\n   */\n  public async setTimebase(\n    interval: number,\n    unit: Time | Native = Units.NATIVE\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.timebase');\n    request.setValue(interval);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Get the delay before oscilloscope recording starts.\n   * @param [unit=Units.NATIVE] Unit of measure to represent the delay in.\n   * @returns The current start delay in the selected time units.\n   */\n  public async getDelay(\n    unit: Time | Native = Units.NATIVE\n  ): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.delay');\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   * Set the sampling start delay.\n   * @param interval Delay time between triggering a recording and the first data point being recorded.\n   * @param [unit=Units.NATIVE] Unit of measure the delay is represented in.\n   */\n  public async setDelay(\n    interval: number,\n    unit: Time | Native = Units.NATIVE\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.delay');\n    request.setValue(interval);\n    request.setUnit(unit);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Get the maximum number of channels that can be recorded.\n   * @returns The maximum number of channels that can be added to an Oscilloscope recording.\n   */\n  public async getMaxChannels(): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.numchannels');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the maximum number of samples that can be recorded per Oscilloscope channel.\n   * @returns The maximum number of samples that can be recorded per Oscilloscope channel.\n   */\n  public async getMaxBufferSize(): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.channel.size.max');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Get the number of samples that can be recorded per channel given the current number of channels added.\n   * @returns Number of samples that will be recorded per channel with the current channels. Zero if none have been added.\n   */\n  public async getBufferSize(): Promise<number> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setSetting('scope.channel.size');\n\n    const response = await gateway.callAsync<gateway.IntResponse>(\n      'oscilloscope/get_setting',\n      request,\n      gateway.IntResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Trigger data recording.\n   * @param [captureLength=0] Optional number of samples to record per channel.\n   * If left empty, the device records samples until the buffer fills.\n   * Requires at least Firmware 7.29.\n   */\n  public async start(\n    captureLength: number = 0\n  ): Promise<void> {\n    const request = new gateway.OscilloscopeStartStopRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setStart(true);\n    request.setCaptureLength(captureLength);\n\n    await gateway.callAsync('oscilloscope/start_or_stop', request);\n  }\n\n  /**\n   * End data recording if currently in progress.\n   */\n  public async stop(): Promise<void> {\n    const request = new gateway.OscilloscopeStartStopRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n    request.setStart(false);\n\n    await gateway.callAsync('oscilloscope/start_or_stop', request);\n  }\n\n  /**\n   * Reads the last-recorded data from the oscilloscope. Will block until any in-progress recording completes.\n   * @returns Array of recorded channel data arrays, in the order added.\n   */\n  public async read(): Promise<OscilloscopeData[]> {\n    const request = new gateway.DeviceEmptyRequest();\n    request.setInterfaceId(this.device.connection.interfaceId);\n    request.setDevice(this.device.deviceAddress);\n\n    const response = await gateway.callAsync<gateway.OscilloscopeReadResponse>(\n      'oscilloscope/read',\n      request,\n      gateway.OscilloscopeReadResponse);\n    return response.getDataIdsList()!.map(id => new OscilloscopeData(id));\n  }\n}\n"]}

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

@@ -0,0 +1,138 @@
+import { ProcessController } from './process_controller';
+import { Response } from './response';
+import { AxisSettings } from './axis_settings';
+import { AxisStorage } from './storage';
+import { Warnings } from './warnings';
+import { ProcessControllerMode } from './process_controller_mode';
+import { ProcessControllerSource } from './process_controller_source';
+import { Measurement } from '../measurement';
+/**
+ * Use to drive voltage for a process such as a heater, valve, Peltier device, etc.
+ * WARNING: DO NOT USE. This API is for an as-yet unreleased product and firmware version.
+ * It is subject to breaking changes without warning until further notice.
+ * Requires at least Firmware 7.34.
+ */
+export declare class Process {
+    /**
+     * Controller for this process.
+     */
+    get controller(): ProcessController;
+    private _controller;
+    /**
+     * The process number identifies the process on the controller.
+     */
+    get processNumber(): number;
+    private _processNumber;
+    private _axis;
+    /**
+     * Settings and properties of this process.
+     */
+    get settings(): AxisSettings;
+    private _settings;
+    /**
+     * Key-value storage of this process.
+     */
+    get storage(): AxisStorage;
+    private _storage;
+    /**
+     * Warnings and faults of this process.
+     */
+    get warnings(): Warnings;
+    private _warnings;
+    constructor(controller: ProcessController, processNumber: number);
+    /**
+     * Sets the enabled state of the driver.
+     * @param [enabled=true] If true (default) enables drive. If false disables.
+     */
+    enable(enabled?: boolean): Promise<void>;
+    /**
+     * Turns this process on. In manual mode, this supplies voltage; in controlled mode, it starts the control loop.
+     * @param [duration=0] How long to leave the process on in milliseconds.
+     */
+    on(duration?: number): Promise<void>;
+    /**
+     * Turns this process off.
+     */
+    off(): Promise<void>;
+    /**
+     * Sets the control mode of this process.
+     * @param mode Mode to set this process to.
+     */
+    setMode(mode: ProcessControllerMode): Promise<void>;
+    /**
+     * Gets the control mode of this process.
+     * @returns Control mode.
+     */
+    getMode(): Promise<ProcessControllerMode>;
+    /**
+     * Gets the source used to control this process.
+     * @returns The source providing feedback for this process.
+     */
+    getSource(): Promise<ProcessControllerSource>;
+    /**
+     * Sets the source used to control this process.
+     * @param source Sets the source that should provide feedback for this process.
+     */
+    setSource(source: ProcessControllerSource): Promise<void>;
+    /**
+     * Gets the current value of the source used to control this process.
+     * @returns The current value of this process's controlling source.
+     */
+    getInput(): Promise<Measurement>;
+    /**
+     * Sends a generic ASCII command to this process' underlying axis.
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     * @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.
+     * @returns A response to the command.
+     */
+    genericCommand(command: string, options?: Process.GenericCommandOptions): Promise<Response>;
+    /**
+     * Sends a generic ASCII command to this process and expect multiple responses.
+     * Responses are returned in order of arrival.
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     * @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.
+     * @returns All responses to the command.
+     */
+    genericCommandMultiResponse(command: string, options?: Process.GenericCommandMultiResponseOptions): Promise<Response[]>;
+    /**
+     * Sends a generic ASCII command to this process without expecting a response and without adding a message ID
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     */
+    genericCommandNoResponse(command: string): Promise<void>;
+    /**
+     * Returns a serialization of the current process state that can be saved and reapplied.
+     * @returns A serialization of the current state of the process.
+     */
+    getState(): Promise<string>;
+    /**
+     * Applies a saved state to this process.
+     * @param state The state object to apply to this process.
+     */
+    setState(state: string): Promise<void>;
+    /**
+     * Checks if a state can be applied to this process.
+     * This only covers exceptions that can be determined statically such as mismatches of ID or version,
+     * the process of applying the state can still fail when running.
+     * @param state The state object to check against.
+     * @returns An explanation of why this state cannot be set to this process.
+     */
+    canSetState(state: string): Promise<string>;
+}
+declare namespace Process {
+    interface GenericCommandOptions {
+        checkErrors?: boolean;
+        timeout?: number;
+    }
+    interface GenericCommandMultiResponseOptions {
+        checkErrors?: boolean;
+        timeout?: number;
+    }
+}
+export {};

package/dist/lib/ascii/process.js

@@ -0,0 +1,278 @@
+"use strict";
+// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //
+// ============= DO NOT EDIT DIRECTLY ============= //
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Process = void 0;
+const gateway = __importStar(require("../gateway"));
+const axis_1 = require("./axis");
+const response_1 = require("./response");
+const axis_settings_1 = require("./axis_settings");
+const storage_1 = require("./storage");
+const warnings_1 = require("./warnings");
+const process_controller_source_1 = require("./process_controller_source");
+const measurement_1 = require("../measurement");
+/**
+ * Use to drive voltage for a process such as a heater, valve, Peltier device, etc.
+ * WARNING: DO NOT USE. This API is for an as-yet unreleased product and firmware version.
+ * It is subject to breaking changes without warning until further notice.
+ * Requires at least Firmware 7.34.
+ */
+class Process {
+    /**
+     * Controller for this process.
+     */
+    get controller() {
+        return this._controller;
+    }
+    /**
+     * The process number identifies the process on the controller.
+     */
+    get processNumber() {
+        return this._processNumber;
+    }
+    /**
+     * Settings and properties of this process.
+     */
+    get settings() {
+        return this._settings;
+    }
+    /**
+     * Key-value storage of this process.
+     */
+    get storage() {
+        return this._storage;
+    }
+    /**
+     * Warnings and faults of this process.
+     */
+    get warnings() {
+        return this._warnings;
+    }
+    constructor(controller, processNumber) {
+        this._controller = controller;
+        this._processNumber = processNumber;
+        this._axis = new axis_1.Axis(controller.device, processNumber);
+        this._settings = new axis_settings_1.AxisSettings(this._axis);
+        this._storage = new storage_1.AxisStorage(this._axis);
+        this._warnings = new warnings_1.Warnings(controller.device, processNumber);
+    }
+    /**
+     * Sets the enabled state of the driver.
+     * @param [enabled=true] If true (default) enables drive. If false disables.
+     */
+    async enable(enabled = true) {
+        const request = new gateway.ProcessOn();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setOn(enabled);
+        await gateway.callAsync('process-controller/enable', request);
+    }
+    /**
+     * Turns this process on. In manual mode, this supplies voltage; in controlled mode, it starts the control loop.
+     * @param [duration=0] How long to leave the process on in milliseconds.
+     */
+    async on(duration = 0) {
+        const request = new gateway.ProcessOn();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setOn(true);
+        request.setDuration(duration);
+        await gateway.callAsync('process-controller/on', request);
+    }
+    /**
+     * Turns this process off.
+     */
+    async off() {
+        const request = new gateway.ProcessOn();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setOn(false);
+        await gateway.callAsync('process-controller/on', request);
+    }
+    /**
+     * Sets the control mode of this process.
+     * @param mode Mode to set this process to.
+     */
+    async setMode(mode) {
+        const request = new gateway.DeviceSetSettingRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setSetting('process.control.mode');
+        request.setValue(mode);
+        await gateway.callAsync('device/set_setting', request);
+    }
+    /**
+     * Gets the control mode of this process.
+     * @returns Control mode.
+     */
+    async getMode() {
+        const request = new gateway.DeviceGetSettingRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setSetting('process.control.mode');
+        const response = await gateway.callAsync('device/get_setting', request, gateway.DoubleResponse);
+        return response.getValue();
+    }
+    /**
+     * Gets the source used to control this process.
+     * @returns The source providing feedback for this process.
+     */
+    async getSource() {
+        const request = new gateway.AxisEmptyRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        const response = await gateway.callAsync('process_controller/get_source', request, gateway.ProcessControllerSource);
+        return process_controller_source_1.ProcessControllerSource.fromProtobuf(response.toObject());
+    }
+    /**
+     * Sets the source used to control this process.
+     * @param source Sets the source that should provide feedback for this process.
+     */
+    async setSource(source) {
+        const request = new gateway.SetProcessControllerSource();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setSource(process_controller_source_1.ProcessControllerSource.toProtobuf(source));
+        await gateway.callAsync('process_controller/set_source', request);
+    }
+    /**
+     * Gets the current value of the source used to control this process.
+     * @returns The current value of this process's controlling source.
+     */
+    async getInput() {
+        const request = new gateway.AxisEmptyRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        const response = await gateway.callAsync('process_controller/get_input', request, gateway.Measurement);
+        return measurement_1.Measurement.fromProtobuf(response.toObject());
+    }
+    /**
+     * Sends a generic ASCII command to this process' underlying axis.
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     * @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.
+     * @returns A response to the command.
+     */
+    async genericCommand(command, options = {}) {
+        const { checkErrors = true, timeout = 0, } = options;
+        const request = new gateway.GenericCommandRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setCommand(command);
+        request.setCheckErrors(checkErrors);
+        request.setTimeout(timeout);
+        const response = await gateway.callAsync('interface/generic_command', request, gateway.GenericCommandResponse);
+        return response_1.Response.fromProtobuf(response.toObject());
+    }
+    /**
+     * Sends a generic ASCII command to this process and expect multiple responses.
+     * Responses are returned in order of arrival.
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     * @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.
+     * @returns All responses to the command.
+     */
+    async genericCommandMultiResponse(command, options = {}) {
+        const { checkErrors = true, timeout = 0, } = options;
+        const request = new gateway.GenericCommandRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setCommand(command);
+        request.setCheckErrors(checkErrors);
+        request.setTimeout(timeout);
+        const response = await gateway.callAsync('interface/generic_command_multi_response', request, gateway.GenericCommandResponseCollection);
+        return response.getResponsesList().map(a => response_1.Response.fromProtobuf(a.toObject()));
+    }
+    /**
+     * Sends a generic ASCII command to this process without expecting a response and without adding a message ID
+     * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).
+     * @param command Command and its parameters.
+     */
+    async genericCommandNoResponse(command) {
+        const request = new gateway.GenericCommandRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setCommand(command);
+        await gateway.callAsync('interface/generic_command_no_response', request);
+    }
+    /**
+     * Returns a serialization of the current process state that can be saved and reapplied.
+     * @returns A serialization of the current state of the process.
+     */
+    async getState() {
+        const request = new gateway.AxisEmptyRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        const response = await gateway.callAsync('device/get_state', request, gateway.StringResponse);
+        return response.getValue();
+    }
+    /**
+     * Applies a saved state to this process.
+     * @param state The state object to apply to this process.
+     */
+    async setState(state) {
+        const request = new gateway.SetStateRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setState(state);
+        await gateway.callAsync('device/set_state', request);
+    }
+    /**
+     * Checks if a state can be applied to this process.
+     * This only covers exceptions that can be determined statically such as mismatches of ID or version,
+     * the process of applying the state can still fail when running.
+     * @param state The state object to check against.
+     * @returns An explanation of why this state cannot be set to this process.
+     */
+    async canSetState(state) {
+        const request = new gateway.CanSetStateRequest();
+        request.setInterfaceId(this.controller.device.connection.interfaceId);
+        request.setDevice(this.controller.device.deviceAddress);
+        request.setAxis(this.processNumber);
+        request.setState(state);
+        const response = await gateway.callAsync('device/can_set_axis_state', request, gateway.CanSetStateAxisResponse);
+        return response.getError();
+    }
+}
+exports.Process = Process;
+//# sourceMappingURL=process.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"process.js","sourceRoot":"","sources":["../../../src/ascii/process.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGtD,oDAAsC;AACtC,iCAA8B;AAC9B,yCAAsC;AACtC,mDAA+C;AAC/C,uCAAwC;AACxC,yCAAsC;AAEtC,2EAAsE;AACtE,gDAA6C;AAE7C;;;;;GAKG;AACH,MAAa,OAAO;IAClB;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAGD;;OAEG;IACH,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAKD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAGD;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAGD,YAAY,UAA6B,EAAE,aAAqB;QAC9D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,WAAI,CAAC,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,qBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CACjB,UAAmB,IAAI;QAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACxC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEvB,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,EAAE,CACb,WAAmB,CAAC;QAEpB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACxC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAE9B,MAAM,OAAO,CAAC,SAAS,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG;QACd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACxC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAErB,MAAM,OAAO,CAAC,SAAS,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAClB,IAA2B;QAE3B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;QAC3C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEvB,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;QAE3C,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;;;OAGG;IACI,KAAK,CAAC,SAAS;QACpB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,+BAA+B,EAC/B,OAAO,EACP,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACnC,OAAO,mDAAuB,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CACpB,MAA+B;QAE/B,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,0BAA0B,EAAE,CAAC;QACzD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,SAAS,CAAC,mDAAuB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAE9D,MAAM,OAAO,CAAC,SAAS,CAAC,+BAA+B,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,8BAA8B,EAC9B,OAAO,EACP,OAAO,CAAC,WAAW,CAAC,CAAC;QACvB,OAAO,yBAAW,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,cAAc,CACzB,OAAe,EACf,UAAyC,EAAE;QAE3C,MAAM,EACJ,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,CAAC,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAClC,OAAO,mBAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,2BAA2B,CACtC,OAAe,EACf,UAAsD,EAAE;QAExD,MAAM,EACJ,WAAW,GAAG,IAAI,EAClB,OAAO,GAAG,CAAC,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0CAA0C,EAC1C,OAAO,EACP,OAAO,CAAC,gCAAgC,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC,gBAAgB,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,wBAAwB,CACnC,OAAe;QAEf,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;QACpD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,MAAM,OAAO,CAAC,SAAS,CAAC,uCAAuC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACnB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC/C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEpC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,kBAAkB,EAClB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ,CACnB,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC9C,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACtB,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;QACjD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACtE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACnC,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAhUD,0BAgUC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { ProcessController } from './process_controller';\nimport * as gateway from '../gateway';\nimport { Axis } from './axis';\nimport { Response } from './response';\nimport { AxisSettings } from './axis_settings';\nimport { AxisStorage } from './storage';\nimport { Warnings } from './warnings';\nimport { ProcessControllerMode } from './process_controller_mode';\nimport { ProcessControllerSource } from './process_controller_source';\nimport { Measurement } from '../measurement';\n\n/**\n * Use to drive voltage for a process such as a heater, valve, Peltier device, etc.\n * WARNING: DO NOT USE. This API is for an as-yet unreleased product and firmware version.\n * It is subject to breaking changes without warning until further notice.\n * Requires at least Firmware 7.34.\n */\nexport class Process {\n  /**\n   * Controller for this process.\n   */\n  public get controller(): ProcessController {\n    return this._controller;\n  }\n  private _controller: ProcessController;\n\n  /**\n   * The process number identifies the process on the controller.\n   */\n  public get processNumber(): number {\n    return this._processNumber;\n  }\n  private _processNumber: number;\n\n  private _axis: Axis;\n\n  /**\n   * Settings and properties of this process.\n   */\n  public get settings(): AxisSettings {\n    return this._settings;\n  }\n  private _settings: AxisSettings;\n\n  /**\n   * Key-value storage of this process.\n   */\n  public get storage(): AxisStorage {\n    return this._storage;\n  }\n  private _storage: AxisStorage;\n\n  /**\n   * Warnings and faults of this process.\n   */\n  public get warnings(): Warnings {\n    return this._warnings;\n  }\n  private _warnings: Warnings;\n\n  constructor(controller: ProcessController, processNumber: number) {\n    this._controller = controller;\n    this._processNumber = processNumber;\n    this._axis = new Axis(controller.device, processNumber);\n    this._settings = new AxisSettings(this._axis);\n    this._storage = new AxisStorage(this._axis);\n    this._warnings = new Warnings(controller.device, processNumber);\n  }\n\n  /**\n   * Sets the enabled state of the driver.\n   * @param [enabled=true] If true (default) enables drive. If false disables.\n   */\n  public async enable(\n    enabled: boolean = true\n  ): Promise<void> {\n    const request = new gateway.ProcessOn();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setOn(enabled);\n\n    await gateway.callAsync('process-controller/enable', request);\n  }\n\n  /**\n   * Turns this process on. In manual mode, this supplies voltage; in controlled mode, it starts the control loop.\n   * @param [duration=0] How long to leave the process on in milliseconds.\n   */\n  public async on(\n    duration: number = 0\n  ): Promise<void> {\n    const request = new gateway.ProcessOn();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setOn(true);\n    request.setDuration(duration);\n\n    await gateway.callAsync('process-controller/on', request);\n  }\n\n  /**\n   * Turns this process off.\n   */\n  public async off(): Promise<void> {\n    const request = new gateway.ProcessOn();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setOn(false);\n\n    await gateway.callAsync('process-controller/on', request);\n  }\n\n  /**\n   * Sets the control mode of this process.\n   * @param mode Mode to set this process to.\n   */\n  public async setMode(\n    mode: ProcessControllerMode\n  ): Promise<void> {\n    const request = new gateway.DeviceSetSettingRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setSetting('process.control.mode');\n    request.setValue(mode);\n\n    await gateway.callAsync('device/set_setting', request);\n  }\n\n  /**\n   * Gets the control mode of this process.\n   * @returns Control mode.\n   */\n  public async getMode(): Promise<ProcessControllerMode> {\n    const request = new gateway.DeviceGetSettingRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setSetting('process.control.mode');\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   * Gets the source used to control this process.\n   * @returns The source providing feedback for this process.\n   */\n  public async getSource(): Promise<ProcessControllerSource> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n\n    const response = await gateway.callAsync<gateway.ProcessControllerSource>(\n      'process_controller/get_source',\n      request,\n      gateway.ProcessControllerSource);\n    return ProcessControllerSource.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Sets the source used to control this process.\n   * @param source Sets the source that should provide feedback for this process.\n   */\n  public async setSource(\n    source: ProcessControllerSource\n  ): Promise<void> {\n    const request = new gateway.SetProcessControllerSource();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setSource(ProcessControllerSource.toProtobuf(source));\n\n    await gateway.callAsync('process_controller/set_source', request);\n  }\n\n  /**\n   * Gets the current value of the source used to control this process.\n   * @returns The current value of this process's controlling source.\n   */\n  public async getInput(): Promise<Measurement> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n\n    const response = await gateway.callAsync<gateway.Measurement>(\n      'process_controller/get_input',\n      request,\n      gateway.Measurement);\n    return Measurement.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Sends a generic ASCII command to this process' underlying axis.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.checkErrors=true] Controls whether to throw an exception when the device rejects the command.\n   * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @returns A response to the command.\n   */\n  public async genericCommand(\n    command: string,\n    options: Process.GenericCommandOptions = {}\n  ): Promise<Response> {\n    const {\n      checkErrors = true,\n      timeout = 0,\n    } = options;\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setCommand(command);\n    request.setCheckErrors(checkErrors);\n    request.setTimeout(timeout);\n\n    const response = await gateway.callAsync<gateway.GenericCommandResponse>(\n      'interface/generic_command',\n      request,\n      gateway.GenericCommandResponse);\n    return Response.fromProtobuf(response.toObject());\n  }\n\n  /**\n   * Sends a generic ASCII command to this process and expect multiple responses.\n   * Responses are returned in order of arrival.\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   * @param [options.checkErrors=true] Controls whether to throw an exception when a device rejects the command.\n   * @param [options.timeout=0] The timeout, in milliseconds, for a device to respond to the command.\n   * Overrides the connection default request timeout.\n   * @returns All responses to the command.\n   */\n  public async genericCommandMultiResponse(\n    command: string,\n    options: Process.GenericCommandMultiResponseOptions = {}\n  ): Promise<Response[]> {\n    const {\n      checkErrors = true,\n      timeout = 0,\n    } = options;\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setCommand(command);\n    request.setCheckErrors(checkErrors);\n    request.setTimeout(timeout);\n\n    const response = await gateway.callAsync<gateway.GenericCommandResponseCollection>(\n      'interface/generic_command_multi_response',\n      request,\n      gateway.GenericCommandResponseCollection);\n    return response.getResponsesList().map(a => Response.fromProtobuf(a.toObject()));\n  }\n\n  /**\n   * Sends a generic ASCII command to this process without expecting a response and without adding a message ID\n   * For more information refer to: [ASCII Protocol Manual](https://www.zaber.com/protocol-manual#topic_commands).\n   * @param command Command and its parameters.\n   */\n  public async genericCommandNoResponse(\n    command: string\n  ): Promise<void> {\n    const request = new gateway.GenericCommandRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setCommand(command);\n\n    await gateway.callAsync('interface/generic_command_no_response', request);\n  }\n\n  /**\n   * Returns a serialization of the current process state that can be saved and reapplied.\n   * @returns A serialization of the current state of the process.\n   */\n  public async getState(): Promise<string> {\n    const request = new gateway.AxisEmptyRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n\n    const response = await gateway.callAsync<gateway.StringResponse>(\n      'device/get_state',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Applies a saved state to this process.\n   * @param state The state object to apply to this process.\n   */\n  public async setState(\n    state: string\n  ): Promise<void> {\n    const request = new gateway.SetStateRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setState(state);\n\n    await gateway.callAsync('device/set_state', request);\n  }\n\n  /**\n   * Checks if a state can be applied to this process.\n   * This only covers exceptions that can be determined statically such as mismatches of ID or version,\n   * the process of applying the state can still fail when running.\n   * @param state The state object to check against.\n   * @returns An explanation of why this state cannot be set to this process.\n   */\n  public async canSetState(\n    state: string\n  ): Promise<string> {\n    const request = new gateway.CanSetStateRequest();\n    request.setInterfaceId(this.controller.device.connection.interfaceId);\n    request.setDevice(this.controller.device.deviceAddress);\n    request.setAxis(this.processNumber);\n    request.setState(state);\n\n    const response = await gateway.callAsync<gateway.CanSetStateAxisResponse>(\n      'device/can_set_axis_state',\n      request,\n      gateway.CanSetStateAxisResponse);\n    return response.getError();\n  }\n}\n\nnamespace Process {\n  export interface GenericCommandOptions {\n      checkErrors?: boolean;\n      timeout?: number;\n  }\n  export interface GenericCommandMultiResponseOptions {\n      checkErrors?: boolean;\n      timeout?: number;\n  }\n}\n"]}

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

@@ -0,0 +1,39 @@
+import { Connection } from './connection';
+import { Device } from './device';
+import { Process } from './process';
+/**
+ * Use to manage a process controller.
+ * WARNING: DO NOT USE. This API is for an as-yet unreleased product and firmware version.
+ * It is subject to breaking changes without warning until further notice.
+ * Requires at least Firmware 7.34.
+ */
+export declare class ProcessController {
+    /**
+     * The base device of this process controller.
+     */
+    get device(): Device;
+    private _device;
+    /**
+     * Creates instance of `ProcessController` of the given device.
+     * If the device is identified, this constructor will ensure it is a process controller.
+     */
+    constructor(device: Device);
+    /**
+     * Detects the process controllers on the connection.
+     * @param connection The connection to detect process controllers on.
+     * @param [identify=true] If the Process Controllers should be identified upon detection.
+     * @returns A list of all `ProcessController`s on the connection.
+     */
+    static detect(connection: Connection, identify?: boolean): Promise<ProcessController[]>;
+    /**
+     * Gets an Process class instance which allows you to control a particular voltage source.
+     * Axes are numbered from 1.
+     * @param processNumber Number of process to control.
+     * @returns Process instance.
+     */
+    getProcess(processNumber: number): Process;
+    /**
+     * Checks if this is a process controller or some other type of device and throws a detect error if it is not.
+     */
+    private _verifyIsProcessController;
+}