wandelbots-api-client 25.9.0.dev2__py3-none-any.whl → 25.10.0.dev47__py3-none-any.whl

wandelbots_api_client/v2/api/license_api.py

@@ -575,7 +575,7 @@ class LicenseApi:
     ) -> License:
         """Get license
 
-        Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
+        Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -639,7 +639,7 @@ class LicenseApi:
     ) -> ApiResponse[License]:
         """Get license
 
-        Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
+        Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -703,7 +703,7 @@ class LicenseApi:
     ) -> RESTResponseType:
         """Get license
 
-        Get information on the license used with the Wandelbots NOVA instance, e.g. licensed product, expiration date, license status.
+        Get information on the license used with the Wandelbots NOVA instance, e.g., licensed product, expiration date, license status.
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -821,7 +821,7 @@ class LicenseApi:
     ) -> LicenseStatus:
         """Get license status
 
-        Get the license status. If `valid`, Wandelbots NOVA can be used. If `expired`, the license has to be renewed in order to use Wandelbots NOVA.
+        Get the license status.  - If `valid`, Wandelbots NOVA can be used. - If `expired`, the license has to be renewed in order to use Wandelbots NOVA. 
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -885,7 +885,7 @@ class LicenseApi:
     ) -> ApiResponse[LicenseStatus]:
         """Get license status
 
-        Get the license status. If `valid`, Wandelbots NOVA can be used. If `expired`, the license has to be renewed in order to use Wandelbots NOVA.
+        Get the license status.  - If `valid`, Wandelbots NOVA can be used. - If `expired`, the license has to be renewed in order to use Wandelbots NOVA. 
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -949,7 +949,7 @@ class LicenseApi:
     ) -> RESTResponseType:
         """Get license status
 
-        Get the license status. If `valid`, Wandelbots NOVA can be used. If `expired`, the license has to be renewed in order to use Wandelbots NOVA.
+        Get the license status.  - If `valid`, Wandelbots NOVA can be used. - If `expired`, the license has to be renewed in order to use Wandelbots NOVA. 
 
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

wandelbots_api_client/v2/api/motion_group_api.py

@@ -23,7 +23,7 @@ from typing import Any, AsyncGenerator, Callable, Dict, List, Optional, Tuple, U
 from typing_extensions import Annotated
 from urllib.parse import quote
 
-from pydantic import Field, StrictInt, StrictStr
+from pydantic import Field, StrictStr
 from typing import Optional
 from typing_extensions import Annotated
 from wandelbots_api_client.v2.models.motion_group_description import MotionGroupDescription
@@ -377,7 +377,7 @@ class MotionGroupApi:
     ) -> MotionGroupDescription:
         """Description
 
-        Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot. 
+        Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc.  This data can change upon connection to the robot. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -454,7 +454,7 @@ class MotionGroupApi:
     ) -> ApiResponse[MotionGroupDescription]:
         """Description
 
-        Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot. 
+        Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc.  This data can change upon connection to the robot. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -531,7 +531,7 @@ class MotionGroupApi:
     ) -> RESTResponseType:
         """Description
 
-        Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot. 
+        Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc.  This data can change upon connection to the robot. 
 
         :param cell: Unique identifier addressing a cell in all API calls.  (required)
         :type cell: str
@@ -651,10 +651,10 @@ class MotionGroupApi:
 
 
     @validate_call
-    async def stream_motion_group_state(self, cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")], controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")], motion_group: Annotated[StrictStr, Field(description="The motion-group identifier.")], response_rate: Annotated[Optional[StrictInt], Field(description="Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller's step rate as well. Minimal response rate is the step rate of controller.")] = None, response_coordinate_system: Annotated[Optional[StrictStr], Field(description="Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system. ")] = None) -> AsyncGenerator[MotionGroupState, None]:  # noqa: E501
+    async def stream_motion_group_state(self, cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")], controller: Annotated[StrictStr, Field(description="Unique identifier to address a controller in the cell.")], motion_group: Annotated[StrictStr, Field(description="The motion-group identifier.")], response_rate: Annotated[Optional[Annotated[int, Field(le=2147483647, strict=True, ge=0)]], Field(description="Update rate for the response message in milliseconds (ms). Default is 200 ms. We recommend to use the step rate of the controller or a multiple of the step rate as NOVA updates the state in the controller's step rate as well. Minimal response rate is the step rate of controller.")] = None, response_coordinate_system: Annotated[Optional[StrictStr], Field(description="Unique identifier addressing a coordinate system to which the cartesian data of the responses should be converted. Default is the world coordinate system. ")] = None) -> AsyncGenerator[MotionGroupState, None]:  # noqa: E501
         """Stream State  # noqa: E501
 
