wandelbots-api-client 25.6.0.dev7__py3-none-any.whl → 25.10.0rc2__py3-none-any.whl

wandelbots_api_client/v2/models/{list_io_values_response.py → stream_io_values_response.py}

@@ -3,9 +3,9 @@
 """
     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.
@@ -17,18 +17,22 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
-from wandelbots_api_client.v2.models.set_output_values_request_inner import SetOutputValuesRequestInner
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.io_value import IOValue
 from typing import Optional, Set
 from typing_extensions import Self
 
-class ListIOValuesResponse(BaseModel):
+class StreamIOValuesResponse(BaseModel):
     """
     Array of input/output values.
     """ # noqa: E501
-    io_values: List[SetOutputValuesRequestInner]
-    __properties: ClassVar[List[str]] = ["io_values"]
+    io_values: List[IOValue] 
+    timestamp: datetime = Field(description="Timestamp indicating when the represented information was received from the robot controller.") 
+    sequence_number: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="Sequence number of the controller state. It starts with 0 upon establishing the connection with a physical controller. The sequence number is reset when the connection to the physical controller is closed and re-established. ") 
+    __properties: ClassVar[List[str]] = ["io_values", "timestamp", "sequence_number"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -52,7 +56,7 @@ class ListIOValuesResponse(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of ListIOValuesResponse from a JSON string"""
+        """Create an instance of StreamIOValuesResponse from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -87,7 +91,7 @@ class ListIOValuesResponse(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ListIOValuesResponse from a dict"""
+        """Create an instance of StreamIOValuesResponse from a dict"""
         if obj is None:
             return None
 
@@ -98,10 +102,12 @@ class ListIOValuesResponse(BaseModel):
             "io_values": [
                 # >>> 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
-                SetOutputValuesRequestInner.from_dict(_item) if hasattr(SetOutputValuesRequestInner, 'from_dict') else _item
+                IOValue.from_dict(_item) if hasattr(IOValue, 'from_dict') else _item
                 # <<< End modification
                 for _item in obj["io_values"]
-            ] if obj.get("io_values") is not None else None
+            ] if obj.get("io_values") is not None else None,
+            "timestamp": obj.get("timestamp"),
+            "sequence_number": obj.get("sequence_number")
         })
         return _obj
 

wandelbots_api_client/v2/models/tcp_offset.py

@@ -3,9 +3,9 @@
 """
     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.
@@ -27,8 +27,8 @@ class TcpOffset(BaseModel):
     """
     TcpOffset
     """ # noqa: E501
-    name: StrictStr = Field(description="A readable and changeable name for frontend visualization.")
-    pose: Pose
+    name: StrictStr = Field(description="A readable and changeable name for frontend visualization.") 
+    pose: Pose 
     __properties: ClassVar[List[str]] = ["name", "pose"]
 
     model_config = ConfigDict(

wandelbots_api_client/v2/models/{tcp_required.py → tcp_required_error.py}

@@ -3,9 +3,9 @@
 """
     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.
@@ -22,11 +22,11 @@ from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class TcpRequired(BaseModel):
+class TcpRequiredError(BaseModel):
     """
     Requested motion group requires TCP to be defined.
     """ # noqa: E501
-    tcp_missing: Optional[Any] = None
+    tcp_missing: Optional[Any] = None 
     __properties: ClassVar[List[str]] = ["tcp_missing"]
 
     model_config = ConfigDict(
@@ -51,7 +51,7 @@ class TcpRequired(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of TcpRequired from a JSON string"""
+        """Create an instance of TcpRequiredError from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -81,7 +81,7 @@ class TcpRequired(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of TcpRequired from a dict"""
+        """Create an instance of TcpRequiredError from a dict"""
         if obj is None:
             return None
 

wandelbots_api_client/v2/models/tcp_velocity_request.py

@@ -3,9 +3,9 @@
 """
     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.
@@ -27,18 +27,15 @@ class TcpVelocityRequest(BaseModel):
     """
     Sets target TCP velocities for jogging a motion group. The motion group needs to have an inverse kinematic solver to be jogged by TCP velocities. Check `supports_inverse_kinematics` field in response of [listController](listController) for the motion group. 
     """ # noqa: E501
-    message_type: Optional[StrictStr] = Field(default=None, description="Type specifier for server, set automatically. ")
-    translation: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)] = Field(description="A three-dimensional vector [x, y, z] with double precision. ")
-    rotation: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)] = Field(description="A three-dimensional vector [x, y, z] with double precision. ")
-    use_tool_coordinate_system: Optional[StrictBool] = Field(default=False, description="If true, TCP velocities are interpreted in the tool coordinate system, specified by the TCP. If false, TCP velocities are interpreted in the world coordinate system. ")
+    message_type: str = "TcpVelocityRequest"
+    translation: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)] = Field(description="A three-dimensional vector [x, y, z] with double precision. ") 
+    rotation: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)] = Field(description="A three-dimensional vector [x, y, z] with double precision. ") 
+    use_tool_coordinate_system: Optional[StrictBool] = Field(default=False, description="If true, TCP velocities are interpreted in the tool coordinate system, specified by the TCP. If false, TCP velocities are interpreted in the world coordinate system. ") 
     __properties: ClassVar[List[str]] = ["message_type", "translation", "rotation", "use_tool_coordinate_system"]
 
     @field_validator('message_type')
     def message_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value is None:
