@wandelbots/nova-api 25.8.0-dev.9 → 25.8.0-dev.91
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/v1/api.d.ts +31 -21
- package/v1/api.js +25 -21
- package/v1/api.js.map +1 -1
- package/v1/api.ts +31 -21
- package/v2/api.d.ts +631 -176
- package/v2/api.js +437 -75
- package/v2/api.js.map +1 -1
- package/v2/api.ts +857 -183
package/package.json
CHANGED
package/v1/api.d.ts
CHANGED
|
@@ -2774,6 +2774,12 @@ export interface KukaController {
|
|
|
2774
2774
|
* @memberof KukaController
|
|
2775
2775
|
*/
|
|
2776
2776
|
'rsiServer': KukaControllerRsiServer;
|
|
2777
|
+
/**
|
|
2778
|
+
* If true, uses slower cycle time of 12ms instead of 4ms.
|
|
2779
|
+
* @type {boolean}
|
|
2780
|
+
* @memberof KukaController
|
|
2781
|
+
*/
|
|
2782
|
+
'slow_cycle_rate'?: boolean;
|
|
2777
2783
|
}
|
|
2778
2784
|
export declare const KukaControllerKindEnum: {
|
|
2779
2785
|
readonly KukaController: "KukaController";
|
|
@@ -7393,11 +7399,13 @@ export declare const VirtualControllerTypes: {
|
|
|
7393
7399
|
readonly KukaKr4R600: "kuka-kr4_r600";
|
|
7394
7400
|
readonly KukaKr500L3403: "kuka-kr500_l340_3";
|
|
7395
7401
|
readonly KukaKr50R2500: "kuka-kr50_r2500";
|
|
7402
|
+
readonly KukaKr60R3: "kuka-kr60_r3";
|
|
7396
7403
|
readonly KukaKr6R1820: "kuka-kr6_r1820";
|
|
7397
7404
|
readonly KukaKr6R7002: "kuka-kr6_r700_2";
|
|
7398
7405
|
readonly KukaKr6R700Sixx: "kuka-kr6_r700_sixx";
|
|
7399
7406
|
readonly KukaKr6R900: "kuka-kr6_r900";
|
|
7400
7407
|
readonly KukaKr6R9002: "kuka-kr6_r900_2";
|
|
7408
|
+
readonly KukaKr70R2100: "kuka-kr70_r2100";
|
|
7401
7409
|
readonly KukaLbrIisy11R1300: "kuka-lbr_iisy_11_r1300";
|
|
7402
7410
|
readonly UniversalrobotsUr10cb: "universalrobots-ur10cb";
|
|
7403
7411
|
readonly UniversalrobotsUr10e: "universalrobots-ur10e";
|
|
@@ -13505,7 +13513,7 @@ export declare const GetDefaultLinkChainMotionGroupModelEnum: {
|
|
|
13505
13513
|
readonly FanucM900iB360E: "FANUC_M900iB360E";
|
|
13506
13514
|
readonly FanucR2000iC125L: "FANUC_R2000iC125L";
|
|
13507
13515
|
readonly FanucR2000iC210F: "FANUC_R2000iC210F";
|
|
13508
|
-
readonly
|
|
13516
|
+
readonly KukaDkp5002: "KUKA_DKP500_2";
|
|
13509
13517
|
readonly KukaKr10R1100: "KUKA_KR10_R1100";
|
|
13510
13518
|
readonly KukaKr10R11002: "KUKA_KR10_R1100_2";
|
|
13511
13519
|
readonly KukaKr10R900: "KUKA_KR10_R900";
|
|
@@ -13539,11 +13547,13 @@ export declare const GetDefaultLinkChainMotionGroupModelEnum: {
|
|
|
13539
13547
|
readonly KukaKr3R540: "KUKA_KR3_R540";
|
|
13540
13548
|
readonly KukaKr4R600: "KUKA_KR4_R600";
|
|
13541
13549
|
readonly KukaKr50R2500: "KUKA_KR50_R2500";
|
|
13550
|
+
readonly KukaKr60R3: "KUKA_KR60_R3";
|
|
13542
13551
|
readonly KukaKr6R1820: "KUKA_KR6_R1820";
|
|
13543
13552
|
readonly KukaKr6R700: "KUKA_KR6_R700";
|
|
13544
13553
|
readonly KukaKr6R7002: "KUKA_KR6_R700_2";
|
|
13545
13554
|
readonly KukaKr6R900: "KUKA_KR6_R900";
|
|
13546
13555
|
readonly KukaKr6R9002: "KUKA_KR6_R900_2";
|
|
13556
|
+
readonly KukaKr70R2100: "KUKA_KR70_R2100";
|
|
13547
13557
|
readonly KukaLbrIisy11R1300: "KUKA_LBR_IISY_11_R1300";
|
|
13548
13558
|
readonly UniversalRobotsUr10: "UniversalRobots_UR10";
|
|
13549
13559
|
readonly UniversalRobotsUr10e: "UniversalRobots_UR10e";
|
|
@@ -14915,7 +14925,7 @@ export type SetOperationModeModeEnum = typeof SetOperationModeModeEnum[keyof typ
|
|
|
14915
14925
|
*/
|
|
14916
14926
|
export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14917
14927
|
/**
|
|
14918
|
-
* Adds a coordinate system to the robot controller.
|
|
14928
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
14919
14929
|
* @summary Add Coordinate Systems
|
|
14920
14930
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14921
14931
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14925,7 +14935,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
14925
14935
|
*/
|
|
14926
14936
|
addVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14927
14937
|
/**
|
|
14928
|
-
* 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
|
|
14938
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#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. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
14929
14939
|
* @summary Add TCP
|
|
14930
14940
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14931
14941
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14936,7 +14946,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
14936
14946
|
*/
|
|
14937
14947
|
addVirtualRobotTcp: (cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14938
14948
|
/**
|
|
14939
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
14949
|
+
* 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 which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the 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 > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
14940
14950
|
* @summary Remove Coordinate System
|
|
14941
14951
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14942
14952
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14947,7 +14957,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
14947
14957
|
*/
|
|
14948
14958
|
deleteVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14949
14959
|
/**
|
|
14950
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
14960
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
14951
14961
|
* @summary Remove TCP
|
|
14952
14962
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14953
14963
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14987,7 +14997,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
14987
14997
|
*/
|
|
14988
14998
|
listVirtualRobotTcps: (cell: string, controller: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14989
14999
|
/**
|
|
14990
|
-
* Sets 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
|
|
15000
|
+
* 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 name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
14991
15001
|
* @summary Set Mounting
|
|
14992
15002
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14993
15003
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15004,7 +15014,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
15004
15014
|
*/
|
|
15005
15015
|
export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) => {
|
|
15006
15016
|
/**
|
|
15007
|
-
* Adds a coordinate system to the robot controller.
|
|
15017
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15008
15018
|
* @summary Add Coordinate Systems
|
|
15009
15019
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15010
15020
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15014,7 +15024,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15014
15024
|
*/
|
|
15015
15025
|
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15016
15026
|
/**
|
|
15017
|
-
* 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
|
|
15027
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#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. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15018
15028
|
* @summary Add TCP
|
|
15019
15029
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15020
15030
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15025,7 +15035,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15025
15035
|
*/
|
|
15026
15036
|
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15027
15037
|
/**
|
|
15028
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15038
|
+
* 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 which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the 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 > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15029
15039
|
* @summary Remove Coordinate System
|
|
15030
15040
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15031
15041
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15036,7 +15046,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15036
15046
|
*/
|
|
15037
15047
|
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15038
15048
|
/**
|
|
15039
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15049
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15040
15050
|
* @summary Remove TCP
|
|
15041
15051
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15042
15052
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15076,7 +15086,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15076
15086
|
*/
|
|
15077
15087
|
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotTcps>>;
|
|
15078
15088
|
/**
|
|
15079
|
-
* Sets 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
|
|
15089
|
+
* 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 name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15080
15090
|
* @summary Set Mounting
|
|
15081
15091
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15082
15092
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15093,7 +15103,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15093
15103
|
*/
|
|
15094
15104
|
export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15095
15105
|
/**
|
|
15096
|
-
* Adds a coordinate system to the robot controller.
|
|
15106
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15097
15107
|
* @summary Add Coordinate Systems
|
|
15098
15108
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15099
15109
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15103,7 +15113,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15103
15113
|
*/
|
|
15104
15114
|
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15105
15115
|
/**
|
|
15106
|
-
* 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
|
|
15116
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#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. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15107
15117
|
* @summary Add TCP
|
|
15108
15118
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15109
15119
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15114,7 +15124,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15114
15124
|
*/
|
|
15115
15125
|
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15116
15126
|
/**
|
|
15117
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15127
|
+
* 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 which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the 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 > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15118
15128
|
* @summary Remove Coordinate System
|
|
15119
15129
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15120
15130
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15125,7 +15135,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15125
15135
|
*/
|
|
15126
15136
|
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15127
15137
|
/**
|
|
15128
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15138
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15129
15139
|
* @summary Remove TCP
|
|
15130
15140
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15131
15141
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15165,7 +15175,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15165
15175
|
*/
|
|
15166
15176
|
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotTcps>;
|
|
15167
15177
|
/**
|
|
15168
|
-
* Sets 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
|
|
15178
|
+
* 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 name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15169
15179
|
* @summary Set Mounting
|
|
15170
15180
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15171
15181
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15184,7 +15194,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15184
15194
|
*/
|
|
15185
15195
|
export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
15186
15196
|
/**
|
|
15187
|
-
* Adds a coordinate system to the robot controller.
|
|
15197
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15188
15198
|
* @summary Add Coordinate Systems
|
|
15189
15199
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15190
15200
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15195,7 +15205,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15195
15205
|
*/
|
|
15196
15206
|
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15197
15207
|
/**
|
|
15198
|
-
* 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
|
|
15208
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#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. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15199
15209
|
* @summary Add TCP
|
|
15200
15210
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15201
15211
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15207,7 +15217,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15207
15217
|
*/
|
|
15208
15218
|
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15209
15219
|
/**
|
|
15210
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15220
|
+
* 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 which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the 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 > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15211
15221
|
* @summary Remove Coordinate System
|
|
15212
15222
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15213
15223
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15219,7 +15229,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15219
15229
|
*/
|
|
15220
15230
|
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15221
15231
|
/**
|
|
15222
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15232
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15223
15233
|
* @summary Remove TCP
|
|
15224
15234
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15225
15235
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15263,7 +15273,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15263
15273
|
*/
|
|
15264
15274
|
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcps, any>>;
|
|
15265
15275
|
/**
|
|
15266
|
-
* Sets 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
|
|
15276
|
+
* 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 name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15267
15277
|
* @summary Set Mounting
|
|
15268
15278
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15269
15279
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
package/v1/api.js
CHANGED
|
@@ -510,11 +510,13 @@ export const VirtualControllerTypes = {
|
|
|
510
510
|
KukaKr4R600: 'kuka-kr4_r600',
|
|
511
511
|
KukaKr500L3403: 'kuka-kr500_l340_3',
|
|
512
512
|
KukaKr50R2500: 'kuka-kr50_r2500',
|
|
513
|
+
KukaKr60R3: 'kuka-kr60_r3',
|
|
513
514
|
KukaKr6R1820: 'kuka-kr6_r1820',
|
|
514
515
|
KukaKr6R7002: 'kuka-kr6_r700_2',
|
|
515
516
|
KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
|
|
516
517
|
KukaKr6R900: 'kuka-kr6_r900',
|
|
517
518
|
KukaKr6R9002: 'kuka-kr6_r900_2',
|
|
519
|
+
KukaKr70R2100: 'kuka-kr70_r2100',
|
|
518
520
|
KukaLbrIisy11R1300: 'kuka-lbr_iisy_11_r1300',
|
|
519
521
|
UniversalrobotsUr10cb: 'universalrobots-ur10cb',
|
|
520
522
|
UniversalrobotsUr10e: 'universalrobots-ur10e',
|
|
@@ -12228,7 +12230,7 @@ export const GetDefaultLinkChainMotionGroupModelEnum = {
|
|
|
12228
12230
|
FanucM900iB360E: 'FANUC_M900iB360E',
|
|
12229
12231
|
FanucR2000iC125L: 'FANUC_R2000iC125L',
|
|
12230
12232
|
FanucR2000iC210F: 'FANUC_R2000iC210F',
|
|
12231
|
-
|
|
12233
|
+
KukaDkp5002: 'KUKA_DKP500_2',
|
|
12232
12234
|
KukaKr10R1100: 'KUKA_KR10_R1100',
|
|
12233
12235
|
KukaKr10R11002: 'KUKA_KR10_R1100_2',
|
|
12234
12236
|
KukaKr10R900: 'KUKA_KR10_R900',
|
|
@@ -12262,11 +12264,13 @@ export const GetDefaultLinkChainMotionGroupModelEnum = {
|
|
|
12262
12264
|
KukaKr3R540: 'KUKA_KR3_R540',
|
|
12263
12265
|
KukaKr4R600: 'KUKA_KR4_R600',
|
|
12264
12266
|
KukaKr50R2500: 'KUKA_KR50_R2500',
|
|
12267
|
+
KukaKr60R3: 'KUKA_KR60_R3',
|
|
12265
12268
|
KukaKr6R1820: 'KUKA_KR6_R1820',
|
|
12266
12269
|
KukaKr6R700: 'KUKA_KR6_R700',
|
|
12267
12270
|
KukaKr6R7002: 'KUKA_KR6_R700_2',
|
|
12268
12271
|
KukaKr6R900: 'KUKA_KR6_R900',
|
|
12269
12272
|
KukaKr6R9002: 'KUKA_KR6_R900_2',
|
|
12273
|
+
KukaKr70R2100: 'KUKA_KR70_R2100',
|
|
12270
12274
|
KukaLbrIisy11R1300: 'KUKA_LBR_IISY_11_R1300',
|
|
12271
12275
|
UniversalRobotsUr10: 'UniversalRobots_UR10',
|
|
12272
12276
|
UniversalRobotsUr10e: 'UniversalRobots_UR10e',
|
|
@@ -14869,7 +14873,7 @@ export const SetOperationModeModeEnum = {
|
|
|
14869
14873
|
export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
14870
14874
|
return {
|
|
14871
14875
|
/**
|
|
14872
|
-
* Adds a coordinate system to the robot controller.
|
|
14876
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
14873
14877
|
* @summary Add Coordinate Systems
|
|
14874
14878
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14875
14879
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14913,7 +14917,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
14913
14917
|
};
|
|
14914
14918
|
},
|
|
14915
14919
|
/**
|
|
14916
|
-
* 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
|
|
14920
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#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. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
14917
14921
|
* @summary Add TCP
|
|
14918
14922
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14919
14923
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14961,7 +14965,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
14961
14965
|
};
|
|
14962
14966
|
},
|
|
14963
14967
|
/**
|
|
14964
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
14968
|
+
* 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 which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the 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 > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
14965
14969
|
* @summary Remove Coordinate System
|
|
14966
14970
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14967
14971
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15008,7 +15012,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
15008
15012
|
};
|
|
15009
15013
|
},
|
|
15010
15014
|
/**
|
|
15011
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15015
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15012
15016
|
* @summary Remove TCP
|
|
15013
15017
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15014
15018
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15180,7 +15184,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
15180
15184
|
};
|
|
15181
15185
|
},
|
|
15182
15186
|
/**
|
|
15183
|
-
* Sets 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
|
|
15187
|
+
* 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 name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15184
15188
|
* @summary Set Mounting
|
|
15185
15189
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15186
15190
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15237,7 +15241,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15237
15241
|
const localVarAxiosParamCreator = VirtualRobotSetupApiAxiosParamCreator(configuration);
|
|
15238
15242
|
return {
|
|
15239
15243
|
/**
|
|
15240
|
-
* Adds a coordinate system to the robot controller.
|
|
15244
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15241
15245
|
* @summary Add Coordinate Systems
|
|
15242
15246
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15243
15247
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15252,7 +15256,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15252
15256
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15253
15257
|
},
|
|
15254
15258
|
/**
|
|
15255
|
-
* 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
|
|
15259
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#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. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15256
15260
|
* @summary Add TCP
|
|
15257
15261
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15258
15262
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15268,7 +15272,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15268
15272
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15269
15273
|
},
|
|
15270
15274
|
/**
|
|
15271
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15275
|
+
* 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 which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the 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 > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15272
15276
|
* @summary Remove Coordinate System
|
|
15273
15277
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15274
15278
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15284,7 +15288,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15284
15288
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15285
15289
|
},
|
|
15286
15290
|
/**
|
|
15287
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15291
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15288
15292
|
* @summary Remove TCP
|
|
15289
15293
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15290
15294
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15344,7 +15348,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15344
15348
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15345
15349
|
},
|
|
15346
15350
|
/**
|
|
15347
|
-
* Sets 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
|
|
15351
|
+
* 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 name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15348
15352
|
* @summary Set Mounting
|
|
15349
15353
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15350
15354
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15369,7 +15373,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15369
15373
|
const localVarFp = VirtualRobotSetupApiFp(configuration);
|
|
15370
15374
|
return {
|
|
15371
15375
|
/**
|
|
15372
|
-
* Adds a coordinate system to the robot controller.
|
|
15376
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15373
15377
|
* @summary Add Coordinate Systems
|
|
15374
15378
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15375
15379
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15381,7 +15385,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15381
15385
|
return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
15382
15386
|
},
|
|
15383
15387
|
/**
|
|
15384
|
-
* 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
|
|
15388
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#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. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15385
15389
|
* @summary Add TCP
|
|
15386
15390
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15387
15391
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15394,7 +15398,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15394
15398
|
return localVarFp.addVirtualRobotTcp(cell, controller, id, robotTcp, options).then((request) => request(axios, basePath));
|
|
15395
15399
|
},
|
|
15396
15400
|
/**
|
|
15397
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15401
|
+
* 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 which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the 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 > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15398
15402
|
* @summary Remove Coordinate System
|
|
15399
15403
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15400
15404
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15407,7 +15411,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15407
15411
|
return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
15408
15412
|
},
|
|
15409
15413
|
/**
|
|
15410
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15414
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15411
15415
|
* @summary Remove TCP
|
|
15412
15416
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15413
15417
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15455,7 +15459,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15455
15459
|
return localVarFp.listVirtualRobotTcps(cell, controller, id, options).then((request) => request(axios, basePath));
|
|
15456
15460
|
},
|
|
15457
15461
|
/**
|
|
15458
|
-
* Sets 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
|
|
15462
|
+
* 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 name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15459
15463
|
* @summary Set Mounting
|
|
15460
15464
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15461
15465
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15477,7 +15481,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15477
15481
|
*/
|
|
15478
15482
|
export class VirtualRobotSetupApi extends BaseAPI {
|
|
15479
15483
|
/**
|
|
15480
|
-
* Adds a coordinate system to the robot controller.
|
|
15484
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15481
15485
|
* @summary Add Coordinate Systems
|
|
15482
15486
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15483
15487
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15490,7 +15494,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15490
15494
|
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
15491
15495
|
}
|
|
15492
15496
|
/**
|
|
15493
|
-
* 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
|
|
15497
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#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. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15494
15498
|
* @summary Add TCP
|
|
15495
15499
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15496
15500
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15504,7 +15508,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15504
15508
|
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotTcp(cell, controller, id, robotTcp, options).then((request) => request(this.axios, this.basePath));
|
|
15505
15509
|
}
|
|
15506
15510
|
/**
|
|
15507
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15511
|
+
* 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 which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the 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 > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15508
15512
|
* @summary Remove Coordinate System
|
|
15509
15513
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15510
15514
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15518,7 +15522,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15518
15522
|
return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
15519
15523
|
}
|
|
15520
15524
|
/**
|
|
15521
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15525
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15522
15526
|
* @summary Remove TCP
|
|
15523
15527
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15524
15528
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15570,7 +15574,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15570
15574
|
return VirtualRobotSetupApiFp(this.configuration).listVirtualRobotTcps(cell, controller, id, options).then((request) => request(this.axios, this.basePath));
|
|
15571
15575
|
}
|
|
15572
15576
|
/**
|
|
15573
|
-
* Sets 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
|
|
15577
|
+
* 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 name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15574
15578
|
* @summary Set Mounting
|
|
15575
15579
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15576
15580
|
* @param {string} controller Unique identifier to address a controller in the cell.
|