@wandelbots/nova-api 25.7.0-dev.3 → 25.7.0-dev.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wandelbots/nova-api",
-  "version": "25.7.0-dev.3",
+  "version": "25.7.0-dev.4",
   "description": "API Client to interact with Wandelbots Public API.",
   "files": [
     "*",

package/v2/api.d.ts

@@ -859,6 +859,37 @@ export interface ContainerStorage {
      */
     'capacity': string;
 }
+/**
+ * The data type to describe a robot controller.
+ * @export
+ * @interface ControllerDescription
+ */
+export interface ControllerDescription {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ControllerDescription
+     */
+    'connected_motion_groups': Array<string>;
+    /**
+     * Can this controller be moved through freedrive (true), or not (false).
+     * @type {boolean}
+     * @memberof ControllerDescription
+     */
+    'supports_freedrive': boolean;
+    /**
+     * Can this controller be controlled with NOVA (true) or is it only possible to read data (false).
+     * @type {boolean}
+     * @memberof ControllerDescription
+     */
+    'supports_control': boolean;
+    /**
+     * True if NOVA supports reading safety zone-, tool- and link-geometries for this motion group. Safety zones are used to define areas where the robot should slow down or stop. If false, NOVA can\'t guarantee that the executed motions respect safety zones defined on the controller.
+     * @type {boolean}
+     * @memberof ControllerDescription
+     */
+    'supports_safety_zones': boolean;
+}
 /**
  * Defines a convex hull encapsulating a set of vertices.
  * @export
@@ -5075,6 +5106,15 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     deleteRobotController: (cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
+     * @summary Description
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} controller Unique identifier to address a controller in the cell.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getControllerDescription: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation.  The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
      * @summary Coordinate System
@@ -5216,6 +5256,15 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
+     * @summary Description
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} controller Unique identifier to address a controller in the cell.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerDescription>>;
     /**
      * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation.  The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
      * @summary Coordinate System
@@ -5357,6 +5406,15 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
+     * @summary Description
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} controller Unique identifier to address a controller in the cell.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerDescription>;
     /**
      * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation.  The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
      * @summary Coordinate System
@@ -5503,6 +5561,16 @@ export declare class ControllerApi extends BaseAPI {
      * @memberof ControllerApi
      */
     deleteRobotController(cell: string, controller: string, completionTimeout?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
+     * @summary Description
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} controller Unique identifier to address a controller in the cell.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ControllerApi
+     */
+    getControllerDescription(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ControllerDescription, any>>;
     /**
      * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation.  The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
      * @summary Coordinate System

package/v2/api.js

@@ -1777,6 +1777,45 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
+         * @summary Description
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {string} controller Unique identifier to address a controller in the cell.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getControllerDescription: async (cell, controller, options = {}) => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('getControllerDescription', 'cell', cell);
+            // verify required parameter 'controller' is not null or undefined
+            assertParamExists('getControllerDescription', 'controller', controller);
+            const localVarPath = `/cells/{cell}/controllers/{controller}/description`
+                .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
+                .replace(`{${"controller"}}`, encodeURIComponent(String(controller)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration);
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation.  The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
          * @summary Coordinate System
@@ -2290,6 +2329,20 @@ export const ControllerApiFp = function (configuration) {
             const localVarOperationServerBasePath = operationServerMap['ControllerApi.deleteRobotController']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
+         * @summary Description
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {string} controller Unique identifier to address a controller in the cell.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getControllerDescription(cell, controller, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getControllerDescription(cell, controller, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ControllerApi.getControllerDescription']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation.  The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
          * @summary Coordinate System
@@ -2495,6 +2548,17 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
         deleteRobotController(cell, controller, completionTimeout, options) {
             return localVarFp.deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
+         * @summary Description
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {string} controller Unique identifier to address a controller in the cell.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getControllerDescription(cell, controller, options) {
+            return localVarFp.getControllerDescription(cell, controller, options).then((request) => request(axios, basePath));
+        },
         /**
          * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation.  The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
          * @summary Coordinate System
@@ -2670,6 +2734,18 @@ export class ControllerApi extends BaseAPI {
     deleteRobotController(cell, controller, completionTimeout, options) {
         return ControllerApiFp(this.configuration).deleteRobotController(cell, controller, completionTimeout, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get description of a configured robot controller including a list of connected motion group identifiers. Use [getMotionGroupDescription](getMotionGroupDescription) to get more information about the motion group.
+     * @summary Description
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {string} controller Unique identifier to address a controller in the cell.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ControllerApi
+     */
+    getControllerDescription(cell, controller, options) {
+        return ControllerApiFp(this.configuration).getControllerDescription(cell, controller, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Request a coordinate system specification for a given identifier. Use parameter orientation_type to get the orientation part of the transformation offset of the coordinate system returned in the requested orientation notation. If parameter orientation_type is not set, the orientation part of the transformation offset of the coordinate system is returned in rotation vector notation.  The coordinate systems from the robot controller are loaded when the motion group associated with the coordinate system is activated. With deactivation of the motion group, the associated coordinate systems are removed from NOVA. The unique identifier of the coordinate systems from the robot controllers are suffixed with \"On\" + the unique identifier of the robot controller.
      * @summary Coordinate System