@wandelbots/nova-api 25.8.0-dev.8 → 25.8.0-dev.80
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 +597 -176
- package/v2/api.js +428 -75
- package/v2/api.js.map +1 -1
- package/v2/api.ts +806 -172
package/v1/api.ts
CHANGED
|
@@ -2821,6 +2821,12 @@ export interface KukaController {
|
|
|
2821
2821
|
* @memberof KukaController
|
|
2822
2822
|
*/
|
|
2823
2823
|
'rsiServer': KukaControllerRsiServer;
|
|
2824
|
+
/**
|
|
2825
|
+
* If true, uses slower cycle time of 12ms instead of 4ms.
|
|
2826
|
+
* @type {boolean}
|
|
2827
|
+
* @memberof KukaController
|
|
2828
|
+
*/
|
|
2829
|
+
'slow_cycle_rate'?: boolean;
|
|
2824
2830
|
}
|
|
2825
2831
|
|
|
2826
2832
|
export const KukaControllerKindEnum = {
|
|
@@ -7564,11 +7570,13 @@ export const VirtualControllerTypes = {
|
|
|
7564
7570
|
KukaKr4R600: 'kuka-kr4_r600',
|
|
7565
7571
|
KukaKr500L3403: 'kuka-kr500_l340_3',
|
|
7566
7572
|
KukaKr50R2500: 'kuka-kr50_r2500',
|
|
7573
|
+
KukaKr60R3: 'kuka-kr60_r3',
|
|
7567
7574
|
KukaKr6R1820: 'kuka-kr6_r1820',
|
|
7568
7575
|
KukaKr6R7002: 'kuka-kr6_r700_2',
|
|
7569
7576
|
KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
|
|
7570
7577
|
KukaKr6R900: 'kuka-kr6_r900',
|
|
7571
7578
|
KukaKr6R9002: 'kuka-kr6_r900_2',
|
|
7579
|
+
KukaKr70R2100: 'kuka-kr70_r2100',
|
|
7572
7580
|
KukaLbrIisy11R1300: 'kuka-lbr_iisy_11_r1300',
|
|
7573
7581
|
UniversalrobotsUr10cb: 'universalrobots-ur10cb',
|
|
7574
7582
|
UniversalrobotsUr10e: 'universalrobots-ur10e',
|
|
@@ -20640,7 +20648,7 @@ export const GetDefaultLinkChainMotionGroupModelEnum = {
|
|
|
20640
20648
|
FanucM900iB360E: 'FANUC_M900iB360E',
|
|
20641
20649
|
FanucR2000iC125L: 'FANUC_R2000iC125L',
|
|
20642
20650
|
FanucR2000iC210F: 'FANUC_R2000iC210F',
|
|
20643
|
-
|
|
20651
|
+
KukaDkp5002: 'KUKA_DKP500_2',
|
|
20644
20652
|
KukaKr10R1100: 'KUKA_KR10_R1100',
|
|
20645
20653
|
KukaKr10R11002: 'KUKA_KR10_R1100_2',
|
|
20646
20654
|
KukaKr10R900: 'KUKA_KR10_R900',
|
|
@@ -20674,11 +20682,13 @@ export const GetDefaultLinkChainMotionGroupModelEnum = {
|
|
|
20674
20682
|
KukaKr3R540: 'KUKA_KR3_R540',
|
|
20675
20683
|
KukaKr4R600: 'KUKA_KR4_R600',
|
|
20676
20684
|
KukaKr50R2500: 'KUKA_KR50_R2500',
|
|
20685
|
+
KukaKr60R3: 'KUKA_KR60_R3',
|
|
20677
20686
|
KukaKr6R1820: 'KUKA_KR6_R1820',
|
|
20678
20687
|
KukaKr6R700: 'KUKA_KR6_R700',
|
|
20679
20688
|
KukaKr6R7002: 'KUKA_KR6_R700_2',
|
|
20680
20689
|
KukaKr6R900: 'KUKA_KR6_R900',
|
|
20681
20690
|
KukaKr6R9002: 'KUKA_KR6_R900_2',
|
|
20691
|
+
KukaKr70R2100: 'KUKA_KR70_R2100',
|
|
20682
20692
|
KukaLbrIisy11R1300: 'KUKA_LBR_IISY_11_R1300',
|
|
20683
20693
|
UniversalRobotsUr10: 'UniversalRobots_UR10',
|
|
20684
20694
|
UniversalRobotsUr10e: 'UniversalRobots_UR10e',
|
|
@@ -23567,7 +23577,7 @@ export type SetOperationModeModeEnum = typeof SetOperationModeModeEnum[keyof typ
|
|
|
23567
23577
|
export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
23568
23578
|
return {
|
|
23569
23579
|
/**
|
|
23570
|
-
* Adds a coordinate system to the robot controller.
|
|
23580
|
+
* 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.
|
|
23571
23581
|
* @summary Add Coordinate Systems
|
|
23572
23582
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
23573
23583
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -23619,7 +23629,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
23619
23629
|
};
|
|
23620
23630
|
},
|
|
23621
23631
|
/**
|
|
23622
|
-
* 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
|
|
23632
|
+
* 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.
|
|
23623
23633
|
* @summary Add TCP
|
|
23624
23634
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
23625
23635
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -23675,7 +23685,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
23675
23685
|
};
|
|
23676
23686
|
},
|
|
23677
23687
|
/**
|
|
23678
|
-
* 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.
|
|
23688
|
+
* 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.
|
|
23679
23689
|
* @summary Remove Coordinate System
|
|
23680
23690
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
23681
23691
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -23730,7 +23740,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
23730
23740
|
};
|
|
23731
23741
|
},
|
|
23732
23742
|
/**
|
|
23733
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
23743
|
+
* 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.
|
|
23734
23744
|
* @summary Remove TCP
|
|
23735
23745
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
23736
23746
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -23930,7 +23940,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
|
|
|
23930
23940
|
};
|
|
23931
23941
|
},
|
|
23932
23942
|
/**
|
|
23933
|
-
* 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
|
|
23943
|
+
* 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.
|
|
23934
23944
|
* @summary Set Mounting
|
|
23935
23945
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
23936
23946
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -23996,7 +24006,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
|
|
|
23996
24006
|
const localVarAxiosParamCreator = VirtualRobotSetupApiAxiosParamCreator(configuration)
|
|
23997
24007
|
return {
|
|
23998
24008
|
/**
|
|
23999
|
-
* Adds a coordinate system to the robot controller.
|
|
24009
|
+
* 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.
|
|
24000
24010
|
* @summary Add Coordinate Systems
|
|
24001
24011
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24002
24012
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24011,7 +24021,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
|
|
|
24011
24021
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24012
24022
|
},
|
|
24013
24023
|
/**
|
|
24014
|
-
* 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
|
|
24024
|
+
* 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.
|
|
24015
24025
|
* @summary Add TCP
|
|
24016
24026
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24017
24027
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24027,7 +24037,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
|
|
|
24027
24037
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24028
24038
|
},
|
|
24029
24039
|
/**
|
|
24030
|
-
* 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.
|
|
24040
|
+
* 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.
|
|
24031
24041
|
* @summary Remove Coordinate System
|
|
24032
24042
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24033
24043
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24043,7 +24053,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
|
|
|
24043
24053
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24044
24054
|
},
|
|
24045
24055
|
/**
|
|
24046
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
24056
|
+
* 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.
|
|
24047
24057
|
* @summary Remove TCP
|
|
24048
24058
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24049
24059
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24103,7 +24113,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
|
|
|
24103
24113
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24104
24114
|
},
|
|
24105
24115
|
/**
|
|
24106
|
-
* 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
|
|
24116
|
+
* 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.
|
|
24107
24117
|
* @summary Set Mounting
|
|
24108
24118
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24109
24119
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24129,7 +24139,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
|
|
|
24129
24139
|
const localVarFp = VirtualRobotSetupApiFp(configuration)
|
|
24130
24140
|
return {
|
|
24131
24141
|
/**
|
|
24132
|
-
* Adds a coordinate system to the robot controller.
|
|
24142
|
+
* 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.
|
|
24133
24143
|
* @summary Add Coordinate Systems
|
|
24134
24144
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24135
24145
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24141,7 +24151,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
|
|
|
24141
24151
|
return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
24142
24152
|
},
|
|
24143
24153
|
/**
|
|
24144
|
-
* 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
|
|
24154
|
+
* 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.
|
|
24145
24155
|
* @summary Add TCP
|
|
24146
24156
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24147
24157
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24154,7 +24164,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
|
|
|
24154
24164
|
return localVarFp.addVirtualRobotTcp(cell, controller, id, robotTcp, options).then((request) => request(axios, basePath));
|
|
24155
24165
|
},
|
|
24156
24166
|
/**
|
|
24157
|
-
* 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.
|
|
24167
|
+
* 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.
|
|
24158
24168
|
* @summary Remove Coordinate System
|
|
24159
24169
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24160
24170
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24167,7 +24177,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
|
|
|
24167
24177
|
return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
24168
24178
|
},
|
|
24169
24179
|
/**
|
|
24170
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
24180
|
+
* 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.
|
|
24171
24181
|
* @summary Remove TCP
|
|
24172
24182
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24173
24183
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24215,7 +24225,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
|
|
|
24215
24225
|
return localVarFp.listVirtualRobotTcps(cell, controller, id, options).then((request) => request(axios, basePath));
|
|
24216
24226
|
},
|
|
24217
24227
|
/**
|
|
24218
|
-
* 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
|
|
24228
|
+
* 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.
|
|
24219
24229
|
* @summary Set Mounting
|
|
24220
24230
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24221
24231
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24238,7 +24248,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
|
|
|
24238
24248
|
*/
|
|
24239
24249
|
export class VirtualRobotSetupApi extends BaseAPI {
|
|
24240
24250
|
/**
|
|
24241
|
-
* Adds a coordinate system to the robot controller.
|
|
24251
|
+
* 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.
|
|
24242
24252
|
* @summary Add Coordinate Systems
|
|
24243
24253
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24244
24254
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24252,7 +24262,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
24252
24262
|
}
|
|
24253
24263
|
|
|
24254
24264
|
/**
|
|
24255
|
-
* 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
|
|
24265
|
+
* 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.
|
|
24256
24266
|
* @summary Add TCP
|
|
24257
24267
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24258
24268
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24267,7 +24277,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
24267
24277
|
}
|
|
24268
24278
|
|
|
24269
24279
|
/**
|
|
24270
|
-
* 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.
|
|
24280
|
+
* 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.
|
|
24271
24281
|
* @summary Remove Coordinate System
|
|
24272
24282
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24273
24283
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24282,7 +24292,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
24282
24292
|
}
|
|
24283
24293
|
|
|
24284
24294
|
/**
|
|
24285
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
24295
|
+
* 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.
|
|
24286
24296
|
* @summary Remove TCP
|
|
24287
24297
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24288
24298
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -24338,7 +24348,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
24338
24348
|
}
|
|
24339
24349
|
|
|
24340
24350
|
/**
|
|
24341
|
-
* 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
|
|
24351
|
+
* 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.
|
|
24342
24352
|
* @summary Set Mounting
|
|
24343
24353
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
24344
24354
|
* @param {string} controller Unique identifier to address a controller in the cell.
|