@wandelbots/nova-api 25.11.0-dev.9 → 26.1.0-dev.40

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
@@ -90,6 +90,13 @@ const Behavior = {
90
90
  };
91
91
  const BlendingAutoBlendingNameEnum = { BlendingAuto: "BlendingAuto" };
92
92
  const BlendingPositionBlendingNameEnum = { BlendingPosition: "BlendingPosition" };
93
+ /**
94
+ * Defines the space in which blending is performed. - `JOINT`: Zone blending is performed in joint space - `CARTESIAN`: Auto-blending is performed in cartesian space
95
+ */
96
+ const BlendingSpace = {
97
+ Joint: "JOINT",
98
+ Cartesian: "CARTESIAN"
99
+ };
93
100
  const BooleanValueValueTypeEnum = { Boolean: "boolean" };
94
101
  const BoxShapeTypeEnum = { Box: "box" };
95
102
  const BoxBoxTypeEnum = {
@@ -1011,6 +1018,60 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
1011
1018
  options: localVarRequestOptions
1012
1019
  };
1013
1020
  },
1021
+ deleteAllModbusIOs: async (cell, options = {}) => {
1022
+ assertParamExists("deleteAllModbusIOs", "cell", cell);
1023
+ const localVarPath = `/cells/{cell}/bus-ios/modbus/ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
1024
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1025
+ let baseOptions;
1026
+ if (configuration) baseOptions = configuration.baseOptions;
1027
+ const localVarRequestOptions = {
1028
+ method: "DELETE",
1029
+ ...baseOptions,
1030
+ ...options
1031
+ };
1032
+ const localVarHeaderParameter = {};
1033
+ const localVarQueryParameter = {};
1034
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1035
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1036
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1037
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1038
+ localVarRequestOptions.headers = {
1039
+ ...localVarHeaderParameter,
1040
+ ...headersFromBaseOptions,
1041
+ ...options.headers
1042
+ };
1043
+ return {
1044
+ url: toPathString(localVarUrlObj),
1045
+ options: localVarRequestOptions
1046
+ };
1047
+ },
1048
+ deleteAllProfinetIOs: async (cell, options = {}) => {
1049
+ assertParamExists("deleteAllProfinetIOs", "cell", cell);
1050
+ const localVarPath = `/cells/{cell}/bus-ios/profinet/ios`.replace(`{cell}`, encodeURIComponent(String(cell)));
1051
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1052
+ let baseOptions;
1053
+ if (configuration) baseOptions = configuration.baseOptions;
1054
+ const localVarRequestOptions = {
1055
+ method: "DELETE",
1056
+ ...baseOptions,
1057
+ ...options
1058
+ };
1059
+ const localVarHeaderParameter = {};
1060
+ const localVarQueryParameter = {};
1061
+ setBasicAuthToObject(localVarRequestOptions, configuration);
1062
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1063
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1064
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1065
+ localVarRequestOptions.headers = {
1066
+ ...localVarHeaderParameter,
1067
+ ...headersFromBaseOptions,
1068
+ ...options.headers
1069
+ };
1070
+ return {
1071
+ url: toPathString(localVarUrlObj),
1072
+ options: localVarRequestOptions
1073
+ };
1074
+ },
1014
1075
  deleteModbusIO: async (cell, io, options = {}) => {
1015
1076
  assertParamExists("deleteModbusIO", "cell", cell);
1016
1077
  assertParamExists("deleteModbusIO", "io", io);
@@ -1378,6 +1439,18 @@ const BUSInputsOutputsApiFp = function(configuration) {
1378
1439
  const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.clearBusIOService"]?.[localVarOperationServerIndex]?.url;
1379
1440
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1380
1441
  },
1442
+ async deleteAllModbusIOs(cell, options) {
1443
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllModbusIOs(cell, options);
1444
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1445
+ const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.deleteAllModbusIOs"]?.[localVarOperationServerIndex]?.url;
1446
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1447
+ },
1448
+ async deleteAllProfinetIOs(cell, options) {
1449
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAllProfinetIOs(cell, options);
1450
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1451
+ const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.deleteAllProfinetIOs"]?.[localVarOperationServerIndex]?.url;
1452
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1453
+ },
1381
1454
  async deleteModbusIO(cell, io, options) {
1382
1455
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteModbusIO(cell, io, options);
1383
1456
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
@@ -1470,6 +1543,12 @@ const BUSInputsOutputsApiFactory = function(configuration, basePath, axios) {
1470
1543
  clearBusIOService(cell, completionTimeout, options) {
1471
1544
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
1472
1545
  },
1546
+ deleteAllModbusIOs(cell, options) {
1547
+ return localVarFp.deleteAllModbusIOs(cell, options).then((request) => request(axios, basePath));
1548
+ },
1549
+ deleteAllProfinetIOs(cell, options) {
1550
+ return localVarFp.deleteAllProfinetIOs(cell, options).then((request) => request(axios, basePath));
1551
+ },
1473
1552
  deleteModbusIO(cell, io, options) {
1474
1553
  return localVarFp.deleteModbusIO(cell, io, options).then((request) => request(axios, basePath));
1475
1554
  },
@@ -1560,6 +1639,26 @@ var BUSInputsOutputsApi = class extends BaseAPI {
1560
1639
  return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
1561
1640
  }
1562
1641
  /**
1642
+ * Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
1643
+ * @summary Remove all MODBUS Input/Outputs
1644
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1645
+ * @param {*} [options] Override http request option.
1646
+ * @throws {RequiredError}
1647
+ */
1648
+ deleteAllModbusIOs(cell, options) {
1649
+ return BUSInputsOutputsApiFp(this.configuration).deleteAllModbusIOs(cell, options).then((request) => request(this.axios, this.basePath));
1650
+ }
1651
+ /**
1652
+ * Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
1653
+ * @summary Remove all PROFINET Input/Outputs
1654
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
1655
+ * @param {*} [options] Override http request option.
1656
+ * @throws {RequiredError}
1657
+ */
1658
+ deleteAllProfinetIOs(cell, options) {
1659
+ return BUSInputsOutputsApiFp(this.configuration).deleteAllProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
1660
+ }
1661
+ /**
1563
1662
  * Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
1564
1663
  * @summary Remove MODBUS Input/Ouptut
1565
1664
  * @param {string} cell Unique identifier addressing a cell in all API calls.
@@ -3123,7 +3222,7 @@ const JoggingApiFactory = function(configuration, basePath, axios) {
3123
3222
  */
3124
3223
  var JoggingApi = class extends BaseAPI {
3125
3224
  /**
3126
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### 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. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
3225
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### 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. - Sets rate and coordinate system for the jogging response. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the (state stream)[streamMotionGroupState], which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request. ### Responses - `InitializeJoggingResponse` is sent to signal the success or failure of the `InitializeJoggingRequest`. - Jogging responses are streamed continuously after an `InitializeJoggingRequest` is processed. Jogging responses contain the robot controller state and the state of the jogging control. - `JoggingErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - In the `JoggingResponse`, verify that the robot control is in the desired state, e.g., standstill, with JoggingState. - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
3127
3226
  * @summary Execute Jogging
3128
3227
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3129
3228
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -3683,6 +3782,33 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
3683
3782
  options: localVarRequestOptions
3684
3783
  };
