@wandelbots/nova-api 25.8.0-dev.75 → 25.8.0-dev.77
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 +20 -20
- package/v1/api.js +20 -20
- package/v1/api.ts +20 -20
- package/v2/api.d.ts +24 -24
- package/v2/api.js +24 -24
- package/v2/api.ts +24 -24
package/v2/api.js
CHANGED
|
@@ -8973,7 +8973,7 @@ export class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8973
8973
|
export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
8974
8974
|
return {
|
|
8975
8975
|
/**
|
|
8976
|
-
* Adds a coordinate system to the robot controller.
|
|
8976
|
+
* Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
|
|
8977
8977
|
* @summary Add Coordinate Systems
|
|
8978
8978
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8979
8979
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9021,7 +9021,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
9021
9021
|
};
|
|
9022
9022
|
},
|
|
9023
9023
|
/**
|
|
9024
|
-
* 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
|
|
9024
|
+
* Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
9025
9025
|
* @summary Add TCP
|
|
9026
9026
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9027
9027
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9073,8 +9073,8 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
9073
9073
|
};
|
|
9074
9074
|
},
|
|
9075
9075
|
/**
|
|
9076
|
-
* 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
|
|
9077
|
-
* @summary
|
|
9076
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **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 available for visualization or program execution.
|
|
9077
|
+
* @summary Delete Coordinate System
|
|
9078
9078
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9079
9079
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9080
9080
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9120,7 +9120,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
9120
9120
|
};
|
|
9121
9121
|
},
|
|
9122
9122
|
/**
|
|
9123
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9123
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
9124
9124
|
* @summary Remove TCP
|
|
9125
9125
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9126
9126
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9588,7 +9588,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
9588
9588
|
};
|
|
9589
9589
|
},
|
|
9590
9590
|
/**
|
|
9591
|
-
* 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
|
|
9591
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
9592
9592
|
* @summary Set Mounting
|
|
9593
9593
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9594
9594
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9645,7 +9645,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9645
9645
|
const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration);
|
|
9646
9646
|
return {
|
|
9647
9647
|
/**
|
|
9648
|
-
* Adds a coordinate system to the robot controller.
|
|
9648
|
+
* Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
|
|
9649
9649
|
* @summary Add Coordinate Systems
|
|
9650
9650
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9651
9651
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9661,7 +9661,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9661
9661
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9662
9662
|
},
|
|
9663
9663
|
/**
|
|
9664
|
-
* 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
|
|
9664
|
+
* Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
9665
9665
|
* @summary Add TCP
|
|
9666
9666
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9667
9667
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9678,8 +9678,8 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9678
9678
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9679
9679
|
},
|
|
9680
9680
|
/**
|
|
9681
|
-
* 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
|
|
9682
|
-
* @summary
|
|
9681
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **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 available for visualization or program execution.
|
|
9682
|
+
* @summary Delete Coordinate System
|
|
9683
9683
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9684
9684
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9685
9685
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9694,7 +9694,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9694
9694
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9695
9695
|
},
|
|
9696
9696
|
/**
|
|
9697
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9697
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
9698
9698
|
* @summary Remove TCP
|
|
9699
9699
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9700
9700
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9857,7 +9857,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9857
9857
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9858
9858
|
},
|
|
9859
9859
|
/**
|
|
9860
|
-
* 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
|
|
9860
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
9861
9861
|
* @summary Set Mounting
|
|
9862
9862
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9863
9863
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9882,7 +9882,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9882
9882
|
const localVarFp = VirtualControllerApiFp(configuration);
|
|
9883
9883
|
return {
|
|
9884
9884
|
/**
|
|
9885
|
-
* Adds a coordinate system to the robot controller.
|
|
9885
|
+
* Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
|
|
9886
9886
|
* @summary Add Coordinate Systems
|
|
9887
9887
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9888
9888
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9895,7 +9895,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9895
9895
|
return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
|
|
9896
9896
|
},
|
|
9897
9897
|
/**
|
|
9898
|
-
* 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
|
|
9898
|
+
* Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
9899
9899
|
* @summary Add TCP
|
|
9900
9900
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9901
9901
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9909,8 +9909,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9909
9909
|
return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
|
|
9910
9910
|
},
|
|
9911
9911
|
/**
|
|
9912
|
-
* 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
|
|
9913
|
-
* @summary
|
|
9912
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **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 available for visualization or program execution.
|
|
9913
|
+
* @summary Delete Coordinate System
|
|
9914
9914
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9915
9915
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9916
9916
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9922,7 +9922,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9922
9922
|
return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
9923
9923
|
},
|
|
9924
9924
|
/**
|
|
9925
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9925
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
9926
9926
|
* @summary Remove TCP
|
|
9927
9927
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9928
9928
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -10052,7 +10052,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
10052
10052
|
return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
|
|
10053
10053
|
},
|
|
10054
10054
|
/**
|
|
10055
|
-
* 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
|
|
10055
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
10056
10056
|
* @summary Set Mounting
|
|
10057
10057
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10058
10058
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -10074,7 +10074,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
10074
10074
|
*/
|
|
10075
10075
|
export class VirtualControllerApi extends BaseAPI {
|
|
10076
10076
|
/**
|
|
10077
|
-
* Adds a coordinate system to the robot controller.
|
|
10077
|
+
* Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
|
|
10078
10078
|
* @summary Add Coordinate Systems
|
|
10079
10079
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10080
10080
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -10088,7 +10088,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
10088
10088
|
return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
10089
10089
|
}
|
|
10090
10090
|
/**
|
|
10091
|
-
* 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
|
|
10091
|
+
* Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
10092
10092
|
* @summary Add TCP
|
|
10093
10093
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10094
10094
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -10103,8 +10103,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
10103
10103
|
return VirtualControllerApiFp(this.configuration).addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(this.axios, this.basePath));
|
|
10104
10104
|
}
|
|
10105
10105
|
/**
|
|
10106
|
-
* 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
|
|
10107
|
-
* @summary
|
|
10106
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **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 available for visualization or program execution.
|
|
10107
|
+
* @summary Delete Coordinate System
|
|
10108
10108
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10109
10109
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
10110
10110
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -10117,7 +10117,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
10117
10117
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
10118
10118
|
}
|
|
10119
10119
|
/**
|
|
10120
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
10120
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
10121
10121
|
* @summary Remove TCP
|
|
10122
10122
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10123
10123
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -10258,7 +10258,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
10258
10258
|
return VirtualControllerApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
10259
10259
|
}
|
|
10260
10260
|
/**
|
|
10261
|
-
* 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
|
|
10261
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
10262
10262
|
* @summary Set Mounting
|
|
10263
10263
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
10264
10264
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
package/v2/api.ts
CHANGED
|
@@ -15087,7 +15087,7 @@ export class TrajectoryPlanningApi extends BaseAPI {
|
|
|
15087
15087
|
export const VirtualControllerApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
15088
15088
|
return {
|
|
15089
15089
|
/**
|
|
15090
|
-
* Adds a coordinate system to the robot controller.
|
|
15090
|
+
* Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
|
|
15091
15091
|
* @summary Add Coordinate Systems
|
|
15092
15092
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15093
15093
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15143,7 +15143,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
|
|
|
15143
15143
|
};
|
|
15144
15144
|
},
|
|
15145
15145
|
/**
|
|
15146
|
-
* 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
|
|
15146
|
+
* Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
15147
15147
|
* @summary Add TCP
|
|
15148
15148
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15149
15149
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15203,8 +15203,8 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
|
|
|
15203
15203
|
};
|
|
15204
15204
|
},
|
|
15205
15205
|
/**
|
|
15206
|
-
* 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
|
|
15207
|
-
* @summary
|
|
15206
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **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 available for visualization or program execution.
|
|
15207
|
+
* @summary Delete Coordinate System
|
|
15208
15208
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15209
15209
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
15210
15210
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -15258,7 +15258,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
|
|
|
15258
15258
|
};
|
|
15259
15259
|
},
|
|
15260
15260
|
/**
|
|
15261
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15261
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
15262
15262
|
* @summary Remove TCP
|
|
15263
15263
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15264
15264
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15806,7 +15806,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration?: C
|
|
|
15806
15806
|
};
|
|
15807
15807
|
},
|
|
15808
15808
|
/**
|
|
15809
|
-
* 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
|
|
15809
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
15810
15810
|
* @summary Set Mounting
|
|
15811
15811
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15812
15812
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15872,7 +15872,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
|
|
|
15872
15872
|
const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration)
|
|
15873
15873
|
return {
|
|
15874
15874
|
/**
|
|
15875
|
-
* Adds a coordinate system to the robot controller.
|
|
15875
|
+
* Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
|
|
15876
15876
|
* @summary Add Coordinate Systems
|
|
15877
15877
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15878
15878
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15888,7 +15888,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
|
|
|
15888
15888
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15889
15889
|
},
|
|
15890
15890
|
/**
|
|
15891
|
-
* 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
|
|
15891
|
+
* Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
15892
15892
|
* @summary Add TCP
|
|
15893
15893
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15894
15894
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15905,8 +15905,8 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
|
|
|
15905
15905
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15906
15906
|
},
|
|
15907
15907
|
/**
|
|
15908
|
-
* 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
|
|
15909
|
-
* @summary
|
|
15908
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **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 available for visualization or program execution.
|
|
15909
|
+
* @summary Delete Coordinate System
|
|
15910
15910
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15911
15911
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
15912
15912
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -15921,7 +15921,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
|
|
|
15921
15921
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15922
15922
|
},
|
|
15923
15923
|
/**
|
|
15924
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15924
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
15925
15925
|
* @summary Remove TCP
|
|
15926
15926
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15927
15927
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16084,7 +16084,7 @@ export const VirtualControllerApiFp = function(configuration?: Configuration) {
|
|
|
16084
16084
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
16085
16085
|
},
|
|
16086
16086
|
/**
|
|
16087
|
-
* 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
|
|
16087
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
16088
16088
|
* @summary Set Mounting
|
|
16089
16089
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16090
16090
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16110,7 +16110,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
|
|
|
16110
16110
|
const localVarFp = VirtualControllerApiFp(configuration)
|
|
16111
16111
|
return {
|
|
16112
16112
|
/**
|
|
16113
|
-
* Adds a coordinate system to the robot controller.
|
|
16113
|
+
* Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
|
|
16114
16114
|
* @summary Add Coordinate Systems
|
|
16115
16115
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16116
16116
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16123,7 +16123,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
|
|
|
16123
16123
|
return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
|
|
16124
16124
|
},
|
|
16125
16125
|
/**
|
|
16126
|
-
* 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
|
|
16126
|
+
* Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
16127
16127
|
* @summary Add TCP
|
|
16128
16128
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16129
16129
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16137,8 +16137,8 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
|
|
|
16137
16137
|
return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
|
|
16138
16138
|
},
|
|
16139
16139
|
/**
|
|
16140
|
-
* 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
|
|
16141
|
-
* @summary
|
|
16140
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **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 available for visualization or program execution.
|
|
16141
|
+
* @summary Delete Coordinate System
|
|
16142
16142
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16143
16143
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
16144
16144
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -16150,7 +16150,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
|
|
|
16150
16150
|
return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
16151
16151
|
},
|
|
16152
16152
|
/**
|
|
16153
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
16153
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
16154
16154
|
* @summary Remove TCP
|
|
16155
16155
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16156
16156
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16280,7 +16280,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
|
|
|
16280
16280
|
return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
|
|
16281
16281
|
},
|
|
16282
16282
|
/**
|
|
16283
|
-
* 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
|
|
16283
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
16284
16284
|
* @summary Set Mounting
|
|
16285
16285
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16286
16286
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16303,7 +16303,7 @@ export const VirtualControllerApiFactory = function (configuration?: Configurati
|
|
|
16303
16303
|
*/
|
|
16304
16304
|
export class VirtualControllerApi extends BaseAPI {
|
|
16305
16305
|
/**
|
|
16306
|
-
* Adds a coordinate system to the robot controller.
|
|
16306
|
+
* Adds a coordinate system to the robot controller. **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 available for visualization or program execution.
|
|
16307
16307
|
* @summary Add Coordinate Systems
|
|
16308
16308
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16309
16309
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16318,7 +16318,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
16318
16318
|
}
|
|
16319
16319
|
|
|
16320
16320
|
/**
|
|
16321
|
-
* 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
|
|
16321
|
+
* Adds a new TCP (Tool Center Point) 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. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
16322
16322
|
* @summary Add TCP
|
|
16323
16323
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16324
16324
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16334,8 +16334,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
16334
16334
|
}
|
|
16335
16335
|
|
|
16336
16336
|
/**
|
|
16337
|
-
* 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
|
|
16338
|
-
* @summary
|
|
16337
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **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 available for visualization or program execution.
|
|
16338
|
+
* @summary Delete Coordinate System
|
|
16339
16339
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16340
16340
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
16341
16341
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -16349,7 +16349,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
16349
16349
|
}
|
|
16350
16350
|
|
|
16351
16351
|
/**
|
|
16352
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
16352
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
|
|
16353
16353
|
* @summary Remove TCP
|
|
16354
16354
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16355
16355
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -16501,7 +16501,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
16501
16501
|
}
|
|
16502
16502
|
|
|
16503
16503
|
/**
|
|
16504
|
-
* 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
|
|
16504
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
|
|
16505
16505
|
* @summary Set Mounting
|
|
16506
16506
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
16507
16507
|
* @param {string} controller Unique identifier to address a controller in the cell.
|