wandelbots_api_client 26.3.0__py3-none-any.whl

wandelbots_api_client/models/pause_movement_request.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0
+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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PauseMovementRequest(BaseModel):
+    """
+    Request to pause the movement execution. Movement pauses as soon as a [Standstill](Standstill.yaml) is sent back to the client. Resume movement with StartMovementRequest.
+    """  # noqa: E501
+
+    message_type: Optional[StrictStr] = Field(default="PauseMovementRequest", description="Type specifier for server, set automatically. ")
+    send_response: Optional[StrictBool] = Field(
+        default=True,
+        description="Defaults to `true`. Set to true to get a response signalling successful initiation to pause the movement. ",
+    )
+    __properties: ClassVar[List[str]] = ["message_type", "send_response"]
+
+    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 PauseMovementRequest 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 PauseMovementRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "message_type": obj.get("message_type") if obj.get("message_type") is not None else "PauseMovementRequest",
+                "send_response": obj.get("send_response") if obj.get("send_response") is not None else True,
+            }
+        )
+        return _obj

wandelbots_api_client/models/pause_movement_response.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: 1.4.0
+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
+from typing import Any, ClassVar, Dict, List
+from wandelbots_api_client.models.pause_movement_response_pause_response import PauseMovementResponsePauseResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PauseMovementResponse(BaseModel):
+    """
+    Response for PauseMovementRequest message. ATTENTION: No confirmation that the movement was paused. Confirmation that the PauseMovementRequest was received and is processed.            End of movement execution is signalled by Standstill response.
+    """  # noqa: E501
+
+    pause_response: PauseMovementResponsePauseResponse
+    __properties: ClassVar[List[str]] = ["pause_response"]
+
+    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 PauseMovementResponse 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 pause_response
+        if self.pause_response:
+            _dict["pause_response"] = self.pause_response.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PauseMovementResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "pause_response": PauseMovementResponsePauseResponse.from_dict(obj["pause_response"])
+                if obj.get("pause_response") is not None
+                else None
+            }
+        )
+        return _obj

wandelbots_api_client/models/pause_movement_response_pause_response.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0
+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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PauseMovementResponsePauseResponse(BaseModel):
+    """
+    PauseMovementResponsePauseResponse
+    """  # noqa: E501
+
+    succeeded: StrictBool = Field(description="Indicates if PauseMovementRequest can be executed.")
+    error_message: Optional[StrictStr] = Field(
+        default=None, description="Error message in case of invalid PauseMovementRequest or failure while claiming motion. "
+    )
+    __properties: ClassVar[List[str]] = ["succeeded", "error_message"]
+
+    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 PauseMovementResponsePauseResponse 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 PauseMovementResponsePauseResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"succeeded": obj.get("succeeded"), "error_message": obj.get("error_message")})
+        return _obj

wandelbots_api_client/models/pause_on_io.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: 1.4.0
+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 wandelbots_api_client.models.comparator import Comparator
+from wandelbots_api_client.models.io_value import IOValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PauseOnIO(BaseModel):
+    """
+    Defines an I/O that the motion will be paused for. The motion will stop gracefully on path.
+    """  # noqa: E501
+
+    io: IOValue
+    comparator: Comparator = Field(
+        description="Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b. "
+    )
+    __properties: ClassVar[List[str]] = ["io", "comparator"]
+
+    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 PauseOnIO 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 io
+        if self.io:
+            _dict["io"] = self.io.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PauseOnIO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"io": IOValue.from_dict(obj["io"]) if obj.get("io") is not None else None, "comparator": obj.get("comparator")}
+        )
+        return _obj