3685
3784
  },
3785
+ getMotionGroupGlbModel: async (motionGroupModel, options = {}) => {
3786
+ assertParamExists("getMotionGroupGlbModel", "motionGroupModel", motionGroupModel);
3787
+ const localVarPath = `/motion-group-models/{motion-group-model}/glb`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
3788
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3789
+ let baseOptions;
3790
+ if (configuration) baseOptions = configuration.baseOptions;
3791
+ const localVarRequestOptions = {
3792
+ method: "GET",
3793
+ ...baseOptions,
3794
+ ...options
3795
+ };
3796
+ const localVarHeaderParameter = {};
3797
+ const localVarQueryParameter = {};
3798
+ setBasicAuthToObject(localVarRequestOptions, configuration);
3799
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
3800
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3801
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3802
+ localVarRequestOptions.headers = {
3803
+ ...localVarHeaderParameter,
3804
+ ...headersFromBaseOptions,
3805
+ ...options.headers
3806
+ };
3807
+ return {
3808
+ url: toPathString(localVarUrlObj),
3809
+ options: localVarRequestOptions
3810
+ };
3811
+ },
3686
3812
  getMotionGroupModels: async (options = {}) => {
3687
3813
  const localVarUrlObj = new URL(`/motion-group-models`, DUMMY_BASE_URL);
3688
3814
  let baseOptions;
@@ -3707,6 +3833,33 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
3707
3833
  url: toPathString(localVarUrlObj),
3708
3834
  options: localVarRequestOptions
3709
3835
  };
