@wandelbots/nova-api 26.2.0-dev.5 → 26.2.0-dev.54
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 +256 -194
- package/dist/v2/index.d.cts +443 -221
- package/dist/v2/index.d.ts +583 -361
- package/dist/v2/index.js +256 -195
- package/package.json +1 -1
package/dist/v2/index.js
CHANGED
|
@@ -39,12 +39,6 @@ const DUMMY_BASE_URL = "https://example.com";
|
|
|
39
39
|
const assertParamExists = function(functionName, paramName, paramValue) {
|
|
40
40
|
if (paramValue === null || paramValue === void 0) throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
|
|
41
41
|
};
|
|
42
|
-
const setBasicAuthToObject = function(object, configuration) {
|
|
43
|
-
if (configuration && (configuration.username || configuration.password)) object["auth"] = {
|
|
44
|
-
username: configuration.username,
|
|
45
|
-
password: configuration.password
|
|
46
|
-
};
|
|
47
|
-
};
|
|
48
42
|
const setBearerAuthToObject = async function(object, configuration) {
|
|
49
43
|
if (configuration && configuration.accessToken) object["Authorization"] = "Bearer " + (typeof configuration.accessToken === "function" ? await configuration.accessToken() : await configuration.accessToken);
|
|
50
44
|
};
|
|
@@ -81,7 +75,7 @@ const createRequestFunction = function(axiosArgs, globalAxios$1, BASE_PATH$1, co
|
|
|
81
75
|
//#region v2/api.ts
|
|
82
76
|
const AbbControllerKindEnum = { AbbController: "AbbController" };
|
|
83
77
|
/**
|
|
84
|
-
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](externalJointsStream).
|
|
78
|
+
* ## BEHAVIOR_AUTOMATIC This is the default behavior. The motion groups of the controller take commanded joint configuration as actual joint state. Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the virtual robot will act like a physical one, e.g., with a cycle time of 8ms to respond to a new joint state command. ## BEHAVIOR_AUTOMATIC_NOT_COMPLY_WITH_CYCLETIME Configures the compliance of the virtual robot with the normal ControllerState cycle time. If set, the robot will respond as fast as possible, limited only by software execution speed. Because of that, the execution of a movement requires less time than with BEHAVIOR_AUTOMATIC. ## BEHAVIOR_EXTERNAL_SOURCE The external client is the only source of actual joint state changes. This mode is used to enable third party software indicating the current joint state via [externalJointsStream](#/operations/externalJointsStream).
|
|
85
79
|
*/
|
|
86
80
|
const Behavior = {
|
|
87
81
|
BehaviorAutomatic: "BEHAVIOR_AUTOMATIC",
|
|
@@ -189,6 +183,10 @@ const JoggingPausedNearCollisionKindEnum = { PausedNearCollision: "PAUSED_NEAR_C
|
|
|
189
183
|
const JoggingPausedNearJointLimitKindEnum = { PausedNearJointLimit: "PAUSED_NEAR_JOINT_LIMIT" };
|
|
190
184
|
const JoggingPausedOnIOKindEnum = { PausedOnIo: "PAUSED_ON_IO" };
|
|
191
185
|
const JoggingRunningKindEnum = { Running: "RUNNING" };
|
|
186
|
+
const JointTypeEnum = {
|
|
187
|
+
RevoluteJoint: "REVOLUTE_JOINT",
|
|
188
|
+
PrismaticJoint: "PRISMATIC_JOINT"
|
|
189
|
+
};
|
|
192
190
|
const JointVelocityRequestMessageTypeEnum = { JointVelocityRequest: "JointVelocityRequest" };
|
|
193
191
|
const JointVelocityResponseKindEnum = { JointVelocityReceived: "JOINT_VELOCITY_RECEIVED" };
|
|
194
192
|
const KukaControllerKindEnum = { KukaController: "KukaController" };
|
|
@@ -346,14 +344,14 @@ const RRTConnectAlgorithmAlgorithmNameEnum = { RrtConnectAlgorithm: "RRTConnectA
|
|
|
346
344
|
const RectangleShapeTypeEnum = { Rectangle: "rectangle" };
|
|
347
345
|
const RectangularCapsuleShapeTypeEnum = { RectangularCapsule: "rectangular_capsule" };
|
|
348
346
|
/**
|
|
349
|
-
* The channel that defines what a new Wandelbots NOVA version is. * `next` the
|
|
347
|
+
* The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
|
|
350
348
|
*/
|
|
351
349
|
const ReleaseChannel = {
|
|
352
350
|
Stable: "stable",
|
|
353
351
|
Next: "next"
|
|
354
352
|
};
|
|
355
353
|
/**
|
|
356
|
-
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](getSupportedModes) to check Free Drive availability.
|
|
354
|
+
* Defines the current system mode of the robot system, including NOVA communicating with the robot controller. ### MODE_CONTROLLER_NOT_CONFIGURED No controller with the specified identifier is configured. Call [addRobotController](#/operations/addRobotController) to register a controller. ### MODE_INITIALIZING Indicates that a connection to the robot controller is established or reestablished in case of a disconnect. On success, the controller is set to MODE_MONITOR. On failure, the initialization process is retried until successful or cancelled by the user. ### MODE_MONITOR Read-only mode with an active controller connection. - Receives robot state and I/O signals - Move requests are rejected - No commands are sent to the controller ### MODE_CONTROL Active control mode. **Movement is possible in this mode** The robot is cyclically commanded to hold its current position. The robot state is received in sync with the controller cycle. Motion and jogging requests are accepted and executed. Input/Output interaction is enabled. ### MODE_FREE_DRIVE Read-only mode with servo motors enabled for manual movement (Free Drive). Move requests are rejected. Not supported by all robots: Use [getSupportedModes](#/operations/getSupportedModes) to check Free Drive availability.
|
|
357
355
|
*/
|
|
358
356
|
const RobotSystemMode = {
|
|
359
357
|
ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED",
|
|
@@ -410,9 +408,14 @@ const ServiceStatusSeverity = {
|
|
|
410
408
|
Warning: "WARNING",
|
|
411
409
|
Error: "ERROR"
|
|
412
410
|
};
|
|
411
|
+
/**
|
|
412
|
+
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
|
|
413
|
+
*/
|
|
413
414
|
const SettableRobotSystemMode = {
|
|
414
415
|
RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR",
|
|
415
|
-
|
|
416
|
+
ModeMonitor: "MODE_MONITOR",
|
|
417
|
+
RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL",
|
|
418
|
+
ModeControl: "MODE_CONTROL"
|
|
416
419
|
};
|
|
417
420
|
const SingularityTypeEnum = {
|
|
418
421
|
Wrist: "WRIST",
|
|
@@ -469,7 +472,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
469
472
|
};
|
|
470
473
|
const localVarHeaderParameter = {};
|
|
471
474
|
const localVarQueryParameter = {};
|
|
472
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
473
475
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
474
476
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
475
477
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -499,7 +501,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
499
501
|
};
|
|
500
502
|
const localVarHeaderParameter = {};
|
|
501
503
|
const localVarQueryParameter = {};
|
|
502
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
503
504
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
504
505
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
505
506
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -528,7 +529,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
528
529
|
};
|
|
529
530
|
const localVarHeaderParameter = {};
|
|
530
531
|
const localVarQueryParameter = {};
|
|
531
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
532
532
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
533
533
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
534
534
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -557,7 +557,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
557
557
|
};
|
|
558
558
|
const localVarHeaderParameter = {};
|
|
559
559
|
const localVarQueryParameter = {};
|
|
560
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
561
560
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
562
561
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
563
562
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -584,7 +583,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
584
583
|
};
|
|
585
584
|
const localVarHeaderParameter = {};
|
|
586
585
|
const localVarQueryParameter = {};
|
|
587
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
588
586
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
589
587
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
590
588
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -613,7 +611,6 @@ const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
|
613
611
|
};
|
|
614
612
|
const localVarHeaderParameter = {};
|
|
615
613
|
const localVarQueryParameter = {};
|
|
616
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
617
614
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
618
615
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
619
616
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -742,7 +739,7 @@ var ApplicationApi = class extends BaseAPI {
|
|
|
742
739
|
return ApplicationApiFp(this.configuration).deleteApp(cell, app, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
743
740
|
}
|
|
744
741
|
/**
|
|
745
|
-
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](updateApp).
|
|
742
|
+
* Get the configuration for an active GUI application in the cell. To update the configuration of a GUI application in the cell, use this configuration with [updateApp](#/operations/updateApp).
|
|
746
743
|
* @summary Configuration
|
|
747
744
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
748
745
|
* @param {string} app
|
|
@@ -753,7 +750,7 @@ var ApplicationApi = class extends BaseAPI {
|
|
|
753
750
|
return ApplicationApiFp(this.configuration).getApp(cell, app, options).then((request) => request(this.axios, this.basePath));
|
|
754
751
|
}
|
|
755
752
|
/**
|
|
756
|
-
* List all GUI applications that have been added to a cell with [addApp](addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
753
|
+
* List all GUI applications that have been added to a cell with [addApp](#/operations/addApp). If the cell does not contain GUI applications, the list is returned empty.
|
|
757
754
|
* @summary List Applications
|
|
758
755
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
759
756
|
* @param {*} [options] Override http request option.
|
|
@@ -795,7 +792,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
795
792
|
};
|
|
796
793
|
const localVarHeaderParameter = {};
|
|
797
794
|
const localVarQueryParameter = {};
|
|
798
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
799
795
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
800
796
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
801
797
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -827,7 +823,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
827
823
|
};
|
|
828
824
|
const localVarHeaderParameter = {};
|
|
829
825
|
const localVarQueryParameter = {};
|
|
830
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
831
826
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
832
827
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
833
828
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -858,7 +853,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
858
853
|
};
|
|
859
854
|
const localVarHeaderParameter = {};
|
|
860
855
|
const localVarQueryParameter = {};
|
|
861
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
862
856
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
863
857
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
864
858
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -887,7 +881,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
887
881
|
};
|
|
888
882
|
const localVarHeaderParameter = {};
|
|
889
883
|
const localVarQueryParameter = {};
|
|
890
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
891
884
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
892
885
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
893
886
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -915,7 +908,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
915
908
|
};
|
|
916
909
|
const localVarHeaderParameter = {};
|
|
917
910
|
const localVarQueryParameter = {};
|
|
918
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
919
911
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
920
912
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
921
913
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -942,7 +934,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
942
934
|
};
|
|
943
935
|
const localVarHeaderParameter = {};
|
|
944
936
|
const localVarQueryParameter = {};
|
|
945
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
946
937
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
947
938
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
948
939
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -970,7 +961,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
970
961
|
};
|
|
971
962
|
const localVarHeaderParameter = {};
|
|
972
963
|
const localVarQueryParameter = {};
|
|
973
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
974
964
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
975
965
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
976
966
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -998,7 +988,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
998
988
|
};
|
|
999
989
|
const localVarHeaderParameter = {};
|
|
1000
990
|
const localVarQueryParameter = {};
|
|
1001
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1002
991
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1003
992
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1004
993
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1025,7 +1014,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1025
1014
|
};
|
|
1026
1015
|
const localVarHeaderParameter = {};
|
|
1027
1016
|
const localVarQueryParameter = {};
|
|
1028
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1029
1017
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1030
1018
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1031
1019
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1052,7 +1040,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1052
1040
|
};
|
|
1053
1041
|
const localVarHeaderParameter = {};
|
|
1054
1042
|
const localVarQueryParameter = {};
|
|
1055
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1056
1043
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1057
1044
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1058
1045
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1079,7 +1066,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1079
1066
|
};
|
|
1080
1067
|
const localVarHeaderParameter = {};
|
|
1081
1068
|
const localVarQueryParameter = {};
|
|
1082
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1083
1069
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1084
1070
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
1085
1071
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1107,7 +1093,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1107
1093
|
};
|
|
1108
1094
|
const localVarHeaderParameter = {};
|
|
1109
1095
|
const localVarQueryParameter = {};
|
|
1110
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1111
1096
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1112
1097
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1113
1098
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1134,7 +1119,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1134
1119
|
};
|
|
1135
1120
|
const localVarHeaderParameter = {};
|
|
1136
1121
|
const localVarQueryParameter = {};
|
|
1137
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1138
1122
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1139
1123
|
if (inputOffset !== void 0) localVarQueryParameter["input_offset"] = inputOffset;
|
|
1140
1124
|
if (outputOffset !== void 0) localVarQueryParameter["output_offset"] = outputOffset;
|
|
@@ -1163,7 +1147,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1163
1147
|
};
|
|
1164
1148
|
const localVarHeaderParameter = {};
|
|
1165
1149
|
const localVarQueryParameter = {};
|
|
1166
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1167
1150
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1168
1151
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1169
1152
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1190,7 +1173,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1190
1173
|
};
|
|
1191
1174
|
const localVarHeaderParameter = {};
|
|
1192
1175
|
const localVarQueryParameter = {};
|
|
1193
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1194
1176
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1195
1177
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1196
1178
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1217,7 +1199,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1217
1199
|
};
|
|
1218
1200
|
const localVarHeaderParameter = {};
|
|
1219
1201
|
const localVarQueryParameter = {};
|
|
1220
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1221
1202
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1222
1203
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1223
1204
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1245,7 +1226,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1245
1226
|
};
|
|
1246
1227
|
const localVarHeaderParameter = {};
|
|
1247
1228
|
const localVarQueryParameter = {};
|
|
1248
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1249
1229
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1250
1230
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1251
1231
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1275,7 +1255,6 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1275
1255
|
};
|
|
1276
1256
|
const localVarHeaderParameter = {};
|
|
1277
1257
|
const localVarQueryParameter = {};
|
|
1278
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1279
1258
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1280
1259
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1281
1260
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1488,7 +1467,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1488
1467
|
return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
1489
1468
|
}
|
|
1490
1469
|
/**
|
|
1491
|
-
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](listModbusIOs).
|
|
1470
|
+
* Adds an input/output variable to or updates an input/output variable on the MODBUS device, e.g., NOVA\'s MODBUS service. The inputs/outputs map variables to specific memory addresses in the process image. The NOVA\'s MODBUS service\'s configuration can be viewed via [listModbusIOs](#/operations/listModbusIOs).
|
|
1492
1471
|
* @summary Add MODBUS Input/Output
|
|
1493
1472
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1494
1473
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -1500,7 +1479,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1500
1479
|
return BUSInputsOutputsApiFp(this.configuration).addModbusIO(cell, io, modbusIOData, options).then((request) => request(this.axios, this.basePath));
|
|
1501
1480
|
}
|
|
1502
1481
|
/**
|
|
1503
|
-
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
1482
|
+
* Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g., NOVA\'s PROFINET service. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal).
|
|
1504
1483
|
* @summary Add PROFINET Input/Output
|
|
1505
1484
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1506
1485
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -1544,7 +1523,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1544
1523
|
}
|
|
1545
1524
|
/**
|
|
1546
1525
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
1547
|
-
* @summary Remove MODBUS Input/
|
|
1526
|
+
* @summary Remove MODBUS Input/Output
|
|
1548
1527
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1549
1528
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
1550
1529
|
* @param {*} [options] Override http request option.
|
|
@@ -1585,7 +1564,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1585
1564
|
return BUSInputsOutputsApiFp(this.configuration).getBusIOState(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1586
1565
|
}
|
|
1587
1566
|
/**
|
|
1588
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
1567
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](#/operations/listBusIODescriptions).
|
|
1589
1568
|
* @summary Get Input/Output Values
|
|
1590
1569
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1591
1570
|
* @param {Array<string>} [ios]
|
|
@@ -1628,7 +1607,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1628
1607
|
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1629
1608
|
}
|
|
1630
1609
|
/**
|
|
1631
|
-
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller as well as NOVA\'s MODBUS service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](addModbusIO).
|
|
1610
|
+
* List descriptions for all configured input/output variables of the MODBUS service. The input/output descriptions contain information like name, type, and address. The input/output direction is given in perspective of the active MODBUS type (service or client). - The byte and bit addresses are the locations in the MODBUS input/output process image the variable points to. - The MODBUS controller, as well as NOVA\'s MODBUS service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA MODBUS service\'s configuration is modified via [addModbusIO](#/operations/addModbusIO).
|
|
1632
1611
|
* @summary List MODBUS Input/Output Configuration
|
|
1633
1612
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1634
1613
|
* @param {*} [options] Override http request option.
|
|
@@ -1638,7 +1617,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1638
1617
|
return BUSInputsOutputsApiFp(this.configuration).listModbusIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1639
1618
|
}
|
|
1640
1619
|
/**
|
|
1641
|
-
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
1620
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information like name, type, and unit. The input/output direction is given in perspective of the PROFINET device, e.g., the configured PROFINET service. - The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. - The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input and output process image. - The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](#/operations/addProfinetIO) and [setProfinetIOsFromFile](#/operations/setProfinetIOsFromFile). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding third party software, e.g., TIA portal.
|
|
1642
1621
|
* @summary List PROFINET Input/Output Configuration
|
|
1643
1622
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1644
1623
|
* @param {*} [options] Override http request option.
|
|
@@ -1648,7 +1627,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1648
1627
|
return BUSInputsOutputsApiFp(this.configuration).listProfinetIOs(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1649
1628
|
}
|
|
1650
1629
|
/**
|
|
1651
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
1630
|
+
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](#/operations/listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
1652
1631
|
* @summary Set Output Values
|
|
1653
1632
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1654
1633
|
* @param {Array<IOValue>} iOValue
|
|
@@ -1659,7 +1638,7 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1659
1638
|
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
1660
1639
|
}
|
|
1661
1640
|
/**
|
|
1662
|
-
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
1641
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. - The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](#/operations/addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller, as well as NOVA\'s PROFINET service, use an input/output variable configuration to interpret the bits of the input/output process image. - The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](#/operations/listProfinetIOs). For the PROFINET controller, e.g., a connected PLC, refer to the corresponding engineering system, e.g., TIA portal. #### Export variables You can export the variable configuration of the PROFINET controller as an XML file from your engineering system, e.g., TIA portal. - The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
1663
1642
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
1664
1643
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1665
1644
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -1675,6 +1654,34 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1675
1654
|
*/
|
|
1676
1655
|
const CellApiAxiosParamCreator = function(configuration) {
|
|
1677
1656
|
return {
|
|
1657
|
+
checkCellVersionUpdate: async (cell, channel, options = {}) => {
|
|
1658
|
+
assertParamExists("checkCellVersionUpdate", "cell", cell);
|
|
1659
|
+
assertParamExists("checkCellVersionUpdate", "channel", channel);
|
|
1660
|
+
const localVarPath = `/cells/{cell}/update`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1661
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1662
|
+
let baseOptions;
|
|
1663
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1664
|
+
const localVarRequestOptions = {
|
|
1665
|
+
method: "GET",
|
|
1666
|
+
...baseOptions,
|
|
1667
|
+
...options
|
|
1668
|
+
};
|
|
1669
|
+
const localVarHeaderParameter = {};
|
|
1670
|
+
const localVarQueryParameter = {};
|
|
1671
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1672
|
+
if (channel !== void 0) localVarQueryParameter["channel"] = channel;
|
|
1673
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1674
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1675
|
+
localVarRequestOptions.headers = {
|
|
1676
|
+
...localVarHeaderParameter,
|
|
1677
|
+
...headersFromBaseOptions,
|
|
1678
|
+
...options.headers
|
|
1679
|
+
};
|
|
1680
|
+
return {
|
|
1681
|
+
url: toPathString(localVarUrlObj),
|
|
1682
|
+
options: localVarRequestOptions
|
|
1683
|
+
};
|
|
1684
|
+
},
|
|
1678
1685
|
deleteCell: async (cell, completionTimeout, options = {}) => {
|
|
1679
1686
|
assertParamExists("deleteCell", "cell", cell);
|
|
1680
1687
|
const localVarPath = `/cells/{cell}`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
@@ -1688,7 +1695,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1688
1695
|
};
|
|
1689
1696
|
const localVarHeaderParameter = {};
|
|
1690
1697
|
const localVarQueryParameter = {};
|
|
1691
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1692
1698
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1693
1699
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1694
1700
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1715,7 +1721,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1715
1721
|
};
|
|
1716
1722
|
const localVarHeaderParameter = {};
|
|
1717
1723
|
const localVarQueryParameter = {};
|
|
1718
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1719
1724
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1720
1725
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1721
1726
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -1745,7 +1750,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1745
1750
|
};
|
|
1746
1751
|
const localVarHeaderParameter = {};
|
|
1747
1752
|
const localVarQueryParameter = {};
|
|
1748
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1749
1753
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1750
1754
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1751
1755
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1772,7 +1776,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1772
1776
|
};
|
|
1773
1777
|
const localVarHeaderParameter = {};
|
|
1774
1778
|
const localVarQueryParameter = {};
|
|
1775
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1776
1779
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1777
1780
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1778
1781
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1797,7 +1800,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1797
1800
|
};
|
|
1798
1801
|
const localVarHeaderParameter = {};
|
|
1799
1802
|
const localVarQueryParameter = {};
|
|
1800
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1801
1803
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1802
1804
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1803
1805
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1825,7 +1827,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1825
1827
|
};
|
|
1826
1828
|
const localVarHeaderParameter = {};
|
|
1827
1829
|
const localVarQueryParameter = {};
|
|
1828
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1829
1830
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1830
1831
|
if (operatingState !== void 0) localVarQueryParameter["operating_state"] = operatingState;
|
|
1831
1832
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1854,7 +1855,6 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1854
1855
|
};
|
|
1855
1856
|
const localVarHeaderParameter = {};
|
|
1856
1857
|
const localVarQueryParameter = {};
|
|
1857
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
1858
1858
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1859
1859
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
1860
1860
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -1870,6 +1870,35 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1870
1870
|
url: toPathString(localVarUrlObj),
|
|
1871
1871
|
options: localVarRequestOptions
|
|
1872
1872
|
};
|
|
1873
|
+
},
|
|
1874
|
+
updateCellVersion: async (cell, updateCellVersionRequest, options = {}) => {
|
|
1875
|
+
assertParamExists("updateCellVersion", "cell", cell);
|
|
1876
|
+
assertParamExists("updateCellVersion", "updateCellVersionRequest", updateCellVersionRequest);
|
|
1877
|
+
const localVarPath = `/cells/{cell}/update`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1878
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1879
|
+
let baseOptions;
|
|
1880
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
1881
|
+
const localVarRequestOptions = {
|
|
1882
|
+
method: "PUT",
|
|
1883
|
+
...baseOptions,
|
|
1884
|
+
...options
|
|
1885
|
+
};
|
|
1886
|
+
const localVarHeaderParameter = {};
|
|
1887
|
+
const localVarQueryParameter = {};
|
|
1888
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1889
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1890
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1891
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1892
|
+
localVarRequestOptions.headers = {
|
|
1893
|
+
...localVarHeaderParameter,
|
|
1894
|
+
...headersFromBaseOptions,
|
|
1895
|
+
...options.headers
|
|
1896
|
+
};
|
|
1897
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCellVersionRequest, localVarRequestOptions, configuration);
|
|
1898
|
+
return {
|
|
1899
|
+
url: toPathString(localVarUrlObj),
|
|
1900
|
+
options: localVarRequestOptions
|
|
1901
|
+
};
|
|
1873
1902
|
}
|
|
1874
1903
|
};
|
|
1875
1904
|
};
|
|
@@ -1879,6 +1908,12 @@ const CellApiAxiosParamCreator = function(configuration) {
|
|
|
1879
1908
|
const CellApiFp = function(configuration) {
|
|
1880
1909
|
const localVarAxiosParamCreator = CellApiAxiosParamCreator(configuration);
|
|
1881
1910
|
return {
|
|
1911
|
+
async checkCellVersionUpdate(cell, channel, options) {
|
|
1912
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkCellVersionUpdate(cell, channel, options);
|
|
1913
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1914
|
+
const localVarOperationServerBasePath = operationServerMap["CellApi.checkCellVersionUpdate"]?.[localVarOperationServerIndex]?.url;
|
|
1915
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1916
|
+
},
|
|
1882
1917
|
async deleteCell(cell, completionTimeout, options) {
|
|
1883
1918
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCell(cell, completionTimeout, options);
|
|
1884
1919
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -1920,6 +1955,12 @@ const CellApiFp = function(configuration) {
|
|
|
1920
1955
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1921
1956
|
const localVarOperationServerBasePath = operationServerMap["CellApi.updateCell"]?.[localVarOperationServerIndex]?.url;
|
|
1922
1957
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1958
|
+
},
|
|
1959
|
+
async updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
1960
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCellVersion(cell, updateCellVersionRequest, options);
|
|
1961
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1962
|
+
const localVarOperationServerBasePath = operationServerMap["CellApi.updateCellVersion"]?.[localVarOperationServerIndex]?.url;
|
|
1963
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1923
1964
|
}
|
|
1924
1965
|
};
|
|
1925
1966
|
};
|
|
@@ -1929,6 +1970,9 @@ const CellApiFp = function(configuration) {
|
|
|
1929
1970
|
const CellApiFactory = function(configuration, basePath, axios) {
|
|
1930
1971
|
const localVarFp = CellApiFp(configuration);
|
|
1931
1972
|
return {
|
|
1973
|
+
checkCellVersionUpdate(cell, channel, options) {
|
|
1974
|
+
return localVarFp.checkCellVersionUpdate(cell, channel, options).then((request) => request(axios, basePath));
|
|
1975
|
+
},
|
|
1932
1976
|
deleteCell(cell, completionTimeout, options) {
|
|
1933
1977
|
return localVarFp.deleteCell(cell, completionTimeout, options).then((request) => request(axios, basePath));
|
|
1934
1978
|
},
|
|
@@ -1949,6 +1993,9 @@ const CellApiFactory = function(configuration, basePath, axios) {
|
|
|
1949
1993
|
},
|
|
1950
1994
|
updateCell(cell, cell2, completionTimeout, options) {
|
|
1951
1995
|
return localVarFp.updateCell(cell, cell2, completionTimeout, options).then((request) => request(axios, basePath));
|
|
1996
|
+
},
|
|
1997
|
+
updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
1998
|
+
return localVarFp.updateCellVersion(cell, updateCellVersionRequest, options).then((request) => request(axios, basePath));
|
|
1952
1999
|
}
|
|
1953
2000
|
};
|
|
1954
2001
|
};
|
|
@@ -1956,6 +2003,17 @@ const CellApiFactory = function(configuration, basePath, axios) {
|
|
|
1956
2003
|
* CellApi - object-oriented interface
|
|
1957
2004
|
*/
|
|
1958
2005
|
var CellApi = class extends BaseAPI {
|
|
2006
|
+
/**
|
|
2007
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
2008
|
+
* @summary Check Cell Update
|
|
2009
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2010
|
+
* @param {ReleaseChannel} channel
|
|
2011
|
+
* @param {*} [options] Override http request option.
|
|
2012
|
+
* @throws {RequiredError}
|
|
2013
|
+
*/
|
|
2014
|
+
checkCellVersionUpdate(cell, channel, options) {
|
|
2015
|
+
return CellApiFp(this.configuration).checkCellVersionUpdate(cell, channel, options).then((request) => request(this.axios, this.basePath));
|
|
2016
|
+
}
|
|
1959
2017
|
/**
|
|
1960
2018
|
* Delete an entire cell.
|
|
1961
2019
|
* @summary Delete Cell
|
|
@@ -2030,6 +2088,17 @@ var CellApi = class extends BaseAPI {
|
|
|
2030
2088
|
updateCell(cell, cell2, completionTimeout, options) {
|
|
2031
2089
|
return CellApiFp(this.configuration).updateCell(cell, cell2, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2032
2090
|
}
|
|
2091
|
+
/**
|
|
2092
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
2093
|
+
* @summary Update Cell Version
|
|
2094
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2095
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
2096
|
+
* @param {*} [options] Override http request option.
|
|
2097
|
+
* @throws {RequiredError}
|
|
2098
|
+
*/
|
|
2099
|
+
updateCellVersion(cell, updateCellVersionRequest, options) {
|
|
2100
|
+
return CellApiFp(this.configuration).updateCellVersion(cell, updateCellVersionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2101
|
+
}
|
|
2033
2102
|
};
|
|
2034
2103
|
/**
|
|
2035
2104
|
* ControllerApi - axios parameter creator
|
|
@@ -2050,7 +2119,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2050
2119
|
};
|
|
2051
2120
|
const localVarHeaderParameter = {};
|
|
2052
2121
|
const localVarQueryParameter = {};
|
|
2053
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2054
2122
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2055
2123
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2056
2124
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -2080,7 +2148,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2080
2148
|
};
|
|
2081
2149
|
const localVarHeaderParameter = {};
|
|
2082
2150
|
const localVarQueryParameter = {};
|
|
2083
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2084
2151
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2085
2152
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2086
2153
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2109,7 +2176,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2109
2176
|
};
|
|
2110
2177
|
const localVarHeaderParameter = {};
|
|
2111
2178
|
const localVarQueryParameter = {};
|
|
2112
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2113
2179
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2114
2180
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2115
2181
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2138,7 +2204,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2138
2204
|
};
|
|
2139
2205
|
const localVarHeaderParameter = {};
|
|
2140
2206
|
const localVarQueryParameter = {};
|
|
2141
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2142
2207
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2143
2208
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2144
2209
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2167,7 +2232,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2167
2232
|
};
|
|
2168
2233
|
const localVarHeaderParameter = {};
|
|
2169
2234
|
const localVarQueryParameter = {};
|
|
2170
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2171
2235
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2172
2236
|
if (orientationType !== void 0) localVarQueryParameter["orientation_type"] = orientationType;
|
|
2173
2237
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2196,7 +2260,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2196
2260
|
};
|
|
2197
2261
|
const localVarHeaderParameter = {};
|
|
2198
2262
|
const localVarQueryParameter = {};
|
|
2199
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2200
2263
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2201
2264
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2202
2265
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2224,7 +2287,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2224
2287
|
};
|
|
2225
2288
|
const localVarHeaderParameter = {};
|
|
2226
2289
|
const localVarQueryParameter = {};
|
|
2227
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2228
2290
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2229
2291
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2230
2292
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2252,7 +2314,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2252
2314
|
};
|
|
2253
2315
|
const localVarHeaderParameter = {};
|
|
2254
2316
|
const localVarQueryParameter = {};
|
|
2255
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2256
2317
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2257
2318
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2258
2319
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2280,7 +2341,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2280
2341
|
};
|
|
2281
2342
|
const localVarHeaderParameter = {};
|
|
2282
2343
|
const localVarQueryParameter = {};
|
|
2283
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2284
2344
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2285
2345
|
if (orientationType !== void 0) localVarQueryParameter["orientation_type"] = orientationType;
|
|
2286
2346
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2308,7 +2368,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2308
2368
|
};
|
|
2309
2369
|
const localVarHeaderParameter = {};
|
|
2310
2370
|
const localVarQueryParameter = {};
|
|
2311
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2312
2371
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2313
2372
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2314
2373
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2337,7 +2396,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2337
2396
|
};
|
|
2338
2397
|
const localVarHeaderParameter = {};
|
|
2339
2398
|
const localVarQueryParameter = {};
|
|
2340
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2341
2399
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2342
2400
|
if (mode !== void 0) localVarQueryParameter["mode"] = mode;
|
|
2343
2401
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2366,7 +2424,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2366
2424
|
};
|
|
2367
2425
|
const localVarHeaderParameter = {};
|
|
2368
2426
|
const localVarQueryParameter = {};
|
|
2369
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2370
2427
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2371
2428
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
2372
2429
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2395,7 +2452,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2395
2452
|
};
|
|
2396
2453
|
const localVarHeaderParameter = {};
|
|
2397
2454
|
const localVarQueryParameter = {};
|
|
2398
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2399
2455
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2400
2456
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
2401
2457
|
if (addControllerTimeout !== void 0) localVarQueryParameter["add_controller_timeout"] = addControllerTimeout;
|
|
@@ -2426,7 +2482,6 @@ const ControllerApiAxiosParamCreator = function(configuration) {
|
|
|
2426
2482
|
};
|
|
2427
2483
|
const localVarHeaderParameter = {};
|
|
2428
2484
|
const localVarQueryParameter = {};
|
|
2429
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2430
2485
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2431
2486
|
if (completionTimeout !== void 0) localVarQueryParameter["completion_timeout"] = completionTimeout;
|
|
2432
2487
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
@@ -2604,7 +2659,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2604
2659
|
return ControllerApiFp(this.configuration).addRobotController(cell, robotController, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2605
2660
|
}
|
|
2606
2661
|
/**
|
|
2607
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
2662
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
2608
2663
|
* @summary Clear Robot Controllers
|
|
2609
2664
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2610
2665
|
* @param {number} [completionTimeout]
|
|
@@ -2627,7 +2682,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2627
2682
|
return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2628
2683
|
}
|
|
2629
2684
|
/**
|
|
2630
|
-
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
|
|
2685
|
+
* Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](#/operations/getMotionGroupDescription) to get more information about the motion group.
|
|
2631
2686
|
* @summary Description
|
|
2632
2687
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2633
2688
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2673,7 +2728,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2673
2728
|
return ControllerApiFp(this.configuration).getRobotController(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
2674
2729
|
}
|
|
2675
2730
|
/**
|
|
2676
|
-
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.
|
|
2731
|
+
* Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot. When adding a virtual controller, use the Virtual configuration variant of [addRobotController](#/operations/addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration, which is not required when providing a complete configuration.
|
|
2677
2732
|
* @summary Virtual Controller Configuration
|
|
2678
2733
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2679
2734
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2706,7 +2761,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2706
2761
|
return ControllerApiFp(this.configuration).listRobotControllers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2707
2762
|
}
|
|
2708
2763
|
/**
|
|
2709
|
-
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2764
|
+
* Switch between monitor and control usage as default for a robot controller. Monitoring mode is used to read information from the robot controller and control mode is used to command the robot system. As long as the robot controller is connected via network, monitoring mode is always possible. To switch to control mode the robot controller must be in `automatic` or `manual` operating mode and safety state `normal` or `reduced`. If the robot controller is in `manual` operating mode, you have to manually confirm the control usage activation on the robot control panel. This manual confirmation can\'t be replaced with this API. Without manual confirmation the robot controller will stay in monitor mode. The robot system will try to activate the required operation mode for the requested usage unless no active call requires a different mode. > **NOTE** > > `setDefaultMode` enables the robot controller to stay in control mode to keep the motors activated. > This allows for faster execution of sequential movements as no mode switches are required. > **NOTE** > > Some robot controllers prevent the external activation of automatic operating mode. In this case, changing the operating mode manually at the robot controller is mandatory. > **NOTE** > > The current operation mode and safety state can be requested via [getCurrentRobotControllerState](#/operations/getCurrentRobotControllerState). If a mode change is not possible, the response lists reasons for the failed change.
|
|
2710
2765
|
* @summary Set Default Mode
|
|
2711
2766
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2712
2767
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2718,7 +2773,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2718
2773
|
return ControllerApiFp(this.configuration).setDefaultMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
2719
2774
|
}
|
|
2720
2775
|
/**
|
|
2721
|
-
* <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](listRobotControllers) to check if the robot controller supports free drive mode.
|
|
2776
|
+
* <!-- theme: success --> > Websocket endpoint Sets the robot controller into freedrive mode and stays in freedrive until the websocket connection is closed by the client. In freedrive mode, it is possible to move the attached motion groups by hand. This is a blocking call. As long as the websocket connection is open, no other endpoint can control or move the robot. <!-- theme: danger --> > **DANGER** > > Danger caused by robot. Improper assessment by the integrator of the application-specific hazards can result in people being > crushed, drawn in or caught due to the robot\'s complex movement sequences. Before opening the websocket, ensure that > > - The robot is in a safe state, > - The right payload is set, > - No humans or object are within the robot\'s reach or within the cell. As long as the websocket connection is open you will get the current state of the robot system in the response in the specified `response_rate`. If the activation failed, the returned status will return possible reasons for the failure. Free drive mode is only available for robot controllers that support it, in particular cobots. Use [listRobotControllers](#/operations/listRobotControllers) to check if the robot controller supports free drive mode.
|
|
2722
2777
|
* @summary Stream Free Drive
|
|
2723
2778
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2724
2779
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2730,7 +2785,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2730
2785
|
return ControllerApiFp(this.configuration).streamFreeDrive(cell, controller, responseRate, options).then((request) => request(this.axios, this.basePath));
|
|
2731
2786
|
}
|
|
2732
2787
|
/**
|
|
2733
|
-
* <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2788
|
+
* <!-- theme: success --> > Websocket endpoint Receive updates of the state of a robot controller. The stream can be opened before the controller is registered. To register a controller, call [addRobotController](#/operations/addRobotController). While connecting, the stream sends initialization updates. Once the controller reaches `MODE_MONITOR`, it sends controller state updates.
|
|
2734
2789
|
* @summary Stream State
|
|
2735
2790
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2736
2791
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2743,7 +2798,7 @@ var ControllerApi = class extends BaseAPI {
|
|
|
2743
2798
|
return ControllerApiFp(this.configuration).streamRobotControllerState(cell, controller, responseRate, addControllerTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2744
2799
|
}
|
|
2745
2800
|
/**
|
|
2746
|
-
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](addRobotController).
|
|
2801
|
+
* Update the configuration of a robot controller. Reconfigure certain options of a robot controller, or deploy a specific container image of a robot controller. To update a virtual controller, the previous controller will be deleted and a new one created. Changes to the configuration, e.g., TCPs, coordinate systems, mounting, are **not** transferred to the new robot. <!-- theme: info --> > **NOTE** > > An update is not a reset. To do a reset: > 1. Get the current configuration via [getRobotController](#/operations/getRobotController). > 2. Delete the existing virtual robot controller via [deleteRobotController](#/operations/deleteRobotController). > 3. Add a virtual robot controller with [addRobotController](#/operations/addRobotController).
|
|
2747
2802
|
* @summary Update Robot Controller
|
|
2748
2803
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2749
2804
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -2775,7 +2830,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2775
2830
|
};
|
|
2776
2831
|
const localVarHeaderParameter = {};
|
|
2777
2832
|
const localVarQueryParameter = {};
|
|
2778
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2779
2833
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2780
2834
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2781
2835
|
if (direction !== void 0) localVarQueryParameter["direction"] = direction;
|
|
@@ -2807,7 +2861,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2807
2861
|
};
|
|
2808
2862
|
const localVarHeaderParameter = {};
|
|
2809
2863
|
const localVarQueryParameter = {};
|
|
2810
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2811
2864
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2812
2865
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2813
2866
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2837,7 +2890,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2837
2890
|
};
|
|
2838
2891
|
const localVarHeaderParameter = {};
|
|
2839
2892
|
const localVarQueryParameter = {};
|
|
2840
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2841
2893
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2842
2894
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2843
2895
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2867,7 +2919,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2867
2919
|
};
|
|
2868
2920
|
const localVarHeaderParameter = {};
|
|
2869
2921
|
const localVarQueryParameter = {};
|
|
2870
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2871
2922
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2872
2923
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
2873
2924
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2897,7 +2948,6 @@ const ControllerInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
2897
2948
|
};
|
|
2898
2949
|
const localVarHeaderParameter = {};
|
|
2899
2950
|
const localVarQueryParameter = {};
|
|
2900
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
2901
2951
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2902
2952
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2903
2953
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2996,7 +3046,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
2996
3046
|
return ControllerInputsOutputsApiFp(this.configuration).listIODescriptions(cell, controller, ios, direction, valueType, group, options).then((request) => request(this.axios, this.basePath));
|
|
2997
3047
|
}
|
|
2998
3048
|
/**
|
|
2999
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](listIODescriptions).
|
|
3049
|
+
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listIODescriptions](#/operations/listIODescriptions).
|
|
3000
3050
|
* @summary Get Input/Output Values
|
|
3001
3051
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3002
3052
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3008,7 +3058,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3008
3058
|
return ControllerInputsOutputsApiFp(this.configuration).listIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3009
3059
|
}
|
|
3010
3060
|
/**
|
|
3011
|
-
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
3061
|
+
* Set the values of outputs. All available output identifiers and possible value ranges can be requested via [listIODescriptions](#/operations/listIODescriptions). The call will return once the values have been set on and accepted by the robot. This can take up to 200 milliseconds. > **NOTE** > > Do not call this endpoint while another request is still in progress. The second call will fail.
|
|
3012
3062
|
* @summary Set Output Values
|
|
3013
3063
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3014
3064
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3032,7 +3082,7 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3032
3082
|
return ControllerInputsOutputsApiFp(this.configuration).streamIOValues(cell, controller, ios, options).then((request) => request(this.axios, this.basePath));
|
|
3033
3083
|
}
|
|
3034
3084
|
/**
|
|
3035
|
-
* Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
3085
|
+
* Wait until an input/output reaches a certain value. This call returns as soon as the condition is met or the request fails. The `comparison_type` value is used to define how the current value of the input/output is compared with given value. Only set the value that corresponds to the `value_type` of the input/output. See [listIODescriptions](#/operations/listIODescriptions) for more information. **Examples** 1. Wait until analog input `AI_1` < 10: ``` io: \"AI_1\" comparison_type: \"COMPARISON_LESS\" value: 10 ``` 2. Wait until analog input `AI_2` > 5.0: ``` io: \"AI_2\" comparison_type: \"COMPARISON_GREATER\" value: 5.0 ``` 3. Wait until digital input `DI_3` is true: ``` io: \"DI_3\" comparison_type: \"COMPARISON_EQUAL\" value: true ```
|
|
3036
3086
|
* @summary Wait For
|
|
3037
3087
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3038
3088
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3063,7 +3113,6 @@ const JoggingApiAxiosParamCreator = function(configuration) {
|
|
|
3063
3113
|
};
|
|
3064
3114
|
const localVarHeaderParameter = {};
|
|
3065
3115
|
const localVarQueryParameter = {};
|
|
3066
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3067
3116
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3068
3117
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3069
3118
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3106,7 +3155,7 @@ const JoggingApiFactory = function(configuration, basePath, axios) {
|
|
|
3106
3155
|
*/
|
|
3107
3156
|
var JoggingApi = class extends BaseAPI {
|
|
3108
3157
|
/**
|
|
3109
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3158
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a dynamically adaptable jogging motion for a motion group. Jogging describes controlling a motion group by sending real-time commands to move either its joints or the TCP. The commands contain target velocities that may change at any time during execution, so the resulting motion cannot be computed upfront. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeJoggingRequest` to configure the jogging. - Sets the robot controller mode to control mode. - Claims the motion group for jogging. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `JointVelocityRequest` or `TcpVelocityRequest` to start the jogging motion. - Commands can only be processed in the cycle rate of the controller - Sending commands faster will not increase the responsiveness of the jogging motion, it will lead to dropped commands - It is recommended to couple sending commands with the [state stream](#/operations/streamMotionGroupState), which can be subscribed to via nats as well. #### 3. Change or stop the jogging motion - Change the jogging direction and/or velocity during the jogging motion with `JointVelocityRequest` or `TcpVelocityRequest`. - To stop the jogging motion, send zero velocities via either request or `PauseJoggingRequest`. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointVelocityResponse` after `JointVelocityRequest` - `TcpVelocityResponse` after `TcpVelocityRequest` - `PauseJoggingResponse` after `PauseJoggingRequest` The responses confirm that the requests were received. They do not signal that the operation was successful; check the [motion group state](#/operations/streamMotionGroupState) for that. - `MovementErrorResponse` with error details is sent in case of an unexpected error, e.g., controller disconnects during jogging. ### Tips and Tricks - Ensure that the websocket connection remains open until the jogging motion is stopped to avoid unexpected stops.
|
|
3110
3159
|
* @summary Execute Jogging
|
|
3111
3160
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3112
3161
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -3137,7 +3186,6 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3137
3186
|
};
|
|
3138
3187
|
const localVarHeaderParameter = {};
|
|
3139
3188
|
const localVarQueryParameter = {};
|
|
3140
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3141
3189
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3142
3190
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3143
3191
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3167,7 +3215,6 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3167
3215
|
};
|
|
3168
3216
|
const localVarHeaderParameter = {};
|
|
3169
3217
|
const localVarQueryParameter = {};
|
|
3170
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3171
3218
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3172
3219
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3173
3220
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3263,7 +3310,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3263
3310
|
};
|
|
3264
3311
|
const localVarHeaderParameter = {};
|
|
3265
3312
|
const localVarQueryParameter = {};
|
|
3266
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3267
3313
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3268
3314
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3269
3315
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3290,7 +3336,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3290
3336
|
};
|
|
3291
3337
|
const localVarHeaderParameter = {};
|
|
3292
3338
|
const localVarQueryParameter = {};
|
|
3293
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3294
3339
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3295
3340
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3296
3341
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3315,7 +3360,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3315
3360
|
};
|
|
3316
3361
|
const localVarHeaderParameter = {};
|
|
3317
3362
|
const localVarQueryParameter = {};
|
|
3318
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3319
3363
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3320
3364
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3321
3365
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3340,7 +3384,6 @@ const LicenseApiAxiosParamCreator = function(configuration) {
|
|
|
3340
3384
|
};
|
|
3341
3385
|
const localVarHeaderParameter = {};
|
|
3342
3386
|
const localVarQueryParameter = {};
|
|
3343
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3344
3387
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3345
3388
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3346
3389
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3470,7 +3513,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3470
3513
|
};
|
|
3471
3514
|
const localVarHeaderParameter = {};
|
|
3472
3515
|
const localVarQueryParameter = {};
|
|
3473
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3474
3516
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3475
3517
|
if (responseCoordinateSystem !== void 0) localVarQueryParameter["response_coordinate_system"] = responseCoordinateSystem;
|
|
3476
3518
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3500,7 +3542,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3500
3542
|
};
|
|
3501
3543
|
const localVarHeaderParameter = {};
|
|
3502
3544
|
const localVarQueryParameter = {};
|
|
3503
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3504
3545
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3505
3546
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3506
3547
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3529,7 +3570,6 @@ const MotionGroupApiAxiosParamCreator = function(configuration) {
|
|
|
3529
3570
|
};
|
|
3530
3571
|
const localVarHeaderParameter = {};
|
|
3531
3572
|
const localVarQueryParameter = {};
|
|
3532
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3533
3573
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3534
3574
|
if (responseRate !== void 0) localVarQueryParameter["response_rate"] = responseRate;
|
|
3535
3575
|
if (responseCoordinateSystem !== void 0) localVarQueryParameter["response_coordinate_system"] = responseCoordinateSystem;
|
|
@@ -3652,7 +3692,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3652
3692
|
};
|
|
3653
3693
|
const localVarHeaderParameter = {};
|
|
3654
3694
|
const localVarQueryParameter = {};
|
|
3655
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3656
3695
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3657
3696
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3658
3697
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3679,7 +3718,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3679
3718
|
};
|
|
3680
3719
|
const localVarHeaderParameter = {};
|
|
3681
3720
|
const localVarQueryParameter = {};
|
|
3682
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3683
3721
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3684
3722
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3685
3723
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3706,7 +3744,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3706
3744
|
};
|
|
3707
3745
|
const localVarHeaderParameter = {};
|
|
3708
3746
|
const localVarQueryParameter = {};
|
|
3709
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3710
3747
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3711
3748
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3712
3749
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3731,7 +3768,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3731
3768
|
};
|
|
3732
3769
|
const localVarHeaderParameter = {};
|
|
3733
3770
|
const localVarQueryParameter = {};
|
|
3734
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3735
3771
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3736
3772
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3737
3773
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3758,7 +3794,6 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
3758
3794
|
};
|
|
3759
3795
|
const localVarHeaderParameter = {};
|
|
3760
3796
|
const localVarQueryParameter = {};
|
|
3761
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3762
3797
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3763
3798
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3764
3799
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3840,9 +3875,9 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios) {
|
|
|
3840
3875
|
*/
|
|
3841
3876
|
var MotionGroupModelsApi = class extends BaseAPI {
|
|
3842
3877
|
/**
|
|
3843
|
-
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
3878
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
3844
3879
|
* @summary Get Collision Model
|
|
3845
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3880
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3846
3881
|
* @param {*} [options] Override http request option.
|
|
3847
3882
|
* @throws {RequiredError}
|
|
3848
3883
|
*/
|
|
@@ -3850,9 +3885,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3850
3885
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3851
3886
|
}
|
|
3852
3887
|
/**
|
|
3853
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3888
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
3854
3889
|
* @summary Download GLB Model
|
|
3855
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3890
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3856
3891
|
* @param {*} [options] Override http request option.
|
|
3857
3892
|
* @throws {RequiredError}
|
|
3858
3893
|
*/
|
|
@@ -3860,9 +3895,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3860
3895
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupGlbModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
3861
3896
|
}
|
|
3862
3897
|
/**
|
|
3863
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
3898
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
3864
3899
|
* @summary Get Kinematics
|
|
3865
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3900
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3866
3901
|
* @param {*} [options] Override http request option.
|
|
3867
3902
|
* @throws {RequiredError}
|
|
3868
3903
|
*/
|
|
@@ -3879,9 +3914,9 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
3879
3914
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(options).then((request) => request(this.axios, this.basePath));
|
|
3880
3915
|
}
|
|
3881
3916
|
/**
|
|
3882
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
3917
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
3883
3918
|
* @summary Download USD Model
|
|
3884
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
3919
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](#/operations/getOptimizerConfiguration).
|
|
3885
3920
|
* @param {*} [options] Override http request option.
|
|
3886
3921
|
* @throws {RequiredError}
|
|
3887
3922
|
*/
|
|
@@ -3908,7 +3943,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3908
3943
|
};
|
|
3909
3944
|
const localVarHeaderParameter = {};
|
|
3910
3945
|
const localVarQueryParameter = {};
|
|
3911
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3912
3946
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3913
3947
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3914
3948
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3935,7 +3969,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3935
3969
|
};
|
|
3936
3970
|
const localVarHeaderParameter = {};
|
|
3937
3971
|
const localVarQueryParameter = {};
|
|
3938
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3939
3972
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3940
3973
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3941
3974
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3964,7 +3997,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3964
3997
|
};
|
|
3965
3998
|
const localVarHeaderParameter = {};
|
|
3966
3999
|
const localVarQueryParameter = {};
|
|
3967
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3968
4000
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3969
4001
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3970
4002
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3994,7 +4026,6 @@ const ProgramApiAxiosParamCreator = function(configuration) {
|
|
|
3994
4026
|
};
|
|
3995
4027
|
const localVarHeaderParameter = {};
|
|
3996
4028
|
const localVarQueryParameter = {};
|
|
3997
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
3998
4029
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3999
4030
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4000
4031
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4126,7 +4157,6 @@ const RobotConfigurationsApiAxiosParamCreator = function(configuration) {
|
|
|
4126
4157
|
};
|
|
4127
4158
|
const localVarHeaderParameter = {};
|
|
4128
4159
|
const localVarQueryParameter = {};
|
|
4129
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4130
4160
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4131
4161
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4132
4162
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4195,7 +4225,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4195
4225
|
};
|
|
4196
4226
|
const localVarHeaderParameter = {};
|
|
4197
4227
|
const localVarQueryParameter = {};
|
|
4198
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4199
4228
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4200
4229
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4201
4230
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4223,7 +4252,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4223
4252
|
};
|
|
4224
4253
|
const localVarHeaderParameter = {};
|
|
4225
4254
|
const localVarQueryParameter = {};
|
|
4226
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4227
4255
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4228
4256
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4229
4257
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4251,7 +4279,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4251
4279
|
};
|
|
4252
4280
|
const localVarHeaderParameter = {};
|
|
4253
4281
|
const localVarQueryParameter = {};
|
|
4254
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4255
4282
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4256
4283
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4257
4284
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4279,7 +4306,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4279
4306
|
};
|
|
4280
4307
|
const localVarHeaderParameter = {};
|
|
4281
4308
|
const localVarQueryParameter = {};
|
|
4282
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4283
4309
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4284
4310
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4285
4311
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4307,7 +4333,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4307
4333
|
};
|
|
4308
4334
|
const localVarHeaderParameter = {};
|
|
4309
4335
|
const localVarQueryParameter = {};
|
|
4310
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4311
4336
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4312
4337
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4313
4338
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4335,7 +4360,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4335
4360
|
};
|
|
4336
4361
|
const localVarHeaderParameter = {};
|
|
4337
4362
|
const localVarQueryParameter = {};
|
|
4338
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4339
4363
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4340
4364
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4341
4365
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4362,7 +4386,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4362
4386
|
};
|
|
4363
4387
|
const localVarHeaderParameter = {};
|
|
4364
4388
|
const localVarQueryParameter = {};
|
|
4365
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4366
4389
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4367
4390
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4368
4391
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4389,7 +4412,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4389
4412
|
};
|
|
4390
4413
|
const localVarHeaderParameter = {};
|
|
4391
4414
|
const localVarQueryParameter = {};
|
|
4392
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4393
4415
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4394
4416
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4395
4417
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4416,7 +4438,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4416
4438
|
};
|
|
4417
4439
|
const localVarHeaderParameter = {};
|
|
4418
4440
|
const localVarQueryParameter = {};
|
|
4419
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4420
4441
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4421
4442
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4422
4443
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4443,7 +4464,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4443
4464
|
};
|
|
4444
4465
|
const localVarHeaderParameter = {};
|
|
4445
4466
|
const localVarQueryParameter = {};
|
|
4446
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4447
4467
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4448
4468
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4449
4469
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4470,7 +4490,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4470
4490
|
};
|
|
4471
4491
|
const localVarHeaderParameter = {};
|
|
4472
4492
|
const localVarQueryParameter = {};
|
|
4473
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4474
4493
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4475
4494
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4476
4495
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4497,7 +4516,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4497
4516
|
};
|
|
4498
4517
|
const localVarHeaderParameter = {};
|
|
4499
4518
|
const localVarQueryParameter = {};
|
|
4500
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4501
4519
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4502
4520
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4503
4521
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4526,7 +4544,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4526
4544
|
};
|
|
4527
4545
|
const localVarHeaderParameter = {};
|
|
4528
4546
|
const localVarQueryParameter = {};
|
|
4529
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4530
4547
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4531
4548
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4532
4549
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4557,7 +4574,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4557
4574
|
};
|
|
4558
4575
|
const localVarHeaderParameter = {};
|
|
4559
4576
|
const localVarQueryParameter = {};
|
|
4560
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4561
4577
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4562
4578
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4563
4579
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4588,7 +4604,6 @@ const StoreCollisionComponentsApiAxiosParamCreator = function(configuration) {
|
|
|
4588
4604
|
};
|
|
4589
4605
|
const localVarHeaderParameter = {};
|
|
4590
4606
|
const localVarQueryParameter = {};
|
|
4591
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4592
4607
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4593
4608
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
4594
4609
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4943,7 +4958,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4943
4958
|
};
|
|
4944
4959
|
const localVarHeaderParameter = {};
|
|
4945
4960
|
const localVarQueryParameter = {};
|
|
4946
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4947
4961
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4948
4962
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4949
4963
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4971,7 +4985,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4971
4985
|
};
|
|
4972
4986
|
const localVarHeaderParameter = {};
|
|
4973
4987
|
const localVarQueryParameter = {};
|
|
4974
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4975
4988
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4976
4989
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4977
4990
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -4998,7 +5011,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
4998
5011
|
};
|
|
4999
5012
|
const localVarHeaderParameter = {};
|
|
5000
5013
|
const localVarQueryParameter = {};
|
|
5001
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5002
5014
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5003
5015
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5004
5016
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5025,7 +5037,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5025
5037
|
};
|
|
5026
5038
|
const localVarHeaderParameter = {};
|
|
5027
5039
|
const localVarQueryParameter = {};
|
|
5028
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5029
5040
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5030
5041
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5031
5042
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5054,7 +5065,6 @@ const StoreCollisionSetupsApiAxiosParamCreator = function(configuration) {
|
|
|
5054
5065
|
};
|
|
5055
5066
|
const localVarHeaderParameter = {};
|
|
5056
5067
|
const localVarQueryParameter = {};
|
|
5057
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5058
5068
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5059
5069
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
5060
5070
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5210,7 +5220,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5210
5220
|
};
|
|
5211
5221
|
const localVarHeaderParameter = {};
|
|
5212
5222
|
const localVarQueryParameter = {};
|
|
5213
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5214
5223
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5215
5224
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5216
5225
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5238,7 +5247,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5238
5247
|
};
|
|
5239
5248
|
const localVarHeaderParameter = {};
|
|
5240
5249
|
const localVarQueryParameter = {};
|
|
5241
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5242
5250
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5243
5251
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5244
5252
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5266,7 +5274,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5266
5274
|
};
|
|
5267
5275
|
const localVarHeaderParameter = {};
|
|
5268
5276
|
const localVarQueryParameter = {};
|
|
5269
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5270
5277
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5271
5278
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5272
5279
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5294,7 +5301,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5294
5301
|
};
|
|
5295
5302
|
const localVarHeaderParameter = {};
|
|
5296
5303
|
const localVarQueryParameter = {};
|
|
5297
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5298
5304
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5299
5305
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5300
5306
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5321,7 +5327,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5321
5327
|
};
|
|
5322
5328
|
const localVarHeaderParameter = {};
|
|
5323
5329
|
const localVarQueryParameter = {};
|
|
5324
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5325
5330
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5326
5331
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5327
5332
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5350,7 +5355,6 @@ const StoreObjectApiAxiosParamCreator = function(configuration) {
|
|
|
5350
5355
|
const localVarHeaderParameter = {};
|
|
5351
5356
|
const localVarQueryParameter = {};
|
|
5352
5357
|
const localVarFormParams = new (configuration && configuration.formDataCtor || FormData)();
|
|
5353
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5354
5358
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5355
5359
|
if (anyValue !== void 0) localVarFormParams.append("any_value", new Blob([JSON.stringify(anyValue)], { type: "application/json" }));
|
|
5356
5360
|
localVarHeaderParameter["Content-Type"] = "multipart/form-data";
|
|
@@ -5498,7 +5502,7 @@ var StoreObjectApi = class extends BaseAPI {
|
|
|
5498
5502
|
return StoreObjectApiFp(this.configuration).listAllObjectKeys(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5499
5503
|
}
|
|
5500
5504
|
/**
|
|
5501
|
-
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
5505
|
+
* Store any data as an object. Using a key which already contains an object will override the previously stored object. Use [getObjectMetadata](#/operations/getObjectMetadata) to verify that the key does not contain objects. #### Optional Specify metadata as a dictionary with names and values.
|
|
5502
5506
|
* @summary Store Object
|
|
5503
5507
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5504
5508
|
* @param {string} key
|
|
@@ -5527,7 +5531,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5527
5531
|
};
|
|
5528
5532
|
const localVarHeaderParameter = {};
|
|
5529
5533
|
const localVarQueryParameter = {};
|
|
5530
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5531
5534
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5532
5535
|
if (resources) localVarQueryParameter["resources"] = resources.join(COLLECTION_FORMATS.csv);
|
|
5533
5536
|
if (metadata !== void 0) localVarQueryParameter["metadata"] = metadata;
|
|
@@ -5555,7 +5558,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5555
5558
|
};
|
|
5556
5559
|
const localVarHeaderParameter = {};
|
|
5557
5560
|
const localVarQueryParameter = {};
|
|
5558
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5559
5561
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5560
5562
|
if (channel !== void 0) localVarQueryParameter["channel"] = channel;
|
|
5561
5563
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5581,7 +5583,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5581
5583
|
};
|
|
5582
5584
|
const localVarHeaderParameter = {};
|
|
5583
5585
|
const localVarQueryParameter = {};
|
|
5584
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5585
5586
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5586
5587
|
if (_interface !== void 0) localVarQueryParameter["interface"] = _interface;
|
|
5587
5588
|
if (cidr !== void 0) localVarQueryParameter["cidr"] = cidr;
|
|
@@ -5610,7 +5611,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5610
5611
|
};
|
|
5611
5612
|
const localVarHeaderParameter = {};
|
|
5612
5613
|
const localVarQueryParameter = {};
|
|
5613
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5614
5614
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5615
5615
|
if (operationId !== void 0) localVarQueryParameter["operation_id"] = operationId;
|
|
5616
5616
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5636,7 +5636,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5636
5636
|
};
|
|
5637
5637
|
const localVarHeaderParameter = {};
|
|
5638
5638
|
const localVarQueryParameter = {};
|
|
5639
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5640
5639
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5641
5640
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5642
5641
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5661,7 +5660,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5661
5660
|
};
|
|
5662
5661
|
const localVarHeaderParameter = {};
|
|
5663
5662
|
const localVarQueryParameter = {};
|
|
5664
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5665
5663
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5666
5664
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5667
5665
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5686,7 +5684,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5686
5684
|
};
|
|
5687
5685
|
const localVarHeaderParameter = {};
|
|
5688
5686
|
const localVarQueryParameter = {};
|
|
5689
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5690
5687
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5691
5688
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5692
5689
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5711,7 +5708,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5711
5708
|
};
|
|
5712
5709
|
const localVarHeaderParameter = {};
|
|
5713
5710
|
const localVarQueryParameter = {};
|
|
5714
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5715
5711
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5716
5712
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5717
5713
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5736,7 +5732,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5736
5732
|
};
|
|
5737
5733
|
const localVarHeaderParameter = {};
|
|
5738
5734
|
const localVarQueryParameter = {};
|
|
5739
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5740
5735
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5741
5736
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5742
5737
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5761,7 +5756,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5761
5756
|
};
|
|
5762
5757
|
const localVarHeaderParameter = {};
|
|
5763
5758
|
const localVarQueryParameter = {};
|
|
5764
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5765
5759
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5766
5760
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5767
5761
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -5787,7 +5781,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5787
5781
|
};
|
|
5788
5782
|
const localVarHeaderParameter = {};
|
|
5789
5783
|
const localVarQueryParameter = {};
|
|
5790
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5791
5784
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5792
5785
|
if (resources) localVarQueryParameter["resources"] = resources.join(COLLECTION_FORMATS.csv);
|
|
5793
5786
|
localVarHeaderParameter["Content-Type"] = "application/gzip";
|
|
@@ -5816,7 +5809,6 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
5816
5809
|
};
|
|
5817
5810
|
const localVarHeaderParameter = {};
|
|
5818
5811
|
const localVarQueryParameter = {};
|
|
5819
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5820
5812
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5821
5813
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
5822
5814
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6071,7 +6063,7 @@ var SystemApi = class extends BaseAPI {
|
|
|
6071
6063
|
return SystemApiFp(this.configuration).restoreConfiguration(body, resources, options).then((request) => request(this.axios, this.basePath));
|
|
6072
6064
|
}
|
|
6073
6065
|
/**
|
|
6074
|
-
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored.
|
|
6066
|
+
* Update the Wandelbots NOVA version and all attached services. Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance. If the update fails, the previous Wandelbots NOVA version is restored. System updates only apply to cells without an explicit chart version. Pinned versions are always preserved; setting `update_cells=false` pins unversioned cells to the current system version before updating.
|
|
6075
6067
|
* @summary Update Wandelbots NOVA version
|
|
6076
6068
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
6077
6069
|
* @param {*} [options] Override http request option.
|
|
@@ -6101,7 +6093,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6101
6093
|
};
|
|
6102
6094
|
const localVarHeaderParameter = {};
|
|
6103
6095
|
const localVarQueryParameter = {};
|
|
6104
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6105
6096
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6106
6097
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6107
6098
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6131,7 +6122,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6131
6122
|
};
|
|
6132
6123
|
const localVarHeaderParameter = {};
|
|
6133
6124
|
const localVarQueryParameter = {};
|
|
6134
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6135
6125
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6136
6126
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6137
6127
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6160,7 +6150,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6160
6150
|
};
|
|
6161
6151
|
const localVarHeaderParameter = {};
|
|
6162
6152
|
const localVarQueryParameter = {};
|
|
6163
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6164
6153
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6165
6154
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6166
6155
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6189,7 +6178,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6189
6178
|
};
|
|
6190
6179
|
const localVarHeaderParameter = {};
|
|
6191
6180
|
const localVarQueryParameter = {};
|
|
6192
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6193
6181
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6194
6182
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6195
6183
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6217,7 +6205,6 @@ const TrajectoryCachingApiAxiosParamCreator = function(configuration) {
|
|
|
6217
6205
|
};
|
|
6218
6206
|
const localVarHeaderParameter = {};
|
|
6219
6207
|
const localVarQueryParameter = {};
|
|
6220
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6221
6208
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6222
6209
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6223
6210
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6299,7 +6286,7 @@ const TrajectoryCachingApiFactory = function(configuration, basePath, axios) {
|
|
|
6299
6286
|
*/
|
|
6300
6287
|
var TrajectoryCachingApi = class extends BaseAPI {
|
|
6301
6288
|
/**
|
|
6302
|
-
* Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](executeTrajectory) endpoint.
|
|
6289
|
+
* Loads and validates the data of a trajectory into the execution cache, rendering the trajectory executable. <!-- theme: info --> > #### NOTE > > Using the trajectory cache is an optional performance optimization. It is not necessary to use the cache to execute trajectories. The response contains the result of the validation of the trajectory. Validation can lead to three different results: - Fully valid: The whole trajectory can be executed from start to end. The response will contain an unique identifier which is used to move the robot. - Partially valid: Only parts of the trajectory can be executed. The response will contain an unique identifier to move the robot and information about the failure for the part that is not executable. - Invalid: The trajectory can not be executed. The response will tell you the reason of failure. If the trajectory is at least partially valid, the parts of the trajectory that are valid can be executed using the [executeTrajectory](#/operations/executeTrajectory) endpoint. The workflow is as follows: - Generate a trajectory with [planTrajectory](#/operations/planTrajectory) or your own motion planner, - Send the trajectory to this endpoint to validate it and get a unique identifier for it, - The unique identifier will appear in the list of available trajectories, see [listTrajectories](#/operations/listTrajectories) endpoint, if it is at least partially executable. - Execute your trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint.
|
|
6303
6290
|
* @summary Add Trajectory
|
|
6304
6291
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6305
6292
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6322,7 +6309,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6322
6309
|
return TrajectoryCachingApiFp(this.configuration).clearTrajectories(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
6323
6310
|
}
|
|
6324
6311
|
/**
|
|
6325
|
-
* Delete a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6312
|
+
* Delete a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories. Trajectories are removed automatically if the motion group or the corresponding controller is disconnected.
|
|
6326
6313
|
* @summary Delete Trajectory
|
|
6327
6314
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6328
6315
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6334,7 +6321,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6334
6321
|
return TrajectoryCachingApiFp(this.configuration).deleteTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
6335
6322
|
}
|
|
6336
6323
|
/**
|
|
6337
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
6324
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
6338
6325
|
* @summary Get Trajectory
|
|
6339
6326
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6340
6327
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6346,7 +6333,7 @@ var TrajectoryCachingApi = class extends BaseAPI {
|
|
|
6346
6333
|
return TrajectoryCachingApiFp(this.configuration).getTrajectory(cell, controller, trajectory, options).then((request) => request(this.axios, this.basePath));
|
|
6347
6334
|
}
|
|
6348
6335
|
/**
|
|
6349
|
-
* List currently cached trajectories. Use [addTrajectory](addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
6336
|
+
* List currently cached trajectories. Use [addTrajectory](#/operations/addTrajectory) to add a new trajectory. Adding trajectories is necessary to execute them. Trajectories are removed if the corresponding motion group or controller disconnects.
|
|
6350
6337
|
* @summary List Trajectories
|
|
6351
6338
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6352
6339
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6376,7 +6363,6 @@ const TrajectoryExecutionApiAxiosParamCreator = function(configuration) {
|
|
|
6376
6363
|
};
|
|
6377
6364
|
const localVarHeaderParameter = {};
|
|
6378
6365
|
const localVarQueryParameter = {};
|
|
6379
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6380
6366
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6381
6367
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6382
6368
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6419,7 +6405,7 @@ const TrajectoryExecutionApiFactory = function(configuration, basePath, axios) {
|
|
|
6419
6405
|
*/
|
|
6420
6406
|
var TrajectoryExecutionApi = class extends BaseAPI {
|
|
6421
6407
|
/**
|
|
6422
|
-
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or
|
|
6408
|
+
* <!-- theme: success --> > Websocket endpoint Provides execution control over a previously [planned trajectory](#/operations/planTrajectory). Enables the caller to attach input/output actions to the trajectory. ### Movement behavior | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** | ### Concept of location - The location or path parameter specifies the exact position along a trajectory. - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](#/operations/planTrajectory). - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line. ### Preconditions - The motion group\'s control mode is not claimed by any other endpoint. - The motion group\'s joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](#/operations/executeToTrajectory) to move the robot to the start location. ### Requests #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection The following actions are executed: - Sets robot controller mode to control mode, - Sets start location of the execution Keep in mind that only a single trajectory can be locked to a websocket connection at a time. Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection. #### 2. Send `StartMovementRequest` to start the movement Sets direction of movement, default is forward. #### **Optional** - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement\'s velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`. ### Responses To monitor the state of the movement, listen to the [state stream](#/operations/streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details. Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement. Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement. ### Tips and Tricks - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.
|
|
6423
6409
|
* @summary Execute Trajectory
|
|
6424
6410
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6425
6411
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -6450,7 +6436,6 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6450
6436
|
};
|
|
6451
6437
|
const localVarHeaderParameter = {};
|
|
6452
6438
|
const localVarQueryParameter = {};
|
|
6453
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6454
6439
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6455
6440
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6456
6441
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6480,7 +6465,6 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
|
|
|
6480
6465
|
};
|
|
6481
6466
|
const localVarHeaderParameter = {};
|
|
6482
6467
|
const localVarQueryParameter = {};
|
|
6483
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6484
6468
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6485
6469
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6486
6470
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6537,7 +6521,7 @@ const TrajectoryPlanningApiFactory = function(configuration, basePath, axios) {
|
|
|
6537
6521
|
*/
|
|
6538
6522
|
var TrajectoryPlanningApi = class extends BaseAPI {
|
|
6539
6523
|
/**
|
|
6540
|
-
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
6524
|
+
* Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
|
|
6541
6525
|
* @summary Plan Collision-Free Trajectory
|
|
6542
6526
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6543
6527
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -6548,7 +6532,7 @@ var TrajectoryPlanningApi = class extends BaseAPI {
|
|
|
6548
6532
|
return TrajectoryPlanningApiFp(this.configuration).planCollisionFree(cell, planCollisionFreeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
6549
6533
|
}
|
|
6550
6534
|
/**
|
|
6551
|
-
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
6535
|
+
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](#/operations/addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](#/operations/executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
|
|
6552
6536
|
* @summary Plan Trajectory
|
|
6553
6537
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6554
6538
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -6574,7 +6558,6 @@ const VersionApiAxiosParamCreator = function(configuration) {
|
|
|
6574
6558
|
};
|
|
6575
6559
|
const localVarHeaderParameter = {};
|
|
6576
6560
|
const localVarQueryParameter = {};
|
|
6577
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6578
6561
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6579
6562
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6580
6563
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6645,7 +6628,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6645
6628
|
};
|
|
6646
6629
|
const localVarHeaderParameter = {};
|
|
6647
6630
|
const localVarQueryParameter = {};
|
|
6648
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6649
6631
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6650
6632
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6651
6633
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6661,6 +6643,36 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6661
6643
|
options: localVarRequestOptions
|
|
6662
6644
|
};
|
|
6663
6645
|
},
|
|
6646
|
+
addVirtualControllerMotionGroup: async (cell, controller, addVirtualControllerMotionGroupRequest, options = {}) => {
|
|
6647
|
+
assertParamExists("addVirtualControllerMotionGroup", "cell", cell);
|
|
6648
|
+
assertParamExists("addVirtualControllerMotionGroup", "controller", controller);
|
|
6649
|
+
assertParamExists("addVirtualControllerMotionGroup", "addVirtualControllerMotionGroupRequest", addVirtualControllerMotionGroupRequest);
|
|
6650
|
+
const localVarPath = `/cells/{cell}/virtual-controllers/{controller}/motion-groups`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
|
|
6651
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6652
|
+
let baseOptions;
|
|
6653
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6654
|
+
const localVarRequestOptions = {
|
|
6655
|
+
method: "POST",
|
|
6656
|
+
...baseOptions,
|
|
6657
|
+
...options
|
|
6658
|
+
};
|
|
6659
|
+
const localVarHeaderParameter = {};
|
|
6660
|
+
const localVarQueryParameter = {};
|
|
6661
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6662
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6663
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6664
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6665
|
+
localVarRequestOptions.headers = {
|
|
6666
|
+
...localVarHeaderParameter,
|
|
6667
|
+
...headersFromBaseOptions,
|
|
6668
|
+
...options.headers
|
|
6669
|
+
};
|
|
6670
|
+
localVarRequestOptions.data = serializeDataIfNeeded(addVirtualControllerMotionGroupRequest, localVarRequestOptions, configuration);
|
|
6671
|
+
return {
|
|
6672
|
+
url: toPathString(localVarUrlObj),
|
|
6673
|
+
options: localVarRequestOptions
|
|
6674
|
+
};
|
|
6675
|
+
},
|
|
6664
6676
|
addVirtualControllerTcp: async (cell, controller, motionGroup, tcp, robotTcpData, options = {}) => {
|
|
6665
6677
|
assertParamExists("addVirtualControllerTcp", "cell", cell);
|
|
6666
6678
|
assertParamExists("addVirtualControllerTcp", "controller", controller);
|
|
@@ -6678,7 +6690,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6678
6690
|
};
|
|
6679
6691
|
const localVarHeaderParameter = {};
|
|
6680
6692
|
const localVarQueryParameter = {};
|
|
6681
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6682
6693
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6683
6694
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
6684
6695
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6709,7 +6720,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6709
6720
|
};
|
|
6710
6721
|
const localVarHeaderParameter = {};
|
|
6711
6722
|
const localVarQueryParameter = {};
|
|
6712
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6713
6723
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6714
6724
|
if (deleteDependent !== void 0) localVarQueryParameter["delete_dependent"] = deleteDependent;
|
|
6715
6725
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6724,6 +6734,34 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6724
6734
|
options: localVarRequestOptions
|
|
6725
6735
|
};
|
|
6726
6736
|
},
|
|
6737
|
+
deleteVirtualControllerMotionGroup: async (cell, controller, motionGroup, options = {}) => {
|
|
6738
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "cell", cell);
|
|
6739
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "controller", controller);
|
|
6740
|
+
assertParamExists("deleteVirtualControllerMotionGroup", "motionGroup", motionGroup);
|
|
6741
|
+
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)));
|
|
6742
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6743
|
+
let baseOptions;
|
|
6744
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
6745
|
+
const localVarRequestOptions = {
|
|
6746
|
+
method: "DELETE",
|
|
6747
|
+
...baseOptions,
|
|
6748
|
+
...options
|
|
6749
|
+
};
|
|
6750
|
+
const localVarHeaderParameter = {};
|
|
6751
|
+
const localVarQueryParameter = {};
|
|
6752
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6753
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6754
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6755
|
+
localVarRequestOptions.headers = {
|
|
6756
|
+
...localVarHeaderParameter,
|
|
6757
|
+
...headersFromBaseOptions,
|
|
6758
|
+
...options.headers
|
|
6759
|
+
};
|
|
6760
|
+
return {
|
|
6761
|
+
url: toPathString(localVarUrlObj),
|
|
6762
|
+
options: localVarRequestOptions
|
|
6763
|
+
};
|
|
6764
|
+
},
|
|
6727
6765
|
deleteVirtualControllerTcp: async (cell, controller, motionGroup, tcp, options = {}) => {
|
|
6728
6766
|
assertParamExists("deleteVirtualControllerTcp", "cell", cell);
|
|
6729
6767
|
assertParamExists("deleteVirtualControllerTcp", "controller", controller);
|
|
@@ -6740,7 +6778,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6740
6778
|
};
|
|
6741
6779
|
const localVarHeaderParameter = {};
|
|
6742
6780
|
const localVarQueryParameter = {};
|
|
6743
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6744
6781
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6745
6782
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6746
6783
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6768,7 +6805,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6768
6805
|
};
|
|
6769
6806
|
const localVarHeaderParameter = {};
|
|
6770
6807
|
const localVarQueryParameter = {};
|
|
6771
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6772
6808
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6773
6809
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6774
6810
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6797,7 +6833,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6797
6833
|
};
|
|
6798
6834
|
const localVarHeaderParameter = {};
|
|
6799
6835
|
const localVarQueryParameter = {};
|
|
6800
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6801
6836
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6802
6837
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6803
6838
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6825,7 +6860,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6825
6860
|
};
|
|
6826
6861
|
const localVarHeaderParameter = {};
|
|
6827
6862
|
const localVarQueryParameter = {};
|
|
6828
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6829
6863
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6830
6864
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6831
6865
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6853,7 +6887,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6853
6887
|
};
|
|
6854
6888
|
const localVarHeaderParameter = {};
|
|
6855
6889
|
const localVarQueryParameter = {};
|
|
6856
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6857
6890
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6858
6891
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6859
6892
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6882,7 +6915,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6882
6915
|
};
|
|
6883
6916
|
const localVarHeaderParameter = {};
|
|
6884
6917
|
const localVarQueryParameter = {};
|
|
6885
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6886
6918
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6887
6919
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6888
6920
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6910,7 +6942,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6910
6942
|
};
|
|
6911
6943
|
const localVarHeaderParameter = {};
|
|
6912
6944
|
const localVarQueryParameter = {};
|
|
6913
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6914
6945
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6915
6946
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6916
6947
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6939,7 +6970,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6939
6970
|
};
|
|
6940
6971
|
const localVarHeaderParameter = {};
|
|
6941
6972
|
const localVarQueryParameter = {};
|
|
6942
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6943
6973
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6944
6974
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6945
6975
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -6967,7 +6997,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6967
6997
|
};
|
|
6968
6998
|
const localVarHeaderParameter = {};
|
|
6969
6999
|
const localVarQueryParameter = {};
|
|
6970
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
6971
7000
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
6972
7001
|
if (active !== void 0) localVarQueryParameter["active"] = active;
|
|
6973
7002
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6998,7 +7027,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
6998
7027
|
};
|
|
6999
7028
|
const localVarHeaderParameter = {};
|
|
7000
7029
|
const localVarQueryParameter = {};
|
|
7001
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7002
7030
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7003
7031
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7004
7032
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7029,7 +7057,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7029
7057
|
};
|
|
7030
7058
|
const localVarHeaderParameter = {};
|
|
7031
7059
|
const localVarQueryParameter = {};
|
|
7032
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7033
7060
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7034
7061
|
if (mode !== void 0) localVarQueryParameter["mode"] = mode;
|
|
7035
7062
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7060,7 +7087,6 @@ const VirtualControllerApiAxiosParamCreator = function(configuration) {
|
|
|
7060
7087
|
};
|
|
7061
7088
|
const localVarHeaderParameter = {};
|
|
7062
7089
|
const localVarQueryParameter = {};
|
|
7063
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7064
7090
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7065
7091
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7066
7092
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7090,6 +7116,12 @@ const VirtualControllerApiFp = function(configuration) {
|
|
|
7090
7116
|
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.addVirtualControllerCoordinateSystem"]?.[localVarOperationServerIndex]?.url;
|
|
7091
7117
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7092
7118
|
},
|
|
7119
|
+
async addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7120
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options);
|
|
7121
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7122
|
+
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.addVirtualControllerMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
7123
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7124
|
+
},
|
|
7093
7125
|
async addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
7094
7126
|
const localVarAxiosArgs = await localVarAxiosParamCreator.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options);
|
|
7095
7127
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -7102,6 +7134,12 @@ const VirtualControllerApiFp = function(configuration) {
|
|
|
7102
7134
|
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.deleteVirtualControllerCoordinateSystem"]?.[localVarOperationServerIndex]?.url;
|
|
7103
7135
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7104
7136
|
},
|
|
7137
|
+
async deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7138
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options);
|
|
7139
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7140
|
+
const localVarOperationServerBasePath = operationServerMap["VirtualControllerApi.deleteVirtualControllerMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
7141
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7142
|
+
},
|
|
7105
7143
|
async deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
7106
7144
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options);
|
|
7107
7145
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -7185,12 +7223,18 @@ const VirtualControllerApiFactory = function(configuration, basePath, axios) {
|
|
|
7185
7223
|
addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options) {
|
|
7186
7224
|
return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
|
|
7187
7225
|
},
|
|
7226
|
+
addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7227
|
+
return localVarFp.addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options).then((request) => request(axios, basePath));
|
|
7228
|
+
},
|
|
7188
7229
|
addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options) {
|
|
7189
7230
|
return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
|
|
7190
7231
|
},
|
|
7191
7232
|
deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options) {
|
|
7192
7233
|
return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
7193
7234
|
},
|
|
7235
|
+
deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7236
|
+
return localVarFp.deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options).then((request) => request(axios, basePath));
|
|
7237
|
+
},
|
|
7194
7238
|
deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options) {
|
|
7195
7239
|
return localVarFp.deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(axios, basePath));
|
|
7196
7240
|
},
|
|
@@ -7247,6 +7291,18 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7247
7291
|
return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
7248
7292
|
}
|
|
7249
7293
|
/**
|
|
7294
|
+
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
7295
|
+
* @summary Add Motion Group
|
|
7296
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7297
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7298
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
7299
|
+
* @param {*} [options] Override http request option.
|
|
7300
|
+
* @throws {RequiredError}
|
|
7301
|
+
*/
|
|
7302
|
+
addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options) {
|
|
7303
|
+
return VirtualControllerApiFp(this.configuration).addVirtualControllerMotionGroup(cell, controller, addVirtualControllerMotionGroupRequest, options).then((request) => request(this.axios, this.basePath));
|
|
7304
|
+
}
|
|
7305
|
+
/**
|
|
7250
7306
|
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. <!-- theme: info --> > #### NOTE > > When adding or updating a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the TCP is available for operation. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the TCP may not yet be visible nor usable.
|
|
7251
7307
|
* @summary Add TCP
|
|
7252
7308
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7274,6 +7330,18 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7274
7330
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
7275
7331
|
}
|
|
7276
7332
|
/**
|
|
7333
|
+
* 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**.
|
|
7334
|
+
* @summary Delete Motion Group
|
|
7335
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7336
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7337
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
7338
|
+
* @param {*} [options] Override http request option.
|
|
7339
|
+
* @throws {RequiredError}
|
|
7340
|
+
*/
|
|
7341
|
+
deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options) {
|
|
7342
|
+
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerMotionGroup(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
7343
|
+
}
|
|
7344
|
+
/**
|
|
7277
7345
|
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. <!-- theme: info --> > #### NOTE > > When removing a TCP, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear. > - The removal of the TCP may not be immediately visible or appear outdated in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the then used TCP may not yet be visible nor usable.
|
|
7278
7346
|
* @summary Remove TCP
|
|
7279
7347
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -7287,7 +7355,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7287
7355
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerTcp(cell, controller, motionGroup, tcp, options).then((request) => request(this.axios, this.basePath));
|
|
7288
7356
|
}
|
|
7289
7357
|
/**
|
|
7290
|
-
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
7358
|
+
* Requests the Emergency Stop state of the virtual robot controller. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed when using virtual robot controllers.
|
|
7291
7359
|
* @summary Get Emergency Stop State
|
|
7292
7360
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7293
7361
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7321,7 +7389,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7321
7389
|
return VirtualControllerApiFp(this.configuration).getMotionGroups(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7322
7390
|
}
|
|
7323
7391
|
/**
|
|
7324
|
-
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7392
|
+
* Requests the operation mode of the virtual robot controller. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7325
7393
|
* @summary Get Operation Mode
|
|
7326
7394
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7327
7395
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7367,7 +7435,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7367
7435
|
return VirtualControllerApiFp(this.configuration).listVirtualControllerTcps(cell, controller, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
7368
7436
|
}
|
|
7369
7437
|
/**
|
|
7370
|
-
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
7438
|
+
* Activates or releases the Emergency Stop on the virtual robot controller. Activating the Emergency Stop stops the execution of all motions. The stop is executed on physical controllers immediately not gracefully and not on paths. Due to restricted physical behavior of the virtual robot controller, the Emergency Stop is executed on paths. To return to normal operation the Emergency Stop needs to be released. Use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState) to get the Emergency Stop state with `safety_state` regardless of the controller type. > **NOTE** > > The Emergency Stop state can only be changed via API when using virtual robot controllers.
|
|
7371
7439
|
* @summary Push or Release Emergency Stop
|
|
7372
7440
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7373
7441
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7392,7 +7460,7 @@ var VirtualControllerApi = class extends BaseAPI {
|
|
|
7392
7460
|
return VirtualControllerApiFp(this.configuration).setMotionGroupState(cell, controller, motionGroup, motionGroupJoints, options).then((request) => request(this.axios, this.basePath));
|
|
7393
7461
|
}
|
|
7394
7462
|
/**
|
|
7395
|
-
* Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7463
|
+
* Changes the operation mode of the virtual robot controller to the specified value. To get the operation mode regardless of the controller type, use [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). > **NOTE** > > The operation mode can only be changed via API when using virtual robot controllers.
|
|
7396
7464
|
* @summary Set Operation Mode
|
|
7397
7465
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7398
7466
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7437,7 +7505,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7437
7505
|
};
|
|
7438
7506
|
const localVarHeaderParameter = {};
|
|
7439
7507
|
const localVarQueryParameter = {};
|
|
7440
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7441
7508
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7442
7509
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7443
7510
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7467,7 +7534,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7467
7534
|
};
|
|
7468
7535
|
const localVarHeaderParameter = {};
|
|
7469
7536
|
const localVarQueryParameter = {};
|
|
7470
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7471
7537
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7472
7538
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7473
7539
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7495,7 +7561,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7495
7561
|
};
|
|
7496
7562
|
const localVarHeaderParameter = {};
|
|
7497
7563
|
const localVarQueryParameter = {};
|
|
7498
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7499
7564
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7500
7565
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7501
7566
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -7523,7 +7588,6 @@ const VirtualControllerBehaviorApiAxiosParamCreator = function(configuration) {
|
|
|
7523
7588
|
};
|
|
7524
7589
|
const localVarHeaderParameter = {};
|
|
7525
7590
|
const localVarQueryParameter = {};
|
|
7526
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7527
7591
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7528
7592
|
if (behavior !== void 0) localVarQueryParameter["behavior"] = behavior;
|
|
7529
7593
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7597,7 +7661,7 @@ const VirtualControllerBehaviorApiFactory = function(configuration, basePath, ax
|
|
|
7597
7661
|
*/
|
|
7598
7662
|
var VirtualControllerBehaviorApi = class extends BaseAPI {
|
|
7599
7663
|
/**
|
|
7600
|
-
* <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](planTrajectory) and [executeTrajectory](executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
7664
|
+
* <!-- theme: success --> > Websocket endpoint Sends the **commanded** state, e.g., joint positions, velocities, accelerations, torques, for each motion group of the virtual controller and sets the joint configuration. Use [planTrajectory](#/operations/planTrajectory) and [executeTrajectory](#/operations/executeTrajectory) to move motion groups on virtual controllers. Learn more about the [movement behavior of virtual controllers in comparison to physical controllers](#/operations/executeTrajectory#movement-behavior). > **NOTE** > > Incoming joint configurations are not visualized and their velocity limits are not checked. #### Use cases 1. Creating a robotic application that dynamically adapts to the configured joints on the robot controller, using this stream to feed new joint configurations back to the motion groups.\\ The stream only sends data to the robot controller if a motion is executed.\\ If the robot controller\'s joint configuration differs too much from the incoming joint configuration, a following error occurs. Joint configurations that result in following errors are executed only for motions with a low velocity. 2. Mimic freedrive motions. <!-- theme: danger --> > **DANGER** > > If the incoming joint configuration is set to maximum velocity, the movement to reach this incoming joint configuration > will be executed with maximum speed regardless of safety zones and mechanical limits.
|
|
7601
7665
|
* @summary Stream Joint Configuration
|
|
7602
7666
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7603
7667
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7620,7 +7684,7 @@ var VirtualControllerBehaviorApi = class extends BaseAPI {
|
|
|
7620
7684
|
return VirtualControllerBehaviorApiFp(this.configuration).getCycleTime(cell, controller, options).then((request) => request(this.axios, this.basePath));
|
|
7621
7685
|
}
|
|
7622
7686
|
/**
|
|
7623
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
7687
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
7624
7688
|
* @summary Get Behavior
|
|
7625
7689
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7626
7690
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7663,7 +7727,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7663
7727
|
};
|
|
7664
7728
|
const localVarHeaderParameter = {};
|
|
7665
7729
|
const localVarQueryParameter = {};
|
|
7666
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7667
7730
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7668
7731
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
7669
7732
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7692,7 +7755,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7692
7755
|
};
|
|
7693
7756
|
const localVarHeaderParameter = {};
|
|
7694
7757
|
const localVarQueryParameter = {};
|
|
7695
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7696
7758
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7697
7759
|
if (ios) localVarQueryParameter["ios"] = ios;
|
|
7698
7760
|
if (direction !== void 0) localVarQueryParameter["direction"] = direction;
|
|
@@ -7725,7 +7787,6 @@ const VirtualControllerInputsOutputsApiAxiosParamCreator = function(configuratio
|
|
|
7725
7787
|
};
|
|
7726
7788
|
const localVarHeaderParameter = {};
|
|
7727
7789
|
const localVarQueryParameter = {};
|
|
7728
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
7729
7790
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
7730
7791
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
7731
7792
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -7791,7 +7852,7 @@ const VirtualControllerInputsOutputsApiFactory = function(configuration, basePat
|
|
|
7791
7852
|
*/
|
|
7792
7853
|
var VirtualControllerInputsOutputsApi = class extends BaseAPI {
|
|
7793
7854
|
/**
|
|
7794
|
-
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](listVirtualControllerIODescriptions).
|
|
7855
|
+
* Retrieves the current values of inputs/outputs of the virtual controller. The identifiers of inputs/outputs must be provided in the request. Request all available input/output identifiers via [listVirtualControllerIODescriptions](#/operations/listVirtualControllerIODescriptions).
|
|
7795
7856
|
* @summary Get Input/Output Values
|
|
7796
7857
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7797
7858
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7950,4 +8011,4 @@ var Configuration = class {
|
|
|
7950
8011
|
};
|
|
7951
8012
|
|
|
7952
8013
|
//#endregion
|
|
7953
|
-
export { AbbControllerKindEnum, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, NetworkStateConnectionTypeEnum, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SettableRobotSystemMode, SingularityTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsControllerKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, YaskawaControllerKindEnum, operationServerMap };
|
|
8014
|
+
export { AbbControllerKindEnum, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointTypeEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, NetworkStateConnectionTypeEnum, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SettableRobotSystemMode, SingularityTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsControllerKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, YaskawaControllerKindEnum, operationServerMap };
|