motion-master-client 0.0.253 → 0.0.255

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "motion-master-client",
-  "version": "0.0.253",
+  "version": "0.0.255",
   "type": "commonjs",
   "description": "A library and CLI program used for communicating with Motion Master.",
   "dependencies": {

package/src/lib/motion-master-req-res-client.d.ts

@@ -1513,14 +1513,50 @@ export declare class MotionMasterReqResClient {
      * @returns An Observable that emits `true` if the acknowledgment was successful, or `false` otherwise.
      */
     acknowledgeIoFailureOnSmm(deviceRef: DeviceRef, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
+    /**
+     * Configures the SMM software update process for the specified device.
+     * Prepares the device to receive a software update of the given file size.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param fileSize - The size of the software update file, in bytes.
+     *
+     * @returns An Observable that emits `true` if the configuration succeeds, or `false` if it fails.
+     */
     configureSmmSoftwareUpdate(deviceRef: DeviceRef, fileSize: number): Observable<boolean>;
+    /**
+     * Performs a complete SMM software update on the specified device.
+     * This includes authentication, configuration, data transmission in chunks, CRC validation, and restart.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param username - The username for authentication.
+     * @param password - The password for authentication.
+     * @param buffer - The software update file as a `Uint8Array`.
+     * @param crc - The CRC checksum of the software update file for integrity verification.
+     * @param chunkSize - (Optional) The size of each data chunk in bytes. Defaults to 1000.
+     *
+     * @returns An Observable that emits each step's result sequentially.
+     * The observable completes successfully if all steps succeed, or errors out on the first failure.
+     *
+     * @remarks
+     * The update process consists of:
+     * 1. Logging in to the SMM device for software update.
+     * 2. Configuring the device for the software update with the provided file size.
+     * 3. Transmitting the file in chunks (default chunk size is 1000 bytes).
+     * 4. Sending a CRC checksum for data integrity verification.
+     * 5. Finalizing the software update.
+     * 6. Triggering an SMM restart to apply the update.
+     *
+     * Each step is represented as a deferred observable, ensuring commands are executed only when subscribed.
+     * If any step fails, the update process stops immediately (via `concat` behavior).
+     */
     updateSmmSoftware(deviceRef: DeviceRef, username: string, password: string, buffer: Uint8Array, crc: number, chunkSize?: number): Observable<boolean>;
     /**
      * Transmits SMM parameters to the specified device.
      *
      * @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. If not provided, it will be resolved automatically.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the device.
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
@@ -1528,7 +1564,6 @@ export declare class MotionMasterReqResClient {
      *
      * @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 fs-buffer file.
      */
     transmitSmmParameters(deviceRef: DeviceRef, values: DataType[], parameterStructureVersion?: number | undefined, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
@@ -1558,7 +1593,8 @@ export declare class MotionMasterReqResClient {
      * @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 parameterStructureVersion - The version of the parameter structure. If not provided, it will be resolved automatically.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the 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<boolean>` that emits `true` if the verification succeeded, or `false` otherwise.
@@ -1645,8 +1681,8 @@ export declare class MotionMasterReqResClient {
      * It supports resolving the parameter structure version if not explicitly provided.
      *
      * @param deviceRef - The reference to the target device.
-     * @param parameterStructureVersion - (Optional) The specific version of the parameter structure to use.
-     *                                     If not provided, it resolves the version automatically.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the device.
      *
      * @returns An `Observable` emitting an array of `SmmParameter` objects, each representing a processed
      *          parameter with metadata such as type, access rights, and UI-related configurations.
@@ -1662,8 +1698,8 @@ export declare class MotionMasterReqResClient {
      * of corresponding `SmmParameter` objects belonging to that group.
      *
      * @param deviceRef - The reference to the target device.
-     * @param parameterStructureVersion - (Optional) The specific version of the parameter structure to use.
-     *                                     If not provided, it resolves the version automatically.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the device.
      *
      * @returns An `Observable` emitting a `Map<string, SmmParameter[]>`:
      *          - The keys are group names.
@@ -1677,4 +1713,20 @@ export declare class MotionMasterReqResClient {
      * This ensures consistency between retrieval, packing, and verification stages.
      */
     getSmmOdGroupedParameters(deviceRef: DeviceRef, parameterStructureVersion?: number | undefined): Observable<Map<string, SmmParameter[]>>;
+    /**
+     * Performs a factory reset on the SMM parameters of the specified device.
+     * It restores all safety-related parameters to their default reset values.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the device.
+     *
+     * @returns An Observable that emits `true` if the reset succeeds, or `false` if it fails.
+     *
+     * @remarks
+     * This function first determines the SMM parameter structure version — either from the provided argument
+     * or by resolving it from the device. It then extracts the reset values from the safety parameters
+     * and transmits them to the device.
+     */
+    factoryResetSmm(deviceRef: DeviceRef, parameterStructureVersion?: number | undefined): Observable<boolean>;
 }

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

@@ -2830,10 +2830,45 @@ class MotionMasterReqResClient {
         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'));
     }
+    /**
+     * Configures the SMM software update process for the specified device.
+     * Prepares the device to receive a software update of the given file size.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param fileSize - The size of the software update file, in bytes.
+     *
+     * @returns An Observable that emits `true` if the configuration succeeds, or `false` if it fails.
+     */
     configureSmmSoftwareUpdate(deviceRef, fileSize) {
         const command = (0, os_command_1.createSmmAcyclicHandlerConfigureSoftwareUpdateOsCommand)(fileSize);
         return this.runOsCommand(deviceRef, command, 10000, 100).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
     }
+    /**
+     * Performs a complete SMM software update on the specified device.
+     * This includes authentication, configuration, data transmission in chunks, CRC validation, and restart.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param username - The username for authentication.
+     * @param password - The password for authentication.
+     * @param buffer - The software update file as a `Uint8Array`.
+     * @param crc - The CRC checksum of the software update file for integrity verification.
+     * @param chunkSize - (Optional) The size of each data chunk in bytes. Defaults to 1000.
+     *
+     * @returns An Observable that emits each step's result sequentially.
+     * The observable completes successfully if all steps succeed, or errors out on the first failure.
+     *
+     * @remarks
+     * The update process consists of:
+     * 1. Logging in to the SMM device for software update.
+     * 2. Configuring the device for the software update with the provided file size.
+     * 3. Transmitting the file in chunks (default chunk size is 1000 bytes).
+     * 4. Sending a CRC checksum for data integrity verification.
+     * 5. Finalizing the software update.
+     * 6. Triggering an SMM restart to apply the update.
+     *
+     * Each step is represented as a deferred observable, ensuring commands are executed only when subscribed.
+     * If any step fails, the update process stops immediately (via `concat` behavior).
+     */
     updateSmmSoftware(deviceRef, username, password, buffer, crc, chunkSize = 1000) {
         const fileSize = buffer.byteLength;
         const observables = [
@@ -2858,7 +2893,8 @@ 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. If not provided, it will be resolved automatically.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the device.
      * @param commandTimeout - The timeout in milliseconds for the command to complete.
      * @param responsePollingInterval - The interval in milliseconds between polling for the response.
      *
@@ -2866,7 +2902,6 @@ class MotionMasterReqResClient {
      *
      * @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 fs-buffer file.
      */
     transmitSmmParameters(deviceRef, values, parameterStructureVersion = undefined, commandTimeout = 5000, responsePollingInterval = 500) {
@@ -2875,7 +2910,6 @@ class MotionMasterReqResClient {
         }
         return (parameterStructureVersion ? (0, rxjs_1.of)(parameterStructureVersion) : this.resolveSmmParameterStructureVersion(deviceRef)).pipe((0, operators_1.mergeMap)((version) => {
             const command = (0, os_command_1.createSmmAcyclicHandlerOsCommand)(os_command_1.SmmAcyclicHandlerSubcommandId.TRANSMIT_PARAMETERS);
-            values.unshift(version);
             const { buffer: content } = (0, smm_1.packSmmParameterValues)(values, version);
             return this.runOsCommandAndWriteFsBuffer(deviceRef, command, content, commandTimeout, responsePollingInterval).pipe((0, operators_1.last)(), (0, operators_1.map)((response) => response.request === 'succeeded'));
         }));
@@ -2909,7 +2943,8 @@ class MotionMasterReqResClient {
      * @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 parameterStructureVersion - The version of the parameter structure. If not provided, it will be resolved automatically.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the 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<boolean>` that emits `true` if the verification succeeded, or `false` otherwise.
@@ -3024,8 +3059,8 @@ class MotionMasterReqResClient {
      * It supports resolving the parameter structure version if not explicitly provided.
      *
      * @param deviceRef - The reference to the target device.
-     * @param parameterStructureVersion - (Optional) The specific version of the parameter structure to use.
-     *                                     If not provided, it resolves the version automatically.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the device.
      *
      * @returns An `Observable` emitting an array of `SmmParameter` objects, each representing a processed
      *          parameter with metadata such as type, access rights, and UI-related configurations.
@@ -3110,8 +3145,8 @@ class MotionMasterReqResClient {
      * of corresponding `SmmParameter` objects belonging to that group.
      *
      * @param deviceRef - The reference to the target device.
-     * @param parameterStructureVersion - (Optional) The specific version of the parameter structure to use.
-     *                                     If not provided, it resolves the version automatically.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the device.
      *
      * @returns An `Observable` emitting a `Map<string, SmmParameter[]>`:
      *          - The keys are group names.
@@ -3127,6 +3162,28 @@ class MotionMasterReqResClient {
     getSmmOdGroupedParameters(deviceRef, parameterStructureVersion = undefined) {
         return this.getSmmOdParameters(deviceRef, parameterStructureVersion).pipe((0, operators_1.map)((parameters) => (0, util_1.mapByProperty)(parameters, 'group')));
     }
+    /**
+     * Performs a factory reset on the SMM parameters of the specified device.
+     * It restores all safety-related parameters to their default reset values.
+     *
+     * @param deviceRef - A reference to the target device.
+     * @param parameterStructureVersion - (Optional) A specific SMM parameter structure version to use.
+     * If not provided, the version is resolved dynamically from the device.
+     *
+     * @returns An Observable that emits `true` if the reset succeeds, or `false` if it fails.
+     *
+     * @remarks
+     * This function first determines the SMM parameter structure version — either from the provided argument
+     * or by resolving it from the device. It then extracts the reset values from the safety parameters
+     * and transmits them to the device.
+     */
+    factoryResetSmm(deviceRef, parameterStructureVersion = undefined) {
+        return (parameterStructureVersion ? (0, rxjs_1.of)(parameterStructureVersion) : this.resolveSmmParameterStructureVersion(deviceRef)).pipe((0, operators_1.mergeMap)((version) => {
+            const smmOd = (0, smm_1.resolveSmmOd)(version);
+            const values = smmOd.parameters.safety.map((p) => p.resetValue);
+            return this.transmitSmmParameters(deviceRef, values, version);
+        }));
+    }
 }
 exports.MotionMasterReqResClient = MotionMasterReqResClient;
 //# sourceMappingURL=motion-master-req-res-client.js.map