@zaber/motion 6.3.0 → 6.4.0

package/dist/lib/ascii/device_io.js

@@ -38,72 +38,77 @@ class DeviceIO {
         this._device = device;
     }
     /**
-     * Returns the current values of all digital input channels.
-     * @returns True if voltage is present on the input channel and false otherwise.
+     * Returns the number of I/O channels the device has.
+     * @returns An object containing the number of I/O channels the device has.
      */
-    async getAllDigitalInputs() {
+    async getChannelsInfo() {
         const request = {
-            ...requests.DeviceGetAllDigitalIORequest.DEFAULT,
+            ...requests.DeviceEmptyRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            channelType: 'di',
             toBinary() {
-                return requests.DeviceGetAllDigitalIORequest.toBinary(this);
+                return requests.DeviceEmptyRequest.toBinary(this);
             },
         };
-        const response = await gateway.callAsync('device/get_all_digital_io', request, requests.DeviceGetAllDigitalIOResponse.fromBinary);
-        return response.values;
+        const response = await gateway.callAsync('device/get_io_info', request, device_io_info_1.DeviceIOInfo.fromBinary);
+        return response;
     }
     /**
-     * Returns the current values of all digital output channels.
-     * @returns True if the output channel is conducting and false otherwise.
+     * 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 getAllDigitalOutputs() {
+    async setLabel(portType, channelNumber, label) {
         const request = {
-            ...requests.DeviceGetAllDigitalIORequest.DEFAULT,
+            ...requests.SetIoPortLabelRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            channelType: 'do',
+            portType: portType,
+            channelNumber: channelNumber,
+            label: label,
             toBinary() {
-                return requests.DeviceGetAllDigitalIORequest.toBinary(this);
+                return requests.SetIoPortLabelRequest.toBinary(this);
             },
         };
-        const response = await gateway.callAsync('device/get_all_digital_io', request, requests.DeviceGetAllDigitalIOResponse.fromBinary);
-        return response.values;
+        await gateway.callAsync('device/set_io_label', request);
     }
     /**
-     * Returns the current values of all analog input channels.
-     * @returns  Measurements of the voltage present on the input channels.
+     * Returns the label of the specified channel.
+     * @param portType The type of channel to get the label of.
+     * @param channelNumber Channel number starting at 1.
+     * @returns The label of the specified channel.
      */
-    async getAllAnalogInputs() {
+    async getLabel(portType, channelNumber) {
         const request = {
-            ...requests.DeviceGetAllAnalogIORequest.DEFAULT,
+            ...requests.GetIoPortLabelRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            channelType: 'ai',
+            portType: portType,
+            channelNumber: channelNumber,
             toBinary() {
-                return requests.DeviceGetAllAnalogIORequest.toBinary(this);
+                return requests.GetIoPortLabelRequest.toBinary(this);
             },
         };
-        const response = await gateway.callAsync('device/get_all_analog_io', request, requests.DeviceGetAllAnalogIOResponse.fromBinary);
-        return response.values;
+        const response = await gateway.callAsync('device/get_io_label', request, requests.StringResponse.fromBinary);
+        return response.value;
     }
     /**
-     * Returns the current values of all analog output channels.
-     * @returns  Measurements of voltage that the output channels are conducting.
+     * Returns every label assigned to an IO port on this device.
+     * @returns The labels set for this device's IO.
      */
-    async getAllAnalogOutputs() {
+    async getAllLabels() {
         const request = {
-            ...requests.DeviceGetAllAnalogIORequest.DEFAULT,
+            ...requests.DeviceEmptyRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            channelType: 'ao',
             toBinary() {
-                return requests.DeviceGetAllAnalogIORequest.toBinary(this);
+                return requests.DeviceEmptyRequest.toBinary(this);
             },
         };
-        const response = await gateway.callAsync('device/get_all_analog_io', request, requests.DeviceGetAllAnalogIOResponse.fromBinary);
-        return response.values;
+        const response = await gateway.callAsync('device/get_all_io_labels', request, requests.GetAllIoPortLabelsResponse.fromBinary);
+        return response.labels;
     }
     /**
      * Returns the current value of the specified digital input channel.
@@ -182,146 +187,106 @@ class DeviceIO {
         return response.value;
     }
     /**
-     * Sets values for all digital output channels.
-     * @param values The type of action to perform on the channel.
+     * Returns the current values of all digital input channels.
+     * @returns True if voltage is present on the input channel and false otherwise.
      */
-    async setAllDigitalOutputs(values) {
+    async getAllDigitalInputs() {
         const request = {
-            ...requests.DeviceSetAllDigitalOutputsRequest.DEFAULT,
+            ...requests.DeviceGetAllDigitalIORequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            values: values,
+            channelType: 'di',
             toBinary() {
-                return requests.DeviceSetAllDigitalOutputsRequest.toBinary(this);
+                return requests.DeviceGetAllDigitalIORequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/set_all_digital_outputs', request);
+        const response = await gateway.callAsync('device/get_all_digital_io', request, requests.DeviceGetAllDigitalIOResponse.fromBinary);
+        return response.values;
     }
     /**
-     * Sets current and future value for all digital output channels.
-     * Requires at least Firmware 7.37.
-     * @param values The type of actions to perform immediately on output channels.
-     * @param futureValues The type of actions to perform in the future on output channels.
-     * @param delay Delay between setting current values and setting future values.
-     * @param [unit=Units.NATIVE] Units of time.
+     * Returns the current values of all digital output channels.
+     * @returns True if the output channel is conducting and false otherwise.
      */
-    async setAllDigitalOutputsSchedule(values, futureValues, delay, unit = units_1.Units.NATIVE) {
-        if (delay <= 0) {
-            throw new TypeError('Delay must be a positive value.');
-        }
+    async getAllDigitalOutputs() {
         const request = {
-            ...requests.DeviceSetAllDigitalOutputsScheduleRequest.DEFAULT,
+            ...requests.DeviceGetAllDigitalIORequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            values: values,
-            futureValues: futureValues,
-            delay: delay,
-            unit: unit,
+            channelType: 'do',
             toBinary() {
-                return requests.DeviceSetAllDigitalOutputsScheduleRequest.toBinary(this);
+                return requests.DeviceGetAllDigitalIORequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/set_all_digital_outputs_schedule', request);
+        const response = await gateway.callAsync('device/get_all_digital_io', request, requests.DeviceGetAllDigitalIOResponse.fromBinary);
+        return response.values;
     }
     /**
-     * Cancel all scheduled digital output actions.
-     * Requires at least Firmware 7.37.
-     * @param [channels=[]] Optionally specify which channels to cancel.
-     * Array length must be empty or equal to the number of channels on device.
-     * Specifying "True" for a channel will cancel the scheduled digital output action for that channel.
+     * Returns the current values of all analog input channels.
+     * @returns  Measurements of the voltage present on the input channels.
      */
-    async cancelAllDigitalOutputsSchedule(channels = []) {
+    async getAllAnalogInputs() {
         const request = {
-            ...requests.DeviceCancelAllOutputsScheduleRequest.DEFAULT,
+            ...requests.DeviceGetAllAnalogIORequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            analog: false,
-            channels: channels,
+            channelType: 'ai',
             toBinary() {
-                return requests.DeviceCancelAllOutputsScheduleRequest.toBinary(this);
+                return requests.DeviceGetAllAnalogIORequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/cancel_all_outputs_schedule', request);
+        const response = await gateway.callAsync('device/get_all_analog_io', request, requests.DeviceGetAllAnalogIOResponse.fromBinary);
+        return response.values;
     }
     /**
-     * Cancel all scheduled analog output actions.
-     * Requires at least Firmware 7.38.
-     * @param [channels=[]] Optionally specify which channels to cancel.
-     * Array length must be empty or equal to the number of channels on device.
-     * Specifying "True" for a channel will cancel the scheduled analog output value for that channel.
+     * Returns the current values of all analog output channels.
+     * @returns  Measurements of voltage that the output channels are conducting.
      */
-    async cancelAllAnalogOutputsSchedule(channels = []) {
+    async getAllAnalogOutputs() {
         const request = {
-            ...requests.DeviceCancelAllOutputsScheduleRequest.DEFAULT,
+            ...requests.DeviceGetAllAnalogIORequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            analog: true,
-            channels: channels,
+            channelType: 'ao',
             toBinary() {
-                return requests.DeviceCancelAllOutputsScheduleRequest.toBinary(this);
+                return requests.DeviceGetAllAnalogIORequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/cancel_all_outputs_schedule', request);
+        const response = await gateway.callAsync('device/get_all_analog_io', request, requests.DeviceGetAllAnalogIOResponse.fromBinary);
+        return response.values;
     }
     /**
-     * Sets values for all analog output channels.
-     * @param values Voltage values to set the output channels to.
+     * Sets value for the specified digital output channel.
+     * @param channelNumber Channel number starting at 1.
+     * @param value The type of action to perform on the channel.
      */
-    async setAllAnalogOutputs(values) {
+    async setDigitalOutput(channelNumber, value) {
         const request = {
-            ...requests.DeviceSetAllAnalogOutputsRequest.DEFAULT,
+            ...requests.DeviceSetDigitalOutputRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            values: values,
+            channelNumber: channelNumber,
+            value: value,
             toBinary() {
-                return requests.DeviceSetAllAnalogOutputsRequest.toBinary(this);
+                return requests.DeviceSetDigitalOutputRequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/set_all_analog_outputs', request);
+        await gateway.callAsync('device/set_digital_output', request);
     }
     /**
-     * Sets current and future values for all analog output channels.
-     * Requires at least Firmware 7.38.
-     * @param values Voltage values to set the output channels to immediately.
-     * @param futureValues Voltage values to set the output channels to in the future.
-     * @param delay Delay between setting current values and setting future values.
-     * @param [unit=Units.NATIVE] Units of time.
+     * Sets values for all digital output channels.
+     * @param values The type of action to perform on the channel.
      */
-    async setAllAnalogOutputsSchedule(values, futureValues, delay, unit = units_1.Units.NATIVE) {
-        if (delay <= 0) {
-            throw new TypeError('Delay must be a positive value.');
-        }
+    async setAllDigitalOutputs(values) {
         const request = {
-            ...requests.DeviceSetAllAnalogOutputsScheduleRequest.DEFAULT,
+            ...requests.DeviceSetAllDigitalOutputsRequest.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);
-    }
-    /**
-     * Sets value for the specified digital output channel.
-     * @param channelNumber Channel number starting at 1.
-     * @param value The type of action to perform on the channel.
-     */
-    async setDigitalOutput(channelNumber, 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);
+                return requests.DeviceSetAllDigitalOutputsRequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/set_digital_output', request);
+        await gateway.callAsync('device/set_all_digital_outputs', request);
     }
     /**
      * Sets current and future value for the specified digital output channel.
@@ -352,58 +317,64 @@ class DeviceIO {
         await gateway.callAsync('device/set_digital_output_schedule', request);
     }
     /**
-     * Cancels a scheduled digital output action.
+     * Sets current and future values for all digital output channels.
      * Requires at least Firmware 7.37.
-     * @param channelNumber Channel number starting at 1.
+     * @param values The type of actions to perform immediately on output channels.
+     * @param futureValues The type of actions to perform in the future on output channels.
+     * @param delay Delay between setting current values and setting future values.
+     * @param [unit=Units.NATIVE] Units of time.
      */
-    async cancelDigitalOutputSchedule(channelNumber) {
+    async setAllDigitalOutputsSchedule(values, futureValues, delay, unit = units_1.Units.NATIVE) {
+        if (delay <= 0) {
+            throw new TypeError('Delay must be a positive value.');
+        }
         const request = {
-            ...requests.DeviceCancelOutputScheduleRequest.DEFAULT,
+            ...requests.DeviceSetAllDigitalOutputsScheduleRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            analog: false,
-            channelNumber: channelNumber,
+            values: values,
+            futureValues: futureValues,
+            delay: delay,
+            unit: unit,
             toBinary() {
-                return requests.DeviceCancelOutputScheduleRequest.toBinary(this);
+                return requests.DeviceSetAllDigitalOutputsScheduleRequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/cancel_output_schedule', request);
+        await gateway.callAsync('device/set_all_digital_outputs_schedule', request);
     }
     /**
-     * Cancels a scheduled analog output value.
-     * Requires at least Firmware 7.38.
+     * Sets value for the specified analog output channel.
      * @param channelNumber Channel number starting at 1.
+     * @param value Value to set the output channel voltage to.
      */
-    async cancelAnalogOutputSchedule(channelNumber) {
+    async setAnalogOutput(channelNumber, value) {
         const request = {
-            ...requests.DeviceCancelOutputScheduleRequest.DEFAULT,
+            ...requests.DeviceSetAnalogOutputRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            analog: true,
             channelNumber: channelNumber,
+            value: value,
             toBinary() {
-                return requests.DeviceCancelOutputScheduleRequest.toBinary(this);
+                return requests.DeviceSetAnalogOutputRequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/cancel_output_schedule', request);
+        await gateway.callAsync('device/set_analog_output', request);
     }
     /**
-     * Sets value for the specified analog output channel.
-     * @param channelNumber Channel number starting at 1.
-     * @param value Value to set the output channel voltage to.
+     * Sets values for all analog output channels.
+     * @param values Voltage values to set the output channels to.
      */
-    async setAnalogOutput(channelNumber, value) {
+    async setAllAnalogOutputs(values) {
         const request = {
-            ...requests.DeviceSetAnalogOutputRequest.DEFAULT,
+            ...requests.DeviceSetAllAnalogOutputsRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            channelNumber: channelNumber,
-            value: value,
+            values: values,
             toBinary() {
-                return requests.DeviceSetAnalogOutputRequest.toBinary(this);
+                return requests.DeviceSetAllAnalogOutputsRequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/set_analog_output', request);
+        await gateway.callAsync('device/set_all_analog_outputs', request);
     }
     /**
      * Sets current and future value for the specified analog output channel.
@@ -434,77 +405,106 @@ class DeviceIO {
         await gateway.callAsync('device/set_analog_output_schedule', request);
     }
     /**
-     * Returns the number of I/O channels the device has.
-     * @returns An object containing the number of I/O channels the device has.
+     * Sets current and future values for all analog output channels.
+     * Requires at least Firmware 7.38.
+     * @param values Voltage values to set the output channels to immediately.
+     * @param futureValues Voltage values to set the output channels to in the future.
+     * @param delay Delay between setting current values and setting future values.
+     * @param [unit=Units.NATIVE] Units of time.
      */
-    async getChannelsInfo() {
+    async setAllAnalogOutputsSchedule(values, futureValues, delay, unit = units_1.Units.NATIVE) {
+        if (delay <= 0) {
+            throw new TypeError('Delay must be a positive value.');
+        }
         const request = {
-            ...requests.DeviceEmptyRequest.DEFAULT,
+            ...requests.DeviceSetAllAnalogOutputsScheduleRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
+            values: values,
+            futureValues: futureValues,
+            delay: delay,
+            unit: unit,
             toBinary() {
-                return requests.DeviceEmptyRequest.toBinary(this);
+                return requests.DeviceSetAllAnalogOutputsScheduleRequest.toBinary(this);
             },
         };
-        const response = await gateway.callAsync('device/get_io_info', request, device_io_info_1.DeviceIOInfo.fromBinary);
-        return response;
+        await gateway.callAsync('device/set_all_analog_outputs_schedule', request);
     }
     /**
-     * Sets the label of the specified channel.
-     * @param portType The type of channel to set the label of.
+     * Cancels a scheduled digital output action.
+     * Requires at least Firmware 7.37.
      * @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) {
+    async cancelDigitalOutputSchedule(channelNumber) {
         const request = {
-            ...requests.SetIoPortLabelRequest.DEFAULT,
+            ...requests.DeviceCancelOutputScheduleRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            portType: portType,
+            analog: false,
             channelNumber: channelNumber,
-            label: label,
             toBinary() {
-                return requests.SetIoPortLabelRequest.toBinary(this);
+                return requests.DeviceCancelOutputScheduleRequest.toBinary(this);
             },
         };
-        await gateway.callAsync('device/set_io_label', request);
+        await gateway.callAsync('device/cancel_output_schedule', request);
     }
     /**
-     * Returns the label of the specified channel.
-     * @param portType The type of channel to get the label of.
+     * Cancel all scheduled digital output actions.
+     * Requires at least Firmware 7.37.
+     * @param [channels=[]] Optionally specify which channels to cancel.
+     * Array length must be empty or equal to the number of channels on device.
+     * Specifying "True" for a channel will cancel the scheduled digital output action for that channel.
+     */
+    async cancelAllDigitalOutputsSchedule(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);
+    }
+    /**
+     * Cancels a scheduled analog output value.
+     * Requires at least Firmware 7.38.
      * @param channelNumber Channel number starting at 1.
-     * @returns The label of the specified channel.
      */
-    async getLabel(portType, channelNumber) {
+    async cancelAnalogOutputSchedule(channelNumber) {
         const request = {
-            ...requests.GetIoPortLabelRequest.DEFAULT,
+            ...requests.DeviceCancelOutputScheduleRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
-            portType: portType,
+            analog: true,
             channelNumber: channelNumber,
             toBinary() {
-                return requests.GetIoPortLabelRequest.toBinary(this);
+                return requests.DeviceCancelOutputScheduleRequest.toBinary(this);
             },
         };
-        const response = await gateway.callAsync('device/get_io_label', request, requests.StringResponse.fromBinary);
-        return response.value;
+        await gateway.callAsync('device/cancel_output_schedule', request);
     }
     /**
-     * Returns every label assigned to an IO port on this device.
-     * @returns The labels set for this device's IO.
+     * Cancel all scheduled analog output actions.
+     * Requires at least Firmware 7.38.
+     * @param [channels=[]] Optionally specify which channels to cancel.
+     * Array length must be empty or equal to the number of channels on device.
+     * Specifying "True" for a channel will cancel the scheduled analog output value for that channel.
      */
-    async getAllLabels() {
+    async cancelAllAnalogOutputsSchedule(channels = []) {
         const request = {
-            ...requests.DeviceEmptyRequest.DEFAULT,
+            ...requests.DeviceCancelAllOutputsScheduleRequest.DEFAULT,
             interfaceId: this._device.connection.interfaceId,
             device: this._device.deviceAddress,
+            analog: true,
+            channels: channels,
             toBinary() {
-                return requests.DeviceEmptyRequest.toBinary(this);
+                return requests.DeviceCancelAllOutputsScheduleRequest.toBinary(this);
             },
         };
-        const response = await gateway.callAsync('device/get_all_io_labels', request, requests.GetAllIoPortLabelsResponse.fromBinary);
-        return response.labels;
+        await gateway.callAsync('device/cancel_all_outputs_schedule', request);
     }
 }
 exports.DeviceIO = DeviceIO;