3836
+ },
3837
+ getMotionGroupUsdModel: async (motionGroupModel, options = {}) => {
3838
+ assertParamExists("getMotionGroupUsdModel", "motionGroupModel", motionGroupModel);
3839
+ const localVarPath = `/motion-group-models/{motion-group-model}/usd`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
3840
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3841
+ let baseOptions;
3842
+ if (configuration) baseOptions = configuration.baseOptions;
3843
+ const localVarRequestOptions = {
3844
+ method: "GET",
3845
+ ...baseOptions,
3846
+ ...options
3847
+ };
3848
+ const localVarHeaderParameter = {};
3849
+ const localVarQueryParameter = {};
3850
+ setBasicAuthToObject(localVarRequestOptions, configuration);
3851
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
3852
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3853
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3854
+ localVarRequestOptions.headers = {
3855
+ ...localVarHeaderParameter,
3856
+ ...headersFromBaseOptions,
3857
+ ...options.headers
3858
+ };
3859
+ return {
3860
+ url: toPathString(localVarUrlObj),
3861
+ options: localVarRequestOptions
3862
+ };
3710
3863
  }
3711
3864
  };
3712
3865
  };
@@ -3722,11 +3875,23 @@ const MotionGroupModelsApiFp = function(configuration) {
3722
3875
  const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupCollisionModel"]?.[localVarOperationServerIndex]?.url;
3723
3876
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3724
3877
  },
3878
+ async getMotionGroupGlbModel(motionGroupModel, options) {
3879
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupGlbModel(motionGroupModel, options);
3880
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3881
+ const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupGlbModel"]?.[localVarOperationServerIndex]?.url;
3882
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3883
+ },
3725
3884
  async getMotionGroupModels(options) {
3726
3885
  const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupModels(options);
3727
3886
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3728
3887
  const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupModels"]?.[localVarOperationServerIndex]?.url;
3729
3888
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3889
+ },
3890
+ async getMotionGroupUsdModel(motionGroupModel, options) {
3891
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupUsdModel(motionGroupModel, options);
3892
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3893
+ const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupUsdModel"]?.[localVarOperationServerIndex]?.url;
3894
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3730
3895
  }
3731
3896
  };
3732
3897
  };
@@ -3739,8 +3904,14 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios) {
3739
3904
  getMotionGroupCollisionModel(motionGroupModel, options) {
3740
3905
  return localVarFp.getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(axios, basePath));
3741
3906
  },
3907
+ getMotionGroupGlbModel(motionGroupModel, options) {
3908
+ return localVarFp.getMotionGroupGlbModel(motionGroupModel, options).then((request) => request(axios, basePath));
3909
+ },
3742
3910
  getMotionGroupModels(options) {
3743
3911
  return localVarFp.getMotionGroupModels(options).then((request) => request(axios, basePath));
3912
+ },
3913
+ getMotionGroupUsdModel(motionGroupModel, options) {
3914
+ return localVarFp.getMotionGroupUsdModel(motionGroupModel, options).then((request) => request(axios, basePath));
3744
3915
  }
3745
3916
  };
3746
3917
  };
@@ -3759,6 +3930,16 @@ var MotionGroupModelsApi = class extends BaseAPI {
3759
3930
  return MotionGroupModelsApiFp(this.configuration).getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
3760
3931
  }
