@wandelbots/nova-api 26.6.0-dev.97 → 26.6.0-dev.99

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.
package/dist/v2/index.js CHANGED
@@ -108,6 +108,8 @@ const createRequestFunction = function(axiosArgs, globalAxios, BASE_PATH, config
108
108
  //#endregion
109
109
  //#region v2/api.ts
110
110
  const AbbControllerKindEnum = { AbbController: "AbbController" };
111
+ const ActionChunkRequestMessageTypeEnum = { ActionChunkRequest: "ActionChunkRequest" };
112
+ const ActionChunkResponseKindEnum = { ActionChunkReceived: "ACTION_CHUNK_RECEIVED" };
111
113
  /**
112
114
  * ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that, the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](#/operations/externalJointsStream).
113
115
  */
@@ -240,6 +242,8 @@ const IOValueType = {
240
242
  IoValueAnalogInteger: "IO_VALUE_ANALOG_INTEGER"
241
243
  };
242
244
  const InconsistentTrajectorySizeErrorKindEnum = { InconsistentTrajectorySizeError: "InconsistentTrajectorySizeError" };
245
+ const InitializeActionChunksRequestMessageTypeEnum = { InitializeActionChunksRequest: "InitializeActionChunksRequest" };
246
+ const InitializeActionChunksResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
243
247
  const InitializeJoggingRequestMessageTypeEnum = { InitializeJoggingRequest: "InitializeJoggingRequest" };
244
248
  const InitializeJoggingResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
245
249
  const InitializeMovementRequestMessageTypeEnum = { InitializeMovementRequest: "InitializeMovementRequest" };
@@ -260,8 +264,7 @@ const JointTypeEnum = {
260
264
  };
261
265
  const JointVelocityRequestMessageTypeEnum = { JointVelocityRequest: "JointVelocityRequest" };
262
266
  const JointVelocityResponseKindEnum = { JointVelocityReceived: "JOINT_VELOCITY_RECEIVED" };
263
- const JointWaypointsRequestMessageTypeEnum = { JointWaypointsRequest: "JointWaypointsRequest" };
264
- const JointWaypointsResponseKindEnum = { JointWaypointsReceived: "JOINT_WAYPOINTS_RECEIVED" };
267
+ const JointWaypointKindEnum = { Joints: "JOINTS" };
265
268
  const KinematicBranchElbow = {
266
269
  Up: "UP",
267
270
  Down: "DOWN"
@@ -392,6 +395,8 @@ const PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum = { DirectionCo
392
395
  const PathDirectionConstrainedJointPTPPathDefinitionNameEnum = { DirectionConstrainedJointPtp: "DirectionConstrainedJointPTP" };
393
396
  const PathJointPTPPathDefinitionNameEnum = { PathJointPtp: "PathJointPTP" };
394
397
  const PathLinePathDefinitionNameEnum = { PathLine: "PathLine" };
398
+ const PauseActionChunksRequestMessageTypeEnum = { PauseActionChunksRequest: "PauseActionChunksRequest" };
399
+ const PauseActionChunksResponseKindEnum = { PauseReceived: "PAUSE_RECEIVED" };
395
400
  const PauseJoggingRequestMessageTypeEnum = { PauseJoggingRequest: "PauseJoggingRequest" };
396
401
  const PauseJoggingResponseKindEnum = { PauseReceived: "PAUSE_RECEIVED" };
397
402
  const PauseMovementRequestMessageTypeEnum = { PauseMovementRequest: "PauseMovementRequest" };
@@ -399,8 +404,7 @@ const PauseMovementResponseKindEnum = { PauseReceived: "PAUSE_RECEIVED" };
399
404
  const PlaneShapeTypeEnum = { Plane: "plane" };
400
405
  const PlaybackSpeedRequestMessageTypeEnum = { PlaybackSpeedRequest: "PlaybackSpeedRequest" };
401
406
  const PlaybackSpeedResponseKindEnum = { PlaybackSpeedReceived: "PLAYBACK_SPEED_RECEIVED" };
402
- const PoseWaypointsRequestMessageTypeEnum = { PoseWaypointsRequest: "PoseWaypointsRequest" };
403
- const PoseWaypointsResponseKindEnum = { PoseWaypointsReceived: "POSE_WAYPOINTS_RECEIVED" };
407
+ const PoseWaypointKindEnum = { Pose: "POSE" };
404
408
  /**
405
409
  * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA\'s PROFINET service.
406
410
  */
@@ -559,6 +563,8 @@ const SphereShapeTypeEnum = { Sphere: "sphere" };
559
563
  const StartMovementRequestMessageTypeEnum = { StartMovementRequest: "StartMovementRequest" };
560
564
  const StartMovementResponseKindEnum = { StartReceived: "START_RECEIVED" };
561
565
  const StaubliControllerKindEnum = { StaubliController: "StaubliController" };
566
+ const StopActionChunksRequestMessageTypeEnum = { StopActionChunksRequest: "StopActionChunksRequest" };
567
+ const StopActionChunksResponseKindEnum = { StopReceived: "STOP_RECEIVED" };
562
568
  const StorageKeySourceEnum = { Key: "key" };
563
569
  const TcpRequiredErrorKindEnum = { TcpRequiredError: "TcpRequiredError" };
564
570
  const TcpVelocityRequestMessageTypeEnum = { TcpVelocityRequest: "TcpVelocityRequest" };
@@ -596,10 +602,85 @@ const UnitreeControllerRobotTypeEnum = {
596
602
  H1: "h1"
597
603
  };
598
604
  const UniversalrobotsControllerKindEnum = { UniversalrobotsController: "UniversalrobotsController" };
605
+ const UnpauseActionChunksRequestMessageTypeEnum = { UnpauseActionChunksRequest: "UnpauseActionChunksRequest" };
606
+ const UnpauseActionChunksResponseKindEnum = { UnpauseReceived: "UNPAUSE_RECEIVED" };
599
607
  const VirtualControllerKindEnum = { VirtualController: "VirtualController" };
600
608
  const YaskawaControllerKindEnum = { YaskawaController: "YaskawaController" };
601
609
  const ZodValidationErrorErrorCodeEnum = { ValidationError: "validation_error" };
602
610
  /**
611
+ * ActionChunkStreamingApi - axios parameter creator
612
+ */
613
+ const ActionChunkStreamingApiAxiosParamCreator = function(configuration) {
614
+ return { executeActionChunks: async (cell, controller, executeActionChunksRequest, options = {}) => {
615
+ assertParamExists("executeActionChunks", "cell", cell);
616
+ assertParamExists("executeActionChunks", "controller", controller);
617
+ assertParamExists("executeActionChunks", "executeActionChunksRequest", executeActionChunksRequest);
618
+ const localVarPath = `/experimental/cells/{cell}/controllers/{controller}/execution/action-chunk-streaming`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
619
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
620
+ let baseOptions;
621
+ if (configuration) baseOptions = configuration.baseOptions;
622
+ const localVarRequestOptions = {
623
+ method: "GET",
624
+ ...baseOptions,
625
+ ...options
626
+ };
627
+ const localVarHeaderParameter = {};
628
+ const localVarQueryParameter = {};
629
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
630
+ localVarHeaderParameter["Content-Type"] = "application/json";
631
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
632
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
633
+ localVarRequestOptions.headers = {
634
+ ...localVarHeaderParameter,
635
+ ...headersFromBaseOptions,
636
+ ...options.headers
637
+ };
638
+ localVarRequestOptions.data = serializeDataIfNeeded(executeActionChunksRequest, localVarRequestOptions, configuration);
639
+ return {
640
+ url: toPathString(localVarUrlObj),
641
+ options: localVarRequestOptions
642
+ };
643
+ } };
644
+ };
645
+ /**
646
+ * ActionChunkStreamingApi - functional programming interface
647
+ */
648
+ const ActionChunkStreamingApiFp = function(configuration) {
649
+ const localVarAxiosParamCreator = ActionChunkStreamingApiAxiosParamCreator(configuration);
650
+ return { async executeActionChunks(cell, controller, executeActionChunksRequest, options) {
651
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeActionChunks(cell, controller, executeActionChunksRequest, options);
652
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
653
+ const localVarOperationServerBasePath = operationServerMap["ActionChunkStreamingApi.executeActionChunks"]?.[localVarOperationServerIndex]?.url;
654
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
655
+ } };
656
+ };
657
+ /**
658
+ * ActionChunkStreamingApi - factory interface
659
+ */
660
+ const ActionChunkStreamingApiFactory = function(configuration, basePath, axios) {
661
+ const localVarFp = ActionChunkStreamingApiFp(configuration);
662
+ return { executeActionChunks(cell, controller, executeActionChunksRequest, options) {
663
+ return localVarFp.executeActionChunks(cell, controller, executeActionChunksRequest, options).then((request) => request(axios, basePath));
664
+ } };
665
+ };
666
+ /**
667
+ * ActionChunkStreamingApi - object-oriented interface
668
+ */
669
+ var ActionChunkStreamingApi = class extends BaseAPI {
670
+ /**
671
+ * **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: danger --> > **Experimental** > > This endpoint is experimental and its behavior may change in future releases. > Websocket endpoint Provides action chunk control for a motion group. An action chunk is a queue of timed waypoints that the robot moves through by best effort. This can be used for realtime action chunk streaming, e.g., from a Vision-Language-Action (VLA) model. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeActionChunksRequest` to configure the action chunk. - Sets the robot controller mode to control mode. - Claims the motion group. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `ActionChunk`s to stream waypoints. - The first message starts an internal clock. - Each waypoint carries a timestamp relative to that clock for when it should be reached. - Existing waypoints in the queue that are older than the first new timestamp are removed. - The current session timestamp is reported in `execute.details.jogger_session_timestamp_ms` of the [streamRobotControllerState](#/operations/streamRobotControllerState) endpoint. #### 3. Stop the motion - Send `PauseActionChunksRequest` to stop the motion. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeActionChunksResponse` after `InitializeActionChunksRequest` - `ActionChunkResponse` after `ActionChunkRequest` - `PauseActionChunksResponse` after `PauseActionChunksRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](#/operations/streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during moving. ### Tips and Tricks - Ensure that the websocket connection remains open until the action chunk motion is stopped to avoid unexpected stops. ### Robot States - The robot controller state is reported in the [streamRobotControllerState](#/operations/streamRobotControllerState) as JOGGING. - The meaning of the states is: - `RUNNING`: The robot is moving through the waypoints. The clock (`execute.details.jogger_session_timestamp_ms`) is running. - `PAUSED_BY_USER`: The robot is braking or in standstill due to a user request. The clock IS paused. - `PAUSED_NEAR_JOINT_LIMIT`: The robot is braking due to a joint limit. The clock is NOT paused. - `PAUSED_NEAR_COLLISION`: The robot is braking due to a collision. The clock is NOT paused. - `PAUSED_NEAR_SINGULARITY`: The robot is braking due to a singularity. The clock is NOT paused. - `PAUSED_NEAR_WORKSPACE_BOUNDARY`: The robot is braking due to a workspace boundary. The clock is NOT paused.
672
+ * @summary Execute Action Chunks
673
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
674
+ * @param {string} controller Unique identifier to address a controller in the cell.
675
+ * @param {ExecuteActionChunksRequest} executeActionChunksRequest
676
+ * @param {*} [options] Override http request option.
677
+ * @throws {RequiredError}
678
+ */
679
+ executeActionChunks(cell, controller, executeActionChunksRequest, options) {
680
+ return ActionChunkStreamingApiFp(this.configuration).executeActionChunks(cell, controller, executeActionChunksRequest, options).then((request) => request(this.axios, this.basePath));
681
+ }
682
+ };
683
+ /**
603
684
  * ApplicationApi - axios parameter creator
604
685
  */
605
686
  const ApplicationApiAxiosParamCreator = function(configuration) {
@@ -3479,102 +3560,57 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
3479
3560
  * JoggingApi - axios parameter creator
3480
3561
  */
3481
3562
  const JoggingApiAxiosParamCreator = function(configuration) {
3482
- return {
3483
- executeJogging: async (cell, controller, executeJoggingRequest, options = {}) => {
3484
- assertParamExists("executeJogging", "cell", cell);
3485
- assertParamExists("executeJogging", "controller", controller);
3486
- assertParamExists("executeJogging", "executeJoggingRequest", executeJoggingRequest);
3487
- const localVarPath = `/cells/{cell}/controllers/{controller}/execution/jogging`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
3488
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3489
- let baseOptions;
3490
- if (configuration) baseOptions = configuration.baseOptions;
3491
- const localVarRequestOptions = {
3492
- method: "GET",
3493
- ...baseOptions,
3494
- ...options
3495
- };
3496
- const localVarHeaderParameter = {};
3497
- const localVarQueryParameter = {};
3498
- await setBearerAuthToObject(localVarHeaderParameter, configuration);
3499
- localVarHeaderParameter["Content-Type"] = "application/json";
3500
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3501
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3502
- localVarRequestOptions.headers = {
3503
- ...localVarHeaderParameter,
3504
- ...headersFromBaseOptions,
3505
- ...options.headers
3506
- };
3507
- localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration);
3508
- return {
3509
- url: toPathString(localVarUrlObj),
3510
- options: localVarRequestOptions
3511
- };
3512
- },
3513
- executeWaypointJogging: async (cell, controller, executeWaypointJoggingRequest, options = {}) => {
3514
- assertParamExists("executeWaypointJogging", "cell", cell);
3515
- assertParamExists("executeWaypointJogging", "controller", controller);
3516
- assertParamExists("executeWaypointJogging", "executeWaypointJoggingRequest", executeWaypointJoggingRequest);
3517
- const localVarPath = `/experimental/cells/{cell}/controllers/{controller}/execution/jogging`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
3518
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3519
- let baseOptions;
3520
- if (configuration) baseOptions = configuration.baseOptions;
3521
- const localVarRequestOptions = {
3522
- method: "GET",
3523
- ...baseOptions,
3524
- ...options
3525
- };
3526
- const localVarHeaderParameter = {};
3527
- const localVarQueryParameter = {};
3528
- await setBearerAuthToObject(localVarHeaderParameter, configuration);
3529
- localVarHeaderParameter["Content-Type"] = "application/json";
3530
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3531
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3532
- localVarRequestOptions.headers = {
3533
- ...localVarHeaderParameter,
3534
- ...headersFromBaseOptions,
3535
- ...options.headers
3536
- };
3537
- localVarRequestOptions.data = serializeDataIfNeeded(executeWaypointJoggingRequest, localVarRequestOptions, configuration);
3538
- return {
3539
- url: toPathString(localVarUrlObj),
3540
- options: localVarRequestOptions
3541
- };
3542
- }
3543
- };
3563
+ return { executeJogging: async (cell, controller, executeJoggingRequest, options = {}) => {
3564
+ assertParamExists("executeJogging", "cell", cell);
3565
+ assertParamExists("executeJogging", "controller", controller);
3566
+ assertParamExists("executeJogging", "executeJoggingRequest", executeJoggingRequest);
3567
+ const localVarPath = `/cells/{cell}/controllers/{controller}/execution/jogging`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
3568
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3569
+ let baseOptions;
3570
+ if (configuration) baseOptions = configuration.baseOptions;
3571
+ const localVarRequestOptions = {
3572
+ method: "GET",
3573
+ ...baseOptions,
3574
+ ...options
3575
+ };
3576
+ const localVarHeaderParameter = {};
3577
+ const localVarQueryParameter = {};
3578
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
3579
+ localVarHeaderParameter["Content-Type"] = "application/json";
3580
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3581
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3582
+ localVarRequestOptions.headers = {
3583
+ ...localVarHeaderParameter,
3584
+ ...headersFromBaseOptions,
3585
+ ...options.headers
3586
+ };
3587
+ localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration);
3588
+ return {
3589
+ url: toPathString(localVarUrlObj),
3590
+ options: localVarRequestOptions
3591
+ };
3592
+ } };
3544
3593
  };
3545
3594
  /**
3546
3595
  * JoggingApi - functional programming interface
3547
3596
  */
3548
3597
  const JoggingApiFp = function(configuration) {
3549
3598
  const localVarAxiosParamCreator = JoggingApiAxiosParamCreator(configuration);
3550
- return {
3551
- async executeJogging(cell, controller, executeJoggingRequest, options) {
3552
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, controller, executeJoggingRequest, options);
3553
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3554
- const localVarOperationServerBasePath = operationServerMap["JoggingApi.executeJogging"]?.[localVarOperationServerIndex]?.url;
3555
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3556
- },
3557
- async executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options) {
3558
- const localVarAxiosArgs = await localVarAxiosParamCreator.executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options);
3559
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3560
- const localVarOperationServerBasePath = operationServerMap["JoggingApi.executeWaypointJogging"]?.[localVarOperationServerIndex]?.url;
3561
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3562
- }
3563
- };
3599
+ return { async executeJogging(cell, controller, executeJoggingRequest, options) {
3600
+ const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, controller, executeJoggingRequest, options);
3601
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3602
+ const localVarOperationServerBasePath = operationServerMap["JoggingApi.executeJogging"]?.[localVarOperationServerIndex]?.url;
3603
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3604
+ } };
3564
3605
  };
