@wandelbots/nova-api 26.2.0-dev.5 → 26.2.0-dev.56
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/v1/index.cjs +60 -243
- package/dist/v1/index.d.cts +433 -433
- package/dist/v1/index.d.ts +433 -433
- package/dist/v1/index.js +60 -243
- package/dist/v2/index.cjs +270 -194
- package/dist/v2/index.d.cts +493 -222
- package/dist/v2/index.d.ts +633 -362
- package/dist/v2/index.js +263 -195
- package/package.json +1 -1
package/dist/v2/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as axios0 from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
@@ -7,7 +7,7 @@ import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
|
7
7
|
* Wandelbots NOVA API
|
|
8
8
|
* Interact with robots in an easy and intuitive way.
|
|
9
9
|
*
|
|
10
|
-
* The version of the OpenAPI document: 2.
|
|
10
|
+
* The version of the OpenAPI document: 2.2.0 dev
|
|
11
11
|
*
|
|
12
12
|
*
|
|
13
13
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -164,7 +164,7 @@ interface ActivateLicenseRequest {
|
|
|
164
164
|
interface AddTrajectoryError {
|
|
165
165
|
'message'?: string;
|
|
166
166
|
/**
|
|
167
|
-
*
|
|
167
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
168
168
|
*/
|
|
169
169
|
'location'?: number;
|
|
170
170
|
'data'?: AddTrajectoryErrorData;
|
|
@@ -172,7 +172,21 @@ interface AddTrajectoryError {
|
|
|
172
172
|
/**
|
|
173
173
|
* @type AddTrajectoryErrorData
|
|
174
174
|
*/
|
|
175
|
-
type AddTrajectoryErrorData =
|
|
175
|
+
type AddTrajectoryErrorData = {
|
|
176
|
+
kind: 'CollisionError';
|
|
177
|
+
} & CollisionError | {
|
|
178
|
+
kind: 'InconsistentTrajectorySizeError';
|
|
179
|
+
} & InconsistentTrajectorySizeError | {
|
|
180
|
+
kind: 'InvalidDofError';
|
|
181
|
+
} & InvalidDofError | {
|
|
182
|
+
kind: 'JointLimitExceededError';
|
|
183
|
+
} & JointLimitExceededError | {
|
|
184
|
+
kind: 'NanValueError';
|
|
185
|
+
} & NanValueError | {
|
|
186
|
+
kind: 'TcpRequiredError';
|
|
187
|
+
} & TcpRequiredError | {
|
|
188
|
+
kind: 'TorqueExceededError';
|
|
189
|
+
} & TorqueExceededError;
|
|
176
190
|
interface AddTrajectoryRequest {
|
|
177
191
|
/**
|
|
178
192
|
* Unique identifier of the motion group the trajectory is planned for.
|
|
@@ -188,11 +202,11 @@ interface AddTrajectoryRequest {
|
|
|
188
202
|
'tcp'?: string;
|
|
189
203
|
}
|
|
190
204
|
/**
|
|
191
|
-
* The response signals if the trajectory is valid or faulty resulting in an executable, partially executable or
|
|
205
|
+
* The response signals if the trajectory is valid or faulty, resulting in an executable, partially executable or non-executable state. - valid trajectory: response contains only the unique identifier for the trajectory - trajectory has error on path: response contains the unique identifier for the trajectory and information about the failure. It is executable up to the point of failure. - trajectory has error at start or invalid data: response contains only information about the failure. To execute the trajectory, use the unique identifier for calling [executeTrajectory](#/operations/executeTrajectory). If you want to validate your trajectory before execution, execute it with a virtual motion group and check the state in the response stream of [executeTrajectory](#/operations/executeTrajectory).
|
|
192
206
|
*/
|
|
193
207
|
interface AddTrajectoryResponse {
|
|
194
208
|
/**
|
|
195
|
-
* The unique identifier of the trajectory. Use this identifier to execute the trajectory with the [executeTrajectory](executeTrajectory) endpoint.
|
|
209
|
+
* The unique identifier of the trajectory. Use this identifier to execute the trajectory with the [executeTrajectory](#/operations/executeTrajectory) endpoint.
|
|
196
210
|
*/
|
|
197
211
|
'trajectory'?: string;
|
|
198
212
|
/**
|
|
@@ -200,6 +214,11 @@ interface AddTrajectoryResponse {
|
|
|
200
214
|
*/
|
|
201
215
|
'error'?: AddTrajectoryError;
|
|
202
216
|
}
|
|
217
|
+
/**
|
|
218
|
+
* @type AddVirtualControllerMotionGroupRequest
|
|
219
|
+
* Request body wrapper for `addVirtualControllerMotionGroup`. Allow callers to either reference a predefined motion group model or upload a full JSON configuration that the backend extracts into a motion group description.
|
|
220
|
+
*/
|
|
221
|
+
type AddVirtualControllerMotionGroupRequest = MotionGroupFromJson | MotionGroupFromType;
|
|
203
222
|
interface ApiVersion {
|
|
204
223
|
/**
|
|
205
224
|
* The version of the API.
|
|
@@ -239,7 +258,7 @@ interface App {
|
|
|
239
258
|
'diagnosis_path'?: string;
|
|
240
259
|
}
|
|
241
260
|
/**
|
|
242
|
-
* ## 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).
|
|
261
|
+
* ## 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).
|
|
243
262
|
*/
|
|
244
263
|
declare const Behavior: {
|
|
245
264
|
readonly BehaviorAutomatic: "BEHAVIOR_AUTOMATIC";
|
|
@@ -349,7 +368,7 @@ interface BusIODescription {
|
|
|
349
368
|
*/
|
|
350
369
|
'io': string;
|
|
351
370
|
/**
|
|
352
|
-
* Name of the input/output. Customize it using the respective BUS service, e.g., [addProfinetIO](addProfinetIO) for PROFINET service.
|
|
371
|
+
* Name of the input/output. Customize it using the respective BUS service, e.g., [addProfinetIO](#/operations/addProfinetIO) for PROFINET service.
|
|
353
372
|
*/
|
|
354
373
|
'name': string;
|
|
355
374
|
'direction': IODirection;
|
|
@@ -576,6 +595,10 @@ interface Cell {
|
|
|
576
595
|
* A unique name for the cell used as an identifier for addressing the cell in all API calls. It must be a valid k8s label name as defined by [RFC 1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names).
|
|
577
596
|
*/
|
|
578
597
|
'name': string;
|
|
598
|
+
/**
|
|
599
|
+
* Wandelbots NOVA version of the cell. This version must not exceed the current system version.
|
|
600
|
+
*/
|
|
601
|
+
'version'?: string;
|
|
579
602
|
/**
|
|
580
603
|
* A description of the cell.
|
|
581
604
|
*/
|
|
@@ -636,8 +659,13 @@ interface CollisionContact {
|
|
|
636
659
|
'root'?: Array<number>;
|
|
637
660
|
}
|
|
638
661
|
interface CollisionError {
|
|
662
|
+
'kind': CollisionErrorKindEnum;
|
|
639
663
|
'collision'?: FeedbackCollision;
|
|
640
664
|
}
|
|
665
|
+
declare const CollisionErrorKindEnum: {
|
|
666
|
+
readonly CollisionError: "CollisionError";
|
|
667
|
+
};
|
|
668
|
+
type CollisionErrorKindEnum = typeof CollisionErrorKindEnum[keyof typeof CollisionErrorKindEnum];
|
|
641
669
|
/**
|
|
642
670
|
* @type CollisionFreeAlgorithm
|
|
643
671
|
* Configuration for collision-free path planning algorithms. Different algorithms may have different parameters and behavior. Recommendation: - For **cells with many obstacles**, use the RRTConnect algorithm. Use it as a starting point. - For **simple cells with very few obstacles** and when a faster solution is needed, try the MidpointInsertion algorithm.
|
|
@@ -777,7 +805,7 @@ interface ContainerResources {
|
|
|
777
805
|
'memory_limit'?: string;
|
|
778
806
|
}
|
|
779
807
|
/**
|
|
780
|
-
* The path and capacity of a volume that retains data across application restarts. The maximal requestable capacity is 300Mi. If you need more capacity consider using [storeObject](storeObject).
|
|
808
|
+
* The path and capacity of a volume that retains data across application restarts. The maximal requestable capacity is 300Mi. If you need more capacity consider using [storeObject](#/operations/storeObject).
|
|
781
809
|
*/
|
|
782
810
|
interface ContainerStorage {
|
|
783
811
|
'mount_path': string;
|
|
@@ -912,6 +940,7 @@ interface DHParameter {
|
|
|
912
940
|
* True, if rotation direction of joint is reversed.
|
|
913
941
|
*/
|
|
914
942
|
'reverse_rotation_direction'?: boolean;
|
|
943
|
+
'type'?: JointTypeEnum;
|
|
915
944
|
}
|
|
916
945
|
/**
|
|
917
946
|
* The direction in which the trajectory is executed. Default: Forward.
|
|
@@ -985,7 +1014,7 @@ type ErrorMaxIterationsExceededErrorFeedbackNameEnum = typeof ErrorMaxIterations
|
|
|
985
1014
|
*/
|
|
986
1015
|
interface Execute {
|
|
987
1016
|
/**
|
|
988
|
-
* Commanded joint position of each joint
|
|
1017
|
+
* Commanded joint position of each joint. This command was sent in the time step the corresponding state was received. The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm].
|
|
989
1018
|
*/
|
|
990
1019
|
'joint_position': Array<number>;
|
|
991
1020
|
'details'?: ExecuteDetails;
|
|
@@ -1122,11 +1151,11 @@ interface ForwardKinematics422Response {
|
|
|
1122
1151
|
}
|
|
1123
1152
|
interface ForwardKinematicsRequest {
|
|
1124
1153
|
/**
|
|
1125
|
-
*
|
|
1154
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
1126
1155
|
*/
|
|
1127
1156
|
'motion_group_model': string;
|
|
1128
1157
|
/**
|
|
1129
|
-
* List of joint positions
|
|
1158
|
+
* List of joint positions for which TCP poses are computed. The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm].
|
|
1130
1159
|
*/
|
|
1131
1160
|
'joint_positions': Array<Array<number>>;
|
|
1132
1161
|
'tcp_offset'?: Pose;
|
|
@@ -1291,8 +1320,13 @@ interface ImageCredentials {
|
|
|
1291
1320
|
* Indicates that the trajectory contains an inconsistent number of joint positions, times, or locations.
|
|
1292
1321
|
*/
|
|
1293
1322
|
interface InconsistentTrajectorySizeError {
|
|
1323
|
+
'kind': InconsistentTrajectorySizeErrorKindEnum;
|
|
1294
1324
|
'inconsistent_trajectory_size'?: InconsistentTrajectorySizeErrorInconsistentTrajectorySize;
|
|
1295
1325
|
}
|
|
1326
|
+
declare const InconsistentTrajectorySizeErrorKindEnum: {
|
|
1327
|
+
readonly InconsistentTrajectorySizeError: "InconsistentTrajectorySizeError";
|
|
1328
|
+
};
|
|
1329
|
+
type InconsistentTrajectorySizeErrorKindEnum = typeof InconsistentTrajectorySizeErrorKindEnum[keyof typeof InconsistentTrajectorySizeErrorKindEnum];
|
|
1296
1330
|
interface InconsistentTrajectorySizeErrorInconsistentTrajectorySize {
|
|
1297
1331
|
'joint_position_size'?: number;
|
|
1298
1332
|
'times_size'?: number;
|
|
@@ -1343,7 +1377,7 @@ interface InitializeMovementRequest {
|
|
|
1343
1377
|
'message_type': InitializeMovementRequestMessageTypeEnum;
|
|
1344
1378
|
'trajectory': InitializeMovementRequestTrajectory;
|
|
1345
1379
|
/**
|
|
1346
|
-
*
|
|
1380
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
1347
1381
|
*/
|
|
1348
1382
|
'initial_location'?: number;
|
|
1349
1383
|
/**
|
|
@@ -1369,7 +1403,7 @@ interface InitializeMovementResponse {
|
|
|
1369
1403
|
*/
|
|
1370
1404
|
'message'?: string;
|
|
1371
1405
|
/**
|
|
1372
|
-
* Error can occur if joint trajectory was added by
|
|
1406
|
+
* Error can occur if joint trajectory was added by InitializeMovementRequest and the trajectory is invalid.
|
|
1373
1407
|
*/
|
|
1374
1408
|
'add_trajectory_error'?: AddTrajectoryError;
|
|
1375
1409
|
'kind': InitializeMovementResponseKindEnum;
|
|
@@ -1390,8 +1424,13 @@ declare const IntegerValueValueTypeEnum: {
|
|
|
1390
1424
|
};
|
|
1391
1425
|
type IntegerValueValueTypeEnum = typeof IntegerValueValueTypeEnum[keyof typeof IntegerValueValueTypeEnum];
|
|
1392
1426
|
interface InvalidDofError {
|
|
1427
|
+
'kind': InvalidDofErrorKindEnum;
|
|
1393
1428
|
'invalid_dof'?: InvalidDofErrorInvalidDof;
|
|
1394
1429
|
}
|
|
1430
|
+
declare const InvalidDofErrorKindEnum: {
|
|
1431
|
+
readonly InvalidDofError: "InvalidDofError";
|
|
1432
|
+
};
|
|
1433
|
+
type InvalidDofErrorKindEnum = typeof InvalidDofErrorKindEnum[keyof typeof InvalidDofErrorKindEnum];
|
|
1395
1434
|
interface InvalidDofErrorInvalidDof {
|
|
1396
1435
|
/**
|
|
1397
1436
|
* The valid degrees of freedom for the motion group.
|
|
@@ -1407,7 +1446,7 @@ interface InverseKinematics422Response {
|
|
|
1407
1446
|
}
|
|
1408
1447
|
interface InverseKinematicsRequest {
|
|
1409
1448
|
/**
|
|
1410
|
-
*
|
|
1449
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
1411
1450
|
*/
|
|
1412
1451
|
'motion_group_model': string;
|
|
1413
1452
|
/**
|
|
@@ -1420,7 +1459,7 @@ interface InverseKinematicsRequest {
|
|
|
1420
1459
|
*/
|
|
1421
1460
|
'mounting'?: Pose;
|
|
1422
1461
|
/**
|
|
1423
|
-
* Joint position limits in [rad],
|
|
1462
|
+
* Joint position limits, indexed starting from base. The unit depends on the type of joint: For revolute joints, the limit is given in [rad]; for prismatic joints, it is given in [mm].
|
|
1424
1463
|
*/
|
|
1425
1464
|
'joint_position_limits'?: Array<LimitRange>;
|
|
1426
1465
|
/**
|
|
@@ -1526,8 +1565,13 @@ declare const JoggingRunningKindEnum: {
|
|
|
1526
1565
|
};
|
|
1527
1566
|
type JoggingRunningKindEnum = typeof JoggingRunningKindEnum[keyof typeof JoggingRunningKindEnum];
|
|
1528
1567
|
interface JointLimitExceededError {
|
|
1568
|
+
'kind': JointLimitExceededErrorKindEnum;
|
|
1529
1569
|
'joint_limit_exceeded'?: FeedbackJointLimitExceeded;
|
|
1530
1570
|
}
|
|
1571
|
+
declare const JointLimitExceededErrorKindEnum: {
|
|
1572
|
+
readonly JointLimitExceededError: "JointLimitExceededError";
|
|
1573
|
+
};
|
|
1574
|
+
type JointLimitExceededErrorKindEnum = typeof JointLimitExceededErrorKindEnum[keyof typeof JointLimitExceededErrorKindEnum];
|
|
1531
1575
|
interface JointLimits {
|
|
1532
1576
|
'position'?: LimitRange;
|
|
1533
1577
|
'velocity'?: number;
|
|
@@ -1536,7 +1580,7 @@ interface JointLimits {
|
|
|
1536
1580
|
}
|
|
1537
1581
|
interface JointTrajectory {
|
|
1538
1582
|
/**
|
|
1539
|
-
* List of joint positions
|
|
1583
|
+
* List of joint positions for each sample. The number of samples must match the number of timestamps provided in the times field. The unit depends on the type of joint: For revolute joints, the angle is given in [rad]; for prismatic joints, the displacement is given in [mm].
|
|
1540
1584
|
*/
|
|
1541
1585
|
'joint_positions': Array<Array<number>>;
|
|
1542
1586
|
/**
|
|
@@ -1545,6 +1589,11 @@ interface JointTrajectory {
|
|
|
1545
1589
|
'times': Array<number>;
|
|
1546
1590
|
'locations': Array<number>;
|
|
1547
1591
|
}
|
|
1592
|
+
declare const JointTypeEnum: {
|
|
1593
|
+
readonly RevoluteJoint: "REVOLUTE_JOINT";
|
|
1594
|
+
readonly PrismaticJoint: "PRISMATIC_JOINT";
|
|
1595
|
+
};
|
|
1596
|
+
type JointTypeEnum = typeof JointTypeEnum[keyof typeof JointTypeEnum];
|
|
1548
1597
|
/**
|
|
1549
1598
|
* Sets target joint velocities for jogging a motion group.
|
|
1550
1599
|
*/
|
|
@@ -1581,6 +1630,10 @@ type JointVelocityResponseKindEnum = typeof JointVelocityResponseKindEnum[keyof
|
|
|
1581
1630
|
*/
|
|
1582
1631
|
interface KinematicModel {
|
|
1583
1632
|
'dh_parameters'?: Array<DHParameter>;
|
|
1633
|
+
/**
|
|
1634
|
+
* Constant coordinate transformation between the motion group base frame and the start of the kinematic chain modeled by Denavit-Hartenberg parameters.
|
|
1635
|
+
*/
|
|
1636
|
+
'kinematic_chain_offset'?: Pose;
|
|
1584
1637
|
/**
|
|
1585
1638
|
* Optional name of the inverse kinematics solver.
|
|
1586
1639
|
*/
|
|
@@ -1711,7 +1764,7 @@ interface LimitsOverride {
|
|
|
1711
1764
|
}
|
|
1712
1765
|
interface ListTrajectoriesResponse {
|
|
1713
1766
|
/**
|
|
1714
|
-
* Identifiers of trajectories which are currently cached. 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.
|
|
1767
|
+
* Identifiers of trajectories which are currently cached. 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.
|
|
1715
1768
|
*/
|
|
1716
1769
|
'trajectories'?: Array<string>;
|
|
1717
1770
|
}
|
|
@@ -1833,11 +1886,11 @@ type MotionCommandBlending = BlendingAuto | BlendingPosition;
|
|
|
1833
1886
|
*/
|
|
1834
1887
|
type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
|
|
1835
1888
|
/**
|
|
1836
|
-
* The configuration of a motion-group used for motion planning.
|
|
1889
|
+
* The configuration of a motion-group used for motion planning. The parameters `mounting`, `kinematic_chain_offset`, `dh_parameters` and `tcp_offset` are used to model the kinematic structure of the motion group. They can be used to compute the coordinate transformations from world to tcp frame: [world frame] -> mounting -> [base frame] -> kinematic chain offset + motion group kinematics (Denavit-Hartenberg parameters) -> [flange frame] -> tcp_offset -> [tcp frame].
|
|
1837
1890
|
*/
|
|
1838
1891
|
interface MotionGroupDescription {
|
|
1839
1892
|
/**
|
|
1840
|
-
*
|
|
1893
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
1841
1894
|
*/
|
|
1842
1895
|
'motion_group_model': string;
|
|
1843
1896
|
/**
|
|
@@ -1882,14 +1935,50 @@ interface MotionGroupDescription {
|
|
|
1882
1935
|
*/
|
|
1883
1936
|
'cycle_time'?: number;
|
|
1884
1937
|
/**
|
|
1885
|
-
* The
|
|
1938
|
+
* The Denavit-Hartenberg parameters describing the motion group kinematics.
|
|
1886
1939
|
*/
|
|
1887
1940
|
'dh_parameters'?: Array<DHParameter>;
|
|
1941
|
+
/**
|
|
1942
|
+
* Constant coordinate transformation between the motion group base frame and the start of the kinematic chain modelled by Denavit-Hartenberg parameters. Unlike the mounting, which is used to set the actual position and orientation of the motion group within a cell, this offset is fixed. It is part of the description of the kinematical structure of the motion group.
|
|
1943
|
+
*/
|
|
1944
|
+
'kinematic_chain_offset'?: Pose;
|
|
1888
1945
|
/**
|
|
1889
1946
|
* The serial number of the motion group, if available. If not available, the serial number of the robot controller. If not available, empty.
|
|
1890
1947
|
*/
|
|
1891
1948
|
'serial_number'?: string;
|
|
1892
1949
|
}
|
|
1950
|
+
interface MotionGroupFromJson {
|
|
1951
|
+
/**
|
|
1952
|
+
* Unique identifier for the motion group to be added.
|
|
1953
|
+
*/
|
|
1954
|
+
'motion_group': string;
|
|
1955
|
+
/**
|
|
1956
|
+
* Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration).
|
|
1957
|
+
*/
|
|
1958
|
+
'json': string;
|
|
1959
|
+
/**
|
|
1960
|
+
* The identifier of the motion group that needs to be extracted from the provided JSON configuration.
|
|
1961
|
+
*/
|
|
1962
|
+
'extracted_motion_group_id': string;
|
|
1963
|
+
/**
|
|
1964
|
+
* Initial joint position of the added motion group. Provides the joint position as a JSON array of float values in radians, where the array length must match the robot\'s degrees of freedom (DOF), e.g., `\"[0, 0, 0, 0, 0, 0]\"` for a 6-DOF robot. If the provided array length does not match the robot\'s DOF, the array will be adjusted: if it is longer, extra values will be truncated; if it is shorter, missing values will be filled with zeros.
|
|
1965
|
+
*/
|
|
1966
|
+
'initial_joint_position'?: string;
|
|
1967
|
+
}
|
|
1968
|
+
interface MotionGroupFromType {
|
|
1969
|
+
/**
|
|
1970
|
+
* Unique identifier for the motion group to be added.
|
|
1971
|
+
*/
|
|
1972
|
+
'motion_group': string;
|
|
1973
|
+
/**
|
|
1974
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
1975
|
+
*/
|
|
1976
|
+
'motion_group_model': string;
|
|
1977
|
+
/**
|
|
1978
|
+
* Initial joint position of the added motion group. Provides the joint position as a JSON array of float values in radians, where the array length must match the robot\'s degrees of freedom (DOF), e.g., `\"[0, 0, 0, 0, 0, 0]\"` for a 6-DOF robot. If the provided array length does not match the robot\'s DOF, the array will be adjusted; if it is longer, extra values will be truncated; if it is shorter, missing values will be filled with zeros.
|
|
1979
|
+
*/
|
|
1980
|
+
'initial_joint_position'?: string;
|
|
1981
|
+
}
|
|
1893
1982
|
interface MotionGroupInfo {
|
|
1894
1983
|
/**
|
|
1895
1984
|
* The unique identifier of the motion group. Use it to refer to the motion group in other calls.
|
|
@@ -1905,7 +1994,7 @@ interface MotionGroupInfo {
|
|
|
1905
1994
|
'dof': number;
|
|
1906
1995
|
}
|
|
1907
1996
|
/**
|
|
1908
|
-
* Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
1997
|
+
* Ensure to provide one value for each joint. See [getMotionGroups](#/operations/getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
1909
1998
|
*/
|
|
1910
1999
|
interface MotionGroupJoints {
|
|
1911
2000
|
/**
|
|
@@ -1927,7 +2016,7 @@ interface MotionGroupJoints {
|
|
|
1927
2016
|
}
|
|
1928
2017
|
interface MotionGroupSetup {
|
|
1929
2018
|
/**
|
|
1930
|
-
*
|
|
2019
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
1931
2020
|
*/
|
|
1932
2021
|
'motion_group_model': string;
|
|
1933
2022
|
/**
|
|
@@ -1985,7 +2074,7 @@ interface MotionGroupState {
|
|
|
1985
2074
|
*/
|
|
1986
2075
|
'joint_current'?: Array<number>;
|
|
1987
2076
|
/**
|
|
1988
|
-
* Pose of the flange. Positions are in [mm].
|
|
2077
|
+
* Pose of the flange. Positions are in [mm]. Orientations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. For robot arms, a flange pose is always returned. For positioners, the flange might not be available, depending on the model.
|
|
1989
2078
|
*/
|
|
1990
2079
|
'flange_pose'?: Pose;
|
|
1991
2080
|
/**
|
|
@@ -1993,7 +2082,7 @@ interface MotionGroupState {
|
|
|
1993
2082
|
*/
|
|
1994
2083
|
'tcp'?: string;
|
|
1995
2084
|
/**
|
|
1996
|
-
* Pose of the TCP selected on the robot control panel. Positions are in [mm].
|
|
2085
|
+
* Pose of the TCP selected on the robot control panel. Positions are in [mm]. Orientations are in [rad]. The pose is relative to the response_coordinate_system specified in the request. Might not be returned for positioners as some do not support TCPs, depending on the model.
|
|
1997
2086
|
*/
|
|
1998
2087
|
'tcp_pose'?: Pose;
|
|
1999
2088
|
/**
|
|
@@ -2037,8 +2126,13 @@ declare const MovementErrorResponseKindEnum: {
|
|
|
2037
2126
|
};
|
|
2038
2127
|
type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
|
|
2039
2128
|
interface NanValueError {
|
|
2129
|
+
'kind': NanValueErrorKindEnum;
|
|
2040
2130
|
'nan_value'?: NanValueErrorNanValue;
|
|
2041
2131
|
}
|
|
2132
|
+
declare const NanValueErrorKindEnum: {
|
|
2133
|
+
readonly NanValueError: "NanValueError";
|
|
2134
|
+
};
|
|
2135
|
+
type NanValueErrorKindEnum = typeof NanValueErrorKindEnum[keyof typeof NanValueErrorKindEnum];
|
|
2042
2136
|
/**
|
|
2043
2137
|
* Requested joint position contains NaN values.
|
|
2044
2138
|
*/
|
|
@@ -2279,11 +2373,11 @@ declare const PauseMovementRequestMessageTypeEnum: {
|
|
|
2279
2373
|
};
|
|
2280
2374
|
type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
|
|
2281
2375
|
/**
|
|
2282
|
-
* Acknowledgment for PauseMovementRequest message. ATTENTION: No confirmation that the movement was paused. Confirmation that the PauseMovementRequest was received and is processed. End of movement execution is signalled by [
|
|
2376
|
+
* Acknowledgment for PauseMovementRequest message. ATTENTION: No confirmation that the movement was paused. Confirmation that the PauseMovementRequest was received and is processed. End of movement execution is signalled by [state stream](#/operations/streamMotionGroupState) response. See TrajectoryDetails of details in execute.
|
|
2283
2377
|
*/
|
|
2284
2378
|
interface PauseMovementResponse {
|
|
2285
2379
|
/**
|
|
2286
|
-
* Error message in case of invalid
|
|
2380
|
+
* Error message in case of invalid PauseMovementRequest.
|
|
2287
2381
|
*/
|
|
2288
2382
|
'message'?: string;
|
|
2289
2383
|
'kind': PauseMovementResponseKindEnum;
|
|
@@ -2329,7 +2423,7 @@ interface PlanCollisionFreeFailedResponse {
|
|
|
2329
2423
|
}
|
|
2330
2424
|
interface PlanCollisionFreeRequest {
|
|
2331
2425
|
/**
|
|
2332
|
-
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
2426
|
+
* The data to assemble the robot setup can be retrieved from the [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
|
|
2333
2427
|
*/
|
|
2334
2428
|
'motion_group_setup': MotionGroupSetup;
|
|
2335
2429
|
'start_joint_position': Array<number>;
|
|
@@ -2349,7 +2443,7 @@ type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFail
|
|
|
2349
2443
|
interface PlanTrajectoryFailedResponse {
|
|
2350
2444
|
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
2351
2445
|
/**
|
|
2352
|
-
*
|
|
2446
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
2353
2447
|
*/
|
|
2354
2448
|
'error_location_on_trajectory': number;
|
|
2355
2449
|
/**
|
|
@@ -2363,7 +2457,7 @@ interface PlanTrajectoryFailedResponse {
|
|
|
2363
2457
|
type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | FeedbackJointLimitExceeded | FeedbackOutOfWorkspace | FeedbackSingularity;
|
|
2364
2458
|
interface PlanTrajectoryRequest {
|
|
2365
2459
|
/**
|
|
2366
|
-
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
2460
|
+
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
|
|
2367
2461
|
*/
|
|
2368
2462
|
'motion_group_setup': MotionGroupSetup;
|
|
2369
2463
|
'start_joint_position': Array<number>;
|
|
@@ -2730,7 +2824,7 @@ declare const RectangularCapsuleShapeTypeEnum: {
|
|
|
2730
2824
|
};
|
|
2731
2825
|
type RectangularCapsuleShapeTypeEnum = typeof RectangularCapsuleShapeTypeEnum[keyof typeof RectangularCapsuleShapeTypeEnum];
|
|
2732
2826
|
/**
|
|
2733
|
-
* The channel that defines what a new Wandelbots NOVA version is. * `next` the
|
|
2827
|
+
* The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
|
|
2734
2828
|
*/
|
|
2735
2829
|
declare const ReleaseChannel: {
|
|
2736
2830
|
readonly Stable: "stable";
|
|
@@ -2787,7 +2881,7 @@ interface RobotControllerState {
|
|
|
2787
2881
|
'motion_groups': Array<MotionGroupState>;
|
|
2788
2882
|
}
|
|
2789
2883
|
/**
|
|
2790
|
-
* 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.
|
|
2884
|
+
* 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.
|
|
2791
2885
|
*/
|
|
2792
2886
|
declare const RobotSystemMode: {
|
|
2793
2887
|
readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
|
|
@@ -2911,9 +3005,14 @@ interface SetIO {
|
|
|
2911
3005
|
'location': number;
|
|
2912
3006
|
'io_origin': IOOrigin;
|
|
2913
3007
|
}
|
|
3008
|
+
/**
|
|
3009
|
+
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
|
|
3010
|
+
*/
|
|
2914
3011
|
declare const SettableRobotSystemMode: {
|
|
2915
3012
|
readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
|
|
3013
|
+
readonly ModeMonitor: "MODE_MONITOR";
|
|
2916
3014
|
readonly RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL";
|
|
3015
|
+
readonly ModeControl: "MODE_CONTROL";
|
|
2917
3016
|
};
|
|
2918
3017
|
type SettableRobotSystemMode = typeof SettableRobotSystemMode[keyof typeof SettableRobotSystemMode];
|
|
2919
3018
|
declare const SingularityTypeEnum: {
|
|
@@ -2937,7 +3036,7 @@ declare const SphereShapeTypeEnum: {
|
|
|
2937
3036
|
};
|
|
2938
3037
|
type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
|
|
2939
3038
|
/**
|
|
2940
|
-
* Moves the motion group along a trajectory, added via [planTrajectory](planTrajectory) or [planMotion](planMotion). Trajectories can be executed forwards or backwards(\"in reverse\"). Pause the execution with PauseMovementRequest. Resume execution with StartMovementRequest. Precondition: To start execution, the motion group must be located at the trajectory\'s start location specified in InitializeMovementRequest.
|
|
3039
|
+
* Moves the motion group along a trajectory, added via [planTrajectory](#/operations/planTrajectory) or [planMotion](#/operations/planMotion). Trajectories can be executed forwards or backwards(\"in reverse\"). Pause the execution with PauseMovementRequest. Resume execution with StartMovementRequest. Precondition: To start execution, the motion group must be located at the trajectory\'s start location specified in InitializeMovementRequest.
|
|
2941
3040
|
*/
|
|
2942
3041
|
interface StartMovementRequest {
|
|
2943
3042
|
/**
|
|
@@ -2946,7 +3045,7 @@ interface StartMovementRequest {
|
|
|
2946
3045
|
'message_type': StartMovementRequestMessageTypeEnum;
|
|
2947
3046
|
'direction'?: Direction;
|
|
2948
3047
|
/**
|
|
2949
|
-
*
|
|
3048
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
2950
3049
|
*/
|
|
2951
3050
|
'target_location'?: number;
|
|
2952
3051
|
/**
|
|
@@ -2967,7 +3066,7 @@ declare const StartMovementRequestMessageTypeEnum: {
|
|
|
2967
3066
|
};
|
|
2968
3067
|
type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
|
|
2969
3068
|
/**
|
|
2970
|
-
* Acknowledgment for StartMovementRequest message. ATTENTION: No confirmation that the movement was started. Confirmation that the StartMovementRequest was received and is processed. Fields `execute` and `standstill` of response of [streamMotionGroupState](streamMotionGroupState) signal start of movement execution.
|
|
3069
|
+
* Acknowledgment for StartMovementRequest message. ATTENTION: No confirmation that the movement was started. Confirmation that the StartMovementRequest was received and is processed. Fields `execute` and `standstill` of response of [streamMotionGroupState](#/operations/streamMotionGroupState) signal start of movement execution.
|
|
2971
3070
|
*/
|
|
2972
3071
|
interface StartMovementResponse {
|
|
2973
3072
|
/**
|
|
@@ -3016,10 +3115,15 @@ interface TcpOffset {
|
|
|
3016
3115
|
* Requested motion group requires TCP to be defined.
|
|
3017
3116
|
*/
|
|
3018
3117
|
interface TcpRequiredError {
|
|
3118
|
+
'kind': TcpRequiredErrorKindEnum;
|
|
3019
3119
|
'tcp_missing'?: any;
|
|
3020
3120
|
}
|
|
3121
|
+
declare const TcpRequiredErrorKindEnum: {
|
|
3122
|
+
readonly TcpRequiredError: "TcpRequiredError";
|
|
3123
|
+
};
|
|
3124
|
+
type TcpRequiredErrorKindEnum = typeof TcpRequiredErrorKindEnum[keyof typeof TcpRequiredErrorKindEnum];
|
|
3021
3125
|
/**
|
|
3022
|
-
* Sets target TCP velocities for jogging a motion group. The motion group needs to have an inverse kinematic solver to be jogged by TCP velocities. Check `supports_inverse_kinematics` field in response of [listController](listController) for the motion group.
|
|
3126
|
+
* Sets target TCP velocities for jogging a motion group. The motion group needs to have an inverse kinematic solver to be jogged by TCP velocities. Check `supports_inverse_kinematics` field in response of [listController](#/operations/listController) for the motion group.
|
|
3023
3127
|
*/
|
|
3024
3128
|
interface TcpVelocityRequest {
|
|
3025
3129
|
/**
|
|
@@ -3058,8 +3162,13 @@ declare const TcpVelocityResponseKindEnum: {
|
|
|
3058
3162
|
};
|
|
3059
3163
|
type TcpVelocityResponseKindEnum = typeof TcpVelocityResponseKindEnum[keyof typeof TcpVelocityResponseKindEnum];
|
|
3060
3164
|
interface TorqueExceededError {
|
|
3165
|
+
'kind': TorqueExceededErrorKindEnum;
|
|
3061
3166
|
'torque_exceeded'?: TorqueExceededErrorTorqueExceeded;
|
|
3062
3167
|
}
|
|
3168
|
+
declare const TorqueExceededErrorKindEnum: {
|
|
3169
|
+
readonly TorqueExceededError: "TorqueExceededError";
|
|
3170
|
+
};
|
|
3171
|
+
type TorqueExceededErrorKindEnum = typeof TorqueExceededErrorKindEnum[keyof typeof TorqueExceededErrorKindEnum];
|
|
3063
3172
|
interface TorqueExceededErrorTorqueExceeded {
|
|
3064
3173
|
/**
|
|
3065
3174
|
* The torque value that was exceeded.
|
|
@@ -3101,7 +3210,7 @@ interface TrajectoryDetails {
|
|
|
3101
3210
|
*/
|
|
3102
3211
|
'trajectory': string;
|
|
3103
3212
|
/**
|
|
3104
|
-
*
|
|
3213
|
+
* - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`, where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command, while non-integer values interpolate positions within the segments. - The location is calculated from the joint path
|
|
3105
3214
|
*/
|
|
3106
3215
|
'location': number;
|
|
3107
3216
|
'state': TrajectoryDetailsState;
|
|
@@ -3144,7 +3253,7 @@ interface TrajectoryId {
|
|
|
3144
3253
|
*/
|
|
3145
3254
|
'message_type': TrajectoryIdMessageTypeEnum;
|
|
3146
3255
|
/**
|
|
3147
|
-
* The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
|
|
3256
|
+
* The identifier of the trajectory which was returned by the [addTrajectory](#/operations/addTrajectory) endpoint.
|
|
3148
3257
|
*/
|
|
3149
3258
|
'id': string;
|
|
3150
3259
|
}
|
|
@@ -3223,11 +3332,21 @@ declare const UniversalrobotsControllerKindEnum: {
|
|
|
3223
3332
|
readonly UniversalrobotsController: "UniversalrobotsController";
|
|
3224
3333
|
};
|
|
3225
3334
|
type UniversalrobotsControllerKindEnum = typeof UniversalrobotsControllerKindEnum[keyof typeof UniversalrobotsControllerKindEnum];
|
|
3335
|
+
/**
|
|
3336
|
+
* Update a single cell\'s Foundation chart version based on the indicated release channel.
|
|
3337
|
+
*/
|
|
3338
|
+
interface UpdateCellVersionRequest {
|
|
3339
|
+
'channel': ReleaseChannel;
|
|
3340
|
+
}
|
|
3226
3341
|
/**
|
|
3227
3342
|
* An update is defined by the indicated Wandelbots NOVA release channel.
|
|
3228
3343
|
*/
|
|
3229
3344
|
interface UpdateNovaVersionRequest {
|
|
3230
3345
|
'channel': ReleaseChannel;
|
|
3346
|
+
/**
|
|
3347
|
+
* Update unpinned cells during system update. Cells with an explicit chart version are never updated by a system update, regardless of this setting.
|
|
3348
|
+
*/
|
|
3349
|
+
'update_cells'?: boolean;
|
|
3231
3350
|
}
|
|
3232
3351
|
interface ValidationError {
|
|
3233
3352
|
'loc': Array<ValidationErrorLocInner>;
|
|
@@ -3250,17 +3369,17 @@ interface ValidationError2 {
|
|
|
3250
3369
|
*/
|
|
3251
3370
|
type ValidationErrorLocInner = number | string;
|
|
3252
3371
|
/**
|
|
3253
|
-
* The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
|
|
3372
|
+
* The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array, and either a preset `type` **or** the complete JSON configuration.
|
|
3254
3373
|
*/
|
|
3255
3374
|
interface VirtualController {
|
|
3256
3375
|
'kind': VirtualControllerKindEnum;
|
|
3257
3376
|
'manufacturer': Manufacturer;
|
|
3258
3377
|
/**
|
|
3259
|
-
* Preset type of the virtual robot controller. See [getRobotConfigurations](getRobotConfigurations) for supported types.
|
|
3378
|
+
* Preset type of the virtual robot controller. See [getRobotConfigurations](#/operations/getRobotConfigurations) for supported types.
|
|
3260
3379
|
*/
|
|
3261
3380
|
'type'?: string;
|
|
3262
3381
|
/**
|
|
3263
|
-
* Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](getVirtualControllerConfiguration). If provided, the `type` field should not be used.
|
|
3382
|
+
* Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). If provided, the `type` field should not be used.
|
|
3264
3383
|
*/
|
|
3265
3384
|
'json'?: string;
|
|
3266
3385
|
/**
|
|
@@ -3278,7 +3397,7 @@ interface VirtualRobotConfiguration {
|
|
|
3278
3397
|
*/
|
|
3279
3398
|
'name': string;
|
|
3280
3399
|
/**
|
|
3281
|
-
* Content of the configuration file. Copy & paste to the [addRobotController](addRobotController) configuration.json parameter.
|
|
3400
|
+
* Content of the configuration file. Copy & paste to the [addRobotController](#/operations/addRobotController) configuration.json parameter.
|
|
3282
3401
|
*/
|
|
3283
3402
|
'content': string;
|
|
3284
3403
|
}
|
|
@@ -3337,7 +3456,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
3337
3456
|
*/
|
|
3338
3457
|
deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3339
3458
|
/**
|
|
3340
|
-
* 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).
|
|
3459
|
+
* 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).
|
|
3341
3460
|
* @summary Configuration
|
|
3342
3461
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3343
3462
|
* @param {string} app
|
|
@@ -3346,7 +3465,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
3346
3465
|
*/
|
|
3347
3466
|
getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3348
3467
|
/**
|
|
3349
|
-
* 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.
|
|
3468
|
+
* 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.
|
|
3350
3469
|
* @summary List Applications
|
|
3351
3470
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3352
3471
|
* @param {*} [options] Override http request option.
|
|
@@ -3399,7 +3518,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
|
3399
3518
|
*/
|
|
3400
3519
|
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3401
3520
|
/**
|
|
3402
|
-
* 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).
|
|
3521
|
+
* 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).
|
|
3403
3522
|
* @summary Configuration
|
|
3404
3523
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3405
3524
|
* @param {string} app
|
|
@@ -3408,7 +3527,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
|
3408
3527
|
*/
|
|
3409
3528
|
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
|
|
3410
3529
|
/**
|
|
3411
|
-
* 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.
|
|
3530
|
+
* 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.
|
|
3412
3531
|
* @summary List Applications
|
|
3413
3532
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3414
3533
|
* @param {*} [options] Override http request option.
|
|
@@ -3461,7 +3580,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
|
|
|
3461
3580
|
*/
|
|
3462
3581
|
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3463
3582
|
/**
|
|
3464
|
-
* 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).
|
|
3583
|
+
* 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).
|
|
3465
3584
|
* @summary Configuration
|
|
3466
3585
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3467
3586
|
* @param {string} app
|
|
@@ -3470,7 +3589,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
|
|
|
3470
3589
|
*/
|
|
3471
3590
|
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
|
|
3472
3591
|
/**
|
|
3473
|
-
* 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.
|
|
3592
|
+
* 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.
|
|
3474
3593
|
* @summary List Applications
|
|
3475
3594
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3476
3595
|
* @param {*} [options] Override http request option.
|
|
@@ -3502,7 +3621,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3502
3621
|
* @param {*} [options] Override http request option.
|
|
3503
3622
|
* @throws {RequiredError}
|
|
3504
3623
|
*/
|
|
3505
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3624
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3506
3625
|
/**
|
|
3507
3626
|
* Delete all GUI applications from the cell.
|
|
3508
3627
|
* @summary Clear Applications
|
|
@@ -3511,7 +3630,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3511
3630
|
* @param {*} [options] Override http request option.
|
|
3512
3631
|
* @throws {RequiredError}
|
|
3513
3632
|
*/
|
|
3514
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3633
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3515
3634
|
/**
|
|
3516
3635
|
* Delete a GUI application from the cell.
|
|
3517
3636
|
* @summary Delete Application
|
|
@@ -3521,24 +3640,24 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3521
3640
|
* @param {*} [options] Override http request option.
|
|
3522
3641
|
* @throws {RequiredError}
|
|
3523
3642
|
*/
|
|
3524
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3643
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3525
3644
|
/**
|
|
3526
|
-
* 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).
|
|
3645
|
+
* 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).
|
|
3527
3646
|
* @summary Configuration
|
|
3528
3647
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3529
3648
|
* @param {string} app
|
|
3530
3649
|
* @param {*} [options] Override http request option.
|
|
3531
3650
|
* @throws {RequiredError}
|
|
3532
3651
|
*/
|
|
3533
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
3652
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
3534
3653
|
/**
|
|
3535
|
-
* 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.
|
|
3654
|
+
* 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.
|
|
3536
3655
|
* @summary List Applications
|
|
3537
3656
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3538
3657
|
* @param {*} [options] Override http request option.
|
|
3539
3658
|
* @throws {RequiredError}
|
|
3540
3659
|
*/
|
|
3541
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
3660
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
3542
3661
|
/**
|
|
3543
3662
|
* Update the configuration of a GUI application in the cell.
|
|
3544
3663
|
* @summary Update Configuration
|
|
@@ -3549,7 +3668,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3549
3668
|
* @param {*} [options] Override http request option.
|
|
3550
3669
|
* @throws {RequiredError}
|
|
3551
3670
|
*/
|
|
3552
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
3671
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3553
3672
|
}
|
|
3554
3673
|
/**
|
|
3555
3674
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -3566,7 +3685,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3566
3685
|
*/
|
|
3567
3686
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3568
3687
|
/**
|
|
3569
|
-
* 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).
|
|
3688
|
+
* 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).
|
|
3570
3689
|
* @summary Add MODBUS Input/Output
|
|
3571
3690
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3572
3691
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3576,7 +3695,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3576
3695
|
*/
|
|
3577
3696
|
addModbusIO: (cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3578
3697
|
/**
|
|
3579
|
-
* 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).
|
|
3698
|
+
* 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).
|
|
3580
3699
|
* @summary Add PROFINET Input/Output
|
|
3581
3700
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3582
3701
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3612,7 +3731,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3612
3731
|
deleteAllProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3613
3732
|
/**
|
|
3614
3733
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3615
|
-
* @summary Remove MODBUS Input/
|
|
3734
|
+
* @summary Remove MODBUS Input/Output
|
|
3616
3735
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3617
3736
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
3618
3737
|
* @param {*} [options] Override http request option.
|
|
@@ -3645,7 +3764,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3645
3764
|
*/
|
|
3646
3765
|
getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3647
3766
|
/**
|
|
3648
|
-
* 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).
|
|
3767
|
+
* 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).
|
|
3649
3768
|
* @summary Get Input/Output Values
|
|
3650
3769
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3651
3770
|
* @param {Array<string>} [ios]
|
|
@@ -3680,7 +3799,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3680
3799
|
*/
|
|
3681
3800
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3682
3801
|
/**
|
|
3683
|
-
* 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).
|
|
3802
|
+
* 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).
|
|
3684
3803
|
* @summary List MODBUS Input/Output Configuration
|
|
3685
3804
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3686
3805
|
* @param {*} [options] Override http request option.
|
|
@@ -3688,7 +3807,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3688
3807
|
*/
|
|
3689
3808
|
listModbusIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3690
3809
|
/**
|
|
3691
|
-
* 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.
|
|
3810
|
+
* 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.
|
|
3692
3811
|
* @summary List PROFINET Input/Output Configuration
|
|
3693
3812
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3694
3813
|
* @param {*} [options] Override http request option.
|
|
@@ -3696,7 +3815,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3696
3815
|
*/
|
|
3697
3816
|
listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3698
3817
|
/**
|
|
3699
|
-
* 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.
|
|
3818
|
+
* 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.
|
|
3700
3819
|
* @summary Set Output Values
|
|
3701
3820
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3702
3821
|
* @param {Array<IOValue>} iOValue
|
|
@@ -3705,7 +3824,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3705
3824
|
*/
|
|
3706
3825
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3707
3826
|
/**
|
|
3708
|
-
* 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.
|
|
3827
|
+
* 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.
|
|
3709
3828
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
3710
3829
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3711
3830
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -3729,7 +3848,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3729
3848
|
*/
|
|
3730
3849
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3731
3850
|
/**
|
|
3732
|
-
* 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).
|
|
3851
|
+
* 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).
|
|
3733
3852
|
* @summary Add MODBUS Input/Output
|
|
3734
3853
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3735
3854
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3739,7 +3858,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3739
3858
|
*/
|
|
3740
3859
|
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3741
3860
|
/**
|
|
3742
|
-
* 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).
|
|
3861
|
+
* 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).
|
|
3743
3862
|
* @summary Add PROFINET Input/Output
|
|
3744
3863
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3745
3864
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3775,7 +3894,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3775
3894
|
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3776
3895
|
/**
|
|
3777
3896
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3778
|
-
* @summary Remove MODBUS Input/
|
|
3897
|
+
* @summary Remove MODBUS Input/Output
|
|
3779
3898
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3780
3899
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
3781
3900
|
* @param {*} [options] Override http request option.
|
|
@@ -3808,7 +3927,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3808
3927
|
*/
|
|
3809
3928
|
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
|
|
3810
3929
|
/**
|
|
3811
|
-
* 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).
|
|
3930
|
+
* 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).
|
|
3812
3931
|
* @summary Get Input/Output Values
|
|
3813
3932
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3814
3933
|
* @param {Array<string>} [ios]
|
|
@@ -3843,7 +3962,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3843
3962
|
*/
|
|
3844
3963
|
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusIODescription>>>;
|
|
3845
3964
|
/**
|
|
3846
|
-
* 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).
|
|
3965
|
+
* 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).
|
|
3847
3966
|
* @summary List MODBUS Input/Output Configuration
|
|
3848
3967
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3849
3968
|
* @param {*} [options] Override http request option.
|
|
@@ -3851,7 +3970,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3851
3970
|
*/
|
|
3852
3971
|
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ModbusIO>>>;
|
|
3853
3972
|
/**
|
|
3854
|
-
* 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.
|
|
3973
|
+
* 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.
|
|
3855
3974
|
* @summary List PROFINET Input/Output Configuration
|
|
3856
3975
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3857
3976
|
* @param {*} [options] Override http request option.
|
|
@@ -3859,7 +3978,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3859
3978
|
*/
|
|
3860
3979
|
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
|
|
3861
3980
|
/**
|
|
3862
|
-
* 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.
|
|
3981
|
+
* 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.
|
|
3863
3982
|
* @summary Set Output Values
|
|
3864
3983
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3865
3984
|
* @param {Array<IOValue>} iOValue
|
|
@@ -3868,7 +3987,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3868
3987
|
*/
|
|
3869
3988
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3870
3989
|
/**
|
|
3871
|
-
* 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.
|
|
3990
|
+
* 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.
|
|
3872
3991
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
3873
3992
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3874
3993
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -3892,7 +4011,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3892
4011
|
*/
|
|
3893
4012
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3894
4013
|
/**
|
|
3895
|
-
* 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).
|
|
4014
|
+
* 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).
|
|
3896
4015
|
* @summary Add MODBUS Input/Output
|
|
3897
4016
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3898
4017
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3902,7 +4021,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3902
4021
|
*/
|
|
3903
4022
|
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3904
4023
|
/**
|
|
3905
|
-
* 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).
|
|
4024
|
+
* 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).
|
|
3906
4025
|
* @summary Add PROFINET Input/Output
|
|
3907
4026
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3908
4027
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3938,7 +4057,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3938
4057
|
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3939
4058
|
/**
|
|
3940
4059
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3941
|
-
* @summary Remove MODBUS Input/
|
|
4060
|
+
* @summary Remove MODBUS Input/Output
|
|
3942
4061
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3943
4062
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
3944
4063
|
* @param {*} [options] Override http request option.
|
|
@@ -3971,7 +4090,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3971
4090
|
*/
|
|
3972
4091
|
getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
|
|
3973
4092
|
/**
|
|
3974
|
-
* 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).
|
|
4093
|
+
* 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).
|
|
3975
4094
|
* @summary Get Input/Output Values
|
|
3976
4095
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3977
4096
|
* @param {Array<string>} [ios]
|
|
@@ -4006,7 +4125,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
4006
4125
|
*/
|
|
4007
4126
|
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BusIODescription>>;
|
|
4008
4127
|
/**
|
|
4009
|
-
* 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).
|
|
4128
|
+
* 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).
|
|
4010
4129
|
* @summary List MODBUS Input/Output Configuration
|
|
4011
4130
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4012
4131
|
* @param {*} [options] Override http request option.
|
|
@@ -4014,7 +4133,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
4014
4133
|
*/
|
|
4015
4134
|
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ModbusIO>>;
|
|
4016
4135
|
/**
|
|
4017
|
-
* 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.
|
|
4136
|
+
* 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.
|
|
4018
4137
|
* @summary List PROFINET Input/Output Configuration
|
|
4019
4138
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4020
4139
|
* @param {*} [options] Override http request option.
|
|
@@ -4022,7 +4141,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
4022
4141
|
*/
|
|
4023
4142
|
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
|
|
4024
4143
|
/**
|
|
4025
|
-
* 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.
|
|
4144
|
+
* 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.
|
|
4026
4145
|
* @summary Set Output Values
|
|
4027
4146
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4028
4147
|
* @param {Array<IOValue>} iOValue
|
|
@@ -4031,7 +4150,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
4031
4150
|
*/
|
|
4032
4151
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4033
4152
|
/**
|
|
4034
|
-
* 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.
|
|
4153
|
+
* 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.
|
|
4035
4154
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
4036
4155
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4037
4156
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -4053,9 +4172,9 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4053
4172
|
* @param {*} [options] Override http request option.
|
|
4054
4173
|
* @throws {RequiredError}
|
|
4055
4174
|
*/
|
|
4056
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4175
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4057
4176
|
/**
|
|
4058
|
-
* 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).
|
|
4177
|
+
* 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).
|
|
4059
4178
|
* @summary Add MODBUS Input/Output
|
|
4060
4179
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4061
4180
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -4063,9 +4182,9 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4063
4182
|
* @param {*} [options] Override http request option.
|
|
4064
4183
|
* @throws {RequiredError}
|
|
4065
4184
|
*/
|
|
4066
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4185
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4067
4186
|
/**
|
|
4068
|
-
* 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).
|
|
4187
|
+
* 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).
|
|
4069
4188
|
* @summary Add PROFINET Input/Output
|
|
4070
4189
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4071
4190
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -4073,7 +4192,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4073
4192
|
* @param {*} [options] Override http request option.
|
|
4074
4193
|
* @throws {RequiredError}
|
|
4075
4194
|
*/
|
|
4076
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
4195
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4077
4196
|
/**
|
|
4078
4197
|
* Remove the BUS inputs/outputs service from the cell.
|
|
4079
4198
|
* @summary Clear Service
|
|
@@ -4082,7 +4201,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4082
4201
|
* @param {*} [options] Override http request option.
|
|
4083
4202
|
* @throws {RequiredError}
|
|
4084
4203
|
*/
|
|
4085
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4204
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4086
4205
|
/**
|
|
4087
4206
|
* Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4088
4207
|
* @summary Remove all MODBUS Input/Outputs
|
|
@@ -4090,7 +4209,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4090
4209
|
* @param {*} [options] Override http request option.
|
|
4091
4210
|
* @throws {RequiredError}
|
|
4092
4211
|
*/
|
|
4093
|
-
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4212
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4094
4213
|
/**
|
|
4095
4214
|
* Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4096
4215
|
* @summary Remove all PROFINET Input/Outputs
|
|
@@ -4098,16 +4217,16 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4098
4217
|
* @param {*} [options] Override http request option.
|
|
4099
4218
|
* @throws {RequiredError}
|
|
4100
4219
|
*/
|
|
4101
|
-
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4220
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4102
4221
|
/**
|
|
4103
4222
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4104
|
-
* @summary Remove MODBUS Input/
|
|
4223
|
+
* @summary Remove MODBUS Input/Output
|
|
4105
4224
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4106
4225
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
4107
4226
|
* @param {*} [options] Override http request option.
|
|
4108
4227
|
* @throws {RequiredError}
|
|
4109
4228
|
*/
|
|
4110
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4229
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4111
4230
|
/**
|
|
4112
4231
|
* Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
4113
4232
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -4116,7 +4235,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4116
4235
|
* @param {*} [options] Override http request option.
|
|
4117
4236
|
* @throws {RequiredError}
|
|
4118
4237
|
*/
|
|
4119
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
4238
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4120
4239
|
/**
|
|
4121
4240
|
* Get deployed BUS inputs/outputs service.
|
|
4122
4241
|
* @summary Get Service
|
|
@@ -4124,7 +4243,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4124
4243
|
* @param {*} [options] Override http request option.
|
|
4125
4244
|
* @throws {RequiredError}
|
|
4126
4245
|
*/
|
|
4127
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4246
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOType, any>>;
|
|
4128
4247
|
/**
|
|
4129
4248
|
* Get the current state of the BUS Inputs/Outputs service.
|
|
4130
4249
|
* @summary State
|
|
@@ -4132,16 +4251,16 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4132
4251
|
* @param {*} [options] Override http request option.
|
|
4133
4252
|
* @throws {RequiredError}
|
|
4134
4253
|
*/
|
|
4135
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4254
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
|
|
4136
4255
|
/**
|
|
4137
|
-
* 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).
|
|
4256
|
+
* 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).
|
|
4138
4257
|
* @summary Get Input/Output Values
|
|
4139
4258
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4140
4259
|
* @param {Array<string>} [ios]
|
|
4141
4260
|
* @param {*} [options] Override http request option.
|
|
4142
4261
|
* @throws {RequiredError}
|
|
4143
4262
|
*/
|
|
4144
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
4263
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
4145
4264
|
/**
|
|
4146
4265
|
* Get description of NOVA as a PROFINET device.
|
|
4147
4266
|
* @summary Get PROFINET Description
|
|
@@ -4149,7 +4268,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4149
4268
|
* @param {*} [options] Override http request option.
|
|
4150
4269
|
* @throws {RequiredError}
|
|
4151
4270
|
*/
|
|
4152
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4271
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetDescription, any>>;
|
|
4153
4272
|
/**
|
|
4154
4273
|
* Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
|
|
4155
4274
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -4159,7 +4278,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4159
4278
|
* @param {*} [options] Override http request option.
|
|
4160
4279
|
* @throws {RequiredError}
|
|
4161
4280
|
*/
|
|
4162
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4281
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4163
4282
|
/**
|
|
4164
4283
|
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
|
|
4165
4284
|
* @summary List Descriptions
|
|
@@ -4167,46 +4286,55 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4167
4286
|
* @param {*} [options] Override http request option.
|
|
4168
4287
|
* @throws {RequiredError}
|
|
4169
4288
|
*/
|
|
4170
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4289
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
|
|
4171
4290
|
/**
|
|
4172
|
-
* 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).
|
|
4291
|
+
* 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).
|
|
4173
4292
|
* @summary List MODBUS Input/Output Configuration
|
|
4174
4293
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4175
4294
|
* @param {*} [options] Override http request option.
|
|
4176
4295
|
* @throws {RequiredError}
|
|
4177
4296
|
*/
|
|
4178
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4297
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
|
|
4179
4298
|
/**
|
|
4180
|
-
* 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.
|
|
4299
|
+
* 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.
|
|
4181
4300
|
* @summary List PROFINET Input/Output Configuration
|
|
4182
4301
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4183
4302
|
* @param {*} [options] Override http request option.
|
|
4184
4303
|
* @throws {RequiredError}
|
|
4185
4304
|
*/
|
|
4186
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4305
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
|
|
4187
4306
|
/**
|
|
4188
|
-
* 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.
|
|
4307
|
+
* 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.
|
|
4189
4308
|
* @summary Set Output Values
|
|
4190
4309
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4191
4310
|
* @param {Array<IOValue>} iOValue
|
|
4192
4311
|
* @param {*} [options] Override http request option.
|
|
4193
4312
|
* @throws {RequiredError}
|
|
4194
4313
|
*/
|
|
4195
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
4314
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4196
4315
|
/**
|
|
4197
|
-
* 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.
|
|
4316
|
+
* 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.
|
|
4198
4317
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
4199
4318
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4200
4319
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
4201
4320
|
* @param {*} [options] Override http request option.
|
|
4202
4321
|
* @throws {RequiredError}
|
|
4203
4322
|
*/
|
|
4204
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
4323
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4205
4324
|
}
|
|
4206
4325
|
/**
|
|
4207
4326
|
* CellApi - axios parameter creator
|
|
4208
4327
|
*/
|
|
4209
4328
|
declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4329
|
+
/**
|
|
4330
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
4331
|
+
* @summary Check Cell Update
|
|
4332
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4333
|
+
* @param {ReleaseChannel} channel
|
|
4334
|
+
* @param {*} [options] Override http request option.
|
|
4335
|
+
* @throws {RequiredError}
|
|
4336
|
+
*/
|
|
4337
|
+
checkCellVersionUpdate: (cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4210
4338
|
/**
|
|
4211
4339
|
* Delete an entire cell.
|
|
4212
4340
|
* @summary Delete Cell
|
|
@@ -4267,11 +4395,29 @@ declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
4267
4395
|
* @throws {RequiredError}
|
|
4268
4396
|
*/
|
|
4269
4397
|
updateCell: (cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4398
|
+
/**
|
|
4399
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
4400
|
+
* @summary Update Cell Version
|
|
4401
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4402
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
4403
|
+
* @param {*} [options] Override http request option.
|
|
4404
|
+
* @throws {RequiredError}
|
|
4405
|
+
*/
|
|
4406
|
+
updateCellVersion: (cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4270
4407
|
};
|
|
4271
4408
|
/**
|
|
4272
4409
|
* CellApi - functional programming interface
|
|
4273
4410
|
*/
|
|
4274
4411
|
declare const CellApiFp: (configuration?: Configuration) => {
|
|
4412
|
+
/**
|
|
4413
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
4414
|
+
* @summary Check Cell Update
|
|
4415
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4416
|
+
* @param {ReleaseChannel} channel
|
|
4417
|
+
* @param {*} [options] Override http request option.
|
|
4418
|
+
* @throws {RequiredError}
|
|
4419
|
+
*/
|
|
4420
|
+
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
4275
4421
|
/**
|
|
4276
4422
|
* Delete an entire cell.
|
|
4277
4423
|
* @summary Delete Cell
|
|
@@ -4332,11 +4478,29 @@ declare const CellApiFp: (configuration?: Configuration) => {
|
|
|
4332
4478
|
* @throws {RequiredError}
|
|
4333
4479
|
*/
|
|
4334
4480
|
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4481
|
+
/**
|
|
4482
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
4483
|
+
* @summary Update Cell Version
|
|
4484
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4485
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
4486
|
+
* @param {*} [options] Override http request option.
|
|
4487
|
+
* @throws {RequiredError}
|
|
4488
|
+
*/
|
|
4489
|
+
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4335
4490
|
};
|
|
4336
4491
|
/**
|
|
4337
4492
|
* CellApi - factory interface
|
|
4338
4493
|
*/
|
|
4339
4494
|
declare const CellApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4495
|
+
/**
|
|
4496
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
4497
|
+
* @summary Check Cell Update
|
|
4498
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4499
|
+
* @param {ReleaseChannel} channel
|
|
4500
|
+
* @param {*} [options] Override http request option.
|
|
4501
|
+
* @throws {RequiredError}
|
|
4502
|
+
*/
|
|
4503
|
+
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
4340
4504
|
/**
|
|
4341
4505
|
* Delete an entire cell.
|
|
4342
4506
|
* @summary Delete Cell
|
|
@@ -4397,11 +4561,29 @@ declare const CellApiFactory: (configuration?: Configuration, basePath?: string,
|
|
|
4397
4561
|
* @throws {RequiredError}
|
|
4398
4562
|
*/
|
|
4399
4563
|
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4564
|
+
/**
|
|
4565
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
4566
|
+
* @summary Update Cell Version
|
|
4567
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4568
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
4569
|
+
* @param {*} [options] Override http request option.
|
|
4570
|
+
* @throws {RequiredError}
|
|
4571
|
+
*/
|
|
4572
|
+
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4400
4573
|
};
|
|
4401
4574
|
/**
|
|
4402
4575
|
* CellApi - object-oriented interface
|
|
4403
4576
|
*/
|
|
4404
4577
|
declare class CellApi extends BaseAPI {
|
|
4578
|
+
/**
|
|
4579
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
4580
|
+
* @summary Check Cell Update
|
|
4581
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4582
|
+
* @param {ReleaseChannel} channel
|
|
4583
|
+
* @param {*} [options] Override http request option.
|
|
4584
|
+
* @throws {RequiredError}
|
|
4585
|
+
*/
|
|
4586
|
+
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4405
4587
|
/**
|
|
4406
4588
|
* Delete an entire cell.
|
|
4407
4589
|
* @summary Delete Cell
|
|
@@ -4410,7 +4592,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4410
4592
|
* @param {*} [options] Override http request option.
|
|
4411
4593
|
* @throws {RequiredError}
|
|
4412
4594
|
*/
|
|
4413
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4595
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4414
4596
|
/**
|
|
4415
4597
|
* Deploy an entire cell with all its resources. A cell can be used to deploy a robot controller, one or more robots, as well as custom applications. Refer to the [Wandelbots NOVA documentation](https://docs.wandelbots.io/latest/setup-cell) for more information.
|
|
4416
4598
|
* @summary Add Cell
|
|
@@ -4419,7 +4601,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4419
4601
|
* @param {*} [options] Override http request option.
|
|
4420
4602
|
* @throws {RequiredError}
|
|
4421
4603
|
*/
|
|
4422
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4604
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4423
4605
|
/**
|
|
4424
4606
|
* List all cell resources.
|
|
4425
4607
|
* @summary Configuration
|
|
@@ -4427,7 +4609,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4427
4609
|
* @param {*} [options] Override http request option.
|
|
4428
4610
|
* @throws {RequiredError}
|
|
4429
4611
|
*/
|
|
4430
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4612
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Cell, any>>;
|
|
4431
4613
|
/**
|
|
4432
4614
|
* List the status of all cell resources.
|
|
4433
4615
|
* @summary Service Status
|
|
@@ -4435,14 +4617,14 @@ declare class CellApi extends BaseAPI {
|
|
|
4435
4617
|
* @param {*} [options] Override http request option.
|
|
4436
4618
|
* @throws {RequiredError}
|
|
4437
4619
|
*/
|
|
4438
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4620
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatusResponse, any>>;
|
|
4439
4621
|
/**
|
|
4440
4622
|
* List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
4441
4623
|
* @summary List Cells
|
|
4442
4624
|
* @param {*} [options] Override http request option.
|
|
4443
4625
|
* @throws {RequiredError}
|
|
4444
4626
|
*/
|
|
4445
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
4627
|
+
listCells(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4446
4628
|
/**
|
|
4447
4629
|
* Deactivate or activate the services of a cell.
|
|
4448
4630
|
* @summary Operating State
|
|
@@ -4451,7 +4633,7 @@ declare class CellApi extends BaseAPI {
|
|
|
4451
4633
|
* @param {*} [options] Override http request option.
|
|
4452
4634
|
* @throws {RequiredError}
|
|
4453
4635
|
*/
|
|
4454
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
4636
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4455
4637
|
/**
|
|
4456
4638
|
* Update the definition of the entire Cell.
|
|
4457
4639
|
* @summary Update Configuration
|
|
@@ -4461,7 +4643,16 @@ declare class CellApi extends BaseAPI {
|
|
|
4461
4643
|
* @param {*} [options] Override http request option.
|
|
4462
4644
|
* @throws {RequiredError}
|
|
4463
4645
|
*/
|
|
4464
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4646
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4647
|
+
/**
|
|
4648
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
4649
|
+
* @summary Update Cell Version
|
|
4650
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4651
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
4652
|
+
* @param {*} [options] Override http request option.
|
|
4653
|
+
* @throws {RequiredError}
|
|
4654
|
+
*/
|
|
4655
|
+
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4465
4656
|
}
|
|
4466
4657
|
/**
|
|
4467
4658
|
* ControllerApi - axios parameter creator
|
|
@@ -4478,7 +4669,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4478
4669
|
*/
|
|
4479
4670
|
addRobotController: (cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4480
4671
|
/**
|
|
4481
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
4672
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
4482
4673
|
* @summary Clear Robot Controllers
|
|
4483
4674
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4484
4675
|
* @param {number} [completionTimeout]
|
|
@@ -4497,7 +4688,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4497
4688
|
*/
|
|
4498
4689
|
deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4499
4690
|
/**
|
|
4500
|
-
* 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.
|
|
4691
|
+
* 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.
|
|
4501
4692
|
* @summary Description
|
|
4502
4693
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4503
4694
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4535,7 +4726,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4535
4726
|
*/
|
|
4536
4727
|
getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4537
4728
|
/**
|
|
4538
|
-
* 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.
|
|
4729
|
+
* 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.
|
|
4539
4730
|
* @summary Virtual Controller Configuration
|
|
4540
4731
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4541
4732
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4562,7 +4753,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4562
4753
|
*/
|
|
4563
4754
|
listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4564
4755
|
/**
|
|
4565
|
-
* 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.
|
|
4756
|
+
* 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.
|
|
4566
4757
|
* @summary Set Default Mode
|
|
4567
4758
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4568
4759
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4572,7 +4763,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4572
4763
|
*/
|
|
4573
4764
|
setDefaultMode: (cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4574
4765
|
/**
|
|
4575
|
-
* <!-- 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.
|
|
4766
|
+
* <!-- 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.
|
|
4576
4767
|
* @summary Stream Free Drive
|
|
4577
4768
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4578
4769
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4582,7 +4773,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4582
4773
|
*/
|
|
4583
4774
|
streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4584
4775
|
/**
|
|
4585
|
-
* <!-- 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.
|
|
4776
|
+
* <!-- 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.
|
|
4586
4777
|
* @summary Stream State
|
|
4587
4778
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4588
4779
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4593,7 +4784,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4593
4784
|
*/
|
|
4594
4785
|
streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4595
4786
|
/**
|
|
4596
|
-
* 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).
|
|
4787
|
+
* 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).
|
|
4597
4788
|
* @summary Update Robot Controller
|
|
4598
4789
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4599
4790
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4619,7 +4810,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4619
4810
|
*/
|
|
4620
4811
|
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4621
4812
|
/**
|
|
4622
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
4813
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
4623
4814
|
* @summary Clear Robot Controllers
|
|
4624
4815
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4625
4816
|
* @param {number} [completionTimeout]
|
|
@@ -4638,7 +4829,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4638
4829
|
*/
|
|
4639
4830
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4640
4831
|
/**
|
|
4641
|
-
* 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.
|
|
4832
|
+
* 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.
|
|
4642
4833
|
* @summary Description
|
|
4643
4834
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4644
4835
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4676,7 +4867,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4676
4867
|
*/
|
|
4677
4868
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
|
|
4678
4869
|
/**
|
|
4679
|
-
* 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.
|
|
4870
|
+
* 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.
|
|
4680
4871
|
* @summary Virtual Controller Configuration
|
|
4681
4872
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4682
4873
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4703,7 +4894,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4703
4894
|
*/
|
|
4704
4895
|
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
4705
4896
|
/**
|
|
4706
|
-
* 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.
|
|
4897
|
+
* 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.
|
|
4707
4898
|
* @summary Set Default Mode
|
|
4708
4899
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4709
4900
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4713,7 +4904,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4713
4904
|
*/
|
|
4714
4905
|
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4715
4906
|
/**
|
|
4716
|
-
* <!-- 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.
|
|
4907
|
+
* <!-- 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.
|
|
4717
4908
|
* @summary Stream Free Drive
|
|
4718
4909
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4719
4910
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4723,7 +4914,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4723
4914
|
*/
|
|
4724
4915
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
4725
4916
|
/**
|
|
4726
|
-
* <!-- 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.
|
|
4917
|
+
* <!-- 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.
|
|
4727
4918
|
* @summary Stream State
|
|
4728
4919
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4729
4920
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4734,7 +4925,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4734
4925
|
*/
|
|
4735
4926
|
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
4736
4927
|
/**
|
|
4737
|
-
* 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).
|
|
4928
|
+
* 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).
|
|
4738
4929
|
* @summary Update Robot Controller
|
|
4739
4930
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4740
4931
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4760,7 +4951,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4760
4951
|
*/
|
|
4761
4952
|
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4762
4953
|
/**
|
|
4763
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
4954
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
4764
4955
|
* @summary Clear Robot Controllers
|
|
4765
4956
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4766
4957
|
* @param {number} [completionTimeout]
|
|
@@ -4779,7 +4970,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4779
4970
|
*/
|
|
4780
4971
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4781
4972
|
/**
|
|
4782
|
-
* 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.
|
|
4973
|
+
* 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.
|
|
4783
4974
|
* @summary Description
|
|
4784
4975
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4785
4976
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4817,7 +5008,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4817
5008
|
*/
|
|
4818
5009
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
|
|
4819
5010
|
/**
|
|
4820
|
-
* 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.
|
|
5011
|
+
* 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.
|
|
4821
5012
|
* @summary Virtual Controller Configuration
|
|
4822
5013
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4823
5014
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4844,7 +5035,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4844
5035
|
*/
|
|
4845
5036
|
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
4846
5037
|
/**
|
|
4847
|
-
* 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.
|
|
5038
|
+
* 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.
|
|
4848
5039
|
* @summary Set Default Mode
|
|
4849
5040
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4850
5041
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4854,7 +5045,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4854
5045
|
*/
|
|
4855
5046
|
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4856
5047
|
/**
|
|
4857
|
-
* <!-- 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.
|
|
5048
|
+
* <!-- 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.
|
|
4858
5049
|
* @summary Stream Free Drive
|
|
4859
5050
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4860
5051
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4864,7 +5055,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4864
5055
|
*/
|
|
4865
5056
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
4866
5057
|
/**
|
|
4867
|
-
* <!-- 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.
|
|
5058
|
+
* <!-- 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.
|
|
4868
5059
|
* @summary Stream State
|
|
4869
5060
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4870
5061
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4875,7 +5066,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4875
5066
|
*/
|
|
4876
5067
|
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
4877
5068
|
/**
|
|
4878
|
-
* 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).
|
|
5069
|
+
* 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).
|
|
4879
5070
|
* @summary Update Robot Controller
|
|
4880
5071
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4881
5072
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4899,16 +5090,16 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4899
5090
|
* @param {*} [options] Override http request option.
|
|
4900
5091
|
* @throws {RequiredError}
|
|
4901
5092
|
*/
|
|
4902
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5093
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4903
5094
|
/**
|
|
4904
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
5095
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
4905
5096
|
* @summary Clear Robot Controllers
|
|
4906
5097
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4907
5098
|
* @param {number} [completionTimeout]
|
|
4908
5099
|
* @param {*} [options] Override http request option.
|
|
4909
5100
|
* @throws {RequiredError}
|
|
4910
5101
|
*/
|
|
4911
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5102
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4912
5103
|
/**
|
|
4913
5104
|
* Delete a robot controller from the cell.
|
|
4914
5105
|
* @summary Delete Robot Controller
|
|
@@ -4918,16 +5109,16 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4918
5109
|
* @param {*} [options] Override http request option.
|
|
4919
5110
|
* @throws {RequiredError}
|
|
4920
5111
|
*/
|
|
4921
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5112
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4922
5113
|
/**
|
|
4923
|
-
* 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.
|
|
5114
|
+
* 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.
|
|
4924
5115
|
* @summary Description
|
|
4925
5116
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4926
5117
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4927
5118
|
* @param {*} [options] Override http request option.
|
|
4928
5119
|
* @throws {RequiredError}
|
|
4929
5120
|
*/
|
|
4930
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5121
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ControllerDescription, any>>;
|
|
4931
5122
|
/**
|
|
4932
5123
|
* Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
|
|
4933
5124
|
* @summary Coordinate System
|
|
@@ -4938,7 +5129,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4938
5129
|
* @param {*} [options] Override http request option.
|
|
4939
5130
|
* @throws {RequiredError}
|
|
4940
5131
|
*/
|
|
4941
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
5132
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
4942
5133
|
/**
|
|
4943
5134
|
* Get the current state of a robot controller.
|
|
4944
5135
|
* @summary State
|
|
@@ -4947,7 +5138,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4947
5138
|
* @param {*} [options] Override http request option.
|
|
4948
5139
|
* @throws {RequiredError}
|
|
4949
5140
|
*/
|
|
4950
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5141
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
4951
5142
|
/**
|
|
4952
5143
|
* Get the configuration for a robot controller.
|
|
4953
5144
|
* @summary Robot Controller
|
|
@@ -4956,16 +5147,16 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4956
5147
|
* @param {*} [options] Override http request option.
|
|
4957
5148
|
* @throws {RequiredError}
|
|
4958
5149
|
*/
|
|
4959
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5150
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
4960
5151
|
/**
|
|
4961
|
-
* 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.
|
|
5152
|
+
* 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.
|
|
4962
5153
|
* @summary Virtual Controller Configuration
|
|
4963
5154
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4964
5155
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
4965
5156
|
* @param {*} [options] Override http request option.
|
|
4966
5157
|
* @throws {RequiredError}
|
|
4967
5158
|
*/
|
|
4968
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
5159
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<VirtualRobotConfiguration, any>>;
|
|
4969
5160
|
/**
|
|
4970
5161
|
* Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
|
|
4971
5162
|
* @summary List Coordinate Systems
|
|
@@ -4975,7 +5166,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4975
5166
|
* @param {*} [options] Override http request option.
|
|
4976
5167
|
* @throws {RequiredError}
|
|
4977
5168
|
*/
|
|
4978
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
5169
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
4979
5170
|
/**
|
|
4980
5171
|
* List the names of all deployed robot controllers.
|
|
4981
5172
|
* @summary List Robot Controllers
|
|
@@ -4983,9 +5174,9 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4983
5174
|
* @param {*} [options] Override http request option.
|
|
4984
5175
|
* @throws {RequiredError}
|
|
4985
5176
|
*/
|
|
4986
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5177
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4987
5178
|
/**
|
|
4988
|
-
* 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.
|
|
5179
|
+
* 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.
|
|
4989
5180
|
* @summary Set Default Mode
|
|
4990
5181
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4991
5182
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4993,9 +5184,9 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4993
5184
|
* @param {*} [options] Override http request option.
|
|
4994
5185
|
* @throws {RequiredError}
|
|
4995
5186
|
*/
|
|
4996
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
5187
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4997
5188
|
/**
|
|
4998
|
-
* <!-- 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.
|
|
5189
|
+
* <!-- 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.
|
|
4999
5190
|
* @summary Stream Free Drive
|
|
5000
5191
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5001
5192
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5003,9 +5194,9 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5003
5194
|
* @param {*} [options] Override http request option.
|
|
5004
5195
|
* @throws {RequiredError}
|
|
5005
5196
|
*/
|
|
5006
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5197
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5007
5198
|
/**
|
|
5008
|
-
* <!-- 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.
|
|
5199
|
+
* <!-- 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.
|
|
5009
5200
|
* @summary Stream State
|
|
5010
5201
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5011
5202
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5014,9 +5205,9 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5014
5205
|
* @param {*} [options] Override http request option.
|
|
5015
5206
|
* @throws {RequiredError}
|
|
5016
5207
|
*/
|
|
5017
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5208
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5018
5209
|
/**
|
|
5019
|
-
* 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).
|
|
5210
|
+
* 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).
|
|
5020
5211
|
* @summary Update Robot Controller
|
|
5021
5212
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5022
5213
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5025,7 +5216,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5025
5216
|
* @param {*} [options] Override http request option.
|
|
5026
5217
|
* @throws {RequiredError}
|
|
5027
5218
|
*/
|
|
5028
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5219
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5029
5220
|
}
|
|
5030
5221
|
/**
|
|
5031
5222
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -5045,7 +5236,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5045
5236
|
*/
|
|
5046
5237
|
listIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5047
5238
|
/**
|
|
5048
|
-
* 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).
|
|
5239
|
+
* 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).
|
|
5049
5240
|
* @summary Get Input/Output Values
|
|
5050
5241
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5051
5242
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5055,7 +5246,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5055
5246
|
*/
|
|
5056
5247
|
listIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5057
5248
|
/**
|
|
5058
|
-
* 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.
|
|
5249
|
+
* 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.
|
|
5059
5250
|
* @summary Set Output Values
|
|
5060
5251
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5061
5252
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5075,7 +5266,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5075
5266
|
*/
|
|
5076
5267
|
streamIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5077
5268
|
/**
|
|
5078
|
-
* 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 ```
|
|
5269
|
+
* 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 ```
|
|
5079
5270
|
* @summary Wait For
|
|
5080
5271
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5081
5272
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5103,7 +5294,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5103
5294
|
*/
|
|
5104
5295
|
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
5105
5296
|
/**
|
|
5106
|
-
* 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).
|
|
5297
|
+
* 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).
|
|
5107
5298
|
* @summary Get Input/Output Values
|
|
5108
5299
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5109
5300
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5113,7 +5304,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5113
5304
|
*/
|
|
5114
5305
|
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5115
5306
|
/**
|
|
5116
|
-
* 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.
|
|
5307
|
+
* 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.
|
|
5117
5308
|
* @summary Set Output Values
|
|
5118
5309
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5119
5310
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5133,7 +5324,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5133
5324
|
*/
|
|
5134
5325
|
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamIOValuesResponse>>;
|
|
5135
5326
|
/**
|
|
5136
|
-
* 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 ```
|
|
5327
|
+
* 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 ```
|
|
5137
5328
|
* @summary Wait For
|
|
5138
5329
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5139
5330
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5161,7 +5352,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5161
5352
|
*/
|
|
5162
5353
|
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
5163
5354
|
/**
|
|
5164
|
-
* 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).
|
|
5355
|
+
* 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).
|
|
5165
5356
|
* @summary Get Input/Output Values
|
|
5166
5357
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5167
5358
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5171,7 +5362,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5171
5362
|
*/
|
|
5172
5363
|
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5173
5364
|
/**
|
|
5174
|
-
* 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.
|
|
5365
|
+
* 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.
|
|
5175
5366
|
* @summary Set Output Values
|
|
5176
5367
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5177
5368
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5191,7 +5382,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5191
5382
|
*/
|
|
5192
5383
|
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<StreamIOValuesResponse>;
|
|
5193
5384
|
/**
|
|
5194
|
-
* 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 ```
|
|
5385
|
+
* 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 ```
|
|
5195
5386
|
* @summary Wait For
|
|
5196
5387
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5197
5388
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5217,9 +5408,9 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5217
5408
|
* @param {*} [options] Override http request option.
|
|
5218
5409
|
* @throws {RequiredError}
|
|
5219
5410
|
*/
|
|
5220
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5411
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
5221
5412
|
/**
|
|
5222
|
-
* 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).
|
|
5413
|
+
* 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).
|
|
5223
5414
|
* @summary Get Input/Output Values
|
|
5224
5415
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5225
5416
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5227,9 +5418,9 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5227
5418
|
* @param {*} [options] Override http request option.
|
|
5228
5419
|
* @throws {RequiredError}
|
|
5229
5420
|
*/
|
|
5230
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5421
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
5231
5422
|
/**
|
|
5232
|
-
* 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.
|
|
5423
|
+
* 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.
|
|
5233
5424
|
* @summary Set Output Values
|
|
5234
5425
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5235
5426
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5237,7 +5428,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5237
5428
|
* @param {*} [options] Override http request option.
|
|
5238
5429
|
* @throws {RequiredError}
|
|
5239
5430
|
*/
|
|
5240
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5431
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5241
5432
|
/**
|
|
5242
5433
|
* <!-- theme: success --> > Websocket endpoint Continuously receive updates of input/output values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > If you request many values simultaneously, the request is likely to fail. The amount of values that can be streamed simultaneously depends on the specific robot controller. > **NOTE** > > The inputs and outputs are sent in the update rate of the controller to prevent losing any values. This can lead to a high amount of data transmitted.
|
|
5243
5434
|
* @summary Stream Input/Output Values
|
|
@@ -5247,9 +5438,9 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5247
5438
|
* @param {*} [options] Override http request option.
|
|
5248
5439
|
* @throws {RequiredError}
|
|
5249
5440
|
*/
|
|
5250
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5441
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
5251
5442
|
/**
|
|
5252
|
-
* 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 ```
|
|
5443
|
+
* 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 ```
|
|
5253
5444
|
* @summary Wait For
|
|
5254
5445
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5255
5446
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5257,14 +5448,14 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5257
5448
|
* @param {*} [options] Override http request option.
|
|
5258
5449
|
* @throws {RequiredError}
|
|
5259
5450
|
*/
|
|
5260
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5451
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<boolean, any>>;
|
|
5261
5452
|
}
|
|
5262
5453
|
/**
|
|
5263
5454
|
* JoggingApi - axios parameter creator
|
|
5264
5455
|
*/
|
|
5265
5456
|
declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5266
5457
|
/**
|
|
5267
|
-
* <!-- 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.
|
|
5458
|
+
* <!-- 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.
|
|
5268
5459
|
* @summary Execute Jogging
|
|
5269
5460
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5270
5461
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5279,7 +5470,7 @@ declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5279
5470
|
*/
|
|
5280
5471
|
declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
5281
5472
|
/**
|
|
5282
|
-
* <!-- 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.
|
|
5473
|
+
* <!-- 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.
|
|
5283
5474
|
* @summary Execute Jogging
|
|
5284
5475
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5285
5476
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5294,7 +5485,7 @@ declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
|
5294
5485
|
*/
|
|
5295
5486
|
declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5296
5487
|
/**
|
|
5297
|
-
* <!-- 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.
|
|
5488
|
+
* <!-- 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.
|
|
5298
5489
|
* @summary Execute Jogging
|
|
5299
5490
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5300
5491
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5309,7 +5500,7 @@ declare const JoggingApiFactory: (configuration?: Configuration, basePath?: stri
|
|
|
5309
5500
|
*/
|
|
5310
5501
|
declare class JoggingApi extends BaseAPI {
|
|
5311
5502
|
/**
|
|
5312
|
-
* <!-- 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.
|
|
5503
|
+
* <!-- 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.
|
|
5313
5504
|
* @summary Execute Jogging
|
|
5314
5505
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5315
5506
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5317,7 +5508,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
5317
5508
|
* @param {*} [options] Override http request option.
|
|
5318
5509
|
* @throws {RequiredError}
|
|
5319
5510
|
*/
|
|
5320
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5511
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteJoggingResponse, any>>;
|
|
5321
5512
|
}
|
|
5322
5513
|
/**
|
|
5323
5514
|
* KinematicsApi - axios parameter creator
|
|
@@ -5400,7 +5591,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5400
5591
|
* @param {*} [options] Override http request option.
|
|
5401
5592
|
* @throws {RequiredError}
|
|
5402
5593
|
*/
|
|
5403
|
-
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5594
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
|
|
5404
5595
|
/**
|
|
5405
5596
|
* Returns the reachable joint positions for a list of given poses.
|
|
5406
5597
|
* @summary Inverse kinematics
|
|
@@ -5409,7 +5600,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
5409
5600
|
* @param {*} [options] Override http request option.
|
|
5410
5601
|
* @throws {RequiredError}
|
|
5411
5602
|
*/
|
|
5412
|
-
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5603
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
|
|
5413
5604
|
}
|
|
5414
5605
|
/**
|
|
5415
5606
|
* LicenseApi - axios parameter creator
|
|
@@ -5524,28 +5715,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
5524
5715
|
* @param {*} [options] Override http request option.
|
|
5525
5716
|
* @throws {RequiredError}
|
|
5526
5717
|
*/
|
|
5527
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5718
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5528
5719
|
/**
|
|
5529
5720
|
* Deactivates active license.
|
|
5530
5721
|
* @summary Deactivate license
|
|
5531
5722
|
* @param {*} [options] Override http request option.
|
|
5532
5723
|
* @throws {RequiredError}
|
|
5533
5724
|
*/
|
|
5534
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5725
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5535
5726
|
/**
|
|
5536
5727
|
* Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
5537
5728
|
* @summary Get license
|
|
5538
5729
|
* @param {*} [options] Override http request option.
|
|
5539
5730
|
* @throws {RequiredError}
|
|
5540
5731
|
*/
|
|
5541
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
5732
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<License, any>>;
|
|
5542
5733
|
/**
|
|
5543
5734
|
* Get the license status. - If `valid`, Wandelbots NOVA can be used. - If `expired`, the license has to be renewed in order to use Wandelbots NOVA.
|
|
5544
5735
|
* @summary Get license status
|
|
5545
5736
|
* @param {*} [options] Override http request option.
|
|
5546
5737
|
* @throws {RequiredError}
|
|
5547
5738
|
*/
|
|
5548
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
5739
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<LicenseStatus, any>>;
|
|
5549
5740
|
}
|
|
5550
5741
|
/**
|
|
5551
5742
|
* MotionGroupApi - axios parameter creator
|
|
@@ -5675,7 +5866,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5675
5866
|
* @param {*} [options] Override http request option.
|
|
5676
5867
|
* @throws {RequiredError}
|
|
5677
5868
|
*/
|
|
5678
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5869
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5679
5870
|
/**
|
|
5680
5871
|
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data can change upon connection to the robot.
|
|
5681
5872
|
* @summary Description
|
|
@@ -5685,7 +5876,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5685
5876
|
* @param {*} [options] Override http request option.
|
|
5686
5877
|
* @throws {RequiredError}
|
|
5687
5878
|
*/
|
|
5688
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
5879
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupDescription, any>>;
|
|
5689
5880
|
/**
|
|
5690
5881
|
* <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
5691
5882
|
* @summary Stream State
|
|
@@ -5697,32 +5888,32 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5697
5888
|
* @param {*} [options] Override http request option.
|
|
5698
5889
|
* @throws {RequiredError}
|
|
5699
5890
|
*/
|
|
5700
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
5891
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupState, any>>;
|
|
5701
5892
|
}
|
|
5702
5893
|
/**
|
|
5703
5894
|
* MotionGroupModelsApi - axios parameter creator
|
|
5704
5895
|
*/
|
|
5705
5896
|
declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5706
5897
|
/**
|
|
5707
|
-
* 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.
|
|
5898
|
+
* 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.
|
|
5708
5899
|
* @summary Get Collision Model
|
|
5709
|
-
* @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).
|
|
5900
|
+
* @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).
|
|
5710
5901
|
* @param {*} [options] Override http request option.
|
|
5711
5902
|
* @throws {RequiredError}
|
|
5712
5903
|
*/
|
|
5713
5904
|
getMotionGroupCollisionModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5714
5905
|
/**
|
|
5715
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
5906
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5716
5907
|
* @summary Download GLB Model
|
|
5717
|
-
* @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).
|
|
5908
|
+
* @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).
|
|
5718
5909
|
* @param {*} [options] Override http request option.
|
|
5719
5910
|
* @throws {RequiredError}
|
|
5720
5911
|
*/
|
|
5721
5912
|
getMotionGroupGlbModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5722
5913
|
/**
|
|
5723
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
5914
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
5724
5915
|
* @summary Get Kinematics
|
|
5725
|
-
* @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).
|
|
5916
|
+
* @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).
|
|
5726
5917
|
* @param {*} [options] Override http request option.
|
|
5727
5918
|
* @throws {RequiredError}
|
|
5728
5919
|
*/
|
|
@@ -5735,9 +5926,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5735
5926
|
*/
|
|
5736
5927
|
getMotionGroupModels: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5737
5928
|
/**
|
|
5738
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
5929
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5739
5930
|
* @summary Download USD Model
|
|
5740
|
-
* @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).
|
|
5931
|
+
* @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).
|
|
5741
5932
|
* @param {*} [options] Override http request option.
|
|
5742
5933
|
* @throws {RequiredError}
|
|
5743
5934
|
*/
|
|
@@ -5748,9 +5939,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5748
5939
|
*/
|
|
5749
5940
|
declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
5750
5941
|
/**
|
|
5751
|
-
* 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.
|
|
5942
|
+
* 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.
|
|
5752
5943
|
* @summary Get Collision Model
|
|
5753
|
-
* @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).
|
|
5944
|
+
* @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).
|
|
5754
5945
|
* @param {*} [options] Override http request option.
|
|
5755
5946
|
* @throws {RequiredError}
|
|
5756
5947
|
*/
|
|
@@ -5758,17 +5949,17 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
|
5758
5949
|
[key: string]: Collider;
|
|
5759
5950
|
}>>>;
|
|
5760
5951
|
/**
|
|
5761
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
5952
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5762
5953
|
* @summary Download GLB Model
|
|
5763
|
-
* @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).
|
|
5954
|
+
* @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).
|
|
5764
5955
|
* @param {*} [options] Override http request option.
|
|
5765
5956
|
* @throws {RequiredError}
|
|
5766
5957
|
*/
|
|
5767
5958
|
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
5768
5959
|
/**
|
|
5769
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
5960
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
5770
5961
|
* @summary Get Kinematics
|
|
5771
|
-
* @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).
|
|
5962
|
+
* @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).
|
|
5772
5963
|
* @param {*} [options] Override http request option.
|
|
5773
5964
|
* @throws {RequiredError}
|
|
5774
5965
|
*/
|
|
@@ -5781,9 +5972,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
|
5781
5972
|
*/
|
|
5782
5973
|
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5783
5974
|
/**
|
|
5784
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
5975
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5785
5976
|
* @summary Download USD Model
|
|
5786
|
-
* @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).
|
|
5977
|
+
* @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).
|
|
5787
5978
|
* @param {*} [options] Override http request option.
|
|
5788
5979
|
* @throws {RequiredError}
|
|
5789
5980
|
*/
|
|
@@ -5794,9 +5985,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
|
5794
5985
|
*/
|
|
5795
5986
|
declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5796
5987
|
/**
|
|
5797
|
-
* 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.
|
|
5988
|
+
* 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.
|
|
5798
5989
|
* @summary Get Collision Model
|
|
5799
|
-
* @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).
|
|
5990
|
+
* @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).
|
|
5800
5991
|
* @param {*} [options] Override http request option.
|
|
5801
5992
|
* @throws {RequiredError}
|
|
5802
5993
|
*/
|
|
@@ -5804,17 +5995,17 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
|
|
|
5804
5995
|
[key: string]: Collider;
|
|
5805
5996
|
}>>;
|
|
5806
5997
|
/**
|
|
5807
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
5998
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5808
5999
|
* @summary Download GLB Model
|
|
5809
|
-
* @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).
|
|
6000
|
+
* @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).
|
|
5810
6001
|
* @param {*} [options] Override http request option.
|
|
5811
6002
|
* @throws {RequiredError}
|
|
5812
6003
|
*/
|
|
5813
6004
|
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
5814
6005
|
/**
|
|
5815
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
6006
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
5816
6007
|
* @summary Get Kinematics
|
|
5817
|
-
* @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).
|
|
6008
|
+
* @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).
|
|
5818
6009
|
* @param {*} [options] Override http request option.
|
|
5819
6010
|
* @throws {RequiredError}
|
|
5820
6011
|
*/
|
|
@@ -5827,9 +6018,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
|
|
|
5827
6018
|
*/
|
|
5828
6019
|
getMotionGroupModels(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
5829
6020
|
/**
|
|
5830
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6021
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5831
6022
|
* @summary Download USD Model
|
|
5832
|
-
* @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).
|
|
6023
|
+
* @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).
|
|
5833
6024
|
* @param {*} [options] Override http request option.
|
|
5834
6025
|
* @throws {RequiredError}
|
|
5835
6026
|
*/
|
|
@@ -5840,46 +6031,46 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
|
|
|
5840
6031
|
*/
|
|
5841
6032
|
declare class MotionGroupModelsApi extends BaseAPI {
|
|
5842
6033
|
/**
|
|
5843
|
-
* 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.
|
|
6034
|
+
* 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.
|
|
5844
6035
|
* @summary Get Collision Model
|
|
5845
|
-
* @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).
|
|
6036
|
+
* @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).
|
|
5846
6037
|
* @param {*} [options] Override http request option.
|
|
5847
6038
|
* @throws {RequiredError}
|
|
5848
6039
|
*/
|
|
5849
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6040
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
5850
6041
|
[key: string]: Collider;
|
|
5851
6042
|
}[], any>>;
|
|
5852
6043
|
/**
|
|
5853
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6044
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5854
6045
|
* @summary Download GLB Model
|
|
5855
|
-
* @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).
|
|
6046
|
+
* @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).
|
|
5856
6047
|
* @param {*} [options] Override http request option.
|
|
5857
6048
|
* @throws {RequiredError}
|
|
5858
6049
|
*/
|
|
5859
|
-
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6050
|
+
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
5860
6051
|
/**
|
|
5861
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
6052
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
5862
6053
|
* @summary Get Kinematics
|
|
5863
|
-
* @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).
|
|
6054
|
+
* @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).
|
|
5864
6055
|
* @param {*} [options] Override http request option.
|
|
5865
6056
|
* @throws {RequiredError}
|
|
5866
6057
|
*/
|
|
5867
|
-
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6058
|
+
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<KinematicModel, any>>;
|
|
5868
6059
|
/**
|
|
5869
6060
|
* Returns the list of supported motion group models.
|
|
5870
6061
|
* @summary Motion Group Models
|
|
5871
6062
|
* @param {*} [options] Override http request option.
|
|
5872
6063
|
* @throws {RequiredError}
|
|
5873
6064
|
*/
|
|
5874
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
6065
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
5875
6066
|
/**
|
|
5876
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6067
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5877
6068
|
* @summary Download USD Model
|
|
5878
|
-
* @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).
|
|
6069
|
+
* @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).
|
|
5879
6070
|
* @param {*} [options] Override http request option.
|
|
5880
6071
|
* @throws {RequiredError}
|
|
5881
6072
|
*/
|
|
5882
|
-
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
6073
|
+
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
5883
6074
|
}
|
|
5884
6075
|
/**
|
|
5885
6076
|
* ProgramApi - axios parameter creator
|
|
@@ -6016,7 +6207,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6016
6207
|
* @param {*} [options] Override http request option.
|
|
6017
6208
|
* @throws {RequiredError}
|
|
6018
6209
|
*/
|
|
6019
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6210
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program, any>>;
|
|
6020
6211
|
/**
|
|
6021
6212
|
* <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
6022
6213
|
* @summary List programs
|
|
@@ -6024,7 +6215,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6024
6215
|
* @param {*} [options] Override http request option.
|
|
6025
6216
|
* @throws {RequiredError}
|
|
6026
6217
|
*/
|
|
6027
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6218
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Program[], any>>;
|
|
6028
6219
|
/**
|
|
6029
6220
|
* <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
6030
6221
|
* @summary Start the program
|
|
@@ -6034,7 +6225,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6034
6225
|
* @param {*} [options] Override http request option.
|
|
6035
6226
|
* @throws {RequiredError}
|
|
6036
6227
|
*/
|
|
6037
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6228
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProgramRun, any>>;
|
|
6038
6229
|
/**
|
|
6039
6230
|
* <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
6040
6231
|
* @summary Stop program run
|
|
@@ -6043,7 +6234,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6043
6234
|
* @param {*} [options] Override http request option.
|
|
6044
6235
|
* @throws {RequiredError}
|
|
6045
6236
|
*/
|
|
6046
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
6237
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6047
6238
|
}
|
|
6048
6239
|
/**
|
|
6049
6240
|
* RobotConfigurationsApi - axios parameter creator
|
|
@@ -6091,7 +6282,7 @@ declare class RobotConfigurationsApi extends BaseAPI {
|
|
|
6091
6282
|
* @param {*} [options] Override http request option.
|
|
6092
6283
|
* @throws {RequiredError}
|
|
6093
6284
|
*/
|
|
6094
|
-
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<
|
|
6285
|
+
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6095
6286
|
}
|
|
6096
6287
|
/**
|
|
6097
6288
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -6564,7 +6755,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6564
6755
|
* @param {*} [options] Override http request option.
|
|
6565
6756
|
* @throws {RequiredError}
|
|
6566
6757
|
*/
|
|
6567
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6758
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6568
6759
|
/**
|
|
6569
6760
|
* Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6570
6761
|
* @summary Delete Link Chain
|
|
@@ -6573,7 +6764,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6573
6764
|
* @param {*} [options] Override http request option.
|
|
6574
6765
|
* @throws {RequiredError}
|
|
6575
6766
|
*/
|
|
6576
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6767
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6577
6768
|
/**
|
|
6578
6769
|
* Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
6579
6770
|
* @summary Delete Tool
|
|
@@ -6582,7 +6773,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6582
6773
|
* @param {*} [options] Override http request option.
|
|
6583
6774
|
* @throws {RequiredError}
|
|
6584
6775
|
*/
|
|
6585
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6776
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6586
6777
|
/**
|
|
6587
6778
|
* Returns the collider.
|
|
6588
6779
|
* @summary Get Collider
|
|
@@ -6591,7 +6782,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6591
6782
|
* @param {*} [options] Override http request option.
|
|
6592
6783
|
* @throws {RequiredError}
|
|
6593
6784
|
*/
|
|
6594
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
6785
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6595
6786
|
/**
|
|
6596
6787
|
* Returns the collision link chain.
|
|
6597
6788
|
* @summary Get Link Chain
|
|
@@ -6600,7 +6791,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6600
6791
|
* @param {*} [options] Override http request option.
|
|
6601
6792
|
* @throws {RequiredError}
|
|
6602
6793
|
*/
|
|
6603
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
6794
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6604
6795
|
[key: string]: Collider;
|
|
6605
6796
|
}[], any>>;
|
|
6606
6797
|
/**
|
|
@@ -6611,7 +6802,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6611
6802
|
* @param {*} [options] Override http request option.
|
|
6612
6803
|
* @throws {RequiredError}
|
|
6613
6804
|
*/
|
|
6614
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
6805
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6615
6806
|
[key: string]: Collider;
|
|
6616
6807
|
}, any>>;
|
|
6617
6808
|
/**
|
|
@@ -6621,7 +6812,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6621
6812
|
* @param {*} [options] Override http request option.
|
|
6622
6813
|
* @throws {RequiredError}
|
|
6623
6814
|
*/
|
|
6624
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6815
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6625
6816
|
[key: string]: {
|
|
6626
6817
|
[key: string]: Collider;
|
|
6627
6818
|
}[];
|
|
@@ -6633,7 +6824,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6633
6824
|
* @param {*} [options] Override http request option.
|
|
6634
6825
|
* @throws {RequiredError}
|
|
6635
6826
|
*/
|
|
6636
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6827
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6637
6828
|
/**
|
|
6638
6829
|
* Returns all stored colliders.
|
|
6639
6830
|
* @summary List Colliders
|
|
@@ -6641,7 +6832,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6641
6832
|
* @param {*} [options] Override http request option.
|
|
6642
6833
|
* @throws {RequiredError}
|
|
6643
6834
|
*/
|
|
6644
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6835
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6645
6836
|
[key: string]: Collider;
|
|
6646
6837
|
}, any>>;
|
|
6647
6838
|
/**
|
|
@@ -6651,7 +6842,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6651
6842
|
* @param {*} [options] Override http request option.
|
|
6652
6843
|
* @throws {RequiredError}
|
|
6653
6844
|
*/
|
|
6654
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6845
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6655
6846
|
/**
|
|
6656
6847
|
* Returns the list of stored tools.
|
|
6657
6848
|
* @summary List Tools
|
|
@@ -6659,7 +6850,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6659
6850
|
* @param {*} [options] Override http request option.
|
|
6660
6851
|
* @throws {RequiredError}
|
|
6661
6852
|
*/
|
|
6662
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6853
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6663
6854
|
[key: string]: {
|
|
6664
6855
|
[key: string]: Collider;
|
|
6665
6856
|
};
|
|
@@ -6671,7 +6862,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6671
6862
|
* @param {*} [options] Override http request option.
|
|
6672
6863
|
* @throws {RequiredError}
|
|
6673
6864
|
*/
|
|
6674
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6865
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6675
6866
|
/**
|
|
6676
6867
|
* Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
6677
6868
|
* @summary Store Collider
|
|
@@ -6681,7 +6872,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6681
6872
|
* @param {*} [options] Override http request option.
|
|
6682
6873
|
* @throws {RequiredError}
|
|
6683
6874
|
*/
|
|
6684
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
6875
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Collider, any>>;
|
|
6685
6876
|
/**
|
|
6686
6877
|
* Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
6687
6878
|
* @summary Store Link Chain
|
|
@@ -6693,7 +6884,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6693
6884
|
*/
|
|
6694
6885
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
6695
6886
|
[key: string]: Collider;
|
|
6696
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
6887
|
+
}>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6697
6888
|
[key: string]: Collider;
|
|
6698
6889
|
}[], any>>;
|
|
6699
6890
|
/**
|
|
@@ -6707,7 +6898,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6707
6898
|
*/
|
|
6708
6899
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
6709
6900
|
[key: string]: Collider;
|
|
6710
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
6901
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6711
6902
|
[key: string]: Collider;
|
|
6712
6903
|
}, any>>;
|
|
6713
6904
|
}
|
|
@@ -6874,7 +7065,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6874
7065
|
* @param {*} [options] Override http request option.
|
|
6875
7066
|
* @throws {RequiredError}
|
|
6876
7067
|
*/
|
|
6877
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7068
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
6878
7069
|
/**
|
|
6879
7070
|
* Returns the stored collision setup.
|
|
6880
7071
|
* @summary Get Collision Setup
|
|
@@ -6883,7 +7074,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6883
7074
|
* @param {*} [options] Override http request option.
|
|
6884
7075
|
* @throws {RequiredError}
|
|
6885
7076
|
*/
|
|
6886
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
7077
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
6887
7078
|
/**
|
|
6888
7079
|
* Returns a list of stored collision setups.
|
|
6889
7080
|
* @summary List Collision Setups
|
|
@@ -6891,7 +7082,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6891
7082
|
* @param {*} [options] Override http request option.
|
|
6892
7083
|
* @throws {RequiredError}
|
|
6893
7084
|
*/
|
|
6894
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7085
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<{
|
|
6895
7086
|
[key: string]: CollisionSetup;
|
|
6896
7087
|
}, any>>;
|
|
6897
7088
|
/**
|
|
@@ -6901,7 +7092,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6901
7092
|
* @param {*} [options] Override http request option.
|
|
6902
7093
|
* @throws {RequiredError}
|
|
6903
7094
|
*/
|
|
6904
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7095
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
6905
7096
|
/**
|
|
6906
7097
|
* Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
6907
7098
|
* @summary Store Collision Setup
|
|
@@ -6911,7 +7102,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
6911
7102
|
* @param {*} [options] Override http request option.
|
|
6912
7103
|
* @throws {RequiredError}
|
|
6913
7104
|
*/
|
|
6914
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
7105
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CollisionSetup, any>>;
|
|
6915
7106
|
}
|
|
6916
7107
|
/**
|
|
6917
7108
|
* StoreObjectApi - axios parameter creator
|
|
@@ -6961,7 +7152,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
6961
7152
|
*/
|
|
6962
7153
|
listAllObjectKeys: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6963
7154
|
/**
|
|
6964
|
-
* 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.
|
|
7155
|
+
* 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.
|
|
6965
7156
|
* @summary Store Object
|
|
6966
7157
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6967
7158
|
* @param {string} key
|
|
@@ -7022,7 +7213,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
|
|
|
7022
7213
|
*/
|
|
7023
7214
|
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
7024
7215
|
/**
|
|
7025
|
-
* 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.
|
|
7216
|
+
* 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.
|
|
7026
7217
|
* @summary Store Object
|
|
7027
7218
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7028
7219
|
* @param {string} key
|
|
@@ -7083,7 +7274,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
|
|
|
7083
7274
|
*/
|
|
7084
7275
|
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
7085
7276
|
/**
|
|
7086
|
-
* 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.
|
|
7277
|
+
* 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.
|
|
7087
7278
|
* @summary Store Object
|
|
7088
7279
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7089
7280
|
* @param {string} key
|
|
@@ -7107,7 +7298,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7107
7298
|
* @param {*} [options] Override http request option.
|
|
7108
7299
|
* @throws {RequiredError}
|
|
7109
7300
|
*/
|
|
7110
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7301
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7111
7302
|
/**
|
|
7112
7303
|
* Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
7113
7304
|
* @summary Delete Object
|
|
@@ -7116,7 +7307,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7116
7307
|
* @param {*} [options] Override http request option.
|
|
7117
7308
|
* @throws {RequiredError}
|
|
7118
7309
|
*/
|
|
7119
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7310
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7120
7311
|
/**
|
|
7121
7312
|
* Returns content and metadata of a stored object.
|
|
7122
7313
|
* @summary Get Object
|
|
@@ -7125,7 +7316,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7125
7316
|
* @param {*} [options] Override http request option.
|
|
7126
7317
|
* @throws {RequiredError}
|
|
7127
7318
|
*/
|
|
7128
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7319
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7129
7320
|
/**
|
|
7130
7321
|
* Returns metadata. Object content is not returned.
|
|
7131
7322
|
* @summary Get Object Metadata
|
|
@@ -7134,7 +7325,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7134
7325
|
* @param {*} [options] Override http request option.
|
|
7135
7326
|
* @throws {RequiredError}
|
|
7136
7327
|
*/
|
|
7137
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
7328
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7138
7329
|
/**
|
|
7139
7330
|
* List the keys for all objects.
|
|
7140
7331
|
* @summary List all Object Keys
|
|
@@ -7142,9 +7333,9 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7142
7333
|
* @param {*} [options] Override http request option.
|
|
7143
7334
|
* @throws {RequiredError}
|
|
7144
7335
|
*/
|
|
7145
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7336
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7146
7337
|
/**
|
|
7147
|
-
* 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.
|
|
7338
|
+
* 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.
|
|
7148
7339
|
* @summary Store Object
|
|
7149
7340
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7150
7341
|
* @param {string} key
|
|
@@ -7155,7 +7346,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7155
7346
|
*/
|
|
7156
7347
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
7157
7348
|
[key: string]: string;
|
|
7158
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
7349
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7159
7350
|
}
|
|
7160
7351
|
/**
|
|
7161
7352
|
* SystemApi - axios parameter creator
|
|
@@ -7250,7 +7441,7 @@ declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
7250
7441
|
*/
|
|
7251
7442
|
restoreConfiguration: (body: File, resources?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7252
7443
|
/**
|
|
7253
|
-
* 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.
|
|
7444
|
+
* 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.
|
|
7254
7445
|
* @summary Update Wandelbots NOVA version
|
|
7255
7446
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
7256
7447
|
* @param {*} [options] Override http request option.
|
|
@@ -7351,7 +7542,7 @@ declare const SystemApiFp: (configuration?: Configuration) => {
|
|
|
7351
7542
|
*/
|
|
7352
7543
|
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7353
7544
|
/**
|
|
7354
|
-
* 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.
|
|
7545
|
+
* 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.
|
|
7355
7546
|
* @summary Update Wandelbots NOVA version
|
|
7356
7547
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
7357
7548
|
* @param {*} [options] Override http request option.
|
|
@@ -7452,7 +7643,7 @@ declare const SystemApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
7452
7643
|
*/
|
|
7453
7644
|
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7454
7645
|
/**
|
|
7455
|
-
* 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.
|
|
7646
|
+
* 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.
|
|
7456
7647
|
* @summary Update Wandelbots NOVA version
|
|
7457
7648
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
7458
7649
|
* @param {*} [options] Override http request option.
|
|
@@ -7474,7 +7665,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7474
7665
|
*/
|
|
7475
7666
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
7476
7667
|
[key: string]: string;
|
|
7477
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
7668
|
+
}, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7478
7669
|
/**
|
|
7479
7670
|
* Check if a more recent Wandelbots NOVA Version is available.
|
|
7480
7671
|
* @summary Check update
|
|
@@ -7482,7 +7673,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7482
7673
|
* @param {*} [options] Override http request option.
|
|
7483
7674
|
* @throws {RequiredError}
|
|
7484
7675
|
*/
|
|
7485
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
7676
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7486
7677
|
/**
|
|
7487
7678
|
* <!-- theme: danger --> > **Experimental** Performs an address resolution protocol (ARP) scan on the specified interface/classless inter-domain routing (CIDR) and returns all discovered devices on the network by CIDR notation.
|
|
7488
7679
|
* @summary Get ARP-Scan
|
|
@@ -7492,7 +7683,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7492
7683
|
* @param {*} [options] Override http request option.
|
|
7493
7684
|
* @throws {RequiredError}
|
|
7494
7685
|
*/
|
|
7495
|
-
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7686
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkDevice[], any>>;
|
|
7496
7687
|
/**
|
|
7497
7688
|
* Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
|
|
7498
7689
|
* @summary Retrieve Backup Status
|
|
@@ -7500,49 +7691,49 @@ declare class SystemApi extends BaseAPI {
|
|
|
7500
7691
|
* @param {*} [options] Override http request option.
|
|
7501
7692
|
* @throws {RequiredError}
|
|
7502
7693
|
*/
|
|
7503
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
7694
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationArchiveStatus, any>>;
|
|
7504
7695
|
/**
|
|
7505
7696
|
* Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
|
|
7506
7697
|
* @summary Download Diagnosis Package
|
|
7507
7698
|
* @param {*} [options] Override http request option.
|
|
7508
7699
|
* @throws {RequiredError}
|
|
7509
7700
|
*/
|
|
7510
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
7701
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
7511
7702
|
/**
|
|
7512
7703
|
* <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
7513
7704
|
* @summary Network Interfaces
|
|
7514
7705
|
* @param {*} [options] Override http request option.
|
|
7515
7706
|
* @throws {RequiredError}
|
|
7516
7707
|
*/
|
|
7517
|
-
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<
|
|
7708
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkInterface[], any>>;
|
|
7518
7709
|
/**
|
|
7519
7710
|
* <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
7520
7711
|
* @summary Network State
|
|
7521
7712
|
* @param {*} [options] Override http request option.
|
|
7522
7713
|
* @throws {RequiredError}
|
|
7523
7714
|
*/
|
|
7524
|
-
getNetworkState(options?: RawAxiosRequestConfig): Promise<
|
|
7715
|
+
getNetworkState(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<NetworkState, any>>;
|
|
7525
7716
|
/**
|
|
7526
7717
|
* Get the status of all system services.
|
|
7527
7718
|
* @summary Wandelbots NOVA status
|
|
7528
7719
|
* @param {*} [options] Override http request option.
|
|
7529
7720
|
* @throws {RequiredError}
|
|
7530
7721
|
*/
|
|
7531
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
7722
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ServiceStatus[], any>>;
|
|
7532
7723
|
/**
|
|
7533
7724
|
* Get the current Wandelbots NOVA version.
|
|
7534
7725
|
* @summary Wandelbots NOVA Version
|
|
7535
7726
|
* @param {*} [options] Override http request option.
|
|
7536
7727
|
* @throws {RequiredError}
|
|
7537
7728
|
*/
|
|
7538
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
7729
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
7539
7730
|
/**
|
|
7540
7731
|
* Retrieves a list of all available configuration resources for backup purposes.
|
|
7541
7732
|
* @summary List Configuration Resources
|
|
7542
7733
|
* @param {*} [options] Override http request option.
|
|
7543
7734
|
* @throws {RequiredError}
|
|
7544
7735
|
*/
|
|
7545
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
7736
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ConfigurationResource[], any>>;
|
|
7546
7737
|
/**
|
|
7547
7738
|
* Restores a previously backed up configuration. If an empty array of resources is provided, all resources from the backup will be restored.
|
|
7548
7739
|
* @summary Restore Configuration Backup
|
|
@@ -7551,22 +7742,22 @@ declare class SystemApi extends BaseAPI {
|
|
|
7551
7742
|
* @param {*} [options] Override http request option.
|
|
7552
7743
|
* @throws {RequiredError}
|
|
7553
7744
|
*/
|
|
7554
|
-
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
7745
|
+
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7555
7746
|
/**
|
|
7556
|
-
* 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.
|
|
7747
|
+
* 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.
|
|
7557
7748
|
* @summary Update Wandelbots NOVA version
|
|
7558
7749
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
7559
7750
|
* @param {*} [options] Override http request option.
|
|
7560
7751
|
* @throws {RequiredError}
|
|
7561
7752
|
*/
|
|
7562
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7753
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7563
7754
|
}
|
|
7564
7755
|
/**
|
|
7565
7756
|
* TrajectoryCachingApi - axios parameter creator
|
|
7566
7757
|
*/
|
|
7567
7758
|
declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7568
7759
|
/**
|
|
7569
|
-
* 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.
|
|
7760
|
+
* 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.
|
|
7570
7761
|
* @summary Add Trajectory
|
|
7571
7762
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7572
7763
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7585,7 +7776,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7585
7776
|
*/
|
|
7586
7777
|
clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7587
7778
|
/**
|
|
7588
|
-
* 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.
|
|
7779
|
+
* 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.
|
|
7589
7780
|
* @summary Delete Trajectory
|
|
7590
7781
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7591
7782
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7595,7 +7786,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7595
7786
|
*/
|
|
7596
7787
|
deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7597
7788
|
/**
|
|
7598
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7789
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7599
7790
|
* @summary Get Trajectory
|
|
7600
7791
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7601
7792
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7605,7 +7796,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7605
7796
|
*/
|
|
7606
7797
|
getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7607
7798
|
/**
|
|
7608
|
-
* 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.
|
|
7799
|
+
* 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.
|
|
7609
7800
|
* @summary List Trajectories
|
|
7610
7801
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7611
7802
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7619,7 +7810,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7619
7810
|
*/
|
|
7620
7811
|
declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
7621
7812
|
/**
|
|
7622
|
-
* 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.
|
|
7813
|
+
* 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.
|
|
7623
7814
|
* @summary Add Trajectory
|
|
7624
7815
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7625
7816
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7638,7 +7829,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
|
7638
7829
|
*/
|
|
7639
7830
|
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7640
7831
|
/**
|
|
7641
|
-
* 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.
|
|
7832
|
+
* 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.
|
|
7642
7833
|
* @summary Delete Trajectory
|
|
7643
7834
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7644
7835
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7648,7 +7839,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
|
7648
7839
|
*/
|
|
7649
7840
|
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7650
7841
|
/**
|
|
7651
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7842
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7652
7843
|
* @summary Get Trajectory
|
|
7653
7844
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7654
7845
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7658,7 +7849,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
|
7658
7849
|
*/
|
|
7659
7850
|
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
|
|
7660
7851
|
/**
|
|
7661
|
-
* 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.
|
|
7852
|
+
* 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.
|
|
7662
7853
|
* @summary List Trajectories
|
|
7663
7854
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7664
7855
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7672,7 +7863,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
|
7672
7863
|
*/
|
|
7673
7864
|
declare const TrajectoryCachingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7674
7865
|
/**
|
|
7675
|
-
* 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.
|
|
7866
|
+
* 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.
|
|
7676
7867
|
* @summary Add Trajectory
|
|
7677
7868
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7678
7869
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7691,7 +7882,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
|
|
|
7691
7882
|
*/
|
|
7692
7883
|
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7693
7884
|
/**
|
|
7694
|
-
* 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.
|
|
7885
|
+
* 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.
|
|
7695
7886
|
* @summary Delete Trajectory
|
|
7696
7887
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7697
7888
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7701,7 +7892,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
|
|
|
7701
7892
|
*/
|
|
7702
7893
|
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7703
7894
|
/**
|
|
7704
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7895
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7705
7896
|
* @summary Get Trajectory
|
|
7706
7897
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7707
7898
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7711,7 +7902,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
|
|
|
7711
7902
|
*/
|
|
7712
7903
|
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
|
|
7713
7904
|
/**
|
|
7714
|
-
* 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.
|
|
7905
|
+
* 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.
|
|
7715
7906
|
* @summary List Trajectories
|
|
7716
7907
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7717
7908
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7725,7 +7916,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
|
|
|
7725
7916
|
*/
|
|
7726
7917
|
declare class TrajectoryCachingApi extends BaseAPI {
|
|
7727
7918
|
/**
|
|
7728
|
-
* 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.
|
|
7919
|
+
* 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.
|
|
7729
7920
|
* @summary Add Trajectory
|
|
7730
7921
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7731
7922
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7733,7 +7924,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7733
7924
|
* @param {*} [options] Override http request option.
|
|
7734
7925
|
* @throws {RequiredError}
|
|
7735
7926
|
*/
|
|
7736
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7927
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<AddTrajectoryResponse, any>>;
|
|
7737
7928
|
/**
|
|
7738
7929
|
* Clear the trajectory cache.
|
|
7739
7930
|
* @summary Clear Trajectories
|
|
@@ -7742,9 +7933,9 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7742
7933
|
* @param {*} [options] Override http request option.
|
|
7743
7934
|
* @throws {RequiredError}
|
|
7744
7935
|
*/
|
|
7745
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7936
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7746
7937
|
/**
|
|
7747
|
-
* 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.
|
|
7938
|
+
* 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.
|
|
7748
7939
|
* @summary Delete Trajectory
|
|
7749
7940
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7750
7941
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7752,9 +7943,9 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7752
7943
|
* @param {*} [options] Override http request option.
|
|
7753
7944
|
* @throws {RequiredError}
|
|
7754
7945
|
*/
|
|
7755
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7946
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7756
7947
|
/**
|
|
7757
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7948
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7758
7949
|
* @summary Get Trajectory
|
|
7759
7950
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7760
7951
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7762,23 +7953,23 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7762
7953
|
* @param {*} [options] Override http request option.
|
|
7763
7954
|
* @throws {RequiredError}
|
|
7764
7955
|
*/
|
|
7765
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
7956
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7766
7957
|
/**
|
|
7767
|
-
* 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.
|
|
7958
|
+
* 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.
|
|
7768
7959
|
* @summary List Trajectories
|
|
7769
7960
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7770
7961
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
7771
7962
|
* @param {*} [options] Override http request option.
|
|
7772
7963
|
* @throws {RequiredError}
|
|
7773
7964
|
*/
|
|
7774
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
7965
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ListTrajectoriesResponse, any>>;
|
|
7775
7966
|
}
|
|
7776
7967
|
/**
|
|
7777
7968
|
* TrajectoryExecutionApi - axios parameter creator
|
|
7778
7969
|
*/
|
|
7779
7970
|
declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7780
7971
|
/**
|
|
7781
|
-
* <!-- 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
|
|
7972
|
+
* <!-- 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.
|
|
7782
7973
|
* @summary Execute Trajectory
|
|
7783
7974
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7784
7975
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7793,7 +7984,7 @@ declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configur
|
|
|
7793
7984
|
*/
|
|
7794
7985
|
declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
|
|
7795
7986
|
/**
|
|
7796
|
-
* <!-- 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
|
|
7987
|
+
* <!-- 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.
|
|
7797
7988
|
* @summary Execute Trajectory
|
|
7798
7989
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7799
7990
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7808,7 +7999,7 @@ declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
|
|
|
7808
7999
|
*/
|
|
7809
8000
|
declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7810
8001
|
/**
|
|
7811
|
-
* <!-- 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
|
|
8002
|
+
* <!-- 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.
|
|
7812
8003
|
* @summary Execute Trajectory
|
|
7813
8004
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7814
8005
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7823,7 +8014,7 @@ declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, bas
|
|
|
7823
8014
|
*/
|
|
7824
8015
|
declare class TrajectoryExecutionApi extends BaseAPI {
|
|
7825
8016
|
/**
|
|
7826
|
-
* <!-- 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
|
|
8017
|
+
* <!-- 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.
|
|
7827
8018
|
* @summary Execute Trajectory
|
|
7828
8019
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7829
8020
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7831,14 +8022,14 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7831
8022
|
* @param {*} [options] Override http request option.
|
|
7832
8023
|
* @throws {RequiredError}
|
|
7833
8024
|
*/
|
|
7834
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8025
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExecuteTrajectoryResponse, any>>;
|
|
7835
8026
|
}
|
|
7836
8027
|
/**
|
|
7837
8028
|
* TrajectoryPlanningApi - axios parameter creator
|
|
7838
8029
|
*/
|
|
7839
8030
|
declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7840
8031
|
/**
|
|
7841
|
-
* 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.
|
|
8032
|
+
* 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.
|
|
7842
8033
|
* @summary Plan Collision-Free Trajectory
|
|
7843
8034
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7844
8035
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -7847,7 +8038,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
|
|
|
7847
8038
|
*/
|
|
7848
8039
|
planCollisionFree: (cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7849
8040
|
/**
|
|
7850
|
-
* 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.
|
|
8041
|
+
* 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.
|
|
7851
8042
|
* @summary Plan Trajectory
|
|
7852
8043
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7853
8044
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -7861,7 +8052,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
|
|
|
7861
8052
|
*/
|
|
7862
8053
|
declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
7863
8054
|
/**
|
|
7864
|
-
* 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.
|
|
8055
|
+
* 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.
|
|
7865
8056
|
* @summary Plan Collision-Free Trajectory
|
|
7866
8057
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7867
8058
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -7870,7 +8061,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
|
7870
8061
|
*/
|
|
7871
8062
|
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
|
|
7872
8063
|
/**
|
|
7873
|
-
* 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.
|
|
8064
|
+
* 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.
|
|
7874
8065
|
* @summary Plan Trajectory
|
|
7875
8066
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7876
8067
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -7884,7 +8075,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
|
7884
8075
|
*/
|
|
7885
8076
|
declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7886
8077
|
/**
|
|
7887
|
-
* 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.
|
|
8078
|
+
* 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.
|
|
7888
8079
|
* @summary Plan Collision-Free Trajectory
|
|
7889
8080
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7890
8081
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -7893,7 +8084,7 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
|
|
|
7893
8084
|
*/
|
|
7894
8085
|
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
|
|
7895
8086
|
/**
|
|
7896
|
-
* 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.
|
|
8087
|
+
* 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.
|
|
7897
8088
|
* @summary Plan Trajectory
|
|
7898
8089
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7899
8090
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -7907,23 +8098,23 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
|
|
|
7907
8098
|
*/
|
|
7908
8099
|
declare class TrajectoryPlanningApi extends BaseAPI {
|
|
7909
8100
|
/**
|
|
7910
|
-
* 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.
|
|
8101
|
+
* 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.
|
|
7911
8102
|
* @summary Plan Collision-Free Trajectory
|
|
7912
8103
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7913
8104
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
7914
8105
|
* @param {*} [options] Override http request option.
|
|
7915
8106
|
* @throws {RequiredError}
|
|
7916
8107
|
*/
|
|
7917
|
-
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8108
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
7918
8109
|
/**
|
|
7919
|
-
* 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.
|
|
8110
|
+
* 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.
|
|
7920
8111
|
* @summary Plan Trajectory
|
|
7921
8112
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7922
8113
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
7923
8114
|
* @param {*} [options] Override http request option.
|
|
7924
8115
|
* @throws {RequiredError}
|
|
7925
8116
|
*/
|
|
7926
|
-
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
8117
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
|
|
7927
8118
|
}
|
|
7928
8119
|
/**
|
|
7929
8120
|
* VersionApi - axios parameter creator
|
|
@@ -7971,7 +8162,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
7971
8162
|
* @param {*} [options] Override http request option.
|
|
7972
8163
|
* @throws {RequiredError}
|
|
7973
8164
|
*/
|
|
7974
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
8165
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ApiVersion, any>>;
|
|
7975
8166
|
}
|
|
7976
8167
|
/**
|
|
7977
8168
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -7988,6 +8179,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7988
8179
|
* @throws {RequiredError}
|
|
7989
8180
|
*/
|
|
7990
8181
|
addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8182
|
+
/**
|
|
8183
|
+
* 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.
|
|
8184
|
+
* @summary Add Motion Group
|
|
8185
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8186
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8187
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
8188
|
+
* @param {*} [options] Override http request option.
|
|
8189
|
+
* @throws {RequiredError}
|
|
8190
|
+
*/
|
|
8191
|
+
addVirtualControllerMotionGroup: (cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7991
8192
|
/**
|
|
7992
8193
|
* 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.
|
|
7993
8194
|
* @summary Add TCP
|
|
@@ -8011,6 +8212,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8011
8212
|
* @throws {RequiredError}
|
|
8012
8213
|
*/
|
|
8013
8214
|
deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8215
|
+
/**
|
|
8216
|
+
* 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**.
|
|
8217
|
+
* @summary Delete Motion Group
|
|
8218
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8219
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8220
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8221
|
+
* @param {*} [options] Override http request option.
|
|
8222
|
+
* @throws {RequiredError}
|
|
8223
|
+
*/
|
|
8224
|
+
deleteVirtualControllerMotionGroup: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8014
8225
|
/**
|
|
8015
8226
|
* 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.
|
|
8016
8227
|
* @summary Remove TCP
|
|
@@ -8023,7 +8234,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8023
8234
|
*/
|
|
8024
8235
|
deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8025
8236
|
/**
|
|
8026
|
-
* 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.
|
|
8237
|
+
* 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.
|
|
8027
8238
|
* @summary Get Emergency Stop State
|
|
8028
8239
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8029
8240
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8051,7 +8262,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8051
8262
|
*/
|
|
8052
8263
|
getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8053
8264
|
/**
|
|
8054
|
-
* 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.
|
|
8265
|
+
* 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.
|
|
8055
8266
|
* @summary Get Operation Mode
|
|
8056
8267
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8057
8268
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8089,7 +8300,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8089
8300
|
*/
|
|
8090
8301
|
listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8091
8302
|
/**
|
|
8092
|
-
* 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.
|
|
8303
|
+
* 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.
|
|
8093
8304
|
* @summary Push or Release Emergency Stop
|
|
8094
8305
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8095
8306
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8110,7 +8321,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8110
8321
|
*/
|
|
8111
8322
|
setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8112
8323
|
/**
|
|
8113
|
-
* 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.
|
|
8324
|
+
* 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.
|
|
8114
8325
|
* @summary Set Operation Mode
|
|
8115
8326
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8116
8327
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8146,6 +8357,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8146
8357
|
* @throws {RequiredError}
|
|
8147
8358
|
*/
|
|
8148
8359
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8360
|
+
/**
|
|
8361
|
+
* 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.
|
|
8362
|
+
* @summary Add Motion Group
|
|
8363
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8364
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8365
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
8366
|
+
* @param {*} [options] Override http request option.
|
|
8367
|
+
* @throws {RequiredError}
|
|
8368
|
+
*/
|
|
8369
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8149
8370
|
/**
|
|
8150
8371
|
* 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.
|
|
8151
8372
|
* @summary Add TCP
|
|
@@ -8169,6 +8390,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8169
8390
|
* @throws {RequiredError}
|
|
8170
8391
|
*/
|
|
8171
8392
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8393
|
+
/**
|
|
8394
|
+
* 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**.
|
|
8395
|
+
* @summary Delete Motion Group
|
|
8396
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8397
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8398
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8399
|
+
* @param {*} [options] Override http request option.
|
|
8400
|
+
* @throws {RequiredError}
|
|
8401
|
+
*/
|
|
8402
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8172
8403
|
/**
|
|
8173
8404
|
* 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.
|
|
8174
8405
|
* @summary Remove TCP
|
|
@@ -8181,7 +8412,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8181
8412
|
*/
|
|
8182
8413
|
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8183
8414
|
/**
|
|
8184
|
-
* 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.
|
|
8415
|
+
* 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.
|
|
8185
8416
|
* @summary Get Emergency Stop State
|
|
8186
8417
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8187
8418
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8209,7 +8440,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8209
8440
|
*/
|
|
8210
8441
|
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
|
|
8211
8442
|
/**
|
|
8212
|
-
* 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.
|
|
8443
|
+
* 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.
|
|
8213
8444
|
* @summary Get Operation Mode
|
|
8214
8445
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8215
8446
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8247,7 +8478,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8247
8478
|
*/
|
|
8248
8479
|
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
|
|
8249
8480
|
/**
|
|
8250
|
-
* 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.
|
|
8481
|
+
* 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.
|
|
8251
8482
|
* @summary Push or Release Emergency Stop
|
|
8252
8483
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8253
8484
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8268,7 +8499,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8268
8499
|
*/
|
|
8269
8500
|
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8270
8501
|
/**
|
|
8271
|
-
* 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.
|
|
8502
|
+
* 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.
|
|
8272
8503
|
* @summary Set Operation Mode
|
|
8273
8504
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8274
8505
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8304,6 +8535,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8304
8535
|
* @throws {RequiredError}
|
|
8305
8536
|
*/
|
|
8306
8537
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8538
|
+
/**
|
|
8539
|
+
* 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.
|
|
8540
|
+
* @summary Add Motion Group
|
|
8541
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8542
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8543
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
8544
|
+
* @param {*} [options] Override http request option.
|
|
8545
|
+
* @throws {RequiredError}
|
|
8546
|
+
*/
|
|
8547
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8307
8548
|
/**
|
|
8308
8549
|
* 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.
|
|
8309
8550
|
* @summary Add TCP
|
|
@@ -8327,6 +8568,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8327
8568
|
* @throws {RequiredError}
|
|
8328
8569
|
*/
|
|
8329
8570
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8571
|
+
/**
|
|
8572
|
+
* 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**.
|
|
8573
|
+
* @summary Delete Motion Group
|
|
8574
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8575
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8576
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8577
|
+
* @param {*} [options] Override http request option.
|
|
8578
|
+
* @throws {RequiredError}
|
|
8579
|
+
*/
|
|
8580
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8330
8581
|
/**
|
|
8331
8582
|
* 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.
|
|
8332
8583
|
* @summary Remove TCP
|
|
@@ -8339,7 +8590,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8339
8590
|
*/
|
|
8340
8591
|
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8341
8592
|
/**
|
|
8342
|
-
* 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.
|
|
8593
|
+
* 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.
|
|
8343
8594
|
* @summary Get Emergency Stop State
|
|
8344
8595
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8345
8596
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8367,7 +8618,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8367
8618
|
*/
|
|
8368
8619
|
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
|
|
8369
8620
|
/**
|
|
8370
|
-
* 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.
|
|
8621
|
+
* 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.
|
|
8371
8622
|
* @summary Get Operation Mode
|
|
8372
8623
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8373
8624
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8405,7 +8656,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8405
8656
|
*/
|
|
8406
8657
|
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
|
|
8407
8658
|
/**
|
|
8408
|
-
* 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.
|
|
8659
|
+
* 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.
|
|
8409
8660
|
* @summary Push or Release Emergency Stop
|
|
8410
8661
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8411
8662
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8426,7 +8677,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8426
8677
|
*/
|
|
8427
8678
|
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8428
8679
|
/**
|
|
8429
|
-
* 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.
|
|
8680
|
+
* 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.
|
|
8430
8681
|
* @summary Set Operation Mode
|
|
8431
8682
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8432
8683
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8461,7 +8712,17 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8461
8712
|
* @param {*} [options] Override http request option.
|
|
8462
8713
|
* @throws {RequiredError}
|
|
8463
8714
|
*/
|
|
8464
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
8715
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8716
|
+
/**
|
|
8717
|
+
* 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.
|
|
8718
|
+
* @summary Add Motion Group
|
|
8719
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8720
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8721
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
8722
|
+
* @param {*} [options] Override http request option.
|
|
8723
|
+
* @throws {RequiredError}
|
|
8724
|
+
*/
|
|
8725
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8465
8726
|
/**
|
|
8466
8727
|
* 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.
|
|
8467
8728
|
* @summary Add TCP
|
|
@@ -8473,7 +8734,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8473
8734
|
* @param {*} [options] Override http request option.
|
|
8474
8735
|
* @throws {RequiredError}
|
|
8475
8736
|
*/
|
|
8476
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
8737
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8477
8738
|
/**
|
|
8478
8739
|
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. <!-- theme: info --> > #### NOTE > > When a new coordinate system 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. > - Coordinate system 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 coordinate system may not yet be available for visualization or program execution.
|
|
8479
8740
|
* @summary Delete Coordinate System
|
|
@@ -8484,7 +8745,17 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8484
8745
|
* @param {*} [options] Override http request option.
|
|
8485
8746
|
* @throws {RequiredError}
|
|
8486
8747
|
*/
|
|
8487
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8748
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8749
|
+
/**
|
|
8750
|
+
* 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**.
|
|
8751
|
+
* @summary Delete Motion Group
|
|
8752
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8753
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8754
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8755
|
+
* @param {*} [options] Override http request option.
|
|
8756
|
+
* @throws {RequiredError}
|
|
8757
|
+
*/
|
|
8758
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8488
8759
|
/**
|
|
8489
8760
|
* 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.
|
|
8490
8761
|
* @summary Remove TCP
|
|
@@ -8495,16 +8766,16 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8495
8766
|
* @param {*} [options] Override http request option.
|
|
8496
8767
|
* @throws {RequiredError}
|
|
8497
8768
|
*/
|
|
8498
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
8769
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8499
8770
|
/**
|
|
8500
|
-
* 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.
|
|
8771
|
+
* 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.
|
|
8501
8772
|
* @summary Get Emergency Stop State
|
|
8502
8773
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8503
8774
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8504
8775
|
* @param {*} [options] Override http request option.
|
|
8505
8776
|
* @throws {RequiredError}
|
|
8506
8777
|
*/
|
|
8507
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8778
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Flag, any>>;
|
|
8508
8779
|
/**
|
|
8509
8780
|
* Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
8510
8781
|
* @summary Get Motion Group State
|
|
@@ -8514,7 +8785,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8514
8785
|
* @param {*} [options] Override http request option.
|
|
8515
8786
|
* @throws {RequiredError}
|
|
8516
8787
|
*/
|
|
8517
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8788
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupJoints, any>>;
|
|
8518
8789
|
/**
|
|
8519
8790
|
* Gets information on the motion group.
|
|
8520
8791
|
* @summary Motion Group Description
|
|
@@ -8523,16 +8794,16 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8523
8794
|
* @param {*} [options] Override http request option.
|
|
8524
8795
|
* @throws {RequiredError}
|
|
8525
8796
|
*/
|
|
8526
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8797
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
|
|
8527
8798
|
/**
|
|
8528
|
-
* 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.
|
|
8799
|
+
* 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.
|
|
8529
8800
|
* @summary Get Operation Mode
|
|
8530
8801
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8531
8802
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8532
8803
|
* @param {*} [options] Override http request option.
|
|
8533
8804
|
* @throws {RequiredError}
|
|
8534
8805
|
*/
|
|
8535
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8806
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<OpMode, any>>;
|
|
8536
8807
|
/**
|
|
8537
8808
|
* Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
8538
8809
|
* @summary Get Mounting
|
|
@@ -8542,7 +8813,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8542
8813
|
* @param {*} [options] Override http request option.
|
|
8543
8814
|
* @throws {RequiredError}
|
|
8544
8815
|
*/
|
|
8545
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8816
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8546
8817
|
/**
|
|
8547
8818
|
* Lists all coordinate systems on the robot controller.
|
|
8548
8819
|
* @summary List Coordinate Systems
|
|
@@ -8551,7 +8822,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8551
8822
|
* @param {*} [options] Override http request option.
|
|
8552
8823
|
* @throws {RequiredError}
|
|
8553
8824
|
*/
|
|
8554
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
8825
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem[], any>>;
|
|
8555
8826
|
/**
|
|
8556
8827
|
* Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
8557
8828
|
* @summary List TCPs
|
|
@@ -8561,9 +8832,9 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8561
8832
|
* @param {*} [options] Override http request option.
|
|
8562
8833
|
* @throws {RequiredError}
|
|
8563
8834
|
*/
|
|
8564
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8835
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
|
|
8565
8836
|
/**
|
|
8566
|
-
* 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.
|
|
8837
|
+
* 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.
|
|
8567
8838
|
* @summary Push or Release Emergency Stop
|
|
8568
8839
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8569
8840
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8571,7 +8842,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8571
8842
|
* @param {*} [options] Override http request option.
|
|
8572
8843
|
* @throws {RequiredError}
|
|
8573
8844
|
*/
|
|
8574
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
8845
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8575
8846
|
/**
|
|
8576
8847
|
* Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. <!-- theme: info --> > #### NOTE > > Only use the endpoint when the motion group is in monitor mode. If the motion group is controlled, currently jogging or planning motions, > the values are overridden by the controller or an error may occur.
|
|
8577
8848
|
* @summary Set Motion Group State
|
|
@@ -8582,9 +8853,9 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8582
8853
|
* @param {*} [options] Override http request option.
|
|
8583
8854
|
* @throws {RequiredError}
|
|
8584
8855
|
*/
|
|
8585
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
8856
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8586
8857
|
/**
|
|
8587
|
-
* 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.
|
|
8858
|
+
* 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.
|
|
8588
8859
|
* @summary Set Operation Mode
|
|
8589
8860
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8590
8861
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8592,7 +8863,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8592
8863
|
* @param {*} [options] Override http request option.
|
|
8593
8864
|
* @throws {RequiredError}
|
|
8594
8865
|
*/
|
|
8595
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
8866
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8596
8867
|
/**
|
|
8597
8868
|
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. <!-- theme: info --> > #### Changing the mounting configuration is considered a setup change > > When the mounting is set to a new coordinate system, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or not reflect the new mounting immediately. > - Motion group state and coordinate system alignment may not be 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**. > A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
8598
8869
|
* @summary Set Mounting
|
|
@@ -8603,14 +8874,14 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8603
8874
|
* @param {*} [options] Override http request option.
|
|
8604
8875
|
* @throws {RequiredError}
|
|
8605
8876
|
*/
|
|
8606
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
8877
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CoordinateSystem, any>>;
|
|
8607
8878
|
}
|
|
8608
8879
|
/**
|
|
8609
8880
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
8610
8881
|
*/
|
|
8611
8882
|
declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8612
8883
|
/**
|
|
8613
|
-
* <!-- 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.
|
|
8884
|
+
* <!-- 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.
|
|
8614
8885
|
* @summary Stream Joint Configuration
|
|
8615
8886
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8616
8887
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8629,7 +8900,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
|
|
|
8629
8900
|
*/
|
|
8630
8901
|
getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8631
8902
|
/**
|
|
8632
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
8903
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
8633
8904
|
* @summary Get Behavior
|
|
8634
8905
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8635
8906
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8653,7 +8924,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
|
|
|
8653
8924
|
*/
|
|
8654
8925
|
declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
|
|
8655
8926
|
/**
|
|
8656
|
-
* <!-- 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.
|
|
8927
|
+
* <!-- 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.
|
|
8657
8928
|
* @summary Stream Joint Configuration
|
|
8658
8929
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8659
8930
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8672,7 +8943,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
|
|
|
8672
8943
|
*/
|
|
8673
8944
|
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
|
|
8674
8945
|
/**
|
|
8675
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
8946
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
8676
8947
|
* @summary Get Behavior
|
|
8677
8948
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8678
8949
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8696,7 +8967,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
|
|
|
8696
8967
|
*/
|
|
8697
8968
|
declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8698
8969
|
/**
|
|
8699
|
-
* <!-- 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.
|
|
8970
|
+
* <!-- 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.
|
|
8700
8971
|
* @summary Stream Joint Configuration
|
|
8701
8972
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8702
8973
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8715,7 +8986,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
|
|
|
8715
8986
|
*/
|
|
8716
8987
|
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
|
|
8717
8988
|
/**
|
|
8718
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
8989
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
8719
8990
|
* @summary Get Behavior
|
|
8720
8991
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8721
8992
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8739,7 +9010,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
|
|
|
8739
9010
|
*/
|
|
8740
9011
|
declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
8741
9012
|
/**
|
|
8742
|
-
* <!-- 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.
|
|
9013
|
+
* <!-- 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.
|
|
8743
9014
|
* @summary Stream Joint Configuration
|
|
8744
9015
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8745
9016
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8747,7 +9018,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8747
9018
|
* @param {*} [options] Override http request option.
|
|
8748
9019
|
* @throws {RequiredError}
|
|
8749
9020
|
*/
|
|
8750
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9021
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ExternalJointStreamDatapoint[], any>>;
|
|
8751
9022
|
/**
|
|
8752
9023
|
* Get the cycle time of controller communication in [ms].
|
|
8753
9024
|
* @summary Get Cycle Time
|
|
@@ -8756,16 +9027,16 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8756
9027
|
* @param {*} [options] Override http request option.
|
|
8757
9028
|
* @throws {RequiredError}
|
|
8758
9029
|
*/
|
|
8759
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9030
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
8760
9031
|
/**
|
|
8761
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
9032
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
8762
9033
|
* @summary Get Behavior
|
|
8763
9034
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8764
9035
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8765
9036
|
* @param {*} [options] Override http request option.
|
|
8766
9037
|
* @throws {RequiredError}
|
|
8767
9038
|
*/
|
|
8768
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9039
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<Behavior, any>>;
|
|
8769
9040
|
/**
|
|
8770
9041
|
* Set virtual controller behavior. See query parameters for details.
|
|
8771
9042
|
* @summary Set Behavior
|
|
@@ -8775,14 +9046,14 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8775
9046
|
* @param {*} [options] Override http request option.
|
|
8776
9047
|
* @throws {RequiredError}
|
|
8777
9048
|
*/
|
|
8778
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
9049
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8779
9050
|
}
|
|
8780
9051
|
/**
|
|
8781
9052
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
8782
9053
|
*/
|
|
8783
9054
|
declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8784
9055
|
/**
|
|
8785
|
-
* 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).
|
|
9056
|
+
* 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).
|
|
8786
9057
|
* @summary Get Input/Output Values
|
|
8787
9058
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8788
9059
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8820,7 +9091,7 @@ declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration
|
|
|
8820
9091
|
*/
|
|
8821
9092
|
declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
8822
9093
|
/**
|
|
8823
|
-
* 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).
|
|
9094
|
+
* 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).
|
|
8824
9095
|
* @summary Get Input/Output Values
|
|
8825
9096
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8826
9097
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8858,7 +9129,7 @@ declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuratio
|
|
|
8858
9129
|
*/
|
|
8859
9130
|
declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8860
9131
|
/**
|
|
8861
|
-
* 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).
|
|
9132
|
+
* 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).
|
|
8862
9133
|
* @summary Get Input/Output Values
|
|
8863
9134
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8864
9135
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8896,7 +9167,7 @@ declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configu
|
|
|
8896
9167
|
*/
|
|
8897
9168
|
declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
8898
9169
|
/**
|
|
8899
|
-
* 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).
|
|
9170
|
+
* 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).
|
|
8900
9171
|
* @summary Get Input/Output Values
|
|
8901
9172
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8902
9173
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8904,7 +9175,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8904
9175
|
* @param {*} [options] Override http request option.
|
|
8905
9176
|
* @throws {RequiredError}
|
|
8906
9177
|
*/
|
|
8907
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
9178
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
8908
9179
|
/**
|
|
8909
9180
|
* Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the virtual robot controller.\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
|
|
8910
9181
|
* @summary List Descriptions
|
|
@@ -8917,7 +9188,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8917
9188
|
* @param {*} [options] Override http request option.
|
|
8918
9189
|
* @throws {RequiredError}
|
|
8919
9190
|
*/
|
|
8920
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
9191
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
8921
9192
|
/**
|
|
8922
9193
|
* Sets a list of values of a virtual controller inputs/outputs.
|
|
8923
9194
|
* @summary Set Input/Ouput Values
|
|
@@ -8927,7 +9198,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8927
9198
|
* @param {*} [options] Override http request option.
|
|
8928
9199
|
* @throws {RequiredError}
|
|
8929
9200
|
*/
|
|
8930
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
9201
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8931
9202
|
}
|
|
8932
9203
|
//#endregion
|
|
8933
|
-
export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddTrajectoryError, AddTrajectoryErrorData, AddTrajectoryRequest, AddTrajectoryResponse, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionFreeAlgorithm, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, FloatValue, FloatValueValueTypeEnum, ForwardKinematics422Response, ForwardKinematicsRequest, ForwardKinematicsResponse, ForwardKinematicsValidationError, GetTrajectoryResponse, HTTPValidationError, IOBooleanValue, IOBooleanValueValueTypeEnum, IOBoundary, IODescription, IODirection, IOFloatValue, IOFloatValueValueTypeEnum, IOIntegerValue, IOIntegerValueValueTypeEnum, IOOrigin, IOValue, IOValueType, ImageCredentials, InconsistentTrajectorySizeError, InconsistentTrajectorySizeErrorInconsistentTrajectorySize, InitializeJoggingRequest, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponse, InitializeJoggingResponseKindEnum, InitializeMovementRequest, InitializeMovementRequestMessageTypeEnum, InitializeMovementRequestTrajectory, InitializeMovementResponse, InitializeMovementResponseKindEnum, IntegerValue, IntegerValueValueTypeEnum, InvalidDofError, InvalidDofErrorInvalidDof, InverseKinematics422Response, InverseKinematicsRequest, InverseKinematicsResponse, InverseKinematicsValidationError, InverseKinematicsValidationErrorAllOfData, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetails, JoggingDetailsKindEnum, JoggingDetailsState, JoggingPausedByUser, JoggingPausedByUserKindEnum, JoggingPausedNearCollision, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimit, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimits, JointTrajectory, JointVelocityRequest, JointVelocityRequestMessageTypeEnum, JointVelocityResponse, JointVelocityResponseKindEnum, KinematicModel, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, NanValueError, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseJoggingRequest, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponse, PauseJoggingResponseKindEnum, PauseMovementRequest, PauseMovementRequestMessageTypeEnum, PauseMovementResponse, PauseMovementResponseKindEnum, PauseOnIO, Payload, Plan422Response, PlanCollisionFreeFailedResponse, PlanCollisionFreeRequest, PlanCollisionFreeResponse, PlanCollisionFreeResponseResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, PlanValidationError, PlanValidationErrorAllOfData, Plane, PlaneShapeTypeEnum, PlaybackSpeedRequest, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponse, PlaybackSpeedResponseKindEnum, Pose, ProfinetDescription, ProfinetIO, ProfinetIOData, ProfinetIODirection, ProfinetIOTypeEnum, ProfinetInputOutputConfig, ProfinetSlotDescription, ProfinetSubSlotDescription, Program, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRun, ProgramRunState, ProgramStartRequest, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyStateType, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, TcpVelocityRequest, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponse, TcpVelocityResponseKindEnum, TorqueExceededError, TorqueExceededErrorTorqueExceeded, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryData, TrajectoryDataMessageTypeEnum, TrajectoryDetails, TrajectoryDetailsKindEnum, TrajectoryDetailsState, TrajectoryEnded, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryId, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUser, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIO, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunning, TrajectoryRunningKindEnum, TrajectoryWaitForIO, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateNovaVersionRequest, ValidationError, ValidationError2, ValidationErrorLocInner, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualController, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|
|
9204
|
+
export { AbbController, AbbControllerEgmServer, AbbControllerKindEnum, ActivateLicenseRequest, AddTrajectoryError, AddTrajectoryErrorData, AddTrajectoryRequest, AddTrajectoryResponse, AddVirtualControllerMotionGroupRequest, ApiVersion, App, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAuto, BlendingAutoBlendingNameEnum, BlendingPosition, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValue, BooleanValueValueTypeEnum, Box, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIODescription, BusIOModbusClient, BusIOModbusClientBusTypeEnum, BusIOModbusServer, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClient, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServer, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtual, BusIOModbusVirtualBusTypeEnum, BusIOProfinet, BusIOProfinetBusTypeEnum, BusIOProfinetDefaultRoute, BusIOProfinetIpConfig, BusIOProfinetNetwork, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionErrorKindEnum, CollisionFreeAlgorithm, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, Flag, FloatValue, FloatValueValueTypeEnum, ForwardKinematics422Response, ForwardKinematicsRequest, ForwardKinematicsResponse, ForwardKinematicsValidationError, GetTrajectoryResponse, HTTPValidationError, IOBooleanValue, IOBooleanValueValueTypeEnum, IOBoundary, IODescription, IODirection, IOFloatValue, IOFloatValueValueTypeEnum, IOIntegerValue, IOIntegerValueValueTypeEnum, IOOrigin, IOValue, IOValueType, ImageCredentials, InconsistentTrajectorySizeError, InconsistentTrajectorySizeErrorInconsistentTrajectorySize, InconsistentTrajectorySizeErrorKindEnum, InitializeJoggingRequest, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponse, InitializeJoggingResponseKindEnum, InitializeMovementRequest, InitializeMovementRequestMessageTypeEnum, InitializeMovementRequestTrajectory, InitializeMovementResponse, InitializeMovementResponseKindEnum, IntegerValue, IntegerValueValueTypeEnum, InvalidDofError, InvalidDofErrorInvalidDof, InvalidDofErrorKindEnum, InverseKinematics422Response, InverseKinematicsRequest, InverseKinematicsResponse, InverseKinematicsValidationError, InverseKinematicsValidationErrorAllOfData, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetails, JoggingDetailsKindEnum, JoggingDetailsState, JoggingPausedByUser, JoggingPausedByUserKindEnum, JoggingPausedNearCollision, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimit, JoggingPausedNearJointLimitKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimitExceededErrorKindEnum, JointLimits, JointTrajectory, JointTypeEnum, JointVelocityRequest, JointVelocityRequestMessageTypeEnum, JointVelocityResponse, JointVelocityResponseKindEnum, KinematicModel, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaController, KukaControllerKindEnum, KukaControllerRsiServer, License, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatus, LicenseStatusEnum, LimitRange, LimitSet, LimitsOverride, ListTrajectoriesResponse, Manufacturer, MidpointInsertionAlgorithm, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIO, ModbusIOArea, ModbusIOByteOrder, ModbusIOData, ModbusIOTypeEnum, ModelError, MotionCommand, MotionCommandBlending, MotionCommandPath, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupDescription, MotionGroupFromJson, MotionGroupFromType, MotionGroupInfo, MotionGroupJoints, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MotionGroupSetup, MotionGroupState, MotionGroupStateJointLimitReached, MovementErrorResponse, MovementErrorResponseKindEnum, NanValueError, NanValueErrorKindEnum, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathJointPTP, PathJointPTPPathDefinitionNameEnum, PathLine, PathLinePathDefinitionNameEnum, PauseJoggingRequest, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponse, PauseJoggingResponseKindEnum, PauseMovementRequest, PauseMovementRequestMessageTypeEnum, PauseMovementResponse, PauseMovementResponseKindEnum, PauseOnIO, Payload, Plan422Response, PlanCollisionFreeFailedResponse, PlanCollisionFreeRequest, PlanCollisionFreeResponse, PlanCollisionFreeResponseResponse, PlanTrajectoryFailedResponse, PlanTrajectoryFailedResponseErrorFeedback, PlanTrajectoryRequest, PlanTrajectoryResponse, PlanTrajectoryResponseResponse, PlanValidationError, PlanValidationErrorAllOfData, Plane, PlaneShapeTypeEnum, PlaybackSpeedRequest, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponse, PlaybackSpeedResponseKindEnum, Pose, ProfinetDescription, ProfinetIO, ProfinetIOData, ProfinetIODirection, ProfinetIOTypeEnum, ProfinetInputOutputConfig, ProfinetSlotDescription, ProfinetSubSlotDescription, Program, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRun, ProgramRunState, ProgramStartRequest, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyStateType, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SetIO, SettableRobotSystemMode, SingularityTypeEnum, Sphere, SphereShapeTypeEnum, StartMovementRequest, StartMovementRequestMessageTypeEnum, StartMovementResponse, StartMovementResponseKindEnum, StartOnIO, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, StreamIOValuesResponse, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpOffset, TcpRequiredError, TcpRequiredErrorKindEnum, TcpVelocityRequest, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponse, TcpVelocityResponseKindEnum, TorqueExceededError, TorqueExceededErrorKindEnum, TorqueExceededErrorTorqueExceeded, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryData, TrajectoryDataMessageTypeEnum, TrajectoryDetails, TrajectoryDetailsKindEnum, TrajectoryDetailsState, TrajectoryEnded, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryId, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUser, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIO, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunning, TrajectoryRunningKindEnum, TrajectoryWaitForIO, TrajectoryWaitForIOKindEnum, UnitType, UniversalrobotsController, UniversalrobotsControllerKindEnum, UpdateCellVersionRequest, UpdateNovaVersionRequest, ValidationError, ValidationError2, ValidationErrorLocInner, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualController, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, VirtualRobotConfiguration, WaitForIOEventRequest, YaskawaController, YaskawaControllerKindEnum, operationServerMap };
|