@wandelbots/nova-api 26.6.0-dev.14 → 26.6.0-dev.140
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/v2/index.cjs +816 -502
- package/dist/v2/index.d.cts +827 -218
- package/dist/v2/index.d.ts +827 -218
- package/dist/v2/index.js +399 -127
- package/package.json +1 -6
- package/dist/defineProperty-6Ts4XR6h.js +0 -39
- package/dist/defineProperty-D0JvJyYC.cjs +0 -72
- package/dist/v1/index.cjs +0 -10324
- package/dist/v1/index.d.cts +0 -11386
- package/dist/v1/index.d.ts +0 -11386
- package/dist/v1/index.js +0 -10135
package/dist/v2/index.js
CHANGED
|
@@ -1,5 +1,42 @@
|
|
|
1
|
-
import { t as _defineProperty } from "../defineProperty-6Ts4XR6h.js";
|
|
2
1
|
import globalAxios from "axios";
|
|
2
|
+
//#region \0@oxc-project+runtime@0.126.0/helpers/typeof.js
|
|
3
|
+
function _typeof(o) {
|
|
4
|
+
"@babel/helpers - typeof";
|
|
5
|
+
return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
|
|
6
|
+
return typeof o;
|
|
7
|
+
} : function(o) {
|
|
8
|
+
return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
|
|
9
|
+
}, _typeof(o);
|
|
10
|
+
}
|
|
11
|
+
//#endregion
|
|
12
|
+
//#region \0@oxc-project+runtime@0.126.0/helpers/toPrimitive.js
|
|
13
|
+
function toPrimitive(t, r) {
|
|
14
|
+
if ("object" != _typeof(t) || !t) return t;
|
|
15
|
+
var e = t[Symbol.toPrimitive];
|
|
16
|
+
if (void 0 !== e) {
|
|
17
|
+
var i = e.call(t, r || "default");
|
|
18
|
+
if ("object" != _typeof(i)) return i;
|
|
19
|
+
throw new TypeError("@@toPrimitive must return a primitive value.");
|
|
20
|
+
}
|
|
21
|
+
return ("string" === r ? String : Number)(t);
|
|
22
|
+
}
|
|
23
|
+
//#endregion
|
|
24
|
+
//#region \0@oxc-project+runtime@0.126.0/helpers/toPropertyKey.js
|
|
25
|
+
function toPropertyKey(t) {
|
|
26
|
+
var i = toPrimitive(t, "string");
|
|
27
|
+
return "symbol" == _typeof(i) ? i : i + "";
|
|
28
|
+
}
|
|
29
|
+
//#endregion
|
|
30
|
+
//#region \0@oxc-project+runtime@0.126.0/helpers/defineProperty.js
|
|
31
|
+
function _defineProperty(e, r, t) {
|
|
32
|
+
return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
|
|
33
|
+
value: t,
|
|
34
|
+
enumerable: !0,
|
|
35
|
+
configurable: !0,
|
|
36
|
+
writable: !0
|
|
37
|
+
}) : e[r] = t, e;
|
|
38
|
+
}
|
|
39
|
+
//#endregion
|
|
3
40
|
//#region v2/base.ts
|
|
4
41
|
const BASE_PATH = "/api/v2".replace(/\/+$/, "");
|
|
5
42
|
const COLLECTION_FORMATS = {
|
|
@@ -71,6 +108,8 @@ const createRequestFunction = function(axiosArgs, globalAxios, BASE_PATH, config
|
|
|
71
108
|
//#endregion
|
|
72
109
|
//#region v2/api.ts
|
|
73
110
|
const AbbControllerKindEnum = { AbbController: "AbbController" };
|
|
111
|
+
const ActionChunkRequestMessageTypeEnum = { ActionChunkRequest: "ActionChunkRequest" };
|
|
112
|
+
const ActionChunkResponseKindEnum = { ActionChunkReceived: "ACTION_CHUNK_RECEIVED" };
|
|
74
113
|
/**
|
|
75
114
|
* ## 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).
|
|
76
115
|
*/
|
|
@@ -89,6 +128,8 @@ const BlendingSpace = {
|
|
|
89
128
|
Cartesian: "CARTESIAN"
|
|
90
129
|
};
|
|
91
130
|
const BooleanValueValueTypeEnum = { Boolean: "boolean" };
|
|
131
|
+
const BostondynamicsControllerKindEnum = { BostondynamicsController: "BostondynamicsController" };
|
|
132
|
+
const BostondynamicsControllerRobotTypeEnum = { Spot: "spot" };
|
|
92
133
|
const BoxShapeTypeEnum = { Box: "box" };
|
|
93
134
|
const BoxBoxTypeEnum = {
|
|
94
135
|
Hollow: "HOLLOW",
|
|
@@ -201,6 +242,8 @@ const IOValueType = {
|
|
|
201
242
|
IoValueAnalogInteger: "IO_VALUE_ANALOG_INTEGER"
|
|
202
243
|
};
|
|
203
244
|
const InconsistentTrajectorySizeErrorKindEnum = { InconsistentTrajectorySizeError: "InconsistentTrajectorySizeError" };
|
|
245
|
+
const InitializeActionChunksRequestMessageTypeEnum = { InitializeActionChunksRequest: "InitializeActionChunksRequest" };
|
|
246
|
+
const InitializeActionChunksResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
|
|
204
247
|
const InitializeJoggingRequestMessageTypeEnum = { InitializeJoggingRequest: "InitializeJoggingRequest" };
|
|
205
248
|
const InitializeJoggingResponseKindEnum = { InitializeReceived: "INITIALIZE_RECEIVED" };
|
|
206
249
|
const InitializeMovementRequestMessageTypeEnum = { InitializeMovementRequest: "InitializeMovementRequest" };
|
|
@@ -221,8 +264,7 @@ const JointTypeEnum = {
|
|
|
221
264
|
};
|
|
222
265
|
const JointVelocityRequestMessageTypeEnum = { JointVelocityRequest: "JointVelocityRequest" };
|
|
223
266
|
const JointVelocityResponseKindEnum = { JointVelocityReceived: "JOINT_VELOCITY_RECEIVED" };
|
|
224
|
-
const
|
|
225
|
-
const JointWaypointsResponseKindEnum = { JointWaypointsReceived: "JOINT_WAYPOINTS_RECEIVED" };
|
|
267
|
+
const JointWaypointKindEnum = { Joints: "JOINTS" };
|
|
226
268
|
const KinematicBranchElbow = {
|
|
227
269
|
Up: "UP",
|
|
228
270
|
Down: "DOWN"
|
|
@@ -246,9 +288,12 @@ const LicenseStatusEnum = {
|
|
|
246
288
|
const LinkChainValueSourceEnum = { Value: "value" };
|
|
247
289
|
const Manufacturer = {
|
|
248
290
|
Abb: "abb",
|
|
291
|
+
Bostondynamics: "bostondynamics",
|
|
249
292
|
Fanuc: "fanuc",
|
|
250
293
|
Kuka: "kuka",
|
|
251
294
|
Staubli: "staubli",
|
|
295
|
+
Techman: "techman",
|
|
296
|
+
Unitree: "unitree",
|
|
252
297
|
Universalrobots: "universalrobots",
|
|
253
298
|
Yaskawa: "yaskawa"
|
|
254
299
|
};
|
|
@@ -284,12 +329,19 @@ const ModbusIOTypeEnum = {
|
|
|
284
329
|
};
|
|
285
330
|
const MovementErrorResponseKindEnum = { MotionError: "MOTION_ERROR" };
|
|
286
331
|
const NanValueErrorKindEnum = { NanValueError: "NanValueError" };
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
332
|
+
/**
|
|
333
|
+
* Network attachment method used to expose the interface to workloads.
|
|
334
|
+
*/
|
|
335
|
+
const NetworkBackend = {
|
|
336
|
+
Macvlan: "macvlan",
|
|
337
|
+
Sriov: "sriov"
|
|
338
|
+
};
|
|
339
|
+
/**
|
|
340
|
+
* Link state of the physical interface.
|
|
341
|
+
*/
|
|
342
|
+
const NetworkLinkState = {
|
|
343
|
+
Up: "up",
|
|
344
|
+
Down: "down"
|
|
293
345
|
};
|
|
294
346
|
/**
|
|
295
347
|
* The operating state.
|
|
@@ -351,6 +403,8 @@ const PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum = { DirectionCo
|
|
|
351
403
|
const PathDirectionConstrainedJointPTPPathDefinitionNameEnum = { DirectionConstrainedJointPtp: "DirectionConstrainedJointPTP" };
|
|
352
404
|
const PathJointPTPPathDefinitionNameEnum = { PathJointPtp: "PathJointPTP" };
|
|
353
405
|
const PathLinePathDefinitionNameEnum = { PathLine: "PathLine" };
|
|
406
|
+
const PauseActionChunksRequestMessageTypeEnum = { PauseActionChunksRequest: "PauseActionChunksRequest" };
|
|
407
|
+
const PauseActionChunksResponseKindEnum = { PauseReceived: "PAUSE_RECEIVED" };
|
|
354
408
|
const PauseJoggingRequestMessageTypeEnum = { PauseJoggingRequest: "PauseJoggingRequest" };
|
|
355
409
|
const PauseJoggingResponseKindEnum = { PauseReceived: "PAUSE_RECEIVED" };
|
|
356
410
|
const PauseMovementRequestMessageTypeEnum = { PauseMovementRequest: "PauseMovementRequest" };
|
|
@@ -358,8 +412,7 @@ const PauseMovementResponseKindEnum = { PauseReceived: "PAUSE_RECEIVED" };
|
|
|
358
412
|
const PlaneShapeTypeEnum = { Plane: "plane" };
|
|
359
413
|
const PlaybackSpeedRequestMessageTypeEnum = { PlaybackSpeedRequest: "PlaybackSpeedRequest" };
|
|
360
414
|
const PlaybackSpeedResponseKindEnum = { PlaybackSpeedReceived: "PLAYBACK_SPEED_RECEIVED" };
|
|
361
|
-
const
|
|
362
|
-
const PoseWaypointsResponseKindEnum = { PoseWaypointsReceived: "POSE_WAYPOINTS_RECEIVED" };
|
|
415
|
+
const PoseWaypointKindEnum = { Pose: "POSE" };
|
|
363
416
|
/**
|
|
364
417
|
* The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
365
418
|
*/
|
|
@@ -470,6 +523,14 @@ const SettableRobotSystemMode = {
|
|
|
470
523
|
RobotSystemModeControl: "ROBOT_SYSTEM_MODE_CONTROL",
|
|
471
524
|
ModeControl: "MODE_CONTROL"
|
|
472
525
|
};
|
|
526
|
+
/**
|
|
527
|
+
* <!-- theme: danger --> > > **Experimental** Strategy used to deal with wrist singularities along a cartesian path. > > - `NONE`: No special handling; a singularity ends the path. > - `PALLETIZING_WRIST`: When performing a palletizing motion, attempt to bridge a wrist singularity by flipping the wrist branch. > A palletizing motion is a motion where the flange axis of rotation is alway parallel to the base axis of rotation. > This flag is supported for all robots except FANUC CRX and ABB GoFa. > - `ADAPTIVE_SAMPLING`: Alternative cartesian solver that re-samples the path in proximity to a singularity.
|
|
528
|
+
*/
|
|
529
|
+
const SingularityHandling = {
|
|
530
|
+
None: "NONE",
|
|
531
|
+
PalletizingWrist: "PALLETIZING_WRIST",
|
|
532
|
+
AdaptiveSampling: "ADAPTIVE_SAMPLING"
|
|
533
|
+
};
|
|
473
534
|
const SingularityTypeEnum = {
|
|
474
535
|
Wrist: "WRIST",
|
|
475
536
|
Elbow: "ELBOW",
|
|
@@ -509,10 +570,14 @@ const Snap7IOTypeEnum = {
|
|
|
509
570
|
const SphereShapeTypeEnum = { Sphere: "sphere" };
|
|
510
571
|
const StartMovementRequestMessageTypeEnum = { StartMovementRequest: "StartMovementRequest" };
|
|
511
572
|
const StartMovementResponseKindEnum = { StartReceived: "START_RECEIVED" };
|
|
573
|
+
const StaubliControllerKindEnum = { StaubliController: "StaubliController" };
|
|
574
|
+
const StopActionChunksRequestMessageTypeEnum = { StopActionChunksRequest: "StopActionChunksRequest" };
|
|
575
|
+
const StopActionChunksResponseKindEnum = { StopReceived: "STOP_RECEIVED" };
|
|
512
576
|
const StorageKeySourceEnum = { Key: "key" };
|
|
513
577
|
const TcpRequiredErrorKindEnum = { TcpRequiredError: "TcpRequiredError" };
|
|
514
578
|
const TcpVelocityRequestMessageTypeEnum = { TcpVelocityRequest: "TcpVelocityRequest" };
|
|
515
579
|
const TcpVelocityResponseKindEnum = { TcpVelocityReceived: "TCP_VELOCITY_RECEIVED" };
|
|
580
|
+
const TechmanControllerKindEnum = { TechmanController: "TechmanController" };
|
|
516
581
|
const ToolValueSourceEnum = { Value: "value" };
|
|
517
582
|
const TorqueExceededErrorKindEnum = { TorqueExceededError: "TorqueExceededError" };
|
|
518
583
|
const TrajectoryDataMessageTypeEnum = { TrajectoryData: "TrajectoryData" };
|
|
@@ -538,11 +603,93 @@ const UnitType = {
|
|
|
538
603
|
UnitNewtonMeter: "UNIT_NEWTON_METER",
|
|
539
604
|
UnitMeter: "UNIT_METER"
|
|
540
605
|
};
|
|
606
|
+
const UnitreeControllerKindEnum = { UnitreeController: "UnitreeController" };
|
|
607
|
+
const UnitreeControllerRobotTypeEnum = {
|
|
608
|
+
Go2: "go2",
|
|
609
|
+
G1: "g1",
|
|
610
|
+
B2: "b2",
|
|
611
|
+
H1: "h1"
|
|
612
|
+
};
|
|
541
613
|
const UniversalrobotsControllerKindEnum = { UniversalrobotsController: "UniversalrobotsController" };
|
|
614
|
+
const UnpauseActionChunksRequestMessageTypeEnum = { UnpauseActionChunksRequest: "UnpauseActionChunksRequest" };
|
|
615
|
+
const UnpauseActionChunksResponseKindEnum = { UnpauseReceived: "UNPAUSE_RECEIVED" };
|
|
542
616
|
const VirtualControllerKindEnum = { VirtualController: "VirtualController" };
|
|
543
617
|
const YaskawaControllerKindEnum = { YaskawaController: "YaskawaController" };
|
|
544
618
|
const ZodValidationErrorErrorCodeEnum = { ValidationError: "validation_error" };
|
|
545
619
|
/**
|
|
620
|
+
* ActionChunkStreamingApi - axios parameter creator
|
|
621
|
+
*/
|
|
622
|
+
const ActionChunkStreamingApiAxiosParamCreator = function(configuration) {
|
|
623
|
+
return { executeActionChunks: async (cell, controller, executeActionChunksRequest, options = {}) => {
|
|
624
|
+
assertParamExists("executeActionChunks", "cell", cell);
|
|
625
|
+
assertParamExists("executeActionChunks", "controller", controller);
|
|
626
|
+
assertParamExists("executeActionChunks", "executeActionChunksRequest", executeActionChunksRequest);
|
|
627
|
+
const localVarPath = `/experimental/cells/{cell}/controllers/{controller}/execution/action-chunk-streaming`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
|
|
628
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
629
|
+
let baseOptions;
|
|
630
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
631
|
+
const localVarRequestOptions = {
|
|
632
|
+
method: "GET",
|
|
633
|
+
...baseOptions,
|
|
634
|
+
...options
|
|
635
|
+
};
|
|
636
|
+
const localVarHeaderParameter = {};
|
|
637
|
+
const localVarQueryParameter = {};
|
|
638
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
639
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
640
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
641
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
642
|
+
localVarRequestOptions.headers = {
|
|
643
|
+
...localVarHeaderParameter,
|
|
644
|
+
...headersFromBaseOptions,
|
|
645
|
+
...options.headers
|
|
646
|
+
};
|
|
647
|
+
localVarRequestOptions.data = serializeDataIfNeeded(executeActionChunksRequest, localVarRequestOptions, configuration);
|
|
648
|
+
return {
|
|
649
|
+
url: toPathString(localVarUrlObj),
|
|
650
|
+
options: localVarRequestOptions
|
|
651
|
+
};
|
|
652
|
+
} };
|
|
653
|
+
};
|
|
654
|
+
/**
|
|
655
|
+
* ActionChunkStreamingApi - functional programming interface
|
|
656
|
+
*/
|
|
657
|
+
const ActionChunkStreamingApiFp = function(configuration) {
|
|
658
|
+
const localVarAxiosParamCreator = ActionChunkStreamingApiAxiosParamCreator(configuration);
|
|
659
|
+
return { async executeActionChunks(cell, controller, executeActionChunksRequest, options) {
|
|
660
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeActionChunks(cell, controller, executeActionChunksRequest, options);
|
|
661
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
662
|
+
const localVarOperationServerBasePath = operationServerMap["ActionChunkStreamingApi.executeActionChunks"]?.[localVarOperationServerIndex]?.url;
|
|
663
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
664
|
+
} };
|
|
665
|
+
};
|
|
666
|
+
/**
|
|
667
|
+
* ActionChunkStreamingApi - factory interface
|
|
668
|
+
*/
|
|
669
|
+
const ActionChunkStreamingApiFactory = function(configuration, basePath, axios) {
|
|
670
|
+
const localVarFp = ActionChunkStreamingApiFp(configuration);
|
|
671
|
+
return { executeActionChunks(cell, controller, executeActionChunksRequest, options) {
|
|
672
|
+
return localVarFp.executeActionChunks(cell, controller, executeActionChunksRequest, options).then((request) => request(axios, basePath));
|
|
673
|
+
} };
|
|
674
|
+
};
|
|
675
|
+
/**
|
|
676
|
+
* ActionChunkStreamingApi - object-oriented interface
|
|
677
|
+
*/
|
|
678
|
+
var ActionChunkStreamingApi = class extends BaseAPI {
|
|
679
|
+
/**
|
|
680
|
+
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: danger --> > **Experimental** > > This endpoint is experimental and its behavior may change in future releases. > Websocket endpoint Provides action chunk control for a motion group. An action chunk is a queue of timed waypoints that the robot moves through by best effort. This can be used for realtime action chunk streaming, e.g., from a Vision-Language-Action (VLA) model. ### Preconditions The motion group is not moved by any other endpoint. ### Requests #### 1. Send `InitializeActionChunksRequest` to configure the action chunk. - Sets the robot controller mode to control mode. - Claims the motion group. For robotic arms, TCP is required to ensure that limits, including TCP limits, are respected. #### 2. Send `ActionChunk`s to stream waypoints. - The first message starts an internal clock. - Each waypoint carries a timestamp relative to that clock for when it should be reached. - Existing waypoints in the queue that are older than the first new timestamp are removed. - The current session timestamp is reported in `execute.details.jogger_session_timestamp_ms` of the [streamRobotControllerState](#/operations/streamRobotControllerState) endpoint. #### 3. Stop the motion - Send `PauseActionChunksRequest` to stop the motion. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeActionChunksResponse` after `InitializeActionChunksRequest` - `ActionChunkResponse` after `ActionChunkRequest` - `PauseActionChunksResponse` after `PauseActionChunksRequest` 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 moving. ### Tips and Tricks - Ensure that the websocket connection remains open until the action chunk motion is stopped to avoid unexpected stops. ### Robot States - The robot controller state is reported in the [streamRobotControllerState](#/operations/streamRobotControllerState) as JOGGING. - The meaning of the states is: - `RUNNING`: The robot is moving through the waypoints. The clock (`execute.details.jogger_session_timestamp_ms`) is running. - `PAUSED_BY_USER`: The robot is braking or in standstill due to a user request. The clock IS paused. - `PAUSED_NEAR_JOINT_LIMIT`: The robot is braking due to a joint limit. The clock is NOT paused. - `PAUSED_NEAR_COLLISION`: The robot is braking due to a collision. The clock is NOT paused. - `PAUSED_NEAR_SINGULARITY`: The robot is braking due to a singularity. The clock is NOT paused. - `PAUSED_NEAR_WORKSPACE_BOUNDARY`: The robot is braking due to a workspace boundary. The clock is NOT paused.
|
|
681
|
+
* @summary Execute Action Chunks
|
|
682
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
683
|
+
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
684
|
+
* @param {ExecuteActionChunksRequest} executeActionChunksRequest
|
|
685
|
+
* @param {*} [options] Override http request option.
|
|
686
|
+
* @throws {RequiredError}
|
|
687
|
+
*/
|
|
688
|
+
executeActionChunks(cell, controller, executeActionChunksRequest, options) {
|
|
689
|
+
return ActionChunkStreamingApiFp(this.configuration).executeActionChunks(cell, controller, executeActionChunksRequest, options).then((request) => request(this.axios, this.basePath));
|
|
690
|
+
}
|
|
691
|
+
};
|
|
692
|
+
/**
|
|
546
693
|
* ApplicationApi - axios parameter creator
|
|
547
694
|
*/
|
|
548
695
|
const ApplicationApiAxiosParamCreator = function(configuration) {
|
|
@@ -1304,7 +1451,7 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1304
1451
|
options: localVarRequestOptions
|
|
1305
1452
|
};
|
|
1306
1453
|
},
|
|
1307
|
-
getProfinetIOsFromFile: async (cell, inputOffset, outputOffset, options = {}) => {
|
|
1454
|
+
getProfinetIOsFromFile: async (cell, offsets, inputOffset, outputOffset, options = {}) => {
|
|
1308
1455
|
assertParamExists("getProfinetIOsFromFile", "cell", cell);
|
|
1309
1456
|
const localVarPath = `/cells/{cell}/bus-ios/profinet/iofile`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
1310
1457
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1318,6 +1465,7 @@ const BUSInputsOutputsApiAxiosParamCreator = function(configuration) {
|
|
|
1318
1465
|
const localVarHeaderParameter = {};
|
|
1319
1466
|
const localVarQueryParameter = {};
|
|
1320
1467
|
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1468
|
+
if (offsets) localVarQueryParameter["offsets"] = offsets.join(COLLECTION_FORMATS.csv);
|
|
1321
1469
|
if (inputOffset !== void 0) localVarQueryParameter["input_offset"] = inputOffset;
|
|
1322
1470
|
if (outputOffset !== void 0) localVarQueryParameter["output_offset"] = outputOffset;
|
|
1323
1471
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1598,8 +1746,8 @@ const BUSInputsOutputsApiFp = function(configuration) {
|
|
|
1598
1746
|
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.getProfinetGSDML"]?.[localVarOperationServerIndex]?.url;
|
|
1599
1747
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1600
1748
|
},
|
|
1601
|
-
async getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
1602
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options);
|
|
1749
|
+
async getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options) {
|
|
1750
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options);
|
|
1603
1751
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1604
1752
|
const localVarOperationServerBasePath = operationServerMap["BUSInputsOutputsApi.getProfinetIOsFromFile"]?.[localVarOperationServerIndex]?.url;
|
|
1605
1753
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1696,8 +1844,8 @@ const BUSInputsOutputsApiFactory = function(configuration, basePath, axios) {
|
|
|
1696
1844
|
getProfinetGSDML(cell, options) {
|
|
1697
1845
|
return localVarFp.getProfinetGSDML(cell, options).then((request) => request(axios, basePath));
|
|
1698
1846
|
},
|
|
1699
|
-
getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
1700
|
-
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
1847
|
+
getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options) {
|
|
1848
|
+
return localVarFp.getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
1701
1849
|
},
|
|
1702
1850
|
listBusIODescriptions(cell, options) {
|
|
1703
1851
|
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
@@ -1897,16 +2045,17 @@ var BUSInputsOutputsApi = class extends BaseAPI {
|
|
|
1897
2045
|
return BUSInputsOutputsApiFp(this.configuration).getProfinetGSDML(cell, options).then((request) => request(this.axios, this.basePath));
|
|
1898
2046
|
}
|
|
1899
2047
|
/**
|
|
1900
|
-
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify byte offsets for
|
|
2048
|
+
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get input/output variable configuration of the PROFINET device, e.g., NOVA\'s PROFINET service as file. You can specify per-slot byte offsets for input and output variable addresses to get an XML tag map that is ready for pasting to third party software, e.g., TIA portal. For backward compatibility, the legacy `input_offset` and `output_offset` query parameters remain available, but deprecated.
|
|
1901
2049
|
* @summary PROFINET Inputs/Outputs to File
|
|
1902
2050
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2051
|
+
* @param {Array<ProfinetSlotOffset>} [offsets] Per-slot offsets used to convert device-local byte addresses to controller byte addresses for export. If this parameter is provided, it is preferred over the deprecated `input_offset` and `output_offset` query parameters.
|
|
1903
2052
|
* @param {number} [inputOffset]
|
|
1904
2053
|
* @param {number} [outputOffset]
|
|
1905
2054
|
* @param {*} [options] Override http request option.
|
|
1906
2055
|
* @throws {RequiredError}
|
|
1907
2056
|
*/
|
|
1908
|
-
getProfinetIOsFromFile(cell, inputOffset, outputOffset, options) {
|
|
1909
|
-
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
2057
|
+
getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options) {
|
|
2058
|
+
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, offsets, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
1910
2059
|
}
|
|
1911
2060
|
/**
|
|
1912
2061
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ List all input/output descriptions for configured BUS services. The input/output descriptions contain information like name, type and unit. The input/output direction is given in perspective of the BUS service.
|
|
@@ -2359,7 +2508,7 @@ var CellApi = class extends BaseAPI {
|
|
|
2359
2508
|
return CellApiFp(this.configuration).deployCell(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
2360
2509
|
}
|
|
2361
2510
|
/**
|
|
2362
|
-
* **Required permissions:** `
|
|
2511
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ List all cell resources.
|
|
2363
2512
|
* @summary Configuration
|
|
2364
2513
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2365
2514
|
* @param {*} [options] Override http request option.
|
|
@@ -3420,102 +3569,57 @@ var ControllerInputsOutputsApi = class extends BaseAPI {
|
|
|
3420
3569
|
* JoggingApi - axios parameter creator
|
|
3421
3570
|
*/
|
|
3422
3571
|
const JoggingApiAxiosParamCreator = function(configuration) {
|
|
3423
|
-
return {
|
|
3424
|
-
executeJogging
|
|
3425
|
-
|
|
3426
|
-
|
|
3427
|
-
|
|
3428
|
-
|
|
3429
|
-
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
|
-
|
|
3440
|
-
|
|
3441
|
-
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3449
|
-
|
|
3450
|
-
|
|
3451
|
-
|
|
3452
|
-
|
|
3453
|
-
},
|
|
3454
|
-
executeWaypointJogging: async (cell, controller, executeWaypointJoggingRequest, options = {}) => {
|
|
3455
|
-
assertParamExists("executeWaypointJogging", "cell", cell);
|
|
3456
|
-
assertParamExists("executeWaypointJogging", "controller", controller);
|
|
3457
|
-
assertParamExists("executeWaypointJogging", "executeWaypointJoggingRequest", executeWaypointJoggingRequest);
|
|
3458
|
-
const localVarPath = `/experimental/cells/{cell}/controllers/{controller}/execution/jogging`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
|
|
3459
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3460
|
-
let baseOptions;
|
|
3461
|
-
if (configuration) baseOptions = configuration.baseOptions;
|
|
3462
|
-
const localVarRequestOptions = {
|
|
3463
|
-
method: "GET",
|
|
3464
|
-
...baseOptions,
|
|
3465
|
-
...options
|
|
3466
|
-
};
|
|
3467
|
-
const localVarHeaderParameter = {};
|
|
3468
|
-
const localVarQueryParameter = {};
|
|
3469
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3470
|
-
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3471
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3472
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3473
|
-
localVarRequestOptions.headers = {
|
|
3474
|
-
...localVarHeaderParameter,
|
|
3475
|
-
...headersFromBaseOptions,
|
|
3476
|
-
...options.headers
|
|
3477
|
-
};
|
|
3478
|
-
localVarRequestOptions.data = serializeDataIfNeeded(executeWaypointJoggingRequest, localVarRequestOptions, configuration);
|
|
3479
|
-
return {
|
|
3480
|
-
url: toPathString(localVarUrlObj),
|
|
3481
|
-
options: localVarRequestOptions
|
|
3482
|
-
};
|
|
3483
|
-
}
|
|
3484
|
-
};
|
|
3572
|
+
return { executeJogging: async (cell, controller, executeJoggingRequest, options = {}) => {
|
|
3573
|
+
assertParamExists("executeJogging", "cell", cell);
|
|
3574
|
+
assertParamExists("executeJogging", "controller", controller);
|
|
3575
|
+
assertParamExists("executeJogging", "executeJoggingRequest", executeJoggingRequest);
|
|
3576
|
+
const localVarPath = `/cells/{cell}/controllers/{controller}/execution/jogging`.replace(`{cell}`, encodeURIComponent(String(cell))).replace(`{controller}`, encodeURIComponent(String(controller)));
|
|
3577
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3578
|
+
let baseOptions;
|
|
3579
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
3580
|
+
const localVarRequestOptions = {
|
|
3581
|
+
method: "GET",
|
|
3582
|
+
...baseOptions,
|
|
3583
|
+
...options
|
|
3584
|
+
};
|
|
3585
|
+
const localVarHeaderParameter = {};
|
|
3586
|
+
const localVarQueryParameter = {};
|
|
3587
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3588
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3589
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3590
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3591
|
+
localVarRequestOptions.headers = {
|
|
3592
|
+
...localVarHeaderParameter,
|
|
3593
|
+
...headersFromBaseOptions,
|
|
3594
|
+
...options.headers
|
|
3595
|
+
};
|
|
3596
|
+
localVarRequestOptions.data = serializeDataIfNeeded(executeJoggingRequest, localVarRequestOptions, configuration);
|
|
3597
|
+
return {
|
|
3598
|
+
url: toPathString(localVarUrlObj),
|
|
3599
|
+
options: localVarRequestOptions
|
|
3600
|
+
};
|
|
3601
|
+
} };
|
|
3485
3602
|
};
|
|
3486
3603
|
/**
|
|
3487
3604
|
* JoggingApi - functional programming interface
|
|
3488
3605
|
*/
|
|
3489
3606
|
const JoggingApiFp = function(configuration) {
|
|
3490
3607
|
const localVarAxiosParamCreator = JoggingApiAxiosParamCreator(configuration);
|
|
3491
|
-
return {
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
},
|
|
3498
|
-
async executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options) {
|
|
3499
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options);
|
|
3500
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3501
|
-
const localVarOperationServerBasePath = operationServerMap["JoggingApi.executeWaypointJogging"]?.[localVarOperationServerIndex]?.url;
|
|
3502
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3503
|
-
}
|
|
3504
|
-
};
|
|
3608
|
+
return { async executeJogging(cell, controller, executeJoggingRequest, options) {
|
|
3609
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeJogging(cell, controller, executeJoggingRequest, options);
|
|
3610
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3611
|
+
const localVarOperationServerBasePath = operationServerMap["JoggingApi.executeJogging"]?.[localVarOperationServerIndex]?.url;
|
|
3612
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3613
|
+
} };
|
|
3505
3614
|
};
|
|
3506
3615
|
/**
|
|
3507
3616
|
* JoggingApi - factory interface
|
|
3508
3617
|
*/
|
|
3509
3618
|
const JoggingApiFactory = function(configuration, basePath, axios) {
|
|
3510
3619
|
const localVarFp = JoggingApiFp(configuration);
|
|
3511
|
-
return {
|
|
3512
|
-
executeJogging(cell, controller, executeJoggingRequest, options)
|
|
3513
|
-
|
|
3514
|
-
},
|
|
3515
|
-
executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options) {
|
|
3516
|
-
return localVarFp.executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options).then((request) => request(axios, basePath));
|
|
3517
|
-
}
|
|
3518
|
-
};
|
|
3620
|
+
return { executeJogging(cell, controller, executeJoggingRequest, options) {
|
|
3621
|
+
return localVarFp.executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(axios, basePath));
|
|
3622
|
+
} };
|
|
3519
3623
|
};
|
|
3520
3624
|
/**
|
|
3521
3625
|
* JoggingApi - object-oriented interface
|
|
@@ -3533,18 +3637,6 @@ var JoggingApi = class extends BaseAPI {
|
|
|
3533
3637
|
executeJogging(cell, controller, executeJoggingRequest, options) {
|
|
3534
3638
|
return JoggingApiFp(this.configuration).executeJogging(cell, controller, executeJoggingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3535
3639
|
}
|
|
3536
|
-
/**
|
|
3537
|
-
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: danger --> > **Experimental** > > This endpoint is experimental and its behavior may change in future releases. > Websocket endpoint Provides waypoint-based jogging control for a motion group. Instead of commanding target velocities (see [executeJogging](#/operations/executeJogging)), waypoint jogging streams a queue of timed waypoints that the robot moves through by best effort. This can be used for realtime action chunk streaming, e.g., from a Vision-Language-Action (VLA) model. ### 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 `JointWaypointsRequest` or `PoseWaypointsRequest` to stream waypoints. - The first waypoints message starts an internal clock. - Each waypoint carries a timestamp relative to that clock for when it should be reached. - Existing waypoints in the queue that are older than the first new timestamp are removed. - The current session timestamp is reported in `execute.details.jogger_session_timestamp_ms` of the [streamRobotControllerState](#/operations/streamRobotControllerState) endpoint. #### 3. Stop the jogging motion - Send `PauseJoggingRequest` to stop the motion. ### Responses - Each request is acknowledged with a corresponding response: - `InitializeJoggingResponse` after `InitializeJoggingRequest` - `JointWaypointsResponse` after `JointWaypointsRequest` - `PoseWaypointsResponse` after `PoseWaypointsRequest` - `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.
|
|
3538
|
-
* @summary Execute Waypoint Jogging
|
|
3539
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3540
|
-
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
3541
|
-
* @param {ExecuteWaypointJoggingRequest} executeWaypointJoggingRequest
|
|
3542
|
-
* @param {*} [options] Override http request option.
|
|
3543
|
-
* @throws {RequiredError}
|
|
3544
|
-
*/
|
|
3545
|
-
executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options) {
|
|
3546
|
-
return JoggingApiFp(this.configuration).executeWaypointJogging(cell, controller, executeWaypointJoggingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3547
|
-
}
|
|
3548
3640
|
};
|
|
3549
3641
|
/**
|
|
3550
3642
|
* KinematicsApi - axios parameter creator
|
|
@@ -3638,6 +3730,35 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
|
|
|
3638
3730
|
options: localVarRequestOptions
|
|
3639
3731
|
};
|
|
3640
3732
|
},
|
|
3733
|
+
getKinematicConfiguration: async (cell, getKinematicConfigurationRequest, options = {}) => {
|
|
3734
|
+
assertParamExists("getKinematicConfiguration", "cell", cell);
|
|
3735
|
+
assertParamExists("getKinematicConfiguration", "getKinematicConfigurationRequest", getKinematicConfigurationRequest);
|
|
3736
|
+
const localVarPath = `/experimental/cells/{cell}/kinematic/get-kinematic-configuration`.replace(`{cell}`, encodeURIComponent(String(cell)));
|
|
3737
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3738
|
+
let baseOptions;
|
|
3739
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
3740
|
+
const localVarRequestOptions = {
|
|
3741
|
+
method: "POST",
|
|
3742
|
+
...baseOptions,
|
|
3743
|
+
...options
|
|
3744
|
+
};
|
|
3745
|
+
const localVarHeaderParameter = {};
|
|
3746
|
+
const localVarQueryParameter = {};
|
|
3747
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3748
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
3749
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3750
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3751
|
+
localVarRequestOptions.headers = {
|
|
3752
|
+
...localVarHeaderParameter,
|
|
3753
|
+
...headersFromBaseOptions,
|
|
3754
|
+
...options.headers
|
|
3755
|
+
};
|
|
3756
|
+
localVarRequestOptions.data = serializeDataIfNeeded(getKinematicConfigurationRequest, localVarRequestOptions, configuration);
|
|
3757
|
+
return {
|
|
3758
|
+
url: toPathString(localVarUrlObj),
|
|
3759
|
+
options: localVarRequestOptions
|
|
3760
|
+
};
|
|
3761
|
+
},
|
|
3641
3762
|
inverseKinematics: async (cell, inverseKinematicsRequest, options = {}) => {
|
|
3642
3763
|
assertParamExists("inverseKinematics", "cell", cell);
|
|
3643
3764
|
assertParamExists("inverseKinematics", "inverseKinematicsRequest", inverseKinematicsRequest);
|
|
@@ -3722,6 +3843,12 @@ const KinematicsApiFp = function(configuration) {
|
|
|
3722
3843
|
const localVarOperationServerBasePath = operationServerMap["KinematicsApi.forwardKinematics"]?.[localVarOperationServerIndex]?.url;
|
|
3723
3844
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3724
3845
|
},
|
|
3846
|
+
async getKinematicConfiguration(cell, getKinematicConfigurationRequest, options) {
|
|
3847
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getKinematicConfiguration(cell, getKinematicConfigurationRequest, options);
|
|
3848
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3849
|
+
const localVarOperationServerBasePath = operationServerMap["KinematicsApi.getKinematicConfiguration"]?.[localVarOperationServerIndex]?.url;
|
|
3850
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3851
|
+
},
|
|
3725
3852
|
async inverseKinematics(cell, inverseKinematicsRequest, options) {
|
|
3726
3853
|
const localVarAxiosArgs = await localVarAxiosParamCreator.inverseKinematics(cell, inverseKinematicsRequest, options);
|
|
3727
3854
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -3751,6 +3878,9 @@ const KinematicsApiFactory = function(configuration, basePath, axios) {
|
|
|
3751
3878
|
forwardKinematics(cell, forwardKinematicsRequest, options) {
|
|
3752
3879
|
return localVarFp.forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(axios, basePath));
|
|
3753
3880
|
},
|
|
3881
|
+
getKinematicConfiguration(cell, getKinematicConfigurationRequest, options) {
|
|
3882
|
+
return localVarFp.getKinematicConfiguration(cell, getKinematicConfigurationRequest, options).then((request) => request(axios, basePath));
|
|
3883
|
+
},
|
|
3754
3884
|
inverseKinematics(cell, inverseKinematicsRequest, options) {
|
|
3755
3885
|
return localVarFp.inverseKinematics(cell, inverseKinematicsRequest, options).then((request) => request(axios, basePath));
|
|
3756
3886
|
},
|
|
@@ -3797,6 +3927,17 @@ var KinematicsApi = class extends BaseAPI {
|
|
|
3797
3927
|
return KinematicsApiFp(this.configuration).forwardKinematics(cell, forwardKinematicsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3798
3928
|
}
|
|
3799
3929
|
/**
|
|
3930
|
+
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ Returns the kinematic configuration for each given joint position including branch and axis ranges. Supported for 6-DOF robots with spherical or offset wrist that implement kinematic branch calculation. Returns 422 with `ErrorUnsupportedOperation` for motion groups that do not support kinematic branch calculation.
|
|
3931
|
+
* @summary Get kinematic configuration
|
|
3932
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
3933
|
+
* @param {GetKinematicConfigurationRequest} getKinematicConfigurationRequest
|
|
3934
|
+
* @param {*} [options] Override http request option.
|
|
3935
|
+
* @throws {RequiredError}
|
|
3936
|
+
*/
|
|
3937
|
+
getKinematicConfiguration(cell, getKinematicConfigurationRequest, options) {
|
|
3938
|
+
return KinematicsApiFp(this.configuration).getKinematicConfiguration(cell, getKinematicConfigurationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3939
|
+
}
|
|
3940
|
+
/**
|
|
3800
3941
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ Returns the reachable joint positions for a list of given poses.
|
|
3801
3942
|
* @summary Inverse kinematics
|
|
3802
3943
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
@@ -4208,7 +4349,7 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
4208
4349
|
copyMotionGroupModel: async (motionGroupModel, copyMotionGroupModelRequest, options = {}) => {
|
|
4209
4350
|
assertParamExists("copyMotionGroupModel", "motionGroupModel", motionGroupModel);
|
|
4210
4351
|
assertParamExists("copyMotionGroupModel", "copyMotionGroupModelRequest", copyMotionGroupModelRequest);
|
|
4211
|
-
const localVarPath = `/experimental/motion-group-models/{motion-group-model}`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4352
|
+
const localVarPath = `/experimental/motion-group-models/{motion-group-model}/archive`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4212
4353
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4213
4354
|
let baseOptions;
|
|
4214
4355
|
if (configuration) baseOptions = configuration.baseOptions;
|
|
@@ -4236,7 +4377,7 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
4236
4377
|
},
|
|
4237
4378
|
deleteExperimentalMotionGroupModel: async (motionGroupModel, options = {}) => {
|
|
4238
4379
|
assertParamExists("deleteExperimentalMotionGroupModel", "motionGroupModel", motionGroupModel);
|
|
4239
|
-
const localVarPath = `/experimental/motion-group-models/{motion-group-model}`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4380
|
+
const localVarPath = `/experimental/motion-group-models/{motion-group-model}/archive`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4240
4381
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4241
4382
|
let baseOptions;
|
|
4242
4383
|
if (configuration) baseOptions = configuration.baseOptions;
|
|
@@ -4262,7 +4403,33 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
4262
4403
|
},
|
|
4263
4404
|
exportMotionGroupModel: async (motionGroupModel, options = {}) => {
|
|
4264
4405
|
assertParamExists("exportMotionGroupModel", "motionGroupModel", motionGroupModel);
|
|
4265
|
-
const localVarPath = `/experimental/motion-group-models/{motion-group-model}`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4406
|
+
const localVarPath = `/experimental/motion-group-models/{motion-group-model}/archive`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4407
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4408
|
+
let baseOptions;
|
|
4409
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
4410
|
+
const localVarRequestOptions = {
|
|
4411
|
+
method: "GET",
|
|
4412
|
+
...baseOptions,
|
|
4413
|
+
...options
|
|
4414
|
+
};
|
|
4415
|
+
const localVarHeaderParameter = {};
|
|
4416
|
+
const localVarQueryParameter = {};
|
|
4417
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4418
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4419
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4420
|
+
localVarRequestOptions.headers = {
|
|
4421
|
+
...localVarHeaderParameter,
|
|
4422
|
+
...headersFromBaseOptions,
|
|
4423
|
+
...options.headers
|
|
4424
|
+
};
|
|
4425
|
+
return {
|
|
4426
|
+
url: toPathString(localVarUrlObj),
|
|
4427
|
+
options: localVarRequestOptions
|
|
4428
|
+
};
|
|
4429
|
+
},
|
|
4430
|
+
getConfigurationForMotionGroup: async (motionGroupModel, options = {}) => {
|
|
4431
|
+
assertParamExists("getConfigurationForMotionGroup", "motionGroupModel", motionGroupModel);
|
|
4432
|
+
const localVarPath = `/motion-group-models/{motion-group-model}/configuration`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
4266
4433
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4267
4434
|
let baseOptions;
|
|
4268
4435
|
if (configuration) baseOptions = configuration.baseOptions;
|
|
@@ -4466,6 +4633,30 @@ const MotionGroupModelsApiAxiosParamCreator = function(configuration) {
|
|
|
4466
4633
|
options: localVarRequestOptions
|
|
4467
4634
|
};
|
|
4468
4635
|
},
|
|
4636
|
+
getMotionGroupModelsCatalog: async (options = {}) => {
|
|
4637
|
+
const localVarUrlObj = new URL(`/experimental/motion-group-models/catalog`, DUMMY_BASE_URL);
|
|
4638
|
+
let baseOptions;
|
|
4639
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
4640
|
+
const localVarRequestOptions = {
|
|
4641
|
+
method: "GET",
|
|
4642
|
+
...baseOptions,
|
|
4643
|
+
...options
|
|
4644
|
+
};
|
|
4645
|
+
const localVarHeaderParameter = {};
|
|
4646
|
+
const localVarQueryParameter = {};
|
|
4647
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4648
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4649
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4650
|
+
localVarRequestOptions.headers = {
|
|
4651
|
+
...localVarHeaderParameter,
|
|
4652
|
+
...headersFromBaseOptions,
|
|
4653
|
+
...options.headers
|
|
4654
|
+
};
|
|
4655
|
+
return {
|
|
4656
|
+
url: toPathString(localVarUrlObj),
|
|
4657
|
+
options: localVarRequestOptions
|
|
4658
|
+
};
|
|
4659
|
+
},
|
|
4469
4660
|
getMotionGroupUsdModel: async (motionGroupModel, options = {}) => {
|
|
4470
4661
|
assertParamExists("getMotionGroupUsdModel", "motionGroupModel", motionGroupModel);
|
|
4471
4662
|
const localVarPath = `/motion-group-models/{motion-group-model}/usd`.replace(`{motion-group-model}`, encodeURIComponent(String(motionGroupModel)));
|
|
@@ -4545,6 +4736,12 @@ const MotionGroupModelsApiFp = function(configuration) {
|
|
|
4545
4736
|
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.exportMotionGroupModel"]?.[localVarOperationServerIndex]?.url;
|
|
4546
4737
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4547
4738
|
},
|
|
4739
|
+
async getConfigurationForMotionGroup(motionGroupModel, options) {
|
|
4740
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getConfigurationForMotionGroup(motionGroupModel, options);
|
|
4741
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4742
|
+
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getConfigurationForMotionGroup"]?.[localVarOperationServerIndex]?.url;
|
|
4743
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4744
|
+
},
|
|
4548
4745
|
async getMotionGroupCollisionModel(motionGroupModel, options) {
|
|
4549
4746
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupCollisionModel(motionGroupModel, options);
|
|
4550
4747
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -4587,6 +4784,12 @@ const MotionGroupModelsApiFp = function(configuration) {
|
|
|
4587
4784
|
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupModels"]?.[localVarOperationServerIndex]?.url;
|
|
4588
4785
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4589
4786
|
},
|
|
4787
|
+
async getMotionGroupModelsCatalog(options) {
|
|
4788
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupModelsCatalog(options);
|
|
4789
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4790
|
+
const localVarOperationServerBasePath = operationServerMap["MotionGroupModelsApi.getMotionGroupModelsCatalog"]?.[localVarOperationServerIndex]?.url;
|
|
4791
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4792
|
+
},
|
|
4590
4793
|
async getMotionGroupUsdModel(motionGroupModel, options) {
|
|
4591
4794
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupUsdModel(motionGroupModel, options);
|
|
4592
4795
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -4616,6 +4819,9 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios) {
|
|
|
4616
4819
|
exportMotionGroupModel(motionGroupModel, options) {
|
|
4617
4820
|
return localVarFp.exportMotionGroupModel(motionGroupModel, options).then((request) => request(axios, basePath));
|
|
4618
4821
|
},
|
|
4822
|
+
getConfigurationForMotionGroup(motionGroupModel, options) {
|
|
4823
|
+
return localVarFp.getConfigurationForMotionGroup(motionGroupModel, options).then((request) => request(axios, basePath));
|
|
4824
|
+
},
|
|
4619
4825
|
getMotionGroupCollisionModel(motionGroupModel, options) {
|
|
4620
4826
|
return localVarFp.getMotionGroupCollisionModel(motionGroupModel, options).then((request) => request(axios, basePath));
|
|
4621
4827
|
},
|
|
@@ -4637,6 +4843,9 @@ const MotionGroupModelsApiFactory = function(configuration, basePath, axios) {
|
|
|
4637
4843
|
getMotionGroupModels(options) {
|
|
4638
4844
|
return localVarFp.getMotionGroupModels(options).then((request) => request(axios, basePath));
|
|
4639
4845
|
},
|
|
4846
|
+
getMotionGroupModelsCatalog(options) {
|
|
4847
|
+
return localVarFp.getMotionGroupModelsCatalog(options).then((request) => request(axios, basePath));
|
|
4848
|
+
},
|
|
4640
4849
|
getMotionGroupUsdModel(motionGroupModel, options) {
|
|
4641
4850
|
return localVarFp.getMotionGroupUsdModel(motionGroupModel, options).then((request) => request(axios, basePath));
|
|
4642
4851
|
},
|
|
@@ -4661,7 +4870,7 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
4661
4870
|
return MotionGroupModelsApiFp(this.configuration).copyMotionGroupModel(motionGroupModel, copyMotionGroupModelRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4662
4871
|
}
|
|
4663
4872
|
/**
|
|
4664
|
-
* **Required permissions:** `can_access_system` - View system status and metadata ___ Deletes a custom motion group model. Only custom models
|
|
4873
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Deletes a custom motion group model. Only custom models, where `is_custom` is `true`, can be deleted. Built-in base models cannot be removed.
|
|
4665
4874
|
* @summary Delete Motion Group Model
|
|
4666
4875
|
* @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).
|
|
4667
4876
|
* @param {*} [options] Override http request option.
|
|
@@ -4681,6 +4890,16 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
4681
4890
|
return MotionGroupModelsApiFp(this.configuration).exportMotionGroupModel(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
4682
4891
|
}
|
|
4683
4892
|
/**
|
|
4893
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Get a robot configuration containing the specified motion group model. This endpoint is designed for Virtual Robot to dynamically add motion groups by model name without needing to know the robot configuration name. Returns the full GCI transcript along with the motion group UID that corresponds to the requested motion group model.
|
|
4894
|
+
* @summary Get Configuration for Motion Group
|
|
4895
|
+
* @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).
|
|
4896
|
+
* @param {*} [options] Override http request option.
|
|
4897
|
+
* @throws {RequiredError}
|
|
4898
|
+
*/
|
|
4899
|
+
getConfigurationForMotionGroup(motionGroupModel, options) {
|
|
4900
|
+
return MotionGroupModelsApiFp(this.configuration).getConfigurationForMotionGroup(motionGroupModel, options).then((request) => request(this.axios, this.basePath));
|
|
4901
|
+
}
|
|
4902
|
+
/**
|
|
4684
4903
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ 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.
|
|
4685
4904
|
* @summary Get Collision Model
|
|
4686
4905
|
* @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).
|
|
@@ -4750,6 +4969,15 @@ var MotionGroupModelsApi = class extends BaseAPI {
|
|
|
4750
4969
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(options).then((request) => request(this.axios, this.basePath));
|
|
4751
4970
|
}
|
|
4752
4971
|
/**
|
|
4972
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the catalog of all motion groups with their motion group names and readable names.
|
|
4973
|
+
* @summary Motion Group Model Catalog
|
|
4974
|
+
* @param {*} [options] Override http request option.
|
|
4975
|
+
* @throws {RequiredError}
|
|
4976
|
+
*/
|
|
4977
|
+
getMotionGroupModelsCatalog(options) {
|
|
4978
|
+
return MotionGroupModelsApiFp(this.configuration).getMotionGroupModelsCatalog(options).then((request) => request(this.axios, this.basePath));
|
|
4979
|
+
}
|
|
4980
|
+
/**
|
|
4753
4981
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the USD scene model for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
4754
4982
|
* @summary Download USD Model
|
|
4755
4983
|
* @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).
|
|
@@ -4827,6 +5055,30 @@ const NOVACloudApiAxiosParamCreator = function(configuration) {
|
|
|
4827
5055
|
options: localVarRequestOptions
|
|
4828
5056
|
};
|
|
4829
5057
|
},
|
|
5058
|
+
getCloudStatus: async (options = {}) => {
|
|
5059
|
+
const localVarUrlObj = new URL(`/experimental/cloud/status`, DUMMY_BASE_URL);
|
|
5060
|
+
let baseOptions;
|
|
5061
|
+
if (configuration) baseOptions = configuration.baseOptions;
|
|
5062
|
+
const localVarRequestOptions = {
|
|
5063
|
+
method: "GET",
|
|
5064
|
+
...baseOptions,
|
|
5065
|
+
...options
|
|
5066
|
+
};
|
|
5067
|
+
const localVarHeaderParameter = {};
|
|
5068
|
+
const localVarQueryParameter = {};
|
|
5069
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5070
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5071
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5072
|
+
localVarRequestOptions.headers = {
|
|
5073
|
+
...localVarHeaderParameter,
|
|
5074
|
+
...headersFromBaseOptions,
|
|
5075
|
+
...options.headers
|
|
5076
|
+
};
|
|
5077
|
+
return {
|
|
5078
|
+
url: toPathString(localVarUrlObj),
|
|
5079
|
+
options: localVarRequestOptions
|
|
5080
|
+
};
|
|
5081
|
+
},
|
|
4830
5082
|
getNovaCloudConfig: async (options = {}) => {
|
|
4831
5083
|
const localVarUrlObj = new URL(`/experimental/cloud/config`, DUMMY_BASE_URL);
|
|
4832
5084
|
let baseOptions;
|
|
@@ -4871,6 +5123,12 @@ const NOVACloudApiFp = function(configuration) {
|
|
|
4871
5123
|
const localVarOperationServerBasePath = operationServerMap["NOVACloudApi.disconnectFromNovaCloud"]?.[localVarOperationServerIndex]?.url;
|
|
4872
5124
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4873
5125
|
},
|
|
5126
|
+
async getCloudStatus(options) {
|
|
5127
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCloudStatus(options);
|
|
5128
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5129
|
+
const localVarOperationServerBasePath = operationServerMap["NOVACloudApi.getCloudStatus"]?.[localVarOperationServerIndex]?.url;
|
|
5130
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5131
|
+
},
|
|
4874
5132
|
async getNovaCloudConfig(options) {
|
|
4875
5133
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getNovaCloudConfig(options);
|
|
4876
5134
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
@@ -4891,6 +5149,9 @@ const NOVACloudApiFactory = function(configuration, basePath, axios) {
|
|
|
4891
5149
|
disconnectFromNovaCloud(completionTimeout, options) {
|
|
4892
5150
|
return localVarFp.disconnectFromNovaCloud(completionTimeout, options).then((request) => request(axios, basePath));
|
|
4893
5151
|
},
|
|
5152
|
+
getCloudStatus(options) {
|
|
5153
|
+
return localVarFp.getCloudStatus(options).then((request) => request(axios, basePath));
|
|
5154
|
+
},
|
|
4894
5155
|
getNovaCloudConfig(options) {
|
|
4895
5156
|
return localVarFp.getNovaCloudConfig(options).then((request) => request(axios, basePath));
|
|
4896
5157
|
}
|
|
@@ -4922,6 +5183,15 @@ var NOVACloudApi = class extends BaseAPI {
|
|
|
4922
5183
|
return NOVACloudApiFp(this.configuration).disconnectFromNovaCloud(completionTimeout, options).then((request) => request(this.axios, this.basePath));
|
|
4923
5184
|
}
|
|
4924
5185
|
/**
|
|
5186
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Get the current NOVA Cloud connection status for this instance, including whether the configured cloud deployment is currently reachable.
|
|
5187
|
+
* @summary Get Connection Status
|
|
5188
|
+
* @param {*} [options] Override http request option.
|
|
5189
|
+
* @throws {RequiredError}
|
|
5190
|
+
*/
|
|
5191
|
+
getCloudStatus(options) {
|
|
5192
|
+
return NOVACloudApiFp(this.configuration).getCloudStatus(options).then((request) => request(this.axios, this.basePath));
|
|
5193
|
+
}
|
|
5194
|
+
/**
|
|
4925
5195
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Get the current NOVA Cloud connection config for this instance.
|
|
4926
5196
|
* @summary Get Connection Config
|
|
4927
5197
|
* @param {*} [options] Override http request option.
|
|
@@ -6696,7 +6966,9 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
6696
6966
|
};
|
|
6697
6967
|
},
|
|
6698
6968
|
getArpScan: async (_interface, cidr, timeout, options = {}) => {
|
|
6699
|
-
|
|
6969
|
+
assertParamExists("getArpScan", "_interface", _interface);
|
|
6970
|
+
assertParamExists("getArpScan", "cidr", cidr);
|
|
6971
|
+
const localVarUrlObj = new URL(`/system/network/arp-scan`, DUMMY_BASE_URL);
|
|
6700
6972
|
let baseOptions;
|
|
6701
6973
|
if (configuration) baseOptions = configuration.baseOptions;
|
|
6702
6974
|
const localVarRequestOptions = {
|
|
@@ -6773,7 +7045,7 @@ const SystemApiAxiosParamCreator = function(configuration) {
|
|
|
6773
7045
|
};
|
|
6774
7046
|
},
|
|
6775
7047
|
getNetworkInterfaces: async (options = {}) => {
|
|
6776
|
-
const localVarUrlObj = new URL(`/
|
|
7048
|
+
const localVarUrlObj = new URL(`/system/network/interfaces`, DUMMY_BASE_URL);
|
|
6777
7049
|
let baseOptions;
|
|
6778
7050
|
if (configuration) baseOptions = configuration.baseOptions;
|
|
6779
7051
|
const localVarRequestOptions = {
|
|
@@ -7099,10 +7371,10 @@ var SystemApi = class extends BaseAPI {
|
|
|
7099
7371
|
return SystemApiFp(this.configuration).checkNovaVersionUpdate(channel, options).then((request) => request(this.axios, this.basePath));
|
|
7100
7372
|
}
|
|
7101
7373
|
/**
|
|
7102
|
-
* **Required permissions:** `can_access_system` - View system status and metadata ___
|
|
7374
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Runs an ARP scan on the target interface and returns all discovered devices.
|
|
7103
7375
|
* @summary Get ARP-Scan
|
|
7104
|
-
* @param {string}
|
|
7105
|
-
* @param {string}
|
|
7376
|
+
* @param {string} _interface
|
|
7377
|
+
* @param {string} cidr
|
|
7106
7378
|
* @param {number} [timeout]
|
|
7107
7379
|
* @param {*} [options] Override http request option.
|
|
7108
7380
|
* @throws {RequiredError}
|
|
@@ -7130,7 +7402,7 @@ var SystemApi = class extends BaseAPI {
|
|
|
7130
7402
|
return SystemApiFp(this.configuration).getDiagnosePackage(options).then((request) => request(this.axios, this.basePath));
|
|
7131
7403
|
}
|
|
7132
7404
|
/**
|
|
7133
|
-
* **Required permissions:** `can_access_system` - View system status and metadata ___
|
|
7405
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Lists all managed network interfaces available for controller connections and ARP scanning.
|
|
7134
7406
|
* @summary Network Interfaces
|
|
7135
7407
|
* @param {*} [options] Override http request option.
|
|
7136
7408
|
* @throws {RequiredError}
|
|
@@ -9377,4 +9649,4 @@ var Configuration = class {
|
|
|
9377
9649
|
}
|
|
9378
9650
|
};
|
|
9379
9651
|
//#endregion
|
|
9380
|
-
export { AbbControllerKindEnum, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOSnap7BusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, CloudConfigStatusConfiguredStatusEnum, CloudConfigStatusNotConfiguredStatusEnum, CloudConnectionErrorInvalidTokenCodeEnum, CloudConnectionErrorLeafnodeConnectionErrorCodeEnum, CloudConnectionErrorLeafnodeConnectionTimeoutCodeEnum, CloudConnectionErrorLeafnodeRestartTimeoutCodeEnum, CloudConnectionErrorNatsFailedCodeEnum, CloudConnectionErrorUnexpectedResponseCodeEnum, CloudDisconnectionStatusDisconnectedStatusEnum, CloudDisconnectionStatusDisconnectingStatusEnum, ColliderValueSourceEnum, CollisionErrorKindEnum, CollisionSetupValueSourceEnum, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, DirectionConstraintConstraintNameEnum, ErrorDirectionConstraintNotMetErrorFeedbackNameEnum, ErrorDirectionConstraintNotNormalizedErrorFeedbackNameEnum, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, ErrorUnsupportedOperationErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackAxisRangeExceededErrorFeedbackNameEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackCommandsMissingErrorFeedbackNameEnum, FeedbackCubicSplineIsNotIncreasingErrorFeedbackNameEnum, FeedbackCubicSplineNotAtStartPoseErrorFeedbackNameEnum, FeedbackDirectionConstraintNoSolutionExistsErrorFeedbackNameEnum, FeedbackDirectionConstraintNotMetErrorFeedbackNameEnum, FeedbackDirectionConstraintNotNormalizedErrorFeedbackNameEnum, FeedbackInvalidDofErrorFeedbackNameEnum, FeedbackInvalidNanValueErrorFeedbackNameEnum, FeedbackInvalidSamplingTimeErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackNoSolutionInCurrentConfigurationErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FeedbackStartJointsMissingErrorFeedbackNameEnum, FeedbackTorqueExceededErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InconsistentTrajectorySizeErrorKindEnum, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, InvalidDofErrorKindEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedNearSingularityKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointLimitExceededErrorKindEnum, JointTypeEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum,
|
|
9652
|
+
export { AbbControllerKindEnum, ActionChunkRequestMessageTypeEnum, ActionChunkResponseKindEnum, ActionChunkStreamingApi, ActionChunkStreamingApiAxiosParamCreator, ActionChunkStreamingApiFactory, ActionChunkStreamingApiFp, ApplicationApi, ApplicationApiAxiosParamCreator, ApplicationApiFactory, ApplicationApiFp, BASE_PATH, BUSInputsOutputsApi, BUSInputsOutputsApiAxiosParamCreator, BUSInputsOutputsApiFactory, BUSInputsOutputsApiFp, BaseAPI, Behavior, BlendingAutoBlendingNameEnum, BlendingPositionBlendingNameEnum, BlendingSpace, BooleanValueValueTypeEnum, BostondynamicsControllerKindEnum, BostondynamicsControllerRobotTypeEnum, BoxBoxTypeEnum, BoxShapeTypeEnum, BusIOModbusClientBusTypeEnum, BusIOModbusServerBusTypeEnum, BusIOModbusTCPClientNetworkTypeEnum, BusIOModbusTCPServerNetworkTypeEnum, BusIOModbusVirtualBusTypeEnum, BusIOProfinetBusTypeEnum, BusIOProfinetVirtualBusTypeEnum, BusIOSnap7BusTypeEnum, BusIOsStateEnum, COLLECTION_FORMATS, CapsuleShapeTypeEnum, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, CloudConfigStatusConfiguredStatusEnum, CloudConfigStatusNotConfiguredStatusEnum, CloudConnectionErrorInvalidTokenCodeEnum, CloudConnectionErrorLeafnodeConnectionErrorCodeEnum, CloudConnectionErrorLeafnodeConnectionTimeoutCodeEnum, CloudConnectionErrorLeafnodeRestartTimeoutCodeEnum, CloudConnectionErrorNatsFailedCodeEnum, CloudConnectionErrorUnexpectedResponseCodeEnum, CloudDisconnectionStatusDisconnectedStatusEnum, CloudDisconnectionStatusDisconnectingStatusEnum, ColliderValueSourceEnum, CollisionErrorKindEnum, CollisionSetupValueSourceEnum, Comparator, Configuration, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccessStatusEnum, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHullShapeTypeEnum, CylinderShapeTypeEnum, Direction, DirectionConstraintConstraintNameEnum, ErrorDirectionConstraintNotMetErrorFeedbackNameEnum, ErrorDirectionConstraintNotNormalizedErrorFeedbackNameEnum, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceededErrorFeedbackNameEnum, ErrorUnsupportedOperationErrorFeedbackNameEnum, FanucControllerKindEnum, FeedbackAxisRangeExceededErrorFeedbackNameEnum, FeedbackCollisionErrorFeedbackNameEnum, FeedbackCommandsMissingErrorFeedbackNameEnum, FeedbackCubicSplineIsNotIncreasingErrorFeedbackNameEnum, FeedbackCubicSplineNotAtStartPoseErrorFeedbackNameEnum, FeedbackDirectionConstraintNoSolutionExistsErrorFeedbackNameEnum, FeedbackDirectionConstraintNotMetErrorFeedbackNameEnum, FeedbackDirectionConstraintNotNormalizedErrorFeedbackNameEnum, FeedbackInvalidDofErrorFeedbackNameEnum, FeedbackInvalidNanValueErrorFeedbackNameEnum, FeedbackInvalidSamplingTimeErrorFeedbackNameEnum, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackNoSolutionInCurrentConfigurationErrorFeedbackNameEnum, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularityErrorFeedbackNameEnum, FeedbackStartJointsMissingErrorFeedbackNameEnum, FeedbackTorqueExceededErrorFeedbackNameEnum, FloatValueValueTypeEnum, IOBooleanValueValueTypeEnum, IODirection, IOFloatValueValueTypeEnum, IOIntegerValueValueTypeEnum, IOOrigin, IOValueType, InconsistentTrajectorySizeErrorKindEnum, InitializeActionChunksRequestMessageTypeEnum, InitializeActionChunksResponseKindEnum, InitializeJoggingRequestMessageTypeEnum, InitializeJoggingResponseKindEnum, InitializeMovementRequestMessageTypeEnum, InitializeMovementResponseKindEnum, IntegerValueValueTypeEnum, InvalidDofErrorKindEnum, JoggingApi, JoggingApiAxiosParamCreator, JoggingApiFactory, JoggingApiFp, JoggingDetailsKindEnum, JoggingPausedByUserKindEnum, JoggingPausedNearCollisionKindEnum, JoggingPausedNearJointLimitKindEnum, JoggingPausedNearSingularityKindEnum, JoggingPausedOnIOKindEnum, JoggingRunningKindEnum, JointLimitExceededErrorKindEnum, JointTypeEnum, JointVelocityRequestMessageTypeEnum, JointVelocityResponseKindEnum, JointWaypointKindEnum, KinematicBranchElbow, KinematicBranchShoulder, KinematicBranchWrist, KinematicsApi, KinematicsApiAxiosParamCreator, KinematicsApiFactory, KinematicsApiFp, KukaControllerKindEnum, LicenseApi, LicenseApiAxiosParamCreator, LicenseApiFactory, LicenseApiFp, LicenseStatusEnum, LinkChainValueSourceEnum, Manufacturer, MidpointInsertionAlgorithmAlgorithmNameEnum, ModbusIOArea, ModbusIOByteOrder, ModbusIOTypeEnum, MotionGroupApi, MotionGroupApiAxiosParamCreator, MotionGroupApiFactory, MotionGroupApiFp, MotionGroupModelsApi, MotionGroupModelsApiAxiosParamCreator, MotionGroupModelsApiFactory, MotionGroupModelsApiFp, MovementErrorResponseKindEnum, NOVACloudApi, NOVACloudApiAxiosParamCreator, NOVACloudApiFactory, NOVACloudApiFp, NanValueErrorKindEnum, NetworkBackend, NetworkLinkState, OperatingState, OperationMode, OrientationType, PathCartesianPTPPathDefinitionNameEnum, PathCirclePathDefinitionNameEnum, PathCubicSplinePathDefinitionNameEnum, PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum, PathDirectionConstrainedJointPTPPathDefinitionNameEnum, PathJointPTPPathDefinitionNameEnum, PathLinePathDefinitionNameEnum, PauseActionChunksRequestMessageTypeEnum, PauseActionChunksResponseKindEnum, PauseJoggingRequestMessageTypeEnum, PauseJoggingResponseKindEnum, PauseMovementRequestMessageTypeEnum, PauseMovementResponseKindEnum, PlaneShapeTypeEnum, PlaybackSpeedRequestMessageTypeEnum, PlaybackSpeedResponseKindEnum, PoseWaypointKindEnum, ProfinetIODirection, ProfinetIOTypeEnum, ProgramApi, ProgramApiAxiosParamCreator, ProgramApiFactory, ProgramApiFp, ProgramRunState, RRTConnectAlgorithmAlgorithmNameEnum, RectangleShapeTypeEnum, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotSystemMode, SafetyStateType, ServiceGroup, ServiceStatusPhase, ServiceStatusSeverity, SessionApi, SessionApiAxiosParamCreator, SessionApiFactory, SessionApiFp, SettableRobotSystemMode, SingularityHandling, SingularityTypeEnum, Snap7IOArea, Snap7IODirection, Snap7IOTypeEnum, SphereShapeTypeEnum, StartMovementRequestMessageTypeEnum, StartMovementResponseKindEnum, StaubliControllerKindEnum, StopActionChunksRequestMessageTypeEnum, StopActionChunksResponseKindEnum, StorageKeySourceEnum, StoreCollisionComponentsApi, StoreCollisionComponentsApiAxiosParamCreator, StoreCollisionComponentsApiFactory, StoreCollisionComponentsApiFp, StoreCollisionSetupsApi, StoreCollisionSetupsApiAxiosParamCreator, StoreCollisionSetupsApiFactory, StoreCollisionSetupsApiFp, StoreObjectApi, StoreObjectApiAxiosParamCreator, StoreObjectApiFactory, StoreObjectApiFp, SystemApi, SystemApiAxiosParamCreator, SystemApiFactory, SystemApiFp, TcpRequiredErrorKindEnum, TcpVelocityRequestMessageTypeEnum, TcpVelocityResponseKindEnum, TechmanControllerKindEnum, ToolValueSourceEnum, TorqueExceededErrorKindEnum, TrajectoryCachingApi, TrajectoryCachingApiAxiosParamCreator, TrajectoryCachingApiFactory, TrajectoryCachingApiFp, TrajectoryDataMessageTypeEnum, TrajectoryDetailsKindEnum, TrajectoryEndedKindEnum, TrajectoryExecutionApi, TrajectoryExecutionApiAxiosParamCreator, TrajectoryExecutionApiFactory, TrajectoryExecutionApiFp, TrajectoryIdMessageTypeEnum, TrajectoryPausedByUserKindEnum, TrajectoryPausedOnIOKindEnum, TrajectoryPlanningApi, TrajectoryPlanningApiAxiosParamCreator, TrajectoryPlanningApiFactory, TrajectoryPlanningApiFp, TrajectoryRunningKindEnum, TrajectoryWaitForIOKindEnum, UnitType, UnitreeControllerKindEnum, UnitreeControllerRobotTypeEnum, UniversalrobotsControllerKindEnum, UnpauseActionChunksRequestMessageTypeEnum, UnpauseActionChunksResponseKindEnum, VersionApi, VersionApiAxiosParamCreator, VersionApiFactory, VersionApiFp, VirtualControllerApi, VirtualControllerApiAxiosParamCreator, VirtualControllerApiFactory, VirtualControllerApiFp, VirtualControllerBehaviorApi, VirtualControllerBehaviorApiAxiosParamCreator, VirtualControllerBehaviorApiFactory, VirtualControllerBehaviorApiFp, VirtualControllerInputsOutputsApi, VirtualControllerInputsOutputsApiAxiosParamCreator, VirtualControllerInputsOutputsApiFactory, VirtualControllerInputsOutputsApiFp, VirtualControllerKindEnum, YaskawaControllerKindEnum, ZodValidationErrorErrorCodeEnum, operationServerMap };
|