motion-master-client 0.0.245 → 0.0.246

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

@@ -1,17 +1,19 @@
-import { Observable } from "rxjs";
-import { RetryConfig } from "rxjs/operators";
-import { Device } from "./device";
-import { DeviceParameter } from "./device-parameter";
-import { HardwareDescription, StackInfo } from "./hardware-description";
-import { MotionMasterReqResSocket } from "./motion-master-req-res-socket";
-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";
-import { EncoderRegisterCommunicationOsCommandResponse, MotorPhaseOrderDetectionOsCommandResponse, OpenPhaseDetectionOsCommandResponse, OsCommandMode, OsCommandResponse, PhaseResistanceMeasurementOsCommandResponse, PhaseInductanceMeasurementOsCommandResponse, PolePairDetectionOsCommandResponse, CommutationOffsetMeasurementOsCommandResponse, IcMuCalibrationModeOsCommandResponse, OpenLoopFieldModeOsCommandResponse, HrdStreamingOsCommandResponse, TorqueConstantMeasurementOsCommandResponse, SkippedCyclesCounterOsCommandResponse, IgnoreBissStatusBitsOsCommandResponse, SystemIdentificationOsCommandResponse, KublerEncoderCommandOsCommandResponse, UseInternalEncoderVelocityOsCommandResponse, KublerEncoderRegisterCommunicationOsCommandResponse, SmmAcyclicHandlerOsCommandResponse, HrdStreamingOsCommandAction, HrdStreamingOsCommandDataIndex } from "./os-command";
-import { IntegroVariant } from "./integro-variant";
+import { Observable } from 'rxjs';
+import { RetryConfig } from 'rxjs/operators';
+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 { 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';
+import { EncoderRegisterCommunicationOsCommandResponse, MotorPhaseOrderDetectionOsCommandResponse, OpenPhaseDetectionOsCommandResponse, OsCommandMode, OsCommandResponse, PhaseResistanceMeasurementOsCommandResponse, PhaseInductanceMeasurementOsCommandResponse, PolePairDetectionOsCommandResponse, CommutationOffsetMeasurementOsCommandResponse, IcMuCalibrationModeOsCommandResponse, OpenLoopFieldModeOsCommandResponse, HrdStreamingOsCommandResponse, TorqueConstantMeasurementOsCommandResponse, SkippedCyclesCounterOsCommandResponse, IgnoreBissStatusBitsOsCommandResponse, SystemIdentificationOsCommandResponse, KublerEncoderCommandOsCommandResponse, UseInternalEncoderVelocityOsCommandResponse, KublerEncoderRegisterCommunicationOsCommandResponse, SmmAcyclicHandlerOsCommandResponse, HrdStreamingOsCommandAction, HrdStreamingOsCommandDataIndex } from './os-command';
+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.
  *
@@ -860,7 +862,7 @@ export declare class MotionMasterReqResClient {
     /**
      * Get file content.
      */
-    getFile(deviceRef: DeviceRef, name: string, requestTimeout?: number, messageId?: string): Observable<Uint8Array | null | undefined>;
+    getFile(deviceRef: DeviceRef, name: string, requestTimeout?: number, messageId?: string): Observable<Uint8Array | number[] | null | undefined>;
     /**
      * Get decoded file content.
      *
@@ -1143,7 +1145,7 @@ export declare class MotionMasterReqResClient {
     resetKublerEncoderMultiturnPosition(deviceRef: DeviceRef): Observable<KublerEncoderRegisterCommunicationOsCommandResponse>;
     readOsCommandResponse(deviceRef: DeviceRef): Observable<OsCommandResponse>;
     runOsCommandAndWriteFsBuffer<T extends OsCommandResponse>(deviceRef: DeviceRef, command: Uint8Array, content: Uint8Array, commandTimeout?: number, responsePollingInterval?: number, osCommandMode?: boolean | OsCommandMode): Observable<T>;
-    runOsCommandAndReadFsBuffer<T extends OsCommandResponse>(deviceRef: DeviceRef, command: Uint8Array, commandTimeout: 30000, responsePollingInterval?: number, osCommandMode?: boolean | OsCommandMode): Observable<T>;
+    runOsCommandAndReadFsBuffer<T extends OsCommandResponse>(deviceRef: DeviceRef, command: Uint8Array, commandTimeout?: number, responsePollingInterval?: number, osCommandMode?: boolean | OsCommandMode): Observable<T>;
     /**
      * Set halt bit.
      *
@@ -1260,5 +1262,213 @@ export declare class MotionMasterReqResClient {
      * @returns {Promise<void>} Resolves when all PDO parameter updates are complete.
      *                          The function processes and applies updates sequentially to ensure they are performed in order.
      */
-    updatePdoParameterGroupedValues(deviceRef: DeviceRef, pdoGroupedValues: number[][], pdoIndex: 0x1600 | 0x1A00): Promise<void>;
+    updatePdoParameterGroupedValues(deviceRef: DeviceRef, pdoGroupedValues: number[][], pdoIndex: 0x1600 | 0x1a00): Promise<void>;
+    /**
+     * Reads the SMM parameter for a given device.
+     *
+     * @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.
+     *
+     * @returns An observable that emits the response from the command once it is received.
+     */
+    readSmmParameter(deviceRef: DeviceRef, index: number, subindex?: number, commandTimeout?: number, responsePollingInterval?: number): Observable<OsCommandResponse>;
+    /**
+     * Reads the SMM parameter value as a number.
+     *
+     * This method reads a parameter from a device and extracts its value based on the provided `dataViewExtractor`.
+     * The default behavior is to extract a 32-bit integer in little-endian format.
+     *
+     * @param deviceRef - A reference to the device from which the SMM parameter is being read.
+     * @param index - The index of the parameter to read.
+     * @param subindex - The subindex of the parameter (default is 0).
+     * @param dataViewExtractor - A function that extracts a number from the `DataView` (default is `view.getInt32(0, true)`).
+     *
+     * @returns An observable that emits the extracted number value.
+     *
+     * @throws {Error} If the response buffer is empty or invalid.
+     */
+    readSmmParameterNumberValue(deviceRef: DeviceRef, index: number, subindex?: number, dataViewExtractor?: (view: DataView) => number): Observable<number>;
+    /**
+     * Reads the SMM parameter value as a string.
+     *
+     * This method reads a parameter from a device and decodes its value as a UTF-8 string from the response buffer.
+     *
+     * @param deviceRef - A reference to the device from which the SMM parameter is being read.
+     * @param index - The index of the parameter to read.
+     * @param subindex - The subindex of the parameter (default is 0).
+     *
+     * @returns An observable that emits the decoded string value.
+     *
+     * @throws {Error} If the response buffer is empty or invalid.
+     */
+    readSmmParameterStringValue(deviceRef: DeviceRef, index: number, subindex?: number): Observable<string>;
+    /**
+     * Reads the SMM parameter value as an array of numbers.
+     *
+     * This method reads a parameter from a device and returns the values as an array of numbers,
+     * where each element corresponds to a byte from the response buffer.
+     *
+     * @param deviceRef - A reference to the device from which the SMM parameter is being read.
+     * @param index - The index of the parameter to read.
+     * @param subindex - The subindex of the parameter (default is 0).
+     *
+     * @returns An observable that emits an array of numbers, representing the byte values in the response buffer.
+     *
+     * @throws {Error} If the response buffer is empty or invalid.
+     */
+    readSmmParameterArrayValue(deviceRef: DeviceRef, index: number, subindex?: number): Observable<number[]>;
+    /**
+     * Reads the SMM firmware version from a device.
+     *
+     * This method reads the firmware version (MCU Software Version 0x0001:00) of the device as an array of numbers.
+     * The first byte represents the minor version, and the second byte represents the major version.
+     *
+     * @param deviceRef - A reference to the device from which the firmware version is being read.
+     *
+     * @returns An observable that emits an array of numbers, representing the byte values of the firmware version.
+     */
+    readSmmFirmareVersion(deviceRef: DeviceRef): Observable<number[]>;
+    /**
+     * Reads the SMM serial number from a device.
+     *
+     * This method reads the serial number of the device as a string.
+     * The serial number is retrieved from the device using the appropriate SMM parameter (0x0003:00).
+     *
+     * @param deviceRef - A reference to the device from which the serial number is being read.
+     *
+     * @returns An observable that emits the serial number as a string.
+     */
+    readSmmSerialNumber(deviceRef: DeviceRef): Observable<string>;
+    /**
+     * Reads the SMM temperature value from a device.
+     *
+     * This method reads the temperature of the device as a number. The temperature is retrieved from the device
+     * using the appropriate SMM parameter (0x000a:00).
+     *
+     * @param deviceRef - A reference to the device from which the temperature is being read.
+     *
+     * @returns An observable that emits the temperature value as a number.
+     */
+    readSmmTemperature(deviceRef: DeviceRef): Observable<number>;
+    /**
+     * Reads the SMM parameter check value from a device.
+     *
+     * This method reads the parameter check value from the device as a 16-bit unsigned integer. The value represents
+     * the number of parameters available on the SMM and is retrieved from the device using the appropriate SMM parameter (0x000b:00).
+     * and the custom data extraction function.
+     *
+     * @param deviceRef - A reference to the device from which the parameter check value is being read.
+     *
+     * @returns An observable that emits the parameter check value as a 16-bit unsigned integer, which represents
+     *          the number of parameters available on the SMM.
+     */
+    readSmmParameterCheck(deviceRef: DeviceRef): Observable<number>;
+    /**
+     * Reads the SMM maximum position discrepancy value from a device.
+     *
+     * This method reads the maximum position discrepancy value from the device as a 32-bit unsigned integer.
+     * The value is retrieved from the device using the appropriate SMM parameter and the custom data extraction function.
+     *
+     * @param deviceRef - A reference to the device from which the maximum position discrepancy value is being read.
+     *
+     * @returns An observable that emits the maximum position discrepancy value as a 32-bit unsigned integer.
+     */
+    readSmmMaxPositionDiscrepancy(deviceRef: DeviceRef): Observable<number>;
+    /**
+     * Logs into the SMM for parameter download with the provided credentials.
+     *
+     * This function sends a login command to the device using the provided username and password. It returns an observable
+     * that emits `true` if the login is successful and `false` otherwise. If the device is already logged in, the next login
+     * attempt will fail unless the user logs out beforehand.
+     *
+     * @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.
+     *
+     * @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>;
+    /**
+     * Logs into the SMM for software update with the provided credentials.
+     *
+     * This function sends a login command to the device using the provided username and password. It returns an observable
+     * that emits `true` if the login is successful and `false` otherwise. If the device is already logged in, the next login
+     * attempt will fail unless the user logs out beforehand.
+     *
+     * @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.
+     *
+     * @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>;
+    /**
+     * Logs out from the SMM.
+     *
+     * This function sends a logout command to the device and returns an observable that emits `true` if the logout
+     * 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.
+     *
+     * @returns An observable that emits a boolean value indicating whether the logout attempt succeeded.
+     */
+    logoutFromSmm(deviceRef: DeviceRef): Observable<boolean>;
+    /**
+     * Logs out from the SMM and then logs back in with the provided credentials for parameter download.
+     *
+     * This function first sends a logout command to the device, followed by a login command using the provided username
+     * and password. It returns an observable that emits `true` if both the logout and login attempts are successful
+     * and `false` otherwise. The login process is handled through the `loginToSmmForParameterDownload` function.
+     *
+     * @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.
+     *
+     * @returns An observable that emits a boolean value indicating whether the relogin attempt succeeded.
+     */
+    reloginToSmmForParameterDownload(deviceRef: DeviceRef, username: string, password: string): Observable<boolean>;
+    changeSmmPassword(deviceRef: DeviceRef, oldPassword: string, newPassword: string): Observable<boolean>;
+    /**
+     * Triggers a restart for the specified device.
+     *
+     * This method sends a command to the device to trigger an SMM restart and waits for a response.
+     * 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.
+     *
+     * @returns An Observable that emits `true` if the restart was successful, or `false` otherwise.
+     */
+    triggerSmmRestart(deviceRef: DeviceRef, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
+    /**
+     * Acknowledges an I/O failure on the specified device.
+     *
+     * This method sends a command to the device to acknowledge an I/O failure and waits for a response.
+     * 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.
+     *
+     * @returns An Observable that emits `true` if the acknowledgment was successful, or `false` otherwise.
+     */
+    acknowledgeIoFailureOnSmm(deviceRef: DeviceRef, commandTimeout?: number, responsePollingInterval?: number): Observable<boolean>;
+    configureSmmSoftwareUpdate(deviceRef: DeviceRef, fileSize: number): Observable<boolean>;
+    updateSmmSoftware(deviceRef: DeviceRef, username: string, password: string, buffer: Uint8Array, crc: number, chunkSize?: number): Observable<boolean>;
+    transmitSmmParameters(deviceRef: DeviceRef, parameters: Pick<Parameter, 'value'>[], version?: number): Observable<boolean>;
+    loadSmmParametersForVerification(deviceRef: DeviceRef): Observable<OsCommandResponse>;
+    loadSmmParametersForVerificationAndUnpack(deviceRef: DeviceRef): Observable<DataType[]>;
+    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>;
 }