3761
3932
  /**
3933
+ * Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
3934
+ * @summary Download GLB Model
3935
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
3936
+ * @param {*} [options] Override http request option.
3937
+ * @throws {RequiredError}
3938
+ */
3939
+ getMotionGroupGlbModel(motionGroupModel, options) {
3940
+ return MotionGroupModelsApiFp(this.configuration).getMotionGroupGlbModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
3941
+ }
3942
+ /**
3762
3943
  * Returns the list of supported motion group models.
3763
3944
  * @summary Motion Group Models
3764
3945
  * @param {*} [options] Override http request option.
@@ -3767,6 +3948,16 @@ var MotionGroupModelsApi = class extends BaseAPI {
3767
3948
  getMotionGroupModels(options) {
3768
3949
  return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(options).then((request) => request(this.axios, this.basePath));
3769
3950
  }
3951
+ /**
3952
+ * Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
3953
+ * @summary Download USD Model
3954
+ * @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., &#x60;UniversalRobots_UR10e&#x60;. Get the &#x60;model&#x60; of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
3955
+ * @param {*} [options] Override http request option.
3956
+ * @throws {RequiredError}
3957
+ */
3958
+ getMotionGroupUsdModel(motionGroupModel, options) {
3959
+ return MotionGroupModelsApiFp(this.configuration).getMotionGroupUsdModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
3960
+ }
3770
3961
  };
3771
3962
  /**
3772
3963
  * ProgramApi - axios parameter creator
@@ -3946,7 +4137,7 @@ const ProgramApiFactory = function(configuration, basePath, axios) {
3946
4137
  */
3947
4138
  var ProgramApi = class extends BaseAPI {
3948
4139
  /**
3949
- * Get details of a program.
4140
+ * <!-- theme: danger --> > **Experimental** Get details of a program.
3950
4141
  * @summary Get program
3951
4142
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3952
4143
  * @param {string} program
@@ -3957,7 +4148,7 @@ var ProgramApi = class extends BaseAPI {
3957
4148
  return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
3958
4149
  }
3959
4150
  /**
3960
- * List details of all existing programs.
4151
+ * <!-- theme: danger --> > **Experimental** List details of all existing programs.
3961
4152
  * @summary List programs
3962
4153
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3963
4154
  * @param {*} [options] Override http request option.
@@ -3967,7 +4158,7 @@ var ProgramApi = class extends BaseAPI {
3967
4158
  return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
3968
4159
  }
3969
4160
  /**
3970
- * This endpoint starts a new program execution. The program will be executed asynchronously.
4161
+ * <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
3971
4162
  * @summary Start the program
3972
4163
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3973
4164
  * @param {string} program
@@ -3979,7 +4170,7 @@ var ProgramApi = class extends BaseAPI {
3979
4170
  return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
3980
4171
  }
3981
4172
  /**
3982
- * Stop a specific program run.
4173
+ * <!-- theme: danger --> > **Experimental** Stop a specific program run.
3983
4174
  * @summary Stop program run
3984
4175
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3985
4176
  * @param {string} program
@@ -6099,7 +6290,7 @@ const TrajectoryExecutionApiFactory = function(configuration, basePath, axios) {
6099
6290
  */
6100
6291
  var TrajectoryExecutionApi = class extends BaseAPI {
6101
6292
  /**
6102
- * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore. To execute another trajectory, a new connection must be established. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses - `InitializeMovementResponse` is sent to signal the success or failure of the `InitializeMovementRequest`. - Movement responses are streamed after a `StartMovementRequest` successfully started the movement. Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to but not exceeding the rate configured by `InitializeMovementRequest`. - Standstill response is sent once the movement has finished or has come to a standstill due to a pause. - `PauseMovementResponse` is sent to signal the success of the `PauseMovementRequest`. It does not signal the end of the movement. End of movement is signaled by Standstill response. - `PlaybackSpeedResponse` is sent to signal the success of the `PlaybackSpeedRequest`. - `MovementError` with error details is sent in case of an unexpected error, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
6293
+ * <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
6103
6294
  * @summary Execute Trajectory
6104
6295
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6105
6296
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7630,4 +7821,4 @@ var Configuration = class {
7630
7821
  };
7631
7822
 
7632
7823
  //#endregion
7633
- export { AbbControllerKindEnum, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BooleanValueValueTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SettableRobotSystemMode, SingularityTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsControllerKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualControllerTypes, YaskawaControllerKindEnum, operationServerMap };
7824
+ export { AbbControllerKindEnum, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SettableRobotSystemMode, SingularityTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsControllerKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualControllerTypes, YaskawaControllerKindEnum, operationServerMap };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wandelbots/nova-api",
3
- "version": "25.11.0-dev.9",
3
+ "version": "26.1.0-dev.40",
4
4
  "description": "API Client to interact with Wandelbots Public API.",
5
5
  "type": "module",
6
6
  "files": [