@wandelbots/nova-api 25.8.0-dev.13 → 25.8.0-dev.15

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
  */
@@ -1170,7 +1170,7 @@ export class ApplicationApi extends BaseAPI {
1170
1170
  export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1171
1171
  return {
1172
1172
  /**
1173
- * Add a BUS Inputs/Outputs Service to the cell.
1173
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1174
1174
  * @summary Add Service
1175
1175
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1176
1176
  * @param {BusIOType} busIOType
@@ -1214,7 +1214,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1214
1214
  };
1215
1215
  },
1216
1216
  /**
1217
- * Adds an input/output to or updates an input/output on the PROFINET device.
1217
+ * 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
1218
  * @summary Add PROFINET Input/Output
1219
1219
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1220
1220
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1258,7 +1258,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1258
1258
  };
1259
1259
  },
1260
1260
  /**
1261
- * Delete BUS Inputs/Outputs Service from the cell.
1261
+ * Remove the BUS inputs/outputs service from the cell.
1262
1262
  * @summary Clear Service
1263
1263
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1264
1264
  * @param {number} [completionTimeout]
@@ -1297,7 +1297,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1297
1297
  };
1298
1298
  },
1299
1299
  /**
1300
- * Removes the input/output from the PROFINET device.
1300
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1301
1301
  * @summary Remove PROFINET Input/Ouptut
1302
1302
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1303
1303
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1336,7 +1336,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1336
1336
  };
1337
1337
  },
1338
1338
  /**
1339
- * Get deployed BUS Inputs/Outputs Service.
1339
+ * Get deployed BUS inputs/outputs service.
1340
1340
  * @summary Get Service
1341
1341
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1342
1342
  * @param {*} [options] Override http request option.
@@ -1445,7 +1445,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1445
1445
  };
1446
1446
  },
1447
1447
  /**
1448
- * Get description of PROFINET
1448
+ * Get description of NOVA as a PROFINET device.
1449
1449
  * @summary Get PROFINET Description
1450
1450
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1451
1451
  * @param {*} [options] Override http request option.
@@ -1480,7 +1480,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1480
1480
  };
1481
1481
  },
1482
1482
  /**
1483
- * Get input/output configuration of the PROFINET device as file.
1483
+ * 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
1484
  * @summary PROFINET Inputs/Outputs to File
1485
1485
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1486
1486
  * @param {number} [inputOffset]
@@ -1523,7 +1523,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1523
1523
  };
1524
1524
  },
1525
1525
  /**
1526
- * List all BUS Input/Output descriptions.
1526
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
1527
1527
  * @summary List Descriptions
1528
1528
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1529
1529
  * @param {*} [options] Override http request option.
@@ -1558,7 +1558,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1558
1558
  };
1559
1559
  },
1560
1560
  /**
1561
- * List all PROFINET input and outputs.
1561
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O 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 I/O 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
1562
  * @summary List PROFINET Input/Output Configuration
1563
1563
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1564
1564
  * @param {*} [options] Override http request option.
@@ -1633,7 +1633,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration) {
1633
1633
  };
1634
1634
  },
1635
1635
  /**
1636
- * Sets inputs/outputs on the PROFINET device from file.
1636
+ * 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 (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. 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, meaning that you can paste the exported XML file here without modifying.
1637
1637
  * @summary Set PROFINET Inputs/Outputs from File
1638
1638
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1639
1639
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -1682,7 +1682,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1682
1682
  const localVarAxiosParamCreator = BUSInputsOutputsApiAxiosParamCreator(configuration);
1683
1683
  return {
1684
1684
  /**
1685
- * Add a BUS Inputs/Outputs Service to the cell.
1685
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1686
1686
  * @summary Add Service
1687
1687
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1688
1688
  * @param {BusIOType} busIOType
@@ -1697,7 +1697,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1697
1697
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1698
1698
  },
1699
1699
  /**
1700
- * Adds an input/output to or updates an input/output on the PROFINET device.
1700
+ * 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
1701
  * @summary Add PROFINET Input/Output
1702
1702
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1703
1703
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1712,7 +1712,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1712
1712
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1713
1713
  },
1714
1714
  /**
1715
- * Delete BUS Inputs/Outputs Service from the cell.
1715
+ * Remove the BUS inputs/outputs service from the cell.
1716
1716
  * @summary Clear Service
1717
1717
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1718
1718
  * @param {number} [completionTimeout]
@@ -1726,7 +1726,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1726
1726
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1727
1727
  },
1728
1728
  /**
1729
- * Removes the input/output from the PROFINET device.
1729
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1730
1730
  * @summary Remove PROFINET Input/Ouptut
1731
1731
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1732
1732
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1740,7 +1740,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1740
1740
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1741
1741
  },
1742
1742
  /**
1743
- * Get deployed BUS Inputs/Outputs Service.
1743
+ * Get deployed BUS inputs/outputs service.
1744
1744
  * @summary Get Service
1745
1745
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1746
1746
  * @param {*} [options] Override http request option.
@@ -1780,7 +1780,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1780
1780
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1781
1781
  },
1782
1782
  /**
1783
- * Get description of PROFINET
1783
+ * Get description of NOVA as a PROFINET device.
1784
1784
  * @summary Get PROFINET Description
1785
1785
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1786
1786
  * @param {*} [options] Override http request option.
@@ -1793,7 +1793,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1793
1793
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1794
1794
  },
1795
1795
  /**
1796
- * Get input/output configuration of the PROFINET device as file.
1796
+ * 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
1797
  * @summary PROFINET Inputs/Outputs to File
1798
1798
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1799
1799
  * @param {number} [inputOffset]
@@ -1808,7 +1808,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1808
1808
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1809
1809
  },
1810
1810
  /**
1811
- * List all BUS Input/Output descriptions.
1811
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
1812
1812
  * @summary List Descriptions
1813
1813
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1814
1814
  * @param {*} [options] Override http request option.
@@ -1821,7 +1821,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1821
1821
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1822
1822
  },
1823
1823
  /**
1824
- * List all PROFINET input and outputs.
1824
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O 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 I/O 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
1825
  * @summary List PROFINET Input/Output Configuration
1826
1826
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1827
1827
  * @param {*} [options] Override http request option.
@@ -1848,7 +1848,7 @@ export const BUSInputsOutputsApiFp = function (configuration) {
1848
1848
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1849
1849
  },
1850
1850
  /**
1851
- * Sets inputs/outputs on the PROFINET device from file.
1851
+ * 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 (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. 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, meaning that you can paste the exported XML file here without modifying.
1852
1852
  * @summary Set PROFINET Inputs/Outputs from File
1853
1853
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1854
1854
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -1871,7 +1871,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1871
1871
  const localVarFp = BUSInputsOutputsApiFp(configuration);
1872
1872
  return {
1873
1873
  /**
1874
- * Add a BUS Inputs/Outputs Service to the cell.
1874
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
1875
1875
  * @summary Add Service
1876
1876
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1877
1877
  * @param {BusIOType} busIOType
@@ -1883,7 +1883,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1883
1883
  return localVarFp.addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(axios, basePath));
1884
1884
  },
1885
1885
  /**
1886
- * Adds an input/output to or updates an input/output on the PROFINET device.
1886
+ * 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
1887
  * @summary Add PROFINET Input/Output
1888
1888
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1889
1889
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1895,7 +1895,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1895
1895
  return localVarFp.addProfinetIO(cell, io, profinetIOData, options).then((request) => request(axios, basePath));
1896
1896
  },
1897
1897
  /**
1898
- * Delete BUS Inputs/Outputs Service from the cell.
1898
+ * Remove the BUS inputs/outputs service from the cell.
1899
1899
  * @summary Clear Service
1900
1900
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1901
1901
  * @param {number} [completionTimeout]
@@ -1906,7 +1906,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1906
1906
  return localVarFp.clearBusIOService(cell, completionTimeout, options).then((request) => request(axios, basePath));
1907
1907
  },
1908
1908
  /**
1909
- * Removes the input/output from the PROFINET device.
1909
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
1910
1910
  * @summary Remove PROFINET Input/Ouptut
1911
1911
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1912
1912
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -1917,7 +1917,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1917
1917
  return localVarFp.deleteProfinetIO(cell, io, options).then((request) => request(axios, basePath));
1918
1918
  },
1919
1919
  /**
1920
- * Get deployed BUS Inputs/Outputs Service.
1920
+ * Get deployed BUS inputs/outputs service.
1921
1921
  * @summary Get Service
1922
1922
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1923
1923
  * @param {*} [options] Override http request option.
@@ -1948,7 +1948,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1948
1948
  return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
1949
1949
  },
1950
1950
  /**
1951
- * Get description of PROFINET
1951
+ * Get description of NOVA as a PROFINET device.
1952
1952
  * @summary Get PROFINET Description
1953
1953
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1954
1954
  * @param {*} [options] Override http request option.
@@ -1958,7 +1958,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1958
1958
  return localVarFp.getProfinetDescription(cell, options).then((request) => request(axios, basePath));
1959
1959
  },
1960
1960
  /**
1961
- * Get input/output configuration of the PROFINET device as file.
1961
+ * 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
1962
  * @summary PROFINET Inputs/Outputs to File
1963
1963
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1964
1964
  * @param {number} [inputOffset]
@@ -1970,7 +1970,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1970
1970
  return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
1971
1971
  },
1972
1972
  /**
1973
- * List all BUS Input/Output descriptions.
1973
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
1974
1974
  * @summary List Descriptions
1975
1975
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1976
1976
  * @param {*} [options] Override http request option.
@@ -1980,7 +1980,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
1980
1980
  return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
1981
1981
  },
1982
1982
  /**
1983
- * List all PROFINET input and outputs.
1983
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O 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 I/O 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
1984
  * @summary List PROFINET Input/Output Configuration
1985
1985
  * @param {string} cell Unique identifier addressing a cell in all API calls.
1986
1986
  * @param {*} [options] Override http request option.
@@ -2001,7 +2001,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
2001
2001
  return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
2002
2002
  },
2003
2003
  /**
2004
- * Sets inputs/outputs on the PROFINET device from file.
2004
+ * 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 (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. 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, meaning that you can paste the exported XML file here without modifying.
2005
2005
  * @summary Set PROFINET Inputs/Outputs from File
2006
2006
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2007
2007
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -2021,7 +2021,7 @@ export const BUSInputsOutputsApiFactory = function (configuration, basePath, axi
2021
2021
  */
2022
2022
  export class BUSInputsOutputsApi extends BaseAPI {
2023
2023
  /**
2024
- * Add a BUS Inputs/Outputs Service to the cell.
2024
+ * Add the BUS inputs/outputs service to the cell. Starts a containerized service that enables BUS connections via the specified ethernet port.
2025
2025
  * @summary Add Service
2026
2026
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2027
2027
  * @param {BusIOType} busIOType
@@ -2034,7 +2034,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2034
2034
  return BUSInputsOutputsApiFp(this.configuration).addBusIOService(cell, busIOType, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2035
2035
  }
2036
2036
  /**
2037
- * Adds an input/output to or updates an input/output on the PROFINET device.
2037
+ * 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
2038
  * @summary Add PROFINET Input/Output
2039
2039
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2040
2040
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -2047,7 +2047,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2047
2047
  return BUSInputsOutputsApiFp(this.configuration).addProfinetIO(cell, io, profinetIOData, options).then((request) => request(this.axios, this.basePath));
2048
2048
  }
2049
2049
  /**
2050
- * Delete BUS Inputs/Outputs Service from the cell.
2050
+ * Remove the BUS inputs/outputs service from the cell.
2051
2051
  * @summary Clear Service
2052
2052
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2053
2053
  * @param {number} [completionTimeout]
@@ -2059,7 +2059,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2059
2059
  return BUSInputsOutputsApiFp(this.configuration).clearBusIOService(cell, completionTimeout, options).then((request) => request(this.axios, this.basePath));
2060
2060
  }
2061
2061
  /**
2062
- * Removes the input/output from the PROFINET device.
2062
+ * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
2063
2063
  * @summary Remove PROFINET Input/Ouptut
2064
2064
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2065
2065
  * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -2071,7 +2071,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2071
2071
  return BUSInputsOutputsApiFp(this.configuration).deleteProfinetIO(cell, io, options).then((request) => request(this.axios, this.basePath));
2072
2072
  }
2073
2073
  /**
2074
- * Get deployed BUS Inputs/Outputs Service.
2074
+ * Get deployed BUS inputs/outputs service.
2075
2075
  * @summary Get Service
2076
2076
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2077
2077
  * @param {*} [options] Override http request option.
@@ -2105,7 +2105,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2105
2105
  return BUSInputsOutputsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
2106
2106
  }
2107
2107
  /**
2108
- * Get description of PROFINET
2108
+ * Get description of NOVA as a PROFINET device.
2109
2109
  * @summary Get PROFINET Description
2110
2110
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2111
2111
  * @param {*} [options] Override http request option.
@@ -2116,7 +2116,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2116
2116
  return BUSInputsOutputsApiFp(this.configuration).getProfinetDescription(cell, options).then((request) => request(this.axios, this.basePath));
2117
2117
  }
2118
2118
  /**
2119
- * Get input/output configuration of the PROFINET device as file.
2119
+ * 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
2120
  * @summary PROFINET Inputs/Outputs to File
2121
2121
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2122
2122
  * @param {number} [inputOffset]
@@ -2129,7 +2129,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2129
2129
  return BUSInputsOutputsApiFp(this.configuration).getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(this.axios, this.basePath));
2130
2130
  }
2131
2131
  /**
2132
- * List all BUS Input/Output descriptions.
2132
+ * List all input/output descriptions for configured BUS services. The input/output descriptions contain information such as the name, the type and the unit. The I/O direction is given in perspective of the BUS service.
2133
2133
  * @summary List Descriptions
2134
2134
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2135
2135
  * @param {*} [options] Override http request option.
@@ -2140,7 +2140,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2140
2140
  return BUSInputsOutputsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
2141
2141
  }
2142
2142
  /**
2143
- * List all PROFINET input and outputs.
2143
+ * List descriptions for all configured input/output variables of the PROFINET service. The input/output descriptions contain information such as the name, the type and the unit. The I/O 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 I/O 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
2144
  * @summary List PROFINET Input/Output Configuration
2145
2145
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2146
2146
  * @param {*} [options] Override http request option.
@@ -2163,7 +2163,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
2163
2163
  return BUSInputsOutputsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
2164
2164
  }
2165
2165
  /**
2166
- * Sets inputs/outputs on the PROFINET device from file.
2166
+ * 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 (i.e. a connected PLC), refer to the corresponding engineering system (i.e. TIA portal). You can export the variable configuration of the PROFINET controller as XML file from you engineering system, i.e. 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, meaning that you can paste the exported XML file here without modifying.
2167
2167
  * @summary Set PROFINET Inputs/Outputs from File
2168
2168
  * @param {string} cell Unique identifier addressing a cell in all API calls.
2169
2169
  * @param {ProfinetInputOutputConfig} profinetInputOutputConfig