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

package/v2/api.d.ts

@@ -342,7 +342,7 @@ export declare const BoxBoxTypeEnum: {
 };
 export type BoxBoxTypeEnum = typeof BoxBoxTypeEnum[keyof typeof BoxBoxTypeEnum];
 /**
- * PROFINET BUS Inputs/Outputs Service configuration.
+ * PROFINET BUS inputs/outputs service configuration.
  * @export
  * @interface BusIOProfinet
  */
@@ -354,19 +354,19 @@ export interface BusIOProfinet {
      */
     'bus_type'?: BusIOProfinetBusTypeEnum;
     /**
-     * Path to the configuration file.
+     * 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}
      * @memberof BusIOProfinet
      */
     'network_config'?: BusIOProfinetNetwork;
     /**
-     * MAC address for the PROFINET port, should be get from another NOVA API endpoind?
+     * MAC address of the physical ethernet interface that you want to use for PROFINET communication.
      * @type {string}
      * @memberof BusIOProfinet
      */
@@ -383,7 +383,7 @@ export declare const BusIOProfinetBusTypeEnum: {
 };
 export type BusIOProfinetBusTypeEnum = typeof BusIOProfinetBusTypeEnum[keyof typeof BusIOProfinetBusTypeEnum];
 /**
- * Default route configuration for the PROFINET service. Will be removed before release by automatic default route configuration, if possible.
+ * Current default route configuration of your NOVA instance. The default route is a setting that tells data where to go if there isn’t a specific path already known for its destination. Usually this will be the path to your router, enabling accessing the internet. On Linux, use `ip route show` to view your default routes and match the output `default via <gateway> dev <interface> ...` to get your gateway and interface.
  * @export
  * @interface BusIOProfinetDefaultRoute
  */
@@ -402,25 +402,25 @@ export interface BusIOProfinetDefaultRoute {
     'interface': string;
 }
 /**
- * Network configuration for the PROFINET device
+ * Network configuration or IPv4 record of the virtual ethernet interface (pnio1) created by the PROFINET driver. The IPv4 record is used in combination with the Name of Station (NoS) to identify your device in the PROFINET network.  The `ip_config` will be used as IPv4 record if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
  * @export
  * @interface BusIOProfinetIpConfig
  */
 export interface BusIOProfinetIpConfig {
     /**
-     * IP address for the PROFINET device
+     * IP address for the device\'s virtual ethernet interface (pnio1).
      * @type {string}
      * @memberof BusIOProfinetIpConfig
      */
     'ip': string;
     /**
-     * Network mask for the PROFINET device.
+     * Network mask for the device\'s virtual ethernet interface (pnio1).
      * @type {string}
      * @memberof BusIOProfinetIpConfig
      */
     'netmask': string;
     /**
-     * Gateway for the PROFINET device
+     * Gateway for connections to other devices outside of the virtual ethernet interface\'s subnet.
      * @type {string}
      * @memberof BusIOProfinetIpConfig
      */
@@ -433,7 +433,7 @@ export interface BusIOProfinetIpConfig {
  */
 export interface BusIOProfinetNetwork {
     /**
-     * Name of the PROFINET device.
+     * Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your machine and no `rema_xml_content` is provided.
      * @type {string}
      * @memberof BusIOProfinetNetwork
      */
@@ -445,14 +445,14 @@ export interface BusIOProfinetNetwork {
      */
     'ip_config'?: BusIOProfinetIpConfig;
     /**
-     * Content of the PROFINET REMA XML file.
+     * Content of the PROFINET REMA XML file. Is used when PROFINET service is added for the first time to create the REMA XML file that holds data to be kept for the next session. Stores information like IP address, Name of Station (NoS) and hardware configuration. If you use a PROFINET controller to assign an IP address to the PROFINET device, this information will be written to the REMA XML file.  Refer to the PDF version of the \"PN Driver I/O Base programming interface\" documentation for more information and an example REMA file.
      * @type {string}
      * @memberof BusIOProfinetNetwork
      */
     'rema_xml_content'?: string;
 }
 /**
- * Virtual PROFINET BUS Inputs/Outputs Service configuration.
+ * Virtual PROFINET BUS inputs/outputs service configuration.
  * @export
  * @interface BusIOProfinetVirtual
  */
@@ -465,7 +465,7 @@ export interface BusIOProfinetVirtual {
     'bus_type'?: BusIOProfinetVirtualBusTypeEnum;
 }
 export declare const BusIOProfinetVirtualBusTypeEnum: {
-    readonly VirtualProfinet: "virtual_profinet";
+    readonly ProfinetVirtual: "profinet_virtual";
 };
 export type BusIOProfinetVirtualBusTypeEnum = typeof BusIOProfinetVirtualBusTypeEnum[keyof typeof BusIOProfinetVirtualBusTypeEnum];
 /**
@@ -490,7 +490,7 @@ export interface BusIOsState {
      */
     'state': BusIOsStateEnum;
     /**
-     * A message providing additional information on the input/output, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
+     * A message providing additional information on the input/output service, e.g. BUS service status, encountered errors. May be empty if no additional information is available.
      * @type {string}
      * @memberof BusIOsState
      */
@@ -1797,6 +1797,55 @@ export interface IODescription {
      */
     'max'?: IODescriptionMin;
 }
+/**
+ *
+ * @export
+ * @interface IODescription2
+ */
+export interface IODescription2 {
+    /**
+     * Unique identifier of the input/output.
+     * @type {string}
+     * @memberof IODescription2
+     */
+    'io': string;
+    /**
+     * Descriptive name of the input/output. Customize it using the respective BUS service, e.g. [addProfinetIO](addProfinetIO) for PROFINET service.
+     * @type {string}
+     * @memberof IODescription2
+     */
+    'name': string;
+    /**
+     *
+     * @type {IODirection}
+     * @memberof IODescription2
+     */
+    'direction': IODirection;
+    /**
+     *
+     * @type {IOValueType}
+     * @memberof IODescription2
+     */
+    'value_type': IOValueType;
+    /**
+     *
+     * @type {UnitType}
+     * @memberof IODescription2
+     */
+    'unit'?: UnitType;
+    /**
+     *
+     * @type {IODescriptionMin}
+     * @memberof IODescription2
+     */
+    'min'?: IODescriptionMin;
+    /**
+     *
+     * @type {IODescriptionMin}
+     * @memberof IODescription2
+     */
+    'max'?: IODescriptionMin;
+}
 /**
  * @type IODescriptionMin
  * @export
@@ -3915,17 +3964,17 @@ export interface ProfinetDescription {
      */
     'slots'?: Array<ProfinetSlotDescription>;
     /**
-     * Name of the PROFINET device
+     * Name of Station (NoS) of the PROFINET device. The NoS is used in combination with IPv4 record to identify your device in the PROFINET network. The `device_name` will be used as NoS if no REMA XML file is already present on your NOVA instance and no `rema_xml_content` is provided.
      * @type {string}
      * @memberof ProfinetDescription
      */
     'device_name'?: string;
     /**
-     * IP address for the PROFINET device
-     * @type {string}
+     *
+     * @type {BusIOProfinetIpConfig}
      * @memberof ProfinetDescription
      */
-    'ip'?: string;
+    'ip_config'?: BusIOProfinetIpConfig;
 }
 /**
  *
@@ -3934,7 +3983,7 @@ export interface ProfinetDescription {
  */
 export interface ProfinetIO {
     /**
-     * The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
+     * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
      * @type {string}
      * @memberof ProfinetIO
      */
@@ -3946,25 +3995,25 @@ export interface ProfinetIO {
      */
     'type': ProfinetIOTypeEnum;
     /**
-     * The direction of the input/output value, indicating whether it is an input or output for the device.
+     * 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.
      * @type {ProfinetIODirection}
      * @memberof ProfinetIO
      */
     'direction': ProfinetIODirection;
     /**
-     * The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
+     * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
      * @type {number}
      * @memberof ProfinetIO
      */
     'byte_address': number;
     /**
-     * The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
+     * The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
      * @type {number}
      * @memberof ProfinetIO
      */
     'bit_address'?: number;
     /**
-     * The unique identifier for the input/output value. This identifier is used to reference the specific input/output in the NOVA system.
+     * The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service.
      * @type {string}
      * @memberof ProfinetIO
      */
@@ -3977,7 +4026,7 @@ export interface ProfinetIO {
  */
 export interface ProfinetIOData {
     /**
-     * The name of the input/output value. This is a human-readable identifier for the value. It can be used to distinguish between different inputs/outputs in the system.
+     * The name of the input/output variable. This is a human-readable identifier for the value. It distinguishes between different inputs/outputs variables in the system. The variables may be used to set bits or bytes at their pointed to address via [setBusIOValues](setBusIOValues).
      * @type {string}
      * @memberof ProfinetIOData
      */
@@ -3989,26 +4038,26 @@ export interface ProfinetIOData {
      */
     'type': ProfinetIOTypeEnum;
     /**
-     * The direction of the input/output value, indicating whether it is an input or output for the device.
+     * 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.
      * @type {ProfinetIODirection}
      * @memberof ProfinetIOData
      */
     'direction': ProfinetIODirection;
     /**
-     * The byte address of the input/output value in the PROFINET device. The byte address is used to locate the specific input/output within the device\'s memory or data structure.
+     * The byte address of the input/output variable in the PROFINET device, e.g. NOVA\'s PROFINET service. The byte address is used to locate the specific input/output variable within the device\'s memory or data structure.
      * @type {number}
      * @memberof ProfinetIOData
      */
     'byte_address': number;
     /**
-     * The bit address of the input/output value within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output value.
+     * The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable.
      * @type {number}
      * @memberof ProfinetIOData
      */
     'bit_address'?: number;
 }
 /**
- * Identifies the input/output type.
+ * 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.
  * @export
  * @enum {string}
  */
@@ -4019,7 +4068,7 @@ export declare const ProfinetIODirection: {
 };
 export type ProfinetIODirection = typeof ProfinetIODirection[keyof typeof ProfinetIODirection];
 /**
- * Value type of the PROFINET input/output.
+ * Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly.
  * @export
  * @enum {string}
  */
@@ -4043,38 +4092,38 @@ export type ProfinetIOTypeEnum = typeof ProfinetIOTypeEnum[keyof typeof Profinet
  */
 export interface ProfinetInputOutputConfig {
     /**
-     * Content of the input output configuration file.
+     * Content of the input/output variable configuration XML file. The XML File has to be embedded as a string by escaping quotes, line breaks and so forth.
      * @type {string}
      * @memberof ProfinetInputOutputConfig
      */
     'config': string;
     /**
-     * Offset in bytes for the input data.
+     * Offset in bytes for the address of the input (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
      * @type {number}
      * @memberof ProfinetInputOutputConfig
      */
     'input_offset': number;
     /**
-     * Offset in bytes for the output data.
+     * Offset in bytes for the address of the output (perspective of the controller) variables. The offset will be subtracted from to the byte addresses of the sent XML content.
      * @type {number}
      * @memberof ProfinetInputOutputConfig
      */
     'output_offset': number;
 }
 /**
- *
+ * An array of PROFINET slots.  PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g. addressing each input/output stream when establishing input/output application relations (I/O-AR).
  * @export
  * @interface ProfinetSlotDescription
  */
 export interface ProfinetSlotDescription {
     /**
-     * The number of the PROFINET slot.
+     * The number/index of the PROFINET slot. Per default, slot 0 is reserved for the device access point (DAP). Slots that are part of the cyclic input/output data exchange start at number 1.
      * @type {number}
      * @memberof ProfinetSlotDescription
      */
     'number': number;
     /**
-     * The API number of the PROFINET input, used to identify the specific API for the input.
+     * The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot.
      * @type {number}
      * @memberof ProfinetSlotDescription
      */
@@ -4093,19 +4142,19 @@ export interface ProfinetSlotDescription {
  */
 export interface ProfinetSubSlotDescription {
     /**
-     * The identifier of the PROFINET subslot.
+     * The number/index of the PROFINET subslot.
      * @type {number}
      * @memberof ProfinetSubSlotDescription
      */
     'number': number;
     /**
-     * The length in bytes of the PROFINET input.
+     * The amount of bytes allocated for the subslot in the input process image buffer.
      * @type {number}
      * @memberof ProfinetSubSlotDescription
      */
     'input_length': number;
     /**
-     * The length in bytes of the PROFINET output.
+     * The amount of bytes allocated for the subslot in the output process image buffer.
      * @type {number}
      * @memberof ProfinetSubSlotDescription
      */
@@ -5562,7 +5611,7 @@ export declare class ApplicationApi extends BaseAPI {
  */
 export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Add a BUS Inputs/Outputs Service to the cell.
+     * Add the BUS inputs/outputs service to the cell.  Starts a containerized service that enables BUS connections via the specified ethernet port.
      * @summary Add Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {BusIOType} busIOType
@@ -5572,7 +5621,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     addBusIOService: (cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Adds an input/output to or updates an input/output on the PROFINET device.
+     * 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).
      * @summary Add PROFINET Input/Output
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5582,7 +5631,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     addProfinetIO: (cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Delete BUS Inputs/Outputs Service from the cell.
+     * Remove the BUS inputs/outputs service from the cell.
      * @summary Clear Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {number} [completionTimeout]
@@ -5591,7 +5640,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     clearBusIOService: (cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Removes the input/output from the PROFINET device.
+     * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
      * @summary Remove PROFINET Input/Ouptut
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5600,7 +5649,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     deleteProfinetIO: (cell: string, io: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get deployed BUS Inputs/Outputs Service.
+     * Get deployed BUS inputs/outputs service.
      * @summary Get Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5625,7 +5674,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     getBusIOValues: (cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get description of PROFINET
+     * Get description of NOVA as a PROFINET device.
      * @summary Get PROFINET Description
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5633,7 +5682,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     getProfinetDescription: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get input/output configuration of the PROFINET device as file.
+     * 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.
      * @summary PROFINET Inputs/Outputs to File
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {number} [inputOffset]
@@ -5643,7 +5692,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     getProfinetIOsFromFile: (cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * List all BUS Input/Output descriptions.
+     * 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.
      * @summary List Descriptions
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5651,7 +5700,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     listBusIODescriptions: (cell: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * List all PROFINET input and outputs.
+     * 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.
      * @summary List PROFINET Input/Output Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5668,7 +5717,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
      */
     setBusIOValues: (cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Sets inputs/outputs on the PROFINET device from file.
+     * 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.
      * @summary Set PROFINET Inputs/Outputs from File
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5683,7 +5732,7 @@ export declare const BUSInputsOutputsApiAxiosParamCreator: (configuration?: Conf
  */
 export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
     /**
-     * Add a BUS Inputs/Outputs Service to the cell.
+     * Add the BUS inputs/outputs service to the cell.  Starts a containerized service that enables BUS connections via the specified ethernet port.
      * @summary Add Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {BusIOType} busIOType
@@ -5693,7 +5742,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
      */
     addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Adds an input/output to or updates an input/output on the PROFINET device.
+     * 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).
      * @summary Add PROFINET Input/Output
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5703,7 +5752,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
      */
     addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Delete BUS Inputs/Outputs Service from the cell.
+     * Remove the BUS inputs/outputs service from the cell.
      * @summary Clear Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {number} [completionTimeout]
@@ -5712,7 +5761,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
      */
     clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Removes the input/output from the PROFINET device.
+     * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
      * @summary Remove PROFINET Input/Ouptut
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5721,7 +5770,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
      */
     deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Get deployed BUS Inputs/Outputs Service.
+     * Get deployed BUS inputs/outputs service.
      * @summary Get Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5746,7 +5795,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
      */
     getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>>;
     /**
-     * Get description of PROFINET
+     * Get description of NOVA as a PROFINET device.
      * @summary Get PROFINET Description
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5754,7 +5803,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
      */
     getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProfinetDescription>>;
     /**
-     * Get input/output configuration of the PROFINET device as file.
+     * 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.
      * @summary PROFINET Inputs/Outputs to File
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {number} [inputOffset]
@@ -5764,15 +5813,15 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
      */
     getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
-     * List all BUS Input/Output descriptions.
+     * 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.
      * @summary List Descriptions
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>>;
+    listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription2>>>;
     /**
-     * List all PROFINET input and outputs.
+     * 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.
      * @summary List PROFINET Input/Output Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5789,7 +5838,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
      */
     setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Sets inputs/outputs on the PROFINET device from file.
+     * 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.
      * @summary Set PROFINET Inputs/Outputs from File
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5804,7 +5853,7 @@ export declare const BUSInputsOutputsApiFp: (configuration?: Configuration) => {
  */
 export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Add a BUS Inputs/Outputs Service to the cell.
+     * Add the BUS inputs/outputs service to the cell.  Starts a containerized service that enables BUS connections via the specified ethernet port.
      * @summary Add Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {BusIOType} busIOType
@@ -5814,7 +5863,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
      */
     addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Adds an input/output to or updates an input/output on the PROFINET device.
+     * 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).
      * @summary Add PROFINET Input/Output
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5824,7 +5873,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
      */
     addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Delete BUS Inputs/Outputs Service from the cell.
+     * Remove the BUS inputs/outputs service from the cell.
      * @summary Clear Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {number} [completionTimeout]
@@ -5833,7 +5882,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
      */
     clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Removes the input/output from the PROFINET device.
+     * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
      * @summary Remove PROFINET Input/Ouptut
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5842,7 +5891,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
      */
     deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Get deployed BUS Inputs/Outputs Service.
+     * Get deployed BUS inputs/outputs service.
      * @summary Get Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5867,7 +5916,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
      */
     getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>>;
     /**
-     * Get description of PROFINET
+     * Get description of NOVA as a PROFINET device.
      * @summary Get PROFINET Description
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5875,7 +5924,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
      */
     getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ProfinetDescription>;
     /**
-     * Get input/output configuration of the PROFINET device as file.
+     * 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.
      * @summary PROFINET Inputs/Outputs to File
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {number} [inputOffset]
@@ -5885,15 +5934,15 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
      */
     getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
     /**
-     * List all BUS Input/Output descriptions.
+     * 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.
      * @summary List Descriptions
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>>;
+    listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription2>>;
     /**
-     * List all PROFINET input and outputs.
+     * 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.
      * @summary List PROFINET Input/Output Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -5910,7 +5959,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
      */
     setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
-     * Sets inputs/outputs on the PROFINET device from file.
+     * 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.
      * @summary Set PROFINET Inputs/Outputs from File
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {ProfinetInputOutputConfig} profinetInputOutputConfig
@@ -5927,7 +5976,7 @@ export declare const BUSInputsOutputsApiFactory: (configuration?: Configuration,
  */
 export declare class BUSInputsOutputsApi extends BaseAPI {
     /**
-     * Add a BUS Inputs/Outputs Service to the cell.
+     * Add the BUS inputs/outputs service to the cell.  Starts a containerized service that enables BUS connections via the specified ethernet port.
      * @summary Add Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {BusIOType} busIOType
@@ -5938,7 +5987,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
      */
     addBusIOService(cell: string, busIOType: BusIOType, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Adds an input/output to or updates an input/output on the PROFINET device.
+     * 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).
      * @summary Add PROFINET Input/Output
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5949,7 +5998,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
      */
     addProfinetIO(cell: string, io: string, profinetIOData: ProfinetIOData, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Delete BUS Inputs/Outputs Service from the cell.
+     * Remove the BUS inputs/outputs service from the cell.
      * @summary Clear Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {number} [completionTimeout]
@@ -5959,7 +6008,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
      */
     clearBusIOService(cell: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Removes the input/output from the PROFINET device.
+     * Removes an input/output variable configuration from the PROFINET device, e.g. NOVA\'s PROFINET service.
      * @summary Remove PROFINET Input/Ouptut
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} io Unique identifier to address an Input/Output in the cell.
@@ -5969,16 +6018,14 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
      */
     deleteProfinetIO(cell: string, io: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Get deployed BUS Inputs/Outputs Service.
+     * Get deployed BUS inputs/outputs service.
      * @summary Get Service
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof BUSInputsOutputsApi
      */
-    getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
-        bus_type: "profinet";
-    } & BusIOProfinet, any>>;
+    getBusIOService(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BusIOType, any>>;
     /**
      * Get the current state of the BUS Inputs/Outputs service.
      * @summary State
@@ -5999,7 +6046,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
      */
     getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IOValue[], any>>;
     /**
-     * Get description of PROFINET
+     * Get description of NOVA as a PROFINET device.
      * @summary Get PROFINET Description
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -6008,7 +6055,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
      */
     getProfinetDescription(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProfinetDescription, any>>;
     /**
-     * Get input/output configuration of the PROFINET device as file.
+     * 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.
      * @summary PROFINET Inputs/Outputs to File
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {number} [inputOffset]
@@ -6019,16 +6066,16 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
      */
     getProfinetIOsFromFile(cell: string, inputOffset?: number, outputOffset?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
     /**
-     * List all BUS Input/Output descriptions.
+     * 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.
      * @summary List Descriptions
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof BUSInputsOutputsApi
      */
-    listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription[], any>>;
+    listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IODescription2[], any>>;
     /**
-     * List all PROFINET input and outputs.
+     * 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.
      * @summary List PROFINET Input/Output Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {*} [options] Override http request option.
@@ -6047,7 +6094,7 @@ export declare class BUSInputsOutputsApi extends BaseAPI {
      */
     setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Sets inputs/outputs on the PROFINET device from file.
+     * 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.
      * @summary Set PROFINET Inputs/Outputs from File
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {ProfinetInputOutputConfig} profinetInputOutputConfig