-        <!-- theme: danger -->  > Websocket endpoint  Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.   # noqa: E501
+        <!-- theme: success -->  > Websocket endpoint  Receive updates of the motion group state.  The stream will be closed from the server if the controller is disconnected.   # noqa: E501
         :param request: A StreamMotionGroupStateRequest
         :info All responses from the server will be yielded
         :type StreamMotionGroupStateRequest
@@ -723,4 +723,6 @@ class MotionGroupApi:
                     yield MotionGroupState.from_dict(response_data["result"])
             except websockets.exceptions.ConnectionClosed:
                 return
+            finally:
+                await websocket.close()
 

wandelbots_api_client/v2/api/motion_group_models_api.py

@@ -47,8 +47,7 @@ class MotionGroupModelsApi:
     @validate_call
     async def get_motion_group_collision_model(
         self,
-        cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
+        motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -66,9 +65,7 @@ class MotionGroupModelsApi:
 
         Returns the default collision link chain for a given motion group model.  See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.  The default link chain is derived from 3D models and optimized for collision detection within NOVA.  The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors.  Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link's default shape. 
 
-        :param cell: Unique identifier addressing a cell in all API calls.  (required)
-        :type cell: str
-        :param motion_group_model: Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).  (required)
+        :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).  (required)
         :type motion_group_model: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -93,7 +90,6 @@ class MotionGroupModelsApi:
         """ # noqa: E501
 
         _param = self._get_motion_group_collision_model_serialize(
-            cell=cell,
             motion_group_model=motion_group_model,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -104,7 +100,6 @@ class MotionGroupModelsApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "List[Dict[str, Collider]]",
             '404': None,
-            '422': "HTTPValidationError2",
             '500': None,
         }
         response_data = await self.api_client.call_api(
@@ -121,8 +116,7 @@ class MotionGroupModelsApi:
     @validate_call
     async def get_motion_group_collision_model_with_http_info(
         self,
-        cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
+        motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -140,9 +134,7 @@ class MotionGroupModelsApi:
 
         Returns the default collision link chain for a given motion group model.  See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.  The default link chain is derived from 3D models and optimized for collision detection within NOVA.  The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors.  Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link's default shape. 
 
-        :param cell: Unique identifier addressing a cell in all API calls.  (required)
-        :type cell: str
-        :param motion_group_model: Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).  (required)
+        :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).  (required)
         :type motion_group_model: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -167,7 +159,6 @@ class MotionGroupModelsApi:
         """ # noqa: E501
 
         _param = self._get_motion_group_collision_model_serialize(
-            cell=cell,
             motion_group_model=motion_group_model,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -178,7 +169,6 @@ class MotionGroupModelsApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "List[Dict[str, Collider]]",
             '404': None,
-            '422': "HTTPValidationError2",
             '500': None,
         }
         response_data = await self.api_client.call_api(
@@ -195,8 +185,7 @@ class MotionGroupModelsApi:
     @validate_call
     async def get_motion_group_collision_model_without_preload_content(
         self,
-        cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
-        motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
+        motion_group_model: Annotated[StrictStr, Field(description="Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration). ")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -214,9 +203,7 @@ class MotionGroupModelsApi:
 
         Returns the default collision link chain for a given motion group model.  See [getMotionGroupModels](getMotionGroupModels) for supported motion group models.  The default link chain is derived from 3D models and optimized for collision detection within NOVA.  The default link chain includes link shapes only. It does not include any attached components like wire feeders or sensors.  Attach additional shapes to the link reference frames by extending the link dictionaries before further use. Additional shapes may overlap each other per link and may also overlap the respective link's default shape. 
 
-        :param cell: Unique identifier addressing a cell in all API calls.  (required)
-        :type cell: str
-        :param motion_group_model: Unique identifier for the model of a motion group, e.g. `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).  (required)
+        :param motion_group_model: Unique identifier for the model of a motion group, e.g., `UniversalRobots_UR10e`.  Get the `model` of a configured motion group with [getOptimizerConfiguration](getOptimizerConfiguration).  (required)
         :type motion_group_model: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -241,7 +228,6 @@ class MotionGroupModelsApi:
         """ # noqa: E501
 
         _param = self._get_motion_group_collision_model_serialize(
-            cell=cell,
             motion_group_model=motion_group_model,
             _request_auth=_request_auth,
             _content_type=_content_type,
@@ -252,7 +238,6 @@ class MotionGroupModelsApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "List[Dict[str, Collider]]",
             '404': None,
-            '422': "HTTPValidationError2",
             '500': None,
         }
         response_data = await self.api_client.call_api(
@@ -264,7 +249,6 @@ class MotionGroupModelsApi:
 
     def _get_motion_group_collision_model_serialize(
         self,
-        cell,
         motion_group_model,
         _request_auth,
         _content_type,
@@ -285,8 +269,6 @@ class MotionGroupModelsApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        if cell is not None:
-            _path_params['cell'] = cell
         if motion_group_model is not None:
             _path_params['motion-group-model'] = motion_group_model
         # process the query parameters
@@ -311,7 +293,7 @@ class MotionGroupModelsApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/cells/{cell}/motion-group-models/{motion-group-model}/collision-model',
+            resource_path='/motion-group-models/{motion-group-model}/collision',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -329,7 +311,6 @@ class MotionGroupModelsApi:
     @validate_call
     async def get_motion_group_models(
         self,
-        cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -345,10 +326,8 @@ class MotionGroupModelsApi:
     ) -> List[str]:
         """Motion Group Models
 
-        Returns motion group models that are supported for planning. 
+        Returns the list of supported motion group models. 
 
-        :param cell: Unique identifier addressing a cell in all API calls.  (required)
-        :type cell: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -372,7 +351,6 @@ class MotionGroupModelsApi:
         """ # noqa: E501
 
         _param = self._get_motion_group_models_serialize(
-            cell=cell,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -382,7 +360,6 @@ class MotionGroupModelsApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "List[str]",
             '404': None,
-            '422': "HTTPValidationError2",
             '500': None,
         }
         response_data = await self.api_client.call_api(
@@ -399,7 +376,6 @@ class MotionGroupModelsApi:
     @validate_call
     async def get_motion_group_models_with_http_info(
         self,
-        cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -415,10 +391,8 @@ class MotionGroupModelsApi:
     ) -> ApiResponse[List[str]]:
         """Motion Group Models
 
-        Returns motion group models that are supported for planning. 
+        Returns the list of supported motion group models. 
 
-        :param cell: Unique identifier addressing a cell in all API calls.  (required)
-        :type cell: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -442,7 +416,6 @@ class MotionGroupModelsApi:
         """ # noqa: E501
 
         _param = self._get_motion_group_models_serialize(
-            cell=cell,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -452,7 +425,6 @@ class MotionGroupModelsApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "List[str]",
             '404': None,
-            '422': "HTTPValidationError2",
             '500': None,
         }
         response_data = await self.api_client.call_api(
@@ -469,7 +441,6 @@ class MotionGroupModelsApi:
     @validate_call
     async def get_motion_group_models_without_preload_content(
         self,
-        cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -485,10 +456,8 @@ class MotionGroupModelsApi:
     ) -> RESTResponseType:
         """Motion Group Models
 
-        Returns motion group models that are supported for planning. 
+        Returns the list of supported motion group models. 
 
-        :param cell: Unique identifier addressing a cell in all API calls.  (required)
-        :type cell: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -512,7 +481,6 @@ class MotionGroupModelsApi:
         """ # noqa: E501
 
         _param = self._get_motion_group_models_serialize(
-            cell=cell,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -522,7 +490,6 @@ class MotionGroupModelsApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "List[str]",
             '404': None,
-            '422': "HTTPValidationError2",
             '500': None,
         }
         response_data = await self.api_client.call_api(
@@ -534,7 +501,6 @@ class MotionGroupModelsApi:
 
     def _get_motion_group_models_serialize(
         self,
-        cell,
         _request_auth,
         _content_type,
         _headers,
@@ -554,8 +520,6 @@ class MotionGroupModelsApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        if cell is not None:
-            _path_params['cell'] = cell
         # process the query parameters
         # process the header parameters
         # process the form parameters
@@ -578,7 +542,7 @@ class MotionGroupModelsApi:
 
         return self.api_client.param_serialize(
             method='GET',
-            resource_path='/cells/{cell}/motion-group-models',
+            resource_path='/motion-group-models',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,