3565
3606
  /**
3566
3607
  * JoggingApi - factory interface
3567
3608
  */
3568
3609
  const JoggingApiFactory = function(configuration, basePath, axios) {
3569
3610
  const localVarFp = JoggingApiFp(configuration);
3570
- return {
3571
- executeJogging(cell, controller, executeJoggingRequest, options) {
3572
- return localVarFp.executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(axios, basePath));
3573
- },
3574
- executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options) {
3575
- return localVarFp.executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options).then((request) => request(axios, basePath));
3576
- }
3577
- };
3611
+ return { executeJogging(cell, controller, executeJoggingRequest, options) {
3612
+ return localVarFp.executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(axios, basePath));
3613
+ } };
3578
3614
  };
3579
3615
  /**
3580
3616
  * JoggingApi - object-oriented interface
@@ -3592,18 +3628,6 @@ var JoggingApi = class extends BaseAPI {
3592
3628
  executeJogging(cell, controller, executeJoggingRequest, options) {
3593
3629
  return JoggingApiFp(this.configuration).executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
3594
3630
  }
3595
- /**
3596
- * **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: danger --> > **Experimental** > > This endpoint is experimental and its behavior may change in future releases. > Websocket endpoint Provides waypoint-based jogging control for a motion group. Instead of commanding target velocities (see [executeJogging](#/operations/executeJogging)), waypoint jogging streams a queue of timed waypoints that the robot moves through by best effort. This can be used for realtime action chunk streaming, e.g., from a Vision-Language-Action (VLA) model. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointWaypointsRequest` or `PoseWaypointsRequest` to stream waypoints. - The first waypoints message starts an internal clock. - Each waypoint carries a timestamp relative to that clock for when it should be reached. - Existing waypoints in the queue that are older than the first new timestamp are removed. - The current session timestamp is reported in `execute.details.jogger_session_timestamp_ms` of the [streamRobotControllerState](#/operations/streamRobotControllerState) endpoint. #### 3. Stop the jogging motion - Send `PauseJoggingRequest` to stop the motion. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointWaypointsResponse` after `JointWaypointsRequest` - `PoseWaypointsResponse` after `PoseWaypointsRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](#/operations/streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
3597
- * @summary Execute Waypoint Jogging
3598
- * @param {string} cell Unique identifier addressing a cell in all API calls.
3599
- * @param {string} controller Unique identifier to address a controller in the cell.
3600
- * @param {ExecuteWaypointJoggingRequest} executeWaypointJoggingRequest
3601
- * @param {*} [options] Override http request option.
3602
- * @throws {RequiredError}
3603
- */
3604
- executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options) {
3605
- return JoggingApiFp(this.configuration).executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options).then((request) => request(this.axios, this.basePath));
3606
- }
3607
3631
  };
