@zaber/motion 5.2.2 → 6.0.1

package/dist/lib/ascii/connection.js

@@ -30,10 +30,9 @@ const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const gateway = __importStar(require("../gateway"));
 const gateway_1 = require("../gateway");
+const requests = __importStar(require("../requests"));
 const device_1 = require("./device");
 const response_1 = require("./response");
-const unknown_response_event_1 = require("./unknown_response_event");
-const alert_event_1 = require("./alert_event");
 /**
  * Class representing access to particular connection (serial port, TCP connection).
  */
@@ -81,13 +80,18 @@ class Connection {
      */
     static async openSerialPort(portName, options = {}) {
         const { baudRate = Connection.DEFAULT_BAUD_RATE, direct = false, } = options;
-        const request = new gateway.OpenInterfaceRequest();
-        request.setInterfaceType(gateway.InterfaceType.SERIAL_PORT);
-        request.setPortName(portName);
-        request.setBaudRate(baudRate);
-        request.setRejectRoutedConnection(direct);
-        const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
-        return new Connection(response.getInterfaceId());
+        const request = {
+            ...requests.OpenInterfaceRequest.DEFAULT,
+            interfaceType: requests.InterfaceType.SERIAL_PORT,
+            portName: portName,
+            baudRate: baudRate,
+            rejectRoutedConnection: direct,
+            toBinary() {
+                return requests.OpenInterfaceRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('interface/open', request, requests.OpenInterfaceResponse.fromBinary);
+        return new Connection(response.interfaceId);
     }
     /**
      * Opens a TCP connection.
@@ -96,12 +100,17 @@ class Connection {
      * @returns An object representing the connection.
      */
     static async openTcp(hostName, port = Connection.TCP_PORT_CHAIN) {
-        const request = new gateway.OpenInterfaceRequest();
-        request.setInterfaceType(gateway.InterfaceType.TCP);
-        request.setHostName(hostName);
-        request.setPort(port);
-        const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
-        return new Connection(response.getInterfaceId());
+        const request = {
+            ...requests.OpenInterfaceRequest.DEFAULT,
+            interfaceType: requests.InterfaceType.TCP,
+            hostName: hostName,
+            port: port,
+            toBinary() {
+                return requests.OpenInterfaceRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('interface/open', request, requests.OpenInterfaceResponse.fromBinary);
+        return new Connection(response.interfaceId);
     }
     /**
      * Opens a connection using a custom transport.
@@ -109,55 +118,70 @@ class Connection {
      * @returns An object representing the connection.
      */
     static async openCustom(transport) {
-        const request = new gateway.OpenInterfaceRequest();
-        request.setInterfaceType(gateway.InterfaceType.CUSTOM);
-        request.setTransport(transport.transportId);
-        const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
-        return new Connection(response.getInterfaceId());
+        const request = {
+            ...requests.OpenInterfaceRequest.DEFAULT,
+            interfaceType: requests.InterfaceType.CUSTOM,
+            transport: transport.transportId,
+            toBinary() {
+                return requests.OpenInterfaceRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('interface/open', request, requests.OpenInterfaceResponse.fromBinary);
+        return new Connection(response.interfaceId);
     }
     /**
      * Opens a secured connection to a cloud connected device chain.
      * Use this method to connect to devices on your account.
      * @param cloudId The cloud ID to connect to.
      * @param [options.token='unauthenticated'] The token to authenticate with. By default the connection will be unauthenticated.
-     * @param [options.connectionName=''] The name of the connection to open.
+     * @param options.connectionName The name of the connection to open.
      * Can be left empty to default to the only connection present.
      * Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
-     * @param [options.realm=''] The realm to connect to.
+     * @param options.realm The realm to connect to.
      * Can be left empty for the default account realm.
      * @param [options.api='https://api.zaber.io'] The URL of the API to receive connection info from.
      * @returns An object representing the connection.
      */
     static async openIot(cloudId, options = {}) {
-        const { token = 'unauthenticated', connectionName = '', realm = '', api = 'https://api.zaber.io', } = options;
-        const request = new gateway.OpenInterfaceRequest();
-        request.setInterfaceType(gateway.InterfaceType.IOT);
-        request.setCloudId(cloudId);
-        request.setToken(token);
-        request.setConnectionName(connectionName);
-        request.setRealm(realm);
-        request.setApi(api);
-        const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
-        return new Connection(response.getInterfaceId());
+        const { token = 'unauthenticated', connectionName, realm, api = 'https://api.zaber.io', } = options;
+        const request = {
+            ...requests.OpenInterfaceRequest.DEFAULT,
+            interfaceType: requests.InterfaceType.IOT,
+            cloudId: cloudId,
+            token: token,
+            connectionName: connectionName,
+            realm: realm,
+            api: api,
+            toBinary() {
+                return requests.OpenInterfaceRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('interface/open', request, requests.OpenInterfaceResponse.fromBinary);
+        return new Connection(response.interfaceId);
     }
     /**
      * Opens a connection to Zaber Launcher in your Local Area Network.
      * The connection is not secured.
      * @param hostName Hostname or IP address.
      * @param [port=Connection.NETWORK_SHARE_PORT] Port number.
-     * @param [connectionName=''] The name of the connection to open.
+     * @param connectionName The name of the connection to open.
      * Can be left empty to default to the only connection present.
      * Otherwise, use serial port name for serial port connection or hostname:port for TCP connection.
      * @returns An object representing the connection.
      */
-    static async openNetworkShare(hostName, port = Connection.NETWORK_SHARE_PORT, connectionName = '') {
-        const request = new gateway.OpenInterfaceRequest();
-        request.setInterfaceType(gateway.InterfaceType.NETWORK_SHARE);
-        request.setHostName(hostName);
-        request.setPort(port);
-        request.setConnectionName(connectionName);
-        const response = await gateway.callAsync('interface/open', request, gateway.OpenInterfaceResponse);
-        return new Connection(response.getInterfaceId());
+    static async openNetworkShare(hostName, port = Connection.NETWORK_SHARE_PORT, connectionName) {
+        const request = {
+            ...requests.OpenInterfaceRequest.DEFAULT,
+            interfaceType: requests.InterfaceType.NETWORK_SHARE,
+            hostName: hostName,
+            port: port,
+            connectionName: connectionName,
+            toBinary() {
+                return requests.OpenInterfaceRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('interface/open', request, requests.OpenInterfaceResponse.fromBinary);
+        return new Connection(response.interfaceId);
     }
     /**
      * Sends a generic ASCII command to this connection.
@@ -172,15 +196,20 @@ class Connection {
      */
     async genericCommand(command, options = {}) {
         const { device = 0, axis = 0, checkErrors = true, timeout = 0, } = options;
-        const request = new gateway.GenericCommandRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setCommand(command);
-        request.setDevice(device);
-        request.setAxis(axis);
-        request.setCheckErrors(checkErrors);
-        request.setTimeout(timeout);
-        const response = await gateway.callAsync('interface/generic_command', request, gateway.GenericCommandResponse);
-        return response_1.Response.fromProtobuf(response.toObject());
+        const request = {
+            ...requests.GenericCommandRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            command: command,
+            device: device,
+            axis: axis,
+            checkErrors: checkErrors,
+            timeout: timeout,
+            toBinary() {
+                return requests.GenericCommandRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('interface/generic_command', request, response_1.Response.fromBinary);
+        return response;
     }
     /**
      * Sends a generic ASCII command to this connection without expecting a response and without adding a message ID.
@@ -193,11 +222,16 @@ class Connection {
      */
     async genericCommandNoResponse(command, options = {}) {
         const { device = 0, axis = 0, } = options;
-        const request = new gateway.GenericCommandRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setCommand(command);
-        request.setDevice(device);
-        request.setAxis(axis);
+        const request = {
+            ...requests.GenericCommandRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            command: command,
+            device: device,
+            axis: axis,
+            toBinary() {
+                return requests.GenericCommandRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('interface/generic_command_no_response', request);
     }
     /**
@@ -215,24 +249,34 @@ class Connection {
      */
     async genericCommandMultiResponse(command, options = {}) {
         const { device = 0, axis = 0, checkErrors = true, timeout = 0, } = options;
-        const request = new gateway.GenericCommandRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setCommand(command);
-        request.setDevice(device);
-        request.setAxis(axis);
-        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()));
+        const request = {
+            ...requests.GenericCommandRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            command: command,
+            device: device,
+            axis: axis,
+            checkErrors: checkErrors,
+            timeout: timeout,
+            toBinary() {
+                return requests.GenericCommandRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('interface/generic_command_multi_response', request, requests.GenericCommandResponseCollection.fromBinary);
+        return response.responses;
     }
     /**
      * Enables alerts for all devices on the connection.
      * This will change the "comm.alert" setting to 1 on all supported devices.
      */
     async enableAlerts() {
-        const request = new gateway.GenericCommandRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setCommand('set comm.alert 1');
+        const request = {
+            ...requests.GenericCommandRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            command: 'set comm.alert 1',
+            toBinary() {
+                return requests.GenericCommandRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('interface/generic_command_no_response', request);
     }
     /**
@@ -240,25 +284,40 @@ class Connection {
      * This will change the "comm.alert" setting to 0 on all supported devices.
      */
     async disableAlerts() {
-        const request = new gateway.GenericCommandRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setCommand('set comm.alert 0');
+        const request = {
+            ...requests.GenericCommandRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            command: 'set comm.alert 0',
+            toBinary() {
+                return requests.GenericCommandRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('interface/generic_command_no_response', request);
     }
     /**
      * Resets ASCII protocol message IDs. Only for testing purposes.
      */
     resetIds() {
-        const request = new gateway.InterfaceEmptyRequest();
-        request.setInterfaceId(this.interfaceId);
+        const request = {
+            ...requests.InterfaceEmptyRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            toBinary() {
+                return requests.InterfaceEmptyRequest.toBinary(this);
+            },
+        };
         gateway.callSync('interface/reset_ids', request);
     }
     /**
      * Close the connection.
      */
     async close() {
-        const request = new gateway.InterfaceEmptyRequest();
-        request.setInterfaceId(this.interfaceId);
+        const request = {
+            ...requests.InterfaceEmptyRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            toBinary() {
+                return requests.InterfaceEmptyRequest.toBinary(this);
+            },
+        };
         await gateway.callAsync('interface/close', request);
     }
     /**
@@ -284,11 +343,16 @@ class Connection {
         if (firstAddress <= 0) {
             throw new TypeError('Invalid value; device addresses are numbered from 1.');
         }
-        const request = new gateway.DeviceRenumberRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setFirstAddress(firstAddress);
-        const response = await gateway.callAsync('device/renumber', request, gateway.IntResponse);
-        return response.getValue();
+        const request = {
+            ...requests.DeviceRenumberRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            firstAddress: firstAddress,
+            toBinary() {
+                return requests.DeviceRenumberRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/renumber', request, requests.IntResponse.fromBinary);
+        return response.value;
     }
     /**
      * Attempts to detect any devices present on this connection.
@@ -297,11 +361,16 @@ class Connection {
      */
     async detectDevices(options = {}) {
         const { identifyDevices = true, } = options;
-        const request = new gateway.DeviceDetectRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setIdentifyDevices(identifyDevices);
-        const response = await gateway.callAsync('device/detect', request, gateway.DeviceDetectResponse);
-        return response.getDevicesList().map(deviceAddress => this.getDevice(deviceAddress));
+        const request = {
+            ...requests.DeviceDetectRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            identifyDevices: identifyDevices,
+            toBinary() {
+                return requests.DeviceDetectRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/detect', request, requests.DeviceDetectResponse.fromBinary);
+        return response.devices.map(deviceAddress => this.getDevice(deviceAddress));
     }
     /**
      * Stops all of the devices on this connection.
@@ -311,11 +380,16 @@ class Connection {
      */
     async stopAll(options = {}) {
         const { waitUntilIdle = true, } = options;
-        const request = new gateway.DeviceOnAllRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setWaitUntilIdle(waitUntilIdle);
-        const response = await gateway.callAsync('device/stop_all', request, gateway.DeviceOnAllResponse);
-        return response.getDeviceAddressesList();
+        const request = {
+            ...requests.DeviceOnAllRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            waitUntilIdle: waitUntilIdle,
+            toBinary() {
+                return requests.DeviceOnAllRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/stop_all', request, requests.DeviceOnAllResponse.fromBinary);
+        return response.deviceAddresses;
     }
     /**
      * Homes all of the devices on this connection.
@@ -325,40 +399,60 @@ class Connection {
      */
     async homeAll(options = {}) {
         const { waitUntilIdle = true, } = options;
-        const request = new gateway.DeviceOnAllRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setWaitUntilIdle(waitUntilIdle);
-        const response = await gateway.callAsync('device/home_all', request, gateway.DeviceOnAllResponse);
-        return response.getDeviceAddressesList();
+        const request = {
+            ...requests.DeviceOnAllRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            waitUntilIdle: waitUntilIdle,
+            toBinary() {
+                return requests.DeviceOnAllRequest.toBinary(this);
+            },
+        };
+        const response = await gateway.callAsync('device/home_all', request, requests.DeviceOnAllResponse.fromBinary);
+        return response.deviceAddresses;
     }
     /**
      * Returns a string that represents the connection.
      * @returns A string that represents the connection.
      */
     toString() {
-        const request = new gateway.InterfaceEmptyRequest();
-        request.setInterfaceId(this.interfaceId);
-        const response = gateway.callSync('interface/to_string', request, gateway.StringResponse);
-        return response.getValue();
+        const request = {
+            ...requests.InterfaceEmptyRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            toBinary() {
+                return requests.InterfaceEmptyRequest.toBinary(this);
+            },
+        };
+        const response = gateway.callSync('interface/to_string', request, requests.StringResponse.fromBinary);
+        return response.value;
     }
     /**
      * Returns default request timeout.
      * @returns Default request timeout.
      */
     _retrieveTimeout() {
-        const request = new gateway.InterfaceEmptyRequest();
-        request.setInterfaceId(this.interfaceId);
-        const response = gateway.callSync('interface/get_timeout', request, gateway.IntResponse);
-        return response.getValue();
+        const request = {
+            ...requests.InterfaceEmptyRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            toBinary() {
+                return requests.InterfaceEmptyRequest.toBinary(this);
+            },
+        };
+        const response = gateway.callSync('interface/get_timeout', request, requests.IntResponse.fromBinary);
+        return response.value;
     }
     /**
      * Sets default request timeout.
      * @param timeout Default request timeout.
      */
     _changeTimeout(timeout) {
-        const request = new gateway.SetInterfaceTimeoutRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setTimeout(timeout);
+        const request = {
+            ...requests.SetInterfaceTimeoutRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            timeout: timeout,
+            toBinary() {
+                return requests.SetInterfaceTimeoutRequest.toBinary(this);
+            },
+        };
         gateway.callSync('interface/set_timeout', request);
     }
     /**
@@ -366,19 +460,29 @@ class Connection {
      * @returns Checksum enabled.
      */
     _retrieveChecksumEnabled() {
-        const request = new gateway.InterfaceEmptyRequest();
-        request.setInterfaceId(this.interfaceId);
-        const response = gateway.callSync('interface/get_checksum_enabled', request, gateway.BoolResponse);
-        return response.getValue();
+        const request = {
+            ...requests.InterfaceEmptyRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            toBinary() {
+                return requests.InterfaceEmptyRequest.toBinary(this);
+            },
+        };
+        const response = gateway.callSync('interface/get_checksum_enabled', request, requests.BoolResponse.fromBinary);
+        return response.value;
     }
     /**
      * Sets checksum enabled.
      * @param isEnabled Checksum enabled.
      */
     _changeChecksumEnabled(isEnabled) {
-        const request = new gateway.SetInterfaceChecksumEnabledRequest();
-        request.setInterfaceId(this.interfaceId);
-        request.setIsEnabled(isEnabled);
+        const request = {
+            ...requests.SetInterfaceChecksumEnabledRequest.DEFAULT,
+            interfaceId: this.interfaceId,
+            isEnabled: isEnabled,
+            toBinary() {
+                return requests.SetInterfaceChecksumEnabledRequest.toBinary(this);
+            },
+        };
         gateway.callSync('interface/set_checksum_enabled', request);
     }
     /**
@@ -388,8 +492,8 @@ class Connection {
         return this._disconnected;
     }
     _subscribe() {
-        this.unknownResponse = gateway_1.events.pipe((0, operators_1.takeUntil)(this._disconnected), (0, gateway_1.filterEvent)('interface/unknown_response'), (0, operators_1.filter)(event => event.interfaceId === this.interfaceId), (0, operators_1.map)(event => unknown_response_event_1.UnknownResponseEvent.fromProtobuf(event)));
-        this.alert = gateway_1.events.pipe((0, operators_1.takeUntil)(this._disconnected), (0, gateway_1.filterEvent)('interface/alert'), (0, operators_1.filter)(event => event.interfaceId === this.interfaceId), (0, operators_1.map)(event => alert_event_1.AlertEvent.fromProtobuf(event)));
+        this.unknownResponse = gateway_1.events.pipe((0, operators_1.takeUntil)(this._disconnected), (0, gateway_1.filterEvent)('interface/unknown_response'), (0, operators_1.filter)(event => event.interfaceId === this.interfaceId), (0, operators_1.map)(event => event.unknownResponse));
+        this.alert = gateway_1.events.pipe((0, operators_1.takeUntil)(this._disconnected), (0, gateway_1.filterEvent)('interface/alert'), (0, operators_1.filter)(event => event.interfaceId === this.interfaceId), (0, operators_1.map)(event => event.alert));
         gateway_1.events.pipe((0, gateway_1.filterEvent)('interface/disconnected'), (0, operators_1.filter)(event => event.interfaceId === this.interfaceId), (0, operators_1.take)(1), (0, operators_1.map)(({ errorMessage, errorType }) => gateway.convertToException(errorType, errorMessage))).subscribe(this._disconnected);
     }
 }