motion-master-client 0.0.378 → 0.0.379

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/package.json +1 -1
  2. package/src/api.js +15 -3
  3. package/src/api.js.map +1 -1
  4. package/src/lib/motion-master-client.d.ts +58 -18
  5. package/src/lib/motion-master-client.js +70 -18
  6. package/src/lib/motion-master-client.js.map +1 -1
  7. package/src/lib/motion-master-req-res-client.d.ts +17 -0
  8. package/src/lib/motion-master-req-res-client.js +41 -33
  9. package/src/lib/motion-master-req-res-client.js.map +1 -1
  10. package/src/lib/types.d.ts +27 -15
package/src/lib/types.d.ts CHANGED
@@ -184,14 +184,18 @@ export interface TorqueProfileConfig {
184
184
  */
185
185
  target: number;
186
186
  /**
187
- * Delay, in milliseconds, before initiating a quick stop after the profile reaches the target.
188
- * Note: This property is effective only if the targetReachTimeout is set.
187
+ * Delay, in milliseconds, to hold at the target before issuing a quick stop.
188
+ * Only effective when targetReachTimeout is set.
189
189
  */
190
190
  holdingDuration?: number;
191
191
  /**
192
- * Indicates whether to skip the quick stop request after reaching the target and the holding duration has passed.
193
- * If true, the device remains in the Operation Enabled CiA402 state without requesting a quick stop.
194
- * Note: This property is effective only if the targetReachTimeout is set.
192
+ * Controls whether a quick stop is issued after the target is reached.
193
+ *
194
+ * - false (default): issues a quick stop after the target is reached and holdingDuration elapses.
195
+ * Requires targetReachTimeout to be set, otherwise an error is thrown.
196
+ * - true: the device remains in the Operation Enabled state; no quick stop is issued.
197
+ * If targetReachTimeout is also set, the function still waits for the target reached bit
198
+ * before returning, but does not stop the drive.
195
199
  */
196
200
  skipQuickStop?: boolean;
197
201
  /**
@@ -229,14 +233,18 @@ export interface VelocityProfileConfig {
229
233
  */
230
234
  deceleration: number;
231
235
  /**
232
- * Delay, in milliseconds, before initiating a quick stop after the profile reaches the target.
233
- * Note: This property is effective only if the targetReachTimeout is set.
236
+ * Delay, in milliseconds, to hold at the target before issuing a quick stop.
237
+ * Only effective when targetReachTimeout is set.
234
238
  */
235
239
  holdingDuration?: number;
236
240
  /**
237
- * Indicates whether to skip the quick stop request after reaching the target and the holding duration has passed.
238
- * If true, the device remains in the Operation Enabled CiA402 state without requesting a quick stop.
239
- * Note: This property is effective only if the targetReachTimeout is set.
241
+ * Controls whether a quick stop is issued after the target is reached.
242
+ *
243
+ * - false (default): issues a quick stop after the target is reached and holdingDuration elapses.
244
+ * Requires targetReachTimeout to be set, otherwise an error is thrown.
245
+ * - true: the device remains in the Operation Enabled state; no quick stop is issued.
246
+ * If targetReachTimeout is also set, the function still waits for the target reached bit
247
+ * before returning, but does not stop the drive.
240
248
  */
241
249
  skipQuickStop?: boolean;
242
250
  /**
@@ -270,8 +278,8 @@ export interface PositionProfileConfig {
270
278
  */
271
279
  deceleration: number;
272
280
  /**
273
- * Delay, in milliseconds, before initiating a quick stop after the profile reaches the target.
274
- * Note: This property is effective only if the targetReachTimeout is set.
281
+ * Delay, in milliseconds, to hold at the target before issuing a quick stop.
282
+ * Only effective when targetReachTimeout is set.
275
283
  */
276
284
  holdingDuration?: number;
277
285
  /**
@@ -280,9 +288,13 @@ export interface PositionProfileConfig {
280
288
  */
281
289
  relative?: boolean;
282
290
  /**
283
- * Indicates whether to skip the quick stop request after reaching the target and the holding duration has passed.
284
- * If true, the device remains in the Operation Enabled CiA402 state without requesting a quick stop.
285
- * Note: This property is effective only if the targetReachTimeout is set.
291
+ * Controls whether a quick stop is issued after the target is reached.
292
+ *
293
+ * - false (default): issues a quick stop after the target is reached and holdingDuration elapses.
294
+ * Requires targetReachTimeout to be set, otherwise an error is thrown.
295
+ * - true: the device remains in the Operation Enabled state; no quick stop is issued.
296
+ * If targetReachTimeout is also set, the function still waits for the target reached bit
297
+ * before returning, but does not stop the drive.
286
298
  */
287
299
  skipQuickStop?: boolean;
288
300
  /**