@wandelbots/nova-api 26.2.0-dev.9 → 26.3.0-dev.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/v1/index.cjs +60 -243
- package/dist/v1/index.d.cts +433 -433
- package/dist/v1/index.d.ts +433 -433
- package/dist/v1/index.js +60 -243
- package/dist/v2/index.cjs +399 -227
- package/dist/v2/index.d.cts +640 -223
- package/dist/v2/index.d.ts +780 -363
- package/dist/v2/index.js +392 -228
- package/package.json +1 -1
package/dist/v2/index.d.cts
CHANGED
|
@@ -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.2.0
|
|
10
|
+
* The version of the OpenAPI document: 2.2.0
|
|
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
|
}
|
|
@@ -1723,6 +1776,72 @@ declare const Manufacturer: {
|
|
|
1723
1776
|
readonly Yaskawa: "yaskawa";
|
|
1724
1777
|
};
|
|
1725
1778
|
type Manufacturer = typeof Manufacturer[keyof typeof Manufacturer];
|
|
1779
|
+
interface MergeTrajectories422Response {
|
|
1780
|
+
'detail'?: Array<MergeTrajectoriesValidationError>;
|
|
1781
|
+
}
|
|
1782
|
+
interface MergeTrajectoriesError {
|
|
1783
|
+
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
1784
|
+
/**
|
|
1785
|
+
* - 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
|
|
1786
|
+
*/
|
|
1787
|
+
'error_location_on_trajectory': number;
|
|
1788
|
+
}
|
|
1789
|
+
interface MergeTrajectoriesRequest {
|
|
1790
|
+
/**
|
|
1791
|
+
* The motion group setup required for collision checking and timescaling.
|
|
1792
|
+
*/
|
|
1793
|
+
'motion_group_setup': MotionGroupSetup;
|
|
1794
|
+
/**
|
|
1795
|
+
* List of trajectory segments to merge together. Each segment contains a trajectory with its own limits override, blending configuration and collision setup.
|
|
1796
|
+
*/
|
|
1797
|
+
'trajectory_segments': Array<MergeTrajectoriesSegment>;
|
|
1798
|
+
}
|
|
1799
|
+
interface MergeTrajectoriesResponse {
|
|
1800
|
+
/**
|
|
1801
|
+
* The merged joint trajectory. If a blending was requested on a segment but could not be applied, the trajectory is merged without blending. The feedback will contain further information on why blending could not be applied.
|
|
1802
|
+
*/
|
|
1803
|
+
'joint_trajectory'?: JointTrajectory;
|
|
1804
|
+
/**
|
|
1805
|
+
* For each blending, feedback will either contain the section in which the trajectory deviates from the original path, or an error message stating why blending could not be applied. The response will include `trajectory_segments` - 1 elements. If no blending was requested at the corresponding segment, the feedback will be a null section where `start_location == end_location`.
|
|
1806
|
+
*/
|
|
1807
|
+
'feedback'?: Array<MergeTrajectoriesResponseFeedbackInner>;
|
|
1808
|
+
}
|
|
1809
|
+
/**
|
|
1810
|
+
* @type MergeTrajectoriesResponseFeedbackInner
|
|
1811
|
+
*/
|
|
1812
|
+
type MergeTrajectoriesResponseFeedbackInner = MergeTrajectoriesError | TrajectorySection;
|
|
1813
|
+
interface MergeTrajectoriesSegment {
|
|
1814
|
+
/**
|
|
1815
|
+
* The trajectory segment to merge. Both the time and location arrays must start at 0 and be strictly increasing.
|
|
1816
|
+
*/
|
|
1817
|
+
'trajectory': JointTrajectory;
|
|
1818
|
+
/**
|
|
1819
|
+
* Limits override is used to override the global limits of the motion group for the blending at the end of this segment.
|
|
1820
|
+
*/
|
|
1821
|
+
'limits_override'?: LimitsOverride;
|
|
1822
|
+
/**
|
|
1823
|
+
* Blending configuration for merging this trajectory segment with the next one. Specifies how the end of this trajectory should be blended with the start of the next trajectory. Ignored for the last segment.
|
|
1824
|
+
*/
|
|
1825
|
+
'blending'?: BlendingPosition;
|
|
1826
|
+
/**
|
|
1827
|
+
* Collision layers to be respected by the motion planner when planning for a single motion group. Each setup represents one layer, e.g., the safety zones and shapes or a fine grained tool and workpiece model. Layers are checked individually along the trajectory and independently of other layers. To respect the safety zones of the controller and check for collision: 1. Fetch the safety zones, link and tool shapes from the controller. 2. Add the fetched zones, links and tools to a layer. 3. Create other layers from your own 3D data as needed. 4. Plan trajectory. 5. The response highlights the layer in which a collision was detected by key.
|
|
1828
|
+
*/
|
|
1829
|
+
'collision_setups'?: {
|
|
1830
|
+
[key: string]: CollisionSetup;
|
|
1831
|
+
};
|
|
1832
|
+
}
|
|
1833
|
+
interface MergeTrajectoriesValidationError {
|
|
1834
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
1835
|
+
'msg': string;
|
|
1836
|
+
'type': string;
|
|
1837
|
+
'input': {
|
|
1838
|
+
[key: string]: any;
|
|
1839
|
+
};
|
|
1840
|
+
/**
|
|
1841
|
+
* Optional data further specifying the merge validation error.
|
|
1842
|
+
*/
|
|
1843
|
+
'data'?: ErrorInvalidJointCount;
|
|
1844
|
+
}
|
|
1726
1845
|
interface MidpointInsertionAlgorithm {
|
|
1727
1846
|
/**
|
|
1728
1847
|
* Algorithm discriminator. Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths.
|
|
@@ -1833,11 +1952,11 @@ type MotionCommandBlending = BlendingAuto | BlendingPosition;
|
|
|
1833
1952
|
*/
|
|
1834
1953
|
type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
|
|
1835
1954
|
/**
|
|
1836
|
-
* The configuration of a motion-group used for motion planning.
|
|
1955
|
+
* 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
1956
|
*/
|
|
1838
1957
|
interface MotionGroupDescription {
|
|
1839
1958
|
/**
|
|
1840
|
-
*
|
|
1959
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
1841
1960
|
*/
|
|
1842
1961
|
'motion_group_model': string;
|
|
1843
1962
|
/**
|
|
@@ -1882,14 +2001,50 @@ interface MotionGroupDescription {
|
|
|
1882
2001
|
*/
|
|
1883
2002
|
'cycle_time'?: number;
|
|
1884
2003
|
/**
|
|
1885
|
-
* The
|
|
2004
|
+
* The Denavit-Hartenberg parameters describing the motion group kinematics.
|
|
1886
2005
|
*/
|
|
1887
2006
|
'dh_parameters'?: Array<DHParameter>;
|
|
2007
|
+
/**
|
|
2008
|
+
* 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.
|
|
2009
|
+
*/
|
|
2010
|
+
'kinematic_chain_offset'?: Pose;
|
|
1888
2011
|
/**
|
|
1889
2012
|
* The serial number of the motion group, if available. If not available, the serial number of the robot controller. If not available, empty.
|
|
1890
2013
|
*/
|
|
1891
2014
|
'serial_number'?: string;
|
|
1892
2015
|
}
|
|
2016
|
+
interface MotionGroupFromJson {
|
|
2017
|
+
/**
|
|
2018
|
+
* Unique identifier for the motion group to be added.
|
|
2019
|
+
*/
|
|
2020
|
+
'motion_group': string;
|
|
2021
|
+
/**
|
|
2022
|
+
* Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration).
|
|
2023
|
+
*/
|
|
2024
|
+
'json_data': string;
|
|
2025
|
+
/**
|
|
2026
|
+
* The identifier of the motion group that needs to be extracted from the provided JSON configuration.
|
|
2027
|
+
*/
|
|
2028
|
+
'extracted_motion_group_id': string;
|
|
2029
|
+
/**
|
|
2030
|
+
* 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.
|
|
2031
|
+
*/
|
|
2032
|
+
'initial_joint_position'?: string;
|
|
2033
|
+
}
|
|
2034
|
+
interface MotionGroupFromType {
|
|
2035
|
+
/**
|
|
2036
|
+
* Unique identifier for the motion group to be added.
|
|
2037
|
+
*/
|
|
2038
|
+
'motion_group': string;
|
|
2039
|
+
/**
|
|
2040
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
2041
|
+
*/
|
|
2042
|
+
'motion_group_model': string;
|
|
2043
|
+
/**
|
|
2044
|
+
* 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.
|
|
2045
|
+
*/
|
|
2046
|
+
'initial_joint_position'?: string;
|
|
2047
|
+
}
|
|
1893
2048
|
interface MotionGroupInfo {
|
|
1894
2049
|
/**
|
|
1895
2050
|
* The unique identifier of the motion group. Use it to refer to the motion group in other calls.
|
|
@@ -1905,7 +2060,7 @@ interface MotionGroupInfo {
|
|
|
1905
2060
|
'dof': number;
|
|
1906
2061
|
}
|
|
1907
2062
|
/**
|
|
1908
|
-
* Ensure to provide one value for each joint. See [getMotionGroups](getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
2063
|
+
* Ensure to provide one value for each joint. See [getMotionGroups](#/operations/getMotionGroups) for the number of joints. Everything but positions is optional.
|
|
1909
2064
|
*/
|
|
1910
2065
|
interface MotionGroupJoints {
|
|
1911
2066
|
/**
|
|
@@ -1927,7 +2082,7 @@ interface MotionGroupJoints {
|
|
|
1927
2082
|
}
|
|
1928
2083
|
interface MotionGroupSetup {
|
|
1929
2084
|
/**
|
|
1930
|
-
*
|
|
2085
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
1931
2086
|
*/
|
|
1932
2087
|
'motion_group_model': string;
|
|
1933
2088
|
/**
|
|
@@ -1985,7 +2140,7 @@ interface MotionGroupState {
|
|
|
1985
2140
|
*/
|
|
1986
2141
|
'joint_current'?: Array<number>;
|
|
1987
2142
|
/**
|
|
1988
|
-
* Pose of the flange. Positions are in [mm].
|
|
2143
|
+
* 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
2144
|
*/
|
|
1990
2145
|
'flange_pose'?: Pose;
|
|
1991
2146
|
/**
|
|
@@ -1993,7 +2148,7 @@ interface MotionGroupState {
|
|
|
1993
2148
|
*/
|
|
1994
2149
|
'tcp'?: string;
|
|
1995
2150
|
/**
|
|
1996
|
-
* Pose of the TCP selected on the robot control panel. Positions are in [mm].
|
|
2151
|
+
* 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
2152
|
*/
|
|
1998
2153
|
'tcp_pose'?: Pose;
|
|
1999
2154
|
/**
|
|
@@ -2037,8 +2192,13 @@ declare const MovementErrorResponseKindEnum: {
|
|
|
2037
2192
|
};
|
|
2038
2193
|
type MovementErrorResponseKindEnum = typeof MovementErrorResponseKindEnum[keyof typeof MovementErrorResponseKindEnum];
|
|
2039
2194
|
interface NanValueError {
|
|
2195
|
+
'kind': NanValueErrorKindEnum;
|
|
2040
2196
|
'nan_value'?: NanValueErrorNanValue;
|
|
2041
2197
|
}
|
|
2198
|
+
declare const NanValueErrorKindEnum: {
|
|
2199
|
+
readonly NanValueError: "NanValueError";
|
|
2200
|
+
};
|
|
2201
|
+
type NanValueErrorKindEnum = typeof NanValueErrorKindEnum[keyof typeof NanValueErrorKindEnum];
|
|
2042
2202
|
/**
|
|
2043
2203
|
* Requested joint position contains NaN values.
|
|
2044
2204
|
*/
|
|
@@ -2279,11 +2439,11 @@ declare const PauseMovementRequestMessageTypeEnum: {
|
|
|
2279
2439
|
};
|
|
2280
2440
|
type PauseMovementRequestMessageTypeEnum = typeof PauseMovementRequestMessageTypeEnum[keyof typeof PauseMovementRequestMessageTypeEnum];
|
|
2281
2441
|
/**
|
|
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 [
|
|
2442
|
+
* 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
2443
|
*/
|
|
2284
2444
|
interface PauseMovementResponse {
|
|
2285
2445
|
/**
|
|
2286
|
-
* Error message in case of invalid
|
|
2446
|
+
* Error message in case of invalid PauseMovementRequest.
|
|
2287
2447
|
*/
|
|
2288
2448
|
'message'?: string;
|
|
2289
2449
|
'kind': PauseMovementResponseKindEnum;
|
|
@@ -2329,7 +2489,7 @@ interface PlanCollisionFreeFailedResponse {
|
|
|
2329
2489
|
}
|
|
2330
2490
|
interface PlanCollisionFreeRequest {
|
|
2331
2491
|
/**
|
|
2332
|
-
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
2492
|
+
* The data to assemble the robot setup can be retrieved from the [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
|
|
2333
2493
|
*/
|
|
2334
2494
|
'motion_group_setup': MotionGroupSetup;
|
|
2335
2495
|
'start_joint_position': Array<number>;
|
|
@@ -2349,7 +2509,7 @@ type PlanCollisionFreeResponseResponse = JointTrajectory | PlanCollisionFreeFail
|
|
|
2349
2509
|
interface PlanTrajectoryFailedResponse {
|
|
2350
2510
|
'error_feedback': PlanTrajectoryFailedResponseErrorFeedback;
|
|
2351
2511
|
/**
|
|
2352
|
-
*
|
|
2512
|
+
* - 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
2513
|
*/
|
|
2354
2514
|
'error_location_on_trajectory': number;
|
|
2355
2515
|
/**
|
|
@@ -2363,7 +2523,7 @@ interface PlanTrajectoryFailedResponse {
|
|
|
2363
2523
|
type PlanTrajectoryFailedResponseErrorFeedback = FeedbackCollision | FeedbackJointLimitExceeded | FeedbackOutOfWorkspace | FeedbackSingularity;
|
|
2364
2524
|
interface PlanTrajectoryRequest {
|
|
2365
2525
|
/**
|
|
2366
|
-
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](getMotionGroupDescription) endpoint.
|
|
2526
|
+
* The data to assemble the robot setup can be retrieved from [getMotionGroupDescription](#/operations/getMotionGroupDescription) endpoint.
|
|
2367
2527
|
*/
|
|
2368
2528
|
'motion_group_setup': MotionGroupSetup;
|
|
2369
2529
|
'start_joint_position': Array<number>;
|
|
@@ -2730,7 +2890,7 @@ declare const RectangularCapsuleShapeTypeEnum: {
|
|
|
2730
2890
|
};
|
|
2731
2891
|
type RectangularCapsuleShapeTypeEnum = typeof RectangularCapsuleShapeTypeEnum[keyof typeof RectangularCapsuleShapeTypeEnum];
|
|
2732
2892
|
/**
|
|
2733
|
-
* The channel that defines what a new Wandelbots NOVA version is. * `next` the
|
|
2893
|
+
* The channel that defines what a new Wandelbots NOVA version is. * `next` the latest version * `stable` newest patch of the current version
|
|
2734
2894
|
*/
|
|
2735
2895
|
declare const ReleaseChannel: {
|
|
2736
2896
|
readonly Stable: "stable";
|
|
@@ -2751,6 +2911,19 @@ interface RobotController {
|
|
|
2751
2911
|
* @type RobotControllerConfiguration
|
|
2752
2912
|
*/
|
|
2753
2913
|
type RobotControllerConfiguration = AbbController | FanucController | KukaController | UniversalrobotsController | VirtualController | YaskawaController;
|
|
2914
|
+
/**
|
|
2915
|
+
* Information to generate all robot controller configurations that match a given ARP scan result.
|
|
2916
|
+
*/
|
|
2917
|
+
interface RobotControllerConfigurationRequest {
|
|
2918
|
+
/**
|
|
2919
|
+
* The IPv4 address assigned to the network interface where the ARP scan was performed.
|
|
2920
|
+
*/
|
|
2921
|
+
'ip': string;
|
|
2922
|
+
/**
|
|
2923
|
+
* Array of network devices.
|
|
2924
|
+
*/
|
|
2925
|
+
'network_devices': Array<NetworkDevice>;
|
|
2926
|
+
}
|
|
2754
2927
|
/**
|
|
2755
2928
|
* Returns the whole current state of robot controller.
|
|
2756
2929
|
*/
|
|
@@ -2787,7 +2960,7 @@ interface RobotControllerState {
|
|
|
2787
2960
|
'motion_groups': Array<MotionGroupState>;
|
|
2788
2961
|
}
|
|
2789
2962
|
/**
|
|
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.
|
|
2963
|
+
* 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
2964
|
*/
|
|
2792
2965
|
declare const RobotSystemMode: {
|
|
2793
2966
|
readonly ModeControllerNotConfigured: "MODE_CONTROLLER_NOT_CONFIGURED";
|
|
@@ -2912,7 +3085,7 @@ interface SetIO {
|
|
|
2912
3085
|
'io_origin': IOOrigin;
|
|
2913
3086
|
}
|
|
2914
3087
|
/**
|
|
2915
|
-
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](getMode) responses.
|
|
3088
|
+
* Defines available system modes of the robot system. Short versions (no \"ROBOT_SYSTEM_\" prefix) are provided, reusing strings from [getMode](#/operations/getMode) responses.
|
|
2916
3089
|
*/
|
|
2917
3090
|
declare const SettableRobotSystemMode: {
|
|
2918
3091
|
readonly RobotSystemModeMonitor: "ROBOT_SYSTEM_MODE_MONITOR";
|
|
@@ -2942,7 +3115,7 @@ declare const SphereShapeTypeEnum: {
|
|
|
2942
3115
|
};
|
|
2943
3116
|
type SphereShapeTypeEnum = typeof SphereShapeTypeEnum[keyof typeof SphereShapeTypeEnum];
|
|
2944
3117
|
/**
|
|
2945
|
-
* 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.
|
|
3118
|
+
* 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.
|
|
2946
3119
|
*/
|
|
2947
3120
|
interface StartMovementRequest {
|
|
2948
3121
|
/**
|
|
@@ -2951,7 +3124,7 @@ interface StartMovementRequest {
|
|
|
2951
3124
|
'message_type': StartMovementRequestMessageTypeEnum;
|
|
2952
3125
|
'direction'?: Direction;
|
|
2953
3126
|
/**
|
|
2954
|
-
*
|
|
3127
|
+
* - 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
|
|
2955
3128
|
*/
|
|
2956
3129
|
'target_location'?: number;
|
|
2957
3130
|
/**
|
|
@@ -2972,7 +3145,7 @@ declare const StartMovementRequestMessageTypeEnum: {
|
|
|
2972
3145
|
};
|
|
2973
3146
|
type StartMovementRequestMessageTypeEnum = typeof StartMovementRequestMessageTypeEnum[keyof typeof StartMovementRequestMessageTypeEnum];
|
|
2974
3147
|
/**
|
|
2975
|
-
* 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.
|
|
3148
|
+
* 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.
|
|
2976
3149
|
*/
|
|
2977
3150
|
interface StartMovementResponse {
|
|
2978
3151
|
/**
|
|
@@ -3021,10 +3194,15 @@ interface TcpOffset {
|
|
|
3021
3194
|
* Requested motion group requires TCP to be defined.
|
|
3022
3195
|
*/
|
|
3023
3196
|
interface TcpRequiredError {
|
|
3197
|
+
'kind': TcpRequiredErrorKindEnum;
|
|
3024
3198
|
'tcp_missing'?: any;
|
|
3025
3199
|
}
|
|
3200
|
+
declare const TcpRequiredErrorKindEnum: {
|
|
3201
|
+
readonly TcpRequiredError: "TcpRequiredError";
|
|
3202
|
+
};
|
|
3203
|
+
type TcpRequiredErrorKindEnum = typeof TcpRequiredErrorKindEnum[keyof typeof TcpRequiredErrorKindEnum];
|
|
3026
3204
|
/**
|
|
3027
|
-
* 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.
|
|
3205
|
+
* 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.
|
|
3028
3206
|
*/
|
|
3029
3207
|
interface TcpVelocityRequest {
|
|
3030
3208
|
/**
|
|
@@ -3063,8 +3241,13 @@ declare const TcpVelocityResponseKindEnum: {
|
|
|
3063
3241
|
};
|
|
3064
3242
|
type TcpVelocityResponseKindEnum = typeof TcpVelocityResponseKindEnum[keyof typeof TcpVelocityResponseKindEnum];
|
|
3065
3243
|
interface TorqueExceededError {
|
|
3244
|
+
'kind': TorqueExceededErrorKindEnum;
|
|
3066
3245
|
'torque_exceeded'?: TorqueExceededErrorTorqueExceeded;
|
|
3067
3246
|
}
|
|
3247
|
+
declare const TorqueExceededErrorKindEnum: {
|
|
3248
|
+
readonly TorqueExceededError: "TorqueExceededError";
|
|
3249
|
+
};
|
|
3250
|
+
type TorqueExceededErrorKindEnum = typeof TorqueExceededErrorKindEnum[keyof typeof TorqueExceededErrorKindEnum];
|
|
3068
3251
|
interface TorqueExceededErrorTorqueExceeded {
|
|
3069
3252
|
/**
|
|
3070
3253
|
* The torque value that was exceeded.
|
|
@@ -3106,7 +3289,7 @@ interface TrajectoryDetails {
|
|
|
3106
3289
|
*/
|
|
3107
3290
|
'trajectory': string;
|
|
3108
3291
|
/**
|
|
3109
|
-
*
|
|
3292
|
+
* - 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
|
|
3110
3293
|
*/
|
|
3111
3294
|
'location': number;
|
|
3112
3295
|
'state': TrajectoryDetailsState;
|
|
@@ -3149,7 +3332,7 @@ interface TrajectoryId {
|
|
|
3149
3332
|
*/
|
|
3150
3333
|
'message_type': TrajectoryIdMessageTypeEnum;
|
|
3151
3334
|
/**
|
|
3152
|
-
* The identifier of the trajectory which was returned by the [addTrajectory](addTrajectory) endpoint.
|
|
3335
|
+
* The identifier of the trajectory which was returned by the [addTrajectory](#/operations/addTrajectory) endpoint.
|
|
3153
3336
|
*/
|
|
3154
3337
|
'id': string;
|
|
3155
3338
|
}
|
|
@@ -3191,6 +3374,10 @@ declare const TrajectoryRunningKindEnum: {
|
|
|
3191
3374
|
readonly Running: "RUNNING";
|
|
3192
3375
|
};
|
|
3193
3376
|
type TrajectoryRunningKindEnum = typeof TrajectoryRunningKindEnum[keyof typeof TrajectoryRunningKindEnum];
|
|
3377
|
+
interface TrajectorySection {
|
|
3378
|
+
'start_location': number;
|
|
3379
|
+
'end_location': number;
|
|
3380
|
+
}
|
|
3194
3381
|
/**
|
|
3195
3382
|
* Waiting for an I/O event to start execution.
|
|
3196
3383
|
*/
|
|
@@ -3228,11 +3415,21 @@ declare const UniversalrobotsControllerKindEnum: {
|
|
|
3228
3415
|
readonly UniversalrobotsController: "UniversalrobotsController";
|
|
3229
3416
|
};
|
|
3230
3417
|
type UniversalrobotsControllerKindEnum = typeof UniversalrobotsControllerKindEnum[keyof typeof UniversalrobotsControllerKindEnum];
|
|
3418
|
+
/**
|
|
3419
|
+
* Update a single cell\'s Foundation chart version based on the indicated release channel.
|
|
3420
|
+
*/
|
|
3421
|
+
interface UpdateCellVersionRequest {
|
|
3422
|
+
'channel': ReleaseChannel;
|
|
3423
|
+
}
|
|
3231
3424
|
/**
|
|
3232
3425
|
* An update is defined by the indicated Wandelbots NOVA release channel.
|
|
3233
3426
|
*/
|
|
3234
3427
|
interface UpdateNovaVersionRequest {
|
|
3235
3428
|
'channel': ReleaseChannel;
|
|
3429
|
+
/**
|
|
3430
|
+
* Update unpinned cells during system update. Cells with an explicit chart version are never updated by a system update, regardless of this setting.
|
|
3431
|
+
*/
|
|
3432
|
+
'update_cells'?: boolean;
|
|
3236
3433
|
}
|
|
3237
3434
|
interface ValidationError {
|
|
3238
3435
|
'loc': Array<ValidationErrorLocInner>;
|
|
@@ -3255,17 +3452,17 @@ interface ValidationError2 {
|
|
|
3255
3452
|
*/
|
|
3256
3453
|
type ValidationErrorLocInner = number | string;
|
|
3257
3454
|
/**
|
|
3258
|
-
* 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.
|
|
3455
|
+
* 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.
|
|
3259
3456
|
*/
|
|
3260
3457
|
interface VirtualController {
|
|
3261
3458
|
'kind': VirtualControllerKindEnum;
|
|
3262
3459
|
'manufacturer': Manufacturer;
|
|
3263
3460
|
/**
|
|
3264
|
-
* Preset type of the virtual robot controller. See [getRobotConfigurations](getRobotConfigurations) for supported types.
|
|
3461
|
+
* Preset type of the virtual robot controller. See [getRobotConfigurations](#/operations/getRobotConfigurations) for supported types.
|
|
3265
3462
|
*/
|
|
3266
3463
|
'type'?: string;
|
|
3267
3464
|
/**
|
|
3268
|
-
* 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.
|
|
3465
|
+
* 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.
|
|
3269
3466
|
*/
|
|
3270
3467
|
'json'?: string;
|
|
3271
3468
|
/**
|
|
@@ -3283,7 +3480,7 @@ interface VirtualRobotConfiguration {
|
|
|
3283
3480
|
*/
|
|
3284
3481
|
'name': string;
|
|
3285
3482
|
/**
|
|
3286
|
-
* Content of the configuration file. Copy & paste to the [addRobotController](addRobotController) configuration.json parameter.
|
|
3483
|
+
* Content of the configuration file. Copy & paste to the [addRobotController](#/operations/addRobotController) configuration.json parameter.
|
|
3287
3484
|
*/
|
|
3288
3485
|
'content': string;
|
|
3289
3486
|
}
|
|
@@ -3342,7 +3539,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
3342
3539
|
*/
|
|
3343
3540
|
deleteApp: (cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3344
3541
|
/**
|
|
3345
|
-
* 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).
|
|
3542
|
+
* 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).
|
|
3346
3543
|
* @summary Configuration
|
|
3347
3544
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3348
3545
|
* @param {string} app
|
|
@@ -3351,7 +3548,7 @@ declare const ApplicationApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
3351
3548
|
*/
|
|
3352
3549
|
getApp: (cell: string, app: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3353
3550
|
/**
|
|
3354
|
-
* 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.
|
|
3551
|
+
* 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.
|
|
3355
3552
|
* @summary List Applications
|
|
3356
3553
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3357
3554
|
* @param {*} [options] Override http request option.
|
|
@@ -3404,7 +3601,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
|
3404
3601
|
*/
|
|
3405
3602
|
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3406
3603
|
/**
|
|
3407
|
-
* 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).
|
|
3604
|
+
* 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).
|
|
3408
3605
|
* @summary Configuration
|
|
3409
3606
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3410
3607
|
* @param {string} app
|
|
@@ -3413,7 +3610,7 @@ declare const ApplicationApiFp: (configuration?: Configuration) => {
|
|
|
3413
3610
|
*/
|
|
3414
3611
|
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<App>>;
|
|
3415
3612
|
/**
|
|
3416
|
-
* 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.
|
|
3613
|
+
* 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.
|
|
3417
3614
|
* @summary List Applications
|
|
3418
3615
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3419
3616
|
* @param {*} [options] Override http request option.
|
|
@@ -3466,7 +3663,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
|
|
|
3466
3663
|
*/
|
|
3467
3664
|
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3468
3665
|
/**
|
|
3469
|
-
* 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).
|
|
3666
|
+
* 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).
|
|
3470
3667
|
* @summary Configuration
|
|
3471
3668
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3472
3669
|
* @param {string} app
|
|
@@ -3475,7 +3672,7 @@ declare const ApplicationApiFactory: (configuration?: Configuration, basePath?:
|
|
|
3475
3672
|
*/
|
|
3476
3673
|
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): AxiosPromise<App>;
|
|
3477
3674
|
/**
|
|
3478
|
-
* 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.
|
|
3675
|
+
* 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.
|
|
3479
3676
|
* @summary List Applications
|
|
3480
3677
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3481
3678
|
* @param {*} [options] Override http request option.
|
|
@@ -3528,7 +3725,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3528
3725
|
*/
|
|
3529
3726
|
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
3530
3727
|
/**
|
|
3531
|
-
* 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).
|
|
3728
|
+
* 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).
|
|
3532
3729
|
* @summary Configuration
|
|
3533
3730
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3534
3731
|
* @param {string} app
|
|
@@ -3537,7 +3734,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
3537
3734
|
*/
|
|
3538
3735
|
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<App, any>>;
|
|
3539
3736
|
/**
|
|
3540
|
-
* 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.
|
|
3737
|
+
* 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.
|
|
3541
3738
|
* @summary List Applications
|
|
3542
3739
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3543
3740
|
* @param {*} [options] Override http request option.
|
|
@@ -3571,7 +3768,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3571
3768
|
*/
|
|
3572
3769
|
addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3573
3770
|
/**
|
|
3574
|
-
* 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).
|
|
3771
|
+
* 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).
|
|
3575
3772
|
* @summary Add MODBUS Input/Output
|
|
3576
3773
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3577
3774
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3581,7 +3778,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3581
3778
|
*/
|
|
3582
3779
|
addModbusIO: (cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3583
3780
|
/**
|
|
3584
|
-
* 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).
|
|
3781
|
+
* 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).
|
|
3585
3782
|
* @summary Add PROFINET Input/Output
|
|
3586
3783
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3587
3784
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3617,7 +3814,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3617
3814
|
deleteAllProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3618
3815
|
/**
|
|
3619
3816
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3620
|
-
* @summary Remove MODBUS Input/
|
|
3817
|
+
* @summary Remove MODBUS Input/Output
|
|
3621
3818
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3622
3819
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
3623
3820
|
* @param {*} [options] Override http request option.
|
|
@@ -3650,7 +3847,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3650
3847
|
*/
|
|
3651
3848
|
getBusIOState: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3652
3849
|
/**
|
|
3653
|
-
* 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).
|
|
3850
|
+
* 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).
|
|
3654
3851
|
* @summary Get Input/Output Values
|
|
3655
3852
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3656
3853
|
* @param {Array<string>} [ios]
|
|
@@ -3685,7 +3882,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3685
3882
|
*/
|
|
3686
3883
|
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3687
3884
|
/**
|
|
3688
|
-
* 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).
|
|
3885
|
+
* 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).
|
|
3689
3886
|
* @summary List MODBUS Input/Output Configuration
|
|
3690
3887
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3691
3888
|
* @param {*} [options] Override http request option.
|
|
@@ -3693,7 +3890,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3693
3890
|
*/
|
|
3694
3891
|
listModbusIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3695
3892
|
/**
|
|
3696
|
-
* 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.
|
|
3893
|
+
* 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.
|
|
3697
3894
|
* @summary List PROFINET Input/Output Configuration
|
|
3698
3895
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3699
3896
|
* @param {*} [options] Override http request option.
|
|
@@ -3701,7 +3898,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3701
3898
|
*/
|
|
3702
3899
|
listProfinetIOs: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3703
3900
|
/**
|
|
3704
|
-
* 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.
|
|
3901
|
+
* 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.
|
|
3705
3902
|
* @summary Set Output Values
|
|
3706
3903
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3707
3904
|
* @param {Array<IOValue>} iOValue
|
|
@@ -3710,7 +3907,7 @@ declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3710
3907
|
*/
|
|
3711
3908
|
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3712
3909
|
/**
|
|
3713
|
-
* 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.
|
|
3910
|
+
* 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.
|
|
3714
3911
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
3715
3912
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3716
3913
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -3734,7 +3931,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3734
3931
|
*/
|
|
3735
3932
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3736
3933
|
/**
|
|
3737
|
-
* 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).
|
|
3934
|
+
* 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).
|
|
3738
3935
|
* @summary Add MODBUS Input/Output
|
|
3739
3936
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3740
3937
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3744,7 +3941,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3744
3941
|
*/
|
|
3745
3942
|
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3746
3943
|
/**
|
|
3747
|
-
* 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).
|
|
3944
|
+
* 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).
|
|
3748
3945
|
* @summary Add PROFINET Input/Output
|
|
3749
3946
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3750
3947
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3780,7 +3977,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3780
3977
|
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3781
3978
|
/**
|
|
3782
3979
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3783
|
-
* @summary Remove MODBUS Input/
|
|
3980
|
+
* @summary Remove MODBUS Input/Output
|
|
3784
3981
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3785
3982
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
3786
3983
|
* @param {*} [options] Override http request option.
|
|
@@ -3813,7 +4010,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3813
4010
|
*/
|
|
3814
4011
|
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BusIOsState>>;
|
|
3815
4012
|
/**
|
|
3816
|
-
* 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).
|
|
4013
|
+
* 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).
|
|
3817
4014
|
* @summary Get Input/Output Values
|
|
3818
4015
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3819
4016
|
* @param {Array<string>} [ios]
|
|
@@ -3848,7 +4045,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3848
4045
|
*/
|
|
3849
4046
|
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusIODescription>>>;
|
|
3850
4047
|
/**
|
|
3851
|
-
* 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).
|
|
4048
|
+
* 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).
|
|
3852
4049
|
* @summary List MODBUS Input/Output Configuration
|
|
3853
4050
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3854
4051
|
* @param {*} [options] Override http request option.
|
|
@@ -3856,7 +4053,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3856
4053
|
*/
|
|
3857
4054
|
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ModbusIO>>>;
|
|
3858
4055
|
/**
|
|
3859
|
-
* 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.
|
|
4056
|
+
* 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.
|
|
3860
4057
|
* @summary List PROFINET Input/Output Configuration
|
|
3861
4058
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3862
4059
|
* @param {*} [options] Override http request option.
|
|
@@ -3864,7 +4061,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3864
4061
|
*/
|
|
3865
4062
|
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProfinetIO>>>;
|
|
3866
4063
|
/**
|
|
3867
|
-
* 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.
|
|
4064
|
+
* 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.
|
|
3868
4065
|
* @summary Set Output Values
|
|
3869
4066
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3870
4067
|
* @param {Array<IOValue>} iOValue
|
|
@@ -3873,7 +4070,7 @@ declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
3873
4070
|
*/
|
|
3874
4071
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3875
4072
|
/**
|
|
3876
|
-
* 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.
|
|
4073
|
+
* 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.
|
|
3877
4074
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
3878
4075
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3879
4076
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -3897,7 +4094,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3897
4094
|
*/
|
|
3898
4095
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3899
4096
|
/**
|
|
3900
|
-
* 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).
|
|
4097
|
+
* 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).
|
|
3901
4098
|
* @summary Add MODBUS Input/Output
|
|
3902
4099
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3903
4100
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3907,7 +4104,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3907
4104
|
*/
|
|
3908
4105
|
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3909
4106
|
/**
|
|
3910
|
-
* 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).
|
|
4107
|
+
* 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).
|
|
3911
4108
|
* @summary Add PROFINET Input/Output
|
|
3912
4109
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3913
4110
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -3943,7 +4140,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3943
4140
|
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3944
4141
|
/**
|
|
3945
4142
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
3946
|
-
* @summary Remove MODBUS Input/
|
|
4143
|
+
* @summary Remove MODBUS Input/Output
|
|
3947
4144
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3948
4145
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
3949
4146
|
* @param {*} [options] Override http request option.
|
|
@@ -3976,7 +4173,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
3976
4173
|
*/
|
|
3977
4174
|
getBusIOState(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<BusIOsState>;
|
|
3978
4175
|
/**
|
|
3979
|
-
* 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).
|
|
4176
|
+
* 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).
|
|
3980
4177
|
* @summary Get Input/Output Values
|
|
3981
4178
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3982
4179
|
* @param {Array<string>} [ios]
|
|
@@ -4011,7 +4208,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
4011
4208
|
*/
|
|
4012
4209
|
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BusIODescription>>;
|
|
4013
4210
|
/**
|
|
4014
|
-
* 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).
|
|
4211
|
+
* 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).
|
|
4015
4212
|
* @summary List MODBUS Input/Output Configuration
|
|
4016
4213
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4017
4214
|
* @param {*} [options] Override http request option.
|
|
@@ -4019,7 +4216,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
4019
4216
|
*/
|
|
4020
4217
|
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ModbusIO>>;
|
|
4021
4218
|
/**
|
|
4022
|
-
* 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.
|
|
4219
|
+
* 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.
|
|
4023
4220
|
* @summary List PROFINET Input/Output Configuration
|
|
4024
4221
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4025
4222
|
* @param {*} [options] Override http request option.
|
|
@@ -4027,7 +4224,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
4027
4224
|
*/
|
|
4028
4225
|
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ProfinetIO>>;
|
|
4029
4226
|
/**
|
|
4030
|
-
* 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.
|
|
4227
|
+
* 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.
|
|
4031
4228
|
* @summary Set Output Values
|
|
4032
4229
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4033
4230
|
* @param {Array<IOValue>} iOValue
|
|
@@ -4036,7 +4233,7 @@ declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePa
|
|
|
4036
4233
|
*/
|
|
4037
4234
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4038
4235
|
/**
|
|
4039
|
-
* 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.
|
|
4236
|
+
* 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.
|
|
4040
4237
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
4041
4238
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4042
4239
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -4060,7 +4257,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4060
4257
|
*/
|
|
4061
4258
|
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4062
4259
|
/**
|
|
4063
|
-
* 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).
|
|
4260
|
+
* 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).
|
|
4064
4261
|
* @summary Add MODBUS Input/Output
|
|
4065
4262
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4066
4263
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -4070,7 +4267,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4070
4267
|
*/
|
|
4071
4268
|
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4072
4269
|
/**
|
|
4073
|
-
* 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).
|
|
4270
|
+
* 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).
|
|
4074
4271
|
* @summary Add PROFINET Input/Output
|
|
4075
4272
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4076
4273
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
@@ -4106,7 +4303,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4106
4303
|
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4107
4304
|
/**
|
|
4108
4305
|
* Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
4109
|
-
* @summary Remove MODBUS Input/
|
|
4306
|
+
* @summary Remove MODBUS Input/Output
|
|
4110
4307
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4111
4308
|
* @param {string} io Unique identifier to address an Input/Output in the cell.
|
|
4112
4309
|
* @param {*} [options] Override http request option.
|
|
@@ -4139,7 +4336,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4139
4336
|
*/
|
|
4140
4337
|
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIOsState, any>>;
|
|
4141
4338
|
/**
|
|
4142
|
-
* 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).
|
|
4339
|
+
* 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).
|
|
4143
4340
|
* @summary Get Input/Output Values
|
|
4144
4341
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4145
4342
|
* @param {Array<string>} [ios]
|
|
@@ -4174,7 +4371,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4174
4371
|
*/
|
|
4175
4372
|
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<BusIODescription[], any>>;
|
|
4176
4373
|
/**
|
|
4177
|
-
* 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).
|
|
4374
|
+
* 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).
|
|
4178
4375
|
* @summary List MODBUS Input/Output Configuration
|
|
4179
4376
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4180
4377
|
* @param {*} [options] Override http request option.
|
|
@@ -4182,7 +4379,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4182
4379
|
*/
|
|
4183
4380
|
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ModbusIO[], any>>;
|
|
4184
4381
|
/**
|
|
4185
|
-
* 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.
|
|
4382
|
+
* 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.
|
|
4186
4383
|
* @summary List PROFINET Input/Output Configuration
|
|
4187
4384
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4188
4385
|
* @param {*} [options] Override http request option.
|
|
@@ -4190,7 +4387,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4190
4387
|
*/
|
|
4191
4388
|
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ProfinetIO[], any>>;
|
|
4192
4389
|
/**
|
|
4193
|
-
* 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.
|
|
4390
|
+
* 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.
|
|
4194
4391
|
* @summary Set Output Values
|
|
4195
4392
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4196
4393
|
* @param {Array<IOValue>} iOValue
|
|
@@ -4199,7 +4396,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4199
4396
|
*/
|
|
4200
4397
|
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4201
4398
|
/**
|
|
4202
|
-
* 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.
|
|
4399
|
+
* 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.
|
|
4203
4400
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
4204
4401
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4205
4402
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -4212,6 +4409,15 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
4212
4409
|
* CellApi - axios parameter creator
|
|
4213
4410
|
*/
|
|
4214
4411
|
declare const CellApiAxiosParamCreator: (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<RequestArgs>;
|
|
4215
4421
|
/**
|
|
4216
4422
|
* Delete an entire cell.
|
|
4217
4423
|
* @summary Delete Cell
|
|
@@ -4272,11 +4478,29 @@ declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
4272
4478
|
* @throws {RequiredError}
|
|
4273
4479
|
*/
|
|
4274
4480
|
updateCell: (cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
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<RequestArgs>;
|
|
4275
4490
|
};
|
|
4276
4491
|
/**
|
|
4277
4492
|
* CellApi - functional programming interface
|
|
4278
4493
|
*/
|
|
4279
4494
|
declare const CellApiFp: (configuration?: Configuration) => {
|
|
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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
4280
4504
|
/**
|
|
4281
4505
|
* Delete an entire cell.
|
|
4282
4506
|
* @summary Delete Cell
|
|
@@ -4337,11 +4561,29 @@ declare const CellApiFp: (configuration?: Configuration) => {
|
|
|
4337
4561
|
* @throws {RequiredError}
|
|
4338
4562
|
*/
|
|
4339
4563
|
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4340
4573
|
};
|
|
4341
4574
|
/**
|
|
4342
4575
|
* CellApi - factory interface
|
|
4343
4576
|
*/
|
|
4344
4577
|
declare const CellApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
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): AxiosPromise<string>;
|
|
4345
4587
|
/**
|
|
4346
4588
|
* Delete an entire cell.
|
|
4347
4589
|
* @summary Delete Cell
|
|
@@ -4402,11 +4644,29 @@ declare const CellApiFactory: (configuration?: Configuration, basePath?: string,
|
|
|
4402
4644
|
* @throws {RequiredError}
|
|
4403
4645
|
*/
|
|
4404
4646
|
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
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): AxiosPromise<void>;
|
|
4405
4656
|
};
|
|
4406
4657
|
/**
|
|
4407
4658
|
* CellApi - object-oriented interface
|
|
4408
4659
|
*/
|
|
4409
4660
|
declare class CellApi extends BaseAPI {
|
|
4661
|
+
/**
|
|
4662
|
+
* Check if a more recent Wandelbots NOVA version is available for the cell. Updates greater than the system version are ignored.
|
|
4663
|
+
* @summary Check Cell Update
|
|
4664
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4665
|
+
* @param {ReleaseChannel} channel
|
|
4666
|
+
* @param {*} [options] Override http request option.
|
|
4667
|
+
* @throws {RequiredError}
|
|
4668
|
+
*/
|
|
4669
|
+
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string, any>>;
|
|
4410
4670
|
/**
|
|
4411
4671
|
* Delete an entire cell.
|
|
4412
4672
|
* @summary Delete Cell
|
|
@@ -4467,6 +4727,15 @@ declare class CellApi extends BaseAPI {
|
|
|
4467
4727
|
* @throws {RequiredError}
|
|
4468
4728
|
*/
|
|
4469
4729
|
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4730
|
+
/**
|
|
4731
|
+
* Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
4732
|
+
* @summary Update Cell Version
|
|
4733
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4734
|
+
* @param {UpdateCellVersionRequest} updateCellVersionRequest
|
|
4735
|
+
* @param {*} [options] Override http request option.
|
|
4736
|
+
* @throws {RequiredError}
|
|
4737
|
+
*/
|
|
4738
|
+
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4470
4739
|
}
|
|
4471
4740
|
/**
|
|
4472
4741
|
* ControllerApi - axios parameter creator
|
|
@@ -4483,7 +4752,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4483
4752
|
*/
|
|
4484
4753
|
addRobotController: (cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4485
4754
|
/**
|
|
4486
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
4755
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
4487
4756
|
* @summary Clear Robot Controllers
|
|
4488
4757
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4489
4758
|
* @param {number} [completionTimeout]
|
|
@@ -4502,7 +4771,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4502
4771
|
*/
|
|
4503
4772
|
deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4504
4773
|
/**
|
|
4505
|
-
* 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.
|
|
4774
|
+
* 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.
|
|
4506
4775
|
* @summary Description
|
|
4507
4776
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4508
4777
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4540,7 +4809,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4540
4809
|
*/
|
|
4541
4810
|
getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4542
4811
|
/**
|
|
4543
|
-
* 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.
|
|
4812
|
+
* 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.
|
|
4544
4813
|
* @summary Virtual Controller Configuration
|
|
4545
4814
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4546
4815
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4567,7 +4836,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4567
4836
|
*/
|
|
4568
4837
|
listRobotControllers: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4569
4838
|
/**
|
|
4570
|
-
* 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.
|
|
4839
|
+
* 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.
|
|
4571
4840
|
* @summary Set Default Mode
|
|
4572
4841
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4573
4842
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4577,7 +4846,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4577
4846
|
*/
|
|
4578
4847
|
setDefaultMode: (cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4579
4848
|
/**
|
|
4580
|
-
* <!-- 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.
|
|
4849
|
+
* <!-- 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.
|
|
4581
4850
|
* @summary Stream Free Drive
|
|
4582
4851
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4583
4852
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4587,7 +4856,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4587
4856
|
*/
|
|
4588
4857
|
streamFreeDrive: (cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4589
4858
|
/**
|
|
4590
|
-
* <!-- 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.
|
|
4859
|
+
* <!-- 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.
|
|
4591
4860
|
* @summary Stream State
|
|
4592
4861
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4593
4862
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4598,7 +4867,7 @@ declare const ControllerApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
4598
4867
|
*/
|
|
4599
4868
|
streamRobotControllerState: (cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4600
4869
|
/**
|
|
4601
|
-
* 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).
|
|
4870
|
+
* 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).
|
|
4602
4871
|
* @summary Update Robot Controller
|
|
4603
4872
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4604
4873
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4624,7 +4893,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4624
4893
|
*/
|
|
4625
4894
|
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4626
4895
|
/**
|
|
4627
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
4896
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
4628
4897
|
* @summary Clear Robot Controllers
|
|
4629
4898
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4630
4899
|
* @param {number} [completionTimeout]
|
|
@@ -4643,7 +4912,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4643
4912
|
*/
|
|
4644
4913
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4645
4914
|
/**
|
|
4646
|
-
* 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.
|
|
4915
|
+
* 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.
|
|
4647
4916
|
* @summary Description
|
|
4648
4917
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4649
4918
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4681,7 +4950,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4681
4950
|
*/
|
|
4682
4951
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
|
|
4683
4952
|
/**
|
|
4684
|
-
* 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.
|
|
4953
|
+
* 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.
|
|
4685
4954
|
* @summary Virtual Controller Configuration
|
|
4686
4955
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4687
4956
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4708,7 +4977,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4708
4977
|
*/
|
|
4709
4978
|
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
4710
4979
|
/**
|
|
4711
|
-
* 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.
|
|
4980
|
+
* 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.
|
|
4712
4981
|
* @summary Set Default Mode
|
|
4713
4982
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4714
4983
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4718,7 +4987,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4718
4987
|
*/
|
|
4719
4988
|
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4720
4989
|
/**
|
|
4721
|
-
* <!-- 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.
|
|
4990
|
+
* <!-- 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.
|
|
4722
4991
|
* @summary Stream Free Drive
|
|
4723
4992
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4724
4993
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4728,7 +4997,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4728
4997
|
*/
|
|
4729
4998
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
4730
4999
|
/**
|
|
4731
|
-
* <!-- 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.
|
|
5000
|
+
* <!-- 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.
|
|
4732
5001
|
* @summary Stream State
|
|
4733
5002
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4734
5003
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4739,7 +5008,7 @@ declare const ControllerApiFp: (configuration?: Configuration) => {
|
|
|
4739
5008
|
*/
|
|
4740
5009
|
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotControllerState>>;
|
|
4741
5010
|
/**
|
|
4742
|
-
* 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).
|
|
5011
|
+
* 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).
|
|
4743
5012
|
* @summary Update Robot Controller
|
|
4744
5013
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4745
5014
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4765,7 +5034,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4765
5034
|
*/
|
|
4766
5035
|
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4767
5036
|
/**
|
|
4768
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
5037
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
4769
5038
|
* @summary Clear Robot Controllers
|
|
4770
5039
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4771
5040
|
* @param {number} [completionTimeout]
|
|
@@ -4784,7 +5053,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4784
5053
|
*/
|
|
4785
5054
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4786
5055
|
/**
|
|
4787
|
-
* 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.
|
|
5056
|
+
* 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.
|
|
4788
5057
|
* @summary Description
|
|
4789
5058
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4790
5059
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4822,7 +5091,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4822
5091
|
*/
|
|
4823
5092
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
|
|
4824
5093
|
/**
|
|
4825
|
-
* 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.
|
|
5094
|
+
* 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.
|
|
4826
5095
|
* @summary Virtual Controller Configuration
|
|
4827
5096
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4828
5097
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4849,7 +5118,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4849
5118
|
*/
|
|
4850
5119
|
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
4851
5120
|
/**
|
|
4852
|
-
* 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.
|
|
5121
|
+
* 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.
|
|
4853
5122
|
* @summary Set Default Mode
|
|
4854
5123
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4855
5124
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4859,7 +5128,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4859
5128
|
*/
|
|
4860
5129
|
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4861
5130
|
/**
|
|
4862
|
-
* <!-- 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.
|
|
5131
|
+
* <!-- 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.
|
|
4863
5132
|
* @summary Stream Free Drive
|
|
4864
5133
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4865
5134
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4869,7 +5138,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4869
5138
|
*/
|
|
4870
5139
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
4871
5140
|
/**
|
|
4872
|
-
* <!-- 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.
|
|
5141
|
+
* <!-- 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.
|
|
4873
5142
|
* @summary Stream State
|
|
4874
5143
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4875
5144
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4880,7 +5149,7 @@ declare const ControllerApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
4880
5149
|
*/
|
|
4881
5150
|
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotControllerState>;
|
|
4882
5151
|
/**
|
|
4883
|
-
* 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).
|
|
5152
|
+
* 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).
|
|
4884
5153
|
* @summary Update Robot Controller
|
|
4885
5154
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4886
5155
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4906,7 +5175,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4906
5175
|
*/
|
|
4907
5176
|
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4908
5177
|
/**
|
|
4909
|
-
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](addRobotController).
|
|
5178
|
+
* Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
4910
5179
|
* @summary Clear Robot Controllers
|
|
4911
5180
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4912
5181
|
* @param {number} [completionTimeout]
|
|
@@ -4925,7 +5194,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4925
5194
|
*/
|
|
4926
5195
|
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
4927
5196
|
/**
|
|
4928
|
-
* 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.
|
|
5197
|
+
* 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.
|
|
4929
5198
|
* @summary Description
|
|
4930
5199
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4931
5200
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4963,7 +5232,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4963
5232
|
*/
|
|
4964
5233
|
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController, any>>;
|
|
4965
5234
|
/**
|
|
4966
|
-
* 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.
|
|
5235
|
+
* 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.
|
|
4967
5236
|
* @summary Virtual Controller Configuration
|
|
4968
5237
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4969
5238
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -4990,7 +5259,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
4990
5259
|
*/
|
|
4991
5260
|
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
4992
5261
|
/**
|
|
4993
|
-
* 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.
|
|
5262
|
+
* 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.
|
|
4994
5263
|
* @summary Set Default Mode
|
|
4995
5264
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4996
5265
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5000,7 +5269,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5000
5269
|
*/
|
|
5001
5270
|
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
5002
5271
|
/**
|
|
5003
|
-
* <!-- 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.
|
|
5272
|
+
* <!-- 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.
|
|
5004
5273
|
* @summary Stream Free Drive
|
|
5005
5274
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5006
5275
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5010,7 +5279,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5010
5279
|
*/
|
|
5011
5280
|
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5012
5281
|
/**
|
|
5013
|
-
* <!-- 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.
|
|
5282
|
+
* <!-- 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.
|
|
5014
5283
|
* @summary Stream State
|
|
5015
5284
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5016
5285
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5021,7 +5290,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
5021
5290
|
*/
|
|
5022
5291
|
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotControllerState, any>>;
|
|
5023
5292
|
/**
|
|
5024
|
-
* 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).
|
|
5293
|
+
* 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).
|
|
5025
5294
|
* @summary Update Robot Controller
|
|
5026
5295
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5027
5296
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5050,7 +5319,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5050
5319
|
*/
|
|
5051
5320
|
listIODescriptions: (cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5052
5321
|
/**
|
|
5053
|
-
* 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).
|
|
5322
|
+
* 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).
|
|
5054
5323
|
* @summary Get Input/Output Values
|
|
5055
5324
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5056
5325
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5060,7 +5329,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5060
5329
|
*/
|
|
5061
5330
|
listIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5062
5331
|
/**
|
|
5063
|
-
* 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.
|
|
5332
|
+
* 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.
|
|
5064
5333
|
* @summary Set Output Values
|
|
5065
5334
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5066
5335
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5080,7 +5349,7 @@ declare const ControllerInputsOutputsApiAxiosParamCreator: (configuration?: Conf
|
|
|
5080
5349
|
*/
|
|
5081
5350
|
streamIOValues: (cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5082
5351
|
/**
|
|
5083
|
-
* 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 ```
|
|
5352
|
+
* 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 ```
|
|
5084
5353
|
* @summary Wait For
|
|
5085
5354
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5086
5355
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5108,7 +5377,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5108
5377
|
*/
|
|
5109
5378
|
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
5110
5379
|
/**
|
|
5111
|
-
* 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).
|
|
5380
|
+
* 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).
|
|
5112
5381
|
* @summary Get Input/Output Values
|
|
5113
5382
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5114
5383
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5118,7 +5387,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5118
5387
|
*/
|
|
5119
5388
|
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
5120
5389
|
/**
|
|
5121
|
-
* 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.
|
|
5390
|
+
* 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.
|
|
5122
5391
|
* @summary Set Output Values
|
|
5123
5392
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5124
5393
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5138,7 +5407,7 @@ declare const ControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
|
5138
5407
|
*/
|
|
5139
5408
|
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamIOValuesResponse>>;
|
|
5140
5409
|
/**
|
|
5141
|
-
* 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 ```
|
|
5410
|
+
* 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 ```
|
|
5142
5411
|
* @summary Wait For
|
|
5143
5412
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5144
5413
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5166,7 +5435,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5166
5435
|
*/
|
|
5167
5436
|
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
5168
5437
|
/**
|
|
5169
|
-
* 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).
|
|
5438
|
+
* 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).
|
|
5170
5439
|
* @summary Get Input/Output Values
|
|
5171
5440
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5172
5441
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5176,7 +5445,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5176
5445
|
*/
|
|
5177
5446
|
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5178
5447
|
/**
|
|
5179
|
-
* 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.
|
|
5448
|
+
* 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.
|
|
5180
5449
|
* @summary Set Output Values
|
|
5181
5450
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5182
5451
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5196,7 +5465,7 @@ declare const ControllerInputsOutputsApiFactory: (configuration?: Configuration,
|
|
|
5196
5465
|
*/
|
|
5197
5466
|
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<StreamIOValuesResponse>;
|
|
5198
5467
|
/**
|
|
5199
|
-
* 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 ```
|
|
5468
|
+
* 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 ```
|
|
5200
5469
|
* @summary Wait For
|
|
5201
5470
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5202
5471
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5224,7 +5493,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5224
5493
|
*/
|
|
5225
5494
|
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IODescription[], any>>;
|
|
5226
5495
|
/**
|
|
5227
|
-
* 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).
|
|
5496
|
+
* 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).
|
|
5228
5497
|
* @summary Get Input/Output Values
|
|
5229
5498
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5230
5499
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5234,7 +5503,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5234
5503
|
*/
|
|
5235
5504
|
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<IOValue[], any>>;
|
|
5236
5505
|
/**
|
|
5237
|
-
* 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.
|
|
5506
|
+
* 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.
|
|
5238
5507
|
* @summary Set Output Values
|
|
5239
5508
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5240
5509
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5254,7 +5523,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5254
5523
|
*/
|
|
5255
5524
|
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<StreamIOValuesResponse, any>>;
|
|
5256
5525
|
/**
|
|
5257
|
-
* 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 ```
|
|
5526
|
+
* 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 ```
|
|
5258
5527
|
* @summary Wait For
|
|
5259
5528
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5260
5529
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5269,7 +5538,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
5269
5538
|
*/
|
|
5270
5539
|
declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5271
5540
|
/**
|
|
5272
|
-
* <!-- 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.
|
|
5541
|
+
* <!-- 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.
|
|
5273
5542
|
* @summary Execute Jogging
|
|
5274
5543
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5275
5544
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5284,7 +5553,7 @@ declare const JoggingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5284
5553
|
*/
|
|
5285
5554
|
declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
5286
5555
|
/**
|
|
5287
|
-
* <!-- 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.
|
|
5556
|
+
* <!-- 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.
|
|
5288
5557
|
* @summary Execute Jogging
|
|
5289
5558
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5290
5559
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5299,7 +5568,7 @@ declare const JoggingApiFp: (configuration?: Configuration) => {
|
|
|
5299
5568
|
*/
|
|
5300
5569
|
declare const JoggingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5301
5570
|
/**
|
|
5302
|
-
* <!-- 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.
|
|
5571
|
+
* <!-- 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.
|
|
5303
5572
|
* @summary Execute Jogging
|
|
5304
5573
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5305
5574
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5314,7 +5583,7 @@ declare const JoggingApiFactory: (configuration?: Configuration, basePath?: stri
|
|
|
5314
5583
|
*/
|
|
5315
5584
|
declare class JoggingApi extends BaseAPI {
|
|
5316
5585
|
/**
|
|
5317
|
-
* <!-- 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.
|
|
5586
|
+
* <!-- 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.
|
|
5318
5587
|
* @summary Execute Jogging
|
|
5319
5588
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5320
5589
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -5709,25 +5978,25 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
5709
5978
|
*/
|
|
5710
5979
|
declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5711
5980
|
/**
|
|
5712
|
-
* 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.
|
|
5981
|
+
* 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.
|
|
5713
5982
|
* @summary Get Collision Model
|
|
5714
|
-
* @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).
|
|
5983
|
+
* @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).
|
|
5715
5984
|
* @param {*} [options] Override http request option.
|
|
5716
5985
|
* @throws {RequiredError}
|
|
5717
5986
|
*/
|
|
5718
5987
|
getMotionGroupCollisionModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5719
5988
|
/**
|
|
5720
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
5989
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5721
5990
|
* @summary Download GLB Model
|
|
5722
|
-
* @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).
|
|
5991
|
+
* @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).
|
|
5723
5992
|
* @param {*} [options] Override http request option.
|
|
5724
5993
|
* @throws {RequiredError}
|
|
5725
5994
|
*/
|
|
5726
5995
|
getMotionGroupGlbModel: (motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5727
5996
|
/**
|
|
5728
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
5997
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
5729
5998
|
* @summary Get Kinematics
|
|
5730
|
-
* @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).
|
|
5999
|
+
* @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).
|
|
5731
6000
|
* @param {*} [options] Override http request option.
|
|
5732
6001
|
* @throws {RequiredError}
|
|
5733
6002
|
*/
|
|
@@ -5740,9 +6009,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5740
6009
|
*/
|
|
5741
6010
|
getMotionGroupModels: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5742
6011
|
/**
|
|
5743
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6012
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5744
6013
|
* @summary Download USD Model
|
|
5745
|
-
* @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).
|
|
6014
|
+
* @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).
|
|
5746
6015
|
* @param {*} [options] Override http request option.
|
|
5747
6016
|
* @throws {RequiredError}
|
|
5748
6017
|
*/
|
|
@@ -5753,9 +6022,9 @@ declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
5753
6022
|
*/
|
|
5754
6023
|
declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
5755
6024
|
/**
|
|
5756
|
-
* 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.
|
|
6025
|
+
* 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.
|
|
5757
6026
|
* @summary Get Collision Model
|
|
5758
|
-
* @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).
|
|
6027
|
+
* @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).
|
|
5759
6028
|
* @param {*} [options] Override http request option.
|
|
5760
6029
|
* @throws {RequiredError}
|
|
5761
6030
|
*/
|
|
@@ -5763,17 +6032,17 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
|
5763
6032
|
[key: string]: Collider;
|
|
5764
6033
|
}>>>;
|
|
5765
6034
|
/**
|
|
5766
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6035
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5767
6036
|
* @summary Download GLB Model
|
|
5768
|
-
* @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).
|
|
6037
|
+
* @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).
|
|
5769
6038
|
* @param {*} [options] Override http request option.
|
|
5770
6039
|
* @throws {RequiredError}
|
|
5771
6040
|
*/
|
|
5772
6041
|
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
5773
6042
|
/**
|
|
5774
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
6043
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
5775
6044
|
* @summary Get Kinematics
|
|
5776
|
-
* @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).
|
|
6045
|
+
* @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).
|
|
5777
6046
|
* @param {*} [options] Override http request option.
|
|
5778
6047
|
* @throws {RequiredError}
|
|
5779
6048
|
*/
|
|
@@ -5786,9 +6055,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
|
5786
6055
|
*/
|
|
5787
6056
|
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
5788
6057
|
/**
|
|
5789
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6058
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5790
6059
|
* @summary Download USD Model
|
|
5791
|
-
* @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).
|
|
6060
|
+
* @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).
|
|
5792
6061
|
* @param {*} [options] Override http request option.
|
|
5793
6062
|
* @throws {RequiredError}
|
|
5794
6063
|
*/
|
|
@@ -5799,9 +6068,9 @@ declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
|
5799
6068
|
*/
|
|
5800
6069
|
declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5801
6070
|
/**
|
|
5802
|
-
* 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.
|
|
6071
|
+
* 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.
|
|
5803
6072
|
* @summary Get Collision Model
|
|
5804
|
-
* @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).
|
|
6073
|
+
* @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).
|
|
5805
6074
|
* @param {*} [options] Override http request option.
|
|
5806
6075
|
* @throws {RequiredError}
|
|
5807
6076
|
*/
|
|
@@ -5809,17 +6078,17 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
|
|
|
5809
6078
|
[key: string]: Collider;
|
|
5810
6079
|
}>>;
|
|
5811
6080
|
/**
|
|
5812
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6081
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5813
6082
|
* @summary Download GLB Model
|
|
5814
|
-
* @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).
|
|
6083
|
+
* @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).
|
|
5815
6084
|
* @param {*} [options] Override http request option.
|
|
5816
6085
|
* @throws {RequiredError}
|
|
5817
6086
|
*/
|
|
5818
6087
|
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
5819
6088
|
/**
|
|
5820
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
6089
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
5821
6090
|
* @summary Get Kinematics
|
|
5822
|
-
* @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).
|
|
6091
|
+
* @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).
|
|
5823
6092
|
* @param {*} [options] Override http request option.
|
|
5824
6093
|
* @throws {RequiredError}
|
|
5825
6094
|
*/
|
|
@@ -5832,9 +6101,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
|
|
|
5832
6101
|
*/
|
|
5833
6102
|
getMotionGroupModels(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
5834
6103
|
/**
|
|
5835
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6104
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5836
6105
|
* @summary Download USD Model
|
|
5837
|
-
* @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).
|
|
6106
|
+
* @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).
|
|
5838
6107
|
* @param {*} [options] Override http request option.
|
|
5839
6108
|
* @throws {RequiredError}
|
|
5840
6109
|
*/
|
|
@@ -5845,9 +6114,9 @@ declare const MotionGroupModelsApiFactory: (configuration?: Configuration, baseP
|
|
|
5845
6114
|
*/
|
|
5846
6115
|
declare class MotionGroupModelsApi extends BaseAPI {
|
|
5847
6116
|
/**
|
|
5848
|
-
* 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.
|
|
6117
|
+
* 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.
|
|
5849
6118
|
* @summary Get Collision Model
|
|
5850
|
-
* @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).
|
|
6119
|
+
* @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).
|
|
5851
6120
|
* @param {*} [options] Override http request option.
|
|
5852
6121
|
* @throws {RequiredError}
|
|
5853
6122
|
*/
|
|
@@ -5855,17 +6124,17 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5855
6124
|
[key: string]: Collider;
|
|
5856
6125
|
}[], any>>;
|
|
5857
6126
|
/**
|
|
5858
|
-
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6127
|
+
* Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5859
6128
|
* @summary Download GLB Model
|
|
5860
|
-
* @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).
|
|
6129
|
+
* @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).
|
|
5861
6130
|
* @param {*} [options] Override http request option.
|
|
5862
6131
|
* @throws {RequiredError}
|
|
5863
6132
|
*/
|
|
5864
6133
|
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<File, any>>;
|
|
5865
6134
|
/**
|
|
5866
|
-
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.
|
|
6135
|
+
* Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
5867
6136
|
* @summary Get Kinematics
|
|
5868
|
-
* @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).
|
|
6137
|
+
* @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).
|
|
5869
6138
|
* @param {*} [options] Override http request option.
|
|
5870
6139
|
* @throws {RequiredError}
|
|
5871
6140
|
*/
|
|
@@ -5878,9 +6147,9 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
5878
6147
|
*/
|
|
5879
6148
|
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
5880
6149
|
/**
|
|
5881
|
-
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported identifiers.
|
|
6150
|
+
* Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
5882
6151
|
* @summary Download USD Model
|
|
5883
|
-
* @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).
|
|
6152
|
+
* @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).
|
|
5884
6153
|
* @param {*} [options] Override http request option.
|
|
5885
6154
|
* @throws {RequiredError}
|
|
5886
6155
|
*/
|
|
@@ -6054,6 +6323,14 @@ declare class ProgramApi extends BaseAPI {
|
|
|
6054
6323
|
* RobotConfigurationsApi - axios parameter creator
|
|
6055
6324
|
*/
|
|
6056
6325
|
declare const RobotConfigurationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6326
|
+
/**
|
|
6327
|
+
* Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
|
|
6328
|
+
* @summary Robot Controller Configurations
|
|
6329
|
+
* @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
|
|
6330
|
+
* @param {*} [options] Override http request option.
|
|
6331
|
+
* @throws {RequiredError}
|
|
6332
|
+
*/
|
|
6333
|
+
getControllerConfigFromArpScan: (robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6057
6334
|
/**
|
|
6058
6335
|
* Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
6059
6336
|
* @summary List Robot Configurations
|
|
@@ -6066,6 +6343,14 @@ declare const RobotConfigurationsApiAxiosParamCreator: (configuration?: Configur
|
|
|
6066
6343
|
* RobotConfigurationsApi - functional programming interface
|
|
6067
6344
|
*/
|
|
6068
6345
|
declare const RobotConfigurationsApiFp: (configuration?: Configuration) => {
|
|
6346
|
+
/**
|
|
6347
|
+
* Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
|
|
6348
|
+
* @summary Robot Controller Configurations
|
|
6349
|
+
* @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
|
|
6350
|
+
* @param {*} [options] Override http request option.
|
|
6351
|
+
* @throws {RequiredError}
|
|
6352
|
+
*/
|
|
6353
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotController>>>;
|
|
6069
6354
|
/**
|
|
6070
6355
|
* Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
6071
6356
|
* @summary List Robot Configurations
|
|
@@ -6078,6 +6363,14 @@ declare const RobotConfigurationsApiFp: (configuration?: Configuration) => {
|
|
|
6078
6363
|
* RobotConfigurationsApi - factory interface
|
|
6079
6364
|
*/
|
|
6080
6365
|
declare const RobotConfigurationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6366
|
+
/**
|
|
6367
|
+
* Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
|
|
6368
|
+
* @summary Robot Controller Configurations
|
|
6369
|
+
* @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
|
|
6370
|
+
* @param {*} [options] Override http request option.
|
|
6371
|
+
* @throws {RequiredError}
|
|
6372
|
+
*/
|
|
6373
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotController>>;
|
|
6081
6374
|
/**
|
|
6082
6375
|
* Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
6083
6376
|
* @summary List Robot Configurations
|
|
@@ -6090,6 +6383,14 @@ declare const RobotConfigurationsApiFactory: (configuration?: Configuration, bas
|
|
|
6090
6383
|
* RobotConfigurationsApi - object-oriented interface
|
|
6091
6384
|
*/
|
|
6092
6385
|
declare class RobotConfigurationsApi extends BaseAPI {
|
|
6386
|
+
/**
|
|
6387
|
+
* Returns all robot controller configurations that match the provided [ARP scan result](#/operations/getArpScan).
|
|
6388
|
+
* @summary Robot Controller Configurations
|
|
6389
|
+
* @param {RobotControllerConfigurationRequest} robotControllerConfigurationRequest
|
|
6390
|
+
* @param {*} [options] Override http request option.
|
|
6391
|
+
* @throws {RequiredError}
|
|
6392
|
+
*/
|
|
6393
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotController[], any>>;
|
|
6093
6394
|
/**
|
|
6094
6395
|
* Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
6095
6396
|
* @summary List Robot Configurations
|
|
@@ -6966,7 +7267,7 @@ declare const StoreObjectApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
6966
7267
|
*/
|
|
6967
7268
|
listAllObjectKeys: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6968
7269
|
/**
|
|
6969
|
-
* 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.
|
|
7270
|
+
* 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.
|
|
6970
7271
|
* @summary Store Object
|
|
6971
7272
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6972
7273
|
* @param {string} key
|
|
@@ -7027,7 +7328,7 @@ declare const StoreObjectApiFp: (configuration?: Configuration) => {
|
|
|
7027
7328
|
*/
|
|
7028
7329
|
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
7029
7330
|
/**
|
|
7030
|
-
* 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.
|
|
7331
|
+
* 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.
|
|
7031
7332
|
* @summary Store Object
|
|
7032
7333
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7033
7334
|
* @param {string} key
|
|
@@ -7088,7 +7389,7 @@ declare const StoreObjectApiFactory: (configuration?: Configuration, basePath?:
|
|
|
7088
7389
|
*/
|
|
7089
7390
|
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
7090
7391
|
/**
|
|
7091
|
-
* 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.
|
|
7392
|
+
* 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.
|
|
7092
7393
|
* @summary Store Object
|
|
7093
7394
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7094
7395
|
* @param {string} key
|
|
@@ -7149,7 +7450,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
7149
7450
|
*/
|
|
7150
7451
|
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<string[], any>>;
|
|
7151
7452
|
/**
|
|
7152
|
-
* 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.
|
|
7453
|
+
* 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.
|
|
7153
7454
|
* @summary Store Object
|
|
7154
7455
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7155
7456
|
* @param {string} key
|
|
@@ -7255,7 +7556,7 @@ declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
7255
7556
|
*/
|
|
7256
7557
|
restoreConfiguration: (body: File, resources?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7257
7558
|
/**
|
|
7258
|
-
* 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.
|
|
7559
|
+
* 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.
|
|
7259
7560
|
* @summary Update Wandelbots NOVA version
|
|
7260
7561
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
7261
7562
|
* @param {*} [options] Override http request option.
|
|
@@ -7356,7 +7657,7 @@ declare const SystemApiFp: (configuration?: Configuration) => {
|
|
|
7356
7657
|
*/
|
|
7357
7658
|
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7358
7659
|
/**
|
|
7359
|
-
* 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.
|
|
7660
|
+
* 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.
|
|
7360
7661
|
* @summary Update Wandelbots NOVA version
|
|
7361
7662
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
7362
7663
|
* @param {*} [options] Override http request option.
|
|
@@ -7457,7 +7758,7 @@ declare const SystemApiFactory: (configuration?: Configuration, basePath?: strin
|
|
|
7457
7758
|
*/
|
|
7458
7759
|
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7459
7760
|
/**
|
|
7460
|
-
* 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.
|
|
7761
|
+
* 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.
|
|
7461
7762
|
* @summary Update Wandelbots NOVA version
|
|
7462
7763
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
7463
7764
|
* @param {*} [options] Override http request option.
|
|
@@ -7558,7 +7859,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7558
7859
|
*/
|
|
7559
7860
|
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7560
7861
|
/**
|
|
7561
|
-
* 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.
|
|
7862
|
+
* 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.
|
|
7562
7863
|
* @summary Update Wandelbots NOVA version
|
|
7563
7864
|
* @param {UpdateNovaVersionRequest} updateNovaVersionRequest
|
|
7564
7865
|
* @param {*} [options] Override http request option.
|
|
@@ -7571,7 +7872,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
7571
7872
|
*/
|
|
7572
7873
|
declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7573
7874
|
/**
|
|
7574
|
-
* 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.
|
|
7875
|
+
* 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.
|
|
7575
7876
|
* @summary Add Trajectory
|
|
7576
7877
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7577
7878
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7590,7 +7891,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7590
7891
|
*/
|
|
7591
7892
|
clearTrajectories: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7592
7893
|
/**
|
|
7593
|
-
* 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.
|
|
7894
|
+
* 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.
|
|
7594
7895
|
* @summary Delete Trajectory
|
|
7595
7896
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7596
7897
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7600,7 +7901,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7600
7901
|
*/
|
|
7601
7902
|
deleteTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7602
7903
|
/**
|
|
7603
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7904
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7604
7905
|
* @summary Get Trajectory
|
|
7605
7906
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7606
7907
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7610,7 +7911,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7610
7911
|
*/
|
|
7611
7912
|
getTrajectory: (cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7612
7913
|
/**
|
|
7613
|
-
* 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.
|
|
7914
|
+
* 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.
|
|
7614
7915
|
* @summary List Trajectories
|
|
7615
7916
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7616
7917
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7624,7 +7925,7 @@ declare const TrajectoryCachingApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7624
7925
|
*/
|
|
7625
7926
|
declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
7626
7927
|
/**
|
|
7627
|
-
* 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.
|
|
7928
|
+
* 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.
|
|
7628
7929
|
* @summary Add Trajectory
|
|
7629
7930
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7630
7931
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7643,7 +7944,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
|
7643
7944
|
*/
|
|
7644
7945
|
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7645
7946
|
/**
|
|
7646
|
-
* 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.
|
|
7947
|
+
* 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.
|
|
7647
7948
|
* @summary Delete Trajectory
|
|
7648
7949
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7649
7950
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7653,7 +7954,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
|
7653
7954
|
*/
|
|
7654
7955
|
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7655
7956
|
/**
|
|
7656
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
7957
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7657
7958
|
* @summary Get Trajectory
|
|
7658
7959
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7659
7960
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7663,7 +7964,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
|
7663
7964
|
*/
|
|
7664
7965
|
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrajectoryResponse>>;
|
|
7665
7966
|
/**
|
|
7666
|
-
* 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.
|
|
7967
|
+
* 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.
|
|
7667
7968
|
* @summary List Trajectories
|
|
7668
7969
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7669
7970
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7677,7 +7978,7 @@ declare const TrajectoryCachingApiFp: (configuration?: Configuration) => {
|
|
|
7677
7978
|
*/
|
|
7678
7979
|
declare const TrajectoryCachingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7679
7980
|
/**
|
|
7680
|
-
* 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.
|
|
7981
|
+
* 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.
|
|
7681
7982
|
* @summary Add Trajectory
|
|
7682
7983
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7683
7984
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7696,7 +7997,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
|
|
|
7696
7997
|
*/
|
|
7697
7998
|
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7698
7999
|
/**
|
|
7699
|
-
* 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.
|
|
8000
|
+
* 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.
|
|
7700
8001
|
* @summary Delete Trajectory
|
|
7701
8002
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7702
8003
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7706,7 +8007,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
|
|
|
7706
8007
|
*/
|
|
7707
8008
|
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
7708
8009
|
/**
|
|
7709
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
8010
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7710
8011
|
* @summary Get Trajectory
|
|
7711
8012
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7712
8013
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7716,7 +8017,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
|
|
|
7716
8017
|
*/
|
|
7717
8018
|
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): AxiosPromise<GetTrajectoryResponse>;
|
|
7718
8019
|
/**
|
|
7719
|
-
* 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.
|
|
8020
|
+
* 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.
|
|
7720
8021
|
* @summary List Trajectories
|
|
7721
8022
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7722
8023
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7730,7 +8031,7 @@ declare const TrajectoryCachingApiFactory: (configuration?: Configuration, baseP
|
|
|
7730
8031
|
*/
|
|
7731
8032
|
declare class TrajectoryCachingApi extends BaseAPI {
|
|
7732
8033
|
/**
|
|
7733
|
-
* 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.
|
|
8034
|
+
* 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.
|
|
7734
8035
|
* @summary Add Trajectory
|
|
7735
8036
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7736
8037
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7749,7 +8050,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7749
8050
|
*/
|
|
7750
8051
|
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7751
8052
|
/**
|
|
7752
|
-
* 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.
|
|
8053
|
+
* 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.
|
|
7753
8054
|
* @summary Delete Trajectory
|
|
7754
8055
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7755
8056
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7759,7 +8060,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7759
8060
|
*/
|
|
7760
8061
|
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
7761
8062
|
/**
|
|
7762
|
-
* Get a previously created trajectory from cache. Use [listTrajectories](listTrajectories) to list all cached trajectories.
|
|
8063
|
+
* Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
7763
8064
|
* @summary Get Trajectory
|
|
7764
8065
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7765
8066
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7769,7 +8070,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7769
8070
|
*/
|
|
7770
8071
|
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<GetTrajectoryResponse, any>>;
|
|
7771
8072
|
/**
|
|
7772
|
-
* 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.
|
|
8073
|
+
* 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.
|
|
7773
8074
|
* @summary List Trajectories
|
|
7774
8075
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7775
8076
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7783,7 +8084,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
7783
8084
|
*/
|
|
7784
8085
|
declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7785
8086
|
/**
|
|
7786
|
-
* <!-- 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
|
|
8087
|
+
* <!-- 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.
|
|
7787
8088
|
* @summary Execute Trajectory
|
|
7788
8089
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7789
8090
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7798,7 +8099,7 @@ declare const TrajectoryExecutionApiAxiosParamCreator: (configuration?: Configur
|
|
|
7798
8099
|
*/
|
|
7799
8100
|
declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
|
|
7800
8101
|
/**
|
|
7801
|
-
* <!-- 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
|
|
8102
|
+
* <!-- 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.
|
|
7802
8103
|
* @summary Execute Trajectory
|
|
7803
8104
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7804
8105
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7813,7 +8114,7 @@ declare const TrajectoryExecutionApiFp: (configuration?: Configuration) => {
|
|
|
7813
8114
|
*/
|
|
7814
8115
|
declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7815
8116
|
/**
|
|
7816
|
-
* <!-- 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
|
|
8117
|
+
* <!-- 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.
|
|
7817
8118
|
* @summary Execute Trajectory
|
|
7818
8119
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7819
8120
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7828,7 +8129,7 @@ declare const TrajectoryExecutionApiFactory: (configuration?: Configuration, bas
|
|
|
7828
8129
|
*/
|
|
7829
8130
|
declare class TrajectoryExecutionApi extends BaseAPI {
|
|
7830
8131
|
/**
|
|
7831
|
-
* <!-- 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
|
|
8132
|
+
* <!-- 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.
|
|
7832
8133
|
* @summary Execute Trajectory
|
|
7833
8134
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7834
8135
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -7843,7 +8144,16 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
7843
8144
|
*/
|
|
7844
8145
|
declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7845
8146
|
/**
|
|
7846
|
-
*
|
|
8147
|
+
* <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
|
|
8148
|
+
* @summary Merge Trajectories
|
|
8149
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8150
|
+
* @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
|
|
8151
|
+
* @param {*} [options] Override http request option.
|
|
8152
|
+
* @throws {RequiredError}
|
|
8153
|
+
*/
|
|
8154
|
+
mergeTrajectories: (cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8155
|
+
/**
|
|
8156
|
+
* 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.
|
|
7847
8157
|
* @summary Plan Collision-Free Trajectory
|
|
7848
8158
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7849
8159
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -7852,7 +8162,7 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
|
|
|
7852
8162
|
*/
|
|
7853
8163
|
planCollisionFree: (cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7854
8164
|
/**
|
|
7855
|
-
* 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.
|
|
8165
|
+
* 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.
|
|
7856
8166
|
* @summary Plan Trajectory
|
|
7857
8167
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7858
8168
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -7866,7 +8176,16 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
|
|
|
7866
8176
|
*/
|
|
7867
8177
|
declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
7868
8178
|
/**
|
|
7869
|
-
*
|
|
8179
|
+
* <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
|
|
8180
|
+
* @summary Merge Trajectories
|
|
8181
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8182
|
+
* @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
|
|
8183
|
+
* @param {*} [options] Override http request option.
|
|
8184
|
+
* @throws {RequiredError}
|
|
8185
|
+
*/
|
|
8186
|
+
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MergeTrajectoriesResponse>>;
|
|
8187
|
+
/**
|
|
8188
|
+
* 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.
|
|
7870
8189
|
* @summary Plan Collision-Free Trajectory
|
|
7871
8190
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7872
8191
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -7875,7 +8194,7 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
|
7875
8194
|
*/
|
|
7876
8195
|
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
|
|
7877
8196
|
/**
|
|
7878
|
-
* 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.
|
|
8197
|
+
* 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.
|
|
7879
8198
|
* @summary Plan Trajectory
|
|
7880
8199
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7881
8200
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -7889,7 +8208,16 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
|
7889
8208
|
*/
|
|
7890
8209
|
declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7891
8210
|
/**
|
|
7892
|
-
*
|
|
8211
|
+
* <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
|
|
8212
|
+
* @summary Merge Trajectories
|
|
8213
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8214
|
+
* @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
|
|
8215
|
+
* @param {*} [options] Override http request option.
|
|
8216
|
+
* @throws {RequiredError}
|
|
8217
|
+
*/
|
|
8218
|
+
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<MergeTrajectoriesResponse>;
|
|
8219
|
+
/**
|
|
8220
|
+
* 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.
|
|
7893
8221
|
* @summary Plan Collision-Free Trajectory
|
|
7894
8222
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7895
8223
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -7898,7 +8226,7 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
|
|
|
7898
8226
|
*/
|
|
7899
8227
|
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
|
|
7900
8228
|
/**
|
|
7901
|
-
* 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.
|
|
8229
|
+
* 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.
|
|
7902
8230
|
* @summary Plan Trajectory
|
|
7903
8231
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7904
8232
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -7912,7 +8240,16 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
|
|
|
7912
8240
|
*/
|
|
7913
8241
|
declare class TrajectoryPlanningApi extends BaseAPI {
|
|
7914
8242
|
/**
|
|
7915
|
-
*
|
|
8243
|
+
* <!-- theme: danger --> > **Experimental** Merges a list of joint trajectories into a single trajectory with collision-aware blending. This endpoint merges a list of separate trajectories by connecting them via blending. The blending is performed with collision checking to ensure the merged trajectory is safe to execute. Timescaling will be applied to the blended area to ensure all limits are respected.
|
|
8244
|
+
* @summary Merge Trajectories
|
|
8245
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8246
|
+
* @param {MergeTrajectoriesRequest} mergeTrajectoriesRequest
|
|
8247
|
+
* @param {*} [options] Override http request option.
|
|
8248
|
+
* @throws {RequiredError}
|
|
8249
|
+
*/
|
|
8250
|
+
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MergeTrajectoriesResponse, any>>;
|
|
8251
|
+
/**
|
|
8252
|
+
* 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.
|
|
7916
8253
|
* @summary Plan Collision-Free Trajectory
|
|
7917
8254
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7918
8255
|
* @param {PlanCollisionFreeRequest} planCollisionFreeRequest
|
|
@@ -7921,7 +8258,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
7921
8258
|
*/
|
|
7922
8259
|
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
|
|
7923
8260
|
/**
|
|
7924
|
-
* 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.
|
|
8261
|
+
* 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.
|
|
7925
8262
|
* @summary Plan Trajectory
|
|
7926
8263
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
7927
8264
|
* @param {PlanTrajectoryRequest} planTrajectoryRequest
|
|
@@ -7993,6 +8330,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
7993
8330
|
* @throws {RequiredError}
|
|
7994
8331
|
*/
|
|
7995
8332
|
addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8333
|
+
/**
|
|
8334
|
+
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
8335
|
+
* @summary Add Motion Group
|
|
8336
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8337
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8338
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
8339
|
+
* @param {*} [options] Override http request option.
|
|
8340
|
+
* @throws {RequiredError}
|
|
8341
|
+
*/
|
|
8342
|
+
addVirtualControllerMotionGroup: (cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7996
8343
|
/**
|
|
7997
8344
|
* 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.
|
|
7998
8345
|
* @summary Add TCP
|
|
@@ -8016,6 +8363,16 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8016
8363
|
* @throws {RequiredError}
|
|
8017
8364
|
*/
|
|
8018
8365
|
deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8366
|
+
/**
|
|
8367
|
+
* 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**.
|
|
8368
|
+
* @summary Delete Motion Group
|
|
8369
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8370
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8371
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8372
|
+
* @param {*} [options] Override http request option.
|
|
8373
|
+
* @throws {RequiredError}
|
|
8374
|
+
*/
|
|
8375
|
+
deleteVirtualControllerMotionGroup: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8019
8376
|
/**
|
|
8020
8377
|
* 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.
|
|
8021
8378
|
* @summary Remove TCP
|
|
@@ -8028,7 +8385,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8028
8385
|
*/
|
|
8029
8386
|
deleteVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8030
8387
|
/**
|
|
8031
|
-
* 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.
|
|
8388
|
+
* 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.
|
|
8032
8389
|
* @summary Get Emergency Stop State
|
|
8033
8390
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8034
8391
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8056,7 +8413,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8056
8413
|
*/
|
|
8057
8414
|
getMotionGroups: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8058
8415
|
/**
|
|
8059
|
-
* 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.
|
|
8416
|
+
* 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.
|
|
8060
8417
|
* @summary Get Operation Mode
|
|
8061
8418
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8062
8419
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8094,7 +8451,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8094
8451
|
*/
|
|
8095
8452
|
listVirtualControllerTcps: (cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8096
8453
|
/**
|
|
8097
|
-
* 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.
|
|
8454
|
+
* 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.
|
|
8098
8455
|
* @summary Push or Release Emergency Stop
|
|
8099
8456
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8100
8457
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8115,7 +8472,7 @@ declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8115
8472
|
*/
|
|
8116
8473
|
setMotionGroupState: (cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8117
8474
|
/**
|
|
8118
|
-
* 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.
|
|
8475
|
+
* 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.
|
|
8119
8476
|
* @summary Set Operation Mode
|
|
8120
8477
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8121
8478
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8151,6 +8508,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8151
8508
|
* @throws {RequiredError}
|
|
8152
8509
|
*/
|
|
8153
8510
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8511
|
+
/**
|
|
8512
|
+
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
8513
|
+
* @summary Add Motion Group
|
|
8514
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8515
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8516
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
8517
|
+
* @param {*} [options] Override http request option.
|
|
8518
|
+
* @throws {RequiredError}
|
|
8519
|
+
*/
|
|
8520
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8154
8521
|
/**
|
|
8155
8522
|
* 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.
|
|
8156
8523
|
* @summary Add TCP
|
|
@@ -8174,6 +8541,16 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8174
8541
|
* @throws {RequiredError}
|
|
8175
8542
|
*/
|
|
8176
8543
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8544
|
+
/**
|
|
8545
|
+
* 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**.
|
|
8546
|
+
* @summary Delete Motion Group
|
|
8547
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8548
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8549
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8550
|
+
* @param {*} [options] Override http request option.
|
|
8551
|
+
* @throws {RequiredError}
|
|
8552
|
+
*/
|
|
8553
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8177
8554
|
/**
|
|
8178
8555
|
* 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.
|
|
8179
8556
|
* @summary Remove TCP
|
|
@@ -8186,7 +8563,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8186
8563
|
*/
|
|
8187
8564
|
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8188
8565
|
/**
|
|
8189
|
-
* 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.
|
|
8566
|
+
* 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.
|
|
8190
8567
|
* @summary Get Emergency Stop State
|
|
8191
8568
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8192
8569
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8214,7 +8591,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8214
8591
|
*/
|
|
8215
8592
|
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MotionGroupInfo>>>;
|
|
8216
8593
|
/**
|
|
8217
|
-
* 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.
|
|
8594
|
+
* 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.
|
|
8218
8595
|
* @summary Get Operation Mode
|
|
8219
8596
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8220
8597
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8252,7 +8629,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8252
8629
|
*/
|
|
8253
8630
|
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RobotTcp>>>;
|
|
8254
8631
|
/**
|
|
8255
|
-
* 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.
|
|
8632
|
+
* 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.
|
|
8256
8633
|
* @summary Push or Release Emergency Stop
|
|
8257
8634
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8258
8635
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8273,7 +8650,7 @@ declare const VirtualControllerApiFp: (configuration?: Configuration) => {
|
|
|
8273
8650
|
*/
|
|
8274
8651
|
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
8275
8652
|
/**
|
|
8276
|
-
* 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.
|
|
8653
|
+
* 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.
|
|
8277
8654
|
* @summary Set Operation Mode
|
|
8278
8655
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8279
8656
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8309,6 +8686,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8309
8686
|
* @throws {RequiredError}
|
|
8310
8687
|
*/
|
|
8311
8688
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8689
|
+
/**
|
|
8690
|
+
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
8691
|
+
* @summary Add Motion Group
|
|
8692
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8693
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8694
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
8695
|
+
* @param {*} [options] Override http request option.
|
|
8696
|
+
* @throws {RequiredError}
|
|
8697
|
+
*/
|
|
8698
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8312
8699
|
/**
|
|
8313
8700
|
* 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.
|
|
8314
8701
|
* @summary Add TCP
|
|
@@ -8332,6 +8719,16 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8332
8719
|
* @throws {RequiredError}
|
|
8333
8720
|
*/
|
|
8334
8721
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8722
|
+
/**
|
|
8723
|
+
* 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**.
|
|
8724
|
+
* @summary Delete Motion Group
|
|
8725
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8726
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8727
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8728
|
+
* @param {*} [options] Override http request option.
|
|
8729
|
+
* @throws {RequiredError}
|
|
8730
|
+
*/
|
|
8731
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8335
8732
|
/**
|
|
8336
8733
|
* 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.
|
|
8337
8734
|
* @summary Remove TCP
|
|
@@ -8344,7 +8741,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8344
8741
|
*/
|
|
8345
8742
|
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8346
8743
|
/**
|
|
8347
|
-
* 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.
|
|
8744
|
+
* 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.
|
|
8348
8745
|
* @summary Get Emergency Stop State
|
|
8349
8746
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8350
8747
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8372,7 +8769,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8372
8769
|
*/
|
|
8373
8770
|
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<MotionGroupInfo>>;
|
|
8374
8771
|
/**
|
|
8375
|
-
* 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.
|
|
8772
|
+
* 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.
|
|
8376
8773
|
* @summary Get Operation Mode
|
|
8377
8774
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8378
8775
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8410,7 +8807,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8410
8807
|
*/
|
|
8411
8808
|
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RobotTcp>>;
|
|
8412
8809
|
/**
|
|
8413
|
-
* 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.
|
|
8810
|
+
* 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.
|
|
8414
8811
|
* @summary Push or Release Emergency Stop
|
|
8415
8812
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8416
8813
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8431,7 +8828,7 @@ declare const VirtualControllerApiFactory: (configuration?: Configuration, baseP
|
|
|
8431
8828
|
*/
|
|
8432
8829
|
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
8433
8830
|
/**
|
|
8434
|
-
* 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.
|
|
8831
|
+
* 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.
|
|
8435
8832
|
* @summary Set Operation Mode
|
|
8436
8833
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8437
8834
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8467,6 +8864,16 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8467
8864
|
* @throws {RequiredError}
|
|
8468
8865
|
*/
|
|
8469
8866
|
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8867
|
+
/**
|
|
8868
|
+
* Adds a motion group configuration for the virtual robot controller. Fields: - Only one of **motion_group_model** or **json_data** should be set. - **motion_group_model**: Identifies a single motion group. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types. - **json_data**: Full JSON configuration of the virtual robot controller. This can be obtained from the physical controller\'s configuration via [getVirtualControllerConfiguration](#/operations/getVirtualControllerConfiguration). - **extracted_motion_group_id** (required when using json_data): The motion group identifier to extract from the provided JSON configuration. - **motion_group**: Unique identifier for the motion group to be added. - **initial_joint_position**: Specifies the initial joint position for the added motion group. <!-- theme: info --> > #### NOTE > > When a motion group is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Motion group changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself **does not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new motion group may not yet be available for use.
|
|
8869
|
+
* @summary Add Motion Group
|
|
8870
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8871
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8872
|
+
* @param {AddVirtualControllerMotionGroupRequest} addVirtualControllerMotionGroupRequest
|
|
8873
|
+
* @param {*} [options] Override http request option.
|
|
8874
|
+
* @throws {RequiredError}
|
|
8875
|
+
*/
|
|
8876
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8470
8877
|
/**
|
|
8471
8878
|
* 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.
|
|
8472
8879
|
* @summary Add TCP
|
|
@@ -8490,6 +8897,16 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8490
8897
|
* @throws {RequiredError}
|
|
8491
8898
|
*/
|
|
8492
8899
|
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8900
|
+
/**
|
|
8901
|
+
* 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**.
|
|
8902
|
+
* @summary Delete Motion Group
|
|
8903
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8904
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8905
|
+
* @param {string} motionGroup The motion-group identifier.
|
|
8906
|
+
* @param {*} [options] Override http request option.
|
|
8907
|
+
* @throws {RequiredError}
|
|
8908
|
+
*/
|
|
8909
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8493
8910
|
/**
|
|
8494
8911
|
* 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.
|
|
8495
8912
|
* @summary Remove TCP
|
|
@@ -8502,7 +8919,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8502
8919
|
*/
|
|
8503
8920
|
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8504
8921
|
/**
|
|
8505
|
-
* 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.
|
|
8922
|
+
* 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.
|
|
8506
8923
|
* @summary Get Emergency Stop State
|
|
8507
8924
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8508
8925
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8530,7 +8947,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8530
8947
|
*/
|
|
8531
8948
|
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<MotionGroupInfo[], any>>;
|
|
8532
8949
|
/**
|
|
8533
|
-
* 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.
|
|
8950
|
+
* 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.
|
|
8534
8951
|
* @summary Get Operation Mode
|
|
8535
8952
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8536
8953
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8568,7 +8985,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8568
8985
|
*/
|
|
8569
8986
|
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<RobotTcp[], any>>;
|
|
8570
8987
|
/**
|
|
8571
|
-
* 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.
|
|
8988
|
+
* 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.
|
|
8572
8989
|
* @summary Push or Release Emergency Stop
|
|
8573
8990
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8574
8991
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8589,7 +9006,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8589
9006
|
*/
|
|
8590
9007
|
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8591
9008
|
/**
|
|
8592
|
-
* 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.
|
|
9009
|
+
* 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.
|
|
8593
9010
|
* @summary Set Operation Mode
|
|
8594
9011
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8595
9012
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8615,7 +9032,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
8615
9032
|
*/
|
|
8616
9033
|
declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8617
9034
|
/**
|
|
8618
|
-
* <!-- 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.
|
|
9035
|
+
* <!-- 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.
|
|
8619
9036
|
* @summary Stream Joint Configuration
|
|
8620
9037
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8621
9038
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8634,7 +9051,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
|
|
|
8634
9051
|
*/
|
|
8635
9052
|
getCycleTime: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8636
9053
|
/**
|
|
8637
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
9054
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
8638
9055
|
* @summary Get Behavior
|
|
8639
9056
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8640
9057
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8658,7 +9075,7 @@ declare const VirtualControllerBehaviorApiAxiosParamCreator: (configuration?: Co
|
|
|
8658
9075
|
*/
|
|
8659
9076
|
declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) => {
|
|
8660
9077
|
/**
|
|
8661
|
-
* <!-- 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.
|
|
9078
|
+
* <!-- 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.
|
|
8662
9079
|
* @summary Stream Joint Configuration
|
|
8663
9080
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8664
9081
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8677,7 +9094,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
|
|
|
8677
9094
|
*/
|
|
8678
9095
|
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CycleTime>>;
|
|
8679
9096
|
/**
|
|
8680
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
9097
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
8681
9098
|
* @summary Get Behavior
|
|
8682
9099
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8683
9100
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8701,7 +9118,7 @@ declare const VirtualControllerBehaviorApiFp: (configuration?: Configuration) =>
|
|
|
8701
9118
|
*/
|
|
8702
9119
|
declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8703
9120
|
/**
|
|
8704
|
-
* <!-- 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.
|
|
9121
|
+
* <!-- 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.
|
|
8705
9122
|
* @summary Stream Joint Configuration
|
|
8706
9123
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8707
9124
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8720,7 +9137,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
|
|
|
8720
9137
|
*/
|
|
8721
9138
|
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<CycleTime>;
|
|
8722
9139
|
/**
|
|
8723
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
9140
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
8724
9141
|
* @summary Get Behavior
|
|
8725
9142
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8726
9143
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8744,7 +9161,7 @@ declare const VirtualControllerBehaviorApiFactory: (configuration?: Configuratio
|
|
|
8744
9161
|
*/
|
|
8745
9162
|
declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
8746
9163
|
/**
|
|
8747
|
-
* <!-- 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.
|
|
9164
|
+
* <!-- 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.
|
|
8748
9165
|
* @summary Stream Joint Configuration
|
|
8749
9166
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8750
9167
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8763,7 +9180,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8763
9180
|
*/
|
|
8764
9181
|
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<CycleTime, any>>;
|
|
8765
9182
|
/**
|
|
8766
|
-
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](setVirtualControllerBehavior) and the body for details.
|
|
9183
|
+
* Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
8767
9184
|
* @summary Get Behavior
|
|
8768
9185
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8769
9186
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8787,7 +9204,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
8787
9204
|
*/
|
|
8788
9205
|
declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8789
9206
|
/**
|
|
8790
|
-
* 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).
|
|
9207
|
+
* 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).
|
|
8791
9208
|
* @summary Get Input/Output Values
|
|
8792
9209
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8793
9210
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8825,7 +9242,7 @@ declare const VirtualControllerInputsOutputsApiAxiosParamCreator: (configuration
|
|
|
8825
9242
|
*/
|
|
8826
9243
|
declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuration) => {
|
|
8827
9244
|
/**
|
|
8828
|
-
* 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).
|
|
9245
|
+
* 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).
|
|
8829
9246
|
* @summary Get Input/Output Values
|
|
8830
9247
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8831
9248
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8863,7 +9280,7 @@ declare const VirtualControllerInputsOutputsApiFp: (configuration?: Configuratio
|
|
|
8863
9280
|
*/
|
|
8864
9281
|
declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8865
9282
|
/**
|
|
8866
|
-
* 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).
|
|
9283
|
+
* 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).
|
|
8867
9284
|
* @summary Get Input/Output Values
|
|
8868
9285
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8869
9286
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8901,7 +9318,7 @@ declare const VirtualControllerInputsOutputsApiFactory: (configuration?: Configu
|
|
|
8901
9318
|
*/
|
|
8902
9319
|
declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
8903
9320
|
/**
|
|
8904
|
-
* 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).
|
|
9321
|
+
* 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).
|
|
8905
9322
|
* @summary Get Input/Output Values
|
|
8906
9323
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8907
9324
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8935,4 +9352,4 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
8935
9352
|
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<void, any>>;
|
|
8936
9353
|
}
|
|
8937
9354
|
//#endregion
|
|
8938
|
-
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 };
|
|
9355
|
+
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, MergeTrajectories422Response, MergeTrajectoriesError, MergeTrajectoriesRequest, MergeTrajectoriesResponse, MergeTrajectoriesResponseFeedbackInner, MergeTrajectoriesSegment, MergeTrajectoriesValidationError, 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, RobotControllerConfigurationRequest, 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, TrajectorySection, 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 };
|