wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2/api/motion_group_api.py

@@ -0,0 +1,689 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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 pydantic import Field, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.motion_group_description import MotionGroupDescription
+from wandelbots_api_client.v2.models.motion_group_state import MotionGroupState
+
+from wandelbots_api_client.v2.api_client import ApiClient, RequestSerialized
+from wandelbots_api_client.v2.api_response import ApiResponse
+from wandelbots_api_client.v2.rest import RESTResponseType
+
+
+class MotionGroupApi:
+    """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_current_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_coordinate_system: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used. "
+            ),
+        ] = None,
+        _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,
+    ) -> MotionGroupState:
+        """State
+
+        **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___  Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
+
+        :param cell: Unique identifier addressing a cell in all API calls.  (required)
+        :type cell: str
+        :param controller: Unique identifier to address a controller in the cell. (required)
+        :type controller: str
+        :param motion_group: The motion-group identifier. (required)
+        :type motion_group: str
+        :param response_coordinate_system: Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
+        :type response_coordinate_system: 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
+                                 (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_current_motion_group_state_serialize(
+            cell=cell,
+            controller=controller,
+            motion_group=motion_group,
+            response_coordinate_system=response_coordinate_system,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "MotionGroupState",
+            "400": "Error",
+            "404": "Error",
+        }
+
+        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_current_motion_group_state_with_http_info(
+        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_coordinate_system: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used. "
+            ),
+        ] = None,
+        _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[MotionGroupState]:
+        """State
+
+        **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___  Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
+
+        :param cell: Unique identifier addressing a cell in all API calls.  (required)
+        :type cell: str
+        :param controller: Unique identifier to address a controller in the cell. (required)
+        :type controller: str
+        :param motion_group: The motion-group identifier. (required)
+        :type motion_group: str
+        :param response_coordinate_system: Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
+        :type response_coordinate_system: 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
+                                 (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_current_motion_group_state_serialize(
+            cell=cell,
+            controller=controller,
+            motion_group=motion_group,
+            response_coordinate_system=response_coordinate_system,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "MotionGroupState",
+            "400": "Error",
+            "404": "Error",
+        }
+
+        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_current_motion_group_state_without_preload_content(
+        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_coordinate_system: Annotated[
+            Optional[StrictStr],
+            Field(
+                description="Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used. "
+            ),
+        ] = None,
+        _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:
+        """State
+
+        **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___  Returns the current state of the selected motion group including the current joint position, velocity, pose, and more.
+
+        :param cell: Unique identifier addressing a cell in all API calls.  (required)
+        :type cell: str
+        :param controller: Unique identifier to address a controller in the cell. (required)
+        :type controller: str
+        :param motion_group: The motion-group identifier. (required)
+        :type motion_group: str
+        :param response_coordinate_system: Unique identifier addressing a coordinate system to which the responses should be converted. If not set, world coordinate system is used.
+        :type response_coordinate_system: 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
+                                 (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_current_motion_group_state_serialize(
+            cell=cell,
+            controller=controller,
+            motion_group=motion_group,
+            response_coordinate_system=response_coordinate_system,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "MotionGroupState",
+            "400": "Error",
+            "404": "Error",
+        }
+
+        response_data = await self.api_client.call_api(*_param, _request_timeout=_request_timeout)
+        return response_data.response
+
+    def _get_current_motion_group_state_serialize(
+        self,
+        cell,
+        controller,
+        motion_group,
+        response_coordinate_system,
+        _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
+        if cell is not None:
+            _path_params["cell"] = cell
+        if controller is not None:
+            _path_params["controller"] = controller
+        if motion_group is not None:
+            _path_params["motion-group"] = motion_group
+        # process the query parameters
+        if response_coordinate_system is not None:
+            _query_params.append(("response_coordinate_system", response_coordinate_system))
+
+        # 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] = ["BearerAuth"]
+
+        return self.api_client.param_serialize(
+            method="GET",
+            resource_path="/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state",
+            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,
+        )
+
+    @validate_call
+    async def get_motion_group_description(
+        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.")],
+        _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,
+    ) -> MotionGroupDescription:
+        """Description
+
+        **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___  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
+        :param controller: Unique identifier to address a controller in the cell. (required)
+        :type controller: str
+        :param motion_group: The motion-group identifier. (required)
+        :type motion_group: 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
+                                 (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_motion_group_description_serialize(
+            cell=cell,
+            controller=controller,
+            motion_group=motion_group,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "MotionGroupDescription",
+            "400": "Error",
+            "404": "Error",
+        }
+
+        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_motion_group_description_with_http_info(
+        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.")],
+        _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[MotionGroupDescription]:
+        """Description
+
+        **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___  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
+        :param controller: Unique identifier to address a controller in the cell. (required)
+        :type controller: str
+        :param motion_group: The motion-group identifier. (required)
+        :type motion_group: 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
+                                 (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_motion_group_description_serialize(
+            cell=cell,
+            controller=controller,
+            motion_group=motion_group,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "MotionGroupDescription",
+            "400": "Error",
+            "404": "Error",
+        }
+
+        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_motion_group_description_without_preload_content(
+        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.")],
+        _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:
+        """Description
+
+        **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___  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
+        :param controller: Unique identifier to address a controller in the cell. (required)
+        :type controller: str
+        :param motion_group: The motion-group identifier. (required)
+        :type motion_group: 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
+                                 (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_motion_group_description_serialize(
+            cell=cell,
+            controller=controller,
+            motion_group=motion_group,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index,
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            "200": "MotionGroupDescription",
+            "400": "Error",
+            "404": "Error",
+        }
+
+        response_data = await self.api_client.call_api(*_param, _request_timeout=_request_timeout)
+        return response_data.response
+
+    def _get_motion_group_description_serialize(
+        self,
+        cell,
+        controller,
+        motion_group,
+        _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
+        if cell is not None:
+            _path_params["cell"] = cell
+        if controller is not None:
+            _path_params["controller"] = controller
+        if motion_group is not None:
+            _path_params["motion-group"] = motion_group
+        # 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] = ["BearerAuth"]
+
+        return self.api_client.param_serialize(
+            method="GET",
+            resource_path="/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/description",
+            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,
+        )
+
+    @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[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
+
+        **Required permissions:** `can_operate_controllers` - Operate and monitor robot controllers ___  <!-- 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
+        """
+
+        def format_path_parameters(path):
+            # Find all substrings that are enclosed in brackets
+            bracket_contents = re.findall(r"\{(.*?)\}", path)
+
+            # For each found substring, replace underscores with spaces
+            for content in bracket_contents:
+                content = "{" + content + "}"
+                modified_content = humps.dekebabize(content)
+                path = path.replace(content, modified_content)
+
+            return path
+
+        def append_parameter_connector(url_schema):
+            if "?" not in url_schema:
+                url_schema += "?"
+            else:
+                url_schema += "&"
+            return url_schema
+
+        path = format_path_parameters("/cells/{cell}/controllers/{controller}/motion-groups/{motion-group}/state-stream")
+        path = path.format(
+            cell=cell,
+            controller=controller,
+            motion_group=motion_group,
+        )
+
+        headers = websockets.Headers()
+        tmp_host = self.api_client.configuration.host
+        if self.api_client.configuration.host.startswith("https://"):
+            # Basic Auth
+            if self.api_client.configuration.username:
+                tmp_host = self.api_client.configuration.host.replace("https://", "")
+                tmp_host = f"wss://{self.api_client.configuration.username}:{self.api_client.configuration.password}@{tmp_host}"
+
+            # OAuth2
+            elif self.api_client.configuration.access_token:
+                tmp_host = self.api_client.configuration.host.replace("https://", "")
+                tmp_host = f"wss://{tmp_host}"
+                headers = websockets.Headers([("Authorization", f"Bearer {self.api_client.configuration.access_token}")])
+        else:
+            tmp_host = tmp_host.replace("http://", "ws://")
+
+        url_schema = tmp_host + path
+        if locals().get("response_rate") is not None:
+            url_schema = append_parameter_connector(url_schema)
+            if isinstance(response_rate, list):
+                url_schema += "&".join(["response_rate=" + s for s in response_rate])
+            else:
+                url_schema += "response_rate=" + str(response_rate)
+        if locals().get("response_coordinate_system") is not None:
+            url_schema = append_parameter_connector(url_schema)
+            if isinstance(response_coordinate_system, list):
+                url_schema += "&".join(["response_coordinate_system=" + s for s in response_coordinate_system])
+            else:
+                url_schema += "response_coordinate_system=" + str(response_coordinate_system)
+        full_url = furl(url_schema)
+
+        async with websockets.connect(full_url.url, open_timeout=10, additional_headers=headers) as websocket:
+            try:
+                async for response in websocket:
+                    response_data = json.loads(response)
+                    if "result" not in response_data:
+                        raise Exception(response_data)
+                    yield MotionGroupState.model_validate(response_data["result"])
+            except websockets.exceptions.ConnectionClosed:
+                return
+            finally:
+                await websocket.close()