wandelbots-api-client 25.10.0.dev35__py3-none-any.whl → 26.1.0.dev50__py3-none-any.whl

wandelbots_api_client/v2_pydantic/api/trajectory_caching_api.py

@@ -3,15 +3,14 @@
 """
     Wandelbots NOVA API
 
-    Interact with robots in an easy and intuitive way.  > **Note:** API version 2 is experimental and will experience functional changes. 
+    Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 2.0.0 beta
+    The version of the OpenAPI document: 2.1.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
-
 from furl import furl
 import json
 import humps
@@ -111,8 +110,7 @@ class TrajectoryCachingApi:
             '200': "AddTrajectoryResponse",
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -190,8 +188,7 @@ class TrajectoryCachingApi:
             '200': "AddTrajectoryResponse",
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -269,8 +266,7 @@ class TrajectoryCachingApi:
             '200': "AddTrajectoryResponse",
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
 
         response_data = await self.api_client.call_api(
             *_param,
@@ -419,8 +415,7 @@ class TrajectoryCachingApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': None,
             '400': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -493,8 +488,7 @@ class TrajectoryCachingApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': None,
             '400': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -567,8 +561,7 @@ class TrajectoryCachingApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': None,
             '400': "Error",
-        }
-        
+        }        
 
         response_data = await self.api_client.call_api(
             *_param,
@@ -706,8 +699,7 @@ class TrajectoryCachingApi:
             '200': None,
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -785,8 +777,7 @@ class TrajectoryCachingApi:
             '200': None,
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -864,8 +855,7 @@ class TrajectoryCachingApi:
             '200': None,
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
 
         response_data = await self.api_client.call_api(
             *_param,
@@ -1006,8 +996,7 @@ class TrajectoryCachingApi:
             '200': "GetTrajectoryResponse",
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -1085,8 +1074,7 @@ class TrajectoryCachingApi:
             '200': "GetTrajectoryResponse",
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -1164,8 +1152,7 @@ class TrajectoryCachingApi:
             '200': "GetTrajectoryResponse",
             '400': "Error",
             '404': "Error",
-        }
-        
+        }        
 
         response_data = await self.api_client.call_api(
             *_param,
@@ -1301,8 +1288,7 @@ class TrajectoryCachingApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "ListTrajectoriesResponse",
             '400': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -1375,8 +1361,7 @@ class TrajectoryCachingApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "ListTrajectoriesResponse",
             '400': "Error",
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -1449,8 +1434,7 @@ class TrajectoryCachingApi:
         _response_types_map: Dict[str, Optional[str]] = {
             '200': "ListTrajectoriesResponse",
             '400': "Error",
-        }
-        
+        }        
 
         response_data = await self.api_client.call_api(
             *_param,

wandelbots_api_client/v2_pydantic/api/trajectory_execution_api.py

@@ -3,15 +3,14 @@
 """
     Wandelbots NOVA API
 
-    Interact with robots in an easy and intuitive way.  > **Note:** API version 2 is experimental and will experience functional changes. 
+    Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 2.0.0 beta
+    The version of the OpenAPI document: 2.1.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
-
 from furl import furl
 import json
 import humps
