motion-master-client 0.0.247 → 0.0.248

package/src/lib/motion-master-req-res-client.js

@@ -2057,7 +2057,7 @@ class MotionMasterReqResClient {
      * @param deviceRef The reference to the device on which the command will be executed.
      * @param command The command to be executed, represented as a Uint8Array.
      * @param commandTimeout The maximum time allowed for the command to complete.
-     * @param responsePollingInterval The interval (in milliseconds) for polling the command response. Defaults to 1000ms.
+     * @param responsePollingInterval The interval (in milliseconds) for polling the command response.
      * @param osCommandMode Specifies whether the next OS command should run immediately after the current one or abort the current command. Sets the OS Command Mode. Defaults to false.
      * @param fsBufferContent If true, the content of the fs-buffer will be read and assigned to the `fsBuffer` property of {@link OsCommandResponse}. If a Uint8Array is provided, the content will be written to the fs-buffer file. If undefined, only the OS command will be executed, and its response will be read and parsed.
      * @returns An observable of type T, which extends {@link OsCommandResponse}, representing the result of the command execution.
@@ -2512,12 +2512,12 @@ class MotionMasterReqResClient {
      * @param deviceRef - The reference to the device to which the command will be sent.
      * @param index - The index of the SMM parameter to read.
      * @param subindex - The subindex of the SMM parameter to read. Defaults to 0.
-     * @param commandTimeout - The timeout for the command in milliseconds. Defaults to 10,000 ms (10 seconds).
-     * @param responsePollingInterval - The interval between polling attempts for a response in milliseconds. Defaults to 100 ms.
+     * @param commandTimeout - The timeout for the command in milliseconds.
+     * @param responsePollingInterval - The interval between polling attempts for a response in milliseconds.
      *
      * @returns An observable that emits the response from the command once it is received.
      */
-    readSmmParameter(deviceRef, index, subindex = 0, commandTimeout = 10000, responsePollingInterval = 100) {
+    readSmmParameter(deviceRef, index, subindex = 0, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerReadSmmParameterOsCommand)(index, subindex);
         return this.runOsCommandAndReadFsBuffer(deviceRef, command, commandTimeout, responsePollingInterval, os_command_1.OsCommandMode.EXECUTE_THE_NEXT_COMMAND_IMMEDIATELY);
     }
@@ -2614,7 +2614,7 @@ class MotionMasterReqResClient {
      * @returns An `Observable<number>` emitting the firmware version, represented as an integer.
      */
     readSmmFirmareVersionAsNumber(deviceRef) {
-        return this.readSmmParameterArrayValue(deviceRef, 0x0001, 0).pipe((0, operators_1.map)((bytes) => (bytes[1] << 8) | bytes[0]));
+        return this.readSmmFirmareVersion(deviceRef).pipe((0, operators_1.map)((bytes) => (bytes[1] << 8) | bytes[0]));
     }
     /**
      * Resolves the SMM parameter structure version for the specified device based on its firmware version.
@@ -2705,16 +2705,18 @@ class MotionMasterReqResClient {
      * @param deviceRef - The reference to the device to which the login command will be sent.
      * @param username - The optional username used for logging in to the SMM. If not provided, it will be treated as an empty string.
      * @param password - The password used for logging in to the SMM.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
      * @returns An observable that emits a boolean value indicating whether the login attempt succeeded.
      *
      * @remarks
      * If the device is already logged in, the next login attempt will fail unless the user logs out first.
      */
-    loginToSmmForParameterDownload(deviceRef, username, password) {
+    loginToSmmForParameterDownload(deviceRef, username, password, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.PARAMETER_DOWNLOAD_LOGIN);
         const content = (0, smm_1.packSmmCredentials)(username, password);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
     }
     /**
      * Logs into the SMM for software update with the provided credentials.
@@ -2726,16 +2728,18 @@ class MotionMasterReqResClient {
      * @param deviceRef - The reference to the device to which the login command will be sent.
      * @param username - The optional username used for logging in to the SMM. If not provided, it will be treated as an empty string.
      * @param password - The password used for logging in to the SMM.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
      * @returns An observable that emits a boolean value indicating whether the login attempt succeeded.
      *
      * @remarks
      * If the device is already logged in, the next login attempt will fail unless the user logs out first.
      */
-    loginToSmmForSoftwareUpdate(deviceRef, username, password) {
+    loginToSmmForSoftwareUpdate(deviceRef, username, password, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.SOFTWARE_UPDATE_LOGIN);
         const content = (0, smm_1.packSmmCredentials)(username, password);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
     }
     /**
      * Logs out from the SMM.
@@ -2744,12 +2748,14 @@ class MotionMasterReqResClient {
      * is successful and `false` otherwise. The command times out after 10 seconds if no response is received.
      *
      * @param deviceRef - The reference to the device to which the logout command will be sent.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
      * @returns An observable that emits a boolean value indicating whether the logout attempt succeeded.
      */
-    logoutFromSmm(deviceRef) {
+    logoutFromSmm(deviceRef, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.LOGOUT);
-        return this.runOsCommand(deviceRef, command, 10000, 100).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
     }
     /**
      * Logs out from the SMM and then logs back in with the provided credentials for parameter download.
@@ -2761,11 +2767,15 @@ class MotionMasterReqResClient {
      * @param deviceRef - The reference to the device to which the logout and login commands will be sent.
      * @param username - The username used for logging in to the SMM.
      * @param password - The password used for logging in to the SMM.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
      * @returns An observable that emits a boolean value indicating whether the relogin attempt succeeded.
      */
-    reloginToSmmForParameterDownload(deviceRef, username, password) {
-        return this.logoutFromSmm(deviceRef).pipe((0, operators_1.mergeMap)((succeeded) => succeeded ? this.loginToSmmForParameterDownload(deviceRef, username, password) : (0, rxjs_1.of)(false)));
+    reloginToSmmForParameterDownload(deviceRef, username, password, commandTimeout = 5000, responsePollingInterval = 500) {
+        return this.logoutFromSmm(deviceRef, commandTimeout, responsePollingInterval).pipe((0, operators_1.mergeMap)((succeeded) => succeeded
+            ? this.loginToSmmForParameterDownload(deviceRef, username, password, commandTimeout, responsePollingInterval)
+            : (0, rxjs_1.of)(false)));
     }
     /**
      * Changes the SMM password for the specified device.
@@ -2773,6 +2783,8 @@ class MotionMasterReqResClient {
      * @param deviceRef - A reference to the target device.
      * @param oldPassword - The current SMM password.
      * @param newPassword - The new password to set for the SMM.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      * @returns An Observable that emits `true` if the password change and SMM restart succeed, otherwise `false`.
      *
      * @remarks
@@ -2781,10 +2793,10 @@ class MotionMasterReqResClient {
      *
      * This function sends an acyclic command to update the password. If successful, it triggers an SMM restart.
      */
-    changeSmmPassword(deviceRef, oldPassword, newPassword) {
+    changeSmmPassword(deviceRef, oldPassword, newPassword, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.CHANGE_PASSWORD);
         const content = (0, smm_1.packSmmChangePassword)(newPassword, oldPassword);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'), (0, operators_1.mergeMap)((succeeded) => (succeeded ? this.triggerSmmRestart(deviceRef) : (0, rxjs_1.of)(false))));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'), (0, operators_1.mergeMap)((succeeded) => (succeeded ? this.triggerSmmRestart(deviceRef) : (0, rxjs_1.of)(false))));
     }
     /**
      * Triggers a restart for the specified device.
@@ -2793,12 +2805,12 @@ class MotionMasterReqResClient {
      * The method will return `true` if the restart was successful, otherwise `false`.
      *
      * @param deviceRef - The reference to the device to restart.
-     * @param commandTimeout - The timeout in milliseconds for the command to complete. Default is 10000ms (10 seconds).
-     * @param responsePollingInterval - The interval in milliseconds between polling for the response. Default is 100ms.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
      * @returns An Observable that emits `true` if the restart was successful, or `false` otherwise.
      */
-    triggerSmmRestart(deviceRef, commandTimeout = 10000, responsePollingInterval = 100) {
+    triggerSmmRestart(deviceRef, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.TRIGGER_RESTART);
         return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
     }
@@ -2809,12 +2821,12 @@ class MotionMasterReqResClient {
      * The method will return `true` if the acknowledgment was successful, otherwise `false`.
      *
      * @param deviceRef - The reference to the device to acknowledge the I/O failure on.
-     * @param commandTimeout - The timeout in milliseconds for the command to complete. Default is 10000ms (10 seconds).
-     * @param responsePollingInterval - The interval in milliseconds between polling for the response. Default is 100ms.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
      * @returns An Observable that emits `true` if the acknowledgment was successful, or `false` otherwise.
      */
-    acknowledgeIoFailureOnSmm(deviceRef, commandTimeout = 10000, responsePollingInterval = 100) {
+    acknowledgeIoFailureOnSmm(deviceRef, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.IO_FAILURE_ACKNOWLEDGE);
         return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
     }
@@ -2847,15 +2859,17 @@ class MotionMasterReqResClient {
      * @param deviceRef - The reference to the target device.
      * @param values - An array of data values to transmit.
      * @param parameterStructureVersion - The version of the parameter structure (default: 0x0041).
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
      * @returns An Observable that emits `true` if the operation succeeds, or `false` if it fails, the `values` array is empty.
      *
      * @remarks
      * - If the `values` array is empty, the function immediately returns `false`.
      * - The `version` is prepended to the values array before packing.
-     * - The function constructs an OS command for transmitting the parameters and writes the packed buffer to the file system.
+     * - The function constructs an OS command for transmitting the parameters and writes the packed buffer to the fs-buffer file.
      */
-    transmitSmmParameters(deviceRef, values, parameterStructureVersion = 0x0041) {
+    transmitSmmParameters(deviceRef, values, parameterStructureVersion = 0x0041, commandTimeout = 5000, responsePollingInterval = 500) {
         if (values.length === 0) {
             return (0, rxjs_1.of)(false);
         }
@@ -2863,7 +2877,7 @@ class MotionMasterReqResClient {
         values.unshift(parameterStructureVersion);
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.TRANSMIT_PARAMETERS);
         const { buffer: content } = (0, smm_1.packSmmParameterValues)(values);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
     }
     /**
      * Loads the SMM parameters for verification on the specified device.
@@ -2873,29 +2887,130 @@ class MotionMasterReqResClient {
      * into valid parameter values, which are then returned in sequence within the OS command response.
      *
      * @param deviceRef - The reference to the device from which the parameters should be loaded.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      * @returns An Observable that emits the response from the device, containing the valid parameter values for verification
      *          after the buffer is processed and reconstructed.
      *
      * @throws Will throw an error if the command fails or times out.
      */
-    loadSmmParametersForVerification(deviceRef) {
+    loadSmmParametersForVerification(deviceRef, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.LOAD_PARAMETERS_FOR_VERIFICATION);
-        return this.runOsCommandAndReadFsBuffer(deviceRef, command, 10000, 1000);
+        return this.runOsCommandAndReadFsBuffer(deviceRef, command, commandTimeout, responsePollingInterval);
     }
-    verifySmmParameters(deviceRef, parameters, groupOrdinal) {
-        const values = parameters.map((p) => p.value);
-        const { buffer: content } = (0, smm_1.calcSmmBitmask)(values, groupOrdinal);
+    /**
+     * Verifies a group of SMM parameters for the specified device.
+     *
+     * This function calculates a bitmask from the provided values and group ordinal,
+     * then sends an SMM OS command (subcommand VERIFY_PARAMETERS) along with the bitmask content
+     * via `fs-buffer` to the device for verification.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param values - An array of parameter values to verify.
+     * @param groupIndex - The verification group index used for bitmask calculation.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
+     * @returns An `Observable<boolean>` that emits `true` if the verification succeeded, or `false` otherwise.
+     *
+     * @remarks
+     * This function requires parameters to be previously loaded for verification to succeed. If parameters are not preloaded, the verification will fail.
+     * The same group can be verified multiple times without causing an error.
+     */
+    verifySmmParameters(deviceRef, values, groupIndex, commandTimeout = 5000, responsePollingInterval = 500) {
+        const { buffer: content } = (0, smm_1.packSmmParameterValuesForVerification)(values, groupIndex);
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.VERIFY_PARAMETERS);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
     }
-    loadSmmValidationFile(deviceRef) {
+    /**
+     * Loads the SMM validation file on the specified device.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
+     * @returns An Observable emitting the OS command response.
+     *
+     * @remarks
+     * This function should only be called **after all parameter groups have been successfully verified**.
+     */
+    loadSmmValidationFile(deviceRef, commandTimeout = 5000, responsePollingInterval = 500) {
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.LOAD_VALIDATION_FILE);
-        return this.runOsCommand(deviceRef, command, 5000, 100);
+        return this.runOsCommand(deviceRef, command, commandTimeout, responsePollingInterval);
+    }
+    /**
+     * Loads the SMM validation file and then retrieves the safety parameters report file.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
+     * @returns An Observable emitting the decoded content of the `.safety_parameters_report` file.
+     *
+     * @throws An error if loading the validation file fails.
+     *
+     * @remarks
+     * This function should only be called **after all parameter groups have been successfully verified**.
+     */
+    loadSmmValidationFileAndReadSafetyParametersReportFile(deviceRef, commandTimeout = 5000, responsePollingInterval = 500) {
+        return this.loadSmmValidationFile(deviceRef, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.mergeMap)((response) => {
+            if (response.request !== 'succeeded') {
+                throw new Error('Failed to load the validation file.');
+            }
+            return this.getDecodedFile(deviceRef, '.safety_parameters_report');
+        }));
     }
-    validateSmmConfiguration(deviceRef, report, date, username, password) {
+    /**
+     * Validates the SMM configuration on the specified device.
+     *
+     * @param deviceRef - The reference to the target device.
+     * @param report - A `Uint8Array` representing the validation report data.
+     * @param date - The date associated with the validation.
+     * @param username - The username used for authentication.
+     * @param password - The password used for authentication.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
+     *
+     * @returns An Observable that emits `true` if the configuration validation succeeds, or `false` if it fails.
+     *
+     * @remarks
+     * - Packs the validation report, date, username, and password into a buffer.
+     * - Constructs an OS command using the `VALIDATE_CONFIGURATION` subcommand.
+     * - Sends the command to the device and writes the packed buffer to the fs-buffer file.
+     * - **Important:** Once the configuration is successfully validated, subsequent calls to this function will fail. To revalidate, the user must go through the verification process again.
+     */
+    validateSmmConfiguration(deviceRef, report, date, username, password, commandTimeout = 5000, responsePollingInterval = 500) {
         const { buffer: content } = (0, smm_1.packSmmValidationReport)(report, date, username, password);
         const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.VALIDATE_CONFIGURATION);
-        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+        return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
+    }
+    /**
+     * Reads the safety parameters report from the device and validates the SMM configuration.
+     *
+     * @param deviceRef - The reference to the target device.
+     * @param date - The date associated with the validation.
+     * @param username - The username used for authentication.
+     * @param password - The password used for authentication.
+     * @param commandTimeout - The timeout in milliseconds for the command to complete.
+     * @param responsePollingInterval - The interval in milliseconds between polling for the response.
+     *
+     * @returns An Observable that emits `true` if the SMM configuration is successfully validated, or `false` if validation fails.
+     *
+     * @throws An error if the `.safety_parameters_report` file is missing.
+     *
+     * @remarks
+     * - The function attempts to retrieve the `.safety_parameters_report` file from the device.
+     * - If the file is missing, an error is thrown.
+     * - The file content is read into a `Uint8Array` and passed to `validateSmmConfiguration`.
+     * - The SMM configuration validation follows the same behavior as `validateSmmConfiguration`:
+     *   - If validation succeeds, subsequent calls to this function will fail.
+     *   - To revalidate, the user must repeat the verification process.
+     */
+    readSafetyParametersReportAndValidateSmmConfiguration(deviceRef, date, username, password, commandTimeout = 5000, responsePollingInterval = 500) {
+        return this.getFile(deviceRef, '.safety_parameters_report').pipe((0, operators_1.last)(), (0, operators_1.mergeMap)((file) => {
+            if (!file) {
+                throw new Error("The '.safety_parameters_report' file is missing.");
+            }
+            const report = new Uint8Array(file);
+            return this.validateSmmConfiguration(deviceRef, report, date, username, password, commandTimeout, responsePollingInterval);
+        }));
     }
 }
 exports.MotionMasterReqResClient = MotionMasterReqResClient;