@zaber/motion 6.2.1 → 6.4.0

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

@@ -11,25 +11,30 @@ export declare class DeviceIO {
     private _device;
     constructor(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.
      */
-    getAllDigitalInputs(): Promise<boolean[]>;
+    getChannelsInfo(): Promise<DeviceIOInfo>;
     /**
-     * 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.
      */
-    getAllDigitalOutputs(): Promise<boolean[]>;
+    setLabel(portType: IoPortType, channelNumber: number, label?: string): Promise<void>;
     /**
-     * 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.
      */
-    getAllAnalogInputs(): Promise<number[]>;
+    getLabel(portType: IoPortType, channelNumber: number): Promise<string>;
     /**
-     * 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.
      */
-    getAllAnalogOutputs(): Promise<number[]>;
+    getAllLabels(): Promise<IoPortLabel[]>;
     /**
      * Returns the current value of the specified digital input channel.
      * @param channelNumber Channel number starting at 1.
@@ -55,55 +60,36 @@ export declare class DeviceIO {
      */
     getAnalogOutput(channelNumber: number): Promise<number>;
     /**
-     * Sets values for all digital output channels.
-     * @param values The type of action to perform on the channel.
-     */
-    setAllDigitalOutputs(values: DigitalOutputAction[]): Promise<void>;
-    /**
-     * 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.
-     */
-    setAllDigitalOutputsSchedule(values: DigitalOutputAction[], futureValues: DigitalOutputAction[], delay: number, unit?: Time | Native): Promise<void>;
-    /**
-     * 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 digital input channels.
+     * @returns True if voltage is present on the input channel and false otherwise.
      */
-    cancelAllDigitalOutputsSchedule(channels?: boolean[]): Promise<void>;
+    getAllDigitalInputs(): Promise<boolean[]>;
     /**
-     * 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 digital output channels.
+     * @returns True if the output channel is conducting and false otherwise.
      */
-    cancelAllAnalogOutputsSchedule(channels?: boolean[]): Promise<void>;
+    getAllDigitalOutputs(): Promise<boolean[]>;
     /**
-     * Sets values for all analog output channels.
-     * @param values Voltage values to set the output channels to.
+     * Returns the current values of all analog input channels.
+     * @returns  Measurements of the voltage present on the input channels.
      */
-    setAllAnalogOutputs(values: number[]): Promise<void>;
+    getAllAnalogInputs(): Promise<number[]>;
     /**
-     * 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.
+     * Returns the current values of all analog output channels.
+     * @returns  Measurements of voltage that the output channels are conducting.
      */
-    setAllAnalogOutputsSchedule(values: number[], futureValues: number[], delay: number, unit?: Time | Native): Promise<void>;
+    getAllAnalogOutputs(): Promise<number[]>;
     /**
      * 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.
      */
     setDigitalOutput(channelNumber: number, value: DigitalOutputAction): Promise<void>;
+    /**
+     * Sets values for all digital output channels.
+     * @param values The type of action to perform on the channel.
+     */
+    setAllDigitalOutputs(values: DigitalOutputAction[]): Promise<void>;
     /**
      * Sets current and future value for the specified digital output channel.
      * Requires at least Firmware 7.37.
@@ -115,23 +101,25 @@ export declare class DeviceIO {
      */
     setDigitalOutputSchedule(channelNumber: number, value: DigitalOutputAction, futureValue: DigitalOutputAction, delay: number, unit?: Time | Native): Promise<void>;
     /**
-     * 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.
-     */
-    cancelDigitalOutputSchedule(channelNumber: number): Promise<void>;
-    /**
-     * Cancels a scheduled analog output value.
-     * Requires at least Firmware 7.38.
-     * @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.
      */
-    cancelAnalogOutputSchedule(channelNumber: number): Promise<void>;
+    setAllDigitalOutputsSchedule(values: DigitalOutputAction[], futureValues: DigitalOutputAction[], delay: number, unit?: Time | Native): Promise<void>;
     /**
      * 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.
      */
     setAnalogOutput(channelNumber: number, value: number): Promise<void>;
+    /**
+     * Sets values for all analog output channels.
+     * @param values Voltage values to set the output channels to.
+     */
+    setAllAnalogOutputs(values: number[]): Promise<void>;
     /**
      * Sets current and future value for the specified analog output channel.
      * Requires at least Firmware 7.38.
@@ -143,29 +131,41 @@ export declare class DeviceIO {
      */
     setAnalogOutputSchedule(channelNumber: number, value: number, futureValue: number, delay: number, unit?: Time | Native): Promise<void>;
     /**
-     * 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.
      */
-    getChannelsInfo(): Promise<DeviceIOInfo>;
+    setAllAnalogOutputsSchedule(values: number[], futureValues: number[], delay: number, unit?: Time | Native): Promise<void>;
     /**
-     * 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.
      */
-    setLabel(portType: IoPortType, channelNumber: number, label?: string): Promise<void>;
+    cancelDigitalOutputSchedule(channelNumber: number): Promise<void>;
     /**
-     * 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.
+     */
+    cancelAllDigitalOutputsSchedule(channels?: boolean[]): Promise<void>;
+    /**
+     * 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.
      */
-    getLabel(portType: IoPortType, channelNumber: number): Promise<string>;
+    cancelAnalogOutputSchedule(channelNumber: number): Promise<void>;
     /**
-     * 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.
      */
-    getAllLabels(): Promise<IoPortLabel[]>;
+    cancelAllAnalogOutputsSchedule(channels?: boolean[]): Promise<void>;
 }
 //# sourceMappingURL=device_io.d.ts.map

package/dist/lib/ascii/device_io.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"device_io.d.ts","sourceRoot":"","sources":["../../../src/ascii/device_io.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,OAAO,EAAE,MAAM,EAAS,IAAI,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;GAEG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,MAAM;IAI1B;;;OAGG;IACU,mBAAmB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBtD;;;OAGG;IACU,oBAAoB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBvD;;;OAGG;IACU,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBpD;;;OAGG;IACU,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBrD;;;;OAIG;IACU,eAAe,CAC1B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,OAAO,CAAC;IAmBnB;;;;OAIG;IACU,gBAAgB,CAC3B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,OAAO,CAAC;IAmBnB;;;;OAIG;IACU,cAAc,CACzB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC;IAmBlB;;;;OAIG;IACU,eAAe,CAC1B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC;IAmBlB;;;OAGG;IACU,oBAAoB,CAC/B,MAAM,EAAE,mBAAmB,EAAE,GAC5B,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;OAOG;IACU,4BAA4B,CACvC,MAAM,EAAE,mBAAmB,EAAE,EAC7B,YAAY,EAAE,mBAAmB,EAAE,EACnC,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,IAAI,GAAG,MAAqB,GACjC,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;;;;OAMG;IACU,+BAA+B,CAC1C,QAAQ,GAAE,OAAO,EAAO,GACvB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;OAMG;IACU,8BAA8B,CACzC,QAAQ,GAAE,OAAO,EAAO,GACvB,OAAO,CAAC,IAAI,CAAC;IAehB;;;OAGG;IACU,mBAAmB,CAC9B,MAAM,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;OAOG;IACU,2BAA2B,CACtC,MAAM,EAAE,MAAM,EAAE,EAChB,YAAY,EAAE,MAAM,EAAE,EACtB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,IAAI,GAAG,MAAqB,GACjC,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;;OAIG;IACU,gBAAgB,CAC3B,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,mBAAmB,GACzB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;OAQG;IACU,wBAAwB,CACnC,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,mBAAmB,EAC1B,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,IAAI,GAAG,MAAqB,GACjC,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;OAIG;IACU,2BAA2B,CACtC,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;OAIG;IACU,0BAA0B,CACrC,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;OAIG;IACU,eAAe,CAC1B,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;OAQG;IACU,uBAAuB,CAClC,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,IAAI,GAAG,MAAqB,GACjC,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;OAGG;IACU,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC;IAiBrD;;;;;;OAMG;IACU,QAAQ,CACnB,QAAQ,EAAE,UAAU,EACpB,aAAa,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;;;OAKG;IACU,QAAQ,CACnB,QAAQ,EAAE,UAAU,EACpB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC;IAmBlB;;;OAGG;IACU,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;CAgBpD"}
+{"version":3,"file":"device_io.d.ts","sourceRoot":"","sources":["../../../src/ascii/device_io.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,OAAO,EAAE,MAAM,EAAS,IAAI,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;GAEG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,MAAM;IAI1B;;;OAGG;IACU,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC;IAiBrD;;;;;;OAMG;IACU,QAAQ,CACnB,QAAQ,EAAE,UAAU,EACpB,aAAa,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;;;OAKG;IACU,QAAQ,CACnB,QAAQ,EAAE,UAAU,EACpB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC;IAmBlB;;;OAGG;IACU,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAiBnD;;;;OAIG;IACU,eAAe,CAC1B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,OAAO,CAAC;IAmBnB;;;;OAIG;IACU,gBAAgB,CAC3B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,OAAO,CAAC;IAmBnB;;;;OAIG;IACU,cAAc,CACzB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC;IAmBlB;;;;OAIG;IACU,eAAe,CAC1B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC;IAmBlB;;;OAGG;IACU,mBAAmB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBtD;;;OAGG;IACU,oBAAoB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAkBvD;;;OAGG;IACU,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBpD;;;OAGG;IACU,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBrD;;;;OAIG;IACU,gBAAgB,CAC3B,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,mBAAmB,GACzB,OAAO,CAAC,IAAI,CAAC;IAehB;;;OAGG;IACU,oBAAoB,CAC/B,MAAM,EAAE,mBAAmB,EAAE,GAC5B,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;;OAQG;IACU,wBAAwB,CACnC,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,mBAAmB,EAC1B,WAAW,EAAE,mBAAmB,EAChC,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,IAAI,GAAG,MAAqB,GACjC,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;;;;OAOG;IACU,4BAA4B,CACvC,MAAM,EAAE,mBAAmB,EAAE,EAC7B,YAAY,EAAE,mBAAmB,EAAE,EACnC,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,IAAI,GAAG,MAAqB,GACjC,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;;OAIG;IACU,eAAe,CAC1B,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC;IAehB;;;OAGG;IACU,mBAAmB,CAC9B,MAAM,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;;;;OAQG;IACU,uBAAuB,CAClC,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,IAAI,GAAG,MAAqB,GACjC,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;;;;OAOG;IACU,2BAA2B,CACtC,MAAM,EAAE,MAAM,EAAE,EAChB,YAAY,EAAE,MAAM,EAAE,EACtB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,IAAI,GAAG,MAAqB,GACjC,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;;OAIG;IACU,2BAA2B,CACtC,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;OAMG;IACU,+BAA+B,CAC1C,QAAQ,GAAE,OAAO,EAAO,GACvB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;OAIG;IACU,0BAA0B,CACrC,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;OAMG;IACU,8BAA8B,CACzC,QAAQ,GAAE,OAAO,EAAO,GACvB,OAAO,CAAC,IAAI,CAAC;CAcjB"}