@wandelbots/nova-api 25.8.0-dev.76 → 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/package.json
CHANGED
package/v1/api.d.ts
CHANGED
|
@@ -14919,7 +14919,7 @@ export type SetOperationModeModeEnum = typeof SetOperationModeModeEnum[keyof typ
|
|
|
14919
14919
|
*/
|
|
14920
14920
|
export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14921
14921
|
/**
|
|
14922
|
-
* Adds a coordinate system to the robot controller.
|
|
14922
|
+
* 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.
|
|
14923
14923
|
* @summary Add Coordinate Systems
|
|
14924
14924
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14925
14925
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14929,7 +14929,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
14929
14929
|
*/
|
|
14930
14930
|
addVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14931
14931
|
/**
|
|
14932
|
-
* 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
|
|
14932
|
+
* 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.
|
|
14933
14933
|
* @summary Add TCP
|
|
14934
14934
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14935
14935
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14940,7 +14940,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
14940
14940
|
*/
|
|
14941
14941
|
addVirtualRobotTcp: (cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14942
14942
|
/**
|
|
14943
|
-
* 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.
|
|
14943
|
+
* 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.
|
|
14944
14944
|
* @summary Remove Coordinate System
|
|
14945
14945
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14946
14946
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14951,7 +14951,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
14951
14951
|
*/
|
|
14952
14952
|
deleteVirtualRobotCoordinateSystem: (cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14953
14953
|
/**
|
|
14954
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
14954
|
+
* 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.
|
|
14955
14955
|
* @summary Remove TCP
|
|
14956
14956
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14957
14957
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14991,7 +14991,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
14991
14991
|
*/
|
|
14992
14992
|
listVirtualRobotTcps: (cell: string, controller: string, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14993
14993
|
/**
|
|
14994
|
-
* 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
|
|
14994
|
+
* 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.
|
|
14995
14995
|
* @summary Set Mounting
|
|
14996
14996
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14997
14997
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15008,7 +15008,7 @@ export declare const VirtualRobotSetupApiAxiosParamCreator: (configuration?: Con
|
|
|
15008
15008
|
*/
|
|
15009
15009
|
export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) => {
|
|
15010
15010
|
/**
|
|
15011
|
-
* Adds a coordinate system to the robot controller.
|
|
15011
|
+
* 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.
|
|
15012
15012
|
* @summary Add Coordinate Systems
|
|
15013
15013
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15014
15014
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15018,7 +15018,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15018
15018
|
*/
|
|
15019
15019
|
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15020
15020
|
/**
|
|
15021
|
-
* 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
|
|
15021
|
+
* 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.
|
|
15022
15022
|
* @summary Add TCP
|
|
15023
15023
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15024
15024
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15029,7 +15029,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15029
15029
|
*/
|
|
15030
15030
|
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15031
15031
|
/**
|
|
15032
|
-
* 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.
|
|
15032
|
+
* 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.
|
|
15033
15033
|
* @summary Remove Coordinate System
|
|
15034
15034
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15035
15035
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15040,7 +15040,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15040
15040
|
*/
|
|
15041
15041
|
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
15042
15042
|
/**
|
|
15043
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15043
|
+
* 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.
|
|
15044
15044
|
* @summary Remove TCP
|
|
15045
15045
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15046
15046
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15080,7 +15080,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15080
15080
|
*/
|
|
15081
15081
|
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotTcps>>;
|
|
15082
15082
|
/**
|
|
15083
|
-
* 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
|
|
15083
|
+
* 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.
|
|
15084
15084
|
* @summary Set Mounting
|
|
15085
15085
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15086
15086
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15097,7 +15097,7 @@ export declare const VirtualRobotSetupApiFp: (configuration?: Configuration) =>
|
|
|
15097
15097
|
*/
|
|
15098
15098
|
export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15099
15099
|
/**
|
|
15100
|
-
* Adds a coordinate system to the robot controller.
|
|
15100
|
+
* 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.
|
|
15101
15101
|
* @summary Add Coordinate Systems
|
|
15102
15102
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15103
15103
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15107,7 +15107,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15107
15107
|
*/
|
|
15108
15108
|
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15109
15109
|
/**
|
|
15110
|
-
* 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
|
|
15110
|
+
* 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.
|
|
15111
15111
|
* @summary Add TCP
|
|
15112
15112
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15113
15113
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15118,7 +15118,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15118
15118
|
*/
|
|
15119
15119
|
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15120
15120
|
/**
|
|
15121
|
-
* 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.
|
|
15121
|
+
* 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.
|
|
15122
15122
|
* @summary Remove Coordinate System
|
|
15123
15123
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15124
15124
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15129,7 +15129,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15129
15129
|
*/
|
|
15130
15130
|
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
15131
15131
|
/**
|
|
15132
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15132
|
+
* 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.
|
|
15133
15133
|
* @summary Remove TCP
|
|
15134
15134
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15135
15135
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15169,7 +15169,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15169
15169
|
*/
|
|
15170
15170
|
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): AxiosPromise<RobotTcps>;
|
|
15171
15171
|
/**
|
|
15172
|
-
* 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
|
|
15172
|
+
* 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.
|
|
15173
15173
|
* @summary Set Mounting
|
|
15174
15174
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15175
15175
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15188,7 +15188,7 @@ export declare const VirtualRobotSetupApiFactory: (configuration?: Configuration
|
|
|
15188
15188
|
*/
|
|
15189
15189
|
export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
15190
15190
|
/**
|
|
15191
|
-
* Adds a coordinate system to the robot controller.
|
|
15191
|
+
* 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.
|
|
15192
15192
|
* @summary Add Coordinate Systems
|
|
15193
15193
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15194
15194
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15199,7 +15199,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15199
15199
|
*/
|
|
15200
15200
|
addVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: CoordinateSystem, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15201
15201
|
/**
|
|
15202
|
-
* 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
|
|
15202
|
+
* 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.
|
|
15203
15203
|
* @summary Add TCP
|
|
15204
15204
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15205
15205
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15211,7 +15211,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15211
15211
|
*/
|
|
15212
15212
|
addVirtualRobotTcp(cell: string, controller: string, id: number, robotTcp: RobotTcp, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15213
15213
|
/**
|
|
15214
|
-
* 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.
|
|
15214
|
+
* 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.
|
|
15215
15215
|
* @summary Remove Coordinate System
|
|
15216
15216
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15217
15217
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15223,7 +15223,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15223
15223
|
*/
|
|
15224
15224
|
deleteVirtualRobotCoordinateSystem(cell: string, controller: string, coordinateSystem: string, deleteDependent?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
15225
15225
|
/**
|
|
15226
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15226
|
+
* 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.
|
|
15227
15227
|
* @summary Remove TCP
|
|
15228
15228
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15229
15229
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15267,7 +15267,7 @@ export declare class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15267
15267
|
*/
|
|
15268
15268
|
listVirtualRobotTcps(cell: string, controller: string, id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotTcps, any>>;
|
|
15269
15269
|
/**
|
|
15270
|
-
* 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
|
|
15270
|
+
* 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.
|
|
15271
15271
|
* @summary Set Mounting
|
|
15272
15272
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15273
15273
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
package/v1/api.js
CHANGED
|
@@ -14873,7 +14873,7 @@ export const SetOperationModeModeEnum = {
|
|
|
14873
14873
|
export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
14874
14874
|
return {
|
|
14875
14875
|
/**
|
|
14876
|
-
* Adds a coordinate system to the robot controller.
|
|
14876
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
14877
14877
|
* @summary Add Coordinate Systems
|
|
14878
14878
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14879
14879
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14917,7 +14917,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
14917
14917
|
};
|
|
14918
14918
|
},
|
|
14919
14919
|
/**
|
|
14920
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange
|
|
14920
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#tcp) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
14921
14921
|
* @summary Add TCP
|
|
14922
14922
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14923
14923
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -14965,7 +14965,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
14965
14965
|
};
|
|
14966
14966
|
},
|
|
14967
14967
|
/**
|
|
14968
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
14968
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
14969
14969
|
* @summary Remove Coordinate System
|
|
14970
14970
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
14971
14971
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15012,7 +15012,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
15012
15012
|
};
|
|
15013
15013
|
},
|
|
15014
15014
|
/**
|
|
15015
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15015
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15016
15016
|
* @summary Remove TCP
|
|
15017
15017
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15018
15018
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15184,7 +15184,7 @@ export const VirtualRobotSetupApiAxiosParamCreator = function (configuration) {
|
|
|
15184
15184
|
};
|
|
15185
15185
|
},
|
|
15186
15186
|
/**
|
|
15187
|
-
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset
|
|
15187
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15188
15188
|
* @summary Set Mounting
|
|
15189
15189
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15190
15190
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15241,7 +15241,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15241
15241
|
const localVarAxiosParamCreator = VirtualRobotSetupApiAxiosParamCreator(configuration);
|
|
15242
15242
|
return {
|
|
15243
15243
|
/**
|
|
15244
|
-
* Adds a coordinate system to the robot controller.
|
|
15244
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15245
15245
|
* @summary Add Coordinate Systems
|
|
15246
15246
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15247
15247
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15256,7 +15256,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15256
15256
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15257
15257
|
},
|
|
15258
15258
|
/**
|
|
15259
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange
|
|
15259
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#tcp) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15260
15260
|
* @summary Add TCP
|
|
15261
15261
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15262
15262
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15272,7 +15272,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15272
15272
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15273
15273
|
},
|
|
15274
15274
|
/**
|
|
15275
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15275
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15276
15276
|
* @summary Remove Coordinate System
|
|
15277
15277
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15278
15278
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15288,7 +15288,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15288
15288
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15289
15289
|
},
|
|
15290
15290
|
/**
|
|
15291
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15291
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15292
15292
|
* @summary Remove TCP
|
|
15293
15293
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15294
15294
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15348,7 +15348,7 @@ export const VirtualRobotSetupApiFp = function (configuration) {
|
|
|
15348
15348
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15349
15349
|
},
|
|
15350
15350
|
/**
|
|
15351
|
-
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset
|
|
15351
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15352
15352
|
* @summary Set Mounting
|
|
15353
15353
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15354
15354
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15373,7 +15373,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15373
15373
|
const localVarFp = VirtualRobotSetupApiFp(configuration);
|
|
15374
15374
|
return {
|
|
15375
15375
|
/**
|
|
15376
|
-
* Adds a coordinate system to the robot controller.
|
|
15376
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15377
15377
|
* @summary Add Coordinate Systems
|
|
15378
15378
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15379
15379
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15385,7 +15385,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15385
15385
|
return localVarFp.addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(axios, basePath));
|
|
15386
15386
|
},
|
|
15387
15387
|
/**
|
|
15388
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange
|
|
15388
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#tcp) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15389
15389
|
* @summary Add TCP
|
|
15390
15390
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15391
15391
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15398,7 +15398,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15398
15398
|
return localVarFp.addVirtualRobotTcp(cell, controller, id, robotTcp, options).then((request) => request(axios, basePath));
|
|
15399
15399
|
},
|
|
15400
15400
|
/**
|
|
15401
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15401
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15402
15402
|
* @summary Remove Coordinate System
|
|
15403
15403
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15404
15404
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15411,7 +15411,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15411
15411
|
return localVarFp.deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
15412
15412
|
},
|
|
15413
15413
|
/**
|
|
15414
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15414
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15415
15415
|
* @summary Remove TCP
|
|
15416
15416
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15417
15417
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15459,7 +15459,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15459
15459
|
return localVarFp.listVirtualRobotTcps(cell, controller, id, options).then((request) => request(axios, basePath));
|
|
15460
15460
|
},
|
|
15461
15461
|
/**
|
|
15462
|
-
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset
|
|
15462
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15463
15463
|
* @summary Set Mounting
|
|
15464
15464
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15465
15465
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15481,7 +15481,7 @@ export const VirtualRobotSetupApiFactory = function (configuration, basePath, ax
|
|
|
15481
15481
|
*/
|
|
15482
15482
|
export class VirtualRobotSetupApi extends BaseAPI {
|
|
15483
15483
|
/**
|
|
15484
|
-
* Adds a coordinate system to the robot controller.
|
|
15484
|
+
* Adds a coordinate system to the robot controller. > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15485
15485
|
* @summary Add Coordinate Systems
|
|
15486
15486
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15487
15487
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15494,7 +15494,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15494
15494
|
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
15495
15495
|
}
|
|
15496
15496
|
/**
|
|
15497
|
-
* Adds a new TCP or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange
|
|
15497
|
+
* Adds a new [TCP](https://docs.wandelbots.io/latest/vocabulary#tcp) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. > **NOTE** > Upon adding or updating a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is available for use. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the TCP may not be available for visualization or program execution.
|
|
15498
15498
|
* @summary Add TCP
|
|
15499
15499
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15500
15500
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15508,7 +15508,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15508
15508
|
return VirtualRobotSetupApiFp(this.configuration).addVirtualRobotTcp(cell, controller, id, robotTcp, options).then((request) => request(this.axios, this.basePath));
|
|
15509
15509
|
}
|
|
15510
15510
|
/**
|
|
15511
|
-
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and remove all dependent coordinate systems which use the deleted coordinate system as reference.
|
|
15511
|
+
* Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems which use the deleted coordinate system as a reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be > **NOTE** > > Upon adding or removing a coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or appear outdated in the UI. > - Coordinate system changes are not immediately visible in visualizations. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new coordinate system may not be available for visualization or program execution.
|
|
15512
15512
|
* @summary Remove Coordinate System
|
|
15513
15513
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15514
15514
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15522,7 +15522,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15522
15522
|
return VirtualRobotSetupApiFp(this.configuration).deleteVirtualRobotCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
15523
15523
|
}
|
|
15524
15524
|
/**
|
|
15525
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
15525
|
+
* Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. > **NOTE** > Upon removing a TCP, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear. > - TCP visualization may be delayed or outdated during the first run. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before the TCP is removed. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that immediately after a successful response, the TCP may not be removed.
|
|
15526
15526
|
* @summary Remove TCP
|
|
15527
15527
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15528
15528
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -15574,7 +15574,7 @@ export class VirtualRobotSetupApi extends BaseAPI {
|
|
|
15574
15574
|
return VirtualRobotSetupApiFp(this.configuration).listVirtualRobotTcps(cell, controller, id, options).then((request) => request(this.axios, this.basePath));
|
|
15575
15575
|
}
|
|
15576
15576
|
/**
|
|
15577
|
-
* Sets motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset
|
|
15577
|
+
* Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. > **NOTE** > Changing the mounting configuration is considered a configuration change. > > Upon updating the mounting to another coordinate system, virtual robots are restarted to apply the new configuration. > What happens during restart: > - Robot visualization may temporarily disappear or not reflect the updated mounting. > - Motion group state and coordinate system alignment may not be instantly updated. > - Existing connections to the virtual robot are closed and re-established, which introduces a short delay before NOVA is fully operational again. > > The API call itself **does not wait until the restart and synchronization are complete**. This means that > immediately after a successful response, the new mounting may not be available for visualization or program execution.
|
|
15578
15578
|
* @summary Set Mounting
|
|
15579
15579
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
15580
15580
|
* @param {string} controller Unique identifier to address a controller in the cell.
|