@wandelbots/nova-api 26.2.0-dev.8 → 26.2.0-rc.1
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 +404 -227
- package/dist/v2/index.d.cts +644 -222
- package/dist/v2/index.d.ts +644 -222
- package/dist/v2/index.js +397 -228
- package/package.json +1 -1
package/dist/v2/index.cjs
CHANGED
|
@@ -41,12 +41,6 @@ const DUMMY_BASE_URL = "https://example.com";
|
|
|
41
41
|
const assertParamExists = function(functionName, paramName, paramValue) {
|
|
42
42
|
if (paramValue === null || paramValue === void 0) throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
|
|
43
43
|
};
|
|
44
|
-
const setBasicAuthToObject = function(object, configuration) {
|
|
45
|
-
if (configuration && (configuration.username || configuration.password)) object["auth"] = {
|
|
46
|
-
username: configuration.username,
|
|
47
|
-
password: configuration.password
|
|
48
|
-
};
|
|
49
|
-
};
|
|
50
44
|
const setBearerAuthToObject = async function(object, configuration) {
|
|
51
45
|
if (configuration && configuration.accessToken) object["Authorization"] = "Bearer " + (typeof configuration.accessToken === "function" ? await configuration.accessToken() : await configuration.accessToken);
|
|
52
46
|
};
|
|
@@ -83,7 +77,7 @@ const createRequestFunction = function(axiosArgs, globalAxios$2, BASE_PATH$1, co
|
|
|
83
77
|
//#region v2/api.ts
|
|
84
78
|
const AbbControllerKindEnum = { AbbController: "AbbController" };
|
|
85
79
|
/**
|
|
86
|
-
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
80
|
+
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that, the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](#/operations/externalJointsStream).
|
|
87
81
|
*/
|
|
88
82
|
const Behavior = {
|
|
89
83
|
BehaviorAutomatic: "BEHAVIOR_AUTOMATIC",
|
|
@@ -122,6 +116,7 @@ const BusIOsStateEnum = {
|
|
|
122
116
|
BusIosStateDisconnected: "BUS_IOS_STATE_DISCONNECTED"
|
|
123
117
|
};
|
|
124
118
|
const CapsuleShapeTypeEnum = { Capsule: "capsule" };
|
|
119
|
+
const CollisionErrorKindEnum = { CollisionError: "CollisionError" };
|
|
125
120
|
/**
|
|
126
121
|
* Comparator for the comparison of two values. The comparator is used to compare two values and return a boolean result. The default comparator is unknown.
|
|
127
122
|
*/
|
|
@@ -180,17 +175,24 @@ const IOValueType = {
|
|
|
180
175
|
IoValueAnalogFloat: "IO_VALUE_ANALOG_FLOAT",
|
|
181
176
|
IoValueAnalogInteger: "IO_VALUE_ANALOG_INTEGER"
|
|
182
177
|
};
|
|
178
|
+
const InconsistentTrajectorySizeErrorKindEnum = { InconsistentTrajectorySizeError: "InconsistentTrajectorySizeError" };
|
|
183
179
|
const InitializeJoggingRequestMessageTypeEnum = { InitializeJoggingRequest: "InitializeJoggingRequest" };
|
|
184
180
|
const InitializeJoggingResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
|
|
185
181
|
const InitializeMovementRequestMessageTypeEnum = { InitializeMovementRequest: "InitializeMovementRequest" };
|
|
186
182
|
const InitializeMovementResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
|
|
187
183
|
const IntegerValueValueTypeEnum = { Integer: "integer" };
|
|
184
|
+
const InvalidDofErrorKindEnum = { InvalidDofError: "InvalidDofError" };
|
|
188
185
|
const JoggingDetailsKindEnum = { Jogging: "JOGGING" };
|
|
189
186
|
const JoggingPausedByUserKindEnum = { PausedByUser: "PAUSED_BY_USER" };
|
|
190
187
|
const JoggingPausedNearCollisionKindEnum = { PausedNearCollision: "PAUSED_NEAR_COLLISION" };
|
|
191
188
|
const JoggingPausedNearJointLimitKindEnum = { PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT" };
|
|
192
189
|
const JoggingPausedOnIOKindEnum = { PausedOnIo: "PAUSED_ON_IO" };
|
|
193
190
|
const JoggingRunningKindEnum = { Running: "RUNNING" };
|
|
191
|
+
const JointLimitExceededErrorKindEnum = { JointLimitExceededError: "JointLimitExceededError" };
|
|
192
|
+
const JointTypeEnum = {
|
|
193
|
+
RevoluteJoint: "REVOLUTE_JOINT",
|
|
194
|
+
PrismaticJoint: "PRISMATIC_JOINT"
|
|
195
|
+
};
|
|
194
196
|
const JointVelocityRequestMessageTypeEnum = { JointVelocityRequest: "JointVelocityRequest" };
|
|
195
197
|
const JointVelocityResponseKindEnum = { JointVelocityReceived: "JOINT_VELOCITY_RECEIVED" };
|
|
196
198
|
const KukaControllerKindEnum = { KukaController: "KukaController" };
|
|
@@ -239,6 +241,7 @@ const ModbusIOTypeEnum = {
|
|
|
239
241
|
ModbusIoTypeFloat32: "MODBUS_IO_TYPE_FLOAT32"
|
|
240
242
|
};
|
|
241
243
|
const MovementErrorResponseKindEnum = { MotionError: "MOTION_ERROR" };
|
|
244
|
+
const NanValueErrorKindEnum = { NanValueError: "NanValueError" };
|
|
242
245
|
const NetworkStateConnectionTypeEnum = {
|
|
243
246
|
Ethernet: "ethernet",
|
|
244
247
|
Wifi: "wifi",
|
|
@@ -348,14 +351,14 @@ const RRTConnectAlgorithmAlgorithmNameEnum = { RrtConnectAlgorithm: "RRTConnectA
|
|
|
348
351
|
const RectangleShapeTypeEnum = { Rectangle: "rectangle" };
|
|
349
352
|
const RectangularCapsuleShapeTypeEnum = { RectangularCapsule: "rectangular_capsule" };
|
|
350
353
|
/**
|
|
351
|
-
* The channel that defines what a new Wandelbots NOVA version is. * `next` the
|
|
354
|
+
* The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
|
|
352
355
|
*/
|
|
353
356
|
const ReleaseChannel = {
|
|
354
357
|
Stable: "stable",
|
|
355
358
|
Next: "next"
|
|
356
359
|
};
|
|
357
360
|
/**
|
|
358
|
-
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
|
|
361
|
+
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](#/operations/addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](#/operations/getSupportedModes) to check Free Drive availability.
|
|
359
362
|
*/
|
|
360
363
|
const RobotSystemMode = {
|
|
361
364
|
ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED",
|
|
@@ -412,9 +415,14 @@ const ServiceStatusSeverity = {
|
|
|
412
415
|
Warning: "WARNING",
|
|
413
416
|
Error: "ERROR"
|
|
414
417
|
};
|
|
418
|
+
/**
|
|
419
|
+
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
|
|
420
|
+
*/
|
|
415
421
|
const SettableRobotSystemMode = {
|
|
416
422
|
RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR",
|
|
417
|
-
|
|
423
|
+
ModeMonitor: "MODE_MONITOR",
|
|
424
|
+
RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL",
|
|
425
|
+
ModeControl: "MODE_CONTROL"
|
|
418
426
|
};
|
|
419
427
|
const SingularityTypeEnum = {
|
|
420
428
|
Wrist: "WRIST",
|
|
@@ -424,8 +432,10 @@ const SingularityTypeEnum = {
|
|
|
424
432
|
const SphereShapeTypeEnum = { Sphere: "sphere" };
|
|
425
433
|
const StartMovementRequestMessageTypeEnum = { StartMovementRequest: "StartMovementRequest" };
|
|
426
434
|
const StartMovementResponseKindEnum = { StartReceived: "START_RECEIVED" };
|
|
435
|
+
const TcpRequiredErrorKindEnum = { TcpRequiredError: "TcpRequiredError" };
|
|
427
436
|
const TcpVelocityRequestMessageTypeEnum = { TcpVelocityRequest: "TcpVelocityRequest" };
|
|
428
437
|
const TcpVelocityResponseKindEnum = { TcpVelocityReceived: "TCP_VELOCITY_RECEIVED" };
|
|
438
|
+
const TorqueExceededErrorKindEnum = { TorqueExceededError: "TorqueExceededError" };
|
|
429
439
|
const TrajectoryDataMessageTypeEnum = { TrajectoryData: "TrajectoryData" };
|
|
430
440
|
const TrajectoryDetailsKindEnum = { Trajectory: "TRAJECTORY" };
|
|
431
441
|
const TrajectoryEndedKindEnum = { EndOfTrajectory: "END_OF_TRAJECTORY" };
|
|
@@ -471,7 +481,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
471
481
|
};
|
|
472
482
|
const localVarHeaderParameter = {};
|
|
473
483
|
const localVarQueryParameter = {};
|
|
474
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
475
484
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
476
485
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
477
486
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -501,7 +510,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
501
510
|
};
|
|
502
511
|
const localVarHeaderParameter = {};
|
|
503
512
|
const localVarQueryParameter = {};
|
|
504
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
505
513
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
506
514
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
507
515
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -530,7 +538,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
530
538
|
};
|
|
531
539
|
const localVarHeaderParameter = {};
|
|
532
540
|
const localVarQueryParameter = {};
|
|
533
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
534
541
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
535
542
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
536
543
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -559,7 +566,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
559
566
|
};
|
|
560
567
|
const localVarHeaderParameter = {};
|
|
561
568
|
const localVarQueryParameter = {};
|
|
562
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
563
569
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
564
570
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
565
571
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -586,7 +592,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
586
592
|
};
|
|
587
593
|
const localVarHeaderParameter = {};
|
|
588
594
|
const localVarQueryParameter = {};
|
|
589
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
590
595
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
591
596
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
592
597
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -615,7 +620,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
615
620
|
};
|
|
616
621
|
const localVarHeaderParameter = {};
|
|
617
622
|
const localVarQueryParameter = {};
|
|
618
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
619
623
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
620
624
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
621
625
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -744,7 +748,7 @@ var ApplicationApi = class extends BaseAPI {
|
|
|
744
748
|
return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
745
749
|
}
|
|
746
750
|
/**
|
|
747
|
-
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
|
|
751
|
+
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
|
|
748
752
|
* @summary Configuration
|
|
749
753
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
750
754
|
* @param {string} app
|
|
@@ -755,7 +759,7 @@ var ApplicationApi = class extends BaseAPI {
|
|
|
755
759
|
return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
|
|
756
760
|
}
|
|
757
761
|
/**
|
|
758
|
-
* List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
762
|
+
* List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
759
763
|
* @summary List Applications
|
|
760
764
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
761
765
|
* @param {*} [options] Override http request option.
|
|
@@ -797,7 +801,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
797
801
|
};
|
|
798
802
|
const localVarHeaderParameter = {};
|
|
799
803
|
const localVarQueryParameter = {};
|
|
800
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
801
804
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
802
805
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
803
806
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -829,7 +832,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
829
832
|
};
|
|
830
833
|
const localVarHeaderParameter = {};
|
|
831
834
|
const localVarQueryParameter = {};
|
|
832
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
833
835
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
834
836
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
835
837
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -860,7 +862,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
860
862
|
};
|
|
861
863
|
const localVarHeaderParameter = {};
|
|
862
864
|
const localVarQueryParameter = {};
|
|
863
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
864
865
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
865
866
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
866
867
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -889,7 +890,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
889
890
|
};
|
|
890
891
|
const localVarHeaderParameter = {};
|
|
891
892
|
const localVarQueryParameter = {};
|
|
892
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
893
893
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
894
894
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
895
895
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -917,7 +917,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
917
917
|
};
|
|
918
918
|
const localVarHeaderParameter = {};
|
|
919
919
|
const localVarQueryParameter = {};
|
|
920
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
921
920
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
922
921
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
923
922
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -944,7 +943,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
944
943
|
};
|
|
945
944
|
const localVarHeaderParameter = {};
|
|
946
945
|
const localVarQueryParameter = {};
|
|
947
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
948
946
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
949
947
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
950
948
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -972,7 +970,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
972
970
|
};
|
|
973
971
|
const localVarHeaderParameter = {};
|
|
974
972
|
const localVarQueryParameter = {};
|
|
975
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
976
973
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
977
974
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
978
975
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1000,7 +997,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1000
997
|
};
|
|
1001
998
|
const localVarHeaderParameter = {};
|
|
1002
999
|
const localVarQueryParameter = {};
|
|
1003
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1004
1000
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1005
1001
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1006
1002
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1027,7 +1023,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1027
1023
|
};
|
|
1028
1024
|
const localVarHeaderParameter = {};
|
|
1029
1025
|
const localVarQueryParameter = {};
|
|
1030
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1031
1026
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1032
1027
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1033
1028
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1054,7 +1049,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1054
1049
|
};
|
|
1055
1050
|
const localVarHeaderParameter = {};
|
|
1056
1051
|
const localVarQueryParameter = {};
|
|
1057
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1058
1052
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1059
1053
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1060
1054
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1081,7 +1075,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1081
1075
|
};
|
|
1082
1076
|
const localVarHeaderParameter = {};
|
|
1083
1077
|
const localVarQueryParameter = {};
|
|
1084
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1085
1078
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1086
1079
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
1087
1080
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1109,7 +1102,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1109
1102
|
};
|
|
1110
1103
|
const localVarHeaderParameter = {};
|
|
1111
1104
|
const localVarQueryParameter = {};
|
|
1112
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1113
1105
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1114
1106
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1115
1107
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1136,7 +1128,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1136
1128
|
};
|
|
1137
1129
|
const localVarHeaderParameter = {};
|
|
1138
1130
|
const localVarQueryParameter = {};
|
|
1139
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1140
1131
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1141
1132
|
if (inputOffset !== void 0) localVarQueryParameter["input_offset"] = inputOffset;
|
|
1142
1133
|
if (outputOffset !== void 0) localVarQueryParameter["output_offset"] = outputOffset;
|
|
@@ -1165,7 +1156,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1165
1156
|
};
|
|
1166
1157
|
const localVarHeaderParameter = {};
|
|
1167
1158
|
const localVarQueryParameter = {};
|
|
1168
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1169
1159
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1170
1160
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1171
1161
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1192,7 +1182,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1192
1182
|
};
|
|
1193
1183
|
const localVarHeaderParameter = {};
|
|
1194
1184
|
const localVarQueryParameter = {};
|
|
1195
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1196
1185
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1197
1186
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1198
1187
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1219,7 +1208,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1219
1208
|
};
|
|
1220
1209
|
const localVarHeaderParameter = {};
|
|
1221
1210
|
const localVarQueryParameter = {};
|
|
1222
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1223
1211
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1224
1212
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1225
1213
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1247,7 +1235,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1247
1235
|
};
|
|
1248
1236
|
const localVarHeaderParameter = {};
|
|
1249
1237
|
const localVarQueryParameter = {};
|
|
1250
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1251
1238
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1252
1239
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1253
1240
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1277,7 +1264,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1277
1264
|
};
|
|
1278
1265
|
const localVarHeaderParameter = {};
|
|
1279
1266
|
const localVarQueryParameter = {};
|
|
1280
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1281
1267
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1282
1268
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1283
1269
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1490,7 +1476,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1490
1476
|
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1491
1477
|
}
|
|
1492
1478
|
/**
|
|
1493
|
-
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
|
|
1479
|
+
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
|
|
1494
1480
|
* @summary Add MODBUS Input/Output
|
|
1495
1481
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1496
1482
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -1502,7 +1488,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1502
1488
|
return BUSInputsOutputsApiFp(this.configuration).addModbusIO(cell, io, modbusIOData, options).then((request) => request(this.axios, this.basePath));
|
|
1503
1489
|
}
|
|
1504
1490
|
/**
|
|
1505
|
-
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
1491
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
1506
1492
|
* @summary Add PROFINET Input/Output
|
|
1507
1493
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1508
1494
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -1546,7 +1532,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1546
1532
|
}
|
|
1547
1533
|
/**
|
|
1548
1534
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
1549
|
-
* @summary Remove MODBUS Input/
|
|
1535
|
+
* @summary Remove MODBUS Input/Output
|
|
1550
1536
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1551
1537
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1552
1538
|
* @param {*} [options] Override http request option.
|
|
@@ -1587,7 +1573,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1587
1573
|
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1588
1574
|
}
|
|
1589
1575
|
/**
|
|
1590
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
1576
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
|
|
1591
1577
|
* @summary Get Input/Output Values
|
|
1592
1578
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1593
1579
|
* @param {Array<string>} [ios]
|
|
@@ -1630,7 +1616,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1630
1616
|
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1631
1617
|
}
|
|
1632
1618
|
/**
|
|
1633
|
-
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
|
|
1619
|
+
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
|
|
1634
1620
|
* @summary List MODBUS Input/Output Configuration
|
|
1635
1621
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1636
1622
|
* @param {*} [options] Override http request option.
|
|
@@ -1640,7 +1626,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1640
1626
|
return BUSInputsOutputsApiFp(this.configuration).listModbusIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1641
1627
|
}
|
|
1642
1628
|
/**
|
|
1643
|
-
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
1629
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
1644
1630
|
* @summary List PROFINET Input/Output Configuration
|
|
1645
1631
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1646
1632
|
* @param {*} [options] Override http request option.
|
|
@@ -1650,7 +1636,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1650
1636
|
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1651
1637
|
}
|
|
1652
1638
|
/**
|
|
1653
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
1639
|
+
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
1654
1640
|
* @summary Set Output Values
|
|
1655
1641
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1656
1642
|
* @param {Array<IOValue>} iOValue
|
|
@@ -1661,7 +1647,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1661
1647
|
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
1662
1648
|
}
|
|
1663
1649
|
/**
|
|
1664
|
-
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
1650
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
1665
1651
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
1666
1652
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1667
1653
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -1677,6 +1663,34 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1677
1663
|
*/
|
|
1678
1664
|
const CellApiAxiosParamCreator = function(configuration) {
|
|
1679
1665
|
return {
|
|
1666
|
+
checkCellVersionUpdate: async (cell, channel, options = {}) => {
|
|
1667
|
+
assertParamExists("checkCellVersionUpdate", "cell", cell);
|
|
1668
|
+
assertParamExists("checkCellVersionUpdate", "channel", channel);
|
|
1669
|
+
const localVarPath = `/cells/{cell}/update`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1670
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1671
|
+
let baseOptions;
|
|
1672
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1673
|
+
const localVarRequestOptions = {
|
|
1674
|
+
method: "GET",
|
|
1675
|
+
...baseOptions,
|
|
1676
|
+
...options
|
|
1677
|
+
};
|
|
1678
|
+
const localVarHeaderParameter = {};
|
|
1679
|
+
const localVarQueryParameter = {};
|
|
1680
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1681
|
+
if (channel !== void 0) localVarQueryParameter["channel"] = channel;
|
|
1682
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1683
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1684
|
+
localVarRequestOptions.headers = {
|
|
1685
|
+
...localVarHeaderParameter,
|
|
1686
|
+
...headersFromBaseOptions,
|
|
1687
|
+
...options.headers
|
|
1688
|
+
};
|
|
1689
|
+
return {
|
|
1690
|
+
url: toPathString(localVarUrlObj),
|
|
1691
|
+
options: localVarRequestOptions
|
|
1692
|
+
};
|
|
1693
|
+
},
|
|
1680
1694
|
deleteCell: async (cell, completionTimeout, options = {}) => {
|
|
1681
1695
|
assertParamExists("deleteCell", "cell", cell);
|
|
1682
1696
|
const localVarPath = `/cells/{cell}`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
@@ -1690,7 +1704,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1690
1704
|
};
|
|
1691
1705
|
const localVarHeaderParameter = {};
|
|
1692
1706
|
const localVarQueryParameter = {};
|
|
1693
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1694
1707
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1695
1708
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1696
1709
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1717,7 +1730,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1717
1730
|
};
|
|
1718
1731
|
const localVarHeaderParameter = {};
|
|
1719
1732
|
const localVarQueryParameter = {};
|
|
1720
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1721
1733
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1722
1734
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1723
1735
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -1747,7 +1759,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1747
1759
|
};
|
|
1748
1760
|
const localVarHeaderParameter = {};
|
|
1749
1761
|
const localVarQueryParameter = {};
|
|
1750
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1751
1762
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1752
1763
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1753
1764
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1774,7 +1785,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1774
1785
|
};
|
|
1775
1786
|
const localVarHeaderParameter = {};
|
|
1776
1787
|
const localVarQueryParameter = {};
|
|
1777
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1778
1788
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1779
1789
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1780
1790
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1799,7 +1809,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1799
1809
|
};
|
|
1800
1810
|
const localVarHeaderParameter = {};
|
|
1801
1811
|
const localVarQueryParameter = {};
|
|
1802
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1803
1812
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1804
1813
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1805
1814
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1827,7 +1836,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1827
1836
|
};
|
|
1828
1837
|
const localVarHeaderParameter = {};
|
|
1829
1838
|
const localVarQueryParameter = {};
|
|
1830
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1831
1839
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1832
1840
|
if (operatingState !== void 0) localVarQueryParameter["operating_state"] = operatingState;
|
|
1833
1841
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1856,7 +1864,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1856
1864
|
};
|
|
1857
1865
|
const localVarHeaderParameter = {};
|
|
1858
1866
|
const localVarQueryParameter = {};
|
|
1859
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1860
1867
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1861
1868
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1862
1869
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -1872,6 +1879,35 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1872
1879
|
url: toPathString(localVarUrlObj),
|
|
1873
1880
|
options: localVarRequestOptions
|
|
1874
1881
|
};
|
|
1882
|
+
},
|
|
1883
|
+
updateCellVersion: async (cell, updateCellVersionRequest, options = {}) => {
|
|
1884
|
+
assertParamExists("updateCellVersion", "cell", cell);
|
|
1885
|
+
assertParamExists("updateCellVersion", "updateCellVersionRequest", updateCellVersionRequest);
|
|
1886
|
+
const localVarPath = `/cells/{cell}/update`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1887
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1888
|
+
let baseOptions;
|
|
1889
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1890
|
+
const localVarRequestOptions = {
|
|
1891
|
+
method: "PUT",
|
|
1892
|
+
...baseOptions,
|
|
1893
|
+
...options
|
|
1894
|
+
};
|
|
1895
|
+
const localVarHeaderParameter = {};
|
|
1896
|
+
const localVarQueryParameter = {};
|
|
1897
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1898
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1899
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1900
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1901
|
+
localVarRequestOptions.headers = {
|
|
1902
|
+
...localVarHeaderParameter,
|
|
1903
|
+
...headersFromBaseOptions,
|
|
1904
|
+
...options.headers
|
|
1905
|
+
};
|
|
1906
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCellVersionRequest, localVarRequestOptions, configuration);
|
|
1907
|
+
return {
|
|
1908
|
+
url: toPathString(localVarUrlObj),
|
|
1909
|
+
options: localVarRequestOptions
|
|
1910
|
+
};
|
|
1875
1911
|
}
|
|
1876
1912
|
};
|
|
1877
1913
|
};
|
|
@@ -1881,6 +1917,12 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1881
1917
|
const CellApiFp = function(configuration) {
|
|
1882
1918
|
const localVarAxiosParamCreator = CellApiAxiosParamCreator(configuration);
|
|
1883
1919
|
return {
|
|
1920
|
+
async checkCellVersionUpdate(cell, channel, options) {
|
|
1921
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkCellVersionUpdate(cell, channel, options);
|
|
1922
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1923
|
+
const localVarOperationServerBasePath = operationServerMap["CellApi.checkCellVersionUpdate"]?.[localVarOperationServerIndex]?.url;
|
|
1924
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1925
|
+
},
|
|
1884
1926
|
async deleteCell(cell, completionTimeout, options) {
|
|
1885
1927
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCell(cell, completionTimeout, options);
|
|
1886
1928
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -1922,6 +1964,12 @@ const CellApiFp = function(configuration) {
|
|
|
1922
1964
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1923
1965
|
const localVarOperationServerBasePath = operationServerMap["CellApi.updateCell"]?.[localVarOperationServerIndex]?.url;
|
|
1924
1966
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1967
|
+
},
|
|
1968
|
+
async updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
1969
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCellVersion(cell, updateCellVersionRequest, options);
|
|
1970
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1971
|
+
const localVarOperationServerBasePath = operationServerMap["CellApi.updateCellVersion"]?.[localVarOperationServerIndex]?.url;
|
|
1972
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
1925
1973
|
}
|
|
1926
1974
|
};
|
|
1927
1975
|
};
|
|
@@ -1931,6 +1979,9 @@ const CellApiFp = function(configuration) {
|
|
|
1931
1979
|
const CellApiFactory = function(configuration, basePath, axios$1) {
|
|
1932
1980
|
const localVarFp = CellApiFp(configuration);
|
|
1933
1981
|
return {
|
|
1982
|
+
checkCellVersionUpdate(cell, channel, options) {
|
|
1983
|
+
return localVarFp.checkCellVersionUpdate(cell, channel, options).then((request) => request(axios$1, basePath));
|
|
1984
|
+
},
|
|
1934
1985
|
deleteCell(cell, completionTimeout, options) {
|
|
1935
1986
|
return localVarFp.deleteCell(cell, completionTimeout, options).then((request) => request(axios$1, basePath));
|
|
1936
1987
|
},
|
|
@@ -1951,6 +2002,9 @@ const CellApiFactory = function(configuration, basePath, axios$1) {
|
|
|
1951
2002
|
},
|
|
1952
2003
|
updateCell(cell, cell2, completionTimeout, options) {
|
|
1953
2004
|
return localVarFp.updateCell(cell, cell2, completionTimeout, options).then((request) => request(axios$1, basePath));
|
|
2005
|
+
},
|
|
2006
|
+
updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
2007
|
+
return localVarFp.updateCellVersion(cell, updateCellVersionRequest, options).then((request) => request(axios$1, basePath));
|
|
1954
2008
|
}
|
|
1955
2009
|
};
|
|
1956
2010
|
};
|
|
@@ -1958,6 +2012,17 @@ const CellApiFactory = function(configuration, basePath, axios$1) {
|
|
|
1958
2012
|
* CellApi - object-oriented interface
|
|
1959
2013
|
*/
|
|
1960
2014
|
var CellApi = class extends BaseAPI {
|
|
2015
|
+
/**
|
|
2016
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
2017
|
+
* @summary Check Cell Update
|
|
2018
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2019
|
+
* @param {ReleaseChannel} channel
|
|
2020
|
+
* @param {*} [options] Override http request option.
|
|
2021
|
+
* @throws {RequiredError}
|
|
2022
|
+
*/
|
|
2023
|
+
checkCellVersionUpdate(cell, channel, options) {
|
|
2024
|
+
return CellApiFp(this.configuration).checkCellVersionUpdate(cell, channel, options).then((request) => request(this.axios, this.basePath));
|
|
2025
|
+
}
|
|
1961
2026
|
/**
|
|
1962
2027
|
* Delete an entire cell.
|
|
1963
2028
|
* @summary Delete Cell
|
|
@@ -2032,6 +2097,17 @@ var CellApi = class extends BaseAPI {
|
|
|
2032
2097
|
updateCell(cell, cell2, completionTimeout, options) {
|
|
2033
2098
|
return CellApiFp(this.configuration).updateCell(cell, cell2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2034
2099
|
}
|
|
2100
|
+
/**
|
|
2101
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
2102
|
+
* @summary Update Cell Version
|
|
2103
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2104
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
2105
|
+
* @param {*} [options] Override http request option.
|
|
2106
|
+
* @throws {RequiredError}
|
|
2107
|
+
*/
|
|
2108
|
+
updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
2109
|
+
return CellApiFp(this.configuration).updateCellVersion(cell, updateCellVersionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2110
|
+
}
|
|
2035
2111
|
};
|
|
2036
2112
|
/**
|
|
2037
2113
|
* ControllerApi - axios parameter creator
|
|
@@ -2052,7 +2128,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2052
2128
|
};
|
|
2053
2129
|
const localVarHeaderParameter = {};
|
|
2054
2130
|
const localVarQueryParameter = {};
|
|
2055
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2056
2131
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2057
2132
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2058
2133
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -2082,7 +2157,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2082
2157
|
};
|
|
2083
2158
|
const localVarHeaderParameter = {};
|
|
2084
2159
|
const localVarQueryParameter = {};
|
|
2085
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2086
2160
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2087
2161
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2088
2162
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2111,7 +2185,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2111
2185
|
};
|
|
2112
2186
|
const localVarHeaderParameter = {};
|
|
2113
2187
|
const localVarQueryParameter = {};
|
|
2114
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2115
2188
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2116
2189
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2117
2190
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2140,7 +2213,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2140
2213
|
};
|
|
2141
2214
|
const localVarHeaderParameter = {};
|
|
2142
2215
|
const localVarQueryParameter = {};
|
|
2143
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2144
2216
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2145
2217
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2146
2218
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2169,7 +2241,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2169
2241
|
};
|
|
2170
2242
|
const localVarHeaderParameter = {};
|
|
2171
2243
|
const localVarQueryParameter = {};
|
|
2172
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2173
2244
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2174
2245
|
if (orientationType !== void 0) localVarQueryParameter["orientation_type"] = orientationType;
|
|
2175
2246
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2198,7 +2269,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2198
2269
|
};
|
|
2199
2270
|
const localVarHeaderParameter = {};
|
|
2200
2271
|
const localVarQueryParameter = {};
|
|
2201
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2202
2272
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2203
2273
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2204
2274
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2226,7 +2296,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2226
2296
|
};
|
|
2227
2297
|
const localVarHeaderParameter = {};
|
|
2228
2298
|
const localVarQueryParameter = {};
|
|
2229
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2230
2299
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2231
2300
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2232
2301
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2254,7 +2323,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2254
2323
|
};
|
|
2255
2324
|
const localVarHeaderParameter = {};
|
|
2256
2325
|
const localVarQueryParameter = {};
|
|
2257
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2258
2326
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2259
2327
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2260
2328
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2282,7 +2350,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2282
2350
|
};
|
|
2283
2351
|
const localVarHeaderParameter = {};
|
|
2284
2352
|
const localVarQueryParameter = {};
|
|
2285
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2286
2353
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2287
2354
|
if (orientationType !== void 0) localVarQueryParameter["orientation_type"] = orientationType;
|
|
2288
2355
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2310,7 +2377,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2310
2377
|
};
|
|
2311
2378
|
const localVarHeaderParameter = {};
|
|
2312
2379
|
const localVarQueryParameter = {};
|
|
2313
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2314
2380
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2315
2381
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2316
2382
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2339,7 +2405,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2339
2405
|
};
|
|
2340
2406
|
const localVarHeaderParameter = {};
|
|
2341
2407
|
const localVarQueryParameter = {};
|
|
2342
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2343
2408
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2344
2409
|
if (mode !== void 0) localVarQueryParameter["mode"] = mode;
|
|
2345
2410
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2368,7 +2433,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2368
2433
|
};
|
|
2369
2434
|
const localVarHeaderParameter = {};
|
|
2370
2435
|
const localVarQueryParameter = {};
|
|
2371
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2372
2436
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2373
2437
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
2374
2438
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2397,7 +2461,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2397
2461
|
};
|
|
2398
2462
|
const localVarHeaderParameter = {};
|
|
2399
2463
|
const localVarQueryParameter = {};
|
|
2400
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2401
2464
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2402
2465
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
2403
2466
|
if (addControllerTimeout !== void 0) localVarQueryParameter["add_controller_timeout"] = addControllerTimeout;
|
|
@@ -2428,7 +2491,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2428
2491
|
};
|
|
2429
2492
|
const localVarHeaderParameter = {};
|
|
2430
2493
|
const localVarQueryParameter = {};
|
|
2431
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2432
2494
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2433
2495
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2434
2496
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -2606,7 +2668,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2606
2668
|
return ControllerApiFp(this.configuration).addRobotController(cell, robotController, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2607
2669
|
}
|
|
2608
2670
|
/**
|
|
2609
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
2671
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
2610
2672
|
* @summary Clear Robot Controllers
|
|
2611
2673
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2612
2674
|
* @param {number} [completionTimeout]
|
|
@@ -2629,7 +2691,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2629
2691
|
return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2630
2692
|
}
|
|
2631
2693
|
/**
|
|
2632
|
-
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
2694
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
|
|
2633
2695
|
* @summary Description
|
|
2634
2696
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2635
2697
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2675,7 +2737,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2675
2737
|
return ControllerApiFp(this.configuration).getRobotController(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2676
2738
|
}
|
|
2677
2739
|
/**
|
|
2678
|
-
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
|
|
2740
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
|
|
2679
2741
|
* @summary Virtual Controller Configuration
|
|
2680
2742
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2681
2743
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2708,7 +2770,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2708
2770
|
return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2709
2771
|
}
|
|
2710
2772
|
/**
|
|
2711
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2773
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2712
2774
|
* @summary Set Default Mode
|
|
2713
2775
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2714
2776
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2720,7 +2782,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2720
2782
|
return ControllerApiFp(this.configuration).setDefaultMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
2721
2783
|
}
|
|
2722
2784
|
/**
|
|
2723
|
-
* <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
|
|
2785
|
+
* <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
|
|
2724
2786
|
* @summary Stream Free Drive
|
|
2725
2787
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2726
2788
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2732,7 +2794,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2732
2794
|
return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
2733
2795
|
}
|
|
2734
2796
|
/**
|
|
2735
|
-
* <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2797
|
+
* <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2736
2798
|
* @summary Stream State
|
|
2737
2799
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2738
2800
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2745,7 +2807,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2745
2807
|
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2746
2808
|
}
|
|
2747
2809
|
/**
|
|
2748
|
-
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
|
|
2810
|
+
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
|
|
2749
2811
|
* @summary Update Robot Controller
|
|
2750
2812
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2751
2813
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2777,7 +2839,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2777
2839
|
};
|
|
2778
2840
|
const localVarHeaderParameter = {};
|
|
2779
2841
|
const localVarQueryParameter = {};
|
|
2780
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2781
2842
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2782
2843
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2783
2844
|
if (direction !== void 0) localVarQueryParameter["direction"] = direction;
|
|
@@ -2809,7 +2870,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2809
2870
|
};
|
|
2810
2871
|
const localVarHeaderParameter = {};
|
|
2811
2872
|
const localVarQueryParameter = {};
|
|
2812
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2813
2873
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2814
2874
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2815
2875
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2839,7 +2899,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2839
2899
|
};
|
|
2840
2900
|
const localVarHeaderParameter = {};
|
|
2841
2901
|
const localVarQueryParameter = {};
|
|
2842
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2843
2902
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2844
2903
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2845
2904
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2869,7 +2928,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2869
2928
|
};
|
|
2870
2929
|
const localVarHeaderParameter = {};
|
|
2871
2930
|
const localVarQueryParameter = {};
|
|
2872
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2873
2931
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2874
2932
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2875
2933
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2899,7 +2957,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2899
2957
|
};
|
|
2900
2958
|
const localVarHeaderParameter = {};
|
|
2901
2959
|
const localVarQueryParameter = {};
|
|
2902
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2903
2960
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2904
2961
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2905
2962
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2998,7 +3055,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
2998
3055
|
return ControllerInputsOutputsApiFp(this.configuration).listIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
2999
3056
|
}
|
|
3000
3057
|
/**
|
|
3001
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](listIODescriptions).
|
|
3058
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
|
|
3002
3059
|
* @summary Get Input/Output Values
|
|
3003
3060
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3004
3061
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3010,7 +3067,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3010
3067
|
return ControllerInputsOutputsApiFp(this.configuration).listIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3011
3068
|
}
|
|
3012
3069
|
/**
|
|
3013
|
-
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
3070
|
+
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
3014
3071
|
* @summary Set Output Values
|
|
3015
3072
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3016
3073
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3034,7 +3091,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3034
3091
|
return ControllerInputsOutputsApiFp(this.configuration).streamIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3035
3092
|
}
|
|
3036
3093
|
/**
|
|
3037
|
-
* Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
3094
|
+
* Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
3038
3095
|
* @summary Wait For
|
|
3039
3096
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3040
3097
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3065,7 +3122,6 @@ const JoggingApiAxiosParamCreator = function(configuration) {
|
|
|
3065
3122
|
};
|
|
3066
3123
|
const localVarHeaderParameter = {};
|
|
3067
3124
|
const localVarQueryParameter = {};
|
|
3068
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3069
3125
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3070
3126
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3071
3127
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3108,7 +3164,7 @@ const JoggingApiFactory = function(configuration, basePath, axios$1) {
|
|
|
3108
3164
|
*/
|
|
3109
3165
|
var JoggingApi = class extends BaseAPI {
|
|
3110
3166
|
/**
|
|
3111
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3167
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](#/operations/streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](#/operations/streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3112
3168
|
* @summary Execute Jogging
|
|
3113
3169
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3114
3170
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3139,7 +3195,6 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3139
3195
|
};
|
|
3140
3196
|
const localVarHeaderParameter = {};
|
|
3141
3197
|
const localVarQueryParameter = {};
|
|
3142
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3143
3198
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3144
3199
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3145
3200
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3169,7 +3224,6 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3169
3224
|
};
|
|
3170
3225
|
const localVarHeaderParameter = {};
|
|
3171
3226
|
const localVarQueryParameter = {};
|
|
3172
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3173
3227
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3174
3228
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3175
3229
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3265,7 +3319,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3265
3319
|
};
|
|
3266
3320
|
const localVarHeaderParameter = {};
|
|
3267
3321
|
const localVarQueryParameter = {};
|
|
3268
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3269
3322
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3270
3323
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3271
3324
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3292,7 +3345,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3292
3345
|
};
|
|
3293
3346
|
const localVarHeaderParameter = {};
|
|
3294
3347
|
const localVarQueryParameter = {};
|
|
3295
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3296
3348
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3297
3349
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3298
3350
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3317,7 +3369,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3317
3369
|
};
|
|
3318
3370
|
const localVarHeaderParameter = {};
|
|
3319
3371
|
const localVarQueryParameter = {};
|
|
3320
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3321
3372
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3322
3373
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3323
3374
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3342,7 +3393,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3342
3393
|
};
|
|
3343
3394
|
const localVarHeaderParameter = {};
|
|
3344
3395
|
const localVarQueryParameter = {};
|
|
3345
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3346
3396
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3347
3397
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3348
3398
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3472,7 +3522,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3472
3522
|
};
|
|
3473
3523
|
const localVarHeaderParameter = {};
|
|
3474
3524
|
const localVarQueryParameter = {};
|
|
3475
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3476
3525
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3477
3526
|
if (responseCoordinateSystem !== void 0) localVarQueryParameter["response_coordinate_system"] = responseCoordinateSystem;
|
|
3478
3527
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3502,7 +3551,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3502
3551
|
};
|
|
3503
3552
|
const localVarHeaderParameter = {};
|
|
3504
3553
|
const localVarQueryParameter = {};
|
|
3505
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3506
3554
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3507
3555
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3508
3556
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3531,7 +3579,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3531
3579
|
};
|
|
3532
3580
|
const localVarHeaderParameter = {};
|
|
3533
3581
|
const localVarQueryParameter = {};
|
|
3534
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3535
3582
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3536
3583
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
3537
3584
|
if (responseCoordinateSystem !== void 0) localVarQueryParameter["response_coordinate_system"] = responseCoordinateSystem;
|
|
@@ -3654,7 +3701,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3654
3701
|
};
|
|
3655
3702
|
const localVarHeaderParameter = {};
|
|
3656
3703
|
const localVarQueryParameter = {};
|
|
3657
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3658
3704
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3659
3705
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3660
3706
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3681,7 +3727,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3681
3727
|
};
|
|
3682
3728
|
const localVarHeaderParameter = {};
|
|
3683
3729
|
const localVarQueryParameter = {};
|
|
3684
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3685
3730
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3686
3731
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3687
3732
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3708,7 +3753,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3708
3753
|
};
|
|
3709
3754
|
const localVarHeaderParameter = {};
|
|
3710
3755
|
const localVarQueryParameter = {};
|
|
3711
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3712
3756
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3713
3757
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3714
3758
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3733,7 +3777,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3733
3777
|
};
|
|
3734
3778
|
const localVarHeaderParameter = {};
|
|
3735
3779
|
const localVarQueryParameter = {};
|
|
3736
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3737
3780
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3738
3781
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3739
3782
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3760,7 +3803,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3760
3803
|
};
|
|
3761
3804
|
const localVarHeaderParameter = {};
|
|
3762
3805
|
const localVarQueryParameter = {};
|
|
3763
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3764
3806
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3765
3807
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3766
3808
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3842,9 +3884,9 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios$1) {
|
|
|
3842
3884
|
*/
|
|
3843
3885
|
var MotionGroupModelsApi = class extends BaseAPI {
|
|
3844
3886
|
/**
|
|
3845
|
-
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
3887
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
3846
3888
|
* @summary Get Collision Model
|
|
3847
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3889
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3848
3890
|
* @param {*} [options] Override http request option.
|
|
3849
3891
|
* @throws {RequiredError}
|
|
3850
3892
|
*/
|
|
@@ -3852,9 +3894,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3852
3894
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3853
3895
|
}
|
|
3854
3896
|
/**
|
|
3855
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3897
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
3856
3898
|
* @summary Download GLB Model
|
|
3857
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3899
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3858
3900
|
* @param {*} [options] Override http request option.
|
|
3859
3901
|
* @throws {RequiredError}
|
|
3860
3902
|
*/
|
|
@@ -3862,9 +3904,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3862
3904
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupGlbModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3863
3905
|
}
|
|
3864
3906
|
/**
|
|
3865
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
3907
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
3866
3908
|
* @summary Get Kinematics
|
|
3867
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3909
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3868
3910
|
* @param {*} [options] Override http request option.
|
|
3869
3911
|
* @throws {RequiredError}
|
|
3870
3912
|
*/
|
|
@@ -3881,9 +3923,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3881
3923
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(options).then((request) => request(this.axios, this.basePath));
|
|
3882
3924
|
}
|
|
3883
3925
|
/**
|
|
3884
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3926
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
3885
3927
|
* @summary Download USD Model
|
|
3886
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3928
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3887
3929
|
* @param {*} [options] Override http request option.
|
|
3888
3930
|
* @throws {RequiredError}
|
|
3889
3931
|
*/
|
|
@@ -3910,7 +3952,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3910
3952
|
};
|
|
3911
3953
|
const localVarHeaderParameter = {};
|
|
3912
3954
|
const localVarQueryParameter = {};
|
|
3913
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3914
3955
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3915
3956
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3916
3957
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3937,7 +3978,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3937
3978
|
};
|
|
3938
3979
|
const localVarHeaderParameter = {};
|
|
3939
3980
|
const localVarQueryParameter = {};
|
|
3940
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3941
3981
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3942
3982
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3943
3983
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3966,7 +4006,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3966
4006
|
};
|
|
3967
4007
|
const localVarHeaderParameter = {};
|
|
3968
4008
|
const localVarQueryParameter = {};
|
|
3969
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3970
4009
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3971
4010
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3972
4011
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3996,7 +4035,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3996
4035
|
};
|
|
3997
4036
|
const localVarHeaderParameter = {};
|
|
3998
4037
|
const localVarQueryParameter = {};
|
|
3999
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4000
4038
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4001
4039
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4002
4040
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4117,57 +4155,108 @@ var ProgramApi = class extends BaseAPI {
|
|
|
4117
4155
|
* RobotConfigurationsApi - axios parameter creator
|
|
4118
4156
|
*/
|
|
4119
4157
|
const RobotConfigurationsApiAxiosParamCreator = function(configuration) {
|
|
4120
|
-
return {
|
|
4121
|
-
|
|
4122
|
-
|
|
4123
|
-
|
|
4124
|
-
|
|
4125
|
-
|
|
4126
|
-
|
|
4127
|
-
|
|
4128
|
-
|
|
4129
|
-
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
|
|
4133
|
-
|
|
4134
|
-
|
|
4135
|
-
|
|
4136
|
-
|
|
4137
|
-
|
|
4138
|
-
|
|
4139
|
-
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
|
|
4158
|
+
return {
|
|
4159
|
+
getControllerConfigFromArpScan: async (robotControllerConfigurationRequest, options = {}) => {
|
|
4160
|
+
assertParamExists("getControllerConfigFromArpScan", "robotControllerConfigurationRequest", robotControllerConfigurationRequest);
|
|
4161
|
+
const localVarUrlObj = new URL(`/experimental/system/network/controllers`, DUMMY_BASE_URL);
|
|
4162
|
+
let baseOptions;
|
|
4163
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
4164
|
+
const localVarRequestOptions = {
|
|
4165
|
+
method: "POST",
|
|
4166
|
+
...baseOptions,
|
|
4167
|
+
...options
|
|
4168
|
+
};
|
|
4169
|
+
const localVarHeaderParameter = {};
|
|
4170
|
+
const localVarQueryParameter = {};
|
|
4171
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4172
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4173
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4174
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4175
|
+
localVarRequestOptions.headers = {
|
|
4176
|
+
...localVarHeaderParameter,
|
|
4177
|
+
...headersFromBaseOptions,
|
|
4178
|
+
...options.headers
|
|
4179
|
+
};
|
|
4180
|
+
localVarRequestOptions.data = serializeDataIfNeeded(robotControllerConfigurationRequest, localVarRequestOptions, configuration);
|
|
4181
|
+
return {
|
|
4182
|
+
url: toPathString(localVarUrlObj),
|
|
4183
|
+
options: localVarRequestOptions
|
|
4184
|
+
};
|
|
4185
|
+
},
|
|
4186
|
+
getRobotConfigurations: async (options = {}) => {
|
|
4187
|
+
const localVarUrlObj = new URL(`/robot-configurations`, DUMMY_BASE_URL);
|
|
4188
|
+
let baseOptions;
|
|
4189
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
4190
|
+
const localVarRequestOptions = {
|
|
4191
|
+
method: "GET",
|
|
4192
|
+
...baseOptions,
|
|
4193
|
+
...options
|
|
4194
|
+
};
|
|
4195
|
+
const localVarHeaderParameter = {};
|
|
4196
|
+
const localVarQueryParameter = {};
|
|
4197
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4198
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4199
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4200
|
+
localVarRequestOptions.headers = {
|
|
4201
|
+
...localVarHeaderParameter,
|
|
4202
|
+
...headersFromBaseOptions,
|
|
4203
|
+
...options.headers
|
|
4204
|
+
};
|
|
4205
|
+
return {
|
|
4206
|
+
url: toPathString(localVarUrlObj),
|
|
4207
|
+
options: localVarRequestOptions
|
|
4208
|
+
};
|
|
4209
|
+
}
|
|
4210
|
+
};
|
|
4145
4211
|
};
|
|
4146
4212
|
/**
|
|
4147
4213
|
* RobotConfigurationsApi - functional programming interface
|
|
4148
4214
|
*/
|
|
4149
4215
|
const RobotConfigurationsApiFp = function(configuration) {
|
|
4150
4216
|
const localVarAxiosParamCreator = RobotConfigurationsApiAxiosParamCreator(configuration);
|
|
4151
|
-
return {
|
|
4152
|
-
|
|
4153
|
-
|
|
4154
|
-
|
|
4155
|
-
|
|
4156
|
-
|
|
4217
|
+
return {
|
|
4218
|
+
async getControllerConfigFromArpScan(robotControllerConfigurationRequest, options) {
|
|
4219
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getControllerConfigFromArpScan(robotControllerConfigurationRequest, options);
|
|
4220
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4221
|
+
const localVarOperationServerBasePath = operationServerMap["RobotConfigurationsApi.getControllerConfigFromArpScan"]?.[localVarOperationServerIndex]?.url;
|
|
4222
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
4223
|
+
},
|
|
4224
|
+
async getRobotConfigurations(options) {
|
|
4225
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRobotConfigurations(options);
|
|
4226
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4227
|
+
const localVarOperationServerBasePath = operationServerMap["RobotConfigurationsApi.getRobotConfigurations"]?.[localVarOperationServerIndex]?.url;
|
|
4228
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
4229
|
+
}
|
|
4230
|
+
};
|
|
4157
4231
|
};
|
|
4158
4232
|
/**
|
|
4159
4233
|
* RobotConfigurationsApi - factory interface
|
|
4160
4234
|
*/
|
|
4161
4235
|
const RobotConfigurationsApiFactory = function(configuration, basePath, axios$1) {
|
|
4162
4236
|
const localVarFp = RobotConfigurationsApiFp(configuration);
|
|
4163
|
-
return {
|
|
4164
|
-
|
|
4165
|
-
|
|
4237
|
+
return {
|
|
4238
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest, options) {
|
|
4239
|
+
return localVarFp.getControllerConfigFromArpScan(robotControllerConfigurationRequest, options).then((request) => request(axios$1, basePath));
|
|
4240
|
+
},
|
|
4241
|
+
getRobotConfigurations(options) {
|
|
4242
|
+
return localVarFp.getRobotConfigurations(options).then((request) => request(axios$1, basePath));
|
|
4243
|
+
}
|
|
4244
|
+
};
|
|
4166
4245
|
};
|
|
4167
4246
|
/**
|
|
4168
4247
|
* RobotConfigurationsApi - object-oriented interface
|
|
4169
4248
|
*/
|
|
4170
4249
|
var RobotConfigurationsApi = class extends BaseAPI {
|
|
4250
|
+
/**
|
|
4251
|
+
* Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
|
|
4252
|
+
* @summary Robot Controller Configurations
|
|
4253
|
+
* @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
|
|
4254
|
+
* @param {*} [options] Override http request option.
|
|
4255
|
+
* @throws {RequiredError}
|
|
4256
|
+
*/
|
|
4257
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest, options) {
|
|
4258
|
+
return RobotConfigurationsApiFp(this.configuration).getControllerConfigFromArpScan(robotControllerConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4259
|
+
}
|
|
4171
4260
|
/**
|
|
4172
4261
|
* Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
4173
4262
|
* @summary List Robot Configurations
|
|
@@ -4197,7 +4286,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4197
4286
|
};
|
|
4198
4287
|
const localVarHeaderParameter = {};
|
|
4199
4288
|
const localVarQueryParameter = {};
|
|
4200
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4201
4289
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4202
4290
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4203
4291
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4225,7 +4313,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4225
4313
|
};
|
|
4226
4314
|
const localVarHeaderParameter = {};
|
|
4227
4315
|
const localVarQueryParameter = {};
|
|
4228
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4229
4316
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4230
4317
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4231
4318
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4253,7 +4340,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4253
4340
|
};
|
|
4254
4341
|
const localVarHeaderParameter = {};
|
|
4255
4342
|
const localVarQueryParameter = {};
|
|
4256
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4257
4343
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4258
4344
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4259
4345
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4281,7 +4367,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4281
4367
|
};
|
|
4282
4368
|
const localVarHeaderParameter = {};
|
|
4283
4369
|
const localVarQueryParameter = {};
|
|
4284
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4285
4370
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4286
4371
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4287
4372
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4309,7 +4394,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4309
4394
|
};
|
|
4310
4395
|
const localVarHeaderParameter = {};
|
|
4311
4396
|
const localVarQueryParameter = {};
|
|
4312
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4313
4397
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4314
4398
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4315
4399
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4337,7 +4421,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4337
4421
|
};
|
|
4338
4422
|
const localVarHeaderParameter = {};
|
|
4339
4423
|
const localVarQueryParameter = {};
|
|
4340
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4341
4424
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4342
4425
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4343
4426
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4364,7 +4447,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4364
4447
|
};
|
|
4365
4448
|
const localVarHeaderParameter = {};
|
|
4366
4449
|
const localVarQueryParameter = {};
|
|
4367
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4368
4450
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4369
4451
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4370
4452
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4391,7 +4473,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4391
4473
|
};
|
|
4392
4474
|
const localVarHeaderParameter = {};
|
|
4393
4475
|
const localVarQueryParameter = {};
|
|
4394
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4395
4476
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4396
4477
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4397
4478
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4418,7 +4499,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4418
4499
|
};
|
|
4419
4500
|
const localVarHeaderParameter = {};
|
|
4420
4501
|
const localVarQueryParameter = {};
|
|
4421
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4422
4502
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4423
4503
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4424
4504
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4445,7 +4525,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4445
4525
|
};
|
|
4446
4526
|
const localVarHeaderParameter = {};
|
|
4447
4527
|
const localVarQueryParameter = {};
|
|
4448
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4449
4528
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4450
4529
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4451
4530
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4472,7 +4551,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4472
4551
|
};
|
|
4473
4552
|
const localVarHeaderParameter = {};
|
|
4474
4553
|
const localVarQueryParameter = {};
|
|
4475
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4476
4554
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4477
4555
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4478
4556
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4499,7 +4577,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4499
4577
|
};
|
|
4500
4578
|
const localVarHeaderParameter = {};
|
|
4501
4579
|
const localVarQueryParameter = {};
|
|
4502
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4503
4580
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4504
4581
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4505
4582
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4528,7 +4605,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4528
4605
|
};
|
|
4529
4606
|
const localVarHeaderParameter = {};
|
|
4530
4607
|
const localVarQueryParameter = {};
|
|
4531
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4532
4608
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4533
4609
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4534
4610
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4559,7 +4635,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4559
4635
|
};
|
|
4560
4636
|
const localVarHeaderParameter = {};
|
|
4561
4637
|
const localVarQueryParameter = {};
|
|
4562
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4563
4638
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4564
4639
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4565
4640
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4590,7 +4665,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4590
4665
|
};
|
|
4591
4666
|
const localVarHeaderParameter = {};
|
|
4592
4667
|
const localVarQueryParameter = {};
|
|
4593
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4594
4668
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4595
4669
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4596
4670
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4945,7 +5019,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4945
5019
|
};
|
|
4946
5020
|
const localVarHeaderParameter = {};
|
|
4947
5021
|
const localVarQueryParameter = {};
|
|
4948
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4949
5022
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4950
5023
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4951
5024
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4973,7 +5046,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4973
5046
|
};
|
|
4974
5047
|
const localVarHeaderParameter = {};
|
|
4975
5048
|
const localVarQueryParameter = {};
|
|
4976
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4977
5049
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4978
5050
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4979
5051
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5000,7 +5072,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5000
5072
|
};
|
|
5001
5073
|
const localVarHeaderParameter = {};
|
|
5002
5074
|
const localVarQueryParameter = {};
|
|
5003
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5004
5075
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5005
5076
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5006
5077
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5027,7 +5098,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5027
5098
|
};
|
|
5028
5099
|
const localVarHeaderParameter = {};
|
|
5029
5100
|
const localVarQueryParameter = {};
|
|
5030
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5031
5101
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5032
5102
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5033
5103
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5056,7 +5126,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5056
5126
|
};
|
|
5057
5127
|
const localVarHeaderParameter = {};
|
|
5058
5128
|
const localVarQueryParameter = {};
|
|
5059
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5060
5129
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5061
5130
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
5062
5131
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5212,7 +5281,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5212
5281
|
};
|
|
5213
5282
|
const localVarHeaderParameter = {};
|
|
5214
5283
|
const localVarQueryParameter = {};
|
|
5215
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5216
5284
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5217
5285
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5218
5286
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5240,7 +5308,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5240
5308
|
};
|
|
5241
5309
|
const localVarHeaderParameter = {};
|
|
5242
5310
|
const localVarQueryParameter = {};
|
|
5243
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5244
5311
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5245
5312
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5246
5313
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5268,7 +5335,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5268
5335
|
};
|
|
5269
5336
|
const localVarHeaderParameter = {};
|
|
5270
5337
|
const localVarQueryParameter = {};
|
|
5271
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5272
5338
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5273
5339
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5274
5340
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5296,7 +5362,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5296
5362
|
};
|
|
5297
5363
|
const localVarHeaderParameter = {};
|
|
5298
5364
|
const localVarQueryParameter = {};
|
|
5299
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5300
5365
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5301
5366
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5302
5367
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5323,7 +5388,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5323
5388
|
};
|
|
5324
5389
|
const localVarHeaderParameter = {};
|
|
5325
5390
|
const localVarQueryParameter = {};
|
|
5326
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5327
5391
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5328
5392
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5329
5393
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5352,7 +5416,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5352
5416
|
const localVarHeaderParameter = {};
|
|
5353
5417
|
const localVarQueryParameter = {};
|
|
5354
5418
|
const localVarFormParams = new (configuration && configuration.formDataCtor || FormData)();
|
|
5355
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5356
5419
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5357
5420
|
if (anyValue !== void 0) localVarFormParams.append("any_value", new Blob([JSON.stringify(anyValue)], { type: "application/json" }));
|
|
5358
5421
|
localVarHeaderParameter["Content-Type"] = "multipart/form-data";
|
|
@@ -5500,7 +5563,7 @@ var StoreObjectApi = class extends BaseAPI {
|
|
|
5500
5563
|
return StoreObjectApiFp(this.configuration).listAllObjectKeys(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5501
5564
|
}
|
|
5502
5565
|
/**
|
|
5503
|
-
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
5566
|
+
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
5504
5567
|
* @summary Store Object
|
|
5505
5568
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5506
5569
|
* @param {string} key
|
|
@@ -5529,7 +5592,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5529
5592
|
};
|
|
5530
5593
|
const localVarHeaderParameter = {};
|
|
5531
5594
|
const localVarQueryParameter = {};
|
|
5532
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5533
5595
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5534
5596
|
if (resources) localVarQueryParameter["resources"] = resources.join(COLLECTION_FORMATS.csv);
|
|
5535
5597
|
if (metadata !== void 0) localVarQueryParameter["metadata"] = metadata;
|
|
@@ -5557,7 +5619,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5557
5619
|
};
|
|
5558
5620
|
const localVarHeaderParameter = {};
|
|
5559
5621
|
const localVarQueryParameter = {};
|
|
5560
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5561
5622
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5562
5623
|
if (channel !== void 0) localVarQueryParameter["channel"] = channel;
|
|
5563
5624
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5583,7 +5644,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5583
5644
|
};
|
|
5584
5645
|
const localVarHeaderParameter = {};
|
|
5585
5646
|
const localVarQueryParameter = {};
|
|
5586
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5587
5647
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5588
5648
|
if (_interface !== void 0) localVarQueryParameter["interface"] = _interface;
|
|
5589
5649
|
if (cidr !== void 0) localVarQueryParameter["cidr"] = cidr;
|
|
@@ -5612,7 +5672,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5612
5672
|
};
|
|
5613
5673
|
const localVarHeaderParameter = {};
|
|
5614
5674
|
const localVarQueryParameter = {};
|
|
5615
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5616
5675
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5617
5676
|
if (operationId !== void 0) localVarQueryParameter["operation_id"] = operationId;
|
|
5618
5677
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5638,7 +5697,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5638
5697
|
};
|
|
5639
5698
|
const localVarHeaderParameter = {};
|
|
5640
5699
|
const localVarQueryParameter = {};
|
|
5641
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5642
5700
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5643
5701
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5644
5702
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5663,7 +5721,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5663
5721
|
};
|
|
5664
5722
|
const localVarHeaderParameter = {};
|
|
5665
5723
|
const localVarQueryParameter = {};
|
|
5666
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5667
5724
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5668
5725
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5669
5726
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5688,7 +5745,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5688
5745
|
};
|
|
5689
5746
|
const localVarHeaderParameter = {};
|
|
5690
5747
|
const localVarQueryParameter = {};
|
|
5691
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5692
5748
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5693
5749
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5694
5750
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5713,7 +5769,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5713
5769
|
};
|
|
5714
5770
|
const localVarHeaderParameter = {};
|
|
5715
5771
|
const localVarQueryParameter = {};
|
|
5716
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5717
5772
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5718
5773
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5719
5774
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5738,7 +5793,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5738
5793
|
};
|
|
5739
5794
|
const localVarHeaderParameter = {};
|
|
5740
5795
|
const localVarQueryParameter = {};
|
|
5741
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5742
5796
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5743
5797
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5744
5798
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5763,7 +5817,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5763
5817
|
};
|
|
5764
5818
|
const localVarHeaderParameter = {};
|
|
5765
5819
|
const localVarQueryParameter = {};
|
|
5766
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5767
5820
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5768
5821
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5769
5822
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5789,7 +5842,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5789
5842
|
};
|
|
5790
5843
|
const localVarHeaderParameter = {};
|
|
5791
5844
|
const localVarQueryParameter = {};
|
|
5792
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5793
5845
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5794
5846
|
if (resources) localVarQueryParameter["resources"] = resources.join(COLLECTION_FORMATS.csv);
|
|
5795
5847
|
localVarHeaderParameter["Content-Type"] = "application/gzip";
|
|
@@ -5818,7 +5870,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5818
5870
|
};
|
|
5819
5871
|
const localVarHeaderParameter = {};
|
|
5820
5872
|
const localVarQueryParameter = {};
|
|
5821
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5822
5873
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5823
5874
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
5824
5875
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6073,7 +6124,7 @@ var SystemApi = class extends BaseAPI {
|
|
|
6073
6124
|
return SystemApiFp(this.configuration).restoreConfiguration(body, resources, options).then((request) => request(this.axios, this.basePath));
|
|
6074
6125
|
}
|
|
6075
6126
|
/**
|
|
6076
|
-
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
|
|
6127
|
+
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
|
|
6077
6128
|
* @summary Update Wandelbots NOVA version
|
|
6078
6129
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
6079
6130
|
* @param {*} [options] Override http request option.
|
|
@@ -6103,7 +6154,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6103
6154
|
};
|
|
6104
6155
|
const localVarHeaderParameter = {};
|
|
6105
6156
|
const localVarQueryParameter = {};
|
|
6106
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6107
6157
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6108
6158
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6109
6159
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6133,7 +6183,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6133
6183
|
};
|
|
6134
6184
|
const localVarHeaderParameter = {};
|
|
6135
6185
|
const localVarQueryParameter = {};
|
|
6136
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6137
6186
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6138
6187
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6139
6188
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6162,7 +6211,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6162
6211
|
};
|
|
6163
6212
|
const localVarHeaderParameter = {};
|
|
6164
6213
|
const localVarQueryParameter = {};
|
|
6165
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6166
6214
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6167
6215
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6168
6216
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6191,7 +6239,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6191
6239
|
};
|
|
6192
6240
|
const localVarHeaderParameter = {};
|
|
6193
6241
|
const localVarQueryParameter = {};
|
|
6194
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6195
6242
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6196
6243
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6197
6244
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6219,7 +6266,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6219
6266
|
};
|
|
6220
6267
|
const localVarHeaderParameter = {};
|
|
6221
6268
|
const localVarQueryParameter = {};
|
|
6222
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6223
6269
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6224
6270
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6225
6271
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6301,7 +6347,7 @@ const TrajectoryCachingApiFactory = function(configuration, basePath, axios$1) {
|
|
|
6301
6347
|
*/
|
|
6302
6348
|
var TrajectoryCachingApi = class extends BaseAPI {
|
|
6303
6349
|
/**
|
|
6304
|
-
* Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
6350
|
+
* Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](#/operations/executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](#/operations/listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint.
|
|
6305
6351
|
* @summary Add Trajectory
|
|
6306
6352
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6307
6353
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6324,7 +6370,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6324
6370
|
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
6325
6371
|
}
|
|
6326
6372
|
/**
|
|
6327
|
-
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6373
|
+
* Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6328
6374
|
* @summary Delete Trajectory
|
|
6329
6375
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6330
6376
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6336,7 +6382,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6336
6382
|
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
6337
6383
|
}
|
|
6338
6384
|
/**
|
|
6339
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
6385
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
6340
6386
|
* @summary Get Trajectory
|
|
6341
6387
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6342
6388
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6348,7 +6394,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6348
6394
|
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
6349
6395
|
}
|
|
6350
6396
|
/**
|
|
6351
|
-
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
6397
|
+
* List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
6352
6398
|
* @summary List Trajectories
|
|
6353
6399
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6354
6400
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6378,7 +6424,6 @@ const TrajectoryExecutionApiAxiosParamCreator = function(configuration) {
|
|
|
6378
6424
|
};
|
|
6379
6425
|
const localVarHeaderParameter = {};
|
|
6380
6426
|
const localVarQueryParameter = {};
|
|
6381
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6382
6427
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6383
6428
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6384
6429
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6421,7 +6466,7 @@ const TrajectoryExecutionApiFactory = function(configuration, basePath, axios$1)
|
|
|
6421
6466
|
*/
|
|
6422
6467
|
var TrajectoryExecutionApi = class extends BaseAPI {
|
|
6423
6468
|
/**
|
|
6424
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or
|
|
6469
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](#/operations/planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](#/operations/planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](#/operations/executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](#/operations/streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
|
|
6425
6470
|
* @summary Execute Trajectory
|
|
6426
6471
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6427
6472
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6438,6 +6483,35 @@ var TrajectoryExecutionApi = class extends BaseAPI {
|
|
|
6438
6483
|
*/
|
|
6439
6484
|
const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
6440
6485
|
return {
|
|
6486
|
+
mergeTrajectories: async (cell, mergeTrajectoriesRequest, options = {}) => {
|
|
6487
|
+
assertParamExists("mergeTrajectories", "cell", cell);
|
|
6488
|
+
assertParamExists("mergeTrajectories", "mergeTrajectoriesRequest", mergeTrajectoriesRequest);
|
|
6489
|
+
const localVarPath = `/experimental/cells/{cell}/trajectory-planning/merge-trajectories`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
6490
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6491
|
+
let baseOptions;
|
|
6492
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6493
|
+
const localVarRequestOptions = {
|
|
6494
|
+
method: "POST",
|
|
6495
|
+
...baseOptions,
|
|
6496
|
+
...options
|
|
6497
|
+
};
|
|
6498
|
+
const localVarHeaderParameter = {};
|
|
6499
|
+
const localVarQueryParameter = {};
|
|
6500
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6501
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6502
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6503
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6504
|
+
localVarRequestOptions.headers = {
|
|
6505
|
+
...localVarHeaderParameter,
|
|
6506
|
+
...headersFromBaseOptions,
|
|
6507
|
+
...options.headers
|
|
6508
|
+
};
|
|
6509
|
+
localVarRequestOptions.data = serializeDataIfNeeded(mergeTrajectoriesRequest, localVarRequestOptions, configuration);
|
|
6510
|
+
return {
|
|
6511
|
+
url: toPathString(localVarUrlObj),
|
|
6512
|
+
options: localVarRequestOptions
|
|
6513
|
+
};
|
|
6514
|
+
},
|
|
6441
6515
|
planCollisionFree: async (cell, planCollisionFreeRequest, options = {}) => {
|
|
6442
6516
|
assertParamExists("planCollisionFree", "cell", cell);
|
|
6443
6517
|
assertParamExists("planCollisionFree", "planCollisionFreeRequest", planCollisionFreeRequest);
|
|
@@ -6452,7 +6526,6 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6452
6526
|
};
|
|
6453
6527
|
const localVarHeaderParameter = {};
|
|
6454
6528
|
const localVarQueryParameter = {};
|
|
6455
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6456
6529
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6457
6530
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6458
6531
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6482,7 +6555,6 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6482
6555
|
};
|
|
6483
6556
|
const localVarHeaderParameter = {};
|
|
6484
6557
|
const localVarQueryParameter = {};
|
|
6485
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6486
6558
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6487
6559
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6488
6560
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6506,6 +6578,12 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6506
6578
|
const TrajectoryPlanningApiFp = function(configuration) {
|
|
6507
6579
|
const localVarAxiosParamCreator = TrajectoryPlanningApiAxiosParamCreator(configuration);
|
|
6508
6580
|
return {
|
|
6581
|
+
async mergeTrajectories(cell, mergeTrajectoriesRequest, options) {
|
|
6582
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.mergeTrajectories(cell, mergeTrajectoriesRequest, options);
|
|
6583
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6584
|
+
const localVarOperationServerBasePath = operationServerMap["TrajectoryPlanningApi.mergeTrajectories"]?.[localVarOperationServerIndex]?.url;
|
|
6585
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
6586
|
+
},
|
|
6509
6587
|
async planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
6510
6588
|
const localVarAxiosArgs = await localVarAxiosParamCreator.planCollisionFree(cell, planCollisionFreeRequest, options);
|
|
6511
6589
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -6526,6 +6604,9 @@ const TrajectoryPlanningApiFp = function(configuration) {
|
|
|
6526
6604
|
const TrajectoryPlanningApiFactory = function(configuration, basePath, axios$1) {
|
|
6527
6605
|
const localVarFp = TrajectoryPlanningApiFp(configuration);
|
|
6528
6606
|
return {
|
|
6607
|
+
mergeTrajectories(cell, mergeTrajectoriesRequest, options) {
|
|
6608
|
+
return localVarFp.mergeTrajectories(cell, mergeTrajectoriesRequest, options).then((request) => request(axios$1, basePath));
|
|
6609
|
+
},
|
|
6529
6610
|
planCollisionFree(cell, planCollisionFreeRequest, options) {
|
|
6530
6611
|
return localVarFp.planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(axios$1, basePath));
|
|
6531
6612
|
},
|
|
@@ -6539,7 +6620,18 @@ const TrajectoryPlanningApiFactory = function(configuration, basePath, axios$1)
|
|
|
6539
6620
|
*/
|
|
6540
6621
|
var TrajectoryPlanningApi = class extends BaseAPI {
|
|
6541
6622
|
/**
|
|
6542
|
-
*
|
|
6623
|
+
* <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
|
|
6624
|
+
* @summary Merge Trajectories
|
|
6625
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6626
|
+
* @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
|
|
6627
|
+
* @param {*} [options] Override http request option.
|
|
6628
|
+
* @throws {RequiredError}
|
|
6629
|
+
*/
|
|
6630
|
+
mergeTrajectories(cell, mergeTrajectoriesRequest, options) {
|
|
6631
|
+
return TrajectoryPlanningApiFp(this.configuration).mergeTrajectories(cell, mergeTrajectoriesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6632
|
+
}
|
|
6633
|
+
/**
|
|
6634
|
+
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
6543
6635
|
* @summary Plan Collision-Free Trajectory
|
|
6544
6636
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6545
6637
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -6550,7 +6642,7 @@ var TrajectoryPlanningApi = class extends BaseAPI {
|
|
|
6550
6642
|
return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6551
6643
|
}
|
|
6552
6644
|
/**
|
|
6553
|
-
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
6645
|
+
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
6554
6646
|
* @summary Plan Trajectory
|
|
6555
6647
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6556
6648
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -6576,7 +6668,6 @@ const VersionApiAxiosParamCreator = function(configuration) {
|
|
|
6576
6668
|
};
|
|
6577
6669
|
const localVarHeaderParameter = {};
|
|
6578
6670
|
const localVarQueryParameter = {};
|
|
6579
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6580
6671
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6581
6672
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6582
6673
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6647,7 +6738,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6647
6738
|
};
|
|
6648
6739
|
const localVarHeaderParameter = {};
|
|
6649
6740
|
const localVarQueryParameter = {};
|
|
6650
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6651
6741
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6652
6742
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6653
6743
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6663,6 +6753,36 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6663
6753
|
options: localVarRequestOptions
|
|
6664
6754
|
};
|
|
6665
6755
|
},
|
|
6756
|
+
addVirtualControllerMotionGroup: async (cell, controller, addVirtualControllerMotionGroupRequest, options = {}) => {
|
|
6757
|
+
assertParamExists("addVirtualControllerMotionGroup", "cell", cell);
|
|
6758
|
+
assertParamExists("addVirtualControllerMotionGroup", "controller", controller);
|
|
6759
|
+
assertParamExists("addVirtualControllerMotionGroup", "addVirtualControllerMotionGroupRequest", addVirtualControllerMotionGroupRequest);
|
|
6760
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
|
|
6761
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6762
|
+
let baseOptions;
|
|
6763
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6764
|
+
const localVarRequestOptions = {
|
|
6765
|
+
method: "POST",
|
|
6766
|
+
...baseOptions,
|
|
6767
|
+
...options
|
|
6768
|
+
};
|
|
6769
|
+
const localVarHeaderParameter = {};
|
|
6770
|
+
const localVarQueryParameter = {};
|
|
6771
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6772
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6773
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6774
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6775
|
+
localVarRequestOptions.headers = {
|
|
6776
|
+
...localVarHeaderParameter,
|
|
6777
|
+
...headersFromBaseOptions,
|
|
6778
|
+
...options.headers
|
|
6779
|
+
};
|
|
6780
|
+
localVarRequestOptions.data = serializeDataIfNeeded(addVirtualControllerMotionGroupRequest, localVarRequestOptions, configuration);
|
|
6781
|
+
return {
|
|
6782
|
+
url: toPathString(localVarUrlObj),
|
|
6783
|
+
options: localVarRequestOptions
|
|
6784
|
+
};
|
|
6785
|
+
},
|
|
6666
6786
|
addVirtualControllerTcp: async (cell, controller, motionGroup, tcp, robotTcpData, options = {}) => {
|
|
6667
6787
|
assertParamExists("addVirtualControllerTcp", "cell", cell);
|
|
6668
6788
|
assertParamExists("addVirtualControllerTcp", "controller", controller);
|
|
@@ -6680,7 +6800,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6680
6800
|
};
|
|
6681
6801
|
const localVarHeaderParameter = {};
|
|
6682
6802
|
const localVarQueryParameter = {};
|
|
6683
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6684
6803
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6685
6804
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6686
6805
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6711,7 +6830,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6711
6830
|
};
|
|
6712
6831
|
const localVarHeaderParameter = {};
|
|
6713
6832
|
const localVarQueryParameter = {};
|
|
6714
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6715
6833
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6716
6834
|
if (deleteDependent !== void 0) localVarQueryParameter["delete_dependent"] = deleteDependent;
|
|
6717
6835
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6726,6 +6844,34 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6726
6844
|
options: localVarRequestOptions
|
|
6727
6845
|
};
|
|
6728
6846
|
},
|
|
6847
|
+
deleteVirtualControllerMotionGroup: async (cell, controller, motionGroup, options = {}) => {
|
|
6848
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "cell", cell);
|
|
6849
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "controller", controller);
|
|
6850
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "motionGroup", motionGroup);
|
|
6851
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups/{motion-group}`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller))).replace(`{motion-group}`, encodeURIComponent(String(motionGroup)));
|
|
6852
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6853
|
+
let baseOptions;
|
|
6854
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6855
|
+
const localVarRequestOptions = {
|
|
6856
|
+
method: "DELETE",
|
|
6857
|
+
...baseOptions,
|
|
6858
|
+
...options
|
|
6859
|
+
};
|
|
6860
|
+
const localVarHeaderParameter = {};
|
|
6861
|
+
const localVarQueryParameter = {};
|
|
6862
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6863
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6864
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6865
|
+
localVarRequestOptions.headers = {
|
|
6866
|
+
...localVarHeaderParameter,
|
|
6867
|
+
...headersFromBaseOptions,
|
|
6868
|
+
...options.headers
|
|
6869
|
+
};
|
|
6870
|
+
return {
|
|
6871
|
+
url: toPathString(localVarUrlObj),
|
|
6872
|
+
options: localVarRequestOptions
|
|
6873
|
+
};
|
|
6874
|
+
},
|
|
6729
6875
|
deleteVirtualControllerTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
|
|
6730
6876
|
assertParamExists("deleteVirtualControllerTcp", "cell", cell);
|
|
6731
6877
|
assertParamExists("deleteVirtualControllerTcp", "controller", controller);
|
|
@@ -6742,7 +6888,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6742
6888
|
};
|
|
6743
6889
|
const localVarHeaderParameter = {};
|
|
6744
6890
|
const localVarQueryParameter = {};
|
|
6745
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6746
6891
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6747
6892
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6748
6893
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6770,7 +6915,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6770
6915
|
};
|
|
6771
6916
|
const localVarHeaderParameter = {};
|
|
6772
6917
|
const localVarQueryParameter = {};
|
|
6773
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6774
6918
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6775
6919
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6776
6920
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6799,7 +6943,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6799
6943
|
};
|
|
6800
6944
|
const localVarHeaderParameter = {};
|
|
6801
6945
|
const localVarQueryParameter = {};
|
|
6802
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6803
6946
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6804
6947
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6805
6948
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6827,7 +6970,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6827
6970
|
};
|
|
6828
6971
|
const localVarHeaderParameter = {};
|
|
6829
6972
|
const localVarQueryParameter = {};
|
|
6830
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6831
6973
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6832
6974
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6833
6975
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6855,7 +6997,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6855
6997
|
};
|
|
6856
6998
|
const localVarHeaderParameter = {};
|
|
6857
6999
|
const localVarQueryParameter = {};
|
|
6858
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6859
7000
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6860
7001
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6861
7002
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6884,7 +7025,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6884
7025
|
};
|
|
6885
7026
|
const localVarHeaderParameter = {};
|
|
6886
7027
|
const localVarQueryParameter = {};
|
|
6887
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6888
7028
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6889
7029
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6890
7030
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6912,7 +7052,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6912
7052
|
};
|
|
6913
7053
|
const localVarHeaderParameter = {};
|
|
6914
7054
|
const localVarQueryParameter = {};
|
|
6915
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6916
7055
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6917
7056
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6918
7057
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6941,7 +7080,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6941
7080
|
};
|
|
6942
7081
|
const localVarHeaderParameter = {};
|
|
6943
7082
|
const localVarQueryParameter = {};
|
|
6944
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6945
7083
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6946
7084
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6947
7085
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6969,7 +7107,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6969
7107
|
};
|
|
6970
7108
|
const localVarHeaderParameter = {};
|
|
6971
7109
|
const localVarQueryParameter = {};
|
|
6972
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6973
7110
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6974
7111
|
if (active !== void 0) localVarQueryParameter["active"] = active;
|
|
6975
7112
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7000,7 +7137,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7000
7137
|
};
|
|
7001
7138
|
const localVarHeaderParameter = {};
|
|
7002
7139
|
const localVarQueryParameter = {};
|
|
7003
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7004
7140
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7005
7141
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7006
7142
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7031,7 +7167,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7031
7167
|
};
|
|
7032
7168
|
const localVarHeaderParameter = {};
|
|
7033
7169
|
const localVarQueryParameter = {};
|
|
7034
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7035
7170
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7036
7171
|
if (mode !== void 0) localVarQueryParameter["mode"] = mode;
|
|
7037
7172
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7062,7 +7197,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7062
7197
|
};
|
|
7063
7198
|
const localVarHeaderParameter = {};
|
|
7064
7199
|
const localVarQueryParameter = {};
|
|
7065
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7066
7200
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7067
7201
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7068
7202
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7092,6 +7226,12 @@ const VirtualControllerApiFp = function(configuration) {
|
|
|
7092
7226
|
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.addVirtualControllerCoordinateSystem"]?.[localVarOperationServerIndex]?.url;
|
|
7093
7227
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
7094
7228
|
},
|
|
7229
|
+
async addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7230
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options);
|
|
7231
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7232
|
+
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.addVirtualControllerMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
7233
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
7234
|
+
},
|
|
7095
7235
|
async addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
7096
7236
|
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
|
|
7097
7237
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -7104,6 +7244,12 @@ const VirtualControllerApiFp = function(configuration) {
|
|
|
7104
7244
|
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.deleteVirtualControllerCoordinateSystem"]?.[localVarOperationServerIndex]?.url;
|
|
7105
7245
|
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
7106
7246
|
},
|
|
7247
|
+
async deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7248
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options);
|
|
7249
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7250
|
+
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.deleteVirtualControllerMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
7251
|
+
return (axios$1, basePath) => createRequestFunction(localVarAxiosArgs, axios.default, BASE_PATH, configuration)(axios$1, localVarOperationServerBasePath || basePath);
|
|
7252
|
+
},
|
|
7107
7253
|
async deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
7108
7254
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options);
|
|
7109
7255
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -7187,12 +7333,18 @@ const VirtualControllerApiFactory = function(configuration, basePath, axios$1) {
|
|
|
7187
7333
|
addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
7188
7334
|
return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios$1, basePath));
|
|
7189
7335
|
},
|
|
7336
|
+
addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7337
|
+
return localVarFp.addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options).then((request) => request(axios$1, basePath));
|
|
7338
|
+
},
|
|
7190
7339
|
addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
7191
7340
|
return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios$1, basePath));
|
|
7192
7341
|
},
|
|
7193
7342
|
deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
7194
7343
|
return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios$1, basePath));
|
|
7195
7344
|
},
|
|
7345
|
+
deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7346
|
+
return localVarFp.deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options).then((request) => request(axios$1, basePath));
|
|
7347
|
+
},
|
|
7196
7348
|
deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
7197
7349
|
return localVarFp.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios$1, basePath));
|
|
7198
7350
|
},
|
|
@@ -7249,6 +7401,18 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7249
7401
|
return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
7250
7402
|
}
|
|
7251
7403
|
/**
|
|
7404
|
+
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
7405
|
+
* @summary Add Motion Group
|
|
7406
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7407
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7408
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
7409
|
+
* @param {*} [options] Override http request option.
|
|
7410
|
+
* @throws {RequiredError}
|
|
7411
|
+
*/
|
|
7412
|
+
addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7413
|
+
return VirtualControllerApiFp(this.configuration).addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7414
|
+
}
|
|
7415
|
+
/**
|
|
7252
7416
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
|
|
7253
7417
|
* @summary Add TCP
|
|
7254
7418
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7276,6 +7440,18 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7276
7440
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
7277
7441
|
}
|
|
7278
7442
|
/**
|
|
7443
|
+
* Removes a motion group configuration from the virtual controller. <!-- theme: info --> > #### NOTE > > When a motion group is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
|
|
7444
|
+
* @summary Delete Motion Group
|
|
7445
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7446
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7447
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7448
|
+
* @param {*} [options] Override http request option.
|
|
7449
|
+
* @throws {RequiredError}
|
|
7450
|
+
*/
|
|
7451
|
+
deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7452
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
7453
|
+
}
|
|
7454
|
+
/**
|
|
7279
7455
|
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
|
|
7280
7456
|
* @summary Remove TCP
|
|
7281
7457
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7289,7 +7465,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7289
7465
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
7290
7466
|
}
|
|
7291
7467
|
/**
|
|
7292
|
-
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
7468
|
+
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
7293
7469
|
* @summary Get Emergency Stop State
|
|
7294
7470
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7295
7471
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7323,7 +7499,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7323
7499
|
return VirtualControllerApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7324
7500
|
}
|
|
7325
7501
|
/**
|
|
7326
|
-
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7502
|
+
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7327
7503
|
* @summary Get Operation Mode
|
|
7328
7504
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7329
7505
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7369,7 +7545,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7369
7545
|
return VirtualControllerApiFp(this.configuration).listVirtualControllerTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
7370
7546
|
}
|
|
7371
7547
|
/**
|
|
7372
|
-
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
7548
|
+
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
7373
7549
|
* @summary Push or Release Emergency Stop
|
|
7374
7550
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7375
7551
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7394,7 +7570,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7394
7570
|
return VirtualControllerApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
|
|
7395
7571
|
}
|
|
7396
7572
|
/**
|
|
7397
|
-
* Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7573
|
+
* Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7398
7574
|
* @summary Set Operation Mode
|
|
7399
7575
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7400
7576
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7439,7 +7615,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7439
7615
|
};
|
|
7440
7616
|
const localVarHeaderParameter = {};
|
|
7441
7617
|
const localVarQueryParameter = {};
|
|
7442
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7443
7618
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7444
7619
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7445
7620
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7469,7 +7644,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7469
7644
|
};
|
|
7470
7645
|
const localVarHeaderParameter = {};
|
|
7471
7646
|
const localVarQueryParameter = {};
|
|
7472
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7473
7647
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7474
7648
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7475
7649
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7497,7 +7671,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7497
7671
|
};
|
|
7498
7672
|
const localVarHeaderParameter = {};
|
|
7499
7673
|
const localVarQueryParameter = {};
|
|
7500
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7501
7674
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7502
7675
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7503
7676
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7525,7 +7698,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7525
7698
|
};
|
|
7526
7699
|
const localVarHeaderParameter = {};
|
|
7527
7700
|
const localVarQueryParameter = {};
|
|
7528
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7529
7701
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7530
7702
|
if (behavior !== void 0) localVarQueryParameter["behavior"] = behavior;
|
|
7531
7703
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7599,7 +7771,7 @@ const VirtualControllerBehaviorApiFactory = function(configuration, basePath, ax
|
|
|
7599
7771
|
*/
|
|
7600
7772
|
var VirtualControllerBehaviorApi = class extends BaseAPI {
|
|
7601
7773
|
/**
|
|
7602
|
-
* <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
7774
|
+
* <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](#/operations/planTrajectory) and [executeTrajectory](#/operations/executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](#/operations/executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
7603
7775
|
* @summary Stream Joint Configuration
|
|
7604
7776
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7605
7777
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7622,7 +7794,7 @@ var VirtualControllerBehaviorApi = class extends BaseAPI {
|
|
|
7622
7794
|
return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7623
7795
|
}
|
|
7624
7796
|
/**
|
|
7625
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
7797
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
7626
7798
|
* @summary Get Behavior
|
|
7627
7799
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7628
7800
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7665,7 +7837,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7665
7837
|
};
|
|
7666
7838
|
const localVarHeaderParameter = {};
|
|
7667
7839
|
const localVarQueryParameter = {};
|
|
7668
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7669
7840
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7670
7841
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
7671
7842
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7694,7 +7865,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7694
7865
|
};
|
|
7695
7866
|
const localVarHeaderParameter = {};
|
|
7696
7867
|
const localVarQueryParameter = {};
|
|
7697
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7698
7868
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7699
7869
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
7700
7870
|
if (direction !== void 0) localVarQueryParameter["direction"] = direction;
|
|
@@ -7727,7 +7897,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7727
7897
|
};
|
|
7728
7898
|
const localVarHeaderParameter = {};
|
|
7729
7899
|
const localVarQueryParameter = {};
|
|
7730
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7731
7900
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7732
7901
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7733
7902
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7793,7 +7962,7 @@ const VirtualControllerInputsOutputsApiFactory = function(configuration, basePat
|
|
|
7793
7962
|
*/
|
|
7794
7963
|
var VirtualControllerInputsOutputsApi = class extends BaseAPI {
|
|
7795
7964
|
/**
|
|
7796
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
7965
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](#/operations/listVirtualControllerIODescriptions).
|
|
7797
7966
|
* @summary Get Input/Output Values
|
|
7798
7967
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7799
7968
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7985,6 +8154,7 @@ exports.CellApi = CellApi;
|
|
|
7985
8154
|
exports.CellApiAxiosParamCreator = CellApiAxiosParamCreator;
|
|
7986
8155
|
exports.CellApiFactory = CellApiFactory;
|
|
7987
8156
|
exports.CellApiFp = CellApiFp;
|
|
8157
|
+
exports.CollisionErrorKindEnum = CollisionErrorKindEnum;
|
|
7988
8158
|
exports.Comparator = Comparator;
|
|
7989
8159
|
exports.Configuration = Configuration;
|
|
7990
8160
|
exports.ConfigurationArchiveStatusCreatingStatusEnum = ConfigurationArchiveStatusCreatingStatusEnum;
|
|
@@ -8017,11 +8187,13 @@ exports.IOFloatValueValueTypeEnum = IOFloatValueValueTypeEnum;
|
|
|
8017
8187
|
exports.IOIntegerValueValueTypeEnum = IOIntegerValueValueTypeEnum;
|
|
8018
8188
|
exports.IOOrigin = IOOrigin;
|
|
8019
8189
|
exports.IOValueType = IOValueType;
|
|
8190
|
+
exports.InconsistentTrajectorySizeErrorKindEnum = InconsistentTrajectorySizeErrorKindEnum;
|
|
8020
8191
|
exports.InitializeJoggingRequestMessageTypeEnum = InitializeJoggingRequestMessageTypeEnum;
|
|
8021
8192
|
exports.InitializeJoggingResponseKindEnum = InitializeJoggingResponseKindEnum;
|
|
8022
8193
|
exports.InitializeMovementRequestMessageTypeEnum = InitializeMovementRequestMessageTypeEnum;
|
|
8023
8194
|
exports.InitializeMovementResponseKindEnum = InitializeMovementResponseKindEnum;
|
|
8024
8195
|
exports.IntegerValueValueTypeEnum = IntegerValueValueTypeEnum;
|
|
8196
|
+
exports.InvalidDofErrorKindEnum = InvalidDofErrorKindEnum;
|
|
8025
8197
|
exports.JoggingApi = JoggingApi;
|
|
8026
8198
|
exports.JoggingApiAxiosParamCreator = JoggingApiAxiosParamCreator;
|
|
8027
8199
|
exports.JoggingApiFactory = JoggingApiFactory;
|
|
@@ -8032,6 +8204,8 @@ exports.JoggingPausedNearCollisionKindEnum = JoggingPausedNearCollisionKindEnum;
|
|
|
8032
8204
|
exports.JoggingPausedNearJointLimitKindEnum = JoggingPausedNearJointLimitKindEnum;
|
|
8033
8205
|
exports.JoggingPausedOnIOKindEnum = JoggingPausedOnIOKindEnum;
|
|
8034
8206
|
exports.JoggingRunningKindEnum = JoggingRunningKindEnum;
|
|
8207
|
+
exports.JointLimitExceededErrorKindEnum = JointLimitExceededErrorKindEnum;
|
|
8208
|
+
exports.JointTypeEnum = JointTypeEnum;
|
|
8035
8209
|
exports.JointVelocityRequestMessageTypeEnum = JointVelocityRequestMessageTypeEnum;
|
|
8036
8210
|
exports.JointVelocityResponseKindEnum = JointVelocityResponseKindEnum;
|
|
8037
8211
|
exports.KinematicsApi = KinematicsApi;
|
|
@@ -8058,6 +8232,7 @@ exports.MotionGroupModelsApiAxiosParamCreator = MotionGroupModelsApiAxiosParamCr
|
|
|
8058
8232
|
exports.MotionGroupModelsApiFactory = MotionGroupModelsApiFactory;
|
|
8059
8233
|
exports.MotionGroupModelsApiFp = MotionGroupModelsApiFp;
|
|
8060
8234
|
exports.MovementErrorResponseKindEnum = MovementErrorResponseKindEnum;
|
|
8235
|
+
exports.NanValueErrorKindEnum = NanValueErrorKindEnum;
|
|
8061
8236
|
exports.NetworkStateConnectionTypeEnum = NetworkStateConnectionTypeEnum;
|
|
8062
8237
|
exports.OperatingState = OperatingState;
|
|
8063
8238
|
exports.OperationMode = OperationMode;
|
|
@@ -8116,8 +8291,10 @@ exports.SystemApi = SystemApi;
|
|
|
8116
8291
|
exports.SystemApiAxiosParamCreator = SystemApiAxiosParamCreator;
|
|
8117
8292
|
exports.SystemApiFactory = SystemApiFactory;
|
|
8118
8293
|
exports.SystemApiFp = SystemApiFp;
|
|
8294
|
+
exports.TcpRequiredErrorKindEnum = TcpRequiredErrorKindEnum;
|
|
8119
8295
|
exports.TcpVelocityRequestMessageTypeEnum = TcpVelocityRequestMessageTypeEnum;
|
|
8120
8296
|
exports.TcpVelocityResponseKindEnum = TcpVelocityResponseKindEnum;
|
|
8297
|
+
exports.TorqueExceededErrorKindEnum = TorqueExceededErrorKindEnum;
|
|
8121
8298
|
exports.TrajectoryCachingApi = TrajectoryCachingApi;
|
|
8122
8299
|
exports.TrajectoryCachingApiAxiosParamCreator = TrajectoryCachingApiAxiosParamCreator;
|
|
8123
8300
|
exports.TrajectoryCachingApiFactory = TrajectoryCachingApiFactory;
|