motion-master-client 0.0.247 → 0.0.248

package/package.json

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

package/src/index.d.ts

@@ -36,6 +36,8 @@ export * from './lib/parameter';
 export * from './lib/product';
 export * from './lib/request-status-resolver';
 export * from './lib/sii';
+export * from './lib/smm-od';
+export * from './lib/smm';
 export * from './lib/system-log-line';
 export * from './lib/types';
 export * from './lib/units';

package/src/index.js

@@ -39,6 +39,8 @@ tslib_1.__exportStar(require("./lib/parameter"), exports);
 tslib_1.__exportStar(require("./lib/product"), exports);
 tslib_1.__exportStar(require("./lib/request-status-resolver"), exports);
 tslib_1.__exportStar(require("./lib/sii"), exports);
+tslib_1.__exportStar(require("./lib/smm-od"), exports);
+tslib_1.__exportStar(require("./lib/smm"), exports);
 tslib_1.__exportStar(require("./lib/system-log-line"), exports);
 tslib_1.__exportStar(require("./lib/types"), exports);
 tslib_1.__exportStar(require("./lib/units"), exports);

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/motion-master-client/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,4DAAkC;AAClC,gEAAsC;AACtC,uDAA6B;AAC7B,iEAAuC;AACvC,gEAAsC;AACtC,wDAA8B;AAC9B,yDAA+B;AAC/B,yDAA+B;AAC/B,sDAA4B;AAC5B,yDAA+B;AAC/B,qEAA2C;AAC3C,uDAA6B;AAC7B,4EAAkD;AAClD,gEAAsC;AACtC,0DAAgC;AAChC,uDAA6B;AAC7B,kEAAwC;AACxC,iEAAuC;AACvC,gEAAsC;AACtC,qEAA2C;AAC3C,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,qEAA2C;AAC3C,uDAA6B;AAC7B,0DAAgC;AAChC,wDAA8B;AAC9B,2DAAiC;AACjC,0DAAgC;AAChC,wDAA8B;AAC9B,wEAA8C;AAC9C,oDAA0B;AAC1B,gEAAsC;AACtC,sDAA4B;AAC5B,sDAA4B;AAC5B,8DAAoC;AACpC,qDAA2B;AAC3B,kFAAwD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/motion-master-client/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,4DAAkC;AAClC,gEAAsC;AACtC,uDAA6B;AAC7B,iEAAuC;AACvC,gEAAsC;AACtC,wDAA8B;AAC9B,yDAA+B;AAC/B,yDAA+B;AAC/B,sDAA4B;AAC5B,yDAA+B;AAC/B,qEAA2C;AAC3C,uDAA6B;AAC7B,4EAAkD;AAClD,gEAAsC;AACtC,0DAAgC;AAChC,uDAA6B;AAC7B,kEAAwC;AACxC,iEAAuC;AACvC,gEAAsC;AACtC,qEAA2C;AAC3C,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,qEAA2C;AAC3C,uDAA6B;AAC7B,0DAAgC;AAChC,wDAA8B;AAC9B,2DAAiC;AACjC,0DAAgC;AAChC,wDAA8B;AAC9B,wEAA8C;AAC9C,oDAA0B;AAC1B,uDAA6B;AAC7B,oDAA0B;AAC1B,gEAAsC;AACtC,sDAA4B;AAC5B,sDAA4B;AAC5B,8DAAoC;AACpC,qDAA2B;AAC3B,kFAAwD"}

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

@@ -4,7 +4,7 @@ import { Device } from './device';
 import { DeviceParameter } from './device-parameter';
 import { HardwareDescription, StackInfo } from './hardware-description';
 import { MotionMasterReqResSocket } from './motion-master-req-res-socket';
-import { Parameter, UIFeaturesConfig } from './parameter';
+import { UIFeaturesConfig } from './parameter';
 import { SystemLogLine } from './system-log-line';
 import { MotionMasterMessage, ParameterValueType, ParameterTypeValue, DeviceParameterValuesStatus, ParameterTypeValueKey, DeviceRefObj, DeviceRef, FullAutoTuningStatus, SystemVersionStatus, DeviceInfoStatus, DeviceParameterInfoStatus, GetDeviceParameterInfoRequest, GetDeviceParameterValuesRequest, GetMultiDeviceParameterValuesRequest, MultiDeviceParameterValuesStatus, SetDeviceParameterValuesRequest, SetMultiDeviceParameterValuesRequest, GetDeviceFileListRequest, DeviceFileListStatus, GetDeviceFileRequest, DeviceFileStatus, SetDeviceFileRequest, DeleteDeviceFileRequest, ResetDeviceFaultRequest, DeviceFaultResetStatus, StopDeviceRequest, DeviceStopStatus, StartDeviceFirmwareInstallationRequest, DeviceFirmwareInstallationStatus, GetDeviceLogRequest, DeviceLogStatus, StartCoggingTorqueRecordingRequest, CoggingTorqueRecordingStatus, GetCoggingTorqueDataRequest, CoggingTorqueDataStatus, StartOffsetDetectionRequest, OffsetDetectionStatus, StartPlantModelIdentificationRequest, PlantIdentificationStatus, ComputeAutoTuningGainsRequest, AutoTuningStatus, SetMotionControllerParametersRequest, MotionControllerStatus, EnableMotionControllerRequest, SetSignalGeneratorParametersRequest, SignalGeneratorStatus, StopSignalGeneratorRequest, StartMonitoringDeviceParameterValuesRequest, MonitoringParameterValuesStatus, StopMonitoringDeviceParameterValuesRequest, GetEthercatNetworkStateRequest, EthercatNetworkStateStatus, SetEthercatNetworkStateRequest, StartNarrowAngleCalibrationRequest, NarrowAngleCalibrationStatus, SetSystemClientTimeoutRequest, StartSystemIdentificationRequest, SystemIdentificationStatus, CirculoEncoderMagnetDistanceStatus, StartCirculoEncoderNarrowAngleCalibrationProcedureRequest, CirculoEncoderNarrowAngleCalibrationProcedureStatus, GetDeviceCiA402StateRequest, DeviceCiA402StateStatus, SetDeviceCiA402StateRequest, SystemLogStatus, StartDeviceSiiRestoreRequest, DeviceSiiRestoreStatus, StartOpenLoopFieldControlRequest, OpenLoopFieldControlStatus, ComputeFullAutoTuningGainsRequest, StartFullAutoTuningRequest, StopFullAutoTuningRequest, StartCirculoEncoderConfigurationRequest, CirculoEncoderConfigurationStatus, StopCirculoEncoderNarrowAngleCalibrationProcedureRequest, StartOsCommandRequest, OsCommandStatus, RestoreDefaultParametersType, DeviceParameterAddressValue, DeviceParameterIds, DeviceParameterInfo, RequestStatusMessage } from './types';
 import { Cia402State, ModesOfOperation } from './cia402';
