@wandelbots/nova-api 25.7.2-rc.2 → 25.8.0-dev.100
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/v1/api.d.ts +31 -21
- package/v1/api.js +25 -21
- package/v1/api.js.map +1 -1
- package/v1/api.ts +31 -21
- package/v2/api.d.ts +565 -150
- package/v2/api.js +406 -44
- package/v2/api.js.map +1 -1
- package/v2/api.ts +761 -151
package/v2/api.js
CHANGED
|
@@ -151,6 +151,15 @@ export const IOFloatValueValueTypeEnum = {
|
|
|
151
151
|
export const IOIntegerValueValueTypeEnum = {
|
|
152
152
|
Integer: 'integer'
|
|
153
153
|
};
|
|
154
|
+
/**
|
|
155
|
+
* States the source of the input/output signal.
|
|
156
|
+
* @export
|
|
157
|
+
* @enum {string}
|
|
158
|
+
*/
|
|
159
|
+
export const IOOrigin = {
|
|
160
|
+
Controller: 'CONTROLLER',
|
|
161
|
+
BusIo: 'BUS_IO'
|
|
162
|
+
};
|
|
154
163
|
/**
|
|
155
164
|
* Data type of the input/output.
|
|
156
165
|
* @export
|
|
@@ -355,6 +364,18 @@ export const ProfinetIOTypeEnum = {
|
|
|
355
364
|
ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
|
|
356
365
|
ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
|
|
357
366
|
};
|
|
367
|
+
/**
|
|
368
|
+
* The state of a program run.
|
|
369
|
+
* @export
|
|
370
|
+
* @enum {string}
|
|
371
|
+
*/
|
|
372
|
+
export const ProgramRunState = {
|
|
373
|
+
Preparing: 'PREPARING',
|
|
374
|
+
Running: 'RUNNING',
|
|
375
|
+
Completed: 'COMPLETED',
|
|
376
|
+
Failed: 'FAILED',
|
|
377
|
+
Stopped: 'STOPPED'
|
|
378
|
+
};
|
|
358
379
|
export const RRTConnectAlgorithmAlgorithmNameEnum = {
|
|
359
380
|
RrtConnectAlgorithm: 'RRTConnectAlgorithm'
|
|
360
381
|
};
|
|
@@ -607,11 +628,13 @@ export const VirtualControllerTypes = {
|
|
|
607
628
|
KukaKr4R600: 'kuka-kr4_r600',
|
|
608
629
|
KukaKr500L3403: 'kuka-kr500_l340_3',
|
|
609
630
|
KukaKr50R2500: 'kuka-kr50_r2500',
|
|
631
|
+
KukaKr60R3: 'kuka-kr60_r3',
|
|
610
632
|
KukaKr6R1820: 'kuka-kr6_r1820',
|
|
611
633
|
KukaKr6R7002: 'kuka-kr6_r700_2',
|
|
612
634
|
KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
|
|
613
635
|
KukaKr6R900: 'kuka-kr6_r900',
|
|
614
636
|
KukaKr6R9002: 'kuka-kr6_r900_2',
|
|
637
|
+
KukaKr70R2100: 'kuka-kr70_r2100',
|
|
615
638
|
KukaLbrIisy11R1300: 'kuka-lbr_iisy_11_r1300',
|
|
616
639
|
UniversalrobotsUr10cb: 'universalrobots-ur10cb',
|
|
617
640
|
UniversalrobotsUr10e: 'universalrobots-ur10e',
|
|
@@ -1523,7 +1546,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
|
|
|
1523
1546
|
};
|
|
1524
1547
|
},
|
|
1525
1548
|
/**
|
|
1526
|
-
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The
|
|
1549
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
1527
1550
|
* @summary List Descriptions
|
|
1528
1551
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1529
1552
|
* @param {*} [options] Override http request option.
|
|
@@ -1558,7 +1581,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
|
|
|
1558
1581
|
};
|
|
1559
1582
|
},
|
|
1560
1583
|
/**
|
|
1561
|
-
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The
|
|
1584
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
1562
1585
|
* @summary List PROFINET Input/Output Configuration
|
|
1563
1586
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1564
1587
|
* @param {*} [options] Override http request option.
|
|
@@ -1633,7 +1656,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
|
|
|
1633
1656
|
};
|
|
1634
1657
|
},
|
|
1635
1658
|
/**
|
|
1636
|
-
* Sets
|
|
1659
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
1637
1660
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
1638
1661
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1639
1662
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -1808,7 +1831,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
|
|
|
1808
1831
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1809
1832
|
},
|
|
1810
1833
|
/**
|
|
1811
|
-
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The
|
|
1834
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
1812
1835
|
* @summary List Descriptions
|
|
1813
1836
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1814
1837
|
* @param {*} [options] Override http request option.
|
|
@@ -1821,7 +1844,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
|
|
|
1821
1844
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1822
1845
|
},
|
|
1823
1846
|
/**
|
|
1824
|
-
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The
|
|
1847
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
1825
1848
|
* @summary List PROFINET Input/Output Configuration
|
|
1826
1849
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1827
1850
|
* @param {*} [options] Override http request option.
|
|
@@ -1848,7 +1871,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
|
|
|
1848
1871
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1849
1872
|
},
|
|
1850
1873
|
/**
|
|
1851
|
-
* Sets
|
|
1874
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
1852
1875
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
1853
1876
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1854
1877
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -1970,7 +1993,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
|
|
|
1970
1993
|
return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
|
|
1971
1994
|
},
|
|
1972
1995
|
/**
|
|
1973
|
-
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The
|
|
1996
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
1974
1997
|
* @summary List Descriptions
|
|
1975
1998
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1976
1999
|
* @param {*} [options] Override http request option.
|
|
@@ -1980,7 +2003,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
|
|
|
1980
2003
|
return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
|
|
1981
2004
|
},
|
|
1982
2005
|
/**
|
|
1983
|
-
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The
|
|
2006
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
1984
2007
|
* @summary List PROFINET Input/Output Configuration
|
|
1985
2008
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
1986
2009
|
* @param {*} [options] Override http request option.
|
|
@@ -2001,7 +2024,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
|
|
|
2001
2024
|
return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
|
|
2002
2025
|
},
|
|
2003
2026
|
/**
|
|
2004
|
-
* Sets
|
|
2027
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
2005
2028
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
2006
2029
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2007
2030
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -2129,7 +2152,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
2129
2152
|
return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
|
|
2130
2153
|
}
|
|
2131
2154
|
/**
|
|
2132
|
-
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The
|
|
2155
|
+
* List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the BUS service.
|
|
2133
2156
|
* @summary List Descriptions
|
|
2134
2157
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2135
2158
|
* @param {*} [options] Override http request option.
|
|
@@ -2140,7 +2163,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
2140
2163
|
return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
|
|
2141
2164
|
}
|
|
2142
2165
|
/**
|
|
2143
|
-
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The
|
|
2166
|
+
* List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The input/output direction is given in perspective of the PROFINET Device, e.g. the configured PROFINET service. The byte and bit addresses are the locations in the PROFINET input/output process image the variable points to. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input and output process image. The NOVA PROFINET service\'s configuration is modified via [addProfinetIO](addProfinetIO) and [setProfinetIOsFromFile](setProfinetIOsFromFile). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding third party software, e.g. TIA portal.
|
|
2144
2167
|
* @summary List PROFINET Input/Output Configuration
|
|
2145
2168
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2146
2169
|
* @param {*} [options] Override http request option.
|
|
@@ -2163,7 +2186,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
|
|
|
2163
2186
|
return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
|
|
2164
2187
|
}
|
|
2165
2188
|
/**
|
|
2166
|
-
* Sets
|
|
2189
|
+
* Sets input/output variable configuration on the PROFINET device (i.e. NOVA\'s PROFINET service) from XML file. The inputs/outputs map variables to specific memory addresses in the process image. The default process image has buffer lengths of 64 bytes for input and output. The size of the buffer is determined by the `config_file_content` that is passed in [addBusIOService](addBusIOService) and has to be in accordance with the GSDML file describing the PROFINET device. The PROFINET controller as well as NOVA\'s PROFINET service use an input/output variable configuration to interpret the bits of the input/output process image. The NOVA\'s PROFINET service\'s configuration can be viewed via [listProfinetIOs](listProfinetIOs). For the PROFINET controller, e.g. a connected PLC, refer to the corresponding engineering system, e.g. TIA portal. You can export the variable configuration of the PROFINET controller as XML file from your engineering system, e.g. TIA portal. The endpoint is built so that the perspective of input and output (PROFINET Device\'s input is PROFINET Controller\'s output) is internally handled (PROFINET device input is PROFINET controller output), meaning that you can paste the exported XML file here without modifying.
|
|
2167
2190
|
* @summary Set PROFINET Inputs/Outputs from File
|
|
2168
2191
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
2169
2192
|
* @param {ProfinetInputOutputConfig} profinetInputOutputConfig
|
|
@@ -5271,7 +5294,7 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
5271
5294
|
export const MotionGroupModelsApiAxiosParamCreator = function (configuration) {
|
|
5272
5295
|
return {
|
|
5273
5296
|
/**
|
|
5274
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
5297
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
5275
5298
|
* @summary Get Collision Model
|
|
5276
5299
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5277
5300
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -5354,7 +5377,7 @@ export const MotionGroupModelsApiFp = function (configuration) {
|
|
|
5354
5377
|
const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration);
|
|
5355
5378
|
return {
|
|
5356
5379
|
/**
|
|
5357
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
5380
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
5358
5381
|
* @summary Get Collision Model
|
|
5359
5382
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5360
5383
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -5390,7 +5413,7 @@ export const MotionGroupModelsApiFactory = function (configuration, basePath, ax
|
|
|
5390
5413
|
const localVarFp = MotionGroupModelsApiFp(configuration);
|
|
5391
5414
|
return {
|
|
5392
5415
|
/**
|
|
5393
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
5416
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
5394
5417
|
* @summary Get Collision Model
|
|
5395
5418
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5396
5419
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -5420,7 +5443,7 @@ export const MotionGroupModelsApiFactory = function (configuration, basePath, ax
|
|
|
5420
5443
|
*/
|
|
5421
5444
|
export class MotionGroupModelsApi extends BaseAPI {
|
|
5422
5445
|
/**
|
|
5423
|
-
* Returns the default collision link chain for a given motion group model. See [
|
|
5446
|
+
* Returns the default collision link chain for a given motion group model. See [getMotionGroupModels](getMotionGroupModels) for supported motion group models. The default link chain is derived from 3D models and optimized for collision detection within NOVA. The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors. Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
|
|
5424
5447
|
* @summary Get Collision Model
|
|
5425
5448
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5426
5449
|
* @param {string} motionGroupModel Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`. Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).
|
|
@@ -5443,6 +5466,345 @@ export class MotionGroupModelsApi extends BaseAPI {
|
|
|
5443
5466
|
return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5444
5467
|
}
|
|
5445
5468
|
}
|
|
5469
|
+
/**
|
|
5470
|
+
* ProgramApi - axios parameter creator
|
|
5471
|
+
* @export
|
|
5472
|
+
*/
|
|
5473
|
+
export const ProgramApiAxiosParamCreator = function (configuration) {
|
|
5474
|
+
return {
|
|
5475
|
+
/**
|
|
5476
|
+
* Get details of a program.
|
|
5477
|
+
* @summary Get program
|
|
5478
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5479
|
+
* @param {string} program
|
|
5480
|
+
* @param {*} [options] Override http request option.
|
|
5481
|
+
* @throws {RequiredError}
|
|
5482
|
+
*/
|
|
5483
|
+
getProgram: async (cell, program, options = {}) => {
|
|
5484
|
+
// verify required parameter 'cell' is not null or undefined
|
|
5485
|
+
assertParamExists('getProgram', 'cell', cell);
|
|
5486
|
+
// verify required parameter 'program' is not null or undefined
|
|
5487
|
+
assertParamExists('getProgram', 'program', program);
|
|
5488
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}`
|
|
5489
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5490
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
5491
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5492
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5493
|
+
let baseOptions;
|
|
5494
|
+
if (configuration) {
|
|
5495
|
+
baseOptions = configuration.baseOptions;
|
|
5496
|
+
}
|
|
5497
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5498
|
+
const localVarHeaderParameter = {};
|
|
5499
|
+
const localVarQueryParameter = {};
|
|
5500
|
+
// authentication BasicAuth required
|
|
5501
|
+
// http basic authentication required
|
|
5502
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5503
|
+
// authentication BearerAuth required
|
|
5504
|
+
// http bearer authentication required
|
|
5505
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5506
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5507
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5508
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5509
|
+
return {
|
|
5510
|
+
url: toPathString(localVarUrlObj),
|
|
5511
|
+
options: localVarRequestOptions,
|
|
5512
|
+
};
|
|
5513
|
+
},
|
|
5514
|
+
/**
|
|
5515
|
+
* List details of all existing programs.
|
|
5516
|
+
* @summary List programs
|
|
5517
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5518
|
+
* @param {*} [options] Override http request option.
|
|
5519
|
+
* @throws {RequiredError}
|
|
5520
|
+
*/
|
|
5521
|
+
listPrograms: async (cell, options = {}) => {
|
|
5522
|
+
// verify required parameter 'cell' is not null or undefined
|
|
5523
|
+
assertParamExists('listPrograms', 'cell', cell);
|
|
5524
|
+
const localVarPath = `/experimental/cells/{cell}/programs`
|
|
5525
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5526
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5527
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5528
|
+
let baseOptions;
|
|
5529
|
+
if (configuration) {
|
|
5530
|
+
baseOptions = configuration.baseOptions;
|
|
5531
|
+
}
|
|
5532
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5533
|
+
const localVarHeaderParameter = {};
|
|
5534
|
+
const localVarQueryParameter = {};
|
|
5535
|
+
// authentication BasicAuth required
|
|
5536
|
+
// http basic authentication required
|
|
5537
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5538
|
+
// authentication BearerAuth required
|
|
5539
|
+
// http bearer authentication required
|
|
5540
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5541
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5542
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5543
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5544
|
+
return {
|
|
5545
|
+
url: toPathString(localVarUrlObj),
|
|
5546
|
+
options: localVarRequestOptions,
|
|
5547
|
+
};
|
|
5548
|
+
},
|
|
5549
|
+
/**
|
|
5550
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5551
|
+
* @summary Start the program
|
|
5552
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5553
|
+
* @param {string} program
|
|
5554
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
5555
|
+
* @param {*} [options] Override http request option.
|
|
5556
|
+
* @throws {RequiredError}
|
|
5557
|
+
*/
|
|
5558
|
+
startProgram: async (cell, program, programStartRequest, options = {}) => {
|
|
5559
|
+
// verify required parameter 'cell' is not null or undefined
|
|
5560
|
+
assertParamExists('startProgram', 'cell', cell);
|
|
5561
|
+
// verify required parameter 'program' is not null or undefined
|
|
5562
|
+
assertParamExists('startProgram', 'program', program);
|
|
5563
|
+
// verify required parameter 'programStartRequest' is not null or undefined
|
|
5564
|
+
assertParamExists('startProgram', 'programStartRequest', programStartRequest);
|
|
5565
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
|
|
5566
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5567
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
5568
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5569
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5570
|
+
let baseOptions;
|
|
5571
|
+
if (configuration) {
|
|
5572
|
+
baseOptions = configuration.baseOptions;
|
|
5573
|
+
}
|
|
5574
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5575
|
+
const localVarHeaderParameter = {};
|
|
5576
|
+
const localVarQueryParameter = {};
|
|
5577
|
+
// authentication BasicAuth required
|
|
5578
|
+
// http basic authentication required
|
|
5579
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5580
|
+
// authentication BearerAuth required
|
|
5581
|
+
// http bearer authentication required
|
|
5582
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5583
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5584
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5585
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5586
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5587
|
+
localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration);
|
|
5588
|
+
return {
|
|
5589
|
+
url: toPathString(localVarUrlObj),
|
|
5590
|
+
options: localVarRequestOptions,
|
|
5591
|
+
};
|
|
5592
|
+
},
|
|
5593
|
+
/**
|
|
5594
|
+
* Stop a specific program run.
|
|
5595
|
+
* @summary Stop program run
|
|
5596
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5597
|
+
* @param {string} program
|
|
5598
|
+
* @param {*} [options] Override http request option.
|
|
5599
|
+
* @throws {RequiredError}
|
|
5600
|
+
*/
|
|
5601
|
+
stopProgram: async (cell, program, options = {}) => {
|
|
5602
|
+
// verify required parameter 'cell' is not null or undefined
|
|
5603
|
+
assertParamExists('stopProgram', 'cell', cell);
|
|
5604
|
+
// verify required parameter 'program' is not null or undefined
|
|
5605
|
+
assertParamExists('stopProgram', 'program', program);
|
|
5606
|
+
const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
|
|
5607
|
+
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
5608
|
+
.replace(`{${"program"}}`, encodeURIComponent(String(program)));
|
|
5609
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5610
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5611
|
+
let baseOptions;
|
|
5612
|
+
if (configuration) {
|
|
5613
|
+
baseOptions = configuration.baseOptions;
|
|
5614
|
+
}
|
|
5615
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
5616
|
+
const localVarHeaderParameter = {};
|
|
5617
|
+
const localVarQueryParameter = {};
|
|
5618
|
+
// authentication BasicAuth required
|
|
5619
|
+
// http basic authentication required
|
|
5620
|
+
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5621
|
+
// authentication BearerAuth required
|
|
5622
|
+
// http bearer authentication required
|
|
5623
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5624
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5625
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5626
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5627
|
+
return {
|
|
5628
|
+
url: toPathString(localVarUrlObj),
|
|
5629
|
+
options: localVarRequestOptions,
|
|
5630
|
+
};
|
|
5631
|
+
},
|
|
5632
|
+
};
|
|
5633
|
+
};
|
|
5634
|
+
/**
|
|
5635
|
+
* ProgramApi - functional programming interface
|
|
5636
|
+
* @export
|
|
5637
|
+
*/
|
|
5638
|
+
export const ProgramApiFp = function (configuration) {
|
|
5639
|
+
const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration);
|
|
5640
|
+
return {
|
|
5641
|
+
/**
|
|
5642
|
+
* Get details of a program.
|
|
5643
|
+
* @summary Get program
|
|
5644
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5645
|
+
* @param {string} program
|
|
5646
|
+
* @param {*} [options] Override http request option.
|
|
5647
|
+
* @throws {RequiredError}
|
|
5648
|
+
*/
|
|
5649
|
+
async getProgram(cell, program, options) {
|
|
5650
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
|
|
5651
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5652
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
|
|
5653
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5654
|
+
},
|
|
5655
|
+
/**
|
|
5656
|
+
* List details of all existing programs.
|
|
5657
|
+
* @summary List programs
|
|
5658
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5659
|
+
* @param {*} [options] Override http request option.
|
|
5660
|
+
* @throws {RequiredError}
|
|
5661
|
+
*/
|
|
5662
|
+
async listPrograms(cell, options) {
|
|
5663
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
|
|
5664
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5665
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
|
|
5666
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5667
|
+
},
|
|
5668
|
+
/**
|
|
5669
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5670
|
+
* @summary Start the program
|
|
5671
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5672
|
+
* @param {string} program
|
|
5673
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
5674
|
+
* @param {*} [options] Override http request option.
|
|
5675
|
+
* @throws {RequiredError}
|
|
5676
|
+
*/
|
|
5677
|
+
async startProgram(cell, program, programStartRequest, options) {
|
|
5678
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
|
|
5679
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5680
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
|
|
5681
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5682
|
+
},
|
|
5683
|
+
/**
|
|
5684
|
+
* Stop a specific program run.
|
|
5685
|
+
* @summary Stop program run
|
|
5686
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5687
|
+
* @param {string} program
|
|
5688
|
+
* @param {*} [options] Override http request option.
|
|
5689
|
+
* @throws {RequiredError}
|
|
5690
|
+
*/
|
|
5691
|
+
async stopProgram(cell, program, options) {
|
|
5692
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
|
|
5693
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5694
|
+
const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
|
|
5695
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5696
|
+
},
|
|
5697
|
+
};
|
|
5698
|
+
};
|
|
5699
|
+
/**
|
|
5700
|
+
* ProgramApi - factory interface
|
|
5701
|
+
* @export
|
|
5702
|
+
*/
|
|
5703
|
+
export const ProgramApiFactory = function (configuration, basePath, axios) {
|
|
5704
|
+
const localVarFp = ProgramApiFp(configuration);
|
|
5705
|
+
return {
|
|
5706
|
+
/**
|
|
5707
|
+
* Get details of a program.
|
|
5708
|
+
* @summary Get program
|
|
5709
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5710
|
+
* @param {string} program
|
|
5711
|
+
* @param {*} [options] Override http request option.
|
|
5712
|
+
* @throws {RequiredError}
|
|
5713
|
+
*/
|
|
5714
|
+
getProgram(cell, program, options) {
|
|
5715
|
+
return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
|
|
5716
|
+
},
|
|
5717
|
+
/**
|
|
5718
|
+
* List details of all existing programs.
|
|
5719
|
+
* @summary List programs
|
|
5720
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5721
|
+
* @param {*} [options] Override http request option.
|
|
5722
|
+
* @throws {RequiredError}
|
|
5723
|
+
*/
|
|
5724
|
+
listPrograms(cell, options) {
|
|
5725
|
+
return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
|
|
5726
|
+
},
|
|
5727
|
+
/**
|
|
5728
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5729
|
+
* @summary Start the program
|
|
5730
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5731
|
+
* @param {string} program
|
|
5732
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
5733
|
+
* @param {*} [options] Override http request option.
|
|
5734
|
+
* @throws {RequiredError}
|
|
5735
|
+
*/
|
|
5736
|
+
startProgram(cell, program, programStartRequest, options) {
|
|
5737
|
+
return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
|
|
5738
|
+
},
|
|
5739
|
+
/**
|
|
5740
|
+
* Stop a specific program run.
|
|
5741
|
+
* @summary Stop program run
|
|
5742
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5743
|
+
* @param {string} program
|
|
5744
|
+
* @param {*} [options] Override http request option.
|
|
5745
|
+
* @throws {RequiredError}
|
|
5746
|
+
*/
|
|
5747
|
+
stopProgram(cell, program, options) {
|
|
5748
|
+
return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
|
|
5749
|
+
},
|
|
5750
|
+
};
|
|
5751
|
+
};
|
|
5752
|
+
/**
|
|
5753
|
+
* ProgramApi - object-oriented interface
|
|
5754
|
+
* @export
|
|
5755
|
+
* @class ProgramApi
|
|
5756
|
+
* @extends {BaseAPI}
|
|
5757
|
+
*/
|
|
5758
|
+
export class ProgramApi extends BaseAPI {
|
|
5759
|
+
/**
|
|
5760
|
+
* Get details of a program.
|
|
5761
|
+
* @summary Get program
|
|
5762
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5763
|
+
* @param {string} program
|
|
5764
|
+
* @param {*} [options] Override http request option.
|
|
5765
|
+
* @throws {RequiredError}
|
|
5766
|
+
* @memberof ProgramApi
|
|
5767
|
+
*/
|
|
5768
|
+
getProgram(cell, program, options) {
|
|
5769
|
+
return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
5770
|
+
}
|
|
5771
|
+
/**
|
|
5772
|
+
* List details of all existing programs.
|
|
5773
|
+
* @summary List programs
|
|
5774
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5775
|
+
* @param {*} [options] Override http request option.
|
|
5776
|
+
* @throws {RequiredError}
|
|
5777
|
+
* @memberof ProgramApi
|
|
5778
|
+
*/
|
|
5779
|
+
listPrograms(cell, options) {
|
|
5780
|
+
return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5781
|
+
}
|
|
5782
|
+
/**
|
|
5783
|
+
* This endpoint starts a new program execution. The program will be executed asynchronously.
|
|
5784
|
+
* @summary Start the program
|
|
5785
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5786
|
+
* @param {string} program
|
|
5787
|
+
* @param {ProgramStartRequest} programStartRequest
|
|
5788
|
+
* @param {*} [options] Override http request option.
|
|
5789
|
+
* @throws {RequiredError}
|
|
5790
|
+
* @memberof ProgramApi
|
|
5791
|
+
*/
|
|
5792
|
+
startProgram(cell, program, programStartRequest, options) {
|
|
5793
|
+
return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5794
|
+
}
|
|
5795
|
+
/**
|
|
5796
|
+
* Stop a specific program run.
|
|
5797
|
+
* @summary Stop program run
|
|
5798
|
+
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5799
|
+
* @param {string} program
|
|
5800
|
+
* @param {*} [options] Override http request option.
|
|
5801
|
+
* @throws {RequiredError}
|
|
5802
|
+
* @memberof ProgramApi
|
|
5803
|
+
*/
|
|
5804
|
+
stopProgram(cell, program, options) {
|
|
5805
|
+
return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
|
|
5806
|
+
}
|
|
5807
|
+
}
|
|
5446
5808
|
/**
|
|
5447
5809
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
5448
5810
|
* @export
|
|
@@ -5719,7 +6081,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
|
|
|
5719
6081
|
};
|
|
5720
6082
|
},
|
|
5721
6083
|
/**
|
|
5722
|
-
* Returns
|
|
6084
|
+
* Returns all stored colliders.
|
|
5723
6085
|
* @summary List Colliders
|
|
5724
6086
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5725
6087
|
* @param {*} [options] Override http request option.
|
|
@@ -6027,7 +6389,7 @@ export const StoreCollisionComponentsApiFp = function (configuration) {
|
|
|
6027
6389
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6028
6390
|
},
|
|
6029
6391
|
/**
|
|
6030
|
-
* Returns
|
|
6392
|
+
* Returns all stored colliders.
|
|
6031
6393
|
* @summary List Colliders
|
|
6032
6394
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6033
6395
|
* @param {*} [options] Override http request option.
|
|
@@ -6183,7 +6545,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration, baseP
|
|
|
6183
6545
|
return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
|
|
6184
6546
|
},
|
|
6185
6547
|
/**
|
|
6186
|
-
* Returns
|
|
6548
|
+
* Returns all stored colliders.
|
|
6187
6549
|
* @summary List Colliders
|
|
6188
6550
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6189
6551
|
* @param {*} [options] Override http request option.
|
|
@@ -6331,7 +6693,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
|
|
|
6331
6693
|
return StoreCollisionComponentsApiFp(this.configuration).listCollisionLinkChains(cell, options).then((request) => request(this.axios, this.basePath));
|
|
6332
6694
|
}
|
|
6333
6695
|
/**
|
|
6334
|
-
* Returns
|
|
6696
|
+
* Returns all stored colliders.
|
|
6335
6697
|
* @summary List Colliders
|
|
6336
6698
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
6337
6699
|
* @param {*} [options] Override http request option.
|
|
@@ -8620,7 +8982,7 @@ export class TrajectoryPlanningApi extends BaseAPI {
|
|
|
8620
8982
|
export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
8621
8983
|
return {
|
|
8622
8984
|
/**
|
|
8623
|
-
* Adds a coordinate system to the robot controller.
|
|
8985
|
+
* 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.
|
|
8624
8986
|
* @summary Add Coordinate Systems
|
|
8625
8987
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8626
8988
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8668,7 +9030,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
8668
9030
|
};
|
|
8669
9031
|
},
|
|
8670
9032
|
/**
|
|
8671
|
-
* 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
|
|
9033
|
+
* 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.
|
|
8672
9034
|
* @summary Add TCP
|
|
8673
9035
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8674
9036
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -8720,8 +9082,8 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
8720
9082
|
};
|
|
8721
9083
|
},
|
|
8722
9084
|
/**
|
|
8723
|
-
* 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
|
|
8724
|
-
* @summary
|
|
9085
|
+
* 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.
|
|
9086
|
+
* @summary Delete Coordinate System
|
|
8725
9087
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8726
9088
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
8727
9089
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -8767,7 +9129,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
8767
9129
|
};
|
|
8768
9130
|
},
|
|
8769
9131
|
/**
|
|
8770
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9132
|
+
* 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.
|
|
8771
9133
|
* @summary Remove TCP
|
|
8772
9134
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
8773
9135
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9235,7 +9597,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
|
|
|
9235
9597
|
};
|
|
9236
9598
|
},
|
|
9237
9599
|
/**
|
|
9238
|
-
* 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
|
|
9600
|
+
* 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.
|
|
9239
9601
|
* @summary Set Mounting
|
|
9240
9602
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9241
9603
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9292,7 +9654,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9292
9654
|
const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration);
|
|
9293
9655
|
return {
|
|
9294
9656
|
/**
|
|
9295
|
-
* Adds a coordinate system to the robot controller.
|
|
9657
|
+
* 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.
|
|
9296
9658
|
* @summary Add Coordinate Systems
|
|
9297
9659
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9298
9660
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9308,7 +9670,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9308
9670
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9309
9671
|
},
|
|
9310
9672
|
/**
|
|
9311
|
-
* 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
|
|
9673
|
+
* 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.
|
|
9312
9674
|
* @summary Add TCP
|
|
9313
9675
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9314
9676
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9325,8 +9687,8 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9325
9687
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9326
9688
|
},
|
|
9327
9689
|
/**
|
|
9328
|
-
* 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
|
|
9329
|
-
* @summary
|
|
9690
|
+
* 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.
|
|
9691
|
+
* @summary Delete Coordinate System
|
|
9330
9692
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9331
9693
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9332
9694
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9341,7 +9703,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9341
9703
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9342
9704
|
},
|
|
9343
9705
|
/**
|
|
9344
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9706
|
+
* 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.
|
|
9345
9707
|
* @summary Remove TCP
|
|
9346
9708
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9347
9709
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9504,7 +9866,7 @@ export const VirtualControllerApiFp = function (configuration) {
|
|
|
9504
9866
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9505
9867
|
},
|
|
9506
9868
|
/**
|
|
9507
|
-
* 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
|
|
9869
|
+
* 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.
|
|
9508
9870
|
* @summary Set Mounting
|
|
9509
9871
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9510
9872
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9529,7 +9891,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9529
9891
|
const localVarFp = VirtualControllerApiFp(configuration);
|
|
9530
9892
|
return {
|
|
9531
9893
|
/**
|
|
9532
|
-
* Adds a coordinate system to the robot controller.
|
|
9894
|
+
* 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.
|
|
9533
9895
|
* @summary Add Coordinate Systems
|
|
9534
9896
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9535
9897
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9542,7 +9904,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9542
9904
|
return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
|
|
9543
9905
|
},
|
|
9544
9906
|
/**
|
|
9545
|
-
* 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
|
|
9907
|
+
* 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.
|
|
9546
9908
|
* @summary Add TCP
|
|
9547
9909
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9548
9910
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9556,8 +9918,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9556
9918
|
return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
|
|
9557
9919
|
},
|
|
9558
9920
|
/**
|
|
9559
|
-
* 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
|
|
9560
|
-
* @summary
|
|
9921
|
+
* 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.
|
|
9922
|
+
* @summary Delete Coordinate System
|
|
9561
9923
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9562
9924
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9563
9925
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9569,7 +9931,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9569
9931
|
return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
|
|
9570
9932
|
},
|
|
9571
9933
|
/**
|
|
9572
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
9934
|
+
* 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.
|
|
9573
9935
|
* @summary Remove TCP
|
|
9574
9936
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9575
9937
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9699,7 +10061,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9699
10061
|
return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
|
|
9700
10062
|
},
|
|
9701
10063
|
/**
|
|
9702
|
-
* 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
|
|
10064
|
+
* 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.
|
|
9703
10065
|
* @summary Set Mounting
|
|
9704
10066
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9705
10067
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9721,7 +10083,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
|
|
|
9721
10083
|
*/
|
|
9722
10084
|
export class VirtualControllerApi extends BaseAPI {
|
|
9723
10085
|
/**
|
|
9724
|
-
* Adds a coordinate system to the robot controller.
|
|
10086
|
+
* 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.
|
|
9725
10087
|
* @summary Add Coordinate Systems
|
|
9726
10088
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9727
10089
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9735,7 +10097,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
9735
10097
|
return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
|
|
9736
10098
|
}
|
|
9737
10099
|
/**
|
|
9738
|
-
* 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
|
|
10100
|
+
* 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.
|
|
9739
10101
|
* @summary Add TCP
|
|
9740
10102
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9741
10103
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9750,8 +10112,8 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
9750
10112
|
return VirtualControllerApiFp(this.configuration).addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(this.axios, this.basePath));
|
|
9751
10113
|
}
|
|
9752
10114
|
/**
|
|
9753
|
-
* 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
|
|
9754
|
-
* @summary
|
|
10115
|
+
* 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.
|
|
10116
|
+
* @summary Delete Coordinate System
|
|
9755
10117
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9756
10118
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
9757
10119
|
* @param {string} coordinateSystem Unique identifier addressing a coordinate system.
|
|
@@ -9764,7 +10126,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
9764
10126
|
return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
|
|
9765
10127
|
}
|
|
9766
10128
|
/**
|
|
9767
|
-
* Removes the TCP from the motion group. An unknown TCP is a valid input.
|
|
10129
|
+
* 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.
|
|
9768
10130
|
* @summary Remove TCP
|
|
9769
10131
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9770
10132
|
* @param {string} controller Unique identifier to address a controller in the cell.
|
|
@@ -9905,7 +10267,7 @@ export class VirtualControllerApi extends BaseAPI {
|
|
|
9905
10267
|
return VirtualControllerApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
|
|
9906
10268
|
}
|
|
9907
10269
|
/**
|
|
9908
|
-
* 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
|
|
10270
|
+
* 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.
|
|
9909
10271
|
* @summary Set Mounting
|
|
9910
10272
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
9911
10273
|
* @param {string} controller Unique identifier to address a controller in the cell.
|