@wandelbots/nova-api 25.8.0-dev.8 → 25.8.0-dev.80

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/api.js CHANGED
@@ -50,7 +50,7 @@ export const BusIOProfinetBusTypeEnum = {
50
50
  Profinet: 'profinet'
51
51
  };
52
52
  export const BusIOProfinetVirtualBusTypeEnum = {
53
- VirtualProfinet: 'virtual_profinet'
53
+ ProfinetVirtual: 'profinet_virtual'
54
54
  };
55
55
  /**
56
56
  * Current state of the BUS input/output service.
@@ -329,7 +329,7 @@ export const PlaybackSpeedResponseKindEnum = {
329
329
  PlaybackSpeedReceived: 'PLAYBACK_SPEED_RECEIVED'
330
330
  };
331
331
  /**
332
- * Identifies the input/output type.
332
+ * The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g. NOVA\'s PROFINET service.
333
333
  * @export
334
334
  * @enum {string}
335
335
  */
@@ -339,7 +339,7 @@ export const ProfinetIODirection = {
339
339
  ProfinetIoDirectionInout: 'PROFINET_IO_DIRECTION_INOUT'
340
340
  };
341
341
  /**
342
- * Value type of the PROFINET input/output.
342
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
343
343
  * @export
344
344
  * @enum {string}
345
345
  */
@@ -355,6 +355,18 @@ export const ProfinetIOTypeEnum = {
355
355
  ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
356
356
  ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
357
357
  };
358
+ /**
359
+ * The state of a program run.
360
+ * @export
361
+ * @enum {string}
362
+ */
363
+ export const ProgramRunState = {
364
+ Preparing: 'PREPARING',
365
+ Running: 'RUNNING',
366
+ Completed: 'COMPLETED',
367
+ Failed: 'FAILED',
368
+ Stopped: 'STOPPED'
369
+ };
358
370
  export const RRTConnectAlgorithmAlgorithmNameEnum = {
359
371
  RrtConnectAlgorithm: 'RRTConnectAlgorithm'
360
372
  };
