wandelbots-api-client 26.3.0.dev23__tar.gz → 26.3.0.dev25__tar.gz

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wandelbots_api_client
-Version: 26.3.0.dev23
+Version: 26.3.0.dev25
 Summary: Wandelbots Python Client: Interact with robots in an easy and intuitive way. 
 Home-page: 
 Author: Copyright (c) 2025 Wandelbots GmbH
@@ -41,7 +41,7 @@ Dynamic: license-file
 Interact with robots in an easy and intuitive way.
 
 - Compatible API version: 1.3.0 (can be found at the home screen of your instance -> API)
-- Package version: 26.3.0.dev23
+- Package version: 26.3.0.dev25
 
 ## Requirements.
 Python >=3.11, Python < 4.0

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/README.md

@@ -2,7 +2,7 @@
 Interact with robots in an easy and intuitive way.
 
 - Compatible API version: 1.3.0 (can be found at the home screen of your instance -> API)
-- Package version: 26.3.0.dev23
+- Package version: 26.3.0.dev25
 
 ## Requirements.
 Python >=3.11, Python < 4.0

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wandelbots_api_client"
-version = "26.3.0.dev23"
+version = "26.3.0.dev25"
 description = "Wandelbots Python Client: Interact with robots in an easy and intuitive way. "
 authors = [{ name="Copyright (c) 2025 Wandelbots GmbH", email="contact@wandelbots.com" }]
 license = "Apache-2.0"

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/setup.py

@@ -21,7 +21,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "wandelbots-api-client"
-VERSION = "26.3.0.dev23"
+VERSION = "26.3.0.dev25"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/__init__.py

@@ -13,7 +13,7 @@
     Do not edit the class manually.
 """  # noqa: E501
 
-__version__ = "26.3.0.dev23"
+__version__ = "26.3.0.dev25"
 
 from . import models
 from . import api

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Wandelbots-Nova-API-Python-Client/26.3.0.dev23'
+        self.user_agent = 'Wandelbots-Nova-API-Python-Client/26.3.0.dev25'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/configuration.py

@@ -511,7 +511,7 @@ class Configuration:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.3.0\n"\
-               "SDK Package Version: 26.3.0.dev23".\
+               "SDK Package Version: 26.3.0.dev25".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/v2/__init__.py

@@ -13,7 +13,7 @@
     Do not edit the class manually.
 """  # noqa: E501
 
-__version__ = "26.3.0.dev23"
+__version__ = "26.3.0.dev25"
 
 from . import models
 from . import api

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/v2/api/bus_inputs_outputs_api.py

@@ -3437,6 +3437,270 @@ class BUSInputsOutputsApi:
 
 
 
