@wandelbots/nova-api 26.2.0-dev.9 → 26.3.0-dev.2
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/v1/index.cjs +60 -243
- package/dist/v1/index.d.cts +433 -433
- package/dist/v1/index.d.ts +433 -433
- package/dist/v1/index.js +60 -243
- package/dist/v2/index.cjs +399 -227
- package/dist/v2/index.d.cts +640 -223
- package/dist/v2/index.d.ts +780 -363
- package/dist/v2/index.js +392 -228
- package/package.json +1 -1
package/dist/v2/index.cjs
CHANGED
|
@@ -41,12 +41,6 @@ const DUMMY_BASE_URL = "https://example.com";
|
|
|
41
41
|
const assertParamExists = function(functionName, paramName, paramValue) {
|
|
42
42
|
if (paramValue === null || paramValue === void 0) throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
|
|
43
43
|
};
|
|
44
|
-
const setBasicAuthToObject = function(object, configuration) {
|
|
45
|
-
if (configuration && (configuration.username || configuration.password)) object["auth"] = {
|
|
46
|
-
username: configuration.username,
|
|
47
|
-
password: configuration.password
|
|
48
|
-
};
|
|
49
|
-
};
|
|
50
44
|
const setBearerAuthToObject = async function(object, configuration) {
|
|
51
45
|
if (configuration && configuration.accessToken) object["Authorization"] = "Bearer " + (typeof configuration.accessToken === "function" ? await configuration.accessToken() : await configuration.accessToken);
|
|
52
46
|
};
|
|
@@ -83,7 +77,7 @@ const createRequestFunction = function(axiosArgs, globalAxios$2, BASE_PATH$1, co
|
|
|
83
77
|
//#region v2/api.ts
|
|
84
78
|
const AbbControllerKindEnum = { AbbController: "AbbController" };
|
|
85
79
|
/**
|
|
86
|
-
* ## 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](externalJointsStream).
|
|
80
|
+
* ## 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).
|
|
87
81
|
*/
|
|
88
82
|
const Behavior = {
|
|
89
83
|
BehaviorAutomatic: "BEHAVIOR_AUTOMATIC",
|
|
@@ -122,6 +116,7 @@ const BusIOsStateEnum = {
|
|
|
122
116
|
BusIosStateDisconnected: "BUS_IOS_STATE_DISCONNECTED"
|
|
123
117
|
};
|
|
124
118
|
const CapsuleShapeTypeEnum = { Capsule: "capsule" };
|
|
119
|
+
const CollisionErrorKindEnum = { CollisionError: "CollisionError" };
|
|
125
120
|
/**
|
|
126
121
|
* Comparator for the comparison of two values. The comparator is used to compare two values and return a boolean result. The default comparator is unknown.
|
|
127
122
|
*/
|
|
@@ -180,17 +175,24 @@ const IOValueType = {
|
|
|
180
175
|
IoValueAnalogFloat: "IO_VALUE_ANALOG_FLOAT",
|
|
181
176
|
IoValueAnalogInteger: "IO_VALUE_ANALOG_INTEGER"
|
|
182
177
|
};
|
|
178
|
+
const InconsistentTrajectorySizeErrorKindEnum = { InconsistentTrajectorySizeError: "InconsistentTrajectorySizeError" };
|
|
183
179
|
const InitializeJoggingRequestMessageTypeEnum = { InitializeJoggingRequest: "InitializeJoggingRequest" };
|
|
184
180
|
const InitializeJoggingResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
|
|
185
181
|
const InitializeMovementRequestMessageTypeEnum = { InitializeMovementRequest: "InitializeMovementRequest" };
|
|
186
182
|
const InitializeMovementResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
|
|
187
183
|
const IntegerValueValueTypeEnum = { Integer: "integer" };
|
|
184
|
+
const InvalidDofErrorKindEnum = { InvalidDofError: "InvalidDofError" };
|
|
188
185
|
const JoggingDetailsKindEnum = { Jogging: "JOGGING" };
|
|
189
186
|
const JoggingPausedByUserKindEnum = { PausedByUser: "PAUSED_BY_USER" };
|
|
190
187
|
const JoggingPausedNearCollisionKindEnum = { PausedNearCollision: "PAUSED_NEAR_COLLISION" };
|
|
191
188
|
const JoggingPausedNearJointLimitKindEnum = { PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT" };
|
|
192
189
|
const JoggingPausedOnIOKindEnum = { PausedOnIo: "PAUSED_ON_IO" };
|
|
193
190
|
const JoggingRunningKindEnum = { Running: "RUNNING" };
|
|
191
|
+
const JointLimitExceededErrorKindEnum = { JointLimitExceededError: "JointLimitExceededError" };
|
|
192
|
+
const JointTypeEnum = {
|
|
193
|
+
RevoluteJoint: "REVOLUTE_JOINT",
|
|
194
|
+
PrismaticJoint: "PRISMATIC_JOINT"
|
|
195
|
+
};
|
|
194
196
|
const JointVelocityRequestMessageTypeEnum = { JointVelocityRequest: "JointVelocityRequest" };
|
|
195
197
|
const JointVelocityResponseKindEnum = { JointVelocityReceived: "JOINT_VELOCITY_RECEIVED" };
|
|
196
198
|
const KukaControllerKindEnum = { KukaController: "KukaController" };
|
|
@@ -239,6 +241,7 @@ const ModbusIOTypeEnum = {
|
|
|
239
241
|
ModbusIoTypeFloat32: "MODBUS_IO_TYPE_FLOAT32"
|
|
240
242
|
};
|
|
241
243
|
const MovementErrorResponseKindEnum = { MotionError: "MOTION_ERROR" };
|
|
244
|
+
const NanValueErrorKindEnum = { NanValueError: "NanValueError" };
|
|
242
245
|
const NetworkStateConnectionTypeEnum = {
|
|
243
246
|
Ethernet: "ethernet",
|
|
244
247
|
Wifi: "wifi",
|
|
@@ -348,14 +351,14 @@ const RRTConnectAlgorithmAlgorithmNameEnum = { RrtConnectAlgorithm: "RRTConnectA
|
|
|
348
351
|
const RectangleShapeTypeEnum = { Rectangle: "rectangle" };
|
|
349
352
|
const RectangularCapsuleShapeTypeEnum = { RectangularCapsule: "rectangular_capsule" };
|
|
350
353
|
/**
|
|
351
|
-
* The channel that defines what a new Wandelbots NOVA version is. * `next` the
|
|
354
|
+
* The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
|
|
352
355
|
*/
|
|
353
356
|
const ReleaseChannel = {
|
|
354
357
|
Stable: "stable",
|
|
355
358
|
Next: "next"
|
|
356
359
|
};
|
|
357
360
|
/**
|
|
358
|
-
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
|
|
361
|
+
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](#/operations/addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](#/operations/getSupportedModes) to check Free Drive availability.
|
|
359
362
|
*/
|
|
360
363
|
const RobotSystemMode = {
|
|
361
364
|
ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED",
|
|
@@ -413,7 +416,7 @@ const ServiceStatusSeverity = {
|
|
|
413
416
|
Error: "ERROR"
|
|
414
417
|
};
|
|
415
418
|
/**
|
|
416
|
-
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](getMode) responses.
|
|
419
|
+
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
|
|
417
420
|
*/
|
|
418
421
|
const SettableRobotSystemMode = {
|
|
419
422
|
RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR",
|
|
@@ -429,8 +432,10 @@ const SingularityTypeEnum = {
|
|
|
429
432
|
const SphereShapeTypeEnum = { Sphere: "sphere" };
|
|
430
433
|
const StartMovementRequestMessageTypeEnum = { StartMovementRequest: "StartMovementRequest" };
|
|
431
434
|
const StartMovementResponseKindEnum = { StartReceived: "START_RECEIVED" };
|
|
435
|
+
const TcpRequiredErrorKindEnum = { TcpRequiredError: "TcpRequiredError" };
|
|
432
436
|
const TcpVelocityRequestMessageTypeEnum = { TcpVelocityRequest: "TcpVelocityRequest" };
|
|
433
437
|
const TcpVelocityResponseKindEnum = { TcpVelocityReceived: "TCP_VELOCITY_RECEIVED" };
|
|
438
|
+
const TorqueExceededErrorKindEnum = { TorqueExceededError: "TorqueExceededError" };
|
|
434
439
|
const TrajectoryDataMessageTypeEnum = { TrajectoryData: "TrajectoryData" };
|
|
435
440
|
const TrajectoryDetailsKindEnum = { Trajectory: "TRAJECTORY" };
|
|
436
441
|
const TrajectoryEndedKindEnum = { EndOfTrajectory: "END_OF_TRAJECTORY" };
|
|
@@ -476,7 +481,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
476
481
|
};
|
|
477
482
|
const localVarHeaderParameter = {};
|
|
478
483
|
const localVarQueryParameter = {};
|
|
479
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
480
484
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
481
485
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
482
486
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -506,7 +510,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
506
510
|
};
|
|
507
511
|
const localVarHeaderParameter = {};
|
|
508
512
|
const localVarQueryParameter = {};
|
|
509
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
510
513
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
511
514
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
512
515
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -535,7 +538,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
535
538
|
};
|
|
536
539
|
const localVarHeaderParameter = {};
|
|
537
540
|
const localVarQueryParameter = {};
|
|
538
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
539
541
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
540
542
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
541
543
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -564,7 +566,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
564
566
|
};
|
|
565
567
|
const localVarHeaderParameter = {};
|
|
566
568
|
const localVarQueryParameter = {};
|
|
567
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
568
569
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
569
570
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
570
571
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -591,7 +592,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
591
592
|
};
|
|
592
593
|
const localVarHeaderParameter = {};
|
|
593
594
|
const localVarQueryParameter = {};
|
|
594
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
595
595
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
596
596
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
597
597
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -620,7 +620,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
620
620
|
};
|
|
621
621
|
const localVarHeaderParameter = {};
|
|
622
622
|
const localVarQueryParameter = {};
|
|
623
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
624
623
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
625
624
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
626
625
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -749,7 +748,7 @@ var ApplicationApi = class extends BaseAPI {
|
|
|
749
748
|
return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
750
749
|
}
|
|
751
750
|
/**
|
|
752
|
-
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
|
|
751
|
+
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
|
|
753
752
|
* @summary Configuration
|
|
754
753
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
755
754
|
* @param {string} app
|
|
@@ -760,7 +759,7 @@ var ApplicationApi = class extends BaseAPI {
|
|
|
760
759
|
return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
|
|
761
760
|
}
|
|
762
761
|
/**
|
|
763
|
-
* List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
762
|
+
* List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
764
763
|
* @summary List Applications
|
|
765
764
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
766
765
|
* @param {*} [options] Override http request option.
|
|
@@ -802,7 +801,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
802
801
|
};
|
|
803
802
|
const localVarHeaderParameter = {};
|
|
804
803
|
const localVarQueryParameter = {};
|
|
805
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
806
804
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
807
805
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
808
806
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -834,7 +832,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
834
832
|
};
|
|
835
833
|
const localVarHeaderParameter = {};
|
|
836
834
|
const localVarQueryParameter = {};
|
|
837
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
838
835
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
839
836
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
840
837
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -865,7 +862,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
865
862
|
};
|
|
866
863
|
const localVarHeaderParameter = {};
|
|
867
864
|
const localVarQueryParameter = {};
|
|
868
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
869
865
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
870
866
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
871
867
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -894,7 +890,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
894
890
|
};
|
|
895
891
|
const localVarHeaderParameter = {};
|
|
896
892
|
const localVarQueryParameter = {};
|
|
897
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
898
893
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
899
894
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
900
895
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -922,7 +917,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
922
917
|
};
|
|
923
918
|
const localVarHeaderParameter = {};
|
|
924
919
|
const localVarQueryParameter = {};
|
|
925
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
926
920
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
927
921
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
928
922
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -949,7 +943,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
949
943
|
};
|
|
950
944
|
const localVarHeaderParameter = {};
|
|
951
945
|
const localVarQueryParameter = {};
|
|
952
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
953
946
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
954
947
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
955
948
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -977,7 +970,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
977
970
|
};
|
|
978
971
|
const localVarHeaderParameter = {};
|
|
979
972
|
const localVarQueryParameter = {};
|
|
980
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
981
973
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
982
974
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
983
975
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1005,7 +997,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1005
997
|
};
|
|
1006
998
|
const localVarHeaderParameter = {};
|
|
1007
999
|
const localVarQueryParameter = {};
|
|
1008
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1009
1000
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1010
1001
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1011
1002
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1032,7 +1023,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1032
1023
|
};
|
|
1033
1024
|
const localVarHeaderParameter = {};
|
|
1034
1025
|
const localVarQueryParameter = {};
|
|
1035
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1036
1026
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1037
1027
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1038
1028
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1059,7 +1049,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1059
1049
|
};
|
|
1060
1050
|
const localVarHeaderParameter = {};
|
|
1061
1051
|
const localVarQueryParameter = {};
|
|
1062
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1063
1052
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1064
1053
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1065
1054
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1086,7 +1075,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1086
1075
|
};
|
|
1087
1076
|
const localVarHeaderParameter = {};
|
|
1088
1077
|
const localVarQueryParameter = {};
|
|
1089
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1090
1078
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1091
1079
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
1092
1080
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1114,7 +1102,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1114
1102
|
};
|
|
1115
1103
|
const localVarHeaderParameter = {};
|
|
1116
1104
|
const localVarQueryParameter = {};
|
|
1117
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1118
1105
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1119
1106
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1120
1107
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1141,7 +1128,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1141
1128
|
};
|
|
1142
1129
|
const localVarHeaderParameter = {};
|
|
1143
1130
|
const localVarQueryParameter = {};
|
|
1144
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1145
1131
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1146
1132
|
if (inputOffset !== void 0) localVarQueryParameter["input_offset"] = inputOffset;
|
|
1147
1133
|
if (outputOffset !== void 0) localVarQueryParameter["output_offset"] = outputOffset;
|
|
@@ -1170,7 +1156,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1170
1156
|
};
|
|
1171
1157
|
const localVarHeaderParameter = {};
|
|
1172
1158
|
const localVarQueryParameter = {};
|
|
1173
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1174
1159
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1175
1160
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1176
1161
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1197,7 +1182,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1197
1182
|
};
|
|
1198
1183
|
const localVarHeaderParameter = {};
|
|
1199
1184
|
const localVarQueryParameter = {};
|
|
1200
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1201
1185
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1202
1186
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1203
1187
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1224,7 +1208,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1224
1208
|
};
|
|
1225
1209
|
const localVarHeaderParameter = {};
|
|
1226
1210
|
const localVarQueryParameter = {};
|
|
1227
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1228
1211
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1229
1212
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1230
1213
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1252,7 +1235,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1252
1235
|
};
|
|
1253
1236
|
const localVarHeaderParameter = {};
|
|
1254
1237
|
const localVarQueryParameter = {};
|
|
1255
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1256
1238
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1257
1239
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1258
1240
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1282,7 +1264,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1282
1264
|
};
|
|
1283
1265
|
const localVarHeaderParameter = {};
|
|
1284
1266
|
const localVarQueryParameter = {};
|
|
1285
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1286
1267
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1287
1268
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1288
1269
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1495,7 +1476,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1495
1476
|
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1496
1477
|
}
|
|
1497
1478
|
/**
|
|
1498
|
-
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
|
|
1479
|
+
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
|
|
1499
1480
|
* @summary Add MODBUS Input/Output
|
|
1500
1481
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1501
1482
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -1507,7 +1488,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1507
1488
|
return BUSInputsOutputsApiFp(this.configuration).addModbusIO(cell, io, modbusIOData, options).then((request) => request(this.axios, this.basePath));
|
|
1508
1489
|
}
|
|
1509
1490
|
/**
|
|
1510
|
-
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
1491
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
1511
1492
|
* @summary Add PROFINET Input/Output
|
|
1512
1493
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1513
1494
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -1551,7 +1532,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1551
1532
|
}
|
|
1552
1533
|
/**
|
|
1553
1534
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
1554
|
-
* @summary Remove MODBUS Input/
|
|
1535
|
+
* @summary Remove MODBUS Input/Output
|
|
1555
1536
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1556
1537
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1557
1538
|
* @param {*} [options] Override http request option.
|
|
@@ -1592,7 +1573,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1592
1573
|
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1593
1574
|
}
|
|
1594
1575
|
/**
|
|
1595
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
1576
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
|
|
1596
1577
|
* @summary Get Input/Output Values
|
|
1597
1578
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1598
1579
|
* @param {Array<string>} [ios]
|
|
@@ -1635,7 +1616,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1635
1616
|
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1636
1617
|
}
|
|
1637
1618
|
/**
|
|
1638
|
-
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
|
|
1619
|
+
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
|
|
1639
1620
|
* @summary List MODBUS Input/Output Configuration
|
|
1640
1621
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1641
1622
|
* @param {*} [options] Override http request option.
|
|
@@ -1645,7 +1626,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1645
1626
|
return BUSInputsOutputsApiFp(this.configuration).listModbusIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1646
1627
|
}
|
|
1647
1628
|
/**
|
|
1648
|
-
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
1629
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
1649
1630
|
* @summary List PROFINET Input/Output Configuration
|
|
1650
1631
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1651
1632
|
* @param {*} [options] Override http request option.
|
|
@@ -1655,7 +1636,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1655
1636
|
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1656
1637
|
}
|
|
1657
1638
|
/**
|
|
1658
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
1639
|
+
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
1659
1640
|
* @summary Set Output Values
|
|
1660
1641
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1661
1642
|
* @param {Array<IOValue>} iOValue
|
|
@@ -1666,7 +1647,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1666
1647
|
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
1667
1648
|
}
|
|
1668
1649
|
/**
|
|
1669
|
-
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
1650
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
1670
1651
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
1671
1652
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1672
1653
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -1682,6 +1663,34 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1682
1663
|
*/
|
|
1683
1664
|
const CellApiAxiosParamCreator = function(configuration) {
|
|
1684
1665
|
return {
|
|
1666
|
+
checkCellVersionUpdate: async (cell, channel, options = {}) => {
|
|
1667
|
+
assertParamExists("checkCellVersionUpdate", "cell", cell);
|
|
1668
|
+
assertParamExists("checkCellVersionUpdate", "channel", channel);
|
|
1669
|
+
const localVarPath = `/cells/{cell}/update`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1670
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1671
|
+
let baseOptions;
|
|
1672
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1673
|
+
const localVarRequestOptions = {
|
|
1674
|
+
method: "GET",
|
|
1675
|
+
...baseOptions,
|
|
1676
|
+
...options
|
|
1677
|
+
};
|
|
1678
|
+
const localVarHeaderParameter = {};
|
|
1679
|
+
const localVarQueryParameter = {};
|
|
1680
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1681
|
+
if (channel !== void 0) localVarQueryParameter["channel"] = channel;
|
|
1682
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1683
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1684
|
+
localVarRequestOptions.headers = {
|
|
1685
|
+
...localVarHeaderParameter,
|
|
1686
|
+
...headersFromBaseOptions,
|
|
1687
|
+
...options.headers
|
|
1688
|
+
};
|
|
1689
|
+
return {
|
|
1690
|
+
url: toPathString(localVarUrlObj),
|
|
1691
|
+
options: localVarRequestOptions
|
|
1692
|
+
};
|
|
1693
|
+
},
|
|
1685
1694
|
deleteCell: async (cell, completionTimeout, options = {}) => {
|
|
1686
1695
|
assertParamExists("deleteCell", "cell", cell);
|
|
1687
1696
|
const localVarPath = `/cells/{cell}`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
@@ -1695,7 +1704,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1695
1704
|
};
|
|
1696
1705
|
const localVarHeaderParameter = {};
|
|
1697
1706
|
const localVarQueryParameter = {};
|
|
1698
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1699
1707
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1700
1708
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1701
1709
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1722,7 +1730,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1722
1730
|
};
|
|
1723
1731
|
const localVarHeaderParameter = {};
|
|
1724
1732
|
const localVarQueryParameter = {};
|
|
1725
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1726
1733
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1727
1734
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1728
1735
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -1752,7 +1759,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1752
1759
|
};
|
|
1753
1760
|
const localVarHeaderParameter = {};
|
|
1754
1761
|
const localVarQueryParameter = {};
|
|
1755
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1756
1762
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1757
1763
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1758
1764
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1779,7 +1785,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1779
1785
|
};
|
|
1780
1786
|
const localVarHeaderParameter = {};
|
|
1781
1787
|
const localVarQueryParameter = {};
|
|
1782
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1783
1788
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1784
1789
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1785
1790
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1804,7 +1809,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1804
1809
|
};
|
|
1805
1810
|
const localVarHeaderParameter = {};
|
|
1806
1811
|
const localVarQueryParameter = {};
|
|
1807
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1808
1812
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1809
1813
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1810
1814
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1832,7 +1836,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1832
1836
|
};
|
|
1833
1837
|
const localVarHeaderParameter = {};
|
|
1834
1838
|
const localVarQueryParameter = {};
|
|
1835
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1836
1839
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1837
1840
|
if (operatingState !== void 0) localVarQueryParameter["operating_state"] = operatingState;
|
|
1838
1841
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1861,7 +1864,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1861
1864
|
};
|
|
1862
1865
|
const localVarHeaderParameter = {};
|
|
1863
1866
|
const localVarQueryParameter = {};
|
|
1864
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1865
1867
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1866
1868
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1867
1869
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -1877,6 +1879,35 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1877
1879
|
url: toPathString(localVarUrlObj),
|
|
1878
1880
|
options: localVarRequestOptions
|
|
1879
1881
|
};
|
|
1882
|
+
},
|
|
1883
|
+
updateCellVersion: async (cell, updateCellVersionRequest, options = {}) => {
|
|
1884
|
+
assertParamExists("updateCellVersion", "cell", cell);
|
|
1885
|
+
assertParamExists("updateCellVersion", "updateCellVersionRequest", updateCellVersionRequest);
|
|
1886
|
+
const localVarPath = `/cells/{cell}/update`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1887
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1888
|
+
let baseOptions;
|
|
1889
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1890
|
+
const localVarRequestOptions = {
|
|
1891
|
+
method: "PUT",
|
|
1892
|
+
...baseOptions,
|
|
1893
|
+
...options
|
|
1894
|
+
};
|
|
1895
|
+
const localVarHeaderParameter = {};
|
|
1896
|
+
const localVarQueryParameter = {};
|
|
1897
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1898
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1899
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1900
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1901
|
+
localVarRequestOptions.headers = {
|
|
1902
|
+
...localVarHeaderParameter,
|
|
1903
|
+
...headersFromBaseOptions,
|
|
1904
|
+
...options.headers
|
|
1905
|
+
};
|
|
1906
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCellVersionRequest, localVarRequestOptions, configuration);
|
|
1907
|
+
return {
|
|
1908
|
+
url: toPathString(localVarUrlObj),
|
|
1909
|
+
options: localVarRequestOptions
|
|
1910
|
+
};
|
|
1880
1911
|
}
|
|
1881
1912
|
};
|
|
1882
1913
|
};
|
|
@@ -1886,6 +1917,12 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1886
1917
|
const CellApiFp = function(configuration) {
|
|
1887
1918
|
const localVarAxiosParamCreator = CellApiAxiosParamCreator(configuration);
|
|
1888
1919
|
return {
|
|
1920
|
+
async checkCellVersionUpdate(cell, channel, options) {
|
|
1921
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkCellVersionUpdate(cell, channel, options);
|
|
1922
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1923
|
+
const localVarOperationServerBasePath = operationServerMap["CellApi.checkCellVersionUpdate"]?.[localVarOperationServerIndex]?.url;
|
|
1924
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1925
|
+
},
|
|
1889
1926
|
async deleteCell(cell, completionTimeout, options) {
|
|
1890
1927
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCell(cell, completionTimeout, options);
|
|
1891
1928
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -1927,6 +1964,12 @@ const CellApiFp = function(configuration) {
|
|
|
1927
1964
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1928
1965
|
const localVarOperationServerBasePath = operationServerMap["CellApi.updateCell"]?.[localVarOperationServerIndex]?.url;
|
|
1929
1966
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1967
|
+
},
|
|
1968
|
+
async updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
1969
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCellVersion(cell, updateCellVersionRequest, options);
|
|
1970
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1971
|
+
const localVarOperationServerBasePath = operationServerMap["CellApi.updateCellVersion"]?.[localVarOperationServerIndex]?.url;
|
|
1972
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1930
1973
|
}
|
|
1931
1974
|
};
|
|
1932
1975
|
};
|
|
@@ -1936,6 +1979,9 @@ const CellApiFp = function(configuration) {
|
|
|
1936
1979
|
const CellApiFactory = function(configuration, basePath, axios$1) {
|
|
1937
1980
|
const localVarFp = CellApiFp(configuration);
|
|
1938
1981
|
return {
|
|
1982
|
+
checkCellVersionUpdate(cell, channel, options) {
|
|
1983
|
+
return localVarFp.checkCellVersionUpdate(cell, channel, options).then((request) => request(axios$1, basePath));
|
|
1984
|
+
},
|
|
1939
1985
|
deleteCell(cell, completionTimeout, options) {
|
|
1940
1986
|
return localVarFp.deleteCell(cell, completionTimeout, options).then((request) => request(axios$1, basePath));
|
|
1941
1987
|
},
|
|
@@ -1956,6 +2002,9 @@ const CellApiFactory = function(configuration, basePath, axios$1) {
|
|
|
1956
2002
|
},
|
|
1957
2003
|
updateCell(cell, cell2, completionTimeout, options) {
|
|
1958
2004
|
return localVarFp.updateCell(cell, cell2, completionTimeout, options).then((request) => request(axios$1, basePath));
|
|
2005
|
+
},
|
|
2006
|
+
updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
2007
|
+
return localVarFp.updateCellVersion(cell, updateCellVersionRequest, options).then((request) => request(axios$1, basePath));
|
|
1959
2008
|
}
|
|
1960
2009
|
};
|
|
1961
2010
|
};
|
|
@@ -1963,6 +2012,17 @@ const CellApiFactory = function(configuration, basePath, axios$1) {
|
|
|
1963
2012
|
* CellApi - object-oriented interface
|
|
1964
2013
|
*/
|
|
1965
2014
|
var CellApi = class extends BaseAPI {
|
|
2015
|
+
/**
|
|
2016
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
2017
|
+
* @summary Check Cell Update
|
|
2018
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2019
|
+
* @param {ReleaseChannel} channel
|
|
2020
|
+
* @param {*} [options] Override http request option.
|
|
2021
|
+
* @throws {RequiredError}
|
|
2022
|
+
*/
|
|
2023
|
+
checkCellVersionUpdate(cell, channel, options) {
|
|
2024
|
+
return CellApiFp(this.configuration).checkCellVersionUpdate(cell, channel, options).then((request) => request(this.axios, this.basePath));
|
|
2025
|
+
}
|
|
1966
2026
|
/**
|
|
1967
2027
|
* Delete an entire cell.
|
|
1968
2028
|
* @summary Delete Cell
|
|
@@ -2037,6 +2097,17 @@ var CellApi = class extends BaseAPI {
|
|
|
2037
2097
|
updateCell(cell, cell2, completionTimeout, options) {
|
|
2038
2098
|
return CellApiFp(this.configuration).updateCell(cell, cell2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2039
2099
|
}
|
|
2100
|
+
/**
|
|
2101
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
2102
|
+
* @summary Update Cell Version
|
|
2103
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2104
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
2105
|
+
* @param {*} [options] Override http request option.
|
|
2106
|
+
* @throws {RequiredError}
|
|
2107
|
+
*/
|
|
2108
|
+
updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
2109
|
+
return CellApiFp(this.configuration).updateCellVersion(cell, updateCellVersionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2110
|
+
}
|
|
2040
2111
|
};
|
|
2041
2112
|
/**
|
|
2042
2113
|
* ControllerApi - axios parameter creator
|
|
@@ -2057,7 +2128,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2057
2128
|
};
|
|
2058
2129
|
const localVarHeaderParameter = {};
|
|
2059
2130
|
const localVarQueryParameter = {};
|
|
2060
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2061
2131
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2062
2132
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2063
2133
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -2087,7 +2157,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2087
2157
|
};
|
|
2088
2158
|
const localVarHeaderParameter = {};
|
|
2089
2159
|
const localVarQueryParameter = {};
|
|
2090
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2091
2160
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2092
2161
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2093
2162
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2116,7 +2185,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2116
2185
|
};
|
|
2117
2186
|
const localVarHeaderParameter = {};
|
|
2118
2187
|
const localVarQueryParameter = {};
|
|
2119
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2120
2188
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2121
2189
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2122
2190
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2145,7 +2213,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2145
2213
|
};
|
|
2146
2214
|
const localVarHeaderParameter = {};
|
|
2147
2215
|
const localVarQueryParameter = {};
|
|
2148
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2149
2216
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2150
2217
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2151
2218
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2174,7 +2241,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2174
2241
|
};
|
|
2175
2242
|
const localVarHeaderParameter = {};
|
|
2176
2243
|
const localVarQueryParameter = {};
|
|
2177
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2178
2244
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2179
2245
|
if (orientationType !== void 0) localVarQueryParameter["orientation_type"] = orientationType;
|
|
2180
2246
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2203,7 +2269,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2203
2269
|
};
|
|
2204
2270
|
const localVarHeaderParameter = {};
|
|
2205
2271
|
const localVarQueryParameter = {};
|
|
2206
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2207
2272
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2208
2273
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2209
2274
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2231,7 +2296,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2231
2296
|
};
|
|
2232
2297
|
const localVarHeaderParameter = {};
|
|
2233
2298
|
const localVarQueryParameter = {};
|
|
2234
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2235
2299
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2236
2300
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2237
2301
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2259,7 +2323,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2259
2323
|
};
|
|
2260
2324
|
const localVarHeaderParameter = {};
|
|
2261
2325
|
const localVarQueryParameter = {};
|
|
2262
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2263
2326
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2264
2327
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2265
2328
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2287,7 +2350,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2287
2350
|
};
|
|
2288
2351
|
const localVarHeaderParameter = {};
|
|
2289
2352
|
const localVarQueryParameter = {};
|
|
2290
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2291
2353
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2292
2354
|
if (orientationType !== void 0) localVarQueryParameter["orientation_type"] = orientationType;
|
|
2293
2355
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2315,7 +2377,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2315
2377
|
};
|
|
2316
2378
|
const localVarHeaderParameter = {};
|
|
2317
2379
|
const localVarQueryParameter = {};
|
|
2318
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2319
2380
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2320
2381
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2321
2382
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2344,7 +2405,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2344
2405
|
};
|
|
2345
2406
|
const localVarHeaderParameter = {};
|
|
2346
2407
|
const localVarQueryParameter = {};
|
|
2347
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2348
2408
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2349
2409
|
if (mode !== void 0) localVarQueryParameter["mode"] = mode;
|
|
2350
2410
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2373,7 +2433,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2373
2433
|
};
|
|
2374
2434
|
const localVarHeaderParameter = {};
|
|
2375
2435
|
const localVarQueryParameter = {};
|
|
2376
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2377
2436
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2378
2437
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
2379
2438
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2402,7 +2461,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2402
2461
|
};
|
|
2403
2462
|
const localVarHeaderParameter = {};
|
|
2404
2463
|
const localVarQueryParameter = {};
|
|
2405
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2406
2464
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2407
2465
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
2408
2466
|
if (addControllerTimeout !== void 0) localVarQueryParameter["add_controller_timeout"] = addControllerTimeout;
|
|
@@ -2433,7 +2491,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2433
2491
|
};
|
|
2434
2492
|
const localVarHeaderParameter = {};
|
|
2435
2493
|
const localVarQueryParameter = {};
|
|
2436
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2437
2494
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2438
2495
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2439
2496
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -2611,7 +2668,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2611
2668
|
return ControllerApiFp(this.configuration).addRobotController(cell, robotController, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2612
2669
|
}
|
|
2613
2670
|
/**
|
|
2614
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
2671
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
2615
2672
|
* @summary Clear Robot Controllers
|
|
2616
2673
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2617
2674
|
* @param {number} [completionTimeout]
|
|
@@ -2634,7 +2691,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2634
2691
|
return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2635
2692
|
}
|
|
2636
2693
|
/**
|
|
2637
|
-
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
2694
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
|
|
2638
2695
|
* @summary Description
|
|
2639
2696
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2640
2697
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2680,7 +2737,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2680
2737
|
return ControllerApiFp(this.configuration).getRobotController(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2681
2738
|
}
|
|
2682
2739
|
/**
|
|
2683
|
-
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
|
|
2740
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
|
|
2684
2741
|
* @summary Virtual Controller Configuration
|
|
2685
2742
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2686
2743
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2713,7 +2770,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2713
2770
|
return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2714
2771
|
}
|
|
2715
2772
|
/**
|
|
2716
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2773
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2717
2774
|
* @summary Set Default Mode
|
|
2718
2775
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2719
2776
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2725,7 +2782,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2725
2782
|
return ControllerApiFp(this.configuration).setDefaultMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
2726
2783
|
}
|
|
2727
2784
|
/**
|
|
2728
|
-
* <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
|
|
2785
|
+
* <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
|
|
2729
2786
|
* @summary Stream Free Drive
|
|
2730
2787
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2731
2788
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2737,7 +2794,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2737
2794
|
return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
2738
2795
|
}
|
|
2739
2796
|
/**
|
|
2740
|
-
* <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2797
|
+
* <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2741
2798
|
* @summary Stream State
|
|
2742
2799
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2743
2800
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2750,7 +2807,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2750
2807
|
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2751
2808
|
}
|
|
2752
2809
|
/**
|
|
2753
|
-
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
|
|
2810
|
+
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
|
|
2754
2811
|
* @summary Update Robot Controller
|
|
2755
2812
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2756
2813
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2782,7 +2839,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2782
2839
|
};
|
|
2783
2840
|
const localVarHeaderParameter = {};
|
|
2784
2841
|
const localVarQueryParameter = {};
|
|
2785
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2786
2842
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2787
2843
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2788
2844
|
if (direction !== void 0) localVarQueryParameter["direction"] = direction;
|
|
@@ -2814,7 +2870,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2814
2870
|
};
|
|
2815
2871
|
const localVarHeaderParameter = {};
|
|
2816
2872
|
const localVarQueryParameter = {};
|
|
2817
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2818
2873
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2819
2874
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2820
2875
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2844,7 +2899,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2844
2899
|
};
|
|
2845
2900
|
const localVarHeaderParameter = {};
|
|
2846
2901
|
const localVarQueryParameter = {};
|
|
2847
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2848
2902
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2849
2903
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2850
2904
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2874,7 +2928,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2874
2928
|
};
|
|
2875
2929
|
const localVarHeaderParameter = {};
|
|
2876
2930
|
const localVarQueryParameter = {};
|
|
2877
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2878
2931
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2879
2932
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2880
2933
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2904,7 +2957,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2904
2957
|
};
|
|
2905
2958
|
const localVarHeaderParameter = {};
|
|
2906
2959
|
const localVarQueryParameter = {};
|
|
2907
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2908
2960
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2909
2961
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2910
2962
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3003,7 +3055,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3003
3055
|
return ControllerInputsOutputsApiFp(this.configuration).listIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
3004
3056
|
}
|
|
3005
3057
|
/**
|
|
3006
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](listIODescriptions).
|
|
3058
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
|
|
3007
3059
|
* @summary Get Input/Output Values
|
|
3008
3060
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3009
3061
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3015,7 +3067,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3015
3067
|
return ControllerInputsOutputsApiFp(this.configuration).listIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3016
3068
|
}
|
|
3017
3069
|
/**
|
|
3018
|
-
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
3070
|
+
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
3019
3071
|
* @summary Set Output Values
|
|
3020
3072
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3021
3073
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3039,7 +3091,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3039
3091
|
return ControllerInputsOutputsApiFp(this.configuration).streamIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3040
3092
|
}
|
|
3041
3093
|
/**
|
|
3042
|
-
* Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
3094
|
+
* Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
3043
3095
|
* @summary Wait For
|
|
3044
3096
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3045
3097
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3070,7 +3122,6 @@ const JoggingApiAxiosParamCreator = function(configuration) {
|
|
|
3070
3122
|
};
|
|
3071
3123
|
const localVarHeaderParameter = {};
|
|
3072
3124
|
const localVarQueryParameter = {};
|
|
3073
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3074
3125
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3075
3126
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3076
3127
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3113,7 +3164,7 @@ const JoggingApiFactory = function(configuration, basePath, axios$1) {
|
|
|
3113
3164
|
*/
|
|
3114
3165
|
var JoggingApi = class extends BaseAPI {
|
|
3115
3166
|
/**
|
|
3116
|
-
* <!-- 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. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 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 or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `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](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.
|
|
3167
|
+
* <!-- 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. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 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](#/operations/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 or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `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.
|
|
3117
3168
|
* @summary Execute Jogging
|
|
3118
3169
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3119
3170
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3144,7 +3195,6 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3144
3195
|
};
|
|
3145
3196
|
const localVarHeaderParameter = {};
|
|
3146
3197
|
const localVarQueryParameter = {};
|
|
3147
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3148
3198
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3149
3199
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3150
3200
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3174,7 +3224,6 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3174
3224
|
};
|
|
3175
3225
|
const localVarHeaderParameter = {};
|
|
3176
3226
|
const localVarQueryParameter = {};
|
|
3177
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3178
3227
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3179
3228
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3180
3229
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3270,7 +3319,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3270
3319
|
};
|
|
3271
3320
|
const localVarHeaderParameter = {};
|
|
3272
3321
|
const localVarQueryParameter = {};
|
|
3273
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3274
3322
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3275
3323
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3276
3324
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3297,7 +3345,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3297
3345
|
};
|
|
3298
3346
|
const localVarHeaderParameter = {};
|
|
3299
3347
|
const localVarQueryParameter = {};
|
|
3300
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3301
3348
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3302
3349
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3303
3350
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3322,7 +3369,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3322
3369
|
};
|
|
3323
3370
|
const localVarHeaderParameter = {};
|
|
3324
3371
|
const localVarQueryParameter = {};
|
|
3325
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3326
3372
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3327
3373
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3328
3374
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3347,7 +3393,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3347
3393
|
};
|
|
3348
3394
|
const localVarHeaderParameter = {};
|
|
3349
3395
|
const localVarQueryParameter = {};
|
|
3350
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3351
3396
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3352
3397
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3353
3398
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3477,7 +3522,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3477
3522
|
};
|
|
3478
3523
|
const localVarHeaderParameter = {};
|
|
3479
3524
|
const localVarQueryParameter = {};
|
|
3480
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3481
3525
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3482
3526
|
if (responseCoordinateSystem !== void 0) localVarQueryParameter["response_coordinate_system"] = responseCoordinateSystem;
|
|
3483
3527
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3507,7 +3551,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3507
3551
|
};
|
|
3508
3552
|
const localVarHeaderParameter = {};
|
|
3509
3553
|
const localVarQueryParameter = {};
|
|
3510
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3511
3554
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3512
3555
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3513
3556
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3536,7 +3579,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3536
3579
|
};
|
|
3537
3580
|
const localVarHeaderParameter = {};
|
|
3538
3581
|
const localVarQueryParameter = {};
|
|
3539
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3540
3582
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3541
3583
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
3542
3584
|
if (responseCoordinateSystem !== void 0) localVarQueryParameter["response_coordinate_system"] = responseCoordinateSystem;
|
|
@@ -3659,7 +3701,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3659
3701
|
};
|
|
3660
3702
|
const localVarHeaderParameter = {};
|
|
3661
3703
|
const localVarQueryParameter = {};
|
|
3662
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3663
3704
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3664
3705
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3665
3706
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3686,7 +3727,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3686
3727
|
};
|
|
3687
3728
|
const localVarHeaderParameter = {};
|
|
3688
3729
|
const localVarQueryParameter = {};
|
|
3689
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3690
3730
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3691
3731
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3692
3732
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3713,7 +3753,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3713
3753
|
};
|
|
3714
3754
|
const localVarHeaderParameter = {};
|
|
3715
3755
|
const localVarQueryParameter = {};
|
|
3716
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3717
3756
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3718
3757
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3719
3758
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3738,7 +3777,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3738
3777
|
};
|
|
3739
3778
|
const localVarHeaderParameter = {};
|
|
3740
3779
|
const localVarQueryParameter = {};
|
|
3741
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3742
3780
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3743
3781
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3744
3782
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3765,7 +3803,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3765
3803
|
};
|
|
3766
3804
|
const localVarHeaderParameter = {};
|
|
3767
3805
|
const localVarQueryParameter = {};
|
|
3768
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3769
3806
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3770
3807
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3771
3808
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3847,9 +3884,9 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios$1) {
|
|
|
3847
3884
|
*/
|
|
3848
3885
|
var MotionGroupModelsApi = class extends BaseAPI {
|
|
3849
3886
|
/**
|
|
3850
|
-
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
3887
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
3851
3888
|
* @summary Get Collision Model
|
|
3852
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3889
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3853
3890
|
* @param {*} [options] Override http request option.
|
|
3854
3891
|
* @throws {RequiredError}
|
|
3855
3892
|
*/
|
|
@@ -3857,9 +3894,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3857
3894
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3858
3895
|
}
|
|
3859
3896
|
/**
|
|
3860
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3897
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
3861
3898
|
* @summary Download GLB Model
|
|
3862
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3899
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3863
3900
|
* @param {*} [options] Override http request option.
|
|
3864
3901
|
* @throws {RequiredError}
|
|
3865
3902
|
*/
|
|
@@ -3867,9 +3904,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3867
3904
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupGlbModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3868
3905
|
}
|
|
3869
3906
|
/**
|
|
3870
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
3907
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
3871
3908
|
* @summary Get Kinematics
|
|
3872
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3909
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3873
3910
|
* @param {*} [options] Override http request option.
|
|
3874
3911
|
* @throws {RequiredError}
|
|
3875
3912
|
*/
|
|
@@ -3886,9 +3923,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3886
3923
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(options).then((request) => request(this.axios, this.basePath));
|
|
3887
3924
|
}
|
|
3888
3925
|
/**
|
|
3889
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3926
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
3890
3927
|
* @summary Download USD Model
|
|
3891
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3928
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3892
3929
|
* @param {*} [options] Override http request option.
|
|
3893
3930
|
* @throws {RequiredError}
|
|
3894
3931
|
*/
|
|
@@ -3915,7 +3952,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3915
3952
|
};
|
|
3916
3953
|
const localVarHeaderParameter = {};
|
|
3917
3954
|
const localVarQueryParameter = {};
|
|
3918
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3919
3955
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3920
3956
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3921
3957
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3942,7 +3978,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3942
3978
|
};
|
|
3943
3979
|
const localVarHeaderParameter = {};
|
|
3944
3980
|
const localVarQueryParameter = {};
|
|
3945
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3946
3981
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3947
3982
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3948
3983
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3971,7 +4006,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3971
4006
|
};
|
|
3972
4007
|
const localVarHeaderParameter = {};
|
|
3973
4008
|
const localVarQueryParameter = {};
|
|
3974
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3975
4009
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3976
4010
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3977
4011
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4001,7 +4035,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
4001
4035
|
};
|
|
4002
4036
|
const localVarHeaderParameter = {};
|
|
4003
4037
|
const localVarQueryParameter = {};
|
|
4004
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4005
4038
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4006
4039
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4007
4040
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4122,57 +4155,108 @@ var ProgramApi = class extends BaseAPI {
|
|
|
4122
4155
|
* RobotConfigurationsApi - axios parameter creator
|
|
4123
4156
|
*/
|
|
4124
4157
|
const RobotConfigurationsApiAxiosParamCreator = function(configuration) {
|
|
4125
|
-
return {
|
|
4126
|
-
|
|
4127
|
-
|
|
4128
|
-
|
|
4129
|
-
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
|
|
4133
|
-
|
|
4134
|
-
|
|
4135
|
-
|
|
4136
|
-
|
|
4137
|
-
|
|
4138
|
-
|
|
4139
|
-
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
|
|
4145
|
-
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
|
|
4149
|
-
|
|
4158
|
+
return {
|
|
4159
|
+
getControllerConfigFromArpScan: async (robotControllerConfigurationRequest, options = {}) => {
|
|
4160
|
+
assertParamExists("getControllerConfigFromArpScan", "robotControllerConfigurationRequest", robotControllerConfigurationRequest);
|
|
4161
|
+
const localVarUrlObj = new URL(`/experimental/system/network/controllers`, DUMMY_BASE_URL);
|
|
4162
|
+
let baseOptions;
|
|
4163
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
4164
|
+
const localVarRequestOptions = {
|
|
4165
|
+
method: "POST",
|
|
4166
|
+
...baseOptions,
|
|
4167
|
+
...options
|
|
4168
|
+
};
|
|
4169
|
+
const localVarHeaderParameter = {};
|
|
4170
|
+
const localVarQueryParameter = {};
|
|
4171
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4172
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4173
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4174
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4175
|
+
localVarRequestOptions.headers = {
|
|
4176
|
+
...localVarHeaderParameter,
|
|
4177
|
+
...headersFromBaseOptions,
|
|
4178
|
+
...options.headers
|
|
4179
|
+
};
|
|
4180
|
+
localVarRequestOptions.data = serializeDataIfNeeded(robotControllerConfigurationRequest, localVarRequestOptions, configuration);
|
|
4181
|
+
return {
|
|
4182
|
+
url: toPathString(localVarUrlObj),
|
|
4183
|
+
options: localVarRequestOptions
|
|
4184
|
+
};
|
|
4185
|
+
},
|
|
4186
|
+
getRobotConfigurations: async (options = {}) => {
|
|
4187
|
+
const localVarUrlObj = new URL(`/robot-configurations`, DUMMY_BASE_URL);
|
|
4188
|
+
let baseOptions;
|
|
4189
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
4190
|
+
const localVarRequestOptions = {
|
|
4191
|
+
method: "GET",
|
|
4192
|
+
...baseOptions,
|
|
4193
|
+
...options
|
|
4194
|
+
};
|
|
4195
|
+
const localVarHeaderParameter = {};
|
|
4196
|
+
const localVarQueryParameter = {};
|
|
4197
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4198
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4199
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4200
|
+
localVarRequestOptions.headers = {
|
|
4201
|
+
...localVarHeaderParameter,
|
|
4202
|
+
...headersFromBaseOptions,
|
|
4203
|
+
...options.headers
|
|
4204
|
+
};
|
|
4205
|
+
return {
|
|
4206
|
+
url: toPathString(localVarUrlObj),
|
|
4207
|
+
options: localVarRequestOptions
|
|
4208
|
+
};
|
|
4209
|
+
}
|
|
4210
|
+
};
|
|
4150
4211
|
};
|
|
4151
4212
|
/**
|
|
4152
4213
|
* RobotConfigurationsApi - functional programming interface
|
|
4153
4214
|
*/
|
|
4154
4215
|
const RobotConfigurationsApiFp = function(configuration) {
|
|
4155
4216
|
const localVarAxiosParamCreator = RobotConfigurationsApiAxiosParamCreator(configuration);
|
|
4156
|
-
return {
|
|
4157
|
-
|
|
4158
|
-
|
|
4159
|
-
|
|
4160
|
-
|
|
4161
|
-
|
|
4217
|
+
return {
|
|
4218
|
+
async getControllerConfigFromArpScan(robotControllerConfigurationRequest, options) {
|
|
4219
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getControllerConfigFromArpScan(robotControllerConfigurationRequest, options);
|
|
4220
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4221
|
+
const localVarOperationServerBasePath = operationServerMap["RobotConfigurationsApi.getControllerConfigFromArpScan"]?.[localVarOperationServerIndex]?.url;
|
|
4222
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
4223
|
+
},
|
|
4224
|
+
async getRobotConfigurations(options) {
|
|
4225
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRobotConfigurations(options);
|
|
4226
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4227
|
+
const localVarOperationServerBasePath = operationServerMap["RobotConfigurationsApi.getRobotConfigurations"]?.[localVarOperationServerIndex]?.url;
|
|
4228
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
4229
|
+
}
|
|
4230
|
+
};
|
|
4162
4231
|
};
|
|
4163
4232
|
/**
|
|
4164
4233
|
* RobotConfigurationsApi - factory interface
|
|
4165
4234
|
*/
|
|
4166
4235
|
const RobotConfigurationsApiFactory = function(configuration, basePath, axios$1) {
|
|
4167
4236
|
const localVarFp = RobotConfigurationsApiFp(configuration);
|
|
4168
|
-
return {
|
|
4169
|
-
|
|
4170
|
-
|
|
4237
|
+
return {
|
|
4238
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest, options) {
|
|
4239
|
+
return localVarFp.getControllerConfigFromArpScan(robotControllerConfigurationRequest, options).then((request) => request(axios$1, basePath));
|
|
4240
|
+
},
|
|
4241
|
+
getRobotConfigurations(options) {
|
|
4242
|
+
return localVarFp.getRobotConfigurations(options).then((request) => request(axios$1, basePath));
|
|
4243
|
+
}
|
|
4244
|
+
};
|
|
4171
4245
|
};
|
|
4172
4246
|
/**
|
|
4173
4247
|
* RobotConfigurationsApi - object-oriented interface
|
|
4174
4248
|
*/
|
|
4175
4249
|
var RobotConfigurationsApi = class extends BaseAPI {
|
|
4250
|
+
/**
|
|
4251
|
+
* Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
|
|
4252
|
+
* @summary Robot Controller Configurations
|
|
4253
|
+
* @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
|
|
4254
|
+
* @param {*} [options] Override http request option.
|
|
4255
|
+
* @throws {RequiredError}
|
|
4256
|
+
*/
|
|
4257
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest, options) {
|
|
4258
|
+
return RobotConfigurationsApiFp(this.configuration).getControllerConfigFromArpScan(robotControllerConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4259
|
+
}
|
|
4176
4260
|
/**
|
|
4177
4261
|
* Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
4178
4262
|
* @summary List Robot Configurations
|
|
@@ -4202,7 +4286,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4202
4286
|
};
|
|
4203
4287
|
const localVarHeaderParameter = {};
|
|
4204
4288
|
const localVarQueryParameter = {};
|
|
4205
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4206
4289
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4207
4290
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4208
4291
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4230,7 +4313,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4230
4313
|
};
|
|
4231
4314
|
const localVarHeaderParameter = {};
|
|
4232
4315
|
const localVarQueryParameter = {};
|
|
4233
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4234
4316
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4235
4317
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4236
4318
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4258,7 +4340,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4258
4340
|
};
|
|
4259
4341
|
const localVarHeaderParameter = {};
|
|
4260
4342
|
const localVarQueryParameter = {};
|
|
4261
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4262
4343
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4263
4344
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4264
4345
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4286,7 +4367,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4286
4367
|
};
|
|
4287
4368
|
const localVarHeaderParameter = {};
|
|
4288
4369
|
const localVarQueryParameter = {};
|
|
4289
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4290
4370
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4291
4371
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4292
4372
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4314,7 +4394,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4314
4394
|
};
|
|
4315
4395
|
const localVarHeaderParameter = {};
|
|
4316
4396
|
const localVarQueryParameter = {};
|
|
4317
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4318
4397
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4319
4398
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4320
4399
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4342,7 +4421,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4342
4421
|
};
|
|
4343
4422
|
const localVarHeaderParameter = {};
|
|
4344
4423
|
const localVarQueryParameter = {};
|
|
4345
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4346
4424
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4347
4425
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4348
4426
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4369,7 +4447,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4369
4447
|
};
|
|
4370
4448
|
const localVarHeaderParameter = {};
|
|
4371
4449
|
const localVarQueryParameter = {};
|
|
4372
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4373
4450
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4374
4451
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4375
4452
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4396,7 +4473,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4396
4473
|
};
|
|
4397
4474
|
const localVarHeaderParameter = {};
|
|
4398
4475
|
const localVarQueryParameter = {};
|
|
4399
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4400
4476
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4401
4477
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4402
4478
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4423,7 +4499,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4423
4499
|
};
|
|
4424
4500
|
const localVarHeaderParameter = {};
|
|
4425
4501
|
const localVarQueryParameter = {};
|
|
4426
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4427
4502
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4428
4503
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4429
4504
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4450,7 +4525,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4450
4525
|
};
|
|
4451
4526
|
const localVarHeaderParameter = {};
|
|
4452
4527
|
const localVarQueryParameter = {};
|
|
4453
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4454
4528
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4455
4529
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4456
4530
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4477,7 +4551,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4477
4551
|
};
|
|
4478
4552
|
const localVarHeaderParameter = {};
|
|
4479
4553
|
const localVarQueryParameter = {};
|
|
4480
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4481
4554
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4482
4555
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4483
4556
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4504,7 +4577,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4504
4577
|
};
|
|
4505
4578
|
const localVarHeaderParameter = {};
|
|
4506
4579
|
const localVarQueryParameter = {};
|
|
4507
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4508
4580
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4509
4581
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4510
4582
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4533,7 +4605,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4533
4605
|
};
|
|
4534
4606
|
const localVarHeaderParameter = {};
|
|
4535
4607
|
const localVarQueryParameter = {};
|
|
4536
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4537
4608
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4538
4609
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4539
4610
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4564,7 +4635,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4564
4635
|
};
|
|
4565
4636
|
const localVarHeaderParameter = {};
|
|
4566
4637
|
const localVarQueryParameter = {};
|
|
4567
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4568
4638
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4569
4639
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4570
4640
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4595,7 +4665,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4595
4665
|
};
|
|
4596
4666
|
const localVarHeaderParameter = {};
|
|
4597
4667
|
const localVarQueryParameter = {};
|
|
4598
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4599
4668
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4600
4669
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4601
4670
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4950,7 +5019,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4950
5019
|
};
|
|
4951
5020
|
const localVarHeaderParameter = {};
|
|
4952
5021
|
const localVarQueryParameter = {};
|
|
4953
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4954
5022
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4955
5023
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4956
5024
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4978,7 +5046,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4978
5046
|
};
|
|
4979
5047
|
const localVarHeaderParameter = {};
|
|
4980
5048
|
const localVarQueryParameter = {};
|
|
4981
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4982
5049
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4983
5050
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4984
5051
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5005,7 +5072,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5005
5072
|
};
|
|
5006
5073
|
const localVarHeaderParameter = {};
|
|
5007
5074
|
const localVarQueryParameter = {};
|
|
5008
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5009
5075
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5010
5076
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5011
5077
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5032,7 +5098,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5032
5098
|
};
|
|
5033
5099
|
const localVarHeaderParameter = {};
|
|
5034
5100
|
const localVarQueryParameter = {};
|
|
5035
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5036
5101
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5037
5102
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5038
5103
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5061,7 +5126,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5061
5126
|
};
|
|
5062
5127
|
const localVarHeaderParameter = {};
|
|
5063
5128
|
const localVarQueryParameter = {};
|
|
5064
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5065
5129
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5066
5130
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
5067
5131
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5217,7 +5281,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5217
5281
|
};
|
|
5218
5282
|
const localVarHeaderParameter = {};
|
|
5219
5283
|
const localVarQueryParameter = {};
|
|
5220
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5221
5284
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5222
5285
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5223
5286
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5245,7 +5308,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5245
5308
|
};
|
|
5246
5309
|
const localVarHeaderParameter = {};
|
|
5247
5310
|
const localVarQueryParameter = {};
|
|
5248
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5249
5311
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5250
5312
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5251
5313
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5273,7 +5335,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5273
5335
|
};
|
|
5274
5336
|
const localVarHeaderParameter = {};
|
|
5275
5337
|
const localVarQueryParameter = {};
|
|
5276
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5277
5338
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5278
5339
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5279
5340
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5301,7 +5362,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5301
5362
|
};
|
|
5302
5363
|
const localVarHeaderParameter = {};
|
|
5303
5364
|
const localVarQueryParameter = {};
|
|
5304
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5305
5365
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5306
5366
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5307
5367
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5328,7 +5388,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5328
5388
|
};
|
|
5329
5389
|
const localVarHeaderParameter = {};
|
|
5330
5390
|
const localVarQueryParameter = {};
|
|
5331
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5332
5391
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5333
5392
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5334
5393
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5357,7 +5416,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5357
5416
|
const localVarHeaderParameter = {};
|
|
5358
5417
|
const localVarQueryParameter = {};
|
|
5359
5418
|
const localVarFormParams = new (configuration && configuration.formDataCtor || FormData)();
|
|
5360
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5361
5419
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5362
5420
|
if (anyValue !== void 0) localVarFormParams.append("any_value", new Blob([JSON.stringify(anyValue)], { type: "application/json" }));
|
|
5363
5421
|
localVarHeaderParameter["Content-Type"] = "multipart/form-data";
|
|
@@ -5505,7 +5563,7 @@ var StoreObjectApi = class extends BaseAPI {
|
|
|
5505
5563
|
return StoreObjectApiFp(this.configuration).listAllObjectKeys(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5506
5564
|
}
|
|
5507
5565
|
/**
|
|
5508
|
-
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
5566
|
+
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
5509
5567
|
* @summary Store Object
|
|
5510
5568
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5511
5569
|
* @param {string} key
|
|
@@ -5534,7 +5592,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5534
5592
|
};
|
|
5535
5593
|
const localVarHeaderParameter = {};
|
|
5536
5594
|
const localVarQueryParameter = {};
|
|
5537
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5538
5595
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5539
5596
|
if (resources) localVarQueryParameter["resources"] = resources.join(COLLECTION_FORMATS.csv);
|
|
5540
5597
|
if (metadata !== void 0) localVarQueryParameter["metadata"] = metadata;
|
|
@@ -5562,7 +5619,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5562
5619
|
};
|
|
5563
5620
|
const localVarHeaderParameter = {};
|
|
5564
5621
|
const localVarQueryParameter = {};
|
|
5565
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5566
5622
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5567
5623
|
if (channel !== void 0) localVarQueryParameter["channel"] = channel;
|
|
5568
5624
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5588,7 +5644,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5588
5644
|
};
|
|
5589
5645
|
const localVarHeaderParameter = {};
|
|
5590
5646
|
const localVarQueryParameter = {};
|
|
5591
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5592
5647
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5593
5648
|
if (_interface !== void 0) localVarQueryParameter["interface"] = _interface;
|
|
5594
5649
|
if (cidr !== void 0) localVarQueryParameter["cidr"] = cidr;
|
|
@@ -5617,7 +5672,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5617
5672
|
};
|
|
5618
5673
|
const localVarHeaderParameter = {};
|
|
5619
5674
|
const localVarQueryParameter = {};
|
|
5620
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5621
5675
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5622
5676
|
if (operationId !== void 0) localVarQueryParameter["operation_id"] = operationId;
|
|
5623
5677
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5643,7 +5697,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5643
5697
|
};
|
|
5644
5698
|
const localVarHeaderParameter = {};
|
|
5645
5699
|
const localVarQueryParameter = {};
|
|
5646
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5647
5700
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5648
5701
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5649
5702
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5668,7 +5721,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5668
5721
|
};
|
|
5669
5722
|
const localVarHeaderParameter = {};
|
|
5670
5723
|
const localVarQueryParameter = {};
|
|
5671
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5672
5724
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5673
5725
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5674
5726
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5693,7 +5745,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5693
5745
|
};
|
|
5694
5746
|
const localVarHeaderParameter = {};
|
|
5695
5747
|
const localVarQueryParameter = {};
|
|
5696
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5697
5748
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5698
5749
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5699
5750
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5718,7 +5769,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5718
5769
|
};
|
|
5719
5770
|
const localVarHeaderParameter = {};
|
|
5720
5771
|
const localVarQueryParameter = {};
|
|
5721
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5722
5772
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5723
5773
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5724
5774
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5743,7 +5793,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5743
5793
|
};
|
|
5744
5794
|
const localVarHeaderParameter = {};
|
|
5745
5795
|
const localVarQueryParameter = {};
|
|
5746
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5747
5796
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5748
5797
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5749
5798
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5768,7 +5817,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5768
5817
|
};
|
|
5769
5818
|
const localVarHeaderParameter = {};
|
|
5770
5819
|
const localVarQueryParameter = {};
|
|
5771
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5772
5820
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5773
5821
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5774
5822
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5794,7 +5842,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5794
5842
|
};
|
|
5795
5843
|
const localVarHeaderParameter = {};
|
|
5796
5844
|
const localVarQueryParameter = {};
|
|
5797
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5798
5845
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5799
5846
|
if (resources) localVarQueryParameter["resources"] = resources.join(COLLECTION_FORMATS.csv);
|
|
5800
5847
|
localVarHeaderParameter["Content-Type"] = "application/gzip";
|
|
@@ -5823,7 +5870,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5823
5870
|
};
|
|
5824
5871
|
const localVarHeaderParameter = {};
|
|
5825
5872
|
const localVarQueryParameter = {};
|
|
5826
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5827
5873
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5828
5874
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
5829
5875
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6078,7 +6124,7 @@ var SystemApi = class extends BaseAPI {
|
|
|
6078
6124
|
return SystemApiFp(this.configuration).restoreConfiguration(body, resources, options).then((request) => request(this.axios, this.basePath));
|
|
6079
6125
|
}
|
|
6080
6126
|
/**
|
|
6081
|
-
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
|
|
6127
|
+
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
|
|
6082
6128
|
* @summary Update Wandelbots NOVA version
|
|
6083
6129
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
6084
6130
|
* @param {*} [options] Override http request option.
|
|
@@ -6108,7 +6154,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6108
6154
|
};
|
|
6109
6155
|
const localVarHeaderParameter = {};
|
|
6110
6156
|
const localVarQueryParameter = {};
|
|
6111
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6112
6157
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6113
6158
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6114
6159
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6138,7 +6183,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6138
6183
|
};
|
|
6139
6184
|
const localVarHeaderParameter = {};
|
|
6140
6185
|
const localVarQueryParameter = {};
|
|
6141
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6142
6186
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6143
6187
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6144
6188
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6167,7 +6211,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6167
6211
|
};
|
|
6168
6212
|
const localVarHeaderParameter = {};
|
|
6169
6213
|
const localVarQueryParameter = {};
|
|
6170
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6171
6214
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6172
6215
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6173
6216
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6196,7 +6239,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6196
6239
|
};
|
|
6197
6240
|
const localVarHeaderParameter = {};
|
|
6198
6241
|
const localVarQueryParameter = {};
|
|
6199
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6200
6242
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6201
6243
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6202
6244
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6224,7 +6266,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6224
6266
|
};
|
|
6225
6267
|
const localVarHeaderParameter = {};
|
|
6226
6268
|
const localVarQueryParameter = {};
|
|
6227
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6228
6269
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6229
6270
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6230
6271
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6306,7 +6347,7 @@ const TrajectoryCachingApiFactory = function(configuration, basePath, axios$1) {
|
|
|
6306
6347
|
*/
|
|
6307
6348
|
var TrajectoryCachingApi = class extends BaseAPI {
|
|
6308
6349
|
/**
|
|
6309
|
-
* Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
6350
|
+
* Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](#/operations/executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](#/operations/listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint.
|
|
6310
6351
|
* @summary Add Trajectory
|
|
6311
6352
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6312
6353
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6329,7 +6370,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6329
6370
|
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
6330
6371
|
}
|
|
6331
6372
|
/**
|
|
6332
|
-
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6373
|
+
* Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6333
6374
|
* @summary Delete Trajectory
|
|
6334
6375
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6335
6376
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6341,7 +6382,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6341
6382
|
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
6342
6383
|
}
|
|
6343
6384
|
/**
|
|
6344
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
6385
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
6345
6386
|
* @summary Get Trajectory
|
|
6346
6387
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6347
6388
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6353,7 +6394,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6353
6394
|
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
6354
6395
|
}
|
|
6355
6396
|
/**
|
|
6356
|
-
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
6397
|
+
* List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
6357
6398
|
* @summary List Trajectories
|
|
6358
6399
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6359
6400
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6383,7 +6424,6 @@ const TrajectoryExecutionApiAxiosParamCreator = function(configuration) {
|
|
|
6383
6424
|
};
|
|
6384
6425
|
const localVarHeaderParameter = {};
|
|
6385
6426
|
const localVarQueryParameter = {};
|
|
6386
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6387
6427
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6388
6428
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6389
6429
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6426,7 +6466,7 @@ const TrajectoryExecutionApiFactory = function(configuration, basePath, axios$1)
|
|
|
6426
6466
|
*/
|
|
6427
6467
|
var TrajectoryExecutionApi = class extends BaseAPI {
|
|
6428
6468
|
/**
|
|
6429
|
-
* <!-- 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
|
|
6469
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](#/operations/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](#/operations/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](#/operations/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](#/operations/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.
|
|
6430
6470
|
* @summary Execute Trajectory
|
|
6431
6471
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6432
6472
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6443,6 +6483,35 @@ var TrajectoryExecutionApi = class extends BaseAPI {
|
|
|
6443
6483
|
*/
|
|
6444
6484
|
const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
6445
6485
|
return {
|
|
6486
|
+
mergeTrajectories: async (cell, mergeTrajectoriesRequest, options = {}) => {
|
|
6487
|
+
assertParamExists("mergeTrajectories", "cell", cell);
|
|
6488
|
+
assertParamExists("mergeTrajectories", "mergeTrajectoriesRequest", mergeTrajectoriesRequest);
|
|
6489
|
+
const localVarPath = `/experimental/cells/{cell}/trajectory-planning/merge-trajectories`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
6490
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6491
|
+
let baseOptions;
|
|
6492
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6493
|
+
const localVarRequestOptions = {
|
|
6494
|
+
method: "POST",
|
|
6495
|
+
...baseOptions,
|
|
6496
|
+
...options
|
|
6497
|
+
};
|
|
6498
|
+
const localVarHeaderParameter = {};
|
|
6499
|
+
const localVarQueryParameter = {};
|
|
6500
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6501
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6502
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6503
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6504
|
+
localVarRequestOptions.headers = {
|
|
6505
|
+
...localVarHeaderParameter,
|
|
6506
|
+
...headersFromBaseOptions,
|
|
6507
|
+
...options.headers
|
|
6508
|
+
};
|
|
6509
|
+
localVarRequestOptions.data = serializeDataIfNeeded(mergeTrajectoriesRequest, localVarRequestOptions, configuration);
|
|
6510
|
+
return {
|
|
6511
|
+
url: toPathString(localVarUrlObj),
|
|
6512
|
+
options: localVarRequestOptions
|
|
6513
|
+
};
|
|
6514
|
+
},
|
|
6446
6515
|
planCollisionFree: async (cell, planCollisionFreeRequest, options = {}) => {
|
|
6447
6516
|
assertParamExists("planCollisionFree", "cell", cell);
|
|
6448
6517
|
assertParamExists("planCollisionFree", "planCollisionFreeRequest", planCollisionFreeRequest);
|
|
@@ -6457,7 +6526,6 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6457
6526
|
};
|
|
6458
6527
|
const localVarHeaderParameter = {};
|
|
6459
6528
|
const localVarQueryParameter = {};
|
|
6460
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6461
6529
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6462
6530
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6463
6531
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6487,7 +6555,6 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6487
6555
|
};
|
|
6488
6556
|
const localVarHeaderParameter = {};
|
|
6489
6557
|
const localVarQueryParameter = {};
|
|
6490
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6491
6558
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6492
6559
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6493
6560
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6511,6 +6578,12 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6511
6578
|
const TrajectoryPlanningApiFp = function(configuration) {
|
|
6512
6579
|
const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration);
|
|
6513
6580
|
return {
|
|
6581
|
+
async mergeTrajectories(cell, mergeTrajectoriesRequest, options) {
|
|
6582
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.mergeTrajectories(cell, mergeTrajectoriesRequest, options);
|
|
6583
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6584
|
+
const localVarOperationServerBasePath = operationServerMap["TrajectoryPlanningApi.mergeTrajectories"]?.[localVarOperationServerIndex]?.url;
|
|
6585
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
6586
|
+
},
|
|
6514
6587
|
async planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
6515
6588
|
const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
|
|
6516
6589
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -6531,6 +6604,9 @@ const TrajectoryPlanningApiFp = function(configuration) {
|
|
|
6531
6604
|
const TrajectoryPlanningApiFactory = function(configuration, basePath, axios$1) {
|
|
6532
6605
|
const localVarFp = TrajectoryPlanningApiFp(configuration);
|
|
6533
6606
|
return {
|
|
6607
|
+
mergeTrajectories(cell, mergeTrajectoriesRequest, options) {
|
|
6608
|
+
return localVarFp.mergeTrajectories(cell, mergeTrajectoriesRequest, options).then((request) => request(axios$1, basePath));
|
|
6609
|
+
},
|
|
6534
6610
|
planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
6535
6611
|
return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios$1, basePath));
|
|
6536
6612
|
},
|
|
@@ -6544,7 +6620,18 @@ const TrajectoryPlanningApiFactory = function(configuration, basePath, axios$1)
|
|
|
6544
6620
|
*/
|
|
6545
6621
|
var TrajectoryPlanningApi = class extends BaseAPI {
|
|
6546
6622
|
/**
|
|
6547
|
-
*
|
|
6623
|
+
* <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
|
|
6624
|
+
* @summary Merge Trajectories
|
|
6625
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6626
|
+
* @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
|
|
6627
|
+
* @param {*} [options] Override http request option.
|
|
6628
|
+
* @throws {RequiredError}
|
|
6629
|
+
*/
|
|
6630
|
+
mergeTrajectories(cell, mergeTrajectoriesRequest, options) {
|
|
6631
|
+
return TrajectoryPlanningApiFp(this.configuration).mergeTrajectories(cell, mergeTrajectoriesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6632
|
+
}
|
|
6633
|
+
/**
|
|
6634
|
+
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
6548
6635
|
* @summary Plan Collision-Free Trajectory
|
|
6549
6636
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6550
6637
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -6555,7 +6642,7 @@ var TrajectoryPlanningApi = class extends BaseAPI {
|
|
|
6555
6642
|
return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6556
6643
|
}
|
|
6557
6644
|
/**
|
|
6558
|
-
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
6645
|
+
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
6559
6646
|
* @summary Plan Trajectory
|
|
6560
6647
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6561
6648
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -6581,7 +6668,6 @@ const VersionApiAxiosParamCreator = function(configuration) {
|
|
|
6581
6668
|
};
|
|
6582
6669
|
const localVarHeaderParameter = {};
|
|
6583
6670
|
const localVarQueryParameter = {};
|
|
6584
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6585
6671
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6586
6672
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6587
6673
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6652,7 +6738,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6652
6738
|
};
|
|
6653
6739
|
const localVarHeaderParameter = {};
|
|
6654
6740
|
const localVarQueryParameter = {};
|
|
6655
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6656
6741
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6657
6742
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6658
6743
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6668,6 +6753,36 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6668
6753
|
options: localVarRequestOptions
|
|
6669
6754
|
};
|
|
6670
6755
|
},
|
|
6756
|
+
addVirtualControllerMotionGroup: async (cell, controller, addVirtualControllerMotionGroupRequest, options = {}) => {
|
|
6757
|
+
assertParamExists("addVirtualControllerMotionGroup", "cell", cell);
|
|
6758
|
+
assertParamExists("addVirtualControllerMotionGroup", "controller", controller);
|
|
6759
|
+
assertParamExists("addVirtualControllerMotionGroup", "addVirtualControllerMotionGroupRequest", addVirtualControllerMotionGroupRequest);
|
|
6760
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
|
|
6761
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6762
|
+
let baseOptions;
|
|
6763
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6764
|
+
const localVarRequestOptions = {
|
|
6765
|
+
method: "POST",
|
|
6766
|
+
...baseOptions,
|
|
6767
|
+
...options
|
|
6768
|
+
};
|
|
6769
|
+
const localVarHeaderParameter = {};
|
|
6770
|
+
const localVarQueryParameter = {};
|
|
6771
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6772
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6773
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6774
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6775
|
+
localVarRequestOptions.headers = {
|
|
6776
|
+
...localVarHeaderParameter,
|
|
6777
|
+
...headersFromBaseOptions,
|
|
6778
|
+
...options.headers
|
|
6779
|
+
};
|
|
6780
|
+
localVarRequestOptions.data = serializeDataIfNeeded(addVirtualControllerMotionGroupRequest, localVarRequestOptions, configuration);
|
|
6781
|
+
return {
|
|
6782
|
+
url: toPathString(localVarUrlObj),
|
|
6783
|
+
options: localVarRequestOptions
|
|
6784
|
+
};
|
|
6785
|
+
},
|
|
6671
6786
|
addVirtualControllerTcp: async (cell, controller, motionGroup, tcp, robotTcpData, options = {}) => {
|
|
6672
6787
|
assertParamExists("addVirtualControllerTcp", "cell", cell);
|
|
6673
6788
|
assertParamExists("addVirtualControllerTcp", "controller", controller);
|
|
@@ -6685,7 +6800,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6685
6800
|
};
|
|
6686
6801
|
const localVarHeaderParameter = {};
|
|
6687
6802
|
const localVarQueryParameter = {};
|
|
6688
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6689
6803
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6690
6804
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6691
6805
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6716,7 +6830,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6716
6830
|
};
|
|
6717
6831
|
const localVarHeaderParameter = {};
|
|
6718
6832
|
const localVarQueryParameter = {};
|
|
6719
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6720
6833
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6721
6834
|
if (deleteDependent !== void 0) localVarQueryParameter["delete_dependent"] = deleteDependent;
|
|
6722
6835
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6731,6 +6844,34 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6731
6844
|
options: localVarRequestOptions
|
|
6732
6845
|
};
|
|
6733
6846
|
},
|
|
6847
|
+
deleteVirtualControllerMotionGroup: async (cell, controller, motionGroup, options = {}) => {
|
|
6848
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "cell", cell);
|
|
6849
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "controller", controller);
|
|
6850
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "motionGroup", motionGroup);
|
|
6851
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller))).replace(`{motion-group}`, encodeURIComponent(String(motionGroup)));
|
|
6852
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6853
|
+
let baseOptions;
|
|
6854
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6855
|
+
const localVarRequestOptions = {
|
|
6856
|
+
method: "DELETE",
|
|
6857
|
+
...baseOptions,
|
|
6858
|
+
...options
|
|
6859
|
+
};
|
|
6860
|
+
const localVarHeaderParameter = {};
|
|
6861
|
+
const localVarQueryParameter = {};
|
|
6862
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6863
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6864
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6865
|
+
localVarRequestOptions.headers = {
|
|
6866
|
+
...localVarHeaderParameter,
|
|
6867
|
+
...headersFromBaseOptions,
|
|
6868
|
+
...options.headers
|
|
6869
|
+
};
|
|
6870
|
+
return {
|
|
6871
|
+
url: toPathString(localVarUrlObj),
|
|
6872
|
+
options: localVarRequestOptions
|
|
6873
|
+
};
|
|
6874
|
+
},
|
|
6734
6875
|
deleteVirtualControllerTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
|
|
6735
6876
|
assertParamExists("deleteVirtualControllerTcp", "cell", cell);
|
|
6736
6877
|
assertParamExists("deleteVirtualControllerTcp", "controller", controller);
|
|
@@ -6747,7 +6888,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6747
6888
|
};
|
|
6748
6889
|
const localVarHeaderParameter = {};
|
|
6749
6890
|
const localVarQueryParameter = {};
|
|
6750
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6751
6891
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6752
6892
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6753
6893
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6775,7 +6915,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6775
6915
|
};
|
|
6776
6916
|
const localVarHeaderParameter = {};
|
|
6777
6917
|
const localVarQueryParameter = {};
|
|
6778
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6779
6918
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6780
6919
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6781
6920
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6804,7 +6943,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6804
6943
|
};
|
|
6805
6944
|
const localVarHeaderParameter = {};
|
|
6806
6945
|
const localVarQueryParameter = {};
|
|
6807
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6808
6946
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6809
6947
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6810
6948
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6832,7 +6970,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6832
6970
|
};
|
|
6833
6971
|
const localVarHeaderParameter = {};
|
|
6834
6972
|
const localVarQueryParameter = {};
|
|
6835
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6836
6973
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6837
6974
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6838
6975
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6860,7 +6997,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6860
6997
|
};
|
|
6861
6998
|
const localVarHeaderParameter = {};
|
|
6862
6999
|
const localVarQueryParameter = {};
|
|
6863
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6864
7000
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6865
7001
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6866
7002
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6889,7 +7025,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6889
7025
|
};
|
|
6890
7026
|
const localVarHeaderParameter = {};
|
|
6891
7027
|
const localVarQueryParameter = {};
|
|
6892
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6893
7028
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6894
7029
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6895
7030
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6917,7 +7052,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6917
7052
|
};
|
|
6918
7053
|
const localVarHeaderParameter = {};
|
|
6919
7054
|
const localVarQueryParameter = {};
|
|
6920
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6921
7055
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6922
7056
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6923
7057
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6946,7 +7080,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6946
7080
|
};
|
|
6947
7081
|
const localVarHeaderParameter = {};
|
|
6948
7082
|
const localVarQueryParameter = {};
|
|
6949
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6950
7083
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6951
7084
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6952
7085
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6974,7 +7107,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6974
7107
|
};
|
|
6975
7108
|
const localVarHeaderParameter = {};
|
|
6976
7109
|
const localVarQueryParameter = {};
|
|
6977
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6978
7110
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6979
7111
|
if (active !== void 0) localVarQueryParameter["active"] = active;
|
|
6980
7112
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7005,7 +7137,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7005
7137
|
};
|
|
7006
7138
|
const localVarHeaderParameter = {};
|
|
7007
7139
|
const localVarQueryParameter = {};
|
|
7008
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7009
7140
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7010
7141
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7011
7142
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7036,7 +7167,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7036
7167
|
};
|
|
7037
7168
|
const localVarHeaderParameter = {};
|
|
7038
7169
|
const localVarQueryParameter = {};
|
|
7039
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7040
7170
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7041
7171
|
if (mode !== void 0) localVarQueryParameter["mode"] = mode;
|
|
7042
7172
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7067,7 +7197,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7067
7197
|
};
|
|
7068
7198
|
const localVarHeaderParameter = {};
|
|
7069
7199
|
const localVarQueryParameter = {};
|
|
7070
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7071
7200
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7072
7201
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7073
7202
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7097,6 +7226,12 @@ const VirtualControllerApiFp = function(configuration) {
|
|
|
7097
7226
|
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.addVirtualControllerCoordinateSystem"]?.[localVarOperationServerIndex]?.url;
|
|
7098
7227
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
7099
7228
|
},
|
|
7229
|
+
async addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7230
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options);
|
|
7231
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7232
|
+
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.addVirtualControllerMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
7233
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
7234
|
+
},
|
|
7100
7235
|
async addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
7101
7236
|
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
|
|
7102
7237
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -7109,6 +7244,12 @@ const VirtualControllerApiFp = function(configuration) {
|
|
|
7109
7244
|
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.deleteVirtualControllerCoordinateSystem"]?.[localVarOperationServerIndex]?.url;
|
|
7110
7245
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
7111
7246
|
},
|
|
7247
|
+
async deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7248
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options);
|
|
7249
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7250
|
+
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.deleteVirtualControllerMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
7251
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
7252
|
+
},
|
|
7112
7253
|
async deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
7113
7254
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options);
|
|
7114
7255
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -7192,12 +7333,18 @@ const VirtualControllerApiFactory = function(configuration, basePath, axios$1) {
|
|
|
7192
7333
|
addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
7193
7334
|
return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios$1, basePath));
|
|
7194
7335
|
},
|
|
7336
|
+
addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7337
|
+
return localVarFp.addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options).then((request) => request(axios$1, basePath));
|
|
7338
|
+
},
|
|
7195
7339
|
addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
7196
7340
|
return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios$1, basePath));
|
|
7197
7341
|
},
|
|
7198
7342
|
deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
7199
7343
|
return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios$1, basePath));
|
|
7200
7344
|
},
|
|
7345
|
+
deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7346
|
+
return localVarFp.deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options).then((request) => request(axios$1, basePath));
|
|
7347
|
+
},
|
|
7201
7348
|
deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
7202
7349
|
return localVarFp.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios$1, basePath));
|
|
7203
7350
|
},
|
|
@@ -7254,6 +7401,18 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7254
7401
|
return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
7255
7402
|
}
|
|
7256
7403
|
/**
|
|
7404
|
+
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
7405
|
+
* @summary Add Motion Group
|
|
7406
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7407
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7408
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
7409
|
+
* @param {*} [options] Override http request option.
|
|
7410
|
+
* @throws {RequiredError}
|
|
7411
|
+
*/
|
|
7412
|
+
addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7413
|
+
return VirtualControllerApiFp(this.configuration).addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7414
|
+
}
|
|
7415
|
+
/**
|
|
7257
7416
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
|
|
7258
7417
|
* @summary Add TCP
|
|
7259
7418
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7281,6 +7440,18 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7281
7440
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
7282
7441
|
}
|
|
7283
7442
|
/**
|
|
7443
|
+
* Removes a motion group configuration from the virtual controller. <!-- theme: info --> > #### NOTE > > When a motion group is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
|
|
7444
|
+
* @summary Delete Motion Group
|
|
7445
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7446
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7447
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7448
|
+
* @param {*} [options] Override http request option.
|
|
7449
|
+
* @throws {RequiredError}
|
|
7450
|
+
*/
|
|
7451
|
+
deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7452
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
7453
|
+
}
|
|
7454
|
+
/**
|
|
7284
7455
|
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
|
|
7285
7456
|
* @summary Remove TCP
|
|
7286
7457
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7294,7 +7465,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7294
7465
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
7295
7466
|
}
|
|
7296
7467
|
/**
|
|
7297
|
-
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
7468
|
+
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
7298
7469
|
* @summary Get Emergency Stop State
|
|
7299
7470
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7300
7471
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7328,7 +7499,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7328
7499
|
return VirtualControllerApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7329
7500
|
}
|
|
7330
7501
|
/**
|
|
7331
|
-
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7502
|
+
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7332
7503
|
* @summary Get Operation Mode
|
|
7333
7504
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7334
7505
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7374,7 +7545,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7374
7545
|
return VirtualControllerApiFp(this.configuration).listVirtualControllerTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
7375
7546
|
}
|
|
7376
7547
|
/**
|
|
7377
|
-
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
7548
|
+
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
7378
7549
|
* @summary Push or Release Emergency Stop
|
|
7379
7550
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7380
7551
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7399,7 +7570,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7399
7570
|
return VirtualControllerApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
|
|
7400
7571
|
}
|
|
7401
7572
|
/**
|
|
7402
|
-
* Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7573
|
+
* Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7403
7574
|
* @summary Set Operation Mode
|
|
7404
7575
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7405
7576
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7444,7 +7615,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7444
7615
|
};
|
|
7445
7616
|
const localVarHeaderParameter = {};
|
|
7446
7617
|
const localVarQueryParameter = {};
|
|
7447
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7448
7618
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7449
7619
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7450
7620
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7474,7 +7644,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7474
7644
|
};
|
|
7475
7645
|
const localVarHeaderParameter = {};
|
|
7476
7646
|
const localVarQueryParameter = {};
|
|
7477
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7478
7647
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7479
7648
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7480
7649
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7502,7 +7671,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7502
7671
|
};
|
|
7503
7672
|
const localVarHeaderParameter = {};
|
|
7504
7673
|
const localVarQueryParameter = {};
|
|
7505
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7506
7674
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7507
7675
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7508
7676
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7530,7 +7698,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7530
7698
|
};
|
|
7531
7699
|
const localVarHeaderParameter = {};
|
|
7532
7700
|
const localVarQueryParameter = {};
|
|
7533
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7534
7701
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7535
7702
|
if (behavior !== void 0) localVarQueryParameter["behavior"] = behavior;
|
|
7536
7703
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7604,7 +7771,7 @@ const VirtualControllerBehaviorApiFactory = function(configuration, basePath, ax
|
|
|
7604
7771
|
*/
|
|
7605
7772
|
var VirtualControllerBehaviorApi = class extends BaseAPI {
|
|
7606
7773
|
/**
|
|
7607
|
-
* <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
7774
|
+
* <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](#/operations/planTrajectory) and [executeTrajectory](#/operations/executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](#/operations/executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
7608
7775
|
* @summary Stream Joint Configuration
|
|
7609
7776
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7610
7777
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7627,7 +7794,7 @@ var VirtualControllerBehaviorApi = class extends BaseAPI {
|
|
|
7627
7794
|
return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7628
7795
|
}
|
|
7629
7796
|
/**
|
|
7630
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
7797
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
7631
7798
|
* @summary Get Behavior
|
|
7632
7799
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7633
7800
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7670,7 +7837,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7670
7837
|
};
|
|
7671
7838
|
const localVarHeaderParameter = {};
|
|
7672
7839
|
const localVarQueryParameter = {};
|
|
7673
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7674
7840
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7675
7841
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
7676
7842
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7699,7 +7865,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7699
7865
|
};
|
|
7700
7866
|
const localVarHeaderParameter = {};
|
|
7701
7867
|
const localVarQueryParameter = {};
|
|
7702
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7703
7868
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7704
7869
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
7705
7870
|
if (direction !== void 0) localVarQueryParameter["direction"] = direction;
|
|
@@ -7732,7 +7897,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7732
7897
|
};
|
|
7733
7898
|
const localVarHeaderParameter = {};
|
|
7734
7899
|
const localVarQueryParameter = {};
|
|
7735
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7736
7900
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7737
7901
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7738
7902
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7798,7 +7962,7 @@ const VirtualControllerInputsOutputsApiFactory = function(configuration, basePat
|
|
|
7798
7962
|
*/
|
|
7799
7963
|
var VirtualControllerInputsOutputsApi = class extends BaseAPI {
|
|
7800
7964
|
/**
|
|
7801
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
7965
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](#/operations/listVirtualControllerIODescriptions).
|
|
7802
7966
|
* @summary Get Input/Output Values
|
|
7803
7967
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7804
7968
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7990,6 +8154,7 @@ exports.CellApi = CellApi;
|
|
|
7990
8154
|
exports.CellApiAxiosParamCreator = CellApiAxiosParamCreator;
|
|
7991
8155
|
exports.CellApiFactory = CellApiFactory;
|
|
7992
8156
|
exports.CellApiFp = CellApiFp;
|
|
8157
|
+
exports.CollisionErrorKindEnum = CollisionErrorKindEnum;
|
|
7993
8158
|
exports.Comparator = Comparator;
|
|
7994
8159
|
exports.Configuration = Configuration;
|
|
7995
8160
|
exports.ConfigurationArchiveStatusCreatingStatusEnum = ConfigurationArchiveStatusCreatingStatusEnum;
|
|
@@ -8022,11 +8187,13 @@ exports.IOFloatValueValueTypeEnum = IOFloatValueValueTypeEnum;
|
|
|
8022
8187
|
exports.IOIntegerValueValueTypeEnum = IOIntegerValueValueTypeEnum;
|
|
8023
8188
|
exports.IOOrigin = IOOrigin;
|
|
8024
8189
|
exports.IOValueType = IOValueType;
|
|
8190
|
+
exports.InconsistentTrajectorySizeErrorKindEnum = InconsistentTrajectorySizeErrorKindEnum;
|
|
8025
8191
|
exports.InitializeJoggingRequestMessageTypeEnum = InitializeJoggingRequestMessageTypeEnum;
|
|
8026
8192
|
exports.InitializeJoggingResponseKindEnum = InitializeJoggingResponseKindEnum;
|
|
8027
8193
|
exports.InitializeMovementRequestMessageTypeEnum = InitializeMovementRequestMessageTypeEnum;
|
|
8028
8194
|
exports.InitializeMovementResponseKindEnum = InitializeMovementResponseKindEnum;
|
|
8029
8195
|
exports.IntegerValueValueTypeEnum = IntegerValueValueTypeEnum;
|
|
8196
|
+
exports.InvalidDofErrorKindEnum = InvalidDofErrorKindEnum;
|
|
8030
8197
|
exports.JoggingApi = JoggingApi;
|
|
8031
8198
|
exports.JoggingApiAxiosParamCreator = JoggingApiAxiosParamCreator;
|
|
8032
8199
|
exports.JoggingApiFactory = JoggingApiFactory;
|
|
@@ -8037,6 +8204,8 @@ exports.JoggingPausedNearCollisionKindEnum = JoggingPausedNearCollisionKindEnum;
|
|
|
8037
8204
|
exports.JoggingPausedNearJointLimitKindEnum = JoggingPausedNearJointLimitKindEnum;
|
|
8038
8205
|
exports.JoggingPausedOnIOKindEnum = JoggingPausedOnIOKindEnum;
|
|
8039
8206
|
exports.JoggingRunningKindEnum = JoggingRunningKindEnum;
|
|
8207
|
+
exports.JointLimitExceededErrorKindEnum = JointLimitExceededErrorKindEnum;
|
|
8208
|
+
exports.JointTypeEnum = JointTypeEnum;
|
|
8040
8209
|
exports.JointVelocityRequestMessageTypeEnum = JointVelocityRequestMessageTypeEnum;
|
|
8041
8210
|
exports.JointVelocityResponseKindEnum = JointVelocityResponseKindEnum;
|
|
8042
8211
|
exports.KinematicsApi = KinematicsApi;
|
|
@@ -8063,6 +8232,7 @@ exports.MotionGroupModelsApiAxiosParamCreator = MotionGroupModelsApiAxiosParamCr
|
|
|
8063
8232
|
exports.MotionGroupModelsApiFactory = MotionGroupModelsApiFactory;
|
|
8064
8233
|
exports.MotionGroupModelsApiFp = MotionGroupModelsApiFp;
|
|
8065
8234
|
exports.MovementErrorResponseKindEnum = MovementErrorResponseKindEnum;
|
|
8235
|
+
exports.NanValueErrorKindEnum = NanValueErrorKindEnum;
|
|
8066
8236
|
exports.NetworkStateConnectionTypeEnum = NetworkStateConnectionTypeEnum;
|
|
8067
8237
|
exports.OperatingState = OperatingState;
|
|
8068
8238
|
exports.OperationMode = OperationMode;
|
|
@@ -8121,8 +8291,10 @@ exports.SystemApi = SystemApi;
|
|
|
8121
8291
|
exports.SystemApiAxiosParamCreator = SystemApiAxiosParamCreator;
|
|
8122
8292
|
exports.SystemApiFactory = SystemApiFactory;
|
|
8123
8293
|
exports.SystemApiFp = SystemApiFp;
|
|
8294
|
+
exports.TcpRequiredErrorKindEnum = TcpRequiredErrorKindEnum;
|
|
8124
8295
|
exports.TcpVelocityRequestMessageTypeEnum = TcpVelocityRequestMessageTypeEnum;
|
|
8125
8296
|
exports.TcpVelocityResponseKindEnum = TcpVelocityResponseKindEnum;
|
|
8297
|
+
exports.TorqueExceededErrorKindEnum = TorqueExceededErrorKindEnum;
|
|
8126
8298
|
exports.TrajectoryCachingApi = TrajectoryCachingApi;
|
|
8127
8299
|
exports.TrajectoryCachingApiAxiosParamCreator = TrajectoryCachingApiAxiosParamCreator;
|
|
8128
8300
|
exports.TrajectoryCachingApiFactory = TrajectoryCachingApiFactory;
|