@@ -607,11 +619,13 @@ export const VirtualControllerTypes = {
607
619
  KukaKr4R600: 'kuka-kr4_r600',
608
620
  KukaKr500L3403: 'kuka-kr500_l340_3',
609
621
  KukaKr50R2500: 'kuka-kr50_r2500',
622
+ KukaKr60R3: 'kuka-kr60_r3',
610
623
  KukaKr6R1820: 'kuka-kr6_r1820',
611
624
  KukaKr6R7002: 'kuka-kr6_r700_2',
612
625
  KukaKr6R700Sixx: 'kuka-kr6_r700_sixx',
613
626
  KukaKr6R900: 'kuka-kr6_r900',
614
627
  KukaKr6R9002: 'kuka-kr6_r900_2',
628
+ KukaKr70R2100: 'kuka-kr70_r2100',
615
629
  KukaLbrIisy11R1300: 'kuka-lbr_iisy_11_r1300',
616
630
  UniversalrobotsUr10cb: 'universalrobots-ur10cb',
617
631
  UniversalrobotsUr10e: 'universalrobots-ur10e',
@@ -1170,7 +1184,7 @@ export class ApplicationApi extends BaseAPI {
1170
1184
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1171
1185
  return {
1172
1186
  /**
1173
- * Add a BUS Inputs/Outputs Service to the cell.
1187
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1174
1188
  * @summary Add Service
1175
1189
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1176
1190
  * @param {BusIOType} busIOType
@@ -1214,7 +1228,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1214
1228
  };
1215
1229
  },
1216
1230
  /**
1217
- * Adds an input/output to or updates an input/output on the PROFINET device.
1231
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. 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 third party software, e.g. TIA portal).
1218
1232
  * @summary Add PROFINET Input/Output
1219
1233
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1220
1234
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1258,7 +1272,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1258
1272
  };
1259
1273
  },
1260
1274
  /**
1261
- * Delete BUS Inputs/Outputs Service from the cell.
1275
+ * Remove the BUS inputs/outputs service from the cell.
1262
1276
  * @summary Clear Service
1263
1277
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1264
1278
  * @param {number} [completionTimeout]
@@ -1297,7 +1311,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1297
1311
  };
1298
1312
  },
1299
1313
  /**
1300
- * Removes the input/output from the PROFINET device.
1314
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1301
1315
  * @summary Remove PROFINET Input/Ouptut
1302
1316
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1303
1317
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1336,7 +1350,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1336
1350
  };
1337
1351
  },
1338
1352
  /**
1339
- * Get deployed BUS Inputs/Outputs Service.
1353
+ * Get deployed BUS inputs/outputs service.
1340
1354
  * @summary Get Service
1341
1355
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1342
1356
  * @param {*} [options] Override http request option.
@@ -1445,7 +1459,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1445
1459
  };
1446
1460
  },
1447
1461
  /**
1448
- * Get description of PROFINET
1462
+ * Get description of NOVA as a PROFINET device.
1449
1463
  * @summary Get PROFINET Description
1450
1464
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1451
1465
  * @param {*} [options] Override http request option.
@@ -1480,7 +1494,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1480
1494
  };
1481
1495
  },
1482
1496
  /**
1483
- * Get input/output configuration of the PROFINET device as file.
1497
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
1484
1498
  * @summary PROFINET Inputs/Outputs to File
1485
1499
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1486
1500
  * @param {number} [inputOffset]
@@ -1523,7 +1537,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1523
1537
  };
1524
1538
  },
1525
1539
  /**
1526
- * List all BUS Input/Output descriptions.
1540
+ * 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
1541
  * @summary List Descriptions
1528
1542
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1529
1543
  * @param {*} [options] Override http request option.
@@ -1558,7 +1572,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1558
1572
  };
1559
1573
  },
1560
1574
  /**
1561
- * List all PROFINET input and outputs.
1575
+ * 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
1576
  * @summary List PROFINET Input/Output Configuration
1563
1577
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1564
1578
  * @param {*} [options] Override http request option.
@@ -1633,7 +1647,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1633
1647
  };
1634
1648
  },
1635
1649
  /**
1636
- * Sets inputs/outputs on the PROFINET device from file.
1650
+ * 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
1651
  * @summary Set PROFINET Inputs/Outputs from File
1638
1652
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1639
1653
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -1682,7 +1696,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1682
1696
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration);
1683
1697
  return {
1684
1698
  /**
1685
- * Add a BUS Inputs/Outputs Service to the cell.
1699
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1686
1700
  * @summary Add Service
1687
1701
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1688
1702
  * @param {BusIOType} busIOType
@@ -1697,7 +1711,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1697
1711
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1698
1712
  },
1699
1713
  /**
1700
- * Adds an input/output to or updates an input/output on the PROFINET device.
1714
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. 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 third party software, e.g. TIA portal).
1701
1715
  * @summary Add PROFINET Input/Output
1702
1716
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1703
1717
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1712,7 +1726,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1712
1726
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1713
1727
  },
1714
1728
  /**
1715
- * Delete BUS Inputs/Outputs Service from the cell.
1729
+ * Remove the BUS inputs/outputs service from the cell.
1716
1730
  * @summary Clear Service
1717
1731
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1718
1732
  * @param {number} [completionTimeout]
@@ -1726,7 +1740,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1726
1740
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1727
1741
  },
1728
1742
  /**
1729
- * Removes the input/output from the PROFINET device.
1743
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1730
1744
  * @summary Remove PROFINET Input/Ouptut
1731
1745
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1732
1746
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1740,7 +1754,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1740
1754
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1741
1755
  },
1742
1756
  /**
1743
- * Get deployed BUS Inputs/Outputs Service.
1757
+ * Get deployed BUS inputs/outputs service.
1744
1758
  * @summary Get Service
1745
1759
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1746
1760
  * @param {*} [options] Override http request option.
@@ -1780,7 +1794,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1780
1794
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1781
1795
  },
1782
1796
  /**
1783
- * Get description of PROFINET
1797
+ * Get description of NOVA as a PROFINET device.
1784
1798
  * @summary Get PROFINET Description
1785
1799
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1786
1800
  * @param {*} [options] Override http request option.
@@ -1793,7 +1807,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1793
1807
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1794
1808
  },
1795
1809
  /**
1796
- * Get input/output configuration of the PROFINET device as file.
1810
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
1797
1811
  * @summary PROFINET Inputs/Outputs to File
1798
1812
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1799
1813
  * @param {number} [inputOffset]
@@ -1808,7 +1822,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1808
1822
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1809
1823
  },
1810
1824
  /**
1811
- * List all BUS Input/Output descriptions.
1825
+ * 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
1826
  * @summary List Descriptions
1813
1827
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1814
1828
  * @param {*} [options] Override http request option.
@@ -1821,7 +1835,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1821
1835
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1822
1836
  },
1823
1837
  /**
1824
- * List all PROFINET input and outputs.
1838
+ * 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
1839
  * @summary List PROFINET Input/Output Configuration
1826
1840
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1827
1841
  * @param {*} [options] Override http request option.
@@ -1848,7 +1862,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1848
1862
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1849
1863
  },
1850
1864
  /**
1851
- * Sets inputs/outputs on the PROFINET device from file.
1865
+ * 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
1866
  * @summary Set PROFINET Inputs/Outputs from File
1853
1867
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1854
1868
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -1871,7 +1885,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1871
1885
  const localVarFp = BUSInputsOutputsApiFp(configuration);
1872
1886
  return {
1873
1887
  /**
1874
- * Add a BUS Inputs/Outputs Service to the cell.
1888
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1875
1889
  * @summary Add Service
1876
1890
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1877
1891
  * @param {BusIOType} busIOType
@@ -1883,7 +1897,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1883
1897
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
1884
1898
  },
1885
1899
  /**
1886
- * Adds an input/output to or updates an input/output on the PROFINET device.
1900
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. 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 third party software, e.g. TIA portal).
1887
1901
  * @summary Add PROFINET Input/Output
1888
1902
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1889
1903
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1895,7 +1909,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1895
1909
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
1896
1910
  },
1897
1911
  /**
1898
- * Delete BUS Inputs/Outputs Service from the cell.
1912
+ * Remove the BUS inputs/outputs service from the cell.
1899
1913
  * @summary Clear Service
1900
1914
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1901
1915
  * @param {number} [completionTimeout]
@@ -1906,7 +1920,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1906
1920
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
1907
1921
  },
1908
1922
  /**
1909
- * Removes the input/output from the PROFINET device.
1923
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1910
1924
  * @summary Remove PROFINET Input/Ouptut
1911
1925
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1912
1926
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1917,7 +1931,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1917
1931
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
1918
1932
  },
1919
1933
  /**
1920
- * Get deployed BUS Inputs/Outputs Service.
1934
+ * Get deployed BUS inputs/outputs service.
1921
1935
  * @summary Get Service
1922
1936
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1923
1937
  * @param {*} [options] Override http request option.
@@ -1948,7 +1962,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1948
1962
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
1949
1963
  },
1950
1964
  /**
1951
- * Get description of PROFINET
1965
+ * Get description of NOVA as a PROFINET device.
1952
1966
  * @summary Get PROFINET Description
1953
1967
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1954
1968
  * @param {*} [options] Override http request option.
@@ -1958,7 +1972,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1958
1972
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
1959
1973
  },
1960
1974
  /**
1961
- * Get input/output configuration of the PROFINET device as file.
1975
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
1962
1976
  * @summary PROFINET Inputs/Outputs to File
1963
1977
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1964
1978
  * @param {number} [inputOffset]
@@ -1970,7 +1984,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1970
1984
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
1971
1985
  },
1972
1986
  /**
1973
- * List all BUS Input/Output descriptions.
1987
+ * 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
1988
  * @summary List Descriptions
1975
1989
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1976
1990
  * @param {*} [options] Override http request option.
@@ -1980,7 +1994,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1980
1994
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
1981
1995
  },
1982
1996
  /**
1983
- * List all PROFINET input and outputs.
1997
+ * 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
1998
  * @summary List PROFINET Input/Output Configuration
1985
1999
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1986
2000
  * @param {*} [options] Override http request option.
@@ -2001,7 +2015,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
2001
2015
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
2002
2016
  },
2003
2017
  /**
2004
- * Sets inputs/outputs on the PROFINET device from file.
2018
+ * 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
2019
  * @summary Set PROFINET Inputs/Outputs from File
2006
2020
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2007
2021
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -2021,7 +2035,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
2021
2035
  */
2022
2036
  export class BUSInputsOutputsApi extends BaseAPI {
2023
2037
  /**
2024
- * Add a BUS Inputs/Outputs Service to the cell.
2038
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
2025
2039
  * @summary Add Service
2026
2040
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2027
2041
  * @param {BusIOType} busIOType
@@ -2034,7 +2048,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2034
2048
  return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2035
2049
  }
2036
2050
  /**
2037
- * Adds an input/output to or updates an input/output on the PROFINET device.
2051
+ * Adds an input/output variable to or updates an input/output variable on the PROFINET device, e.g. NOVA\'s PROFINET service. 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 third party software, e.g. TIA portal).
2038
2052
  * @summary Add PROFINET Input/Output
2039
2053
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2040
2054
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -2047,7 +2061,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2047
2061
  return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
2048
2062
  }
2049
2063
  /**
2050
- * Delete BUS Inputs/Outputs Service from the cell.
2064
+ * Remove the BUS inputs/outputs service from the cell.
2051
2065
  * @summary Clear Service
2052
2066
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2053
2067
  * @param {number} [completionTimeout]
@@ -2059,7 +2073,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2059
2073
  return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2060
2074
  }
2061
2075
  /**
2062
- * Removes the input/output from the PROFINET device.
2076
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
2063
2077
  * @summary Remove PROFINET Input/Ouptut
2064
2078
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2065
2079
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -2071,7 +2085,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2071
2085
  return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
2072
2086
  }
2073
2087
  /**
2074
- * Get deployed BUS Inputs/Outputs Service.
2088
+ * Get deployed BUS inputs/outputs service.
2075
2089
  * @summary Get Service
2076
2090
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2077
2091
  * @param {*} [options] Override http request option.
@@ -2105,7 +2119,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2105
2119
  return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
2106
2120
  }
2107
2121
  /**
2108
- * Get description of PROFINET
2122
+ * Get description of NOVA as a PROFINET device.
2109
2123
  * @summary Get PROFINET Description
2110
2124
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2111
2125
  * @param {*} [options] Override http request option.
@@ -2116,7 +2130,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2116
2130
  return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
2117
2131
  }
2118
2132
  /**
2119
- * Get input/output configuration of the PROFINET device as file.
2133
+ * Get input/output variable configuration of the PROFINET device, e.g. NOVA\'s PROFINET service as file. You can specify byte offsets for the input and output variable addresses to get an XML tagmap that is ready to paste to the third party software, e.g. TIA portal.
2120
2134
  * @summary PROFINET Inputs/Outputs to File
2121
2135
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2122
2136
  * @param {number} [inputOffset]
@@ -2129,7 +2143,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2129
2143
  return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
2130
2144
  }
2131
2145
  /**
2132
- * List all BUS Input/Output descriptions.
2146
+ * 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
2147
  * @summary List Descriptions
2134
2148
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2135
2149
  * @param {*} [options] Override http request option.
@@ -2140,7 +2154,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2140
2154
  return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
2141
2155
  }
2142
2156
  /**
2143
- * List all PROFINET input and outputs.
2157
+ * 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
2158
  * @summary List PROFINET Input/Output Configuration
2145
2159
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2146
2160
  * @param {*} [options] Override http request option.
@@ -2163,7 +2177,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2163
2177
  return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
2164
2178
  }
2165
2179
  /**
2166
- * Sets inputs/outputs on the PROFINET device from file.
2180
+ * 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
2181
  * @summary Set PROFINET Inputs/Outputs from File
2168
2182
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2169
2183
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5271,7 +5285,7 @@ export class MotionGroupApi extends BaseAPI {
5271
5285
  export const MotionGroupModelsApiAxiosParamCreator = function (configuration) {
5272
5286
  return {
5273
5287
  /**
5274
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) 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. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5288
+ * 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
5289
  * @summary Get Collision Model
5276
5290
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5277
5291
  * @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 +5368,7 @@ export const MotionGroupModelsApiFp = function (configuration) {
5354
5368
  const localVarAxiosParamCreator = MotionGroupModelsApiAxiosParamCreator(configuration);
5355
5369
  return {
5356
5370
  /**
5357
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) 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. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5371
+ * 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
5372
  * @summary Get Collision Model
5359
5373
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5360
5374
  * @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 +5404,7 @@ export const MotionGroupModelsApiFactory = function (configuration, basePath, ax
5390
5404
  const localVarFp = MotionGroupModelsApiFp(configuration);
5391
5405
  return {
5392
5406
  /**
5393
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) 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. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5407
+ * 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
5408
  * @summary Get Collision Model
5395
5409
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5396
5410
  * @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 +5434,7 @@ export const MotionGroupModelsApiFactory = function (configuration, basePath, ax
5420
5434
  */
5421
5435
  export class MotionGroupModelsApi extends BaseAPI {
5422
5436
  /**
5423
- * Returns the default collision link chain for a given motion group model. See [getMotionGroupDescription](getMotionGroupDescription) 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. Use the `stored_link_chain` or `link_chain` field in [storeCollisionScene](storeCollisionScene) to attach additional shapes to the link reference frames. Additional shapes may overlap each other per link and may also overlap the respective link\'s default shape.
5437
+ * 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
5438
  * @summary Get Collision Model
5425
5439
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5426
5440
  * @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 +5457,345 @@ export class MotionGroupModelsApi extends BaseAPI {
5443
5457
  return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(cell, options).then((request) => request(this.axios, this.basePath));
5444
5458
  }
5445
5459
  }
5460
+ /**
5461
+ * ProgramApi - axios parameter creator
5462
+ * @export
5463
+ */
5464
+ export const ProgramApiAxiosParamCreator = function (configuration) {
5465
+ return {
5466
+ /**
5467
+ * Get details of a program.
5468
+ * @summary Get program
5469
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5470
+ * @param {string} program
5471
+ * @param {*} [options] Override http request option.
5472
+ * @throws {RequiredError}
5473
+ */
5474
+ getProgram: async (cell, program, options = {}) => {
5475
+ // verify required parameter 'cell' is not null or undefined
5476
+ assertParamExists('getProgram', 'cell', cell);
5477
+ // verify required parameter 'program' is not null or undefined
5478
+ assertParamExists('getProgram', 'program', program);
5479
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}`
5480
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5481
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
5482
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5483
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5484
+ let baseOptions;
5485
+ if (configuration) {
5486
+ baseOptions = configuration.baseOptions;
5487
+ }
5488
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
5489
+ const localVarHeaderParameter = {};
5490
+ const localVarQueryParameter = {};
5491
+ // authentication BasicAuth required
5492
+ // http basic authentication required
5493
+ setBasicAuthToObject(localVarRequestOptions, configuration);
5494
+ // authentication BearerAuth required
5495
+ // http bearer authentication required
5496
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
5497
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5498
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5499
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5500
+ return {
5501
+ url: toPathString(localVarUrlObj),
5502
+ options: localVarRequestOptions,
5503
+ };
5504
+ },
5505
+ /**
5506
+ * List details of all existing programs.
5507
+ * @summary List programs
5508
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5509
+ * @param {*} [options] Override http request option.
5510
+ * @throws {RequiredError}
5511
+ */
5512
+ listPrograms: async (cell, options = {}) => {
5513
+ // verify required parameter 'cell' is not null or undefined
5514
+ assertParamExists('listPrograms', 'cell', cell);
5515
+ const localVarPath = `/experimental/cells/{cell}/programs`
5516
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
5517
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5518
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5519
+ let baseOptions;
5520
+ if (configuration) {
5521
+ baseOptions = configuration.baseOptions;
5522
+ }
5523
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
5524
+ const localVarHeaderParameter = {};
5525
+ const localVarQueryParameter = {};
5526
+ // authentication BasicAuth required
5527
+ // http basic authentication required
5528
+ setBasicAuthToObject(localVarRequestOptions, configuration);
5529
+ // authentication BearerAuth required
5530
+ // http bearer authentication required
5531
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
5532
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5533
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5534
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5535
+ return {
5536
+ url: toPathString(localVarUrlObj),
5537
+ options: localVarRequestOptions,
5538
+ };
5539
+ },
5540
+ /**
5541
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
5542
+ * @summary Start the program
5543
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5544
+ * @param {string} program
5545
+ * @param {ProgramStartRequest} programStartRequest
5546
+ * @param {*} [options] Override http request option.
5547
+ * @throws {RequiredError}
5548
+ */
5549
+ startProgram: async (cell, program, programStartRequest, options = {}) => {
5550
+ // verify required parameter 'cell' is not null or undefined
5551
+ assertParamExists('startProgram', 'cell', cell);
5552
+ // verify required parameter 'program' is not null or undefined
5553
+ assertParamExists('startProgram', 'program', program);
5554
+ // verify required parameter 'programStartRequest' is not null or undefined
5555
+ assertParamExists('startProgram', 'programStartRequest', programStartRequest);
5556
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
5557
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5558
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
5559
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5560
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5561
+ let baseOptions;
5562
+ if (configuration) {
5563
+ baseOptions = configuration.baseOptions;
5564
+ }
5565
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
5566
+ const localVarHeaderParameter = {};
5567
+ const localVarQueryParameter = {};
5568
+ // authentication BasicAuth required
5569
+ // http basic authentication required
5570
+ setBasicAuthToObject(localVarRequestOptions, configuration);
5571
+ // authentication BearerAuth required
5572
+ // http bearer authentication required
5573
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
5574
+ localVarHeaderParameter['Content-Type'] = 'application/json';
5575
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5576
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5577
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5578
+ localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration);
5579
+ return {
5580
+ url: toPathString(localVarUrlObj),
5581
+ options: localVarRequestOptions,
5582
+ };
5583
+ },
5584
+ /**
5585
+ * Stop a specific program run.
5586
+ * @summary Stop program run
5587
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5588
+ * @param {string} program
5589
+ * @param {*} [options] Override http request option.
5590
+ * @throws {RequiredError}
5591
+ */
5592
+ stopProgram: async (cell, program, options = {}) => {
5593
+ // verify required parameter 'cell' is not null or undefined
5594
+ assertParamExists('stopProgram', 'cell', cell);
5595
+ // verify required parameter 'program' is not null or undefined
5596
+ assertParamExists('stopProgram', 'program', program);
5597
+ const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
5598
+ .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
5599
+ .replace(`{${"program"}}`, encodeURIComponent(String(program)));
5600
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5601
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5602
+ let baseOptions;
5603
+ if (configuration) {
5604
+ baseOptions = configuration.baseOptions;
5605
+ }
5606
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
5607
+ const localVarHeaderParameter = {};
5608
+ const localVarQueryParameter = {};
5609
+ // authentication BasicAuth required
5610
+ // http basic authentication required
5611
+ setBasicAuthToObject(localVarRequestOptions, configuration);
5612
+ // authentication BearerAuth required
5613
+ // http bearer authentication required
5614
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
5615
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5616
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5617
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
5618
+ return {
5619
+ url: toPathString(localVarUrlObj),
5620
+ options: localVarRequestOptions,
5621
+ };
5622
+ },
5623
+ };
5624
+ };
5625
+ /**
5626
+ * ProgramApi - functional programming interface
5627
+ * @export
5628
+ */
5629
+ export const ProgramApiFp = function (configuration) {
5630
+ const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration);
5631
+ return {
5632
+ /**
5633
+ * Get details of a program.
5634
+ * @summary Get program
5635
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5636
+ * @param {string} program
5637
+ * @param {*} [options] Override http request option.
5638
+ * @throws {RequiredError}
5639
+ */
5640
+ async getProgram(cell, program, options) {
5641
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
5642
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5643
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
5644
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5645
+ },
5646
+ /**
5647
+ * List details of all existing programs.
5648
+ * @summary List programs
5649
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5650
+ * @param {*} [options] Override http request option.
5651
+ * @throws {RequiredError}
5652
+ */
5653
+ async listPrograms(cell, options) {
5654
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
5655
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5656
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
5657
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5658
+ },
5659
+ /**
5660
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
5661
+ * @summary Start the program
5662
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5663
+ * @param {string} program
5664
+ * @param {ProgramStartRequest} programStartRequest
5665
+ * @param {*} [options] Override http request option.
5666
+ * @throws {RequiredError}
5667
+ */
5668
+ async startProgram(cell, program, programStartRequest, options) {
5669
+ const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
5670
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5671
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
5672
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5673
+ },
5674
+ /**
5675
+ * Stop a specific program run.
5676
+ * @summary Stop program run
5677
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5678
+ * @param {string} program
5679
+ * @param {*} [options] Override http request option.
5680
+ * @throws {RequiredError}
5681
+ */
5682
+ async stopProgram(cell, program, options) {
5683
+ const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
5684
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
5685
+ const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
5686
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
5687
+ },
5688
+ };
5689
+ };
5690
+ /**
5691
+ * ProgramApi - factory interface
5692
+ * @export
5693
+ */
5694
+ export const ProgramApiFactory = function (configuration, basePath, axios) {
5695
+ const localVarFp = ProgramApiFp(configuration);
5696
+ return {
5697
+ /**
5698
+ * Get details of a program.
5699
+ * @summary Get program
5700
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5701
+ * @param {string} program
5702
+ * @param {*} [options] Override http request option.
5703
+ * @throws {RequiredError}
5704
+ */
5705
+ getProgram(cell, program, options) {
5706
+ return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
5707
+ },
5708
+ /**
5709
+ * List details of all existing programs.
5710
+ * @summary List programs
5711
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5712
+ * @param {*} [options] Override http request option.
5713
+ * @throws {RequiredError}
5714
+ */
5715
+ listPrograms(cell, options) {
5716
+ return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
5717
+ },
5718
+ /**
5719
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
5720
+ * @summary Start the program
5721
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5722
+ * @param {string} program
5723
+ * @param {ProgramStartRequest} programStartRequest
5724
+ * @param {*} [options] Override http request option.
5725
+ * @throws {RequiredError}
5726
+ */
5727
+ startProgram(cell, program, programStartRequest, options) {
5728
+ return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
5729
+ },
5730
+ /**
5731
+ * Stop a specific program run.
5732
+ * @summary Stop program run
5733
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5734
+ * @param {string} program
5735
+ * @param {*} [options] Override http request option.
5736
+ * @throws {RequiredError}
5737
+ */
5738
+ stopProgram(cell, program, options) {
5739
+ return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
5740
+ },
5741
+ };
5742
+ };
5743
+ /**
5744
+ * ProgramApi - object-oriented interface
5745
+ * @export
5746
+ * @class ProgramApi
5747
+ * @extends {BaseAPI}
5748
+ */
5749
+ export class ProgramApi extends BaseAPI {
5750
+ /**
5751
+ * Get details of a program.
5752
+ * @summary Get program
5753
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5754
+ * @param {string} program
5755
+ * @param {*} [options] Override http request option.
5756
+ * @throws {RequiredError}
5757
+ * @memberof ProgramApi
5758
+ */
5759
+ getProgram(cell, program, options) {
5760
+ return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
5761
+ }
5762
+ /**
5763
+ * List details of all existing programs.
5764
+ * @summary List programs
5765
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5766
+ * @param {*} [options] Override http request option.
5767
+ * @throws {RequiredError}
5768
+ * @memberof ProgramApi
5769
+ */
5770
+ listPrograms(cell, options) {
5771
+ return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
5772
+ }
5773
+ /**
5774
+ * This endpoint starts a new program execution. The program will be executed asynchronously.
5775
+ * @summary Start the program
5776
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5777
+ * @param {string} program
5778
+ * @param {ProgramStartRequest} programStartRequest
5779
+ * @param {*} [options] Override http request option.
5780
+ * @throws {RequiredError}
5781
+ * @memberof ProgramApi
5782
+ */
5783
+ startProgram(cell, program, programStartRequest, options) {
5784
+ return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
5785
+ }
5786
+ /**
5787
+ * Stop a specific program run.
5788
+ * @summary Stop program run
5789
+ * @param {string} cell Unique identifier addressing a cell in all API calls.
5790
+ * @param {string} program
5791
+ * @param {*} [options] Override http request option.
5792
+ * @throws {RequiredError}
5793
+ * @memberof ProgramApi
5794
+ */
5795
+ stopProgram(cell, program, options) {
5796
+ return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
5797
+ }
5798
+ }
5446
5799
  /**
5447
5800
  * StoreCollisionComponentsApi - axios parameter creator
5448
5801
  * @export
@@ -5719,7 +6072,7 @@ export const StoreCollisionComponentsApiAxiosParamCreator = function (configurat
5719
6072
  };
5720
6073
  },
5721
6074
  /**
5722
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
6075
+ * Returns all stored colliders.
5723
6076
  * @summary List Colliders
5724
6077
  * @param {string} cell Unique identifier addressing a cell in all API calls.
5725
6078
  * @param {*} [options] Override http request option.
@@ -6027,7 +6380,7 @@ export const StoreCollisionComponentsApiFp = function (configuration) {
6027
6380
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6028
6381
  },
6029
6382
  /**
6030
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
6383
+ * Returns all stored colliders.
6031
6384
  * @summary List Colliders
6032
6385
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6033
6386
  * @param {*} [options] Override http request option.
@@ -6183,7 +6536,7 @@ export const StoreCollisionComponentsApiFactory = function (configuration, baseP
6183
6536
  return localVarFp.listCollisionLinkChains(cell, options).then((request) => request(axios, basePath));
6184
6537
  },
6185
6538
  /**
6186
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
6539
+ * Returns all stored colliders.
6187
6540
  * @summary List Colliders
6188
6541
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6189
6542
  * @param {*} [options] Override http request option.
@@ -6331,7 +6684,7 @@ export class StoreCollisionComponentsApi extends BaseAPI {
6331
6684
  return StoreCollisionComponentsApiFp(this.configuration).listCollisionLinkChains(cell, options).then((request) => request(this.axios, this.basePath));
6332
6685
  }
6333
6686
  /**
6334
- * Returns a list of colliders in a scene. This excludes colliders that are part of a motion group.
6687
+ * Returns all stored colliders.
6335
6688
  * @summary List Colliders
6336
6689
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6337
6690
  * @param {*} [options] Override http request option.
@@ -8620,7 +8973,7 @@ export class TrajectoryPlanningApi extends BaseAPI {
8620
8973
  export const VirtualControllerApiAxiosParamCreator = function (configuration) {
8621
8974
  return {
8622
8975
  /**
8623
- * Adds a coordinate system to the robot controller.
8976
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
8624
8977
  * @summary Add Coordinate Systems
8625
8978
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8626
8979
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8668,7 +9021,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
8668
9021
  };
8669
9022
  },
8670
9023
  /**
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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
9024
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
8672
9025
  * @summary Add TCP
8673
9026
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8674
9027
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8720,8 +9073,8 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
8720
9073
  };
8721
9074
  },
8722
9075
  /**
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 which use the deleted coordinate system as reference.
8724
- * @summary Remove Coordinate System
9076
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
9077
+ * @summary Delete Coordinate System
8725
9078
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8726
9079
  * @param {string} controller Unique identifier to address a controller in the cell.
8727
9080
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -8767,7 +9120,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
8767
9120
  };
8768
9121
  },
8769
9122
  /**
8770
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9123
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
8771
9124
  * @summary Remove TCP
8772
9125
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8773
9126
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9235,7 +9588,7 @@ export const VirtualControllerApiAxiosParamCreator = function (configuration) {
9235
9588
  };
9236
9589
  },
9237
9590
  /**
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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
9591
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
9239
9592
  * @summary Set Mounting
9240
9593
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9241
9594
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9292,7 +9645,7 @@ export const VirtualControllerApiFp = function (configuration) {
9292
9645
  const localVarAxiosParamCreator = VirtualControllerApiAxiosParamCreator(configuration);
9293
9646
  return {
9294
9647
  /**
9295
- * Adds a coordinate system to the robot controller.
9648
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
9296
9649
  * @summary Add Coordinate Systems
9297
9650
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9298
9651
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9308,7 +9661,7 @@ export const VirtualControllerApiFp = function (configuration) {
9308
9661
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9309
9662
  },
9310
9663
  /**
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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
9664
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
9312
9665
  * @summary Add TCP
9313
9666
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9314
9667
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9325,8 +9678,8 @@ export const VirtualControllerApiFp = function (configuration) {
9325
9678
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9326
9679
  },
9327
9680
  /**
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 which use the deleted coordinate system as reference.
9329
- * @summary Remove Coordinate System
9681
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
9682
+ * @summary Delete Coordinate System
9330
9683
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9331
9684
  * @param {string} controller Unique identifier to address a controller in the cell.
9332
9685
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -9341,7 +9694,7 @@ export const VirtualControllerApiFp = function (configuration) {
9341
9694
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9342
9695
  },
9343
9696
  /**
9344
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9697
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
9345
9698
  * @summary Remove TCP
9346
9699
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9347
9700
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9504,7 +9857,7 @@ export const VirtualControllerApiFp = function (configuration) {
9504
9857
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9505
9858
  },
9506
9859
  /**
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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
9860
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
9508
9861
  * @summary Set Mounting
9509
9862
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9510
9863
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9529,7 +9882,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
9529
9882
  const localVarFp = VirtualControllerApiFp(configuration);
9530
9883
  return {
9531
9884
  /**
9532
- * Adds a coordinate system to the robot controller.
9885
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
9533
9886
  * @summary Add Coordinate Systems
9534
9887
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9535
9888
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9542,7 +9895,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
9542
9895
  return localVarFp.addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(axios, basePath));
9543
9896
  },
9544
9897
  /**
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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
9898
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
9546
9899
  * @summary Add TCP
9547
9900
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9548
9901
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9556,8 +9909,8 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
9556
9909
  return localVarFp.addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(axios, basePath));
9557
9910
  },
9558
9911
  /**
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 which use the deleted coordinate system as reference.
9560
- * @summary Remove Coordinate System
9912
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
9913
+ * @summary Delete Coordinate System
9561
9914
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9562
9915
  * @param {string} controller Unique identifier to address a controller in the cell.
9563
9916
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -9569,7 +9922,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
9569
9922
  return localVarFp.deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(axios, basePath));
9570
9923
  },
9571
9924
  /**
9572
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
9925
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
9573
9926
  * @summary Remove TCP
9574
9927
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9575
9928
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9699,7 +10052,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
9699
10052
  return localVarFp.setOperationMode(cell, controller, mode, options).then((request) => request(axios, basePath));
9700
10053
  },
9701
10054
  /**
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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
10055
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
9703
10056
  * @summary Set Mounting
9704
10057
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9705
10058
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9721,7 +10074,7 @@ export const VirtualControllerApiFactory = function (configuration, basePath, ax
9721
10074
  */
9722
10075
  export class VirtualControllerApi extends BaseAPI {
9723
10076
  /**
9724
- * Adds a coordinate system to the robot controller.
10077
+ * Adds a coordinate system to the robot controller. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
9725
10078
  * @summary Add Coordinate Systems
9726
10079
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9727
10080
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9735,7 +10088,7 @@ export class VirtualControllerApi extends BaseAPI {
9735
10088
  return VirtualControllerApiFp(this.configuration).addVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, coordinateSystemData, options).then((request) => request(this.axios, this.basePath));
9736
10089
  }
9737
10090
  /**
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 flanges coordinate system. > **NOTE** > > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robots documentation or data sheet for details like joint limits or reach.
10091
+ * Adds a new TCP (Tool Center Point) or updates an existing TCP in the motion group. The position and rotation values in the request body are defined within the flange\'s coordinate system. > **NOTE** > Ensure the TCP\'s position is within the robot\'s reach. Refer to the robot\'s documentation or data sheet for details like joint limits or reach. **Important notes:** - Adding or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
9739
10092
  * @summary Add TCP
9740
10093
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9741
10094
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9750,8 +10103,8 @@ export class VirtualControllerApi extends BaseAPI {
9750
10103
  return VirtualControllerApiFp(this.configuration).addVirtualControllerTcp(cell, controller, motionGroup, tcp, robotTcpData, options).then((request) => request(this.axios, this.basePath));
9751
10104
  }
9752
10105
  /**
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 which use the deleted coordinate system as reference.
9754
- * @summary Remove Coordinate System
10106
+ * Deletes a coordinate system from the virtual controller. This will remove the coordinate system from the list of coordinate systems and also remove all dependent coordinate systems that use the deleted coordinate system as reference. **Important notes:** - When a new coordinate system is added/removed, the **virtual robot is restarted** in the background in order to apply the new configuration. - During this restart: - Robot visualization may temporarily disappear or appear outdated in the UI. - coordinate system changes are not immediately visible in visualizations. - All existing connections to the virtual robot are closed and re-established, which introduces a short delay before the system is fully operational again. - The API call itself does **not wait until the restart and re-synchronization are complete**. This means that immediately after a successful response, the new coordinate system may not yet be available for visualization or program execution.
10107
+ * @summary Delete Coordinate System
9755
10108
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9756
10109
  * @param {string} controller Unique identifier to address a controller in the cell.
9757
10110
  * @param {string} coordinateSystem Unique identifier addressing a coordinate system.
@@ -9764,7 +10117,7 @@ export class VirtualControllerApi extends BaseAPI {
9764
10117
  return VirtualControllerApiFp(this.configuration).deleteVirtualControllerCoordinateSystem(cell, controller, coordinateSystem, deleteDependent, options).then((request) => request(this.axios, this.basePath));
9765
10118
  }
9766
10119
  /**
9767
- * Removes the TCP from the motion group. An unknown TCP is a valid input.
10120
+ * Removes the TCP (Tool Center Point) from the motion group. An unknown TCP is a valid input and will simply be ignored. **Important notes:** - Removing or updating a TCP triggers a **virtual robot restart** to apply the new configuration. - During this restart: - The robot visualization in the UI may temporarily disappear. - The TCP visualization may not immediately appear, or may look outdated during the first test/rerun. - All active connections to the virtual robot are closed and then re-established. This creates a delay before the TCP is available in both the UI and robot programs. - The API call itself does **not wait until the restart and synchronization are complete**. Even if the request succeeds, the new or updated TCP may not yet be visible in the GUI or available for use.
9768
10121
  * @summary Remove TCP
9769
10122
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9770
10123
  * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9905,7 +10258,7 @@ export class VirtualControllerApi extends BaseAPI {
9905
10258
  return VirtualControllerApiFp(this.configuration).setOperationMode(cell, controller, mode, options).then((request) => request(this.axios, this.basePath));
9906
10259
  }
9907
10260
  /**
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. The transformation offset is defined by a unique identifier, a name for front end usage and an offset in another coordinate system referenced by the unique identifier of the reference coordinate system.
10261
+ * Sets the motion group mounting by specifying a coordinate system. The motion group will be based on the coordinate system\'s origin. The coordinate system defines a transformation offset, which consists of: - A unique identifier - A user-facing name - An offset in another coordinate system, referenced by the unique identifier of the reference coordinate system. **Important notes:** - Changing the mounting configuration is treated as a setup change. - When the mounting is set to a new coordinate system, the **virtual robot restarts** in the background to apply the new configuration. - During this process: - Robot visualization may temporarily disappear or not reflect the new mounting immediately. - Motion group state and coordinate system alignment may not be instantly updated in the UI. - All connections to the virtual robot are closed and then re-established, which can cause a short delay before the system is ready again. - The API call itself does **not wait until the restart and synchronization are complete**. A successful response indicates that the request was accepted, but the updated mounting may not yet be visible.
9909
10262
  * @summary Set Mounting
9910
10263
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9911
10264
  * @param {string} controller Unique identifier to address a controller in the cell.