@@ -48,7 +47,7 @@ class TrajectoryExecutionApi:
     async def execute_trajectory(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.")], client_request_generator: Callable[[AsyncGenerator[ExecuteTrajectoryResponse, None]], AsyncGenerator[ExecuteTrajectoryRequest, None]]) -> None:  # noqa: E501
         """Execute Trajectory  # noqa: E501
 
-        <!-- theme: success -->  > Websocket endpoint  Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory.  ### Movement behavior  | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** |  ### Concept of location    - The location or path parameter specifies the exact position along a trajectory.   - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory).   - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line.  ### Preconditions  - The motion group's control mode is not claimed by any other endpoint. - The motion group's joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location.  ### Requests  #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection   The following actions are executed:   - Sets robot controller mode to control mode,   - Sets start location of the execution    Keep in mind that only a single trajectory can be locked to a websocket connection at a time and not unlocked anymore.   To execute another trajectory, a new connection must be established.  #### 2. Send `StartMovementRequest` to start the movement  Sets direction of movement, default is forward.  #### **Optional**  - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement's velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`.  ### Responses  - `InitializeMovementResponse` is sent to signal the success or failure of the `InitializeMovementRequest`. - Movement responses are streamed after a `StartMovementRequest` successfully started the movement.   Movement responses are streamed in a rate that is defined as the multiple of the controller step-rate closest to   but not exceeding the rate configured by `InitializeMovementRequest`. - Standstill response is sent once the movement has finished or has come to a standstill due to a pause. - `PauseMovementResponse` is sent to signal the success of the `PauseMovementRequest`. It does not signal the end of the movement.   End of movement is signaled by Standstill response. - `PlaybackSpeedResponse` is sent to signal the success of the `PlaybackSpeedRequest`. - `MovementError` with error details is sent in case of an unexpected error, e.g., controller disconnects during movement.  ### Tips and Tricks  - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.   # noqa: E501
+        <!-- theme: success -->  > Websocket endpoint  Provides execution control over a previously [planned trajectory](planTrajectory). Enables the caller to attach input/output actions to the trajectory.  ### Movement behavior  | Virtual controller | Physical controller | |------------------|-------------------| | Desired joint configurations are commanded to each motion group and **applied immediately** | Move to desired **actual joint configuration**, **if possible** |  ### Concept of location    - The location or path parameter specifies the exact position along a trajectory.   - The location is a scalar value that ranges from 0 to `n`, where `n` denotes the number of motion commands, or trajectory segments, e.g., line, p2p, etc. See [planTrajectory](planTrajectory).   - Each integer value of the location corresponds to one motion command, e.g., 3.0 to 3.999 could be a line.  ### Preconditions  - The motion group's control mode is not claimed by any other endpoint. - The motion group's joint position are at start location specified with `InitializeMovementRequest`. - Use [executeToTrajectory](executeToTrajectory) to move the robot to the start location.  ### Requests  #### 1. Send `InitializeMovementRequest` to lock the trajectory to this connection   The following actions are executed:   - Sets robot controller mode to control mode,   - Sets start location of the execution    Keep in mind that only a single trajectory can be locked to a websocket connection at a time.   Pausing the current movement enables you to send another `InitializeMovementRequest` to execute another trajectory on the same connection.  #### 2. Send `StartMovementRequest` to start the movement  Sets direction of movement, default is forward.  #### **Optional**  - To pause, send `PauseMovementRequest` before the movement has reached its end location. - Change the movement's velocity with `PlaybackSpeedRequest` after initializing the movement with `InitializeMovementRequest`.  ### Responses  To monitor the state of the movement, listen to the [state stream](streamMotionGroupState). The state is published via nats as well. Field `execute` in the `MotionGroupState` indicates whether a movement is ongoing and carries execution details.  Each request has a corresponding acknowledgment response. They signal success or failure of the request. Especially for `PauseMovementResponse`, it does not signal the end of the movement.  Additionally, `MovementError` messages can be sent in case of unexpected errors during the execution, e.g., controller disconnects during movement.  ### Tips and Tricks  - A movement can be paused and resumed by sending `PauseMovementRequest` and `StartMovementRequest`. - Send `PlaybackSpeedRequest` before `StartMovementRequest` to reduce the velocity of the movement before it starts. - Send `PlaybackSpeedRequest` repeatedly to implement a slider. The velocity of the motion group can be adjusted with each controller step. Therefore, if your app needs a slider-like UI to alter the velocity of a currently running movement, you can send `PlaybackSpeedRequest` with different speed values repeatedly during the movement. - A closed trajectory (end and start joint position are equal) can be repeated by sending `StartMovementRequest` after the movement has finished.   # noqa: E501
         :param client_request_generator: An AsyncGenerator that yields request of type ExecuteTrajectoryRequest and takes an AsyncGenerator of ExecuteTrajectoryResponse as an input argument (required)
         :info All responses from the server will be yielded to client_request_generator through the (AsyncGenerator[ExecuteTrajectoryResponse, None])
         :type AsyncGenerator[ExecuteTrajectoryRequest, None]

wandelbots_api_client/v2_pydantic/api/trajectory_planning_api.py

@@ -3,15 +3,14 @@
 """
     Wandelbots NOVA API
 
-    Interact with robots in an easy and intuitive way.  > **Note:** API version 2 is experimental and will experience functional changes. 
+    Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 2.0.0 beta
+    The version of the OpenAPI document: 2.1.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
-
 from furl import furl
 import json
 import humps
@@ -108,8 +107,7 @@ class TrajectoryPlanningApi:
             '404': None,
             '422': "Plan422Response",
             '500': None,
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -184,8 +182,7 @@ class TrajectoryPlanningApi:
             '404': None,
             '422': "Plan422Response",
             '500': None,
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -260,8 +257,7 @@ class TrajectoryPlanningApi:
             '404': None,
             '422': "Plan422Response",
             '500': None,
-        }
-        
+        }        
 
         response_data = await self.api_client.call_api(
             *_param,
@@ -409,8 +405,7 @@ class TrajectoryPlanningApi:
             '404': None,
             '422': "Plan422Response",
             '500': None,
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -485,8 +480,7 @@ class TrajectoryPlanningApi:
             '404': None,
             '422': "Plan422Response",
             '500': None,
-        }
-        
+        }        
         
         response_data = await self.api_client.call_api(
             *_param,
@@ -561,8 +555,7 @@ class TrajectoryPlanningApi:
             '404': None,
             '422': "Plan422Response",
             '500': None,
-        }
-        
+        }        
 
         response_data = await self.api_client.call_api(
             *_param,

wandelbots_api_client/v2_pydantic/api/version_api.py

@@ -0,0 +1,287 @@
+# coding: utf-8
+
+"""
+    Wandelbots NOVA API
+
+    Interact with robots in an easy and intuitive way. 
+
+    The version of the OpenAPI document: 2.1.0 dev
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+from furl import furl
+import json
+import humps
+import re
+import warnings
+import websockets
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, AsyncGenerator, Callable, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+from urllib.parse import quote
+
+from wandelbots_api_client.v2_pydantic.models import ApiVersion
+
+from wandelbots_api_client.v2_pydantic.api_client import ApiClient, RequestSerialized
+from wandelbots_api_client.v2_pydantic.api_response import ApiResponse
+from wandelbots_api_client.v2_pydantic.rest import RESTResponseType
+
+class VersionApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+    @validate_call
+    async def get_api_version(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiVersion:
+        """API Version
+
+        Retrieves the version of the NOVA API.
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_api_version_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ApiVersion",
+        }        
+        
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def get_api_version_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ApiVersion]:
+        """API Version
+
+        Retrieves the version of the NOVA API.
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_api_version_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ApiVersion",
+        }        
+        
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def get_api_version_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """API Version
+
+        Retrieves the version of the NOVA API.
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_api_version_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ApiVersion",
+        }        
+
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_api_version_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, Union[str, bytes]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'BasicAuth', 
+            'BearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/version',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+