@zaber/motion 5.2.2 → 6.0.1

package/dist/lib/ascii/device_io.js

@@ -27,9 +27,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeviceIO = void 0;
 const gateway = __importStar(require("../gateway"));
+const requests = __importStar(require("../requests"));
 const units_1 = require("../units");
 const device_io_info_1 = require("./device_io_info");
-const io_port_label_1 = require("./io_port_label");
 /**
  * Class providing access to the I/O channels of the device.
  */
@@ -42,48 +42,68 @@ class DeviceIO {
      * @returns True if voltage is present on the input channel and false otherwise.
      */
     async getAllDigitalInputs() {
-        const request = new gateway.DeviceGetAllDigitalIORequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelType('di');
-        const response = await gateway.callAsync('device/get_all_digital_io', request, gateway.DeviceGetAllDigitalIOResponse);
-        return response.getValuesList();
+        const request = {
+            ...requests.DeviceGetAllDigitalIORequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelType: 'di',
+            toBinary() {
+                return requests.DeviceGetAllDigitalIORequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_all_digital_io', request, requests.DeviceGetAllDigitalIOResponse.fromBinary);
+        return response.values;
     }
     /**
      * Returns the current values of all digital output channels.
      * @returns True if the output channel is conducting and false otherwise.
      */
     async getAllDigitalOutputs() {
-        const request = new gateway.DeviceGetAllDigitalIORequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelType('do');
-        const response = await gateway.callAsync('device/get_all_digital_io', request, gateway.DeviceGetAllDigitalIOResponse);
-        return response.getValuesList();
+        const request = {
+            ...requests.DeviceGetAllDigitalIORequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelType: 'do',
+            toBinary() {
+                return requests.DeviceGetAllDigitalIORequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_all_digital_io', request, requests.DeviceGetAllDigitalIOResponse.fromBinary);
+        return response.values;
     }
     /**
      * Returns the current values of all analog input channels.
      * @returns  Measurements of the voltage present on the input channels.
      */
     async getAllAnalogInputs() {
-        const request = new gateway.DeviceGetAllAnalogIORequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelType('ai');
-        const response = await gateway.callAsync('device/get_all_analog_io', request, gateway.DeviceGetAllAnalogIOResponse);
-        return response.getValuesList();
+        const request = {
+            ...requests.DeviceGetAllAnalogIORequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelType: 'ai',
+            toBinary() {
+                return requests.DeviceGetAllAnalogIORequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_all_analog_io', request, requests.DeviceGetAllAnalogIOResponse.fromBinary);
+        return response.values;
     }
     /**
      * Returns the current values of all analog output channels.
      * @returns  Measurements of voltage that the output channels are conducting.
      */
     async getAllAnalogOutputs() {
-        const request = new gateway.DeviceGetAllAnalogIORequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelType('ao');
-        const response = await gateway.callAsync('device/get_all_analog_io', request, gateway.DeviceGetAllAnalogIOResponse);
-        return response.getValuesList();
+        const request = {
+            ...requests.DeviceGetAllAnalogIORequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelType: 'ao',
+            toBinary() {
+                return requests.DeviceGetAllAnalogIORequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_all_analog_io', request, requests.DeviceGetAllAnalogIOResponse.fromBinary);
+        return response.values;
     }
     /**
      * Returns the current value of the specified digital input channel.
@@ -91,13 +111,18 @@ class DeviceIO {
      * @returns True if voltage is present on the input channel and false otherwise.
      */
     async getDigitalInput(channelNumber) {
-        const request = new gateway.DeviceGetDigitalIORequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelType('di');
-        request.setChannelNumber(channelNumber);
-        const response = await gateway.callAsync('device/get_digital_io', request, gateway.BoolResponse);
-        return response.getValue();
+        const request = {
+            ...requests.DeviceGetDigitalIORequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelType: 'di',
+            channelNumber: channelNumber,
+            toBinary() {
+                return requests.DeviceGetDigitalIORequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_digital_io', request, requests.BoolResponse.fromBinary);
+        return response.value;
     }
     /**
      * Returns the current value of the specified digital output channel.
@@ -105,13 +130,18 @@ class DeviceIO {
      * @returns True if the output channel is conducting and false otherwise.
      */
     async getDigitalOutput(channelNumber) {
-        const request = new gateway.DeviceGetDigitalIORequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelType('do');
-        request.setChannelNumber(channelNumber);
-        const response = await gateway.callAsync('device/get_digital_io', request, gateway.BoolResponse);
-        return response.getValue();
+        const request = {
+            ...requests.DeviceGetDigitalIORequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelType: 'do',
+            channelNumber: channelNumber,
+            toBinary() {
+                return requests.DeviceGetDigitalIORequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_digital_io', request, requests.BoolResponse.fromBinary);
+        return response.value;
     }
     /**
      * Returns the current value of the specified analog input channel.
@@ -119,13 +149,18 @@ class DeviceIO {
      * @returns  A measurementsof the voltage present on the input channel.
      */
     async getAnalogInput(channelNumber) {
-        const request = new gateway.DeviceGetAnalogIORequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelType('ai');
-        request.setChannelNumber(channelNumber);
-        const response = await gateway.callAsync('device/get_analog_io', request, gateway.DoubleResponse);
-        return response.getValue();
+        const request = {
+            ...requests.DeviceGetAnalogIORequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelType: 'ai',
+            channelNumber: channelNumber,
+            toBinary() {
+                return requests.DeviceGetAnalogIORequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_analog_io', request, requests.DoubleResponse.fromBinary);
+        return response.value;
     }
     /**
      * Returns the current values of the specified analog output channel.
@@ -133,23 +168,33 @@ class DeviceIO {
      * @returns A measurement of voltage that the output channel is conducting.
      */
     async getAnalogOutput(channelNumber) {
-        const request = new gateway.DeviceGetAnalogIORequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelType('ao');
-        request.setChannelNumber(channelNumber);
-        const response = await gateway.callAsync('device/get_analog_io', request, gateway.DoubleResponse);
-        return response.getValue();
+        const request = {
+            ...requests.DeviceGetAnalogIORequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelType: 'ao',
+            channelNumber: channelNumber,
+            toBinary() {
+                return requests.DeviceGetAnalogIORequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_analog_io', request, requests.DoubleResponse.fromBinary);
+        return response.value;
     }
     /**
      * Sets values for all digital output channels.
      * @param values The type of action to perform on the channel.
      */
     async setAllDigitalOutputs(values) {
-        const request = new gateway.DeviceSetAllDigitalOutputsRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setValuesList(values);
+        const request = {
+            ...requests.DeviceSetAllDigitalOutputsRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            values: values,
+            toBinary() {
+                return requests.DeviceSetAllDigitalOutputsRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_all_digital_outputs', request);
     }
     /**
@@ -164,13 +209,18 @@ class DeviceIO {
         if (delay <= 0) {
             throw new TypeError('Delay must be a positive value.');
         }
-        const request = new gateway.DeviceSetAllDigitalOutputsScheduleRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setValuesList(values);
-        request.setFutureValuesList(futureValues);
-        request.setDelay(delay);
-        request.setUnit(unit);
+        const request = {
+            ...requests.DeviceSetAllDigitalOutputsScheduleRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            values: values,
+            futureValues: futureValues,
+            delay: delay,
+            unit: unit,
+            toBinary() {
+                return requests.DeviceSetAllDigitalOutputsScheduleRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_all_digital_outputs_schedule', request);
     }
     /**
@@ -181,11 +231,16 @@ class DeviceIO {
      * Specifying "True" for a channel will cancel the scheduled digital output action for that channel.
      */
     async cancelAllDigitalOutputsSchedule(channels = []) {
-        const request = new gateway.DeviceCancelAllOutputsScheduleRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setAnalog(false);
-        request.setChannelsList(channels);
+        const request = {
+            ...requests.DeviceCancelAllOutputsScheduleRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            analog: false,
+            channels: channels,
+            toBinary() {
+                return requests.DeviceCancelAllOutputsScheduleRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/cancel_all_outputs_schedule', request);
     }
     /**
@@ -196,11 +251,16 @@ class DeviceIO {
      * Specifying "True" for a channel will cancel the scheduled analog output value for that channel.
      */
     async cancelAllAnalogOutputsSchedule(channels = []) {
-        const request = new gateway.DeviceCancelAllOutputsScheduleRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setAnalog(true);
-        request.setChannelsList(channels);
+        const request = {
+            ...requests.DeviceCancelAllOutputsScheduleRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            analog: true,
+            channels: channels,
+            toBinary() {
+                return requests.DeviceCancelAllOutputsScheduleRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/cancel_all_outputs_schedule', request);
     }
     /**
@@ -208,10 +268,15 @@ class DeviceIO {
      * @param values Voltage values to set the output channels to.
      */
     async setAllAnalogOutputs(values) {
-        const request = new gateway.DeviceSetAllAnalogOutputsRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setValuesList(values);
+        const request = {
+            ...requests.DeviceSetAllAnalogOutputsRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            values: values,
+            toBinary() {
+                return requests.DeviceSetAllAnalogOutputsRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_all_analog_outputs', request);
     }
     /**
@@ -226,13 +291,18 @@ class DeviceIO {
         if (delay <= 0) {
             throw new TypeError('Delay must be a positive value.');
         }
-        const request = new gateway.DeviceSetAllAnalogOutputsScheduleRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setValuesList(values);
-        request.setFutureValuesList(futureValues);
-        request.setDelay(delay);
-        request.setUnit(unit);
+        const request = {
+            ...requests.DeviceSetAllAnalogOutputsScheduleRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            values: values,
+            futureValues: futureValues,
+            delay: delay,
+            unit: unit,
+            toBinary() {
+                return requests.DeviceSetAllAnalogOutputsScheduleRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_all_analog_outputs_schedule', request);
     }
     /**
@@ -241,11 +311,16 @@ class DeviceIO {
      * @param value The type of action to perform on the channel.
      */
     async setDigitalOutput(channelNumber, value) {
-        const request = new gateway.DeviceSetDigitalOutputRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelNumber(channelNumber);
-        request.setValue(value);
+        const request = {
+            ...requests.DeviceSetDigitalOutputRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelNumber: channelNumber,
+            value: value,
+            toBinary() {
+                return requests.DeviceSetDigitalOutputRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_digital_output', request);
     }
     /**
@@ -261,14 +336,19 @@ class DeviceIO {
         if (delay <= 0) {
             throw new TypeError('Delay must be a positive value.');
         }
-        const request = new gateway.DeviceSetDigitalOutputScheduleRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelNumber(channelNumber);
-        request.setValue(value);
-        request.setFutureValue(futureValue);
-        request.setDelay(delay);
-        request.setUnit(unit);
+        const request = {
+            ...requests.DeviceSetDigitalOutputScheduleRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelNumber: channelNumber,
+            value: value,
+            futureValue: futureValue,
+            delay: delay,
+            unit: unit,
+            toBinary() {
+                return requests.DeviceSetDigitalOutputScheduleRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_digital_output_schedule', request);
     }
     /**
@@ -277,11 +357,16 @@ class DeviceIO {
      * @param channelNumber Channel number starting at 1.
      */
     async cancelDigitalOutputSchedule(channelNumber) {
-        const request = new gateway.DeviceCancelOutputScheduleRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setAnalog(false);
-        request.setChannelNumber(channelNumber);
+        const request = {
+            ...requests.DeviceCancelOutputScheduleRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            analog: false,
+            channelNumber: channelNumber,
+            toBinary() {
+                return requests.DeviceCancelOutputScheduleRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/cancel_output_schedule', request);
     }
     /**
@@ -290,11 +375,16 @@ class DeviceIO {
      * @param channelNumber Channel number starting at 1.
      */
     async cancelAnalogOutputSchedule(channelNumber) {
-        const request = new gateway.DeviceCancelOutputScheduleRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setAnalog(true);
-        request.setChannelNumber(channelNumber);
+        const request = {
+            ...requests.DeviceCancelOutputScheduleRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            analog: true,
+            channelNumber: channelNumber,
+            toBinary() {
+                return requests.DeviceCancelOutputScheduleRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/cancel_output_schedule', request);
     }
     /**
@@ -303,11 +393,16 @@ class DeviceIO {
      * @param value Value to set the output channel voltage to.
      */
     async setAnalogOutput(channelNumber, value) {
-        const request = new gateway.DeviceSetAnalogOutputRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelNumber(channelNumber);
-        request.setValue(value);
+        const request = {
+            ...requests.DeviceSetAnalogOutputRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelNumber: channelNumber,
+            value: value,
+            toBinary() {
+                return requests.DeviceSetAnalogOutputRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_analog_output', request);
     }
     /**
@@ -323,14 +418,19 @@ class DeviceIO {
         if (delay <= 0) {
             throw new TypeError('Delay must be a positive value.');
         }
-        const request = new gateway.DeviceSetAnalogOutputScheduleRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setChannelNumber(channelNumber);
-        request.setValue(value);
-        request.setFutureValue(futureValue);
-        request.setDelay(delay);
-        request.setUnit(unit);
+        const request = {
+            ...requests.DeviceSetAnalogOutputScheduleRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            channelNumber: channelNumber,
+            value: value,
+            futureValue: futureValue,
+            delay: delay,
+            unit: unit,
+            toBinary() {
+                return requests.DeviceSetAnalogOutputScheduleRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_analog_output_schedule', request);
     }
     /**
@@ -338,25 +438,36 @@ class DeviceIO {
      * @returns An object containing the number of I/O channels the device has.
      */
     async getChannelsInfo() {
-        const request = new gateway.DeviceEmptyRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        const response = await gateway.callAsync('device/get_io_info', request, gateway.DeviceIOInfo);
-        return device_io_info_1.DeviceIOInfo.fromProtobuf(response.toObject());
+        const request = {
+            ...requests.DeviceEmptyRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            toBinary() {
+                return requests.DeviceEmptyRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_io_info', request, device_io_info_1.DeviceIOInfo.fromBinary);
+        return response;
     }
     /**
      * Sets the label of the specified channel.
      * @param portType The type of channel to set the label of.
      * @param channelNumber Channel number starting at 1.
      * @param label The label to set for the specified channel.
+     * If no value or an empty string is provided, this label is deleted.
      */
     async setLabel(portType, channelNumber, label) {
-        const request = new gateway.SetIoPortLabel();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setPortType(portType);
-        request.setChannelNumber(channelNumber);
-        request.setLabel(label);
+        const request = {
+            ...requests.SetIoPortLabelRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            portType: portType,
+            channelNumber: channelNumber,
+            label: label,
+            toBinary() {
+                return requests.SetIoPortLabelRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('device/set_io_label', request);
     }
     /**
@@ -366,24 +477,34 @@ class DeviceIO {
      * @returns The label of the specified channel.
      */
     async getLabel(portType, channelNumber) {
-        const request = new gateway.GetIoPortLabel();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        request.setPortType(portType);
-        request.setChannelNumber(channelNumber);
-        const response = await gateway.callAsync('device/get_io_label', request, gateway.StringResponse);
-        return response.getValue();
+        const request = {
+            ...requests.GetIoPortLabelRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            portType: portType,
+            channelNumber: channelNumber,
+            toBinary() {
+                return requests.GetIoPortLabelRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_io_label', request, requests.StringResponse.fromBinary);
+        return response.value;
     }
     /**
      * Returns every label assigned to an IO port on this device.
      * @returns The labels set for this device's IO.
      */
     async getAllLabels() {
-        const request = new gateway.DeviceEmptyRequest();
-        request.setInterfaceId(this._device.connection.interfaceId);
-        request.setDevice(this._device.deviceAddress);
-        const response = await gateway.callAsync('device/get_all_io_labels', request, gateway.GetAllIoPortLabelsResponse);
-        return response.getLabelsList().map(a => io_port_label_1.IoPortLabel.fromProtobuf(a.toObject()));
+        const request = {
+            ...requests.DeviceEmptyRequest.DEFAULT,
+            interfaceId: this._device.connection.interfaceId,
+            device: this._device.deviceAddress,
+            toBinary() {
+                return requests.DeviceEmptyRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/get_all_io_labels', request, requests.GetAllIoPortLabelsResponse.fromBinary);
+        return response.labels;
     }
 }
 exports.DeviceIO = DeviceIO;