@wandelbots/nova-api 25.8.0-dev.34 → 25.8.0-dev.36

package/v2/api.ts

@@ -384,12 +384,6 @@ export interface BusIOProfinet {
      * @memberof BusIOProfinet
      */
     'bus_type'?: BusIOProfinetBusTypeEnum;
-    /**
-     * Content of Configuration XML file for PROFINET device, typically known as PND_IOD.xml. Leave empty for the default configuration.  Refer to the official PROFINET driver documentation for further information. 
-     * @type {string}
-     * @memberof BusIOProfinet
-     */
-    'config_file_content'?: string;
     /**
      * Used to enable IP communication through the same physical interface while PN Driver is running.
      * @type {BusIOProfinetNetwork}
@@ -2005,7 +1999,7 @@ export interface IOIntegerValue {
      */
     'io': string;
     /**
-     * Value of an input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value. 
+     * Value of an input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value. 
      * @type {string}
      * @memberof IOIntegerValue
      */
@@ -2268,7 +2262,7 @@ export const InitializeMovementResponseKindEnum = {
 export type InitializeMovementResponseKindEnum = typeof InitializeMovementResponseKindEnum[keyof typeof InitializeMovementResponseKindEnum];
 
 /**
- * Value of an input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value. 
+ * Value of an input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value. 
  * @export
  * @interface IntegerValue
  */
@@ -6840,7 +6834,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
             };
         },
         /**
-         * 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. 
+         * 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. 
          * @summary List Descriptions
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {*} [options] Override http request option.
@@ -6882,7 +6876,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
             };
         },
         /**
-         * 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. 
+         * 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. 
          * @summary List PROFINET Input/Output Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {*} [options] Override http request option.
@@ -6972,7 +6966,7 @@ export const BUSInputsOutputsApiAxiosParamCreator = function (configuration?: Co
             };
         },
         /**
-         * 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. 
+         * 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. 
          * @summary Set PROFINET Inputs/Outputs from File
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {ProfinetInputOutputConfig} profinetInputOutputConfig 
@@ -7156,7 +7150,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * 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. 
+         * 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. 
          * @summary List Descriptions
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {*} [options] Override http request option.
@@ -7169,7 +7163,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * 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. 
+         * 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. 
          * @summary List PROFINET Input/Output Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {*} [options] Override http request option.
@@ -7196,7 +7190,7 @@ export const BUSInputsOutputsApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * 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. 
+         * 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. 
          * @summary Set PROFINET Inputs/Outputs from File
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {ProfinetInputOutputConfig} profinetInputOutputConfig 
@@ -7319,7 +7313,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
             return localVarFp.getProfinetIOsFromFile(cell, inputOffset, outputOffset, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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. 
+         * 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. 
          * @summary List Descriptions
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {*} [options] Override http request option.
@@ -7329,7 +7323,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
             return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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. 
+         * 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. 
          * @summary List PROFINET Input/Output Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {*} [options] Override http request option.
@@ -7350,7 +7344,7 @@ export const BUSInputsOutputsApiFactory = function (configuration?: Configuratio
             return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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. 
+         * 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. 
          * @summary Set PROFINET Inputs/Outputs from File
          * @param {string} cell Unique identifier addressing a cell in all API calls. 
          * @param {ProfinetInputOutputConfig} profinetInputOutputConfig 
@@ -7488,7 +7482,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
     }
 
     /**
-     * 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. 
+     * 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. 
      * @summary List Descriptions
      * @param {string} cell Unique identifier addressing a cell in all API calls. 
      * @param {*} [options] Override http request option.
@@ -7500,7 +7494,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
     }
 
     /**
-     * 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. 
+     * 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. 
      * @summary List PROFINET Input/Output Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls. 
      * @param {*} [options] Override http request option.
@@ -7525,7 +7519,7 @@ export class BUSInputsOutputsApi extends BaseAPI {
     }
 
     /**
-     * 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. 
+     * 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. 
      * @summary Set PROFINET Inputs/Outputs from File
      * @param {string} cell Unique identifier addressing a cell in all API calls. 
      * @param {ProfinetInputOutputConfig} profinetInputOutputConfig