@wandelbots/nova-api 26.4.0-dev.3 → 26.4.0-dev.30
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/{defineProperty-CQ_RnIQg.js → defineProperty-6Ts4XR6h.js} +9 -13
- package/dist/defineProperty-D0JvJyYC.cjs +72 -0
- package/dist/v1/index.cjs +405 -411
- package/dist/v1/index.d.cts +193 -194
- package/dist/v1/index.d.ts +193 -194
- package/dist/v1/index.js +10 -15
- package/dist/v2/index.cjs +468 -357
- package/dist/v2/index.d.cts +360 -172
- package/dist/v2/index.d.ts +360 -172
- package/dist/v2/index.js +119 -11
- package/package.json +4 -4
- package/dist/defineProperty-CWzmgFYR.cjs +0 -97
package/dist/v2/index.d.ts
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _$axios from "axios";
|
|
2
2
|
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
3
|
|
|
4
4
|
//#region v2/configuration.d.ts
|
|
5
|
-
|
|
6
5
|
/**
|
|
7
6
|
* Wandelbots NOVA API
|
|
8
7
|
* Interact with robots in an easy and intuitive way.
|
|
9
8
|
*
|
|
10
|
-
* The version of the OpenAPI document: 2.
|
|
9
|
+
* The version of the OpenAPI document: 2.4.0 dev
|
|
11
10
|
*
|
|
12
11
|
*
|
|
13
12
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -584,6 +583,19 @@ declare const BusIOsStateEnum: {
|
|
|
584
583
|
readonly BusIosStateDisconnected: "BUS_IOS_STATE_DISCONNECTED";
|
|
585
584
|
};
|
|
586
585
|
type BusIOsStateEnum = typeof BusIOsStateEnum[keyof typeof BusIOsStateEnum];
|
|
586
|
+
/**
|
|
587
|
+
* A capability granted to the authenticated user. If `resource_ids` is absent or empty, the capability is granted globally without resource restriction.
|
|
588
|
+
*/
|
|
589
|
+
interface CapabilityEntry {
|
|
590
|
+
/**
|
|
591
|
+
* Capability relation name.
|
|
592
|
+
*/
|
|
593
|
+
'capability': string;
|
|
594
|
+
/**
|
|
595
|
+
* Resource identifiers the capability is scoped to. Absent or empty means the capability is granted globally. Resource IDs are deduplicated and sorted in ascending order.
|
|
596
|
+
*/
|
|
597
|
+
'resource_ids'?: Array<string>;
|
|
598
|
+
}
|
|
587
599
|
/**
|
|
588
600
|
* Defines a cylindrical shape with 2 semi-spheres on the top and bottom. Centred around origin, symmetric around z-axis.
|
|
589
601
|
*/
|
|
@@ -663,7 +675,7 @@ interface CloudConfiguration {
|
|
|
663
675
|
/**
|
|
664
676
|
* Instance identifier received from cloud registration
|
|
665
677
|
*/
|
|
666
|
-
'instance':
|
|
678
|
+
'instance': number;
|
|
667
679
|
}
|
|
668
680
|
interface CloudConnectionError {
|
|
669
681
|
'error': CloudConnectionErrorError;
|
|
@@ -797,7 +809,7 @@ interface CloudRegistrationSuccessResponse {
|
|
|
797
809
|
/**
|
|
798
810
|
* Instance identifier received from cloud registration
|
|
799
811
|
*/
|
|
800
|
-
'instance':
|
|
812
|
+
'instance': number;
|
|
801
813
|
}
|
|
802
814
|
/**
|
|
803
815
|
* Defines a collider with a single shape. A collider is an object that is used for collision detection. It defines the `shape` that is attached with the offset of `pose` to a reference frame. Use colliders to: - Define the shape of a workpiece. The reference frame is the scene origin. - Define the shape of a link in a motion group. The reference frame is the link coordinate system. - Define the shape of a tool. The reference frame is the flange coordinate system.
|
|
@@ -1829,6 +1841,10 @@ interface InitializeMovementRequest {
|
|
|
1829
1841
|
* Unique identifier addressing a coordinate system to which the responses are transformed. If not set, world coordinate system is used.
|
|
1830
1842
|
*/
|
|
1831
1843
|
'response_coordinate_system'?: string;
|
|
1844
|
+
/**
|
|
1845
|
+
* If the flag is `true`, controller limits are ignored. Changes to controller limits are not applied to the trajectory.
|
|
1846
|
+
*/
|
|
1847
|
+
'ignore_controller_limits'?: boolean;
|
|
1832
1848
|
}
|
|
1833
1849
|
declare const InitializeMovementRequestMessageTypeEnum: {
|
|
1834
1850
|
readonly InitializeMovementRequest: "InitializeMovementRequest";
|
|
@@ -3450,6 +3466,55 @@ interface ProgramStartRequest {
|
|
|
3450
3466
|
*/
|
|
3451
3467
|
'arguments': object;
|
|
3452
3468
|
}
|
|
3469
|
+
interface ProjectJointPositionDirectionConstraint422Response {
|
|
3470
|
+
'detail'?: Array<ProjectJointPositionDirectionConstraintValidationError>;
|
|
3471
|
+
}
|
|
3472
|
+
interface ProjectJointPositionDirectionConstraintRequest {
|
|
3473
|
+
/**
|
|
3474
|
+
* Identifies a single motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported types.
|
|
3475
|
+
*/
|
|
3476
|
+
'motion_group_model': string;
|
|
3477
|
+
/**
|
|
3478
|
+
* List of joint positions for which the direction constraint is applied.
|
|
3479
|
+
*/
|
|
3480
|
+
'joint_positions': Array<Array<number>>;
|
|
3481
|
+
'constraint': DirectionConstraint;
|
|
3482
|
+
'tcp_offset'?: Pose;
|
|
3483
|
+
/**
|
|
3484
|
+
* Offset from the world frame to the motion group base.
|
|
3485
|
+
*/
|
|
3486
|
+
'mounting'?: Pose;
|
|
3487
|
+
/**
|
|
3488
|
+
* 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].
|
|
3489
|
+
*/
|
|
3490
|
+
'joint_position_limits'?: Array<LimitRange>;
|
|
3491
|
+
/**
|
|
3492
|
+
* 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.
|
|
3493
|
+
*/
|
|
3494
|
+
'collision_setups'?: {
|
|
3495
|
+
[key: string]: CollisionSetup;
|
|
3496
|
+
};
|
|
3497
|
+
}
|
|
3498
|
+
interface ProjectJointPositionDirectionConstraintResponse {
|
|
3499
|
+
/**
|
|
3500
|
+
* List of projected joint positions. If the resulting joint position is in collision or violates joint limits, the corresponding entry is null.
|
|
3501
|
+
*/
|
|
3502
|
+
'projected_joint_positions': Array<Array<number> | null>;
|
|
3503
|
+
}
|
|
3504
|
+
interface ProjectJointPositionDirectionConstraintValidationError {
|
|
3505
|
+
'loc': Array<ValidationErrorLocInner>;
|
|
3506
|
+
'msg': string;
|
|
3507
|
+
'type': string;
|
|
3508
|
+
'input': {
|
|
3509
|
+
[key: string]: any;
|
|
3510
|
+
};
|
|
3511
|
+
'data'?: ProjectJointPositionDirectionConstraintValidationErrorAllOfData;
|
|
3512
|
+
}
|
|
3513
|
+
/**
|
|
3514
|
+
* @type ProjectJointPositionDirectionConstraintValidationErrorAllOfData
|
|
3515
|
+
* Optional data further specifying the validation error.
|
|
3516
|
+
*/
|
|
3517
|
+
type ProjectJointPositionDirectionConstraintValidationErrorAllOfData = ErrorDirectionConstraintNotNormalized | ErrorInvalidJointCount | ErrorUnsupportedOperation;
|
|
3453
3518
|
interface RRTConnectAlgorithm {
|
|
3454
3519
|
/**
|
|
3455
3520
|
* Algorithm discriminator. RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points with JointPTP motions. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts.
|
|
@@ -3894,6 +3959,28 @@ interface ServiceStatusStatus {
|
|
|
3894
3959
|
'code': ServiceStatusPhase;
|
|
3895
3960
|
'reason'?: string;
|
|
3896
3961
|
}
|
|
3962
|
+
/**
|
|
3963
|
+
* Session information including user identity, capabilities, and token lifetime metadata. On unmanaged instances (no authentication or authorization configured), a default anonymous session is returned with `session_id` \"default\", empty user fields, no capabilities, and zero-value timestamps.
|
|
3964
|
+
*/
|
|
3965
|
+
interface SessionResponse {
|
|
3966
|
+
/**
|
|
3967
|
+
* Unique identifier for the current session. For authenticated sessions this is derived from the access token. Unmanaged instances return \"default\".
|
|
3968
|
+
*/
|
|
3969
|
+
'session_id': string;
|
|
3970
|
+
'user': User;
|
|
3971
|
+
/**
|
|
3972
|
+
* Capability entries resolved for the user. Empty on unmanaged instances.
|
|
3973
|
+
*/
|
|
3974
|
+
'capabilities': Array<CapabilityEntry>;
|
|
3975
|
+
/**
|
|
3976
|
+
* Timestamp when the underlying access token was issued. Zero-value on unmanaged instances.
|
|
3977
|
+
*/
|
|
3978
|
+
'issued_at': string;
|
|
3979
|
+
/**
|
|
3980
|
+
* Timestamp when the underlying access token expires. Zero-value on unmanaged instances.
|
|
3981
|
+
*/
|
|
3982
|
+
'expires_at': string;
|
|
3983
|
+
}
|
|
3897
3984
|
/**
|
|
3898
3985
|
* Defines an input/output that should be set upon reaching a specified location on the trajectory.
|
|
3899
3986
|
*/
|
|
@@ -4252,6 +4339,23 @@ interface UpdateNovaVersionRequest {
|
|
|
4252
4339
|
*/
|
|
4253
4340
|
'update_cells'?: boolean;
|
|
4254
4341
|
}
|
|
4342
|
+
/**
|
|
4343
|
+
* Identity information for the session user. On unmanaged instances all fields are empty strings representing an anonymous user.
|
|
4344
|
+
*/
|
|
4345
|
+
interface User {
|
|
4346
|
+
/**
|
|
4347
|
+
* Subject identifier of the user. Empty on unmanaged instances.
|
|
4348
|
+
*/
|
|
4349
|
+
'id': string;
|
|
4350
|
+
/**
|
|
4351
|
+
* Display name of the user. Empty on unmanaged instances.
|
|
4352
|
+
*/
|
|
4353
|
+
'name': string;
|
|
4354
|
+
/**
|
|
4355
|
+
* Email address of the user. Empty on unmanaged instances.
|
|
4356
|
+
*/
|
|
4357
|
+
'email': string;
|
|
4358
|
+
}
|
|
4255
4359
|
interface ValidationError {
|
|
4256
4360
|
'loc': Array<ValidationErrorLocInner>;
|
|
4257
4361
|
'msg': string;
|
|
@@ -4552,7 +4656,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4552
4656
|
* @param {*} [options] Override http request option.
|
|
4553
4657
|
* @throws {RequiredError}
|
|
4554
4658
|
*/
|
|
4555
|
-
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4659
|
+
addApp(cell: string, app: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
4556
4660
|
/**
|
|
4557
4661
|
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Delete all GUI applications from the cell.
|
|
4558
4662
|
* @summary Clear Applications
|
|
@@ -4561,7 +4665,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4561
4665
|
* @param {*} [options] Override http request option.
|
|
4562
4666
|
* @throws {RequiredError}
|
|
4563
4667
|
*/
|
|
4564
|
-
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4668
|
+
clearApps(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
4565
4669
|
/**
|
|
4566
4670
|
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Delete a GUI application from the cell.
|
|
4567
4671
|
* @summary Delete Application
|
|
@@ -4571,7 +4675,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4571
4675
|
* @param {*} [options] Override http request option.
|
|
4572
4676
|
* @throws {RequiredError}
|
|
4573
4677
|
*/
|
|
4574
|
-
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4678
|
+
deleteApp(cell: string, app: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
4575
4679
|
/**
|
|
4576
4680
|
* **Required permissions:** `can_access_apps` - View application configurations ___ 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).
|
|
4577
4681
|
* @summary Configuration
|
|
@@ -4580,7 +4684,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4580
4684
|
* @param {*} [options] Override http request option.
|
|
4581
4685
|
* @throws {RequiredError}
|
|
4582
4686
|
*/
|
|
4583
|
-
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<
|
|
4687
|
+
getApp(cell: string, app: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<App, any, {}>>;
|
|
4584
4688
|
/**
|
|
4585
4689
|
* **Required permissions:** `can_access_apps` - View application configurations ___ 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.
|
|
4586
4690
|
* @summary List Applications
|
|
@@ -4588,7 +4692,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4588
4692
|
* @param {*} [options] Override http request option.
|
|
4589
4693
|
* @throws {RequiredError}
|
|
4590
4694
|
*/
|
|
4591
|
-
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
4695
|
+
listApps(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
4592
4696
|
/**
|
|
4593
4697
|
* **Required permissions:** `can_manage_apps` - Install, update, or remove applications ___ Update the configuration of a GUI application in the cell.
|
|
4594
4698
|
* @summary Update Configuration
|
|
@@ -4599,7 +4703,7 @@ declare class ApplicationApi extends BaseAPI {
|
|
|
4599
4703
|
* @param {*} [options] Override http request option.
|
|
4600
4704
|
* @throws {RequiredError}
|
|
4601
4705
|
*/
|
|
4602
|
-
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
4706
|
+
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
4603
4707
|
}
|
|
4604
4708
|
/**
|
|
4605
4709
|
* BUSInputsOutputsApi - axios parameter creator
|
|
@@ -5127,7 +5231,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5127
5231
|
* @param {*} [options] Override http request option.
|
|
5128
5232
|
* @throws {RequiredError}
|
|
5129
5233
|
*/
|
|
5130
|
-
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5234
|
+
addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5131
5235
|
/**
|
|
5132
5236
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ 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).
|
|
5133
5237
|
* @summary Add MODBUS Input/Output
|
|
@@ -5137,7 +5241,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5137
5241
|
* @param {*} [options] Override http request option.
|
|
5138
5242
|
* @throws {RequiredError}
|
|
5139
5243
|
*/
|
|
5140
|
-
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<
|
|
5244
|
+
addModbusIO(cell: string, io: string, modbusIOData: ModbusIOData, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5141
5245
|
/**
|
|
5142
5246
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ 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).
|
|
5143
5247
|
* @summary Add PROFINET Input/Output
|
|
@@ -5147,7 +5251,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5147
5251
|
* @param {*} [options] Override http request option.
|
|
5148
5252
|
* @throws {RequiredError}
|
|
5149
5253
|
*/
|
|
5150
|
-
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<
|
|
5254
|
+
addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5151
5255
|
/**
|
|
5152
5256
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Remove the BUS inputs/outputs service from the cell.
|
|
5153
5257
|
* @summary Clear Service
|
|
@@ -5156,7 +5260,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5156
5260
|
* @param {*} [options] Override http request option.
|
|
5157
5261
|
* @throws {RequiredError}
|
|
5158
5262
|
*/
|
|
5159
|
-
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5263
|
+
clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5160
5264
|
/**
|
|
5161
5265
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Removes all input/output variable configurations from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
5162
5266
|
* @summary Remove all MODBUS Input/Outputs
|
|
@@ -5164,7 +5268,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5164
5268
|
* @param {*} [options] Override http request option.
|
|
5165
5269
|
* @throws {RequiredError}
|
|
5166
5270
|
*/
|
|
5167
|
-
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5271
|
+
deleteAllModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5168
5272
|
/**
|
|
5169
5273
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Removes all input/output variable configurations from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
5170
5274
|
* @summary Remove all PROFINET Input/Outputs
|
|
@@ -5172,7 +5276,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5172
5276
|
* @param {*} [options] Override http request option.
|
|
5173
5277
|
* @throws {RequiredError}
|
|
5174
5278
|
*/
|
|
5175
|
-
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5279
|
+
deleteAllProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5176
5280
|
/**
|
|
5177
5281
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Removes an input/output variable configuration from the MODBUS device, e.g., NOVA\'s MODBUS service.
|
|
5178
5282
|
* @summary Remove MODBUS Input/Output
|
|
@@ -5181,7 +5285,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5181
5285
|
* @param {*} [options] Override http request option.
|
|
5182
5286
|
* @throws {RequiredError}
|
|
5183
5287
|
*/
|
|
5184
|
-
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
5288
|
+
deleteModbusIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5185
5289
|
/**
|
|
5186
5290
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ Removes an input/output variable configuration from the PROFINET device, e.g., NOVA\'s PROFINET service.
|
|
5187
5291
|
* @summary Remove PROFINET Input/Ouptut
|
|
@@ -5190,7 +5294,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5190
5294
|
* @param {*} [options] Override http request option.
|
|
5191
5295
|
* @throws {RequiredError}
|
|
5192
5296
|
*/
|
|
5193
|
-
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<
|
|
5297
|
+
deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5194
5298
|
/**
|
|
5195
5299
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get deployed BUS inputs/outputs service.
|
|
5196
5300
|
* @summary Get Service
|
|
@@ -5198,7 +5302,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5198
5302
|
* @param {*} [options] Override http request option.
|
|
5199
5303
|
* @throws {RequiredError}
|
|
5200
5304
|
*/
|
|
5201
|
-
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5305
|
+
getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<BusIOType, any, {}>>;
|
|
5202
5306
|
/**
|
|
5203
5307
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get the current state of the BUS Inputs/Outputs service.
|
|
5204
5308
|
* @summary State
|
|
@@ -5206,7 +5310,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5206
5310
|
* @param {*} [options] Override http request option.
|
|
5207
5311
|
* @throws {RequiredError}
|
|
5208
5312
|
*/
|
|
5209
|
-
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5313
|
+
getBusIOState(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<BusIOsState, any, {}>>;
|
|
5210
5314
|
/**
|
|
5211
5315
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ 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).
|
|
5212
5316
|
* @summary Get Input/Output Values
|
|
@@ -5215,7 +5319,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5215
5319
|
* @param {*} [options] Override http request option.
|
|
5216
5320
|
* @throws {RequiredError}
|
|
5217
5321
|
*/
|
|
5218
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
5322
|
+
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<IOValue[], any, {}>>;
|
|
5219
5323
|
/**
|
|
5220
5324
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Get description of NOVA as a PROFINET device.
|
|
5221
5325
|
* @summary Get PROFINET Description
|
|
@@ -5223,7 +5327,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5223
5327
|
* @param {*} [options] Override http request option.
|
|
5224
5328
|
* @throws {RequiredError}
|
|
5225
5329
|
*/
|
|
5226
|
-
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5330
|
+
getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ProfinetDescription, any, {}>>;
|
|
5227
5331
|
/**
|
|
5228
5332
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ Returns the Generic Station Description Markup Language (GSDML) file for the PROFINET device. The GSDML file describes the PROFINET device configuration and capabilities, and can be imported into PROFINET engineering tools, e.g., TIA Portal, or other PLC programming environments. The returned GSDML file matches the current slot configuration of the PROFINET device.
|
|
5229
5333
|
* @summary Get PROFINET GSDML File
|
|
@@ -5231,7 +5335,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5231
5335
|
* @param {*} [options] Override http request option.
|
|
5232
5336
|
* @throws {RequiredError}
|
|
5233
5337
|
*/
|
|
5234
|
-
getProfinetGSDML(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5338
|
+
getProfinetGSDML(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string, any, {}>>;
|
|
5235
5339
|
/**
|
|
5236
5340
|
* **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 the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g., TIA portal.
|
|
5237
5341
|
* @summary PROFINET Inputs/Outputs to File
|
|
@@ -5241,7 +5345,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5241
5345
|
* @param {*} [options] Override http request option.
|
|
5242
5346
|
* @throws {RequiredError}
|
|
5243
5347
|
*/
|
|
5244
|
-
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5348
|
+
getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string, any, {}>>;
|
|
5245
5349
|
/**
|
|
5246
5350
|
* **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.
|
|
5247
5351
|
* @summary List Descriptions
|
|
@@ -5249,7 +5353,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5249
5353
|
* @param {*} [options] Override http request option.
|
|
5250
5354
|
* @throws {RequiredError}
|
|
5251
5355
|
*/
|
|
5252
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5356
|
+
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<BusIODescription[], any, {}>>;
|
|
5253
5357
|
/**
|
|
5254
5358
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ 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).
|
|
5255
5359
|
* @summary List MODBUS Input/Output Configuration
|
|
@@ -5257,7 +5361,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5257
5361
|
* @param {*} [options] Override http request option.
|
|
5258
5362
|
* @throws {RequiredError}
|
|
5259
5363
|
*/
|
|
5260
|
-
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5364
|
+
listModbusIOs(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ModbusIO[], any, {}>>;
|
|
5261
5365
|
/**
|
|
5262
5366
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ 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.
|
|
5263
5367
|
* @summary List PROFINET Input/Output Configuration
|
|
@@ -5265,7 +5369,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5265
5369
|
* @param {*} [options] Override http request option.
|
|
5266
5370
|
* @throws {RequiredError}
|
|
5267
5371
|
*/
|
|
5268
|
-
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5372
|
+
listProfinetIOs(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ProfinetIO[], any, {}>>;
|
|
5269
5373
|
/**
|
|
5270
5374
|
* **Required permissions:** `can_operate_bus_ios` - Read and write BUS IO values ___ 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.
|
|
5271
5375
|
* @summary Set Output Values
|
|
@@ -5274,7 +5378,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5274
5378
|
* @param {*} [options] Override http request option.
|
|
5275
5379
|
* @throws {RequiredError}
|
|
5276
5380
|
*/
|
|
5277
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
5381
|
+
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5278
5382
|
/**
|
|
5279
5383
|
* **Required permissions:** `can_manage_bus_ios` - Manage BUS IO configuration ___ 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.
|
|
5280
5384
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
@@ -5283,7 +5387,7 @@ declare class BUSInputsOutputsApi extends BaseAPI {
|
|
|
5283
5387
|
* @param {*} [options] Override http request option.
|
|
5284
5388
|
* @throws {RequiredError}
|
|
5285
5389
|
*/
|
|
5286
|
-
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<
|
|
5390
|
+
setProfinetIOsFromFile(cell: string, profinetInputOutputConfig: ProfinetInputOutputConfig, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5287
5391
|
}
|
|
5288
5392
|
/**
|
|
5289
5393
|
* CellApi - axios parameter creator
|
|
@@ -5333,7 +5437,7 @@ declare const CellApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5333
5437
|
*/
|
|
5334
5438
|
getCellStatus: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5335
5439
|
/**
|
|
5336
|
-
* **Required permissions:** `
|
|
5440
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
5337
5441
|
* @summary List Cells
|
|
5338
5442
|
* @param {*} [options] Override http request option.
|
|
5339
5443
|
* @throws {RequiredError}
|
|
@@ -5416,7 +5520,7 @@ declare const CellApiFp: (configuration?: Configuration) => {
|
|
|
5416
5520
|
*/
|
|
5417
5521
|
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceStatusResponse>>;
|
|
5418
5522
|
/**
|
|
5419
|
-
* **Required permissions:** `
|
|
5523
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
5420
5524
|
* @summary List Cells
|
|
5421
5525
|
* @param {*} [options] Override http request option.
|
|
5422
5526
|
* @throws {RequiredError}
|
|
@@ -5499,7 +5603,7 @@ declare const CellApiFactory: (configuration?: Configuration, basePath?: string,
|
|
|
5499
5603
|
*/
|
|
5500
5604
|
getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ServiceStatusResponse>;
|
|
5501
5605
|
/**
|
|
5502
|
-
* **Required permissions:** `
|
|
5606
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
5503
5607
|
* @summary List Cells
|
|
5504
5608
|
* @param {*} [options] Override http request option.
|
|
5505
5609
|
* @throws {RequiredError}
|
|
@@ -5546,7 +5650,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5546
5650
|
* @param {*} [options] Override http request option.
|
|
5547
5651
|
* @throws {RequiredError}
|
|
5548
5652
|
*/
|
|
5549
|
-
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
5653
|
+
checkCellVersionUpdate(cell: string, channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string, any, {}>>;
|
|
5550
5654
|
/**
|
|
5551
5655
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Delete an entire cell.
|
|
5552
5656
|
* @summary Delete Cell
|
|
@@ -5555,7 +5659,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5555
5659
|
* @param {*} [options] Override http request option.
|
|
5556
5660
|
* @throws {RequiredError}
|
|
5557
5661
|
*/
|
|
5558
|
-
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5662
|
+
deleteCell(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5559
5663
|
/**
|
|
5560
5664
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Deploy an entire cell with all its resources. A cell can be used to deploy a robot controller, one or more robots, as well as custom applications. Refer to the [Wandelbots NOVA documentation](https://docs.wandelbots.io/latest/setup-cell) for more information.
|
|
5561
5665
|
* @summary Add Cell
|
|
@@ -5564,7 +5668,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5564
5668
|
* @param {*} [options] Override http request option.
|
|
5565
5669
|
* @throws {RequiredError}
|
|
5566
5670
|
*/
|
|
5567
|
-
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5671
|
+
deployCell(cell: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5568
5672
|
/**
|
|
5569
5673
|
* **Required permissions:** `can_access_cells` - View cell configurations and resources ___ List all cell resources.
|
|
5570
5674
|
* @summary Configuration
|
|
@@ -5572,7 +5676,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5572
5676
|
* @param {*} [options] Override http request option.
|
|
5573
5677
|
* @throws {RequiredError}
|
|
5574
5678
|
*/
|
|
5575
|
-
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5679
|
+
getCell(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<Cell, any, {}>>;
|
|
5576
5680
|
/**
|
|
5577
5681
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ List the status of all cell resources.
|
|
5578
5682
|
* @summary Service Status
|
|
@@ -5580,14 +5684,14 @@ declare class CellApi extends BaseAPI {
|
|
|
5580
5684
|
* @param {*} [options] Override http request option.
|
|
5581
5685
|
* @throws {RequiredError}
|
|
5582
5686
|
*/
|
|
5583
|
-
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
5687
|
+
getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ServiceStatusResponse, any, {}>>;
|
|
5584
5688
|
/**
|
|
5585
|
-
* **Required permissions:** `
|
|
5689
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ List all deployed cell names. If no cells are deployed, an empty list is returned.
|
|
5586
5690
|
* @summary List Cells
|
|
5587
5691
|
* @param {*} [options] Override http request option.
|
|
5588
5692
|
* @throws {RequiredError}
|
|
5589
5693
|
*/
|
|
5590
|
-
listCells(options?: RawAxiosRequestConfig): Promise<
|
|
5694
|
+
listCells(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
5591
5695
|
/**
|
|
5592
5696
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Deactivate or activate the services of a cell.
|
|
5593
5697
|
* @summary Operating State
|
|
@@ -5596,7 +5700,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5596
5700
|
* @param {*} [options] Override http request option.
|
|
5597
5701
|
* @throws {RequiredError}
|
|
5598
5702
|
*/
|
|
5599
|
-
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<
|
|
5703
|
+
setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5600
5704
|
/**
|
|
5601
5705
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Update the definition of the entire cell. <!-- theme: info --> > **NOTE** > > This endpoint replaces the full cell configuration and is not a partial update. > To change only one field: > 1. Get the current configuration via [Cell > Configuration](#/operations/getCell). > 2. Send the full configuration with your intended changes via [Cell > Update Configuration](#/operations/updateCell). Omitting existing sections may reset or remove their current configuration.
|
|
5602
5706
|
* @summary Update Configuration
|
|
@@ -5606,7 +5710,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5606
5710
|
* @param {*} [options] Override http request option.
|
|
5607
5711
|
* @throws {RequiredError}
|
|
5608
5712
|
*/
|
|
5609
|
-
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
5713
|
+
updateCell(cell: string, cell2: Cell, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5610
5714
|
/**
|
|
5611
5715
|
* **Required permissions:** `can_manage_cells` - Create, update, or delete cells ___ Update the Foundation chart version for a single cell based on a release channel. The resulting version is capped at the current system version.
|
|
5612
5716
|
* @summary Update Cell Version
|
|
@@ -5615,7 +5719,7 @@ declare class CellApi extends BaseAPI {
|
|
|
5615
5719
|
* @param {*} [options] Override http request option.
|
|
5616
5720
|
* @throws {RequiredError}
|
|
5617
5721
|
*/
|
|
5618
|
-
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
5722
|
+
updateCellVersion(cell: string, updateCellVersionRequest: UpdateCellVersionRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
5619
5723
|
}
|
|
5620
5724
|
/**
|
|
5621
5725
|
* ControllerApi - axios parameter creator
|
|
@@ -6053,7 +6157,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6053
6157
|
* @param {*} [options] Override http request option.
|
|
6054
6158
|
* @throws {RequiredError}
|
|
6055
6159
|
*/
|
|
6056
|
-
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6160
|
+
addRobotController(cell: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
6057
6161
|
/**
|
|
6058
6162
|
* **Required permissions:** `can_manage_controllers` - Create, update, or delete robot controllers ___ Delete all robot controllers from the cell. To replace all robot controllers in a cell, use this endpoint in combination with [addRobotController](#/operations/addRobotController).
|
|
6059
6163
|
* @summary Clear Robot Controllers
|
|
@@ -6062,7 +6166,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6062
6166
|
* @param {*} [options] Override http request option.
|
|
6063
6167
|
* @throws {RequiredError}
|
|
6064
6168
|
*/
|
|
6065
|
-
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6169
|
+
clearRobotControllers(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
6066
6170
|
/**
|
|
6067
6171
|
* **Required permissions:** `can_manage_controllers` - Create, update, or delete robot controllers ___ Delete a robot controller from the cell.
|
|
6068
6172
|
* @summary Delete Robot Controller
|
|
@@ -6072,7 +6176,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6072
6176
|
* @param {*} [options] Override http request option.
|
|
6073
6177
|
* @throws {RequiredError}
|
|
6074
6178
|
*/
|
|
6075
|
-
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6179
|
+
deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
6076
6180
|
/**
|
|
6077
6181
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
6078
6182
|
* @summary Description
|
|
@@ -6081,7 +6185,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6081
6185
|
* @param {*} [options] Override http request option.
|
|
6082
6186
|
* @throws {RequiredError}
|
|
6083
6187
|
*/
|
|
6084
|
-
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
6188
|
+
getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ControllerDescription, any, {}>>;
|
|
6085
6189
|
/**
|
|
6086
6190
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Request a coordinate system specification for a given identifier. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
|
|
6087
6191
|
* @summary Coordinate System
|
|
@@ -6092,7 +6196,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6092
6196
|
* @param {*} [options] Override http request option.
|
|
6093
6197
|
* @throws {RequiredError}
|
|
6094
6198
|
*/
|
|
6095
|
-
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
6199
|
+
getCoordinateSystem(cell: string, controller: string, coordinateSystem: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CoordinateSystem, any, {}>>;
|
|
6096
6200
|
/**
|
|
6097
6201
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Get the current state of a robot controller.
|
|
6098
6202
|
* @summary State
|
|
@@ -6101,7 +6205,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6101
6205
|
* @param {*} [options] Override http request option.
|
|
6102
6206
|
* @throws {RequiredError}
|
|
6103
6207
|
*/
|
|
6104
|
-
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
6208
|
+
getCurrentRobotControllerState(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<RobotControllerState, any, {}>>;
|
|
6105
6209
|
/**
|
|
6106
6210
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Get the configuration for a robot controller.
|
|
6107
6211
|
* @summary Robot Controller
|
|
@@ -6110,7 +6214,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6110
6214
|
* @param {*} [options] Override http request option.
|
|
6111
6215
|
* @throws {RequiredError}
|
|
6112
6216
|
*/
|
|
6113
|
-
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
6217
|
+
getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<RobotController, any, {}>>;
|
|
6114
6218
|
/**
|
|
6115
6219
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
6116
6220
|
* @summary Virtual Controller Configuration
|
|
@@ -6119,7 +6223,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6119
6223
|
* @param {*} [options] Override http request option.
|
|
6120
6224
|
* @throws {RequiredError}
|
|
6121
6225
|
*/
|
|
6122
|
-
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
6226
|
+
getVirtualControllerConfiguration(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<VirtualRobotConfiguration, any, {}>>;
|
|
6123
6227
|
/**
|
|
6124
6228
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Lists all specifications of coordinate systems from robot controllers. Use parameter `orientation_type` to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter `orientation_type` is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation. The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with `On` + the unique identifier of the robot controller.
|
|
6125
6229
|
* @summary List Coordinate Systems
|
|
@@ -6129,7 +6233,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6129
6233
|
* @param {*} [options] Override http request option.
|
|
6130
6234
|
* @throws {RequiredError}
|
|
6131
6235
|
*/
|
|
6132
|
-
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<
|
|
6236
|
+
listCoordinateSystems(cell: string, controller: string, orientationType?: OrientationType, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CoordinateSystem[], any, {}>>;
|
|
6133
6237
|
/**
|
|
6134
6238
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ List the names of all deployed robot controllers.
|
|
6135
6239
|
* @summary List Robot Controllers
|
|
@@ -6137,7 +6241,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6137
6241
|
* @param {*} [options] Override http request option.
|
|
6138
6242
|
* @throws {RequiredError}
|
|
6139
6243
|
*/
|
|
6140
|
-
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
6244
|
+
listRobotControllers(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
6141
6245
|
/**
|
|
6142
6246
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
6143
6247
|
* @summary Set Default Mode
|
|
@@ -6147,7 +6251,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6147
6251
|
* @param {*} [options] Override http request option.
|
|
6148
6252
|
* @throws {RequiredError}
|
|
6149
6253
|
*/
|
|
6150
|
-
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<
|
|
6254
|
+
setDefaultMode(cell: string, controller: string, mode: SettableRobotSystemMode, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
6151
6255
|
/**
|
|
6152
6256
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- 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.
|
|
6153
6257
|
* @summary Stream Free Drive
|
|
@@ -6157,7 +6261,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6157
6261
|
* @param {*} [options] Override http request option.
|
|
6158
6262
|
* @throws {RequiredError}
|
|
6159
6263
|
*/
|
|
6160
|
-
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6264
|
+
streamFreeDrive(cell: string, controller: string, responseRate?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<RobotControllerState, any, {}>>;
|
|
6161
6265
|
/**
|
|
6162
6266
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- 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.
|
|
6163
6267
|
* @summary Stream State
|
|
@@ -6168,7 +6272,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6168
6272
|
* @param {*} [options] Override http request option.
|
|
6169
6273
|
* @throws {RequiredError}
|
|
6170
6274
|
*/
|
|
6171
|
-
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6275
|
+
streamRobotControllerState(cell: string, controller: string, responseRate?: number, addControllerTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<RobotControllerState, any, {}>>;
|
|
6172
6276
|
/**
|
|
6173
6277
|
* **Required permissions:** `can_manage_controllers` - Create, update, or delete robot controllers ___ 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).
|
|
6174
6278
|
* @summary Update Robot Controller
|
|
@@ -6179,7 +6283,7 @@ declare class ControllerApi extends BaseAPI {
|
|
|
6179
6283
|
* @param {*} [options] Override http request option.
|
|
6180
6284
|
* @throws {RequiredError}
|
|
6181
6285
|
*/
|
|
6182
|
-
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
6286
|
+
updateRobotController(cell: string, controller: string, robotController: RobotController, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
6183
6287
|
}
|
|
6184
6288
|
/**
|
|
6185
6289
|
* ControllerInputsOutputsApi - axios parameter creator
|
|
@@ -6371,7 +6475,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6371
6475
|
* @param {*} [options] Override http request option.
|
|
6372
6476
|
* @throws {RequiredError}
|
|
6373
6477
|
*/
|
|
6374
|
-
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
6478
|
+
listIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<IODescription[], any, {}>>;
|
|
6375
6479
|
/**
|
|
6376
6480
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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).
|
|
6377
6481
|
* @summary Get Input/Output Values
|
|
@@ -6381,7 +6485,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6381
6485
|
* @param {*} [options] Override http request option.
|
|
6382
6486
|
* @throws {RequiredError}
|
|
6383
6487
|
*/
|
|
6384
|
-
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
6488
|
+
listIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<IOValue[], any, {}>>;
|
|
6385
6489
|
/**
|
|
6386
6490
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
6387
6491
|
* @summary Set Output Values
|
|
@@ -6391,7 +6495,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6391
6495
|
* @param {*} [options] Override http request option.
|
|
6392
6496
|
* @throws {RequiredError}
|
|
6393
6497
|
*/
|
|
6394
|
-
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
6498
|
+
setOutputValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
6395
6499
|
/**
|
|
6396
6500
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: success --> > Websocket endpoint Continuously receive updates of input/output values via websocket. Updates are sent in the update rate of the controller. > **NOTE** > > If you request many values simultaneously, the request is likely to fail. The amount of values that can be streamed simultaneously depends on the specific robot controller. > **NOTE** > > The inputs and outputs are sent in the update rate of the controller to prevent losing any values. This can lead to a high amount of data transmitted.
|
|
6397
6501
|
* @summary Stream Input/Output Values
|
|
@@ -6401,7 +6505,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6401
6505
|
* @param {*} [options] Override http request option.
|
|
6402
6506
|
* @throws {RequiredError}
|
|
6403
6507
|
*/
|
|
6404
|
-
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
6508
|
+
streamIOValues(cell: string, controller: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<StreamIOValuesResponse, any, {}>>;
|
|
6405
6509
|
/**
|
|
6406
6510
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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 ```
|
|
6407
6511
|
* @summary Wait For
|
|
@@ -6411,7 +6515,7 @@ declare class ControllerInputsOutputsApi extends BaseAPI {
|
|
|
6411
6515
|
* @param {*} [options] Override http request option.
|
|
6412
6516
|
* @throws {RequiredError}
|
|
6413
6517
|
*/
|
|
6414
|
-
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6518
|
+
waitForIOEvent(cell: string, controller: string, waitForIOEventRequest: WaitForIOEventRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<boolean, any, {}>>;
|
|
6415
6519
|
}
|
|
6416
6520
|
/**
|
|
6417
6521
|
* JoggingApi - axios parameter creator
|
|
@@ -6471,7 +6575,7 @@ declare class JoggingApi extends BaseAPI {
|
|
|
6471
6575
|
* @param {*} [options] Override http request option.
|
|
6472
6576
|
* @throws {RequiredError}
|
|
6473
6577
|
*/
|
|
6474
|
-
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6578
|
+
executeJogging(cell: string, controller: string, executeJoggingRequest: ExecuteJoggingRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ExecuteJoggingResponse, any, {}>>;
|
|
6475
6579
|
}
|
|
6476
6580
|
/**
|
|
6477
6581
|
* KinematicsApi - axios parameter creator
|
|
@@ -6495,6 +6599,15 @@ declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
6495
6599
|
* @throws {RequiredError}
|
|
6496
6600
|
*/
|
|
6497
6601
|
inverseKinematics: (cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6602
|
+
/**
|
|
6603
|
+
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ <!-- theme: danger --> > **Experimental** Returns the projected joint position that satisfies the direction constraint for a given target joint position. This may alter the TCP pose. To project the cartesian pose instead, use the following code snippet: ```python import numpy as np from scipy.spatial.transform import Rotation as R def project_cartesian_pose_direction_constraint(T_world_tcp: models.Pose, constraint: models.DirectionConstraint) -> models.Pose: constraint_tcp = np.array(constraint.tcp) target_constraint_world = np.array(constraint.world) R_world_tcp = R.from_rotvec(T_world_tcp.orientation.root) current_constraint_world = R_world_tcp.apply(constraint_tcp) R_corr, _ = R.align_vectors([target_constraint_world], [current_constraint_world]) R_world_tcp_new = R_corr * R_world_tcp return models.Pose(position=T_world_tcp.position, orientation=R_world_tcp_new.as_rotvec()) ```
|
|
6604
|
+
* @summary Project joint position to direction constraint
|
|
6605
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6606
|
+
* @param {ProjectJointPositionDirectionConstraintRequest} projectJointPositionDirectionConstraintRequest
|
|
6607
|
+
* @param {*} [options] Override http request option.
|
|
6608
|
+
* @throws {RequiredError}
|
|
6609
|
+
*/
|
|
6610
|
+
projectJointPositionDirectionConstraint: (cell: string, projectJointPositionDirectionConstraintRequest: ProjectJointPositionDirectionConstraintRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6498
6611
|
};
|
|
6499
6612
|
/**
|
|
6500
6613
|
* KinematicsApi - functional programming interface
|
|
@@ -6518,6 +6631,15 @@ declare const KinematicsApiFp: (configuration?: Configuration) => {
|
|
|
6518
6631
|
* @throws {RequiredError}
|
|
6519
6632
|
*/
|
|
6520
6633
|
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>>;
|
|
6634
|
+
/**
|
|
6635
|
+
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ <!-- theme: danger --> > **Experimental** Returns the projected joint position that satisfies the direction constraint for a given target joint position. This may alter the TCP pose. To project the cartesian pose instead, use the following code snippet: ```python import numpy as np from scipy.spatial.transform import Rotation as R def project_cartesian_pose_direction_constraint(T_world_tcp: models.Pose, constraint: models.DirectionConstraint) -> models.Pose: constraint_tcp = np.array(constraint.tcp) target_constraint_world = np.array(constraint.world) R_world_tcp = R.from_rotvec(T_world_tcp.orientation.root) current_constraint_world = R_world_tcp.apply(constraint_tcp) R_corr, _ = R.align_vectors([target_constraint_world], [current_constraint_world]) R_world_tcp_new = R_corr * R_world_tcp return models.Pose(position=T_world_tcp.position, orientation=R_world_tcp_new.as_rotvec()) ```
|
|
6636
|
+
* @summary Project joint position to direction constraint
|
|
6637
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6638
|
+
* @param {ProjectJointPositionDirectionConstraintRequest} projectJointPositionDirectionConstraintRequest
|
|
6639
|
+
* @param {*} [options] Override http request option.
|
|
6640
|
+
* @throws {RequiredError}
|
|
6641
|
+
*/
|
|
6642
|
+
projectJointPositionDirectionConstraint(cell: string, projectJointPositionDirectionConstraintRequest: ProjectJointPositionDirectionConstraintRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectJointPositionDirectionConstraintResponse>>;
|
|
6521
6643
|
};
|
|
6522
6644
|
/**
|
|
6523
6645
|
* KinematicsApi - factory interface
|
|
@@ -6541,6 +6663,15 @@ declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
6541
6663
|
* @throws {RequiredError}
|
|
6542
6664
|
*/
|
|
6543
6665
|
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse>;
|
|
6666
|
+
/**
|
|
6667
|
+
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ <!-- theme: danger --> > **Experimental** Returns the projected joint position that satisfies the direction constraint for a given target joint position. This may alter the TCP pose. To project the cartesian pose instead, use the following code snippet: ```python import numpy as np from scipy.spatial.transform import Rotation as R def project_cartesian_pose_direction_constraint(T_world_tcp: models.Pose, constraint: models.DirectionConstraint) -> models.Pose: constraint_tcp = np.array(constraint.tcp) target_constraint_world = np.array(constraint.world) R_world_tcp = R.from_rotvec(T_world_tcp.orientation.root) current_constraint_world = R_world_tcp.apply(constraint_tcp) R_corr, _ = R.align_vectors([target_constraint_world], [current_constraint_world]) R_world_tcp_new = R_corr * R_world_tcp return models.Pose(position=T_world_tcp.position, orientation=R_world_tcp_new.as_rotvec()) ```
|
|
6668
|
+
* @summary Project joint position to direction constraint
|
|
6669
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6670
|
+
* @param {ProjectJointPositionDirectionConstraintRequest} projectJointPositionDirectionConstraintRequest
|
|
6671
|
+
* @param {*} [options] Override http request option.
|
|
6672
|
+
* @throws {RequiredError}
|
|
6673
|
+
*/
|
|
6674
|
+
projectJointPositionDirectionConstraint(cell: string, projectJointPositionDirectionConstraintRequest: ProjectJointPositionDirectionConstraintRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectJointPositionDirectionConstraintResponse>;
|
|
6544
6675
|
};
|
|
6545
6676
|
/**
|
|
6546
6677
|
* KinematicsApi - object-oriented interface
|
|
@@ -6554,7 +6685,7 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
6554
6685
|
* @param {*} [options] Override http request option.
|
|
6555
6686
|
* @throws {RequiredError}
|
|
6556
6687
|
*/
|
|
6557
|
-
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6688
|
+
forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ForwardKinematicsResponse, any, {}>>;
|
|
6558
6689
|
/**
|
|
6559
6690
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ Returns the reachable joint positions for a list of given poses.
|
|
6560
6691
|
* @summary Inverse kinematics
|
|
@@ -6563,7 +6694,16 @@ declare class KinematicsApi extends BaseAPI {
|
|
|
6563
6694
|
* @param {*} [options] Override http request option.
|
|
6564
6695
|
* @throws {RequiredError}
|
|
6565
6696
|
*/
|
|
6566
|
-
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6697
|
+
inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<InverseKinematicsResponse, any, {}>>;
|
|
6698
|
+
/**
|
|
6699
|
+
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ <!-- theme: danger --> > **Experimental** Returns the projected joint position that satisfies the direction constraint for a given target joint position. This may alter the TCP pose. To project the cartesian pose instead, use the following code snippet: ```python import numpy as np from scipy.spatial.transform import Rotation as R def project_cartesian_pose_direction_constraint(T_world_tcp: models.Pose, constraint: models.DirectionConstraint) -> models.Pose: constraint_tcp = np.array(constraint.tcp) target_constraint_world = np.array(constraint.world) R_world_tcp = R.from_rotvec(T_world_tcp.orientation.root) current_constraint_world = R_world_tcp.apply(constraint_tcp) R_corr, _ = R.align_vectors([target_constraint_world], [current_constraint_world]) R_world_tcp_new = R_corr * R_world_tcp return models.Pose(position=T_world_tcp.position, orientation=R_world_tcp_new.as_rotvec()) ```
|
|
6700
|
+
* @summary Project joint position to direction constraint
|
|
6701
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6702
|
+
* @param {ProjectJointPositionDirectionConstraintRequest} projectJointPositionDirectionConstraintRequest
|
|
6703
|
+
* @param {*} [options] Override http request option.
|
|
6704
|
+
* @throws {RequiredError}
|
|
6705
|
+
*/
|
|
6706
|
+
projectJointPositionDirectionConstraint(cell: string, projectJointPositionDirectionConstraintRequest: ProjectJointPositionDirectionConstraintRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ProjectJointPositionDirectionConstraintResponse, any, {}>>;
|
|
6567
6707
|
}
|
|
6568
6708
|
/**
|
|
6569
6709
|
* LicenseApi - axios parameter creator
|
|
@@ -6678,28 +6818,28 @@ declare class LicenseApi extends BaseAPI {
|
|
|
6678
6818
|
* @param {*} [options] Override http request option.
|
|
6679
6819
|
* @throws {RequiredError}
|
|
6680
6820
|
*/
|
|
6681
|
-
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<
|
|
6821
|
+
activateLicense(activateLicenseRequest: ActivateLicenseRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<License, any, {}>>;
|
|
6682
6822
|
/**
|
|
6683
6823
|
* **Required permissions:** `can_manage_license` - Manage license configuration ___ Deactivates active license.
|
|
6684
6824
|
* @summary Deactivate license
|
|
6685
6825
|
* @param {*} [options] Override http request option.
|
|
6686
6826
|
* @throws {RequiredError}
|
|
6687
6827
|
*/
|
|
6688
|
-
deactivateLicense(options?: RawAxiosRequestConfig): Promise<
|
|
6828
|
+
deactivateLicense(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
6689
6829
|
/**
|
|
6690
6830
|
* **Required permissions:** `can_manage_license` - Manage license configuration ___ Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
|
|
6691
6831
|
* @summary Get license
|
|
6692
6832
|
* @param {*} [options] Override http request option.
|
|
6693
6833
|
* @throws {RequiredError}
|
|
6694
6834
|
*/
|
|
6695
|
-
getLicense(options?: RawAxiosRequestConfig): Promise<
|
|
6835
|
+
getLicense(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<License, any, {}>>;
|
|
6696
6836
|
/**
|
|
6697
6837
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Get the license status. - If `valid`, Wandelbots NOVA can be used. - If `expired`, the license has to be renewed in order to use Wandelbots NOVA.
|
|
6698
6838
|
* @summary Get license status
|
|
6699
6839
|
* @param {*} [options] Override http request option.
|
|
6700
6840
|
* @throws {RequiredError}
|
|
6701
6841
|
*/
|
|
6702
|
-
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<
|
|
6842
|
+
getLicenseStatus(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<LicenseStatus, any, {}>>;
|
|
6703
6843
|
}
|
|
6704
6844
|
/**
|
|
6705
6845
|
* MotionGroupApi - axios parameter creator
|
|
@@ -6829,7 +6969,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
6829
6969
|
* @param {*} [options] Override http request option.
|
|
6830
6970
|
* @throws {RequiredError}
|
|
6831
6971
|
*/
|
|
6832
|
-
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
6972
|
+
getCurrentMotionGroupState(cell: string, controller: string, motionGroup: string, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<MotionGroupState, any, {}>>;
|
|
6833
6973
|
/**
|
|
6834
6974
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data can change upon connection to the robot.
|
|
6835
6975
|
* @summary Description
|
|
@@ -6839,7 +6979,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
6839
6979
|
* @param {*} [options] Override http request option.
|
|
6840
6980
|
* @throws {RequiredError}
|
|
6841
6981
|
*/
|
|
6842
|
-
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
6982
|
+
getMotionGroupDescription(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<MotionGroupDescription, any, {}>>;
|
|
6843
6983
|
/**
|
|
6844
6984
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ <!-- theme: success --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
6845
6985
|
* @summary Stream State
|
|
@@ -6851,7 +6991,7 @@ declare class MotionGroupApi extends BaseAPI {
|
|
|
6851
6991
|
* @param {*} [options] Override http request option.
|
|
6852
6992
|
* @throws {RequiredError}
|
|
6853
6993
|
*/
|
|
6854
|
-
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<
|
|
6994
|
+
streamMotionGroupState(cell: string, controller: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<MotionGroupState, any, {}>>;
|
|
6855
6995
|
}
|
|
6856
6996
|
/**
|
|
6857
6997
|
* MotionGroupModelsApi - axios parameter creator
|
|
@@ -7000,9 +7140,9 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7000
7140
|
* @param {*} [options] Override http request option.
|
|
7001
7141
|
* @throws {RequiredError}
|
|
7002
7142
|
*/
|
|
7003
|
-
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
7143
|
+
getMotionGroupCollisionModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
7004
7144
|
[key: string]: Collider;
|
|
7005
|
-
}[], any>>;
|
|
7145
|
+
}[], any, {}>>;
|
|
7006
7146
|
/**
|
|
7007
7147
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the GLB asset for the specified motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported identifiers.
|
|
7008
7148
|
* @summary Download GLB Model
|
|
@@ -7010,7 +7150,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7010
7150
|
* @param {*} [options] Override http request option.
|
|
7011
7151
|
* @throws {RequiredError}
|
|
7012
7152
|
*/
|
|
7013
|
-
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
7153
|
+
getMotionGroupGlbModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<File, any, {}>>;
|
|
7014
7154
|
/**
|
|
7015
7155
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the kinematics model (DH parameters) for the given motion group model. See [getMotionGroupModels](#/operations/getMotionGroupModels) for supported motion group models.
|
|
7016
7156
|
* @summary Get Kinematics
|
|
@@ -7018,14 +7158,14 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7018
7158
|
* @param {*} [options] Override http request option.
|
|
7019
7159
|
* @throws {RequiredError}
|
|
7020
7160
|
*/
|
|
7021
|
-
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
7161
|
+
getMotionGroupKinematicModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<KinematicModel, any, {}>>;
|
|
7022
7162
|
/**
|
|
7023
7163
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the list of supported motion group models.
|
|
7024
7164
|
* @summary Motion Group Models
|
|
7025
7165
|
* @param {*} [options] Override http request option.
|
|
7026
7166
|
* @throws {RequiredError}
|
|
7027
7167
|
*/
|
|
7028
|
-
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<
|
|
7168
|
+
getMotionGroupModels(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
7029
7169
|
/**
|
|
7030
7170
|
* **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.
|
|
7031
7171
|
* @summary Download USD Model
|
|
@@ -7033,7 +7173,7 @@ declare class MotionGroupModelsApi extends BaseAPI {
|
|
|
7033
7173
|
* @param {*} [options] Override http request option.
|
|
7034
7174
|
* @throws {RequiredError}
|
|
7035
7175
|
*/
|
|
7036
|
-
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<
|
|
7176
|
+
getMotionGroupUsdModel(motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<File, any, {}>>;
|
|
7037
7177
|
}
|
|
7038
7178
|
/**
|
|
7039
7179
|
* NOVACloudApi - axios parameter creator
|
|
@@ -7134,7 +7274,7 @@ declare class NOVACloudApi extends BaseAPI {
|
|
|
7134
7274
|
* @param {*} [options] Override http request option.
|
|
7135
7275
|
* @throws {RequiredError}
|
|
7136
7276
|
*/
|
|
7137
|
-
connectToNovaCloud(completionTimeout?: number, cloudConnectionRequest?: CloudConnectionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7277
|
+
connectToNovaCloud(completionTimeout?: number, cloudConnectionRequest?: CloudConnectionRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CloudRegistrationSuccessResponse, any, {}>>;
|
|
7138
7278
|
/**
|
|
7139
7279
|
* **Required permissions:** `can_manage_cloud_connection` - Manage NOVA Cloud connection ___ <!-- theme: danger --> > **Experimental** Disconnects this instance from NOVA Cloud and removes the local NATS leafnode configuration.
|
|
7140
7280
|
* @summary Disconnect from NOVA Cloud
|
|
@@ -7142,14 +7282,14 @@ declare class NOVACloudApi extends BaseAPI {
|
|
|
7142
7282
|
* @param {*} [options] Override http request option.
|
|
7143
7283
|
* @throws {RequiredError}
|
|
7144
7284
|
*/
|
|
7145
|
-
disconnectFromNovaCloud(completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
7285
|
+
disconnectFromNovaCloud(completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CloudDisconnectionStatusDisconnected, any, {}>>;
|
|
7146
7286
|
/**
|
|
7147
7287
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Get the current NOVA Cloud connection config for this instance.
|
|
7148
7288
|
* @summary Get Connection Config
|
|
7149
7289
|
* @param {*} [options] Override http request option.
|
|
7150
7290
|
* @throws {RequiredError}
|
|
7151
7291
|
*/
|
|
7152
|
-
getNovaCloudConfig(options?: RawAxiosRequestConfig): Promise<
|
|
7292
|
+
getNovaCloudConfig(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CloudConfigStatus, any, {}>>;
|
|
7153
7293
|
}
|
|
7154
7294
|
/**
|
|
7155
7295
|
* ProgramApi - axios parameter creator
|
|
@@ -7286,7 +7426,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
7286
7426
|
* @param {*} [options] Override http request option.
|
|
7287
7427
|
* @throws {RequiredError}
|
|
7288
7428
|
*/
|
|
7289
|
-
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
7429
|
+
getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<Program, any, {}>>;
|
|
7290
7430
|
/**
|
|
7291
7431
|
* **Required permissions:** `can_operate_programs` - Execute and monitor programs ___ <!-- theme: danger --> > **Experimental** List details of all existing programs.
|
|
7292
7432
|
* @summary List programs
|
|
@@ -7294,7 +7434,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
7294
7434
|
* @param {*} [options] Override http request option.
|
|
7295
7435
|
* @throws {RequiredError}
|
|
7296
7436
|
*/
|
|
7297
|
-
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
7437
|
+
listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<Program[], any, {}>>;
|
|
7298
7438
|
/**
|
|
7299
7439
|
* **Required permissions:** `can_operate_programs` - Execute and monitor programs ___ <!-- theme: danger --> > **Experimental** This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
7300
7440
|
* @summary Start the program
|
|
@@ -7304,7 +7444,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
7304
7444
|
* @param {*} [options] Override http request option.
|
|
7305
7445
|
* @throws {RequiredError}
|
|
7306
7446
|
*/
|
|
7307
|
-
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7447
|
+
startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ProgramRun, any, {}>>;
|
|
7308
7448
|
/**
|
|
7309
7449
|
* **Required permissions:** `can_operate_programs` - Execute and monitor programs ___ <!-- theme: danger --> > **Experimental** Stop a specific program run.
|
|
7310
7450
|
* @summary Stop program run
|
|
@@ -7313,7 +7453,7 @@ declare class ProgramApi extends BaseAPI {
|
|
|
7313
7453
|
* @param {*} [options] Override http request option.
|
|
7314
7454
|
* @throws {RequiredError}
|
|
7315
7455
|
*/
|
|
7316
|
-
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<
|
|
7456
|
+
stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
7317
7457
|
}
|
|
7318
7458
|
/**
|
|
7319
7459
|
* RobotConfigurationsApi - axios parameter creator
|
|
@@ -7386,14 +7526,62 @@ declare class RobotConfigurationsApi extends BaseAPI {
|
|
|
7386
7526
|
* @param {*} [options] Override http request option.
|
|
7387
7527
|
* @throws {RequiredError}
|
|
7388
7528
|
*/
|
|
7389
|
-
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<
|
|
7529
|
+
getControllerConfigFromArpScan(robotControllerConfigurationRequest: RobotControllerConfigurationRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<RobotController[], any, {}>>;
|
|
7390
7530
|
/**
|
|
7391
7531
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns the identifiers of available robot configurations. A robot configuration represents a robot controller with one or more attached motion groups.
|
|
7392
7532
|
* @summary List Robot Configurations
|
|
7393
7533
|
* @param {*} [options] Override http request option.
|
|
7394
7534
|
* @throws {RequiredError}
|
|
7395
7535
|
*/
|
|
7396
|
-
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<
|
|
7536
|
+
getRobotConfigurations(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
7537
|
+
}
|
|
7538
|
+
/**
|
|
7539
|
+
* SessionApi - axios parameter creator
|
|
7540
|
+
*/
|
|
7541
|
+
declare const SessionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7542
|
+
/**
|
|
7543
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns - session metadata, - user identity, - capabilities, and - token lifetime. When authentication and authorization are configured, the response reflects the currently authenticated user. On unmanaged instances (no authentication and authorization is configured), a default anonymous session is returned with empty user fields, no capabilities, and zero-value timestamps.
|
|
7544
|
+
* @summary Get current user session information
|
|
7545
|
+
* @param {*} [options] Override http request option.
|
|
7546
|
+
* @throws {RequiredError}
|
|
7547
|
+
*/
|
|
7548
|
+
getSession: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
7549
|
+
};
|
|
7550
|
+
/**
|
|
7551
|
+
* SessionApi - functional programming interface
|
|
7552
|
+
*/
|
|
7553
|
+
declare const SessionApiFp: (configuration?: Configuration) => {
|
|
7554
|
+
/**
|
|
7555
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns - session metadata, - user identity, - capabilities, and - token lifetime. When authentication and authorization are configured, the response reflects the currently authenticated user. On unmanaged instances (no authentication and authorization is configured), a default anonymous session is returned with empty user fields, no capabilities, and zero-value timestamps.
|
|
7556
|
+
* @summary Get current user session information
|
|
7557
|
+
* @param {*} [options] Override http request option.
|
|
7558
|
+
* @throws {RequiredError}
|
|
7559
|
+
*/
|
|
7560
|
+
getSession(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SessionResponse>>;
|
|
7561
|
+
};
|
|
7562
|
+
/**
|
|
7563
|
+
* SessionApi - factory interface
|
|
7564
|
+
*/
|
|
7565
|
+
declare const SessionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7566
|
+
/**
|
|
7567
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns - session metadata, - user identity, - capabilities, and - token lifetime. When authentication and authorization are configured, the response reflects the currently authenticated user. On unmanaged instances (no authentication and authorization is configured), a default anonymous session is returned with empty user fields, no capabilities, and zero-value timestamps.
|
|
7568
|
+
* @summary Get current user session information
|
|
7569
|
+
* @param {*} [options] Override http request option.
|
|
7570
|
+
* @throws {RequiredError}
|
|
7571
|
+
*/
|
|
7572
|
+
getSession(options?: RawAxiosRequestConfig): AxiosPromise<SessionResponse>;
|
|
7573
|
+
};
|
|
7574
|
+
/**
|
|
7575
|
+
* SessionApi - object-oriented interface
|
|
7576
|
+
*/
|
|
7577
|
+
declare class SessionApi extends BaseAPI {
|
|
7578
|
+
/**
|
|
7579
|
+
* **Required permissions:** `can_access_system` - View system status and metadata ___ Returns - session metadata, - user identity, - capabilities, and - token lifetime. When authentication and authorization are configured, the response reflects the currently authenticated user. On unmanaged instances (no authentication and authorization is configured), a default anonymous session is returned with empty user fields, no capabilities, and zero-value timestamps.
|
|
7580
|
+
* @summary Get current user session information
|
|
7581
|
+
* @param {*} [options] Override http request option.
|
|
7582
|
+
* @throws {RequiredError}
|
|
7583
|
+
*/
|
|
7584
|
+
getSession(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<SessionResponse, any, {}>>;
|
|
7397
7585
|
}
|
|
7398
7586
|
/**
|
|
7399
7587
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
@@ -7866,7 +8054,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7866
8054
|
* @param {*} [options] Override http request option.
|
|
7867
8055
|
* @throws {RequiredError}
|
|
7868
8056
|
*/
|
|
7869
|
-
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
8057
|
+
deleteStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
7870
8058
|
/**
|
|
7871
8059
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Deletes the stored link chain. <!-- theme: danger --> > This will delete persistently stored data.
|
|
7872
8060
|
* @summary Delete Link Chain
|
|
@@ -7875,7 +8063,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7875
8063
|
* @param {*} [options] Override http request option.
|
|
7876
8064
|
* @throws {RequiredError}
|
|
7877
8065
|
*/
|
|
7878
|
-
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
8066
|
+
deleteStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
7879
8067
|
/**
|
|
7880
8068
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Deletes the stored tool. <!-- theme: danger --> > This will delete persistently stored data.
|
|
7881
8069
|
* @summary Delete Tool
|
|
@@ -7884,7 +8072,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7884
8072
|
* @param {*} [options] Override http request option.
|
|
7885
8073
|
* @throws {RequiredError}
|
|
7886
8074
|
*/
|
|
7887
|
-
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
8075
|
+
deleteStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
7888
8076
|
/**
|
|
7889
8077
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the collider.
|
|
7890
8078
|
* @summary Get Collider
|
|
@@ -7893,7 +8081,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7893
8081
|
* @param {*} [options] Override http request option.
|
|
7894
8082
|
* @throws {RequiredError}
|
|
7895
8083
|
*/
|
|
7896
|
-
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<
|
|
8084
|
+
getStoredCollider(cell: string, collider: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<Collider, any, {}>>;
|
|
7897
8085
|
/**
|
|
7898
8086
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the collision link chain.
|
|
7899
8087
|
* @summary Get Link Chain
|
|
@@ -7902,9 +8090,9 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7902
8090
|
* @param {*} [options] Override http request option.
|
|
7903
8091
|
* @throws {RequiredError}
|
|
7904
8092
|
*/
|
|
7905
|
-
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<
|
|
8093
|
+
getStoredCollisionLinkChain(cell: string, linkChain: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
7906
8094
|
[key: string]: Collider;
|
|
7907
|
-
}[], any>>;
|
|
8095
|
+
}[], any, {}>>;
|
|
7908
8096
|
/**
|
|
7909
8097
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the stored tool.
|
|
7910
8098
|
* @summary Get Tool
|
|
@@ -7913,9 +8101,9 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7913
8101
|
* @param {*} [options] Override http request option.
|
|
7914
8102
|
* @throws {RequiredError}
|
|
7915
8103
|
*/
|
|
7916
|
-
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<
|
|
8104
|
+
getStoredCollisionTool(cell: string, tool: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
7917
8105
|
[key: string]: Collider;
|
|
7918
|
-
}, any>>;
|
|
8106
|
+
}, any, {}>>;
|
|
7919
8107
|
/**
|
|
7920
8108
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the stored link chains.
|
|
7921
8109
|
* @summary List Link Chains
|
|
@@ -7923,11 +8111,11 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7923
8111
|
* @param {*} [options] Override http request option.
|
|
7924
8112
|
* @throws {RequiredError}
|
|
7925
8113
|
*/
|
|
7926
|
-
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8114
|
+
listCollisionLinkChains(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
7927
8115
|
[key: string]: {
|
|
7928
8116
|
[key: string]: Collider;
|
|
7929
8117
|
}[];
|
|
7930
|
-
}, any>>;
|
|
8118
|
+
}, any, {}>>;
|
|
7931
8119
|
/**
|
|
7932
8120
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns a list of keys for stored link chains.
|
|
7933
8121
|
* @summary List Link Chain Keys
|
|
@@ -7935,7 +8123,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7935
8123
|
* @param {*} [options] Override http request option.
|
|
7936
8124
|
* @throws {RequiredError}
|
|
7937
8125
|
*/
|
|
7938
|
-
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8126
|
+
listCollisionLinkChainsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
7939
8127
|
/**
|
|
7940
8128
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns all stored colliders.
|
|
7941
8129
|
* @summary List Colliders
|
|
@@ -7943,9 +8131,9 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7943
8131
|
* @param {*} [options] Override http request option.
|
|
7944
8132
|
* @throws {RequiredError}
|
|
7945
8133
|
*/
|
|
7946
|
-
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8134
|
+
listStoredColliders(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
7947
8135
|
[key: string]: Collider;
|
|
7948
|
-
}, any>>;
|
|
8136
|
+
}, any, {}>>;
|
|
7949
8137
|
/**
|
|
7950
8138
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns a list of keys for stored colliders.
|
|
7951
8139
|
* @summary List Collider Keys
|
|
@@ -7953,7 +8141,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7953
8141
|
* @param {*} [options] Override http request option.
|
|
7954
8142
|
* @throws {RequiredError}
|
|
7955
8143
|
*/
|
|
7956
|
-
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8144
|
+
listStoredCollidersKeys(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
7957
8145
|
/**
|
|
7958
8146
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the list of stored tools.
|
|
7959
8147
|
* @summary List Tools
|
|
@@ -7961,11 +8149,11 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7961
8149
|
* @param {*} [options] Override http request option.
|
|
7962
8150
|
* @throws {RequiredError}
|
|
7963
8151
|
*/
|
|
7964
|
-
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8152
|
+
listStoredCollisionTools(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
7965
8153
|
[key: string]: {
|
|
7966
8154
|
[key: string]: Collider;
|
|
7967
8155
|
};
|
|
7968
|
-
}, any>>;
|
|
8156
|
+
}, any, {}>>;
|
|
7969
8157
|
/**
|
|
7970
8158
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns a list of keys for stored tools.
|
|
7971
8159
|
* @summary List Tool Keys
|
|
@@ -7973,7 +8161,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7973
8161
|
* @param {*} [options] Override http request option.
|
|
7974
8162
|
* @throws {RequiredError}
|
|
7975
8163
|
*/
|
|
7976
|
-
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8164
|
+
listStoredCollisionToolsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
7977
8165
|
/**
|
|
7978
8166
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Stores collider. - If the collider does not exist, it will be created. - If the collider exists, it will be updated.
|
|
7979
8167
|
* @summary Store Collider
|
|
@@ -7983,7 +8171,7 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7983
8171
|
* @param {*} [options] Override http request option.
|
|
7984
8172
|
* @throws {RequiredError}
|
|
7985
8173
|
*/
|
|
7986
|
-
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<
|
|
8174
|
+
storeCollider(cell: string, collider: string, collider2: Collider, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<Collider, any, {}>>;
|
|
7987
8175
|
/**
|
|
7988
8176
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Stores link chain. - If the link chain does not exist, it will be created. - If the link chain exists, it will be updated.
|
|
7989
8177
|
* @summary Store Link Chain
|
|
@@ -7995,9 +8183,9 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
7995
8183
|
*/
|
|
7996
8184
|
storeCollisionLinkChain(cell: string, linkChain: string, collider: Array<{
|
|
7997
8185
|
[key: string]: Collider;
|
|
7998
|
-
}>, options?: RawAxiosRequestConfig): Promise<
|
|
8186
|
+
}>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
7999
8187
|
[key: string]: Collider;
|
|
8000
|
-
}[], any>>;
|
|
8188
|
+
}[], any, {}>>;
|
|
8001
8189
|
/**
|
|
8002
8190
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Stores the tool. - If the tool does not exist, it will be created. - If the tool exists, it will be updated.
|
|
8003
8191
|
* @summary Store Tool
|
|
@@ -8009,9 +8197,9 @@ declare class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
8009
8197
|
*/
|
|
8010
8198
|
storeCollisionTool(cell: string, tool: string, requestBody: {
|
|
8011
8199
|
[key: string]: Collider;
|
|
8012
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
8200
|
+
}, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
8013
8201
|
[key: string]: Collider;
|
|
8014
|
-
}, any>>;
|
|
8202
|
+
}, any, {}>>;
|
|
8015
8203
|
}
|
|
8016
8204
|
/**
|
|
8017
8205
|
* StoreCollisionSetupsApi - axios parameter creator
|
|
@@ -8176,7 +8364,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8176
8364
|
* @param {*} [options] Override http request option.
|
|
8177
8365
|
* @throws {RequiredError}
|
|
8178
8366
|
*/
|
|
8179
|
-
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8367
|
+
deleteStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
8180
8368
|
/**
|
|
8181
8369
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns the stored collision setup.
|
|
8182
8370
|
* @summary Get Collision Setup
|
|
@@ -8185,7 +8373,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8185
8373
|
* @param {*} [options] Override http request option.
|
|
8186
8374
|
* @throws {RequiredError}
|
|
8187
8375
|
*/
|
|
8188
|
-
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<
|
|
8376
|
+
getStoredCollisionSetup(cell: string, setup: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CollisionSetup, any, {}>>;
|
|
8189
8377
|
/**
|
|
8190
8378
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns a list of stored collision setups.
|
|
8191
8379
|
* @summary List Collision Setups
|
|
@@ -8193,9 +8381,9 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8193
8381
|
* @param {*} [options] Override http request option.
|
|
8194
8382
|
* @throws {RequiredError}
|
|
8195
8383
|
*/
|
|
8196
|
-
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8384
|
+
listStoredCollisionSetups(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<{
|
|
8197
8385
|
[key: string]: CollisionSetup;
|
|
8198
|
-
}, any>>;
|
|
8386
|
+
}, any, {}>>;
|
|
8199
8387
|
/**
|
|
8200
8388
|
* **Required permissions:** `can_read_collision_world` - Read collision models and scenes ___ Returns a list of keys for stored collision setups.
|
|
8201
8389
|
* @summary List Collision Setup Keys
|
|
@@ -8203,7 +8391,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8203
8391
|
* @param {*} [options] Override http request option.
|
|
8204
8392
|
* @throws {RequiredError}
|
|
8205
8393
|
*/
|
|
8206
|
-
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8394
|
+
listStoredCollisionSetupsKeys(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
8207
8395
|
/**
|
|
8208
8396
|
* **Required permissions:** `can_write_collision_world` - Write collision models and scenes ___ Stores collision setup. - If the collision setup does not exist, it will be created. - If the collision setup exists, it will be updated.
|
|
8209
8397
|
* @summary Store Collision Setup
|
|
@@ -8213,7 +8401,7 @@ declare class StoreCollisionSetupsApi extends BaseAPI {
|
|
|
8213
8401
|
* @param {*} [options] Override http request option.
|
|
8214
8402
|
* @throws {RequiredError}
|
|
8215
8403
|
*/
|
|
8216
|
-
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<
|
|
8404
|
+
storeCollisionSetup(cell: string, setup: string, collisionSetup: CollisionSetup, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CollisionSetup, any, {}>>;
|
|
8217
8405
|
}
|
|
8218
8406
|
/**
|
|
8219
8407
|
* StoreObjectApi - axios parameter creator
|
|
@@ -8409,7 +8597,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8409
8597
|
* @param {*} [options] Override http request option.
|
|
8410
8598
|
* @throws {RequiredError}
|
|
8411
8599
|
*/
|
|
8412
|
-
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8600
|
+
clearAllObjects(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
8413
8601
|
/**
|
|
8414
8602
|
* **Required permissions:** `can_write_objects` - Write stored objects ___ Delete an object <!-- theme: danger --> > This will delete persistently stored data.
|
|
8415
8603
|
* @summary Delete Object
|
|
@@ -8418,7 +8606,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8418
8606
|
* @param {*} [options] Override http request option.
|
|
8419
8607
|
* @throws {RequiredError}
|
|
8420
8608
|
*/
|
|
8421
|
-
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
8609
|
+
deleteObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
8422
8610
|
/**
|
|
8423
8611
|
* **Required permissions:** `can_read_objects` - Read stored objects ___ Returns content and metadata of a stored object.
|
|
8424
8612
|
* @summary Get Object
|
|
@@ -8427,7 +8615,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8427
8615
|
* @param {*} [options] Override http request option.
|
|
8428
8616
|
* @throws {RequiredError}
|
|
8429
8617
|
*/
|
|
8430
|
-
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
8618
|
+
getObject(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<File, any, {}>>;
|
|
8431
8619
|
/**
|
|
8432
8620
|
* **Required permissions:** `can_read_objects` - Read stored objects ___ Returns metadata. Object content is not returned.
|
|
8433
8621
|
* @summary Get Object Metadata
|
|
@@ -8436,7 +8624,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8436
8624
|
* @param {*} [options] Override http request option.
|
|
8437
8625
|
* @throws {RequiredError}
|
|
8438
8626
|
*/
|
|
8439
|
-
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<
|
|
8627
|
+
getObjectMetadata(cell: string, key: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
8440
8628
|
/**
|
|
8441
8629
|
* **Required permissions:** `can_read_objects` - Read stored objects ___ List the keys for all objects.
|
|
8442
8630
|
* @summary List all Object Keys
|
|
@@ -8444,7 +8632,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8444
8632
|
* @param {*} [options] Override http request option.
|
|
8445
8633
|
* @throws {RequiredError}
|
|
8446
8634
|
*/
|
|
8447
|
-
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<
|
|
8635
|
+
listAllObjectKeys(cell: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string[], any, {}>>;
|
|
8448
8636
|
/**
|
|
8449
8637
|
* **Required permissions:** `can_write_objects` - Write stored objects ___ 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.
|
|
8450
8638
|
* @summary Store Object
|
|
@@ -8457,7 +8645,7 @@ declare class StoreObjectApi extends BaseAPI {
|
|
|
8457
8645
|
*/
|
|
8458
8646
|
storeObject(cell: string, key: string, xMetadata?: {
|
|
8459
8647
|
[key: string]: string;
|
|
8460
|
-
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<
|
|
8648
|
+
}, anyValue?: any, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
8461
8649
|
}
|
|
8462
8650
|
/**
|
|
8463
8651
|
* SystemApi - axios parameter creator
|
|
@@ -8776,7 +8964,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8776
8964
|
*/
|
|
8777
8965
|
backupConfiguration(resources?: Array<string>, metadata?: {
|
|
8778
8966
|
[key: string]: string;
|
|
8779
|
-
}, options?: RawAxiosRequestConfig): Promise<
|
|
8967
|
+
}, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<File, any, {}>>;
|
|
8780
8968
|
/**
|
|
8781
8969
|
* **Required permissions:** `can_update_system` - Update system versions and services ___ Check if a more recent Wandelbots NOVA Version is available.
|
|
8782
8970
|
* @summary Check update
|
|
@@ -8784,7 +8972,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8784
8972
|
* @param {*} [options] Override http request option.
|
|
8785
8973
|
* @throws {RequiredError}
|
|
8786
8974
|
*/
|
|
8787
|
-
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<
|
|
8975
|
+
checkNovaVersionUpdate(channel: ReleaseChannel, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string, any, {}>>;
|
|
8788
8976
|
/**
|
|
8789
8977
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Performs an address resolution protocol (ARP) scan on the specified interface/classless inter-domain routing (CIDR) and returns all discovered devices on the network by CIDR notation.
|
|
8790
8978
|
* @summary Get ARP-Scan
|
|
@@ -8794,7 +8982,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8794
8982
|
* @param {*} [options] Override http request option.
|
|
8795
8983
|
* @throws {RequiredError}
|
|
8796
8984
|
*/
|
|
8797
|
-
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<
|
|
8985
|
+
getArpScan(_interface?: string, cidr?: string, timeout?: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<NetworkDevice[], any, {}>>;
|
|
8798
8986
|
/**
|
|
8799
8987
|
* **Required permissions:** `can_backup_system` - Create system backups ___ Retrieves the status of a configuration backup. The status can only be requested for 5 minutes after backup creation. After 5 minutes, 404 is returned.
|
|
8800
8988
|
* @summary Retrieve Backup Status
|
|
@@ -8802,49 +8990,49 @@ declare class SystemApi extends BaseAPI {
|
|
|
8802
8990
|
* @param {*} [options] Override http request option.
|
|
8803
8991
|
* @throws {RequiredError}
|
|
8804
8992
|
*/
|
|
8805
|
-
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<
|
|
8993
|
+
getConfigurationBackupStatus(operationId: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ConfigurationArchiveStatus, any, {}>>;
|
|
8806
8994
|
/**
|
|
8807
8995
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Collects information on the current status of all NOVA services and exports them as a .zip file. Includes information on all cells on the instance such as the service logs and virtual robot controllers. From each cell the logs of all services are included, as well as the configuration of each connected controller to start virtual robots.
|
|
8808
8996
|
* @summary Download Diagnosis Package
|
|
8809
8997
|
* @param {*} [options] Override http request option.
|
|
8810
8998
|
* @throws {RequiredError}
|
|
8811
8999
|
*/
|
|
8812
|
-
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<
|
|
9000
|
+
getDiagnosePackage(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<File, any, {}>>;
|
|
8813
9001
|
/**
|
|
8814
9002
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Get the network interfaces of the system.
|
|
8815
9003
|
* @summary Network Interfaces
|
|
8816
9004
|
* @param {*} [options] Override http request option.
|
|
8817
9005
|
* @throws {RequiredError}
|
|
8818
9006
|
*/
|
|
8819
|
-
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<
|
|
9007
|
+
getNetworkInterfaces(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<NetworkInterface[], any, {}>>;
|
|
8820
9008
|
/**
|
|
8821
9009
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ <!-- theme: danger --> > **Experimental** Get the current state of the network.
|
|
8822
9010
|
* @summary Network State
|
|
8823
9011
|
* @param {*} [options] Override http request option.
|
|
8824
9012
|
* @throws {RequiredError}
|
|
8825
9013
|
*/
|
|
8826
|
-
getNetworkState(options?: RawAxiosRequestConfig): Promise<
|
|
9014
|
+
getNetworkState(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<NetworkState, any, {}>>;
|
|
8827
9015
|
/**
|
|
8828
9016
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Get the status of all system services.
|
|
8829
9017
|
* @summary Wandelbots NOVA status
|
|
8830
9018
|
* @param {*} [options] Override http request option.
|
|
8831
9019
|
* @throws {RequiredError}
|
|
8832
9020
|
*/
|
|
8833
|
-
getSystemStatus(options?: RawAxiosRequestConfig): Promise<
|
|
9021
|
+
getSystemStatus(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ServiceStatus[], any, {}>>;
|
|
8834
9022
|
/**
|
|
8835
9023
|
* **Required permissions:** `can_access_system` - View system status and metadata ___ Get the current Wandelbots NOVA version.
|
|
8836
9024
|
* @summary Wandelbots NOVA Version
|
|
8837
9025
|
* @param {*} [options] Override http request option.
|
|
8838
9026
|
* @throws {RequiredError}
|
|
8839
9027
|
*/
|
|
8840
|
-
getSystemVersion(options?: RawAxiosRequestConfig): Promise<
|
|
9028
|
+
getSystemVersion(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<string, any, {}>>;
|
|
8841
9029
|
/**
|
|
8842
9030
|
* **Required permissions:** `can_backup_system` - Create system backups ___ Retrieves a list of all available configuration resources for backup purposes.
|
|
8843
9031
|
* @summary List Configuration Resources
|
|
8844
9032
|
* @param {*} [options] Override http request option.
|
|
8845
9033
|
* @throws {RequiredError}
|
|
8846
9034
|
*/
|
|
8847
|
-
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<
|
|
9035
|
+
listConfigurationResources(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ConfigurationResource[], any, {}>>;
|
|
8848
9036
|
/**
|
|
8849
9037
|
* **Required permissions:** `can_restore_system` - Restore system backups ___ Restores a previously backed up configuration. If an empty array of resources is provided, all resources from the backup will be restored.
|
|
8850
9038
|
* @summary Restore Configuration Backup
|
|
@@ -8853,7 +9041,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8853
9041
|
* @param {*} [options] Override http request option.
|
|
8854
9042
|
* @throws {RequiredError}
|
|
8855
9043
|
*/
|
|
8856
|
-
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
9044
|
+
restoreConfiguration(body: File, resources?: Array<string>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
8857
9045
|
/**
|
|
8858
9046
|
* **Required permissions:** `can_update_system` - Update system versions and services ___ 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.
|
|
8859
9047
|
* @summary Update Wandelbots NOVA version
|
|
@@ -8861,7 +9049,7 @@ declare class SystemApi extends BaseAPI {
|
|
|
8861
9049
|
* @param {*} [options] Override http request option.
|
|
8862
9050
|
* @throws {RequiredError}
|
|
8863
9051
|
*/
|
|
8864
|
-
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9052
|
+
updateNovaVersion(updateNovaVersionRequest: UpdateNovaVersionRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
8865
9053
|
}
|
|
8866
9054
|
/**
|
|
8867
9055
|
* TrajectoryCachingApi - axios parameter creator
|
|
@@ -9035,7 +9223,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9035
9223
|
* @param {*} [options] Override http request option.
|
|
9036
9224
|
* @throws {RequiredError}
|
|
9037
9225
|
*/
|
|
9038
|
-
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9226
|
+
addTrajectory(cell: string, controller: string, addTrajectoryRequest: AddTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<AddTrajectoryResponse, any, {}>>;
|
|
9039
9227
|
/**
|
|
9040
9228
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Clear the trajectory cache.
|
|
9041
9229
|
* @summary Clear Trajectories
|
|
@@ -9044,7 +9232,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9044
9232
|
* @param {*} [options] Override http request option.
|
|
9045
9233
|
* @throws {RequiredError}
|
|
9046
9234
|
*/
|
|
9047
|
-
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9235
|
+
clearTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
9048
9236
|
/**
|
|
9049
9237
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
9050
9238
|
* @summary Delete Trajectory
|
|
@@ -9054,7 +9242,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9054
9242
|
* @param {*} [options] Override http request option.
|
|
9055
9243
|
* @throws {RequiredError}
|
|
9056
9244
|
*/
|
|
9057
|
-
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
9245
|
+
deleteTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
9058
9246
|
/**
|
|
9059
9247
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ Get a previously created trajectory from cache. Use [listTrajectories](#/operations/listTrajectories) to list all cached trajectories.
|
|
9060
9248
|
* @summary Get Trajectory
|
|
@@ -9064,7 +9252,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9064
9252
|
* @param {*} [options] Override http request option.
|
|
9065
9253
|
* @throws {RequiredError}
|
|
9066
9254
|
*/
|
|
9067
|
-
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<
|
|
9255
|
+
getTrajectory(cell: string, controller: string, trajectory: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<GetTrajectoryResponse, any, {}>>;
|
|
9068
9256
|
/**
|
|
9069
9257
|
* **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___ 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.
|
|
9070
9258
|
* @summary List Trajectories
|
|
@@ -9073,7 +9261,7 @@ declare class TrajectoryCachingApi extends BaseAPI {
|
|
|
9073
9261
|
* @param {*} [options] Override http request option.
|
|
9074
9262
|
* @throws {RequiredError}
|
|
9075
9263
|
*/
|
|
9076
|
-
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
9264
|
+
listTrajectories(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ListTrajectoriesResponse, any, {}>>;
|
|
9077
9265
|
}
|
|
9078
9266
|
/**
|
|
9079
9267
|
* TrajectoryExecutionApi - axios parameter creator
|
|
@@ -9133,7 +9321,7 @@ declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
9133
9321
|
* @param {*} [options] Override http request option.
|
|
9134
9322
|
* @throws {RequiredError}
|
|
9135
9323
|
*/
|
|
9136
|
-
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9324
|
+
executeTrajectory(cell: string, controller: string, executeTrajectoryRequest: ExecuteTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ExecuteTrajectoryResponse, any, {}>>;
|
|
9137
9325
|
}
|
|
9138
9326
|
/**
|
|
9139
9327
|
* TrajectoryPlanningApi - axios parameter creator
|
|
@@ -9270,7 +9458,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9270
9458
|
* @param {*} [options] Override http request option.
|
|
9271
9459
|
* @throws {RequiredError}
|
|
9272
9460
|
*/
|
|
9273
|
-
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9461
|
+
mergeTrajectories(cell: string, mergeTrajectoriesRequest: MergeTrajectoriesRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<MergeTrajectoriesResponse, any, {}>>;
|
|
9274
9462
|
/**
|
|
9275
9463
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ 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.
|
|
9276
9464
|
* @summary Plan Collision-Free Trajectory
|
|
@@ -9279,7 +9467,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9279
9467
|
* @param {*} [options] Override http request option.
|
|
9280
9468
|
* @throws {RequiredError}
|
|
9281
9469
|
*/
|
|
9282
|
-
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9470
|
+
planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<PlanCollisionFreeResponse, any, {}>>;
|
|
9283
9471
|
/**
|
|
9284
9472
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ 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.
|
|
9285
9473
|
* @summary Plan Trajectory
|
|
@@ -9288,7 +9476,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9288
9476
|
* @param {*} [options] Override http request option.
|
|
9289
9477
|
* @throws {RequiredError}
|
|
9290
9478
|
*/
|
|
9291
|
-
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9479
|
+
planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<PlanTrajectoryResponse, any, {}>>;
|
|
9292
9480
|
/**
|
|
9293
9481
|
* **Required permissions:** `can_plan_motion` - Plan robot motions and trajectories ___ <!-- theme: danger --> > **Experimental** Searches collision-free trajectories for multiple motion groups simultaneously within a cell. This is the multi-robot variant of collision-free path search — it coordinates paths so that several motion groups, e.g., multiple robot arms, can move from start to target positions without colliding with each other or with the environment. The caller provides per-motion-group setups (robot model, cycle time, mounting, TCP offset, limits, payload, collision geometry), per-motion-group point-to-point path definitions (start and target joint positions), optional cross-group collision setups defining which link-chain/tool colliders to consider between groups plus static environment colliders, and optional RRT-Connect algorithm settings (max iterations, step size, smoothing, blending). On success the response contains a time-synchronized trajectory with joint positions per motion group at shared timestamps so their motions are temporally coordinated. On failure it returns feedback indicating why planning failed, e.g., max iterations exceeded.
|
|
9294
9482
|
* @summary Search Collision-Free Trajectories for Multiple Motion Groups
|
|
@@ -9297,7 +9485,7 @@ declare class TrajectoryPlanningApi extends BaseAPI {
|
|
|
9297
9485
|
* @param {*} [options] Override http request option.
|
|
9298
9486
|
* @throws {RequiredError}
|
|
9299
9487
|
*/
|
|
9300
|
-
searchCollisionFreeMultiMotionGroup(cell: string, multiSearchCollisionFreeRequest: MultiSearchCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<
|
|
9488
|
+
searchCollisionFreeMultiMotionGroup(cell: string, multiSearchCollisionFreeRequest: MultiSearchCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<MultiSearchCollisionFreeResponse, any, {}>>;
|
|
9301
9489
|
}
|
|
9302
9490
|
/**
|
|
9303
9491
|
* VersionApi - axios parameter creator
|
|
@@ -9345,7 +9533,7 @@ declare class VersionApi extends BaseAPI {
|
|
|
9345
9533
|
* @param {*} [options] Override http request option.
|
|
9346
9534
|
* @throws {RequiredError}
|
|
9347
9535
|
*/
|
|
9348
|
-
getApiVersion(options?: RawAxiosRequestConfig): Promise<
|
|
9536
|
+
getApiVersion(options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ApiVersion, any, {}>>;
|
|
9349
9537
|
}
|
|
9350
9538
|
/**
|
|
9351
9539
|
* VirtualControllerApi - axios parameter creator
|
|
@@ -9982,7 +10170,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
9982
10170
|
* @param {*} [options] Override http request option.
|
|
9983
10171
|
* @throws {RequiredError}
|
|
9984
10172
|
*/
|
|
9985
|
-
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<
|
|
10173
|
+
addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
9986
10174
|
/**
|
|
9987
10175
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
9988
10176
|
* @summary Add Motion Group
|
|
@@ -9992,7 +10180,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
9992
10180
|
* @param {*} [options] Override http request option.
|
|
9993
10181
|
* @throws {RequiredError}
|
|
9994
10182
|
*/
|
|
9995
|
-
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10183
|
+
addVirtualControllerMotionGroup(cell: string, controller: string, addVirtualControllerMotionGroupRequest: AddVirtualControllerMotionGroupRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
9996
10184
|
/**
|
|
9997
10185
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Adds a new safety zone to the virtual robot controller. Safety zones define geometric boundaries that restrict or permit robot motion in 3D space. Each zone has a `geometry` that defines its shape, and two flags that control its behavior: - **`restricted: true`** the robot is not allowed to enter this zone. - **`inverted: true`** the zone applies to the **outside** of the shape, meaning the shape defines the *allowed* region; everything outside is the zone. Combined with `restricted: true`, the robot must stay **inside** the shape. Common combinations: | `restricted` | `inverted` | Effect | |---|---|---| | `true` | `false` | Keep-out zone, the robot cannot enter the shape, e.g., obstacle, table, wall | | `true` | `true` | Keep-in zone, the robot must stay inside the shape, e.g., workspace envelope / cell boundary | The `mg_uid` field specifies which motion group the safety zone is enforced for and must match an existing motion group UID on the controller. The `uid_ref_cs` field defines the coordinate system in which the geometry coordinates are expressed. The coordinate system must be defined on the controller beforehand. If empty (`\"\"`), the World coordinate system is used. Using an incorrect coordinate system places the safety zone in a different physical location. --- ## Geometry Shape Reference All coordinates are in **millimetres (mm)**. Choose the shape that best fits the physical boundary. --- ### Box A rectangular cuboid (box) defined by its **center point** and **three face centers** (`neighbour`). Each face center is the center of one of the three principal faces of the box and encodes both the size and orientation of the box. The distance from the center to each face center equals half the edge length along that axis. This format is used directly by robot controllers (FANUC, KUKA, etc.) and supports arbitrary orientations, including left-handed coordinate systems that parametric (size + quaternion) formats cannot represent. **When to use:** Cell workspace envelope, machine enclosure, table, rectangular obstacle, pallet zone. **How to define:** ``` center → geometric center of the box [x, y, z] neighbour = [ x1, y1, z1, ← center of the face along the first axis x2, y2, z2, ← center of the face along the second axis x3, y3, z3 ← center of the face along the third axis ] edge_length_i = 2 × ||neighbour_i − center|| ``` For an axis-aligned box with `center = [cx, cy, cz]` and half-sizes `[hx, hy, hz]`: ``` neighbour = [cx+hx, cy, cz, cx, cy+hy, cz, cx, cy, cz+hz] ``` --- ### Prism An extruded polygon is a 2D closed polygon (defined in the XY plane) extruded vertically between `bottom` and `top` Z coordinates. The polygon can be convex or concave. **When to use:** Irregular floor-plan areas (aisles, loading bays, L-shaped zones), conveyor corridors, or any zone with a non-rectangular footprint. **How to define:** ``` point = [x1, y1, x2, y2, x3, y3, ...] ← 2D vertices (XY), flattened, ≥ 3 points top = upper Z bound [mm] bottom = lower Z bound [mm] ``` Points must form a closed polygon; the last point implicitly connects to the first. --- ### Sphere A perfect sphere defined by its **center point** and **radius**. **When to use:** Protection zones around sensors, cameras, workpieces, point-like obstacles, singularity avoidance zones around the robot base. **How to define:** ``` center = [x, y, z] ← center of the sphere [mm] radius ← radius [mm] ``` --- ### Capsule A cylinder with hemispherical caps at each end, defined by two axis endpoints (`top`, `bottom`) and a **radius**. The axis can have any orientation. **When to use:** Pipes, cable trays, vertical columns, horizontal beams, or tube-shaped obstacles. **How to define:** ``` top = [x, y, z] ← center of the top hemisphere [mm] bottom = [x, y, z] ← center of the bottom hemisphere [mm] radius ← cylinder + hemisphere radius [mm] ``` The total length of the capsule is `||top − bottom|| + 2 × radius`. --- ### Lozenge A rounded rectangle (stadium/discorectangle shape) in a plane, defined by a **center pose**, two **dimensions**, and a **corner radius**. The plane orientation is defined by the quaternion in `center`. **When to use:** Conveyor belt surfaces, worktables with rounded edges, or flat rectangular zones in arbitrary orientations. **How to define:** ``` center.x/y/z ← position of the center [mm] center.qx/qy/qz/qw ← orientation as unit quaternion (identity = XY plane) x_dimension ← total length along local X axis [mm] y_dimension ← total width along local Y axis [mm] radius ← corner rounding radius [mm] ``` For a horizontal lozenge, use identity quaternion `(qx=0, qy=0, qz=0, qw=1)`. --- ### Plane A mathematical half-space plane defined by its **3D vertices**. All vertices must be coplanar. The plane is unbounded (infinite extent in all directions parallel to the surface). The points define the plane\'s orientation and position only. **When to use:** Floor boundaries, virtual walls, tilted surfaces, e.g., ramps, inclined conveyors, or flat custom barriers. **How to define:** ``` point = [x1, y1, z1, x2, y2, z2, x3, y3, z3, ...] ← 3D vertices, flattened, ≥ 3 points ``` Points must be coplanar and form a closed polygon. --- <!-- theme: info --> > #### NOTE > > When a safety zone is added, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - All connections to the virtual robot are closed and re-established, introducing a short delay before the system is fully operational again. > - The safety checksum is automatically updated to reflect the configuration change. > > The API call **does not wait until the restart and re-synchronization are complete**.
|
|
9998
10186
|
* @summary Add Safety Zone
|
|
@@ -10002,7 +10190,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10002
10190
|
* @param {*} [options] Override http request option.
|
|
10003
10191
|
* @throws {RequiredError}
|
|
10004
10192
|
*/
|
|
10005
|
-
addVirtualControllerSafetyZone(cell: string, controller: string, safetyZone: SafetyZone, options?: RawAxiosRequestConfig): Promise<
|
|
10193
|
+
addVirtualControllerSafetyZone(cell: string, controller: string, safetyZone: SafetyZone, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10006
10194
|
/**
|
|
10007
10195
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10008
10196
|
* @summary Add TCP
|
|
@@ -10014,7 +10202,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10014
10202
|
* @param {*} [options] Override http request option.
|
|
10015
10203
|
* @throws {RequiredError}
|
|
10016
10204
|
*/
|
|
10017
|
-
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<
|
|
10205
|
+
addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10018
10206
|
/**
|
|
10019
10207
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. <!-- theme: info --> > #### NOTE > > When a new coordinate system is removed, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
|
|
10020
10208
|
* @summary Delete Coordinate System
|
|
@@ -10025,7 +10213,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10025
10213
|
* @param {*} [options] Override http request option.
|
|
10026
10214
|
* @throws {RequiredError}
|
|
10027
10215
|
*/
|
|
10028
|
-
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
10216
|
+
deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10029
10217
|
/**
|
|
10030
10218
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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**.
|
|
10031
10219
|
* @summary Delete Motion Group
|
|
@@ -10035,7 +10223,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10035
10223
|
* @param {*} [options] Override http request option.
|
|
10036
10224
|
* @throws {RequiredError}
|
|
10037
10225
|
*/
|
|
10038
|
-
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10226
|
+
deleteVirtualControllerMotionGroup(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10039
10227
|
/**
|
|
10040
10228
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Removes a safety zone from the virtual robot controller. <!-- theme: info --> > #### NOTE > > When a safety zone is removed, **the virtual robot is restarted** to apply the new configuration. > > During this restart: > - All connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > - The safety checksum is automatically updated to reflect the configuration change. > > The API call itself **does not wait until the restart and re-synchronization are complete**.
|
|
10041
10229
|
* @summary Delete Safety Zone
|
|
@@ -10045,7 +10233,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10045
10233
|
* @param {*} [options] Override http request option.
|
|
10046
10234
|
* @throws {RequiredError}
|
|
10047
10235
|
*/
|
|
10048
|
-
deleteVirtualControllerSafetyZone(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<
|
|
10236
|
+
deleteVirtualControllerSafetyZone(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10049
10237
|
/**
|
|
10050
10238
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10051
10239
|
* @summary Remove TCP
|
|
@@ -10056,7 +10244,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10056
10244
|
* @param {*} [options] Override http request option.
|
|
10057
10245
|
* @throws {RequiredError}
|
|
10058
10246
|
*/
|
|
10059
|
-
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<
|
|
10247
|
+
deleteVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10060
10248
|
/**
|
|
10061
10249
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10062
10250
|
* @summary Get Emergency Stop State
|
|
@@ -10065,7 +10253,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10065
10253
|
* @param {*} [options] Override http request option.
|
|
10066
10254
|
* @throws {RequiredError}
|
|
10067
10255
|
*/
|
|
10068
|
-
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10256
|
+
getEmergencyStop(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<Flag, any, {}>>;
|
|
10069
10257
|
/**
|
|
10070
10258
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Get the current motion group state which provides values for the joints\' position, velocity and acceleration.
|
|
10071
10259
|
* @summary Get Motion Group State
|
|
@@ -10075,7 +10263,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10075
10263
|
* @param {*} [options] Override http request option.
|
|
10076
10264
|
* @throws {RequiredError}
|
|
10077
10265
|
*/
|
|
10078
|
-
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10266
|
+
getMotionGroupState(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<MotionGroupJoints, any, {}>>;
|
|
10079
10267
|
/**
|
|
10080
10268
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Gets information on the motion group.
|
|
10081
10269
|
* @summary Motion Group Description
|
|
@@ -10084,7 +10272,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10084
10272
|
* @param {*} [options] Override http request option.
|
|
10085
10273
|
* @throws {RequiredError}
|
|
10086
10274
|
*/
|
|
10087
|
-
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10275
|
+
getMotionGroups(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<MotionGroupInfo[], any, {}>>;
|
|
10088
10276
|
/**
|
|
10089
10277
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10090
10278
|
* @summary Get Operation Mode
|
|
@@ -10093,7 +10281,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10093
10281
|
* @param {*} [options] Override http request option.
|
|
10094
10282
|
* @throws {RequiredError}
|
|
10095
10283
|
*/
|
|
10096
|
-
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10284
|
+
getOperationMode(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<OpMode, any, {}>>;
|
|
10097
10285
|
/**
|
|
10098
10286
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Gets motion group mounting. The motion group is based on the origin of the returned coordinate system.
|
|
10099
10287
|
* @summary Get Mounting
|
|
@@ -10103,7 +10291,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10103
10291
|
* @param {*} [options] Override http request option.
|
|
10104
10292
|
* @throws {RequiredError}
|
|
10105
10293
|
*/
|
|
10106
|
-
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10294
|
+
getVirtualControllerMounting(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CoordinateSystem, any, {}>>;
|
|
10107
10295
|
/**
|
|
10108
10296
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Gets all safety zones configured in the virtual robot controller. Safety zones define geometric boundaries that restrict robot motion or define protected areas in the workspace.
|
|
10109
10297
|
* @summary List Safety Zones
|
|
@@ -10112,7 +10300,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10112
10300
|
* @param {*} [options] Override http request option.
|
|
10113
10301
|
* @throws {RequiredError}
|
|
10114
10302
|
*/
|
|
10115
|
-
getVirtualControllerSafetyZones(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10303
|
+
getVirtualControllerSafetyZones(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<SafetyZones, any, {}>>;
|
|
10116
10304
|
/**
|
|
10117
10305
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Lists all coordinate systems on the robot controller.
|
|
10118
10306
|
* @summary List Coordinate Systems
|
|
@@ -10121,7 +10309,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10121
10309
|
* @param {*} [options] Override http request option.
|
|
10122
10310
|
* @throws {RequiredError}
|
|
10123
10311
|
*/
|
|
10124
|
-
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10312
|
+
listVirtualControllerCoordinateSystems(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CoordinateSystem[], any, {}>>;
|
|
10125
10313
|
/**
|
|
10126
10314
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Lists TCPs of the motion group. An empty TCP list is valid, e.g., for external axes.
|
|
10127
10315
|
* @summary List TCPs
|
|
@@ -10131,7 +10319,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10131
10319
|
* @param {*} [options] Override http request option.
|
|
10132
10320
|
* @throws {RequiredError}
|
|
10133
10321
|
*/
|
|
10134
|
-
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<
|
|
10322
|
+
listVirtualControllerTcps(cell: string, controller: string, motionGroup: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<RobotTcp[], any, {}>>;
|
|
10135
10323
|
/**
|
|
10136
10324
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10137
10325
|
* @summary Push or Release Emergency Stop
|
|
@@ -10141,7 +10329,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10141
10329
|
* @param {*} [options] Override http request option.
|
|
10142
10330
|
* @throws {RequiredError}
|
|
10143
10331
|
*/
|
|
10144
|
-
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<
|
|
10332
|
+
setEmergencyStop(cell: string, controller: string, active?: boolean, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10145
10333
|
/**
|
|
10146
10334
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Sets the values for joint position, joint velocity or joint acceleration of a motion group state. The values are immediately applied to the joints of the motion group. <!-- theme: info --> > #### NOTE > > Only use the endpoint when the motion group is in monitor mode. If the motion group is controlled, currently jogging or planning motions, > the values are overridden by the controller or an error may occur.
|
|
10147
10335
|
* @summary Set Motion Group State
|
|
@@ -10152,7 +10340,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10152
10340
|
* @param {*} [options] Override http request option.
|
|
10153
10341
|
* @throws {RequiredError}
|
|
10154
10342
|
*/
|
|
10155
|
-
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<
|
|
10343
|
+
setMotionGroupState(cell: string, controller: string, motionGroup: string, motionGroupJoints: MotionGroupJoints, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10156
10344
|
/**
|
|
10157
10345
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ 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.
|
|
10158
10346
|
* @summary Set Operation Mode
|
|
@@ -10162,7 +10350,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10162
10350
|
* @param {*} [options] Override http request option.
|
|
10163
10351
|
* @throws {RequiredError}
|
|
10164
10352
|
*/
|
|
10165
|
-
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<
|
|
10353
|
+
setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10166
10354
|
/**
|
|
10167
10355
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. <!-- theme: info --> > #### Changing the mounting configuration is considered a setup change > > When the mounting is set to a new coordinate system, the **virtual robot is restarted** to apply the new configuration. > > During this restart: > - Robot visualization can temporarily disappear or not reflect the new mounting immediately. > - Motion group state and coordinate system alignment may not be immediately visible in visualizations. > - All connections to virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. > > The API call itself does **not wait until the restart and re-synchronization are complete**. > A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
10168
10356
|
* @summary Set Mounting
|
|
@@ -10173,7 +10361,7 @@ declare class VirtualControllerApi extends BaseAPI {
|
|
|
10173
10361
|
* @param {*} [options] Override http request option.
|
|
10174
10362
|
* @throws {RequiredError}
|
|
10175
10363
|
*/
|
|
10176
|
-
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<
|
|
10364
|
+
setVirtualControllerMounting(cell: string, controller: string, motionGroup: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CoordinateSystem, any, {}>>;
|
|
10177
10365
|
}
|
|
10178
10366
|
/**
|
|
10179
10367
|
* VirtualControllerBehaviorApi - axios parameter creator
|
|
@@ -10317,7 +10505,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10317
10505
|
* @param {*} [options] Override http request option.
|
|
10318
10506
|
* @throws {RequiredError}
|
|
10319
10507
|
*/
|
|
10320
|
-
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<
|
|
10508
|
+
externalJointsStream(cell: string, controller: string, externalJointStreamRequest: ExternalJointStreamRequest, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<ExternalJointStreamDatapoint[], any, {}>>;
|
|
10321
10509
|
/**
|
|
10322
10510
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Get the cycle time of controller communication in [ms].
|
|
10323
10511
|
* @summary Get Cycle Time
|
|
@@ -10326,7 +10514,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10326
10514
|
* @param {*} [options] Override http request option.
|
|
10327
10515
|
* @throws {RequiredError}
|
|
10328
10516
|
*/
|
|
10329
|
-
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10517
|
+
getCycleTime(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<CycleTime, any, {}>>;
|
|
10330
10518
|
/**
|
|
10331
10519
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Get the current virtual controller behavior. See [setVirtualControllerBehavior](#/operations/setVirtualControllerBehavior) and the body for details.
|
|
10332
10520
|
* @summary Get Behavior
|
|
@@ -10335,7 +10523,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10335
10523
|
* @param {*} [options] Override http request option.
|
|
10336
10524
|
* @throws {RequiredError}
|
|
10337
10525
|
*/
|
|
10338
|
-
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<
|
|
10526
|
+
getVirtualControllerBehavior(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<Behavior, any, {}>>;
|
|
10339
10527
|
/**
|
|
10340
10528
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Set virtual controller behavior. See query parameters for details.
|
|
10341
10529
|
* @summary Set Behavior
|
|
@@ -10345,7 +10533,7 @@ declare class VirtualControllerBehaviorApi extends BaseAPI {
|
|
|
10345
10533
|
* @param {*} [options] Override http request option.
|
|
10346
10534
|
* @throws {RequiredError}
|
|
10347
10535
|
*/
|
|
10348
|
-
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<
|
|
10536
|
+
setVirtualControllerBehavior(cell: string, controller: string, behavior?: Behavior, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10349
10537
|
}
|
|
10350
10538
|
/**
|
|
10351
10539
|
* VirtualControllerInputsOutputsApi - axios parameter creator
|
|
@@ -10474,7 +10662,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
10474
10662
|
* @param {*} [options] Override http request option.
|
|
10475
10663
|
* @throws {RequiredError}
|
|
10476
10664
|
*/
|
|
10477
|
-
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<
|
|
10665
|
+
listIOs(cell: string, controller: string, ios: Array<string>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<IOValue[], any, {}>>;
|
|
10478
10666
|
/**
|
|
10479
10667
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Lists the input/output descriptions of the virtual robot controller. The input/output descriptions contain information like name, type and unit.\\ Available inputs/outputs are defined by the virtual robot controller.\\ Each input/output has a unique identifier. - If no identifiers and no filters are specified in the request, all available inputs/outputs are retrieved by this endpoint. - If a filter, e.g., `direction`, `value_type`, `group` is applied, only matching inputs/outputs are returned.
|
|
10480
10668
|
* @summary List Descriptions
|
|
@@ -10487,7 +10675,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
10487
10675
|
* @param {*} [options] Override http request option.
|
|
10488
10676
|
* @throws {RequiredError}
|
|
10489
10677
|
*/
|
|
10490
|
-
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<
|
|
10678
|
+
listVirtualControllerIODescriptions(cell: string, controller: string, ios?: Array<string>, direction?: IODirection, valueType?: IOValueType, group?: string, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<IODescription[], any, {}>>;
|
|
10491
10679
|
/**
|
|
10492
10680
|
* **Required permissions:** `can_operate_virtual_controllers` - Operate and configure virtual controllers ___ Sets a list of values of a virtual controller inputs/outputs.
|
|
10493
10681
|
* @summary Set Input/Ouput Values
|
|
@@ -10497,7 +10685,7 @@ declare class VirtualControllerInputsOutputsApi extends BaseAPI {
|
|
|
10497
10685
|
* @param {*} [options] Override http request option.
|
|
10498
10686
|
* @throws {RequiredError}
|
|
10499
10687
|
*/
|
|
10500
|
-
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<
|
|
10688
|
+
setIOValues(cell: string, controller: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<_$axios.AxiosResponse<void, any, {}>>;
|
|
10501
10689
|
}
|
|
10502
10690
|
//#endregion
|
|
10503
|
-
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, BusIOProfinetSlot, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, CloudConfigStatus, CloudConfigStatusConfigured, CloudConfigStatusConfiguredStatusEnum, CloudConfigStatusNotConfigured, CloudConfigStatusNotConfiguredStatusEnum, CloudConfiguration, CloudConnectionError, CloudConnectionErrorError, CloudConnectionErrorInvalidToken, CloudConnectionErrorInvalidTokenCodeEnum, CloudConnectionErrorInvalidTokenDetails, CloudConnectionErrorInvalidTokenDetailsCloudResponse, CloudConnectionErrorLeafnodeConnectionError, CloudConnectionErrorLeafnodeConnectionErrorCodeEnum, CloudConnectionErrorLeafnodeConnectionErrorDetails, CloudConnectionErrorLeafnodeConnectionTimeout, CloudConnectionErrorLeafnodeConnectionTimeoutCodeEnum, CloudConnectionErrorLeafnodeRestartTimeout, CloudConnectionErrorLeafnodeRestartTimeoutCodeEnum, CloudConnectionErrorNatsFailed, CloudConnectionErrorNatsFailedCodeEnum, CloudConnectionErrorNatsFailedDetails, CloudConnectionErrorUnexpectedResponse, CloudConnectionErrorUnexpectedResponseCodeEnum, CloudConnectionErrorUnexpectedResponseDetails, CloudConnectionErrorUnexpectedResponseDetailsCloudResponse, CloudConnectionRequest, CloudDisconnectionError, CloudDisconnectionStatusDisconnected, CloudDisconnectionStatusDisconnectedStatusEnum, CloudDisconnectionStatusDisconnecting, CloudDisconnectionStatusDisconnectingStatusEnum, CloudRegistrationSuccessResponse, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionErrorKindEnum, CollisionFreeAlgorithm, CollisionMotionGroup, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ConstrainedPose, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, DirectionConstraint, DirectionConstraintConstraintNameEnum, ErrorDirectionConstraintNotMet, ErrorDirectionConstraintNotMetErrorFeedbackNameEnum, ErrorDirectionConstraintNotNormalized, ErrorDirectionConstraintNotNormalizedErrorFeedbackNameEnum, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, ErrorMotionGroupKeyMismatch, ErrorUnsupportedOperation, ErrorUnsupportedOperationErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackCommandsMissing, FeedbackCommandsMissingErrorFeedbackNameEnum, FeedbackCubicSplineIsNotIncreasing, FeedbackCubicSplineIsNotIncreasingErrorFeedbackNameEnum, FeedbackCubicSplineNotAtStartPose, FeedbackCubicSplineNotAtStartPoseErrorFeedbackNameEnum, FeedbackDirectionConstraintNoSolutionExists, FeedbackDirectionConstraintNoSolutionExistsErrorFeedbackNameEnum, FeedbackDirectionConstraintNotMet, FeedbackDirectionConstraintNotMetErrorFeedbackNameEnum, FeedbackDirectionConstraintNotNormalized, FeedbackDirectionConstraintNotNormalizedErrorFeedbackNameEnum, FeedbackInvalidDof, FeedbackInvalidDofErrorFeedbackNameEnum, FeedbackInvalidNanValue, FeedbackInvalidNanValueErrorFeedbackNameEnum, FeedbackInvalidSamplingTime, FeedbackInvalidSamplingTimeErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackNoSolutionInCurrentConfiguration, FeedbackNoSolutionInCurrentConfigurationErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, FeedbackStartJointsMissing, FeedbackStartJointsMissingErrorFeedbackNameEnum, FeedbackTorqueExceeded, FeedbackTorqueExceededErrorFeedbackNameEnum, Flag, FlangePayload, 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, JoggingPausedNearSingularity, JoggingPausedNearSingularityKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimitExceededErrorKindEnum, JointLimits, JointPTPMotion, 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, MergeTrajectoriesErrorErrorFeedback, 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, MultiCollisionSetup, MultiErrorInvalidJointCount, MultiErrorJointLimitExceeded, MultiErrorJointPositionCollision, MultiJointTrajectory, MultiSearchCollisionFree422Response, MultiSearchCollisionFreeRequest, MultiSearchCollisionFreeResponse, MultiSearchCollisionFreeResponseResponse, MultiSearchCollisionFreeValidationError, MultiSearchCollisionFreeValidationErrorAllOfData, NOVACloudApi, NOVACloudApiAxiosParamCreator, NOVACloudApiFactory, NOVACloudApiFp, NanValueError, NanValueErrorKindEnum, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathDirectionConstrainedCartesianPTP, PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum, PathDirectionConstrainedJointPTP, PathDirectionConstrainedJointPTPPathDefinitionNameEnum, 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, SafetyGeometry, SafetyGeometryBox, SafetyGeometryCapsule, SafetyGeometryLozenge, SafetyGeometryPlane, SafetyGeometryPrism, SafetyGeometrySphere, SafetyStateType, SafetyZone, SafetyZonePose, SafetyZones, 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, ZodValidationError, ZodValidationErrorError, ZodValidationErrorErrorCodeEnum, ZodValidationErrorErrorDetailsInner, ZodValidationErrorErrorDetailsInnerPathInner, operationServerMap };
|
|
10691
|
+
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, BusIOProfinetSlot, BusIOProfinetVirtual, BusIOProfinetVirtualBusTypeEnum, BusIOType, BusIOsState, BusIOsStateEnum, COLLECTION_FORMATS, CapabilityEntry, Capsule, CapsuleShapeTypeEnum, CartesianLimits, Cell, CellApi, CellApiAxiosParamCreator, CellApiFactory, CellApiFp, CloudConfigStatus, CloudConfigStatusConfigured, CloudConfigStatusConfiguredStatusEnum, CloudConfigStatusNotConfigured, CloudConfigStatusNotConfiguredStatusEnum, CloudConfiguration, CloudConnectionError, CloudConnectionErrorError, CloudConnectionErrorInvalidToken, CloudConnectionErrorInvalidTokenCodeEnum, CloudConnectionErrorInvalidTokenDetails, CloudConnectionErrorInvalidTokenDetailsCloudResponse, CloudConnectionErrorLeafnodeConnectionError, CloudConnectionErrorLeafnodeConnectionErrorCodeEnum, CloudConnectionErrorLeafnodeConnectionErrorDetails, CloudConnectionErrorLeafnodeConnectionTimeout, CloudConnectionErrorLeafnodeConnectionTimeoutCodeEnum, CloudConnectionErrorLeafnodeRestartTimeout, CloudConnectionErrorLeafnodeRestartTimeoutCodeEnum, CloudConnectionErrorNatsFailed, CloudConnectionErrorNatsFailedCodeEnum, CloudConnectionErrorNatsFailedDetails, CloudConnectionErrorUnexpectedResponse, CloudConnectionErrorUnexpectedResponseCodeEnum, CloudConnectionErrorUnexpectedResponseDetails, CloudConnectionErrorUnexpectedResponseDetailsCloudResponse, CloudConnectionRequest, CloudDisconnectionError, CloudDisconnectionStatusDisconnected, CloudDisconnectionStatusDisconnectedStatusEnum, CloudDisconnectionStatusDisconnecting, CloudDisconnectionStatusDisconnectingStatusEnum, CloudRegistrationSuccessResponse, Collider, ColliderShape, Collision, CollisionContact, CollisionError, CollisionErrorKindEnum, CollisionFreeAlgorithm, CollisionMotionGroup, CollisionSetup, Comparator, Configuration, ConfigurationArchiveStatus, ConfigurationArchiveStatusCreating, ConfigurationArchiveStatusCreatingStatusEnum, ConfigurationArchiveStatusError, ConfigurationArchiveStatusErrorStatusEnum, ConfigurationArchiveStatusSuccess, ConfigurationArchiveStatusSuccessStatusEnum, ConfigurationParameters, ConfigurationResource, ConstrainedPose, ContainerEnvironmentInner, ContainerImage, ContainerImageSecretsInner, ContainerResources, ContainerStorage, ControllerApi, ControllerApiAxiosParamCreator, ControllerApiFactory, ControllerApiFp, ControllerDescription, ControllerInputsOutputsApi, ControllerInputsOutputsApiAxiosParamCreator, ControllerInputsOutputsApiFactory, ControllerInputsOutputsApiFp, ConvexHull, ConvexHullShapeTypeEnum, CoordinateSystem, CoordinateSystemData, CubicSplineParameter, CycleTime, Cylinder, CylinderShapeTypeEnum, DHParameter, Direction, DirectionConstraint, DirectionConstraintConstraintNameEnum, ErrorDirectionConstraintNotMet, ErrorDirectionConstraintNotMetErrorFeedbackNameEnum, ErrorDirectionConstraintNotNormalized, ErrorDirectionConstraintNotNormalizedErrorFeedbackNameEnum, ErrorInvalidJointCount, ErrorInvalidJointCountErrorFeedbackNameEnum, ErrorJointLimitExceeded, ErrorJointLimitExceededErrorFeedbackNameEnum, ErrorJointPositionCollision, ErrorJointPositionCollisionErrorFeedbackNameEnum, ErrorMaxIterationsExceeded, ErrorMaxIterationsExceededErrorFeedbackNameEnum, ErrorMotionGroupKeyMismatch, ErrorUnsupportedOperation, ErrorUnsupportedOperationErrorFeedbackNameEnum, Execute, ExecuteDetails, ExecuteJoggingRequest, ExecuteJoggingResponse, ExecuteTrajectoryRequest, ExecuteTrajectoryResponse, ExternalJointStreamDatapoint, ExternalJointStreamRequest, FanucController, FanucControllerKindEnum, FeedbackCollision, FeedbackCollisionErrorFeedbackNameEnum, FeedbackCommandsMissing, FeedbackCommandsMissingErrorFeedbackNameEnum, FeedbackCubicSplineIsNotIncreasing, FeedbackCubicSplineIsNotIncreasingErrorFeedbackNameEnum, FeedbackCubicSplineNotAtStartPose, FeedbackCubicSplineNotAtStartPoseErrorFeedbackNameEnum, FeedbackDirectionConstraintNoSolutionExists, FeedbackDirectionConstraintNoSolutionExistsErrorFeedbackNameEnum, FeedbackDirectionConstraintNotMet, FeedbackDirectionConstraintNotMetErrorFeedbackNameEnum, FeedbackDirectionConstraintNotNormalized, FeedbackDirectionConstraintNotNormalizedErrorFeedbackNameEnum, FeedbackInvalidDof, FeedbackInvalidDofErrorFeedbackNameEnum, FeedbackInvalidNanValue, FeedbackInvalidNanValueErrorFeedbackNameEnum, FeedbackInvalidSamplingTime, FeedbackInvalidSamplingTimeErrorFeedbackNameEnum, FeedbackJointLimitExceeded, FeedbackJointLimitExceededErrorFeedbackNameEnum, FeedbackNoSolutionInCurrentConfiguration, FeedbackNoSolutionInCurrentConfigurationErrorFeedbackNameEnum, FeedbackOutOfWorkspace, FeedbackOutOfWorkspaceErrorFeedbackNameEnum, FeedbackSingularity, FeedbackSingularityErrorFeedbackNameEnum, FeedbackStartJointsMissing, FeedbackStartJointsMissingErrorFeedbackNameEnum, FeedbackTorqueExceeded, FeedbackTorqueExceededErrorFeedbackNameEnum, Flag, FlangePayload, 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, JoggingPausedNearSingularity, JoggingPausedNearSingularityKindEnum, JoggingPausedOnIO, JoggingPausedOnIOKindEnum, JoggingRunning, JoggingRunningKindEnum, JointLimitExceededError, JointLimitExceededErrorKindEnum, JointLimits, JointPTPMotion, 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, MergeTrajectoriesErrorErrorFeedback, 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, MultiCollisionSetup, MultiErrorInvalidJointCount, MultiErrorJointLimitExceeded, MultiErrorJointPositionCollision, MultiJointTrajectory, MultiSearchCollisionFree422Response, MultiSearchCollisionFreeRequest, MultiSearchCollisionFreeResponse, MultiSearchCollisionFreeResponseResponse, MultiSearchCollisionFreeValidationError, MultiSearchCollisionFreeValidationErrorAllOfData, NOVACloudApi, NOVACloudApiAxiosParamCreator, NOVACloudApiFactory, NOVACloudApiFp, NanValueError, NanValueErrorKindEnum, NanValueErrorNanValue, NetworkDevice, NetworkInterface, NetworkState, NetworkStateConnectionTypeEnum, OpMode, OperatingState, OperationLimits, OperationMode, OrientationType, PathCartesianPTP, PathCartesianPTPPathDefinitionNameEnum, PathCircle, PathCirclePathDefinitionNameEnum, PathCubicSpline, PathCubicSplinePathDefinitionNameEnum, PathDirectionConstrainedCartesianPTP, PathDirectionConstrainedCartesianPTPPathDefinitionNameEnum, PathDirectionConstrainedJointPTP, PathDirectionConstrainedJointPTPPathDefinitionNameEnum, 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, ProjectJointPositionDirectionConstraint422Response, ProjectJointPositionDirectionConstraintRequest, ProjectJointPositionDirectionConstraintResponse, ProjectJointPositionDirectionConstraintValidationError, ProjectJointPositionDirectionConstraintValidationErrorAllOfData, RRTConnectAlgorithm, RRTConnectAlgorithmAlgorithmNameEnum, Rectangle, RectangleShapeTypeEnum, RectangularCapsule, RectangularCapsuleShapeTypeEnum, ReleaseChannel, RequestArgs, RequiredError, RobotConfigurationsApi, RobotConfigurationsApiAxiosParamCreator, RobotConfigurationsApiFactory, RobotConfigurationsApiFp, RobotController, RobotControllerConfiguration, RobotControllerConfigurationRequest, RobotControllerState, RobotSystemMode, RobotTcp, RobotTcpData, SafetyGeometry, SafetyGeometryBox, SafetyGeometryCapsule, SafetyGeometryLozenge, SafetyGeometryPlane, SafetyGeometryPrism, SafetyGeometrySphere, SafetyStateType, SafetyZone, SafetyZonePose, SafetyZones, ServiceGroup, ServiceStatus, ServiceStatusPhase, ServiceStatusResponse, ServiceStatusSeverity, ServiceStatusStatus, SessionApi, SessionApiAxiosParamCreator, SessionApiFactory, SessionApiFp, SessionResponse, 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, User, 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, ZodValidationError, ZodValidationErrorError, ZodValidationErrorErrorCodeEnum, ZodValidationErrorErrorDetailsInner, ZodValidationErrorErrorDetailsInnerPathInner, operationServerMap };
|