@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/v1/api.ts CHANGED
@@ -23571,7 +23571,7 @@ export type SetOperationModeModeEnum = typeof SetOperationModeModeEnum[keyof typ
23571
23571
  export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: Configuration) {
23572
23572
  return {
23573
23573
  /**
23574
- * Adds a coordinate system to the robot controller.
23574
+ * 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.
23575
23575
  * @summary Add Coordinate Systems
23576
23576
  * @param {string} cell Unique identifier addressing a cell in all API calls.
23577
23577
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -23623,7 +23623,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
23623
23623
  };
23624
23624
  },
23625
23625
  /**
23626
- * 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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
23626
+ * 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.
23627
23627
  * @summary Add TCP
23628
23628
  * @param {string} cell Unique identifier addressing a cell in all API calls.
23629
23629
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -23679,7 +23679,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
23679
23679
  };
23680
23680
  },
23681
23681
  /**
23682
- * 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.
23682
+ * 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.
23683
23683
  * @summary Remove Coordinate System
23684
23684
  * @param {string} cell Unique identifier addressing a cell in all API calls.
23685
23685
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -23734,7 +23734,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
23734
23734
  };
23735
23735
  },
23736
23736
  /**
23737
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
23737
+ * 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.
23738
23738
  * @summary Remove TCP
23739
23739
  * @param {string} cell Unique identifier addressing a cell in all API calls.
23740
23740
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -23934,7 +23934,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration?: C
23934
23934
  };
23935
23935
  },
23936
23936
  /**
23937
- * 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
23937
+ * 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.
23938
23938
  * @summary Set Mounting
23939
23939
  * @param {string} cell Unique identifier addressing a cell in all API calls.
23940
23940
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24000,7 +24000,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
24000
24000
  const localVarAxiosParamCreator = VirtualRobotSetupApiAxiosParamCreator(configuration)
24001
24001
  return {
24002
24002
  /**
24003
- * Adds a coordinate system to the robot controller.
24003
+ * 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.
24004
24004
  * @summary Add Coordinate Systems
24005
24005
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24006
24006
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24015,7 +24015,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
24015
24015
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24016
24016
  },
24017
24017
  /**
24018
- * 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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
24018
+ * 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.
24019
24019
  * @summary Add TCP
24020
24020
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24021
24021
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24031,7 +24031,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
24031
24031
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24032
24032
  },
24033
24033
  /**
24034
- * 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.
24034
+ * 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.
24035
24035
  * @summary Remove Coordinate System
24036
24036
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24037
24037
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24047,7 +24047,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
24047
24047
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24048
24048
  },
24049
24049
  /**
24050
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
24050
+ * 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.
24051
24051
  * @summary Remove TCP
24052
24052
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24053
24053
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24107,7 +24107,7 @@ export const VirtualRobotSetupApiFp = function(configuration?: Configuration) {
24107
24107
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24108
24108
  },
24109
24109
  /**
24110
- * 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
24110
+ * 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.
24111
24111
  * @summary Set Mounting
24112
24112
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24113
24113
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24133,7 +24133,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
24133
24133
  const localVarFp = VirtualRobotSetupApiFp(configuration)
24134
24134
  return {
24135
24135
  /**
24136
- * Adds a coordinate system to the robot controller.
24136
+ * 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.
24137
24137
  * @summary Add Coordinate Systems
24138
24138
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24139
24139
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24145,7 +24145,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
24145
24145
  return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
24146
24146
  },
24147
24147
  /**
24148
- * 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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
24148
+ * 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.
24149
24149
  * @summary Add TCP
24150
24150
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24151
24151
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24158,7 +24158,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
24158
24158
  return localVarFp.addVirtualRobotTcp(cell, controller, id, robotTcp, options).then((request) => request(axios, basePath));
24159
24159
  },
24160
24160
  /**
24161
- * 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.
24161
+ * 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.
24162
24162
  * @summary Remove Coordinate System
24163
24163
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24164
24164
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24171,7 +24171,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
24171
24171
  return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
24172
24172
  },
24173
24173
  /**
24174
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
24174
+ * 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.
24175
24175
  * @summary Remove TCP
24176
24176
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24177
24177
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24219,7 +24219,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
24219
24219
  return localVarFp.listVirtualRobotTcps(cell, controller, id, options).then((request) => request(axios, basePath));
24220
24220
  },
24221
24221
  /**
24222
- * 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
24222
+ * 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.
24223
24223
  * @summary Set Mounting
24224
24224
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24225
24225
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24242,7 +24242,7 @@ export const VirtualRobotSetupApiFactory = function (configuration?: Configurati
24242
24242
  */
24243
24243
  export class VirtualRobotSetupApi extends BaseAPI {
24244
24244
  /**
24245
- * Adds a coordinate system to the robot controller.
24245
+ * 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.
24246
24246
  * @summary Add Coordinate Systems
24247
24247
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24248
24248
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24256,7 +24256,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
24256
24256
  }
24257
24257
 
24258
24258
  /**
24259
- * 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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
24259
+ * 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.
24260
24260
  * @summary Add TCP
24261
24261
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24262
24262
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24271,7 +24271,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
24271
24271
  }
24272
24272
 
24273
24273
  /**
24274
- * 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.
24274
+ * 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.
24275
24275
  * @summary Remove Coordinate System
24276
24276
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24277
24277
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24286,7 +24286,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
24286
24286
  }
24287
24287
 
24288
24288
  /**
24289
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
24289
+ * 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.
24290
24290
  * @summary Remove TCP
24291
24291
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24292
24292
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -24342,7 +24342,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
24342
24342
  }
24343
24343
 
24344
24344
  /**
24345
- * 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
24345
+ * 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.
24346
24346
  * @summary Set Mounting
24347
24347
  * @param {string} cell Unique identifier addressing a cell in all API calls.
24348
24348
  * @param {string} controller Unique identifier to address a controller in the cell.
package/v2/api.d.ts CHANGED
@@ -9843,7 +9843,7 @@ export declare class TrajectoryPlanningApi extends BaseAPI {
9843
9843
  */
9844
9844
  export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Configuration) => {
9845
9845
  /**
9846
- * Adds a coordinate system to the robot controller.
9846
+ * 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.
9847
9847
  * @summary Add Coordinate Systems
9848
9848
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9849
9849
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9854,7 +9854,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9854
9854
  */
9855
9855
  addVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9856
9856
  /**
9857
- * 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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
9857
+ * 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.
9858
9858
  * @summary Add TCP
9859
9859
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9860
9860
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9866,8 +9866,8 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9866
9866
  */
9867
9867
  addVirtualControllerTcp: (cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9868
9868
  /**
9869
- * 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.
9870
- * @summary Remove Coordinate System
9869
+ * 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.
9870
+ * @summary Delete Coordinate System
9871
9871
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9872
9872
  * @param {string} controller Unique identifier to address a controller in the cell.
9873
9873
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -9877,7 +9877,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9877
9877
  */
9878
9878
  deleteVirtualControllerCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9879
9879
  /**
9880
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9880
+ * 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.
9881
9881
  * @summary Remove TCP
9882
9882
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9883
9883
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9985,7 +9985,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
9985
9985
  */
9986
9986
  setOperationMode: (cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
9987
9987
  /**
9988
- * 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
9988
+ * 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.
9989
9989
  * @summary Set Mounting
9990
9990
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9991
9991
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10002,7 +10002,7 @@ export declare const VirtualControllerApiAxiosParamCreator: (configuration?: Con
10002
10002
  */
10003
10003
  export declare const VirtualControllerApiFp: (configuration?: Configuration) => {
10004
10004
  /**
10005
- * Adds a coordinate system to the robot controller.
10005
+ * 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.
10006
10006
  * @summary Add Coordinate Systems
10007
10007
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10008
10008
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10013,7 +10013,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
10013
10013
  */
10014
10014
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10015
10015
  /**
10016
- * 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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
10016
+ * 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.
10017
10017
  * @summary Add TCP
10018
10018
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10019
10019
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10025,8 +10025,8 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
10025
10025
  */
10026
10026
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10027
10027
  /**
10028
- * 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.
10029
- * @summary Remove Coordinate System
10028
+ * 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.
10029
+ * @summary Delete Coordinate System
10030
10030
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10031
10031
  * @param {string} controller Unique identifier to address a controller in the cell.
10032
10032
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -10036,7 +10036,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
10036
10036
  */
10037
10037
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10038
10038
  /**
10039
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
10039
+ * 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.
10040
10040
  * @summary Remove TCP
10041
10041
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10042
10042
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10144,7 +10144,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
10144
10144
  */
10145
10145
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
10146
10146
  /**
10147
- * 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
10147
+ * 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.
10148
10148
  * @summary Set Mounting
10149
10149
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10150
10150
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10161,7 +10161,7 @@ export declare const VirtualControllerApiFp: (configuration?: Configuration) =>
10161
10161
  */
10162
10162
  export declare const VirtualControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
10163
10163
  /**
10164
- * Adds a coordinate system to the robot controller.
10164
+ * 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.
10165
10165
  * @summary Add Coordinate Systems
10166
10166
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10167
10167
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10172,7 +10172,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
10172
10172
  */
10173
10173
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10174
10174
  /**
10175
- * 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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
10175
+ * 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.
10176
10176
  * @summary Add TCP
10177
10177
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10178
10178
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10184,8 +10184,8 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
10184
10184
  */
10185
10185
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10186
10186
  /**
10187
- * 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.
10188
- * @summary Remove Coordinate System
10187
+ * 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.
10188
+ * @summary Delete Coordinate System
10189
10189
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10190
10190
  * @param {string} controller Unique identifier to address a controller in the cell.
10191
10191
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -10195,7 +10195,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
10195
10195
  */
10196
10196
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10197
10197
  /**
10198
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
10198
+ * 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.
10199
10199
  * @summary Remove TCP
10200
10200
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10201
10201
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10303,7 +10303,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
10303
10303
  */
10304
10304
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): AxiosPromise<void>;
10305
10305
  /**
10306
- * 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
10306
+ * 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.
10307
10307
  * @summary Set Mounting
10308
10308
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10309
10309
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10322,7 +10322,7 @@ export declare const VirtualControllerApiFactory: (configuration?: Configuration
10322
10322
  */
10323
10323
  export declare class VirtualControllerApi extends BaseAPI {
10324
10324
  /**
10325
- * Adds a coordinate system to the robot controller.
10325
+ * 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.
10326
10326
  * @summary Add Coordinate Systems
10327
10327
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10328
10328
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10334,7 +10334,7 @@ export declare class VirtualControllerApi extends BaseAPI {
10334
10334
  */
10335
10335
  addVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, coordinateSystemData: CoordinateSystemData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10336
10336
  /**
10337
- * 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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
10337
+ * 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.
10338
10338
  * @summary Add TCP
10339
10339
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10340
10340
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10347,8 +10347,8 @@ export declare class VirtualControllerApi extends BaseAPI {
10347
10347
  */
10348
10348
  addVirtualControllerTcp(cell: string, controller: string, motionGroup: string, tcp: string, robotTcpData: RobotTcpData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10349
10349
  /**
10350
- * 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.
10351
- * @summary Remove Coordinate System
10350
+ * 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.
10351
+ * @summary Delete Coordinate System
10352
10352
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10353
10353
  * @param {string} controller Unique identifier to address a controller in the cell.
10354
10354
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -10359,7 +10359,7 @@ export declare class VirtualControllerApi extends BaseAPI {
10359
10359
  */
10360
10360
  deleteVirtualControllerCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10361
10361
  /**
10362
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
10362
+ * 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.
10363
10363
  * @summary Remove TCP
10364
10364
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10365
10365
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -10478,7 +10478,7 @@ export declare class VirtualControllerApi extends BaseAPI {
10478
10478
  */
10479
10479
  setOperationMode(cell: string, controller: string, mode: OperationMode, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
10480
10480
  /**
10481
- * 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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
10481
+ * 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.
10482
10482
  * @summary Set Mounting
10483
10483
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10484
10484
  * @param {string} controller Unique identifier to address a controller in the cell.