3608
3632
  /**
3609
3633
  * KinematicsApi - axios parameter creator
@@ -9614,4 +9638,4 @@ var Configuration = class {
9614
9638
  }
9615
9639
  };
9616
9640
  //#endregion
9617
- export { AbbControllerKindEnum, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BostondynamicsControllerKindEnum, BostondynamicsControllerRobotTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOSnap7BusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, CloudConfigStatusConfiguredStatusEnum, CloudConfigStatusNotConfiguredStatusEnum, CloudConnectionErrorInvalidTokenCodeEnum, CloudConnectionErrorLeafnodeConnectionErrorCodeEnum, CloudConnectionErrorLeafnodeConnectionTimeoutCodeEnum, CloudConnectionErrorLeafnodeRestartTimeoutCodeEnum, CloudConnectionErrorNatsFailedCodeEnum, CloudConnectionErrorUnexpectedResponseCodeEnum, CloudDisconnectionStatusDisconnectedStatusEnum, CloudDisconnectionStatusDisconnectingStatusEnum, ColliderValueSourceEnum, CollisionErrorKindEnum, CollisionSetupValueSourceEnum, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, DirectionConstraintConstraintNameEnum, ErrorDirectionConstraintNotMetErrorFeedbackNameEnum, ErrorDirectionConstraintNotNormalizedErrorFeedbackNameEnum, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, ErrorUnsupportedOperationErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackAxisRangeExceededErrorFeedbackNameEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackCommandsMissingErrorFeedbackNameEnum, FeedbackCubicSplineIsNotIncreasingErrorFeedbackNameEnum, FeedbackCubicSplineNotAtStartPoseErrorFeedbackNameEnum, FeedbackDirectionConstraintNoSolutionExistsErrorFeedbackNameEnum, FeedbackDirectionConstraintNotMetErrorFeedbackNameEnum, FeedbackDirectionConstraintNotNormalizedErrorFeedbackNameEnum, FeedbackInvalidDofErrorFeedbackNameEnum, FeedbackInvalidNanValueErrorFeedbackNameEnum, FeedbackInvalidSamplingTimeErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackNoSolutionInCurrentConfigurationErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FeedbackStartJointsMissingErrorFeedbackNameEnum, FeedbackTorqueExceededErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InconsistentTrajectorySizeErrorKindEnum, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, InvalidDofErrorKindEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedNearSingularityKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointLimitExceededErrorKindEnum, JointTypeEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, JointWaypointsRequestMessageTypeEnum, JointWaypointsResponseKindEnum, KinematicBranchElbow, KinematicBranchShoulder, KinematicBranchWrist, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, LinkChainValueSourceEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, NOVACloudApi, NOVACloudApiAxiosParamCreator, NOVACloudApiFactory, NOVACloudApiFp, NanValueErrorKindEnum, NetworkStateConnectionTypeEnum, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum, PathDirectionConstrainedJointPTPPathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, PoseWaypointsRequestMessageTypeEnum, PoseWaypointsResponseKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SessionApi, SessionApiAxiosParamCreator, SessionApiFactory, SessionApiFp, SettableRobotSystemMode, SingularityHandling, SingularityTypeEnum, Snap7IOArea, Snap7IODirection, Snap7IOTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StaubliControllerKindEnum, StorageKeySourceEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpRequiredErrorKindEnum, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, ToolValueSourceEnum, TorqueExceededErrorKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UnitreeControllerKindEnum, UnitreeControllerRobotTypeEnum, UniversalrobotsControllerKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, YaskawaControllerKindEnum, ZodValidationErrorErrorCodeEnum, operationServerMap };
9641
+ export { AbbControllerKindEnum, ActionChunkRequestMessageTypeEnum, ActionChunkResponseKindEnum, ActionChunkStreamingApi, ActionChunkStreamingApiAxiosParamCreator, ActionChunkStreamingApiFactory, ActionChunkStreamingApiFp, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BostondynamicsControllerKindEnum, BostondynamicsControllerRobotTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOSnap7BusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, CloudConfigStatusConfiguredStatusEnum, CloudConfigStatusNotConfiguredStatusEnum, CloudConnectionErrorInvalidTokenCodeEnum, CloudConnectionErrorLeafnodeConnectionErrorCodeEnum, CloudConnectionErrorLeafnodeConnectionTimeoutCodeEnum, CloudConnectionErrorLeafnodeRestartTimeoutCodeEnum, CloudConnectionErrorNatsFailedCodeEnum, CloudConnectionErrorUnexpectedResponseCodeEnum, CloudDisconnectionStatusDisconnectedStatusEnum, CloudDisconnectionStatusDisconnectingStatusEnum, ColliderValueSourceEnum, CollisionErrorKindEnum, CollisionSetupValueSourceEnum, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, DirectionConstraintConstraintNameEnum, ErrorDirectionConstraintNotMetErrorFeedbackNameEnum, ErrorDirectionConstraintNotNormalizedErrorFeedbackNameEnum, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, ErrorUnsupportedOperationErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackAxisRangeExceededErrorFeedbackNameEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackCommandsMissingErrorFeedbackNameEnum, FeedbackCubicSplineIsNotIncreasingErrorFeedbackNameEnum, FeedbackCubicSplineNotAtStartPoseErrorFeedbackNameEnum, FeedbackDirectionConstraintNoSolutionExistsErrorFeedbackNameEnum, FeedbackDirectionConstraintNotMetErrorFeedbackNameEnum, FeedbackDirectionConstraintNotNormalizedErrorFeedbackNameEnum, FeedbackInvalidDofErrorFeedbackNameEnum, FeedbackInvalidNanValueErrorFeedbackNameEnum, FeedbackInvalidSamplingTimeErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackNoSolutionInCurrentConfigurationErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FeedbackStartJointsMissingErrorFeedbackNameEnum, FeedbackTorqueExceededErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InconsistentTrajectorySizeErrorKindEnum, InitializeActionChunksRequestMessageTypeEnum, InitializeActionChunksResponseKindEnum, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, InvalidDofErrorKindEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedNearSingularityKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointLimitExceededErrorKindEnum, JointTypeEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, JointWaypointKindEnum, KinematicBranchElbow, KinematicBranchShoulder, KinematicBranchWrist, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, LinkChainValueSourceEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, NOVACloudApi, NOVACloudApiAxiosParamCreator, NOVACloudApiFactory, NOVACloudApiFp, NanValueErrorKindEnum, NetworkStateConnectionTypeEnum, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum, PathDirectionConstrainedJointPTPPathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseActionChunksRequestMessageTypeEnum, PauseActionChunksResponseKindEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, PoseWaypointKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SessionApi, SessionApiAxiosParamCreator, SessionApiFactory, SessionApiFp, SettableRobotSystemMode, SingularityHandling, SingularityTypeEnum, Snap7IOArea, Snap7IODirection, Snap7IOTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StaubliControllerKindEnum, StopActionChunksRequestMessageTypeEnum, StopActionChunksResponseKindEnum, StorageKeySourceEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpRequiredErrorKindEnum, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, ToolValueSourceEnum, TorqueExceededErrorKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UnitreeControllerKindEnum, UnitreeControllerRobotTypeEnum, UniversalrobotsControllerKindEnum, UnpauseActionChunksRequestMessageTypeEnum, UnpauseActionChunksResponseKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, YaskawaControllerKindEnum, ZodValidationErrorErrorCodeEnum, operationServerMap };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wandelbots/nova-api",
3
- "version": "26.6.0-dev.97",
3
+ "version": "26.6.0-dev.99",
4
4
  "description": "API Client to interact with Wandelbots Public API.",
5
5
  "type": "module",
6
6
  "files": [