@wandelbots/nova-api 25.6.0-dev.37 → 25.6.0-dev.39
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/package.json +1 -1
- package/v2/api.d.ts +102 -209
- package/v2/api.js +179 -401
- package/v2/api.js.map +1 -1
- package/v2/api.ts +200 -448
package/package.json
CHANGED
package/v2/api.d.ts
CHANGED
|
@@ -4950,139 +4950,6 @@ export declare class ApplicationApi extends BaseAPI {
|
|
|
4950
4950
|
*/
|
|
4951
4951
|
updateApp(cell: string, app: string, app2: App, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4952
4952
|
}
|
|
4953
|
-
/**
|
|
4954
|
-
* BusIOsApi - axios parameter creator
|
|
4955
|
-
* @export
|
|
4956
|
-
*/
|
|
4957
|
-
export declare const BusIOsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4958
|
-
/**
|
|
4959
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
4960
|
-
* @summary Get Input/Output Values
|
|
4961
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4962
|
-
* @param {Array<string>} [ios]
|
|
4963
|
-
* @param {*} [options] Override http request option.
|
|
4964
|
-
* @throws {RequiredError}
|
|
4965
|
-
*/
|
|
4966
|
-
getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4967
|
-
/**
|
|
4968
|
-
* List all Bus Input/Outputs.
|
|
4969
|
-
* @summary Configuration
|
|
4970
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4971
|
-
* @param {*} [options] Override http request option.
|
|
4972
|
-
* @throws {RequiredError}
|
|
4973
|
-
*/
|
|
4974
|
-
listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4975
|
-
/**
|
|
4976
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
4977
|
-
* @summary Set Output Values
|
|
4978
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4979
|
-
* @param {Array<IOValue>} iOValue
|
|
4980
|
-
* @param {*} [options] Override http request option.
|
|
4981
|
-
* @throws {RequiredError}
|
|
4982
|
-
*/
|
|
4983
|
-
setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4984
|
-
};
|
|
4985
|
-
/**
|
|
4986
|
-
* BusIOsApi - functional programming interface
|
|
4987
|
-
* @export
|
|
4988
|
-
*/
|
|
4989
|
-
export declare const BusIOsApiFp: (configuration?: Configuration) => {
|
|
4990
|
-
/**
|
|
4991
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
4992
|
-
* @summary Get Input/Output Values
|
|
4993
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4994
|
-
* @param {Array<string>} [ios]
|
|
4995
|
-
* @param {*} [options] Override http request option.
|
|
4996
|
-
* @throws {RequiredError}
|
|
4997
|
-
*/
|
|
4998
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
|
|
4999
|
-
/**
|
|
5000
|
-
* List all Bus Input/Outputs.
|
|
5001
|
-
* @summary Configuration
|
|
5002
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5003
|
-
* @param {*} [options] Override http request option.
|
|
5004
|
-
* @throws {RequiredError}
|
|
5005
|
-
*/
|
|
5006
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
|
|
5007
|
-
/**
|
|
5008
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5009
|
-
* @summary Set Output Values
|
|
5010
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5011
|
-
* @param {Array<IOValue>} iOValue
|
|
5012
|
-
* @param {*} [options] Override http request option.
|
|
5013
|
-
* @throws {RequiredError}
|
|
5014
|
-
*/
|
|
5015
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5016
|
-
};
|
|
5017
|
-
/**
|
|
5018
|
-
* BusIOsApi - factory interface
|
|
5019
|
-
* @export
|
|
5020
|
-
*/
|
|
5021
|
-
export declare const BusIOsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
5022
|
-
/**
|
|
5023
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5024
|
-
* @summary Get Input/Output Values
|
|
5025
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5026
|
-
* @param {Array<string>} [ios]
|
|
5027
|
-
* @param {*} [options] Override http request option.
|
|
5028
|
-
* @throws {RequiredError}
|
|
5029
|
-
*/
|
|
5030
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
|
|
5031
|
-
/**
|
|
5032
|
-
* List all Bus Input/Outputs.
|
|
5033
|
-
* @summary Configuration
|
|
5034
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5035
|
-
* @param {*} [options] Override http request option.
|
|
5036
|
-
* @throws {RequiredError}
|
|
5037
|
-
*/
|
|
5038
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
|
|
5039
|
-
/**
|
|
5040
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5041
|
-
* @summary Set Output Values
|
|
5042
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5043
|
-
* @param {Array<IOValue>} iOValue
|
|
5044
|
-
* @param {*} [options] Override http request option.
|
|
5045
|
-
* @throws {RequiredError}
|
|
5046
|
-
*/
|
|
5047
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5048
|
-
};
|
|
5049
|
-
/**
|
|
5050
|
-
* BusIOsApi - object-oriented interface
|
|
5051
|
-
* @export
|
|
5052
|
-
* @class BusIOsApi
|
|
5053
|
-
* @extends {BaseAPI}
|
|
5054
|
-
*/
|
|
5055
|
-
export declare class BusIOsApi extends BaseAPI {
|
|
5056
|
-
/**
|
|
5057
|
-
* Retrieves the current values of inputs/outputs. The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions).
|
|
5058
|
-
* @summary Get Input/Output Values
|
|
5059
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5060
|
-
* @param {Array<string>} [ios]
|
|
5061
|
-
* @param {*} [options] Override http request option.
|
|
5062
|
-
* @throws {RequiredError}
|
|
5063
|
-
* @memberof BusIOsApi
|
|
5064
|
-
*/
|
|
5065
|
-
getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
|
|
5066
|
-
/**
|
|
5067
|
-
* List all Bus Input/Outputs.
|
|
5068
|
-
* @summary Configuration
|
|
5069
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5070
|
-
* @param {*} [options] Override http request option.
|
|
5071
|
-
* @throws {RequiredError}
|
|
5072
|
-
* @memberof BusIOsApi
|
|
5073
|
-
*/
|
|
5074
|
-
listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
|
|
5075
|
-
/**
|
|
5076
|
-
* Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set. All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions). The call will return once the values have been set and accepted by the service.
|
|
5077
|
-
* @summary Set Output Values
|
|
5078
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5079
|
-
* @param {Array<IOValue>} iOValue
|
|
5080
|
-
* @param {*} [options] Override http request option.
|
|
5081
|
-
* @throws {RequiredError}
|
|
5082
|
-
* @memberof BusIOsApi
|
|
5083
|
-
*/
|
|
5084
|
-
setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5085
|
-
}
|
|
5086
4953
|
/**
|
|
5087
4954
|
* CellApi - axios parameter creator
|
|
5088
4955
|
* @export
|
|
@@ -6600,6 +6467,108 @@ export declare class MotionGroupApi extends BaseAPI {
|
|
|
6600
6467
|
*/
|
|
6601
6468
|
streamMotionGroupState(cell: string, motionGroup: string, responseRate?: number, responseCoordinateSystem?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionGroupState, any>>;
|
|
6602
6469
|
}
|
|
6470
|
+
/**
|
|
6471
|
+
* MotionGroupModelsApi - axios parameter creator
|
|
6472
|
+
* @export
|
|
6473
|
+
*/
|
|
6474
|
+
export declare const MotionGroupModelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6475
|
+
/**
|
|
6476
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
6477
|
+
* @summary Get Collision Model
|
|
6478
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6479
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
6480
|
+
* @param {*} [options] Override http request option.
|
|
6481
|
+
* @throws {RequiredError}
|
|
6482
|
+
*/
|
|
6483
|
+
getMotionGroupCollisionModel: (cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6484
|
+
/**
|
|
6485
|
+
* Returns motion group models that are supported for planning.
|
|
6486
|
+
* @summary Motion Group Models
|
|
6487
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6488
|
+
* @param {*} [options] Override http request option.
|
|
6489
|
+
* @throws {RequiredError}
|
|
6490
|
+
*/
|
|
6491
|
+
getMotionGroupModels: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6492
|
+
};
|
|
6493
|
+
/**
|
|
6494
|
+
* MotionGroupModelsApi - functional programming interface
|
|
6495
|
+
* @export
|
|
6496
|
+
*/
|
|
6497
|
+
export declare const MotionGroupModelsApiFp: (configuration?: Configuration) => {
|
|
6498
|
+
/**
|
|
6499
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
6500
|
+
* @summary Get Collision Model
|
|
6501
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6502
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
6503
|
+
* @param {*} [options] Override http request option.
|
|
6504
|
+
* @throws {RequiredError}
|
|
6505
|
+
*/
|
|
6506
|
+
getMotionGroupCollisionModel(cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<{
|
|
6507
|
+
[key: string]: Collider;
|
|
6508
|
+
}>>>;
|
|
6509
|
+
/**
|
|
6510
|
+
* Returns motion group models that are supported for planning.
|
|
6511
|
+
* @summary Motion Group Models
|
|
6512
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6513
|
+
* @param {*} [options] Override http request option.
|
|
6514
|
+
* @throws {RequiredError}
|
|
6515
|
+
*/
|
|
6516
|
+
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
6517
|
+
};
|
|
6518
|
+
/**
|
|
6519
|
+
* MotionGroupModelsApi - factory interface
|
|
6520
|
+
* @export
|
|
6521
|
+
*/
|
|
6522
|
+
export declare const MotionGroupModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6523
|
+
/**
|
|
6524
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
6525
|
+
* @summary Get Collision Model
|
|
6526
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6527
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
6528
|
+
* @param {*} [options] Override http request option.
|
|
6529
|
+
* @throws {RequiredError}
|
|
6530
|
+
*/
|
|
6531
|
+
getMotionGroupCollisionModel(cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<{
|
|
6532
|
+
[key: string]: Collider;
|
|
6533
|
+
}>>;
|
|
6534
|
+
/**
|
|
6535
|
+
* Returns motion group models that are supported for planning.
|
|
6536
|
+
* @summary Motion Group Models
|
|
6537
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6538
|
+
* @param {*} [options] Override http request option.
|
|
6539
|
+
* @throws {RequiredError}
|
|
6540
|
+
*/
|
|
6541
|
+
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
6542
|
+
};
|
|
6543
|
+
/**
|
|
6544
|
+
* MotionGroupModelsApi - object-oriented interface
|
|
6545
|
+
* @export
|
|
6546
|
+
* @class MotionGroupModelsApi
|
|
6547
|
+
* @extends {BaseAPI}
|
|
6548
|
+
*/
|
|
6549
|
+
export declare class MotionGroupModelsApi extends BaseAPI {
|
|
6550
|
+
/**
|
|
6551
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
6552
|
+
* @summary Get Collision Model
|
|
6553
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6554
|
+
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
6555
|
+
* @param {*} [options] Override http request option.
|
|
6556
|
+
* @throws {RequiredError}
|
|
6557
|
+
* @memberof MotionGroupModelsApi
|
|
6558
|
+
*/
|
|
6559
|
+
getMotionGroupCollisionModel(cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
6560
|
+
[key: string]: Collider;
|
|
6561
|
+
}[], any>>;
|
|
6562
|
+
/**
|
|
6563
|
+
* Returns motion group models that are supported for planning.
|
|
6564
|
+
* @summary Motion Group Models
|
|
6565
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6566
|
+
* @param {*} [options] Override http request option.
|
|
6567
|
+
* @throws {RequiredError}
|
|
6568
|
+
* @memberof MotionGroupModelsApi
|
|
6569
|
+
*/
|
|
6570
|
+
getMotionGroupModels(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
6571
|
+
}
|
|
6603
6572
|
/**
|
|
6604
6573
|
* ProgramApi - axios parameter creator
|
|
6605
6574
|
* @export
|
|
@@ -8637,23 +8606,6 @@ export declare class TrajectoryExecutionApi extends BaseAPI {
|
|
|
8637
8606
|
* @export
|
|
8638
8607
|
*/
|
|
8639
8608
|
export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
8640
|
-
/**
|
|
8641
|
-
* Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
8642
|
-
* @summary Get Default Link Chain
|
|
8643
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8644
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
8645
|
-
* @param {*} [options] Override http request option.
|
|
8646
|
-
* @throws {RequiredError}
|
|
8647
|
-
*/
|
|
8648
|
-
getDefaultLinkChain: (cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8649
|
-
/**
|
|
8650
|
-
* Returns motion group models that are supported for planning.
|
|
8651
|
-
* @summary Motion Group Models for Planning
|
|
8652
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8653
|
-
* @param {*} [options] Override http request option.
|
|
8654
|
-
* @throws {RequiredError}
|
|
8655
|
-
*/
|
|
8656
|
-
getMotionGroupModelsForPlanning: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8657
8609
|
/**
|
|
8658
8610
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. 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.
|
|
8659
8611
|
* @summary Plan Trajectory
|
|
@@ -8669,25 +8621,6 @@ export declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Co
|
|
|
8669
8621
|
* @export
|
|
8670
8622
|
*/
|
|
8671
8623
|
export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
|
|
8672
|
-
/**
|
|
8673
|
-
* Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
8674
|
-
* @summary Get Default Link Chain
|
|
8675
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8676
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
8677
|
-
* @param {*} [options] Override http request option.
|
|
8678
|
-
* @throws {RequiredError}
|
|
8679
|
-
*/
|
|
8680
|
-
getDefaultLinkChain(cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<{
|
|
8681
|
-
[key: string]: Collider;
|
|
8682
|
-
}>>>;
|
|
8683
|
-
/**
|
|
8684
|
-
* Returns motion group models that are supported for planning.
|
|
8685
|
-
* @summary Motion Group Models for Planning
|
|
8686
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8687
|
-
* @param {*} [options] Override http request option.
|
|
8688
|
-
* @throws {RequiredError}
|
|
8689
|
-
*/
|
|
8690
|
-
getMotionGroupModelsForPlanning(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
8691
8624
|
/**
|
|
8692
8625
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. 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.
|
|
8693
8626
|
* @summary Plan Trajectory
|
|
@@ -8703,25 +8636,6 @@ export declare const TrajectoryPlanningApiFp: (configuration?: Configuration) =>
|
|
|
8703
8636
|
* @export
|
|
8704
8637
|
*/
|
|
8705
8638
|
export declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
8706
|
-
/**
|
|
8707
|
-
* Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
8708
|
-
* @summary Get Default Link Chain
|
|
8709
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8710
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
8711
|
-
* @param {*} [options] Override http request option.
|
|
8712
|
-
* @throws {RequiredError}
|
|
8713
|
-
*/
|
|
8714
|
-
getDefaultLinkChain(cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<{
|
|
8715
|
-
[key: string]: Collider;
|
|
8716
|
-
}>>;
|
|
8717
|
-
/**
|
|
8718
|
-
* Returns motion group models that are supported for planning.
|
|
8719
|
-
* @summary Motion Group Models for Planning
|
|
8720
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8721
|
-
* @param {*} [options] Override http request option.
|
|
8722
|
-
* @throws {RequiredError}
|
|
8723
|
-
*/
|
|
8724
|
-
getMotionGroupModelsForPlanning(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
8725
8639
|
/**
|
|
8726
8640
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. 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.
|
|
8727
8641
|
* @summary Plan Trajectory
|
|
@@ -8739,27 +8653,6 @@ export declare const TrajectoryPlanningApiFactory: (configuration?: Configuratio
|
|
|
8739
8653
|
* @extends {BaseAPI}
|
|
8740
8654
|
*/
|
|
8741
8655
|
export declare class TrajectoryPlanningApi extends BaseAPI {
|
|
8742
|
-
/**
|
|
8743
|
-
* Returns the default collision link chain for a given motion group model. See [getPlanningMotionGroupModels](getPlanningMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
8744
|
-
* @summary Get Default Link Chain
|
|
8745
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8746
|
-
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
8747
|
-
* @param {*} [options] Override http request option.
|
|
8748
|
-
* @throws {RequiredError}
|
|
8749
|
-
* @memberof TrajectoryPlanningApi
|
|
8750
|
-
*/
|
|
8751
|
-
getDefaultLinkChain(cell: string, motionGroupModel: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
8752
|
-
[key: string]: Collider;
|
|
8753
|
-
}[], any>>;
|
|
8754
|
-
/**
|
|
8755
|
-
* Returns motion group models that are supported for planning.
|
|
8756
|
-
* @summary Motion Group Models for Planning
|
|
8757
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8758
|
-
* @param {*} [options] Override http request option.
|
|
8759
|
-
* @throws {RequiredError}
|
|
8760
|
-
* @memberof TrajectoryPlanningApi
|
|
8761
|
-
*/
|
|
8762
|
-
getMotionGroupModelsForPlanning(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
|
|
8763
8656
|
/**
|
|
8764
8657
|
* Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the [PlanTrajectoryResponse](PlanTrajectoryResponse) will contain the joint trajectory up until the error, e.g. all samples until a collision occurs. 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.
|
|
8765
8658
|
* @summary Plan Trajectory
|