@@ -12,7 +12,6 @@ import { EncoderRegisterCommunicationOsCommandResponse, MotorPhaseOrderDetection
 import { IntegroVariant } from './integro-variant';
 import { ConfigParameter } from './config-file';
 import { MotionMasterClientIndexedDB } from './mmcidb';
-import { SmmVerificationGroupOrdinal } from './smm';
 import { DataType } from 'python-struct';
 /**
  * This class contains methods for making requests to Motion Master using the injected request/response socket.
@@ -1110,7 +1109,7 @@ export declare 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.
@@ -1269,8 +1268,8 @@ export declare 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.
      */
@@ -1413,13 +1412,15 @@ export declare 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: DeviceRef, username: string, password: string): Observable<boolean>;
+    loginToSmmForParameterDownload(deviceRef: DeviceRef, username: string, password: string, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
     /**
      * Logs into the SMM for software update with the provided credentials.
      *
@@ -1430,13 +1431,15 @@ export declare 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: DeviceRef, username: string, password: string): Observable<boolean>;
+    loginToSmmForSoftwareUpdate(deviceRef: DeviceRef, username: string, password: string, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
     /**
      * Logs out from the SMM.
      *
@@ -1444,10 +1447,12 @@ export declare 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: DeviceRef): Observable<boolean>;
+    logoutFromSmm(deviceRef: DeviceRef, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
     /**
      * Logs out from the SMM and then logs back in with the provided credentials for parameter download.
      *
@@ -1458,16 +1463,20 @@ export declare 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: DeviceRef, username: string, password: string): Observable<boolean>;
+    reloginToSmmForParameterDownload(deviceRef: DeviceRef, username: string, password: string, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
     /**
      * Changes the SMM password for the specified device.
      *
      * @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
@@ -1476,7 +1485,7 @@ export declare class MotionMasterReqResClient {
      *
      * This function sends an acyclic command to update the password. If successful, it triggers an SMM restart.
      */
-    changeSmmPassword(deviceRef: DeviceRef, oldPassword: string, newPassword: string): Observable<boolean>;
+    changeSmmPassword(deviceRef: DeviceRef, oldPassword: string, newPassword: string, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
     /**
      * Triggers a restart for the specified device.
      *
@@ -1484,8 +1493,8 @@ export declare 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.
      */
@@ -1497,8 +1506,8 @@ export declare 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.
      */
@@ -1511,15 +1520,17 @@ export declare 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: DeviceRef, values: DataType[], parameterStructureVersion?: number): Observable<boolean>;
+    transmitSmmParameters(deviceRef: DeviceRef, values: DataType[], parameterStructureVersion?: number, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
     /**
      * Loads the SMM parameters for verification on the specified device.
      *
@@ -1528,13 +1539,100 @@ export declare 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: DeviceRef): Observable<SmmAcyclicHandlerLoadParametersForVerificationOsCommandResponse>;
-    verifySmmParameters(deviceRef: DeviceRef, parameters: Pick<Parameter, 'value'>[], groupOrdinal: SmmVerificationGroupOrdinal): Observable<boolean>;
-    loadSmmValidationFile(deviceRef: DeviceRef): Observable<OsCommandResponse>;
-    validateSmmConfiguration(deviceRef: DeviceRef, report: Uint8Array, date: Date, username: string, password: string): Observable<boolean>;
+    loadSmmParametersForVerification(deviceRef: DeviceRef, commandTimeout?: number, responsePollingInterval?: number): Observable<SmmAcyclicHandlerLoadParametersForVerificationOsCommandResponse>;
+    /**
+     * 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: DeviceRef, values: DataType[], groupIndex: number, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
+    /**
+     * 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: DeviceRef, commandTimeout?: number, responsePollingInterval?: number): Observable<OsCommandResponse>;
+    /**
+     * 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: DeviceRef, commandTimeout?: number, responsePollingInterval?: number): Observable<string>;
+    /**
+     * 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: DeviceRef, report: Uint8Array, date: Date, username: string, password: string, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
+    /**
+     * 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: DeviceRef, date: Date, username: string, password: string, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
 }