+    @validate_call
+    async def get_profinet_gsdml(
+        self,
+        cell: Annotated[StrictStr, Field(description="Unique identifier addressing a cell in all API calls. ")],
+        _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,
+    ) -> str:
+        """Get PROFINET GSDML File
+
+        Returns the Generic Station Description Markup Language (GSDML) file for the PROFINET device.  The GSDML file describes the PROFINET device configuration and capabilities, and can be imported into PROFINET engineering tools, e.g., TIA Portal, or other PLC programming environments.  The returned GSDML file matches the current slot configuration of the PROFINET device. 
+
+        :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
+                                 (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_profinet_gsdml_serialize(
+            cell=cell,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '404': "Error",
+            '412': "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_profinet_gsdml_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)],
+            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[str]:
+        """Get PROFINET GSDML File
+
+        Returns the Generic Station Description Markup Language (GSDML) file for the PROFINET device.  The GSDML file describes the PROFINET device configuration and capabilities, and can be imported into PROFINET engineering tools, e.g., TIA Portal, or other PLC programming environments.  The returned GSDML file matches the current slot configuration of the PROFINET device. 
+
+        :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
+                                 (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_profinet_gsdml_serialize(
+            cell=cell,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '404': "Error",
+            '412': "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_profinet_gsdml_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)],
+            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:
+        """Get PROFINET GSDML File
+
+        Returns the Generic Station Description Markup Language (GSDML) file for the PROFINET device.  The GSDML file describes the PROFINET device configuration and capabilities, and can be imported into PROFINET engineering tools, e.g., TIA Portal, or other PLC programming environments.  The returned GSDML file matches the current slot configuration of the PROFINET device. 
+
+        :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
+                                 (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_profinet_gsdml_serialize(
+            cell=cell,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '404': "Error",
+            '412': "Error",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_profinet_gsdml_serialize(
+        self,
+        cell,
+        _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
+        # 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/xml', 
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'BearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/cells/{cell}/bus-ios/profinet/gsdml',
+            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_profinet_ios_from_file(
         self,

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/v2/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Wandelbots-Nova-API-Python-Client/26.3.0.dev23'
+        self.user_agent = 'Wandelbots-Nova-API-Python-Client/26.3.0.dev25'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/v2/configuration.py

@@ -511,7 +511,7 @@ class Configuration:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.3.0 dev\n"\
-               "SDK Package Version: 26.3.0.dev23".\
+               "SDK Package Version: 26.3.0.dev25".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/v2/models/__init__.py

@@ -39,6 +39,7 @@ from .bus_io_profinet import BusIOProfinet
 from .bus_io_profinet_default_route import BusIOProfinetDefaultRoute
 from .bus_io_profinet_ip_config import BusIOProfinetIpConfig
 from .bus_io_profinet_network import BusIOProfinetNetwork
+from .bus_io_profinet_slot import BusIOProfinetSlot
 from .bus_io_profinet_virtual import BusIOProfinetVirtual
 from .bus_io_type import BusIOType
 from .bus_ios_state import BusIOsState
@@ -154,6 +155,7 @@ from .jogging_details_state import JoggingDetailsState
 from .jogging_paused_by_user import JoggingPausedByUser
 from .jogging_paused_near_collision import JoggingPausedNearCollision
 from .jogging_paused_near_joint_limit import JoggingPausedNearJointLimit
+from .jogging_paused_near_singularity import JoggingPausedNearSingularity
 from .jogging_paused_on_io import JoggingPausedOnIO
 from .jogging_running import JoggingRunning
 from .joint_limit_exceeded_error import JointLimitExceededError
@@ -334,6 +336,7 @@ __all__ = [
     "BusIOProfinetDefaultRoute", 
     "BusIOProfinetIpConfig", 
     "BusIOProfinetNetwork", 
+    "BusIOProfinetSlot", 
     "BusIOProfinetVirtual", 
     "BusIOType", 
     "BusIOsState", 
@@ -449,6 +452,7 @@ __all__ = [
     "JoggingPausedByUser", 
     "JoggingPausedNearCollision", 
     "JoggingPausedNearJointLimit", 
+    "JoggingPausedNearSingularity", 
     "JoggingPausedOnIO", 
     "JoggingRunning", 
     "JointLimitExceededError", 

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/v2/models/bus_io_profinet.py

@@ -19,8 +19,10 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from wandelbots_api_client.v2.models.bus_io_profinet_default_route import BusIOProfinetDefaultRoute
 from wandelbots_api_client.v2.models.bus_io_profinet_network import BusIOProfinetNetwork
+from wandelbots_api_client.v2.models.bus_io_profinet_slot import BusIOProfinetSlot
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -32,8 +34,9 @@ class BusIOProfinet(BaseModel):
     network_config: Optional[BusIOProfinetNetwork] = Field(default=None, description="Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active. ") 
     plc_ip: StrictStr = Field(description="IP address of the PLC to establish PROFINET communication with.  The IP address is used to configure the host machine's firewall. The firewall configuration is applied while the BUS input/output service is active. Without proper firewall configuration, PROFINET device discovery, configuration exchanges, and real-time cyclic data communication will fail. ") 
     mac: StrictStr = Field(description="MAC address of the physical ethernet interface that you want to use for PROFINET communication. ") 
+    slots: Optional[Annotated[List[BusIOProfinetSlot], Field(min_length=1)]] = Field(default=None, description="Optional PROFINET slot configuration.  If not provided, the default configuration is used for backward compatibility: one slot with a size of 64 bytes. ") 
     default_route: Optional[BusIOProfinetDefaultRoute] = None 
-    __properties: ClassVar[List[str]] = ["bus_type", "network_config", "plc_ip", "mac", "default_route"]
+    __properties: ClassVar[List[str]] = ["bus_type", "network_config", "plc_ip", "mac", "slots", "default_route"]
 
     @field_validator('bus_type')
     def bus_type_validate_enum(cls, value):
@@ -88,6 +91,16 @@ class BusIOProfinet(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of network_config
         if self.network_config:
             _dict['network_config'] = self.network_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in slots (list)
+        _items = []
+        if self.slots:
+            for _item in self.slots:
+                # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                #     to not drop empty elements in lists
+                if _item is not None:
+                    _items.append(_item.to_dict())
+                # <<< End modification
+            _dict['slots'] = _items
         # override the default output from pydantic by calling `to_dict()` of default_route
         if self.default_route:
             _dict['default_route'] = self.default_route.to_dict()
@@ -107,6 +120,13 @@ class BusIOProfinet(BaseModel):
             "network_config": BusIOProfinetNetwork.from_dict(obj["network_config"]) if obj.get("network_config") is not None else None,
             "plc_ip": obj.get("plc_ip"),
             "mac": obj.get("mac"),
+            "slots": [
+                # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                #     to allow dicts in lists
+                BusIOProfinetSlot.from_dict(_item) if hasattr(BusIOProfinetSlot, 'from_dict') else _item
+                # <<< End modification
+                for _item in obj["slots"]
+            ] if obj.get("slots") is not None else None,
             "default_route": BusIOProfinetDefaultRoute.from_dict(obj["default_route"]) if obj.get("default_route") is not None else None
         })
         return _obj

wandelbots_api_client-26.3.0.dev25/wandelbots_api_client/v2/models/bus_io_profinet_slot.py

@@ -0,0 +1,96 @@
+# 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 __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BusIOProfinetSlot(BaseModel):
+    """
+    Configuration for one PROFINET process data slot. 
+    """ # noqa: E501
+    slot: Annotated[int, Field(strict=True, ge=1)] = Field(description="Slot identifier on the PROFINET device. ") 
+    input_size_bytes: Annotated[int, Field(strict=True, ge=0)] = Field(description="Process data size in bytes for the input direction (device → controller). ") 
+    output_size_bytes: Annotated[int, Field(strict=True, ge=0)] = Field(description="Process data size in bytes for the output direction (controller → device). ") 
+    __properties: ClassVar[List[str]] = ["slot", "input_size_bytes", "output_size_bytes"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+        
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BusIOProfinetSlot from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BusIOProfinetSlot from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "slot": obj.get("slot"),
+            "input_size_bytes": obj.get("input_size_bytes"),
+            "output_size_bytes": obj.get("output_size_bytes")
+        })
+        return _obj
+
+

{wandelbots_api_client-26.3.0.dev23 → wandelbots_api_client-26.3.0.dev25}/wandelbots_api_client/v2/models/jogging_details.py

@@ -25,7 +25,7 @@ from typing_extensions import Self
 
 class JoggingDetails(BaseModel):
     """
-    State of jogging execution. This state is sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate. The jogging state can be one of the following: - RUNNING: Jogging is active. - PAUSED_BY_USER: User has paused jogging. - PAUSED_NEAR_JOINT_LIMIT: Jogging was paused because a joint is is near its limit. - PAUSED_NEAR_COLLISION: Jogging was paused because the motion group neared a collision. - PAUSED_ON_IO: Jogging was paused because of an I/O event. 
+    State of jogging execution. This state is sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate. The jogging state can be one of the following: - RUNNING: Jogging is active. - PAUSED_BY_USER: User has paused jogging. - PAUSED_NEAR_JOINT_LIMIT: Jogging was paused because a joint is near its limit. - PAUSED_NEAR_COLLISION: Jogging was paused because the motion group neared a collision. - PAUSED_NEAR_SINGULARITY: Jogging was paused because the motion group neared a singularity or the workspace boundary. - PAUSED_ON_IO: Jogging was paused because of an I/O event. 
     """ # noqa: E501
     state: JoggingDetailsState 
     kind: str = "JOGGING"