-            return value
-
         if value not in set(['TcpVelocityRequest']):
             raise ValueError("must be one of enum values ('TcpVelocityRequest')")
         return value

wandelbots_api_client/v2/models/tcp_velocity_response.py

@@ -0,0 +1,100 @@
+# 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 __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TcpVelocityResponse(BaseModel):
+    """
+    Acknowledgment to a TcpVelocityRequest. 
+    """ # noqa: E501
+    message: Optional[StrictStr] = Field(default=None, description="Error message in case of invalid TcpVelocityRequest.") 
+    kind: str = "TCP_VELOCITY_RECEIVED"
+    __properties: ClassVar[List[str]] = ["message", "kind"]
+
+    @field_validator('kind')
+    def kind_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['TCP_VELOCITY_RECEIVED']):
+            raise ValueError("must be one of enum values ('TCP_VELOCITY_RECEIVED')")
+        return value
+
+    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 TcpVelocityResponse 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 TcpVelocityResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "message": obj.get("message"),
+            "kind": obj.get("kind")
+        })
+        return _obj
+
+

wandelbots_api_client/v2/models/{torque_exceeded.py → torque_exceeded_error.py}

@@ -3,9 +3,9 @@
 """
     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.
@@ -19,15 +19,15 @@ import json
 
 from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
-from wandelbots_api_client.v2.models.torque_exceeded_torque_exceeded import TorqueExceededTorqueExceeded
+from wandelbots_api_client.v2.models.torque_exceeded_error_torque_exceeded import TorqueExceededErrorTorqueExceeded
 from typing import Optional, Set
 from typing_extensions import Self
 
-class TorqueExceeded(BaseModel):
+class TorqueExceededError(BaseModel):
     """
-    TorqueExceeded
+    TorqueExceededError
     """ # noqa: E501
-    torque_exceeded: Optional[TorqueExceededTorqueExceeded] = None
+    torque_exceeded: Optional[TorqueExceededErrorTorqueExceeded] = None 
     __properties: ClassVar[List[str]] = ["torque_exceeded"]
 
     model_config = ConfigDict(
@@ -52,7 +52,7 @@ class TorqueExceeded(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of TorqueExceeded from a JSON string"""
+        """Create an instance of TorqueExceededError from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -80,7 +80,7 @@ class TorqueExceeded(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of TorqueExceeded from a dict"""
+        """Create an instance of TorqueExceededError from a dict"""
         if obj is None:
             return None
 
@@ -88,7 +88,7 @@ class TorqueExceeded(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "torque_exceeded": TorqueExceededTorqueExceeded.from_dict(obj["torque_exceeded"]) if obj.get("torque_exceeded") is not None else None
+            "torque_exceeded": TorqueExceededErrorTorqueExceeded.from_dict(obj["torque_exceeded"]) if obj.get("torque_exceeded") is not None else None
         })
         return _obj
 

wandelbots_api_client/v2/models/{torque_exceeded_torque_exceeded.py → torque_exceeded_error_torque_exceeded.py}

@@ -3,9 +3,9 @@
 """
     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.
@@ -22,12 +22,12 @@ from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
 
-class TorqueExceededTorqueExceeded(BaseModel):
+class TorqueExceededErrorTorqueExceeded(BaseModel):
     """
