@wandelbots/nova-api 26.2.0-dev.5 → 26.2.0-dev.56
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 +270 -194
- package/dist/v2/index.d.cts +493 -222
- package/dist/v2/index.d.ts +633 -362
- package/dist/v2/index.js +263 -195
- package/package.json +1 -1
package/dist/v2/index.js
CHANGED
|
@@ -39,12 +39,6 @@ const DUMMY_BASE_URL = "https://example.com";
|
|
|
39
39
|
const assertParamExists = function(functionName, paramName, paramValue) {
|
|
40
40
|
if (paramValue === null || paramValue === void 0) throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
|
|
41
41
|
};
|
|
42
|
-
const setBasicAuthToObject = function(object, configuration) {
|
|
43
|
-
if (configuration && (configuration.username || configuration.password)) object["auth"] = {
|
|
44
|
-
username: configuration.username,
|
|
45
|
-
password: configuration.password
|
|
46
|
-
};
|
|
47
|
-
};
|
|
48
42
|
const setBearerAuthToObject = async function(object, configuration) {
|
|
49
43
|
if (configuration && configuration.accessToken) object["Authorization"] = "Bearer " + (typeof configuration.accessToken === "function" ? await configuration.accessToken() : await configuration.accessToken);
|
|
50
44
|
};
|
|
@@ -81,7 +75,7 @@ const createRequestFunction = function(axiosArgs, globalAxios$1, BASE_PATH$1, co
|
|
|
81
75
|
//#region v2/api.ts
|
|
82
76
|
const AbbControllerKindEnum = { AbbController: "AbbController" };
|
|
83
77
|
/**
|
|
84
|
-
* ## 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).
|
|
78
|
+
* ## 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).
|
|
85
79
|
*/
|
|
86
80
|
const Behavior = {
|
|
87
81
|
BehaviorAutomatic: "BEHAVIOR_AUTOMATIC",
|
|
@@ -120,6 +114,7 @@ const BusIOsStateEnum = {
|
|
|
120
114
|
BusIosStateDisconnected: "BUS_IOS_STATE_DISCONNECTED"
|
|
121
115
|
};
|
|
122
116
|
const CapsuleShapeTypeEnum = { Capsule: "capsule" };
|
|
117
|
+
const CollisionErrorKindEnum = { CollisionError: "CollisionError" };
|
|
123
118
|
/**
|
|
124
119
|
* 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.
|
|
125
120
|
*/
|
|
@@ -178,17 +173,24 @@ const IOValueType = {
|
|
|
178
173
|
IoValueAnalogFloat: "IO_VALUE_ANALOG_FLOAT",
|
|
179
174
|
IoValueAnalogInteger: "IO_VALUE_ANALOG_INTEGER"
|
|
180
175
|
};
|
|
176
|
+
const InconsistentTrajectorySizeErrorKindEnum = { InconsistentTrajectorySizeError: "InconsistentTrajectorySizeError" };
|
|
181
177
|
const InitializeJoggingRequestMessageTypeEnum = { InitializeJoggingRequest: "InitializeJoggingRequest" };
|
|
182
178
|
const InitializeJoggingResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
|
|
183
179
|
const InitializeMovementRequestMessageTypeEnum = { InitializeMovementRequest: "InitializeMovementRequest" };
|
|
184
180
|
const InitializeMovementResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
|
|
185
181
|
const IntegerValueValueTypeEnum = { Integer: "integer" };
|
|
182
|
+
const InvalidDofErrorKindEnum = { InvalidDofError: "InvalidDofError" };
|
|
186
183
|
const JoggingDetailsKindEnum = { Jogging: "JOGGING" };
|
|
187
184
|
const JoggingPausedByUserKindEnum = { PausedByUser: "PAUSED_BY_USER" };
|
|
188
185
|
const JoggingPausedNearCollisionKindEnum = { PausedNearCollision: "PAUSED_NEAR_COLLISION" };
|
|
189
186
|
const JoggingPausedNearJointLimitKindEnum = { PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT" };
|
|
190
187
|
const JoggingPausedOnIOKindEnum = { PausedOnIo: "PAUSED_ON_IO" };
|
|
191
188
|
const JoggingRunningKindEnum = { Running: "RUNNING" };
|
|
189
|
+
const JointLimitExceededErrorKindEnum = { JointLimitExceededError: "JointLimitExceededError" };
|
|
190
|
+
const JointTypeEnum = {
|
|
191
|
+
RevoluteJoint: "REVOLUTE_JOINT",
|
|
192
|
+
PrismaticJoint: "PRISMATIC_JOINT"
|
|
193
|
+
};
|
|
192
194
|
const JointVelocityRequestMessageTypeEnum = { JointVelocityRequest: "JointVelocityRequest" };
|
|
193
195
|
const JointVelocityResponseKindEnum = { JointVelocityReceived: "JOINT_VELOCITY_RECEIVED" };
|
|
194
196
|
const KukaControllerKindEnum = { KukaController: "KukaController" };
|
|
@@ -237,6 +239,7 @@ const ModbusIOTypeEnum = {
|
|
|
237
239
|
ModbusIoTypeFloat32: "MODBUS_IO_TYPE_FLOAT32"
|
|
238
240
|
};
|
|
239
241
|
const MovementErrorResponseKindEnum = { MotionError: "MOTION_ERROR" };
|
|
242
|
+
const NanValueErrorKindEnum = { NanValueError: "NanValueError" };
|
|
240
243
|
const NetworkStateConnectionTypeEnum = {
|
|
241
244
|
Ethernet: "ethernet",
|
|
242
245
|
Wifi: "wifi",
|
|
@@ -346,14 +349,14 @@ const RRTConnectAlgorithmAlgorithmNameEnum = { RrtConnectAlgorithm: "RRTConnectA
|
|
|
346
349
|
const RectangleShapeTypeEnum = { Rectangle: "rectangle" };
|
|
347
350
|
const RectangularCapsuleShapeTypeEnum = { RectangularCapsule: "rectangular_capsule" };
|
|
348
351
|
/**
|
|
349
|
-
* The channel that defines what a new Wandelbots NOVA version is. * `next` the
|
|
352
|
+
* The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
|
|
350
353
|
*/
|
|
351
354
|
const ReleaseChannel = {
|
|
352
355
|
Stable: "stable",
|
|
353
356
|
Next: "next"
|
|
354
357
|
};
|
|
355
358
|
/**
|
|
356
|
-
* 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.
|
|
359
|
+
* 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.
|
|
357
360
|
*/
|
|
358
361
|
const RobotSystemMode = {
|
|
359
362
|
ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED",
|
|
@@ -410,9 +413,14 @@ const ServiceStatusSeverity = {
|
|
|
410
413
|
Warning: "WARNING",
|
|
411
414
|
Error: "ERROR"
|
|
412
415
|
};
|
|
416
|
+
/**
|
|
417
|
+
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
|
|
418
|
+
*/
|
|
413
419
|
const SettableRobotSystemMode = {
|
|
414
420
|
RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR",
|
|
415
|
-
|
|
421
|
+
ModeMonitor: "MODE_MONITOR",
|
|
422
|
+
RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL",
|
|
423
|
+
ModeControl: "MODE_CONTROL"
|
|
416
424
|
};
|
|
417
425
|
const SingularityTypeEnum = {
|
|
418
426
|
Wrist: "WRIST",
|
|
@@ -422,8 +430,10 @@ const SingularityTypeEnum = {
|
|
|
422
430
|
const SphereShapeTypeEnum = { Sphere: "sphere" };
|
|
423
431
|
const StartMovementRequestMessageTypeEnum = { StartMovementRequest: "StartMovementRequest" };
|
|
424
432
|
const StartMovementResponseKindEnum = { StartReceived: "START_RECEIVED" };
|
|
433
|
+
const TcpRequiredErrorKindEnum = { TcpRequiredError: "TcpRequiredError" };
|
|
425
434
|
const TcpVelocityRequestMessageTypeEnum = { TcpVelocityRequest: "TcpVelocityRequest" };
|
|
426
435
|
const TcpVelocityResponseKindEnum = { TcpVelocityReceived: "TCP_VELOCITY_RECEIVED" };
|
|
436
|
+
const TorqueExceededErrorKindEnum = { TorqueExceededError: "TorqueExceededError" };
|
|
427
437
|
const TrajectoryDataMessageTypeEnum = { TrajectoryData: "TrajectoryData" };
|
|
428
438
|
const TrajectoryDetailsKindEnum = { Trajectory: "TRAJECTORY" };
|
|
429
439
|
const TrajectoryEndedKindEnum = { EndOfTrajectory: "END_OF_TRAJECTORY" };
|
|
@@ -469,7 +479,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
469
479
|
};
|
|
470
480
|
const localVarHeaderParameter = {};
|
|
471
481
|
const localVarQueryParameter = {};
|
|
472
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
473
482
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
474
483
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
475
484
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -499,7 +508,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
499
508
|
};
|
|
500
509
|
const localVarHeaderParameter = {};
|
|
501
510
|
const localVarQueryParameter = {};
|
|
502
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
503
511
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
504
512
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
505
513
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -528,7 +536,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
528
536
|
};
|
|
529
537
|
const localVarHeaderParameter = {};
|
|
530
538
|
const localVarQueryParameter = {};
|
|
531
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
532
539
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
533
540
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
534
541
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -557,7 +564,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
557
564
|
};
|
|
558
565
|
const localVarHeaderParameter = {};
|
|
559
566
|
const localVarQueryParameter = {};
|
|
560
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
561
567
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
562
568
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
563
569
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -584,7 +590,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
584
590
|
};
|
|
585
591
|
const localVarHeaderParameter = {};
|
|
586
592
|
const localVarQueryParameter = {};
|
|
587
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
588
593
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
589
594
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
590
595
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -613,7 +618,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
613
618
|
};
|
|
614
619
|
const localVarHeaderParameter = {};
|
|
615
620
|
const localVarQueryParameter = {};
|
|
616
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
617
621
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
618
622
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
619
623
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -742,7 +746,7 @@ var ApplicationApi = class extends BaseAPI {
|
|
|
742
746
|
return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
743
747
|
}
|
|
744
748
|
/**
|
|
745
|
-
* 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).
|
|
749
|
+
* 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).
|
|
746
750
|
* @summary Configuration
|
|
747
751
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
748
752
|
* @param {string} app
|
|
@@ -753,7 +757,7 @@ var ApplicationApi = class extends BaseAPI {
|
|
|
753
757
|
return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
|
|
754
758
|
}
|
|
755
759
|
/**
|
|
756
|
-
* 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.
|
|
760
|
+
* 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.
|
|
757
761
|
* @summary List Applications
|
|
758
762
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
759
763
|
* @param {*} [options] Override http request option.
|
|
@@ -795,7 +799,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
795
799
|
};
|
|
796
800
|
const localVarHeaderParameter = {};
|
|
797
801
|
const localVarQueryParameter = {};
|
|
798
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
799
802
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
800
803
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
801
804
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -827,7 +830,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
827
830
|
};
|
|
828
831
|
const localVarHeaderParameter = {};
|
|
829
832
|
const localVarQueryParameter = {};
|
|
830
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
831
833
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
832
834
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
833
835
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -858,7 +860,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
858
860
|
};
|
|
859
861
|
const localVarHeaderParameter = {};
|
|
860
862
|
const localVarQueryParameter = {};
|
|
861
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
862
863
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
863
864
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
864
865
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -887,7 +888,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
887
888
|
};
|
|
888
889
|
const localVarHeaderParameter = {};
|
|
889
890
|
const localVarQueryParameter = {};
|
|
890
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
891
891
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
892
892
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
893
893
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -915,7 +915,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
915
915
|
};
|
|
916
916
|
const localVarHeaderParameter = {};
|
|
917
917
|
const localVarQueryParameter = {};
|
|
918
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
919
918
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
920
919
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
921
920
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -942,7 +941,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
942
941
|
};
|
|
943
942
|
const localVarHeaderParameter = {};
|
|
944
943
|
const localVarQueryParameter = {};
|
|
945
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
946
944
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
947
945
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
948
946
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -970,7 +968,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
970
968
|
};
|
|
971
969
|
const localVarHeaderParameter = {};
|
|
972
970
|
const localVarQueryParameter = {};
|
|
973
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
974
971
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
975
972
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
976
973
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -998,7 +995,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
998
995
|
};
|
|
999
996
|
const localVarHeaderParameter = {};
|
|
1000
997
|
const localVarQueryParameter = {};
|
|
1001
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1002
998
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1003
999
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1004
1000
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1025,7 +1021,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1025
1021
|
};
|
|
1026
1022
|
const localVarHeaderParameter = {};
|
|
1027
1023
|
const localVarQueryParameter = {};
|
|
1028
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1029
1024
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1030
1025
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1031
1026
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1052,7 +1047,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1052
1047
|
};
|
|
1053
1048
|
const localVarHeaderParameter = {};
|
|
1054
1049
|
const localVarQueryParameter = {};
|
|
1055
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1056
1050
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1057
1051
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1058
1052
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1079,7 +1073,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1079
1073
|
};
|
|
1080
1074
|
const localVarHeaderParameter = {};
|
|
1081
1075
|
const localVarQueryParameter = {};
|
|
1082
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1083
1076
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1084
1077
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
1085
1078
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1107,7 +1100,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1107
1100
|
};
|
|
1108
1101
|
const localVarHeaderParameter = {};
|
|
1109
1102
|
const localVarQueryParameter = {};
|
|
1110
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1111
1103
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1112
1104
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1113
1105
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1134,7 +1126,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1134
1126
|
};
|
|
1135
1127
|
const localVarHeaderParameter = {};
|
|
1136
1128
|
const localVarQueryParameter = {};
|
|
1137
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1138
1129
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1139
1130
|
if (inputOffset !== void 0) localVarQueryParameter["input_offset"] = inputOffset;
|
|
1140
1131
|
if (outputOffset !== void 0) localVarQueryParameter["output_offset"] = outputOffset;
|
|
@@ -1163,7 +1154,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1163
1154
|
};
|
|
1164
1155
|
const localVarHeaderParameter = {};
|
|
1165
1156
|
const localVarQueryParameter = {};
|
|
1166
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1167
1157
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1168
1158
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1169
1159
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1190,7 +1180,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1190
1180
|
};
|
|
1191
1181
|
const localVarHeaderParameter = {};
|
|
1192
1182
|
const localVarQueryParameter = {};
|
|
1193
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1194
1183
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1195
1184
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1196
1185
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1217,7 +1206,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1217
1206
|
};
|
|
1218
1207
|
const localVarHeaderParameter = {};
|
|
1219
1208
|
const localVarQueryParameter = {};
|
|
1220
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1221
1209
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1222
1210
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1223
1211
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1245,7 +1233,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1245
1233
|
};
|
|
1246
1234
|
const localVarHeaderParameter = {};
|
|
1247
1235
|
const localVarQueryParameter = {};
|
|
1248
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1249
1236
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1250
1237
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1251
1238
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1275,7 +1262,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1275
1262
|
};
|
|
1276
1263
|
const localVarHeaderParameter = {};
|
|
1277
1264
|
const localVarQueryParameter = {};
|
|
1278
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1279
1265
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1280
1266
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1281
1267
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1488,7 +1474,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1488
1474
|
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1489
1475
|
}
|
|
1490
1476
|
/**
|
|
1491
|
-
* 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).
|
|
1477
|
+
* 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).
|
|
1492
1478
|
* @summary Add MODBUS Input/Output
|
|
1493
1479
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1494
1480
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -1500,7 +1486,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1500
1486
|
return BUSInputsOutputsApiFp(this.configuration).addModbusIO(cell, io, modbusIOData, options).then((request) => request(this.axios, this.basePath));
|
|
1501
1487
|
}
|
|
1502
1488
|
/**
|
|
1503
|
-
* 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).
|
|
1489
|
+
* 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).
|
|
1504
1490
|
* @summary Add PROFINET Input/Output
|
|
1505
1491
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1506
1492
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -1544,7 +1530,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1544
1530
|
}
|
|
1545
1531
|
/**
|
|
1546
1532
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
1547
|
-
* @summary Remove MODBUS Input/
|
|
1533
|
+
* @summary Remove MODBUS Input/Output
|
|
1548
1534
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1549
1535
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1550
1536
|
* @param {*} [options] Override http request option.
|
|
@@ -1585,7 +1571,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1585
1571
|
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1586
1572
|
}
|
|
1587
1573
|
/**
|
|
1588
|
-
* 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).
|
|
1574
|
+
* 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).
|
|
1589
1575
|
* @summary Get Input/Output Values
|
|
1590
1576
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1591
1577
|
* @param {Array<string>} [ios]
|
|
@@ -1628,7 +1614,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1628
1614
|
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1629
1615
|
}
|
|
1630
1616
|
/**
|
|
1631
|
-
* 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).
|
|
1617
|
+
* 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).
|
|
1632
1618
|
* @summary List MODBUS Input/Output Configuration
|
|
1633
1619
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1634
1620
|
* @param {*} [options] Override http request option.
|
|
@@ -1638,7 +1624,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1638
1624
|
return BUSInputsOutputsApiFp(this.configuration).listModbusIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1639
1625
|
}
|
|
1640
1626
|
/**
|
|
1641
|
-
* 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.
|
|
1627
|
+
* 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.
|
|
1642
1628
|
* @summary List PROFINET Input/Output Configuration
|
|
1643
1629
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1644
1630
|
* @param {*} [options] Override http request option.
|
|
@@ -1648,7 +1634,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1648
1634
|
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1649
1635
|
}
|
|
1650
1636
|
/**
|
|
1651
|
-
* 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.
|
|
1637
|
+
* 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.
|
|
1652
1638
|
* @summary Set Output Values
|
|
1653
1639
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1654
1640
|
* @param {Array<IOValue>} iOValue
|
|
@@ -1659,7 +1645,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1659
1645
|
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
1660
1646
|
}
|
|
1661
1647
|
/**
|
|
1662
|
-
* 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.
|
|
1648
|
+
* 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.
|
|
1663
1649
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
1664
1650
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1665
1651
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -1675,6 +1661,34 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1675
1661
|
*/
|
|
1676
1662
|
const CellApiAxiosParamCreator = function(configuration) {
|
|
1677
1663
|
return {
|
|
1664
|
+
checkCellVersionUpdate: async (cell, channel, options = {}) => {
|
|
1665
|
+
assertParamExists("checkCellVersionUpdate", "cell", cell);
|
|
1666
|
+
assertParamExists("checkCellVersionUpdate", "channel", channel);
|
|
1667
|
+
const localVarPath = `/cells/{cell}/update`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1668
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1669
|
+
let baseOptions;
|
|
1670
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1671
|
+
const localVarRequestOptions = {
|
|
1672
|
+
method: "GET",
|
|
1673
|
+
...baseOptions,
|
|
1674
|
+
...options
|
|
1675
|
+
};
|
|
1676
|
+
const localVarHeaderParameter = {};
|
|
1677
|
+
const localVarQueryParameter = {};
|
|
1678
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1679
|
+
if (channel !== void 0) localVarQueryParameter["channel"] = channel;
|
|
1680
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1681
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1682
|
+
localVarRequestOptions.headers = {
|
|
1683
|
+
...localVarHeaderParameter,
|
|
1684
|
+
...headersFromBaseOptions,
|
|
1685
|
+
...options.headers
|
|
1686
|
+
};
|
|
1687
|
+
return {
|
|
1688
|
+
url: toPathString(localVarUrlObj),
|
|
1689
|
+
options: localVarRequestOptions
|
|
1690
|
+
};
|
|
1691
|
+
},
|
|
1678
1692
|
deleteCell: async (cell, completionTimeout, options = {}) => {
|
|
1679
1693
|
assertParamExists("deleteCell", "cell", cell);
|
|
1680
1694
|
const localVarPath = `/cells/{cell}`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
@@ -1688,7 +1702,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1688
1702
|
};
|
|
1689
1703
|
const localVarHeaderParameter = {};
|
|
1690
1704
|
const localVarQueryParameter = {};
|
|
1691
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1692
1705
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1693
1706
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1694
1707
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1715,7 +1728,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1715
1728
|
};
|
|
1716
1729
|
const localVarHeaderParameter = {};
|
|
1717
1730
|
const localVarQueryParameter = {};
|
|
1718
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1719
1731
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1720
1732
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1721
1733
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -1745,7 +1757,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1745
1757
|
};
|
|
1746
1758
|
const localVarHeaderParameter = {};
|
|
1747
1759
|
const localVarQueryParameter = {};
|
|
1748
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1749
1760
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1750
1761
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1751
1762
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1772,7 +1783,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1772
1783
|
};
|
|
1773
1784
|
const localVarHeaderParameter = {};
|
|
1774
1785
|
const localVarQueryParameter = {};
|
|
1775
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1776
1786
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1777
1787
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1778
1788
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1797,7 +1807,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1797
1807
|
};
|
|
1798
1808
|
const localVarHeaderParameter = {};
|
|
1799
1809
|
const localVarQueryParameter = {};
|
|
1800
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1801
1810
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1802
1811
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1803
1812
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1825,7 +1834,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1825
1834
|
};
|
|
1826
1835
|
const localVarHeaderParameter = {};
|
|
1827
1836
|
const localVarQueryParameter = {};
|
|
1828
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1829
1837
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1830
1838
|
if (operatingState !== void 0) localVarQueryParameter["operating_state"] = operatingState;
|
|
1831
1839
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1854,7 +1862,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1854
1862
|
};
|
|
1855
1863
|
const localVarHeaderParameter = {};
|
|
1856
1864
|
const localVarQueryParameter = {};
|
|
1857
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1858
1865
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1859
1866
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1860
1867
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -1870,6 +1877,35 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1870
1877
|
url: toPathString(localVarUrlObj),
|
|
1871
1878
|
options: localVarRequestOptions
|
|
1872
1879
|
};
|
|
1880
|
+
},
|
|
1881
|
+
updateCellVersion: async (cell, updateCellVersionRequest, options = {}) => {
|
|
1882
|
+
assertParamExists("updateCellVersion", "cell", cell);
|
|
1883
|
+
assertParamExists("updateCellVersion", "updateCellVersionRequest", updateCellVersionRequest);
|
|
1884
|
+
const localVarPath = `/cells/{cell}/update`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1885
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1886
|
+
let baseOptions;
|
|
1887
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1888
|
+
const localVarRequestOptions = {
|
|
1889
|
+
method: "PUT",
|
|
1890
|
+
...baseOptions,
|
|
1891
|
+
...options
|
|
1892
|
+
};
|
|
1893
|
+
const localVarHeaderParameter = {};
|
|
1894
|
+
const localVarQueryParameter = {};
|
|
1895
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1896
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1897
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1898
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1899
|
+
localVarRequestOptions.headers = {
|
|
1900
|
+
...localVarHeaderParameter,
|
|
1901
|
+
...headersFromBaseOptions,
|
|
1902
|
+
...options.headers
|
|
1903
|
+
};
|
|
1904
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCellVersionRequest, localVarRequestOptions, configuration);
|
|
1905
|
+
return {
|
|
1906
|
+
url: toPathString(localVarUrlObj),
|
|
1907
|
+
options: localVarRequestOptions
|
|
1908
|
+
};
|
|
1873
1909
|
}
|
|
1874
1910
|
};
|
|
1875
1911
|
};
|
|
@@ -1879,6 +1915,12 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1879
1915
|
const CellApiFp = function(configuration) {
|
|
1880
1916
|
const localVarAxiosParamCreator = CellApiAxiosParamCreator(configuration);
|
|
1881
1917
|
return {
|
|
1918
|
+
async checkCellVersionUpdate(cell, channel, options) {
|
|
1919
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkCellVersionUpdate(cell, channel, options);
|
|
1920
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1921
|
+
const localVarOperationServerBasePath = operationServerMap["CellApi.checkCellVersionUpdate"]?.[localVarOperationServerIndex]?.url;
|
|
1922
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1923
|
+
},
|
|
1882
1924
|
async deleteCell(cell, completionTimeout, options) {
|
|
1883
1925
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCell(cell, completionTimeout, options);
|
|
1884
1926
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -1920,6 +1962,12 @@ const CellApiFp = function(configuration) {
|
|
|
1920
1962
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1921
1963
|
const localVarOperationServerBasePath = operationServerMap["CellApi.updateCell"]?.[localVarOperationServerIndex]?.url;
|
|
1922
1964
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1965
|
+
},
|
|
1966
|
+
async updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
1967
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCellVersion(cell, updateCellVersionRequest, options);
|
|
1968
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1969
|
+
const localVarOperationServerBasePath = operationServerMap["CellApi.updateCellVersion"]?.[localVarOperationServerIndex]?.url;
|
|
1970
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1923
1971
|
}
|
|
1924
1972
|
};
|
|
1925
1973
|
};
|
|
@@ -1929,6 +1977,9 @@ const CellApiFp = function(configuration) {
|
|
|
1929
1977
|
const CellApiFactory = function(configuration, basePath, axios) {
|
|
1930
1978
|
const localVarFp = CellApiFp(configuration);
|
|
1931
1979
|
return {
|
|
1980
|
+
checkCellVersionUpdate(cell, channel, options) {
|
|
1981
|
+
return localVarFp.checkCellVersionUpdate(cell, channel, options).then((request) => request(axios, basePath));
|
|
1982
|
+
},
|
|
1932
1983
|
deleteCell(cell, completionTimeout, options) {
|
|
1933
1984
|
return localVarFp.deleteCell(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
1934
1985
|
},
|
|
@@ -1949,6 +2000,9 @@ const CellApiFactory = function(configuration, basePath, axios) {
|
|
|
1949
2000
|
},
|
|
1950
2001
|
updateCell(cell, cell2, completionTimeout, options) {
|
|
1951
2002
|
return localVarFp.updateCell(cell, cell2, completionTimeout, options).then((request) => request(axios, basePath));
|
|
2003
|
+
},
|
|
2004
|
+
updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
2005
|
+
return localVarFp.updateCellVersion(cell, updateCellVersionRequest, options).then((request) => request(axios, basePath));
|
|
1952
2006
|
}
|
|
1953
2007
|
};
|
|
1954
2008
|
};
|
|
@@ -1956,6 +2010,17 @@ const CellApiFactory = function(configuration, basePath, axios) {
|
|
|
1956
2010
|
* CellApi - object-oriented interface
|
|
1957
2011
|
*/
|
|
1958
2012
|
var CellApi = class extends BaseAPI {
|
|
2013
|
+
/**
|
|
2014
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
2015
|
+
* @summary Check Cell Update
|
|
2016
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2017
|
+
* @param {ReleaseChannel} channel
|
|
2018
|
+
* @param {*} [options] Override http request option.
|
|
2019
|
+
* @throws {RequiredError}
|
|
2020
|
+
*/
|
|
2021
|
+
checkCellVersionUpdate(cell, channel, options) {
|
|
2022
|
+
return CellApiFp(this.configuration).checkCellVersionUpdate(cell, channel, options).then((request) => request(this.axios, this.basePath));
|
|
2023
|
+
}
|
|
1959
2024
|
/**
|
|
1960
2025
|
* Delete an entire cell.
|
|
1961
2026
|
* @summary Delete Cell
|
|
@@ -2030,6 +2095,17 @@ var CellApi = class extends BaseAPI {
|
|
|
2030
2095
|
updateCell(cell, cell2, completionTimeout, options) {
|
|
2031
2096
|
return CellApiFp(this.configuration).updateCell(cell, cell2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2032
2097
|
}
|
|
2098
|
+
/**
|
|
2099
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
2100
|
+
* @summary Update Cell Version
|
|
2101
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2102
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
2103
|
+
* @param {*} [options] Override http request option.
|
|
2104
|
+
* @throws {RequiredError}
|
|
2105
|
+
*/
|
|
2106
|
+
updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
2107
|
+
return CellApiFp(this.configuration).updateCellVersion(cell, updateCellVersionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2108
|
+
}
|
|
2033
2109
|
};
|
|
2034
2110
|
/**
|
|
2035
2111
|
* ControllerApi - axios parameter creator
|
|
@@ -2050,7 +2126,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2050
2126
|
};
|
|
2051
2127
|
const localVarHeaderParameter = {};
|
|
2052
2128
|
const localVarQueryParameter = {};
|
|
2053
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2054
2129
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2055
2130
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2056
2131
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -2080,7 +2155,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2080
2155
|
};
|
|
2081
2156
|
const localVarHeaderParameter = {};
|
|
2082
2157
|
const localVarQueryParameter = {};
|
|
2083
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2084
2158
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2085
2159
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2086
2160
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2109,7 +2183,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2109
2183
|
};
|
|
2110
2184
|
const localVarHeaderParameter = {};
|
|
2111
2185
|
const localVarQueryParameter = {};
|
|
2112
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2113
2186
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2114
2187
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2115
2188
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2138,7 +2211,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2138
2211
|
};
|
|
2139
2212
|
const localVarHeaderParameter = {};
|
|
2140
2213
|
const localVarQueryParameter = {};
|
|
2141
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2142
2214
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2143
2215
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2144
2216
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2167,7 +2239,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2167
2239
|
};
|
|
2168
2240
|
const localVarHeaderParameter = {};
|
|
2169
2241
|
const localVarQueryParameter = {};
|
|
2170
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2171
2242
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2172
2243
|
if (orientationType !== void 0) localVarQueryParameter["orientation_type"] = orientationType;
|
|
2173
2244
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2196,7 +2267,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2196
2267
|
};
|
|
2197
2268
|
const localVarHeaderParameter = {};
|
|
2198
2269
|
const localVarQueryParameter = {};
|
|
2199
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2200
2270
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2201
2271
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2202
2272
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2224,7 +2294,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2224
2294
|
};
|
|
2225
2295
|
const localVarHeaderParameter = {};
|
|
2226
2296
|
const localVarQueryParameter = {};
|
|
2227
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2228
2297
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2229
2298
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2230
2299
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2252,7 +2321,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2252
2321
|
};
|
|
2253
2322
|
const localVarHeaderParameter = {};
|
|
2254
2323
|
const localVarQueryParameter = {};
|
|
2255
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2256
2324
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2257
2325
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2258
2326
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2280,7 +2348,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2280
2348
|
};
|
|
2281
2349
|
const localVarHeaderParameter = {};
|
|
2282
2350
|
const localVarQueryParameter = {};
|
|
2283
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2284
2351
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2285
2352
|
if (orientationType !== void 0) localVarQueryParameter["orientation_type"] = orientationType;
|
|
2286
2353
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2308,7 +2375,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2308
2375
|
};
|
|
2309
2376
|
const localVarHeaderParameter = {};
|
|
2310
2377
|
const localVarQueryParameter = {};
|
|
2311
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2312
2378
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2313
2379
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2314
2380
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2337,7 +2403,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2337
2403
|
};
|
|
2338
2404
|
const localVarHeaderParameter = {};
|
|
2339
2405
|
const localVarQueryParameter = {};
|
|
2340
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2341
2406
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2342
2407
|
if (mode !== void 0) localVarQueryParameter["mode"] = mode;
|
|
2343
2408
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2366,7 +2431,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2366
2431
|
};
|
|
2367
2432
|
const localVarHeaderParameter = {};
|
|
2368
2433
|
const localVarQueryParameter = {};
|
|
2369
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2370
2434
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2371
2435
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
2372
2436
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2395,7 +2459,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2395
2459
|
};
|
|
2396
2460
|
const localVarHeaderParameter = {};
|
|
2397
2461
|
const localVarQueryParameter = {};
|
|
2398
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2399
2462
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2400
2463
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
2401
2464
|
if (addControllerTimeout !== void 0) localVarQueryParameter["add_controller_timeout"] = addControllerTimeout;
|
|
@@ -2426,7 +2489,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2426
2489
|
};
|
|
2427
2490
|
const localVarHeaderParameter = {};
|
|
2428
2491
|
const localVarQueryParameter = {};
|
|
2429
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2430
2492
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2431
2493
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2432
2494
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -2604,7 +2666,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2604
2666
|
return ControllerApiFp(this.configuration).addRobotController(cell, robotController, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2605
2667
|
}
|
|
2606
2668
|
/**
|
|
2607
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
2669
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
2608
2670
|
* @summary Clear Robot Controllers
|
|
2609
2671
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2610
2672
|
* @param {number} [completionTimeout]
|
|
@@ -2627,7 +2689,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2627
2689
|
return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2628
2690
|
}
|
|
2629
2691
|
/**
|
|
2630
|
-
* 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.
|
|
2692
|
+
* 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.
|
|
2631
2693
|
* @summary Description
|
|
2632
2694
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2633
2695
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2673,7 +2735,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2673
2735
|
return ControllerApiFp(this.configuration).getRobotController(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2674
2736
|
}
|
|
2675
2737
|
/**
|
|
2676
|
-
* 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.
|
|
2738
|
+
* 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.
|
|
2677
2739
|
* @summary Virtual Controller Configuration
|
|
2678
2740
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2679
2741
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2706,7 +2768,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2706
2768
|
return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2707
2769
|
}
|
|
2708
2770
|
/**
|
|
2709
|
-
* 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.
|
|
2771
|
+
* 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.
|
|
2710
2772
|
* @summary Set Default Mode
|
|
2711
2773
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2712
2774
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2718,7 +2780,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2718
2780
|
return ControllerApiFp(this.configuration).setDefaultMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
2719
2781
|
}
|
|
2720
2782
|
/**
|
|
2721
|
-
* <!-- 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.
|
|
2783
|
+
* <!-- 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.
|
|
2722
2784
|
* @summary Stream Free Drive
|
|
2723
2785
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2724
2786
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2730,7 +2792,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2730
2792
|
return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
2731
2793
|
}
|
|
2732
2794
|
/**
|
|
2733
|
-
* <!-- 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.
|
|
2795
|
+
* <!-- 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.
|
|
2734
2796
|
* @summary Stream State
|
|
2735
2797
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2736
2798
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2743,7 +2805,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2743
2805
|
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2744
2806
|
}
|
|
2745
2807
|
/**
|
|
2746
|
-
* 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).
|
|
2808
|
+
* 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).
|
|
2747
2809
|
* @summary Update Robot Controller
|
|
2748
2810
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2749
2811
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2775,7 +2837,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2775
2837
|
};
|
|
2776
2838
|
const localVarHeaderParameter = {};
|
|
2777
2839
|
const localVarQueryParameter = {};
|
|
2778
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2779
2840
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2780
2841
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2781
2842
|
if (direction !== void 0) localVarQueryParameter["direction"] = direction;
|
|
@@ -2807,7 +2868,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2807
2868
|
};
|
|
2808
2869
|
const localVarHeaderParameter = {};
|
|
2809
2870
|
const localVarQueryParameter = {};
|
|
2810
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2811
2871
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2812
2872
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2813
2873
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2837,7 +2897,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2837
2897
|
};
|
|
2838
2898
|
const localVarHeaderParameter = {};
|
|
2839
2899
|
const localVarQueryParameter = {};
|
|
2840
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2841
2900
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2842
2901
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2843
2902
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2867,7 +2926,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2867
2926
|
};
|
|
2868
2927
|
const localVarHeaderParameter = {};
|
|
2869
2928
|
const localVarQueryParameter = {};
|
|
2870
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2871
2929
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2872
2930
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2873
2931
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2897,7 +2955,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2897
2955
|
};
|
|
2898
2956
|
const localVarHeaderParameter = {};
|
|
2899
2957
|
const localVarQueryParameter = {};
|
|
2900
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2901
2958
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2902
2959
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2903
2960
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2996,7 +3053,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
2996
3053
|
return ControllerInputsOutputsApiFp(this.configuration).listIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
2997
3054
|
}
|
|
2998
3055
|
/**
|
|
2999
|
-
* 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).
|
|
3056
|
+
* 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).
|
|
3000
3057
|
* @summary Get Input/Output Values
|
|
3001
3058
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3002
3059
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3008,7 +3065,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3008
3065
|
return ControllerInputsOutputsApiFp(this.configuration).listIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3009
3066
|
}
|
|
3010
3067
|
/**
|
|
3011
|
-
* 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.
|
|
3068
|
+
* 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.
|
|
3012
3069
|
* @summary Set Output Values
|
|
3013
3070
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3014
3071
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3032,7 +3089,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3032
3089
|
return ControllerInputsOutputsApiFp(this.configuration).streamIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3033
3090
|
}
|
|
3034
3091
|
/**
|
|
3035
|
-
* 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 ```
|
|
3092
|
+
* 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 ```
|
|
3036
3093
|
* @summary Wait For
|
|
3037
3094
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3038
3095
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3063,7 +3120,6 @@ const JoggingApiAxiosParamCreator = function(configuration) {
|
|
|
3063
3120
|
};
|
|
3064
3121
|
const localVarHeaderParameter = {};
|
|
3065
3122
|
const localVarQueryParameter = {};
|
|
3066
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3067
3123
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3068
3124
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3069
3125
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3106,7 +3162,7 @@ const JoggingApiFactory = function(configuration, basePath, axios) {
|
|
|
3106
3162
|
*/
|
|
3107
3163
|
var JoggingApi = class extends BaseAPI {
|
|
3108
3164
|
/**
|
|
3109
|
-
* <!-- 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.
|
|
3165
|
+
* <!-- 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.
|
|
3110
3166
|
* @summary Execute Jogging
|
|
3111
3167
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3112
3168
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3137,7 +3193,6 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3137
3193
|
};
|
|
3138
3194
|
const localVarHeaderParameter = {};
|
|
3139
3195
|
const localVarQueryParameter = {};
|
|
3140
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3141
3196
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3142
3197
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3143
3198
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3167,7 +3222,6 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3167
3222
|
};
|
|
3168
3223
|
const localVarHeaderParameter = {};
|
|
3169
3224
|
const localVarQueryParameter = {};
|
|
3170
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3171
3225
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3172
3226
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3173
3227
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3263,7 +3317,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3263
3317
|
};
|
|
3264
3318
|
const localVarHeaderParameter = {};
|
|
3265
3319
|
const localVarQueryParameter = {};
|
|
3266
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3267
3320
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3268
3321
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3269
3322
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3290,7 +3343,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3290
3343
|
};
|
|
3291
3344
|
const localVarHeaderParameter = {};
|
|
3292
3345
|
const localVarQueryParameter = {};
|
|
3293
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3294
3346
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3295
3347
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3296
3348
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3315,7 +3367,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3315
3367
|
};
|
|
3316
3368
|
const localVarHeaderParameter = {};
|
|
3317
3369
|
const localVarQueryParameter = {};
|
|
3318
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3319
3370
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3320
3371
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3321
3372
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3340,7 +3391,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3340
3391
|
};
|
|
3341
3392
|
const localVarHeaderParameter = {};
|
|
3342
3393
|
const localVarQueryParameter = {};
|
|
3343
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3344
3394
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3345
3395
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3346
3396
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3470,7 +3520,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3470
3520
|
};
|
|
3471
3521
|
const localVarHeaderParameter = {};
|
|
3472
3522
|
const localVarQueryParameter = {};
|
|
3473
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3474
3523
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3475
3524
|
if (responseCoordinateSystem !== void 0) localVarQueryParameter["response_coordinate_system"] = responseCoordinateSystem;
|
|
3476
3525
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3500,7 +3549,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3500
3549
|
};
|
|
3501
3550
|
const localVarHeaderParameter = {};
|
|
3502
3551
|
const localVarQueryParameter = {};
|
|
3503
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3504
3552
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3505
3553
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3506
3554
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3529,7 +3577,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3529
3577
|
};
|
|
3530
3578
|
const localVarHeaderParameter = {};
|
|
3531
3579
|
const localVarQueryParameter = {};
|
|
3532
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3533
3580
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3534
3581
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
3535
3582
|
if (responseCoordinateSystem !== void 0) localVarQueryParameter["response_coordinate_system"] = responseCoordinateSystem;
|
|
@@ -3652,7 +3699,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3652
3699
|
};
|
|
3653
3700
|
const localVarHeaderParameter = {};
|
|
3654
3701
|
const localVarQueryParameter = {};
|
|
3655
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3656
3702
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3657
3703
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3658
3704
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3679,7 +3725,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3679
3725
|
};
|
|
3680
3726
|
const localVarHeaderParameter = {};
|
|
3681
3727
|
const localVarQueryParameter = {};
|
|
3682
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3683
3728
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3684
3729
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3685
3730
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3706,7 +3751,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3706
3751
|
};
|
|
3707
3752
|
const localVarHeaderParameter = {};
|
|
3708
3753
|
const localVarQueryParameter = {};
|
|
3709
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3710
3754
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3711
3755
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3712
3756
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3731,7 +3775,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3731
3775
|
};
|
|
3732
3776
|
const localVarHeaderParameter = {};
|
|
3733
3777
|
const localVarQueryParameter = {};
|
|
3734
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3735
3778
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3736
3779
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3737
3780
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3758,7 +3801,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3758
3801
|
};
|
|
3759
3802
|
const localVarHeaderParameter = {};
|
|
3760
3803
|
const localVarQueryParameter = {};
|
|
3761
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3762
3804
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3763
3805
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3764
3806
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3840,9 +3882,9 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios) {
|
|
|
3840
3882
|
*/
|
|
3841
3883
|
var MotionGroupModelsApi = class extends BaseAPI {
|
|
3842
3884
|
/**
|
|
3843
|
-
* 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.
|
|
3885
|
+
* 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.
|
|
3844
3886
|
* @summary Get Collision Model
|
|
3845
|
-
* @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).
|
|
3887
|
+
* @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).
|
|
3846
3888
|
* @param {*} [options] Override http request option.
|
|
3847
3889
|
* @throws {RequiredError}
|
|
3848
3890
|
*/
|
|
@@ -3850,9 +3892,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3850
3892
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3851
3893
|
}
|
|
3852
3894
|
/**
|
|
3853
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3895
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
3854
3896
|
* @summary Download GLB Model
|
|
3855
|
-
* @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).
|
|
3897
|
+
* @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).
|
|
3856
3898
|
* @param {*} [options] Override http request option.
|
|
3857
3899
|
* @throws {RequiredError}
|
|
3858
3900
|
*/
|
|
@@ -3860,9 +3902,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3860
3902
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupGlbModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3861
3903
|
}
|
|
3862
3904
|
/**
|
|
3863
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
3905
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
3864
3906
|
* @summary Get Kinematics
|
|
3865
|
-
* @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).
|
|
3907
|
+
* @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).
|
|
3866
3908
|
* @param {*} [options] Override http request option.
|
|
3867
3909
|
* @throws {RequiredError}
|
|
3868
3910
|
*/
|
|
@@ -3879,9 +3921,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3879
3921
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(options).then((request) => request(this.axios, this.basePath));
|
|
3880
3922
|
}
|
|
3881
3923
|
/**
|
|
3882
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3924
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
3883
3925
|
* @summary Download USD Model
|
|
3884
|
-
* @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).
|
|
3926
|
+
* @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).
|
|
3885
3927
|
* @param {*} [options] Override http request option.
|
|
3886
3928
|
* @throws {RequiredError}
|
|
3887
3929
|
*/
|
|
@@ -3908,7 +3950,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3908
3950
|
};
|
|
3909
3951
|
const localVarHeaderParameter = {};
|
|
3910
3952
|
const localVarQueryParameter = {};
|
|
3911
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3912
3953
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3913
3954
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3914
3955
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3935,7 +3976,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3935
3976
|
};
|
|
3936
3977
|
const localVarHeaderParameter = {};
|
|
3937
3978
|
const localVarQueryParameter = {};
|
|
3938
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3939
3979
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3940
3980
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3941
3981
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3964,7 +4004,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3964
4004
|
};
|
|
3965
4005
|
const localVarHeaderParameter = {};
|
|
3966
4006
|
const localVarQueryParameter = {};
|
|
3967
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3968
4007
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3969
4008
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3970
4009
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3994,7 +4033,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3994
4033
|
};
|
|
3995
4034
|
const localVarHeaderParameter = {};
|
|
3996
4035
|
const localVarQueryParameter = {};
|
|
3997
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3998
4036
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3999
4037
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4000
4038
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4126,7 +4164,6 @@ const RobotConfigurationsApiAxiosParamCreator = function(configuration) {
|
|
|
4126
4164
|
};
|
|
4127
4165
|
const localVarHeaderParameter = {};
|
|
4128
4166
|
const localVarQueryParameter = {};
|
|
4129
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4130
4167
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4131
4168
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4132
4169
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4195,7 +4232,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4195
4232
|
};
|
|
4196
4233
|
const localVarHeaderParameter = {};
|
|
4197
4234
|
const localVarQueryParameter = {};
|
|
4198
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4199
4235
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4200
4236
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4201
4237
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4223,7 +4259,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4223
4259
|
};
|
|
4224
4260
|
const localVarHeaderParameter = {};
|
|
4225
4261
|
const localVarQueryParameter = {};
|
|
4226
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4227
4262
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4228
4263
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4229
4264
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4251,7 +4286,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4251
4286
|
};
|
|
4252
4287
|
const localVarHeaderParameter = {};
|
|
4253
4288
|
const localVarQueryParameter = {};
|
|
4254
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4255
4289
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4256
4290
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4257
4291
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4279,7 +4313,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4279
4313
|
};
|
|
4280
4314
|
const localVarHeaderParameter = {};
|
|
4281
4315
|
const localVarQueryParameter = {};
|
|
4282
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4283
4316
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4284
4317
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4285
4318
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4307,7 +4340,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4307
4340
|
};
|
|
4308
4341
|
const localVarHeaderParameter = {};
|
|
4309
4342
|
const localVarQueryParameter = {};
|
|
4310
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4311
4343
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4312
4344
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4313
4345
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4335,7 +4367,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4335
4367
|
};
|
|
4336
4368
|
const localVarHeaderParameter = {};
|
|
4337
4369
|
const localVarQueryParameter = {};
|
|
4338
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4339
4370
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4340
4371
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4341
4372
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4362,7 +4393,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4362
4393
|
};
|
|
4363
4394
|
const localVarHeaderParameter = {};
|
|
4364
4395
|
const localVarQueryParameter = {};
|
|
4365
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4366
4396
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4367
4397
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4368
4398
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4389,7 +4419,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4389
4419
|
};
|
|
4390
4420
|
const localVarHeaderParameter = {};
|
|
4391
4421
|
const localVarQueryParameter = {};
|
|
4392
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4393
4422
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4394
4423
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4395
4424
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4416,7 +4445,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4416
4445
|
};
|
|
4417
4446
|
const localVarHeaderParameter = {};
|
|
4418
4447
|
const localVarQueryParameter = {};
|
|
4419
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4420
4448
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4421
4449
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4422
4450
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4443,7 +4471,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4443
4471
|
};
|
|
4444
4472
|
const localVarHeaderParameter = {};
|
|
4445
4473
|
const localVarQueryParameter = {};
|
|
4446
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4447
4474
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4448
4475
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4449
4476
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4470,7 +4497,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4470
4497
|
};
|
|
4471
4498
|
const localVarHeaderParameter = {};
|
|
4472
4499
|
const localVarQueryParameter = {};
|
|
4473
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4474
4500
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4475
4501
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4476
4502
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4497,7 +4523,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4497
4523
|
};
|
|
4498
4524
|
const localVarHeaderParameter = {};
|
|
4499
4525
|
const localVarQueryParameter = {};
|
|
4500
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4501
4526
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4502
4527
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4503
4528
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4526,7 +4551,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4526
4551
|
};
|
|
4527
4552
|
const localVarHeaderParameter = {};
|
|
4528
4553
|
const localVarQueryParameter = {};
|
|
4529
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4530
4554
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4531
4555
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4532
4556
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4557,7 +4581,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4557
4581
|
};
|
|
4558
4582
|
const localVarHeaderParameter = {};
|
|
4559
4583
|
const localVarQueryParameter = {};
|
|
4560
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4561
4584
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4562
4585
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4563
4586
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4588,7 +4611,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4588
4611
|
};
|
|
4589
4612
|
const localVarHeaderParameter = {};
|
|
4590
4613
|
const localVarQueryParameter = {};
|
|
4591
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4592
4614
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4593
4615
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4594
4616
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4943,7 +4965,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4943
4965
|
};
|
|
4944
4966
|
const localVarHeaderParameter = {};
|
|
4945
4967
|
const localVarQueryParameter = {};
|
|
4946
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4947
4968
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4948
4969
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4949
4970
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4971,7 +4992,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4971
4992
|
};
|
|
4972
4993
|
const localVarHeaderParameter = {};
|
|
4973
4994
|
const localVarQueryParameter = {};
|
|
4974
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4975
4995
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4976
4996
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4977
4997
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4998,7 +5018,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4998
5018
|
};
|
|
4999
5019
|
const localVarHeaderParameter = {};
|
|
5000
5020
|
const localVarQueryParameter = {};
|
|
5001
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5002
5021
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5003
5022
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5004
5023
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5025,7 +5044,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5025
5044
|
};
|
|
5026
5045
|
const localVarHeaderParameter = {};
|
|
5027
5046
|
const localVarQueryParameter = {};
|
|
5028
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5029
5047
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5030
5048
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5031
5049
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5054,7 +5072,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5054
5072
|
};
|
|
5055
5073
|
const localVarHeaderParameter = {};
|
|
5056
5074
|
const localVarQueryParameter = {};
|
|
5057
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5058
5075
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5059
5076
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
5060
5077
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5210,7 +5227,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5210
5227
|
};
|
|
5211
5228
|
const localVarHeaderParameter = {};
|
|
5212
5229
|
const localVarQueryParameter = {};
|
|
5213
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5214
5230
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5215
5231
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5216
5232
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5238,7 +5254,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5238
5254
|
};
|
|
5239
5255
|
const localVarHeaderParameter = {};
|
|
5240
5256
|
const localVarQueryParameter = {};
|
|
5241
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5242
5257
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5243
5258
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5244
5259
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5266,7 +5281,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5266
5281
|
};
|
|
5267
5282
|
const localVarHeaderParameter = {};
|
|
5268
5283
|
const localVarQueryParameter = {};
|
|
5269
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5270
5284
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5271
5285
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5272
5286
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5294,7 +5308,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5294
5308
|
};
|
|
5295
5309
|
const localVarHeaderParameter = {};
|
|
5296
5310
|
const localVarQueryParameter = {};
|
|
5297
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5298
5311
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5299
5312
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5300
5313
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5321,7 +5334,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5321
5334
|
};
|
|
5322
5335
|
const localVarHeaderParameter = {};
|
|
5323
5336
|
const localVarQueryParameter = {};
|
|
5324
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5325
5337
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5326
5338
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5327
5339
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5350,7 +5362,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5350
5362
|
const localVarHeaderParameter = {};
|
|
5351
5363
|
const localVarQueryParameter = {};
|
|
5352
5364
|
const localVarFormParams = new (configuration && configuration.formDataCtor || FormData)();
|
|
5353
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5354
5365
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5355
5366
|
if (anyValue !== void 0) localVarFormParams.append("any_value", new Blob([JSON.stringify(anyValue)], { type: "application/json" }));
|
|
5356
5367
|
localVarHeaderParameter["Content-Type"] = "multipart/form-data";
|
|
@@ -5498,7 +5509,7 @@ var StoreObjectApi = class extends BaseAPI {
|
|
|
5498
5509
|
return StoreObjectApiFp(this.configuration).listAllObjectKeys(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5499
5510
|
}
|
|
5500
5511
|
/**
|
|
5501
|
-
* 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.
|
|
5512
|
+
* 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.
|
|
5502
5513
|
* @summary Store Object
|
|
5503
5514
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5504
5515
|
* @param {string} key
|
|
@@ -5527,7 +5538,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5527
5538
|
};
|
|
5528
5539
|
const localVarHeaderParameter = {};
|
|
5529
5540
|
const localVarQueryParameter = {};
|
|
5530
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5531
5541
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5532
5542
|
if (resources) localVarQueryParameter["resources"] = resources.join(COLLECTION_FORMATS.csv);
|
|
5533
5543
|
if (metadata !== void 0) localVarQueryParameter["metadata"] = metadata;
|
|
@@ -5555,7 +5565,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5555
5565
|
};
|
|
5556
5566
|
const localVarHeaderParameter = {};
|
|
5557
5567
|
const localVarQueryParameter = {};
|
|
5558
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5559
5568
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5560
5569
|
if (channel !== void 0) localVarQueryParameter["channel"] = channel;
|
|
5561
5570
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5581,7 +5590,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5581
5590
|
};
|
|
5582
5591
|
const localVarHeaderParameter = {};
|
|
5583
5592
|
const localVarQueryParameter = {};
|
|
5584
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5585
5593
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5586
5594
|
if (_interface !== void 0) localVarQueryParameter["interface"] = _interface;
|
|
5587
5595
|
if (cidr !== void 0) localVarQueryParameter["cidr"] = cidr;
|
|
@@ -5610,7 +5618,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5610
5618
|
};
|
|
5611
5619
|
const localVarHeaderParameter = {};
|
|
5612
5620
|
const localVarQueryParameter = {};
|
|
5613
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5614
5621
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5615
5622
|
if (operationId !== void 0) localVarQueryParameter["operation_id"] = operationId;
|
|
5616
5623
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5636,7 +5643,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5636
5643
|
};
|
|
5637
5644
|
const localVarHeaderParameter = {};
|
|
5638
5645
|
const localVarQueryParameter = {};
|
|
5639
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5640
5646
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5641
5647
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5642
5648
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5661,7 +5667,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5661
5667
|
};
|
|
5662
5668
|
const localVarHeaderParameter = {};
|
|
5663
5669
|
const localVarQueryParameter = {};
|
|
5664
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5665
5670
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5666
5671
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5667
5672
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5686,7 +5691,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5686
5691
|
};
|
|
5687
5692
|
const localVarHeaderParameter = {};
|
|
5688
5693
|
const localVarQueryParameter = {};
|
|
5689
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5690
5694
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5691
5695
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5692
5696
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5711,7 +5715,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5711
5715
|
};
|
|
5712
5716
|
const localVarHeaderParameter = {};
|
|
5713
5717
|
const localVarQueryParameter = {};
|
|
5714
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5715
5718
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5716
5719
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5717
5720
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5736,7 +5739,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5736
5739
|
};
|
|
5737
5740
|
const localVarHeaderParameter = {};
|
|
5738
5741
|
const localVarQueryParameter = {};
|
|
5739
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5740
5742
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5741
5743
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5742
5744
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5761,7 +5763,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5761
5763
|
};
|
|
5762
5764
|
const localVarHeaderParameter = {};
|
|
5763
5765
|
const localVarQueryParameter = {};
|
|
5764
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5765
5766
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5766
5767
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5767
5768
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5787,7 +5788,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5787
5788
|
};
|
|
5788
5789
|
const localVarHeaderParameter = {};
|
|
5789
5790
|
const localVarQueryParameter = {};
|
|
5790
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5791
5791
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5792
5792
|
if (resources) localVarQueryParameter["resources"] = resources.join(COLLECTION_FORMATS.csv);
|
|
5793
5793
|
localVarHeaderParameter["Content-Type"] = "application/gzip";
|
|
@@ -5816,7 +5816,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5816
5816
|
};
|
|
5817
5817
|
const localVarHeaderParameter = {};
|
|
5818
5818
|
const localVarQueryParameter = {};
|
|
5819
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5820
5819
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5821
5820
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
5822
5821
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6071,7 +6070,7 @@ var SystemApi = class extends BaseAPI {
|
|
|
6071
6070
|
return SystemApiFp(this.configuration).restoreConfiguration(body, resources, options).then((request) => request(this.axios, this.basePath));
|
|
6072
6071
|
}
|
|
6073
6072
|
/**
|
|
6074
|
-
* 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.
|
|
6073
|
+
* 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.
|
|
6075
6074
|
* @summary Update Wandelbots NOVA version
|
|
6076
6075
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
6077
6076
|
* @param {*} [options] Override http request option.
|
|
@@ -6101,7 +6100,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6101
6100
|
};
|
|
6102
6101
|
const localVarHeaderParameter = {};
|
|
6103
6102
|
const localVarQueryParameter = {};
|
|
6104
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6105
6103
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6106
6104
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6107
6105
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6131,7 +6129,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6131
6129
|
};
|
|
6132
6130
|
const localVarHeaderParameter = {};
|
|
6133
6131
|
const localVarQueryParameter = {};
|
|
6134
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6135
6132
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6136
6133
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6137
6134
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6160,7 +6157,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6160
6157
|
};
|
|
6161
6158
|
const localVarHeaderParameter = {};
|
|
6162
6159
|
const localVarQueryParameter = {};
|
|
6163
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6164
6160
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6165
6161
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6166
6162
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6189,7 +6185,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6189
6185
|
};
|
|
6190
6186
|
const localVarHeaderParameter = {};
|
|
6191
6187
|
const localVarQueryParameter = {};
|
|
6192
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6193
6188
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6194
6189
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6195
6190
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6217,7 +6212,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6217
6212
|
};
|
|
6218
6213
|
const localVarHeaderParameter = {};
|
|
6219
6214
|
const localVarQueryParameter = {};
|
|
6220
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6221
6215
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6222
6216
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6223
6217
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6299,7 +6293,7 @@ const TrajectoryCachingApiFactory = function(configuration, basePath, axios) {
|
|
|
6299
6293
|
*/
|
|
6300
6294
|
var TrajectoryCachingApi = class extends BaseAPI {
|
|
6301
6295
|
/**
|
|
6302
|
-
* 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.
|
|
6296
|
+
* 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.
|
|
6303
6297
|
* @summary Add Trajectory
|
|
6304
6298
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6305
6299
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6322,7 +6316,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6322
6316
|
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
6323
6317
|
}
|
|
6324
6318
|
/**
|
|
6325
|
-
* 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.
|
|
6319
|
+
* 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.
|
|
6326
6320
|
* @summary Delete Trajectory
|
|
6327
6321
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6328
6322
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6334,7 +6328,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6334
6328
|
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
6335
6329
|
}
|
|
6336
6330
|
/**
|
|
6337
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
6331
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
6338
6332
|
* @summary Get Trajectory
|
|
6339
6333
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6340
6334
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6346,7 +6340,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6346
6340
|
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
6347
6341
|
}
|
|
6348
6342
|
/**
|
|
6349
|
-
* 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.
|
|
6343
|
+
* 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.
|
|
6350
6344
|
* @summary List Trajectories
|
|
6351
6345
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6352
6346
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6376,7 +6370,6 @@ const TrajectoryExecutionApiAxiosParamCreator = function(configuration) {
|
|
|
6376
6370
|
};
|
|
6377
6371
|
const localVarHeaderParameter = {};
|
|
6378
6372
|
const localVarQueryParameter = {};
|
|
6379
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6380
6373
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6381
6374
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6382
6375
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6419,7 +6412,7 @@ const TrajectoryExecutionApiFactory = function(configuration, basePath, axios) {
|
|
|
6419
6412
|
*/
|
|
6420
6413
|
var TrajectoryExecutionApi = class extends BaseAPI {
|
|
6421
6414
|
/**
|
|
6422
|
-
* <!-- 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
|
|
6415
|
+
* <!-- 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.
|
|
6423
6416
|
* @summary Execute Trajectory
|
|
6424
6417
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6425
6418
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6450,7 +6443,6 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6450
6443
|
};
|
|
6451
6444
|
const localVarHeaderParameter = {};
|
|
6452
6445
|
const localVarQueryParameter = {};
|
|
6453
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6454
6446
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6455
6447
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6456
6448
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6480,7 +6472,6 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6480
6472
|
};
|
|
6481
6473
|
const localVarHeaderParameter = {};
|
|
6482
6474
|
const localVarQueryParameter = {};
|
|
6483
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6484
6475
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6485
6476
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6486
6477
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6537,7 +6528,7 @@ const TrajectoryPlanningApiFactory = function(configuration, basePath, axios) {
|
|
|
6537
6528
|
*/
|
|
6538
6529
|
var TrajectoryPlanningApi = class extends BaseAPI {
|
|
6539
6530
|
/**
|
|
6540
|
-
* 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](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
6531
|
+
* 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.
|
|
6541
6532
|
* @summary Plan Collision-Free Trajectory
|
|
6542
6533
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6543
6534
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -6548,7 +6539,7 @@ var TrajectoryPlanningApi = class extends BaseAPI {
|
|
|
6548
6539
|
return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6549
6540
|
}
|
|
6550
6541
|
/**
|
|
6551
|
-
* 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.
|
|
6542
|
+
* 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.
|
|
6552
6543
|
* @summary Plan Trajectory
|
|
6553
6544
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6554
6545
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -6574,7 +6565,6 @@ const VersionApiAxiosParamCreator = function(configuration) {
|
|
|
6574
6565
|
};
|
|
6575
6566
|
const localVarHeaderParameter = {};
|
|
6576
6567
|
const localVarQueryParameter = {};
|
|
6577
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6578
6568
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6579
6569
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6580
6570
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6645,7 +6635,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6645
6635
|
};
|
|
6646
6636
|
const localVarHeaderParameter = {};
|
|
6647
6637
|
const localVarQueryParameter = {};
|
|
6648
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6649
6638
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6650
6639
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6651
6640
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6661,6 +6650,36 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6661
6650
|
options: localVarRequestOptions
|
|
6662
6651
|
};
|
|
6663
6652
|
},
|
|
6653
|
+
addVirtualControllerMotionGroup: async (cell, controller, addVirtualControllerMotionGroupRequest, options = {}) => {
|
|
6654
|
+
assertParamExists("addVirtualControllerMotionGroup", "cell", cell);
|
|
6655
|
+
assertParamExists("addVirtualControllerMotionGroup", "controller", controller);
|
|
6656
|
+
assertParamExists("addVirtualControllerMotionGroup", "addVirtualControllerMotionGroupRequest", addVirtualControllerMotionGroupRequest);
|
|
6657
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
|
|
6658
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6659
|
+
let baseOptions;
|
|
6660
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6661
|
+
const localVarRequestOptions = {
|
|
6662
|
+
method: "POST",
|
|
6663
|
+
...baseOptions,
|
|
6664
|
+
...options
|
|
6665
|
+
};
|
|
6666
|
+
const localVarHeaderParameter = {};
|
|
6667
|
+
const localVarQueryParameter = {};
|
|
6668
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6669
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6670
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6671
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6672
|
+
localVarRequestOptions.headers = {
|
|
6673
|
+
...localVarHeaderParameter,
|
|
6674
|
+
...headersFromBaseOptions,
|
|
6675
|
+
...options.headers
|
|
6676
|
+
};
|
|
6677
|
+
localVarRequestOptions.data = serializeDataIfNeeded(addVirtualControllerMotionGroupRequest, localVarRequestOptions, configuration);
|
|
6678
|
+
return {
|
|
6679
|
+
url: toPathString(localVarUrlObj),
|
|
6680
|
+
options: localVarRequestOptions
|
|
6681
|
+
};
|
|
6682
|
+
},
|
|
6664
6683
|
addVirtualControllerTcp: async (cell, controller, motionGroup, tcp, robotTcpData, options = {}) => {
|
|
6665
6684
|
assertParamExists("addVirtualControllerTcp", "cell", cell);
|
|
6666
6685
|
assertParamExists("addVirtualControllerTcp", "controller", controller);
|
|
@@ -6678,7 +6697,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6678
6697
|
};
|
|
6679
6698
|
const localVarHeaderParameter = {};
|
|
6680
6699
|
const localVarQueryParameter = {};
|
|
6681
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6682
6700
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6683
6701
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6684
6702
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6709,7 +6727,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6709
6727
|
};
|
|
6710
6728
|
const localVarHeaderParameter = {};
|
|
6711
6729
|
const localVarQueryParameter = {};
|
|
6712
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6713
6730
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6714
6731
|
if (deleteDependent !== void 0) localVarQueryParameter["delete_dependent"] = deleteDependent;
|
|
6715
6732
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6724,6 +6741,34 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6724
6741
|
options: localVarRequestOptions
|
|
6725
6742
|
};
|
|
6726
6743
|
},
|
|
6744
|
+
deleteVirtualControllerMotionGroup: async (cell, controller, motionGroup, options = {}) => {
|
|
6745
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "cell", cell);
|
|
6746
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "controller", controller);
|
|
6747
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "motionGroup", motionGroup);
|
|
6748
|
+
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)));
|
|
6749
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6750
|
+
let baseOptions;
|
|
6751
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6752
|
+
const localVarRequestOptions = {
|
|
6753
|
+
method: "DELETE",
|
|
6754
|
+
...baseOptions,
|
|
6755
|
+
...options
|
|
6756
|
+
};
|
|
6757
|
+
const localVarHeaderParameter = {};
|
|
6758
|
+
const localVarQueryParameter = {};
|
|
6759
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6760
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6761
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6762
|
+
localVarRequestOptions.headers = {
|
|
6763
|
+
...localVarHeaderParameter,
|
|
6764
|
+
...headersFromBaseOptions,
|
|
6765
|
+
...options.headers
|
|
6766
|
+
};
|
|
6767
|
+
return {
|
|
6768
|
+
url: toPathString(localVarUrlObj),
|
|
6769
|
+
options: localVarRequestOptions
|
|
6770
|
+
};
|
|
6771
|
+
},
|
|
6727
6772
|
deleteVirtualControllerTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
|
|
6728
6773
|
assertParamExists("deleteVirtualControllerTcp", "cell", cell);
|
|
6729
6774
|
assertParamExists("deleteVirtualControllerTcp", "controller", controller);
|
|
@@ -6740,7 +6785,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6740
6785
|
};
|
|
6741
6786
|
const localVarHeaderParameter = {};
|
|
6742
6787
|
const localVarQueryParameter = {};
|
|
6743
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6744
6788
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6745
6789
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6746
6790
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6768,7 +6812,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6768
6812
|
};
|
|
6769
6813
|
const localVarHeaderParameter = {};
|
|
6770
6814
|
const localVarQueryParameter = {};
|
|
6771
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6772
6815
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6773
6816
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6774
6817
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6797,7 +6840,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6797
6840
|
};
|
|
6798
6841
|
const localVarHeaderParameter = {};
|
|
6799
6842
|
const localVarQueryParameter = {};
|
|
6800
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6801
6843
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6802
6844
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6803
6845
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6825,7 +6867,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6825
6867
|
};
|
|
6826
6868
|
const localVarHeaderParameter = {};
|
|
6827
6869
|
const localVarQueryParameter = {};
|
|
6828
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6829
6870
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6830
6871
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6831
6872
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6853,7 +6894,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6853
6894
|
};
|
|
6854
6895
|
const localVarHeaderParameter = {};
|
|
6855
6896
|
const localVarQueryParameter = {};
|
|
6856
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6857
6897
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6858
6898
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6859
6899
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6882,7 +6922,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6882
6922
|
};
|
|
6883
6923
|
const localVarHeaderParameter = {};
|
|
6884
6924
|
const localVarQueryParameter = {};
|
|
6885
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6886
6925
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6887
6926
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6888
6927
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6910,7 +6949,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6910
6949
|
};
|
|
6911
6950
|
const localVarHeaderParameter = {};
|
|
6912
6951
|
const localVarQueryParameter = {};
|
|
6913
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6914
6952
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6915
6953
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6916
6954
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6939,7 +6977,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6939
6977
|
};
|
|
6940
6978
|
const localVarHeaderParameter = {};
|
|
6941
6979
|
const localVarQueryParameter = {};
|
|
6942
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6943
6980
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6944
6981
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6945
6982
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6967,7 +7004,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6967
7004
|
};
|
|
6968
7005
|
const localVarHeaderParameter = {};
|
|
6969
7006
|
const localVarQueryParameter = {};
|
|
6970
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6971
7007
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6972
7008
|
if (active !== void 0) localVarQueryParameter["active"] = active;
|
|
6973
7009
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6998,7 +7034,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6998
7034
|
};
|
|
6999
7035
|
const localVarHeaderParameter = {};
|
|
7000
7036
|
const localVarQueryParameter = {};
|
|
7001
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7002
7037
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7003
7038
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7004
7039
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7029,7 +7064,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7029
7064
|
};
|
|
7030
7065
|
const localVarHeaderParameter = {};
|
|
7031
7066
|
const localVarQueryParameter = {};
|
|
7032
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7033
7067
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7034
7068
|
if (mode !== void 0) localVarQueryParameter["mode"] = mode;
|
|
7035
7069
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7060,7 +7094,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7060
7094
|
};
|
|
7061
7095
|
const localVarHeaderParameter = {};
|
|
7062
7096
|
const localVarQueryParameter = {};
|
|
7063
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7064
7097
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7065
7098
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7066
7099
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7090,6 +7123,12 @@ const VirtualControllerApiFp = function(configuration) {
|
|
|
7090
7123
|
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.addVirtualControllerCoordinateSystem"]?.[localVarOperationServerIndex]?.url;
|
|
7091
7124
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7092
7125
|
},
|
|
7126
|
+
async addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7127
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options);
|
|
7128
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7129
|
+
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.addVirtualControllerMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
7130
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7131
|
+
},
|
|
7093
7132
|
async addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
7094
7133
|
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
|
|
7095
7134
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -7102,6 +7141,12 @@ const VirtualControllerApiFp = function(configuration) {
|
|
|
7102
7141
|
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.deleteVirtualControllerCoordinateSystem"]?.[localVarOperationServerIndex]?.url;
|
|
7103
7142
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7104
7143
|
},
|
|
7144
|
+
async deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7145
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options);
|
|
7146
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7147
|
+
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.deleteVirtualControllerMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
7148
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7149
|
+
},
|
|
7105
7150
|
async deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
7106
7151
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options);
|
|
7107
7152
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -7185,12 +7230,18 @@ const VirtualControllerApiFactory = function(configuration, basePath, axios) {
|
|
|
7185
7230
|
addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
7186
7231
|
return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
|
|
7187
7232
|
},
|
|
7233
|
+
addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7234
|
+
return localVarFp.addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options).then((request) => request(axios, basePath));
|
|
7235
|
+
},
|
|
7188
7236
|
addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
7189
7237
|
return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
|
|
7190
7238
|
},
|
|
7191
7239
|
deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
7192
7240
|
return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
7193
7241
|
},
|
|
7242
|
+
deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7243
|
+
return localVarFp.deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
7244
|
+
},
|
|
7194
7245
|
deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
7195
7246
|
return localVarFp.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
|
|
7196
7247
|
},
|
|
@@ -7247,6 +7298,18 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7247
7298
|
return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
7248
7299
|
}
|
|
7249
7300
|
/**
|
|
7301
|
+
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json**: 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): 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.
|
|
7302
|
+
* @summary Add Motion Group
|
|
7303
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7304
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7305
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
7306
|
+
* @param {*} [options] Override http request option.
|
|
7307
|
+
* @throws {RequiredError}
|
|
7308
|
+
*/
|
|
7309
|
+
addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7310
|
+
return VirtualControllerApiFp(this.configuration).addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7311
|
+
}
|
|
7312
|
+
/**
|
|
7250
7313
|
* 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.
|
|
7251
7314
|
* @summary Add TCP
|
|
7252
7315
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7274,6 +7337,18 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7274
7337
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
7275
7338
|
}
|
|
7276
7339
|
/**
|
|
7340
|
+
* 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**.
|
|
7341
|
+
* @summary Delete Motion Group
|
|
7342
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7343
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7344
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7345
|
+
* @param {*} [options] Override http request option.
|
|
7346
|
+
* @throws {RequiredError}
|
|
7347
|
+
*/
|
|
7348
|
+
deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7349
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
7350
|
+
}
|
|
7351
|
+
/**
|
|
7277
7352
|
* 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.
|
|
7278
7353
|
* @summary Remove TCP
|
|
7279
7354
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7287,7 +7362,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7287
7362
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
7288
7363
|
}
|
|
7289
7364
|
/**
|
|
7290
|
-
* 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.
|
|
7365
|
+
* 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.
|
|
7291
7366
|
* @summary Get Emergency Stop State
|
|
7292
7367
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7293
7368
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7321,7 +7396,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7321
7396
|
return VirtualControllerApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7322
7397
|
}
|
|
7323
7398
|
/**
|
|
7324
|
-
* 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.
|
|
7399
|
+
* 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.
|
|
7325
7400
|
* @summary Get Operation Mode
|
|
7326
7401
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7327
7402
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7367,7 +7442,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7367
7442
|
return VirtualControllerApiFp(this.configuration).listVirtualControllerTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
7368
7443
|
}
|
|
7369
7444
|
/**
|
|
7370
|
-
* 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.
|
|
7445
|
+
* 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.
|
|
7371
7446
|
* @summary Push or Release Emergency Stop
|
|
7372
7447
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7373
7448
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7392,7 +7467,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7392
7467
|
return VirtualControllerApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
|
|
7393
7468
|
}
|
|
7394
7469
|
/**
|
|
7395
|
-
* 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.
|
|
7470
|
+
* 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.
|
|
7396
7471
|
* @summary Set Operation Mode
|
|
7397
7472
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7398
7473
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7437,7 +7512,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7437
7512
|
};
|
|
7438
7513
|
const localVarHeaderParameter = {};
|
|
7439
7514
|
const localVarQueryParameter = {};
|
|
7440
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7441
7515
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7442
7516
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7443
7517
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7467,7 +7541,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7467
7541
|
};
|
|
7468
7542
|
const localVarHeaderParameter = {};
|
|
7469
7543
|
const localVarQueryParameter = {};
|
|
7470
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7471
7544
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7472
7545
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7473
7546
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7495,7 +7568,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7495
7568
|
};
|
|
7496
7569
|
const localVarHeaderParameter = {};
|
|
7497
7570
|
const localVarQueryParameter = {};
|
|
7498
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7499
7571
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7500
7572
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7501
7573
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7523,7 +7595,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7523
7595
|
};
|
|
7524
7596
|
const localVarHeaderParameter = {};
|
|
7525
7597
|
const localVarQueryParameter = {};
|
|
7526
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7527
7598
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7528
7599
|
if (behavior !== void 0) localVarQueryParameter["behavior"] = behavior;
|
|
7529
7600
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7597,7 +7668,7 @@ const VirtualControllerBehaviorApiFactory = function(configuration, basePath, ax
|
|
|
7597
7668
|
*/
|
|
7598
7669
|
var VirtualControllerBehaviorApi = class extends BaseAPI {
|
|
7599
7670
|
/**
|
|
7600
|
-
* <!-- 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.
|
|
7671
|
+
* <!-- 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.
|
|
7601
7672
|
* @summary Stream Joint Configuration
|
|
7602
7673
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7603
7674
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7620,7 +7691,7 @@ var VirtualControllerBehaviorApi = class extends BaseAPI {
|
|
|
7620
7691
|
return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7621
7692
|
}
|
|
7622
7693
|
/**
|
|
7623
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
7694
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
7624
7695
|
* @summary Get Behavior
|
|
7625
7696
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7626
7697
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7663,7 +7734,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7663
7734
|
};
|
|
7664
7735
|
const localVarHeaderParameter = {};
|
|
7665
7736
|
const localVarQueryParameter = {};
|
|
7666
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7667
7737
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7668
7738
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
7669
7739
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7692,7 +7762,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7692
7762
|
};
|
|
7693
7763
|
const localVarHeaderParameter = {};
|
|
7694
7764
|
const localVarQueryParameter = {};
|
|
7695
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7696
7765
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7697
7766
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
7698
7767
|
if (direction !== void 0) localVarQueryParameter["direction"] = direction;
|
|
@@ -7725,7 +7794,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7725
7794
|
};
|
|
7726
7795
|
const localVarHeaderParameter = {};
|
|
7727
7796
|
const localVarQueryParameter = {};
|
|
7728
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7729
7797
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7730
7798
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7731
7799
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7791,7 +7859,7 @@ const VirtualControllerInputsOutputsApiFactory = function(configuration, basePat
|
|
|
7791
7859
|
*/
|
|
7792
7860
|
var VirtualControllerInputsOutputsApi = class extends BaseAPI {
|
|
7793
7861
|
/**
|
|
7794
|
-
* 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).
|
|
7862
|
+
* 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).
|
|
7795
7863
|
* @summary Get Input/Output Values
|
|
7796
7864
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7797
7865
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7950,4 +8018,4 @@ var Configuration = class {
|
|
|
7950
8018
|
};
|
|
7951
8019
|
|
|
7952
8020
|
//#endregion
|
|
7953
|
-
export { AbbControllerKindEnum, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, NetworkStateConnectionTypeEnum, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SettableRobotSystemMode, SingularityTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsControllerKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, YaskawaControllerKindEnum, operationServerMap };
|
|
8021
|
+
export { AbbControllerKindEnum, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, CollisionErrorKindEnum, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InconsistentTrajectorySizeErrorKindEnum, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, InvalidDofErrorKindEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointLimitExceededErrorKindEnum, JointTypeEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, NanValueErrorKindEnum, NetworkStateConnectionTypeEnum, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SettableRobotSystemMode, SingularityTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpRequiredErrorKindEnum, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, TorqueExceededErrorKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsControllerKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, YaskawaControllerKindEnum, operationServerMap };
|