wandelbots_api_client/models/payload.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0
+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
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from wandelbots_api_client.models.vector3d import Vector3d
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Payload(BaseModel):
+    """
+    Payload
+    """  # noqa: E501
+
+    name: StrictStr = Field(description="Unique identifier of the payload.")
+    payload: Union[StrictFloat, StrictInt] = Field(description="Mass of payload in [kg].")
+    center_of_mass: Optional[Vector3d] = None
+    moment_of_inertia: Optional[Vector3d] = None
+    __properties: ClassVar[List[str]] = ["name", "payload", "center_of_mass", "moment_of_inertia"]
+
+    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 Payload 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 center_of_mass
+        if self.center_of_mass:
+            _dict["center_of_mass"] = self.center_of_mass.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of moment_of_inertia
+        if self.moment_of_inertia:
+            _dict["moment_of_inertia"] = self.moment_of_inertia.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Payload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "name": obj.get("name"),
+                "payload": obj.get("payload"),
+                "center_of_mass": Vector3d.from_dict(obj["center_of_mass"]) if obj.get("center_of_mass") is not None else None,
+                "moment_of_inertia": Vector3d.from_dict(obj["moment_of_inertia"]) if obj.get("moment_of_inertia") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/models/plan_collision_free_ptp_request.py

@@ -0,0 +1,131 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0
+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
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from wandelbots_api_client.models.collider import Collider
+from wandelbots_api_client.models.collision_motion_group import CollisionMotionGroup
+from wandelbots_api_client.models.optimizer_setup import OptimizerSetup
+from wandelbots_api_client.models.plan_collision_free_ptp_request_target import PlanCollisionFreePTPRequestTarget
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PlanCollisionFreePTPRequest(BaseModel):
+    """
+    PlanCollisionFreePTPRequest
+    """  # noqa: E501
+
+    robot_setup: OptimizerSetup = Field(
+        description="The robot setup as returned from the [getOptimizerConfiguration](#/operations/getOptimizerConfiguration) endpoint."
+    )
+    start_joint_position: List[Union[StrictFloat, StrictInt]] = Field(
+        description="Indicate the current joint position as start joint position to define a motion. To retrieve the current joint position use the endpoint [getCurrentMotionGroupState](#/operations/getCurrentMotionGroupState). To move the robot to the start joint position use the endpoint [streamMoveToTrajectoryViaJointP2P](#/operations/streamMoveToTrajectoryViaJointP2P). "
+    )
+    target: PlanCollisionFreePTPRequestTarget
+    static_colliders: Optional[Dict[str, Collider]] = Field(
+        default=None, description="Static colliders considered during motion planning. "
+    )
+    collision_motion_group: Optional[CollisionMotionGroup] = Field(
+        default=None, description="Collision motion group considered during the motion planning. "
+    )
+    __properties: ClassVar[List[str]] = ["robot_setup", "start_joint_position", "target", "static_colliders", "collision_motion_group"]
+
+    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 PlanCollisionFreePTPRequest 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 robot_setup
+        if self.robot_setup:
+            _dict["robot_setup"] = self.robot_setup.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of target
+        if self.target:
+            _dict["target"] = self.target.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in static_colliders (dict)
+        # >>> Modified from openapi template
+        if self.static_colliders:
+            _field_dict = {}
+            for _key, _value in self.static_colliders.items():
+                if self.static_colliders[_key]:
+                    _field_dict[_key] = _value.to_dict()
+            _dict["static_colliders"] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of collision_motion_group
+        if self.collision_motion_group:
+            _dict["collision_motion_group"] = self.collision_motion_group.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanCollisionFreePTPRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "robot_setup": OptimizerSetup.from_dict(obj["robot_setup"]) if obj.get("robot_setup") is not None else None,
+                "start_joint_position": obj.get("start_joint_position"),
+                "target": PlanCollisionFreePTPRequestTarget.from_dict(obj["target"]) if obj.get("target") is not None else None,
+                "static_colliders": dict((_k, Collider.from_dict(_v)) for _k, _v in obj["static_colliders"].items())
+                if obj.get("static_colliders") is not None
+                else None,
+                "collision_motion_group": CollisionMotionGroup.from_dict(obj["collision_motion_group"])
+                if obj.get("collision_motion_group") is not None
+                else None,
+            }
+        )
+        return _obj