-    TorqueExceededTorqueExceeded
+    TorqueExceededErrorTorqueExceeded
     """ # noqa: E501
-    torque_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The torque value that was exceeded. ")
-    torque_limit: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The value of the torque limit that was exceeded. ")
+    torque_value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The torque value that was exceeded. ") 
+    torque_limit: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The value of the torque limit that was exceeded. ") 
     __properties: ClassVar[List[str]] = ["torque_value", "torque_limit"]
 
     model_config = ConfigDict(
@@ -52,7 +52,7 @@ class TorqueExceededTorqueExceeded(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of TorqueExceededTorqueExceeded from a JSON string"""
+        """Create an instance of TorqueExceededErrorTorqueExceeded from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -77,7 +77,7 @@ class TorqueExceededTorqueExceeded(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of TorqueExceededTorqueExceeded from a dict"""
+        """Create an instance of TorqueExceededErrorTorqueExceeded from a dict"""
         if obj is None:
             return None
 

wandelbots_api_client/v2/models/trajectory_data.py

@@ -3,9 +3,9 @@
 """
     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.
@@ -27,10 +27,10 @@ class TrajectoryData(BaseModel):
     """
     TrajectoryData
     """ # noqa: E501
-    message_type: StrictStr = Field(description="Type specifier for server, set automatically. ")
-    motion_group: Optional[StrictStr] = Field(default=None, description="Identifier of the motion-group.")
-    data: JointTrajectory = Field(description="The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps. ")
-    tcp: Optional[StrictStr] = Field(default=None, description="Unique identifier of the tool the trajectory is planned for.")
+    message_type: str = "TrajectoryData"
+    motion_group: Optional[StrictStr] = Field(default=None, description="Identifier of the motion-group.") 
+    data: JointTrajectory = Field(description="The trajectory consisting of a list of joint positions and an equal number of corresponding timestamps. ") 
+    tcp: Optional[StrictStr] = Field(default=None, description="Unique identifier of the tool the trajectory is planned for.") 
     __properties: ClassVar[List[str]] = ["message_type", "motion_group", "data", "tcp"]
 
     @field_validator('message_type')

wandelbots_api_client/v2/models/trajectory_details.py

@@ -0,0 +1,108 @@
+# 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 __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from wandelbots_api_client.v2.models.trajectory_details_state import TrajectoryDetailsState
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TrajectoryDetails(BaseModel):
+    """
+    State of trajectory execution. This state is sent during trajectory movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate. The trajectory state can be one of the following: - RUNNING: Trajectory is being executed. - PAUSED_BY_USER: User has paused execution. - END_OF_TRAJECTORY: First or last sample (depending on direction) of trajectory has been sent. - WAIT_FOR_IO: Waiting for an I/O event to start execution. - PAUSED_ON_IO: Execution was paused because of an I/O event. 
+    """ # noqa: E501
+    trajectory: StrictStr = Field(description="Unique identifier of the trajectory being executed. ") 
+    location: Union[StrictFloat, StrictInt] = Field(description="Location on trajectory where the execution will start. The default value is the start (forward movement) or end (backward movement) of the trajectory. If you want to start your movement from an arbitrary location, e.g., in combination with [streamMoveToTrajectoryViaJointPTP](streamMoveToTrajectoryViaJointPTP), set the location by respecting the following format: - The location is a scalar value that defines a position along a path, typically ranging from 0 to `n`,   where `n` denotes the number of motion commands - Each integer value of the location corresponds to a specific motion command,   while non-integer values interpolate positions within the segments. - The location is calculated from the joint path ") 
+    state: TrajectoryDetailsState 
+    kind: str = "TRAJECTORY"
+    __properties: ClassVar[List[str]] = ["trajectory", "location", "state", "kind"]
+
+    @field_validator('kind')
+    def kind_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['TRAJECTORY']):
+            raise ValueError("must be one of enum values ('TRAJECTORY')")
+        return value
+
+    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 TrajectoryDetails 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of state
+        if self.state:
+            _dict['state'] = self.state.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TrajectoryDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "trajectory": obj.get("trajectory"),
+            "location": obj.get("location"),
+            "state": TrajectoryDetailsState.from_dict(obj["state"]) if obj.get("state") is not None else None,
+            "kind": obj.get("kind")
+        })
+        return _obj
+
+