wandelbots_api_client 26.3.0__py3-none-any.whl

wandelbots_api_client/models/single_joint_limit.py

@@ -0,0 +1,112 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class SingleJointLimit(BaseModel):
+    """
+    A joint limit can contain a position (rad or mm), a velocity (rad/s or mm/s), an acceleration (rad/s² or mm/s²) or a jerk (rad/s³ or mm/s³).
+    """  # noqa: E501
+
+    joint: StrictStr = Field(description="Definition of the joint where the limits are applied.")
+    limit: Union[StrictFloat, StrictInt] = Field(description="Limit, unit depends on usage of this message structure.")
+    __properties: ClassVar[List[str]] = ["joint", "limit"]
+
+    @field_validator("joint")
+    def joint_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(
+            [
+                "JOINTNAME_AXIS_INVALID",
+                "JOINTNAME_AXIS_1",
+                "JOINTNAME_AXIS_2",
+                "JOINTNAME_AXIS_3",
+                "JOINTNAME_AXIS_4",
+                "JOINTNAME_AXIS_5",
+                "JOINTNAME_AXIS_6",
+                "JOINTNAME_AXIS_7",
+                "JOINTNAME_AXIS_8",
+                "JOINTNAME_AXIS_9",
+                "JOINTNAME_AXIS_10",
+                "JOINTNAME_AXIS_11",
+                "JOINTNAME_AXIS_12",
+            ]
+        ):
+            raise ValueError(
+                "must be one of enum values ('JOINTNAME_AXIS_INVALID', 'JOINTNAME_AXIS_1', 'JOINTNAME_AXIS_2', 'JOINTNAME_AXIS_3', 'JOINTNAME_AXIS_4', 'JOINTNAME_AXIS_5', 'JOINTNAME_AXIS_6', 'JOINTNAME_AXIS_7', 'JOINTNAME_AXIS_8', 'JOINTNAME_AXIS_9', 'JOINTNAME_AXIS_10', 'JOINTNAME_AXIS_11', 'JOINTNAME_AXIS_12')"
+            )
+        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 SingleJointLimit 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 SingleJointLimit from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"joint": obj.get("joint"), "limit": obj.get("limit")})
+        return _obj

wandelbots_api_client/models/singularity.py

@@ -0,0 +1,110 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.models.joints import Joints
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Singularity(BaseModel):
+    """
+    A Singularity is a point in the robot's workspace where the robot loses one or more degrees of freedom with regards to moving its TCP. This means the robot cannot move or rotate the TCP in a certain direction from this specific point.  The singularity type is the type of singularity that the robot is in. The singular joint position is the joint position of the robot when it is in a singularity.
+    """  # noqa: E501
+
+    singularity_type: Optional[StrictStr] = None
+    singular_joint_position: Optional[Joints] = None
+    __properties: ClassVar[List[str]] = ["singularity_type", "singular_joint_position"]
+
+    @field_validator("singularity_type")
+    def singularity_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["SINGULARITY_TYPE_UNKNOWN", "SINGULARITY_TYPE_WRIST", "SINGULARITY_TYPE_ELBOW", "SINGULARITY_TYPE_SHOULDER"]):
+            raise ValueError(
+                "must be one of enum values ('SINGULARITY_TYPE_UNKNOWN', 'SINGULARITY_TYPE_WRIST', 'SINGULARITY_TYPE_ELBOW', 'SINGULARITY_TYPE_SHOULDER')"
+            )
+        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 Singularity 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 singular_joint_position
+        if self.singular_joint_position:
+            _dict["singular_joint_position"] = self.singular_joint_position.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Singularity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "singularity_type": obj.get("singularity_type"),
+                "singular_joint_position": Joints.from_dict(obj["singular_joint_position"])
+                if obj.get("singular_joint_position") is not None
+                else None,
+            }
+        )
+        return _obj

wandelbots_api_client/models/singularity_type_enum.py

@@ -0,0 +1,35 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class SingularityTypeEnum(str, Enum):
+    """
+    SingularityTypeEnum
+    """
+
+    """
+    allowed enum values
+    """
+    WRIST = "WRIST"
+    ELBOW = "ELBOW"
+    SHOULDER = "SHOULDER"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SingularityTypeEnum from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/models/sphere.py

@@ -0,0 +1,86 @@
+# 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, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Sphere(BaseModel):
+    """
+    Defines a spherical shape centered around an origin.
+    """  # noqa: E501
+
+    radius: Union[StrictFloat, StrictInt] = Field(description="The radius of the sphere in [mm].")
+    __properties: ClassVar[List[str]] = ["radius"]
+
+    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 Sphere 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 Sphere from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"radius": obj.get("radius")})
+        return _obj

wandelbots_api_client/models/sphere2.py

@@ -0,0 +1,94 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Sphere2(BaseModel):
+    """
+    Defines a spherical shape centred around the origin.
+    """  # noqa: E501
+
+    shape_type: str = "sphere"
+    radius: Union[StrictFloat, StrictInt] = Field(description="The radius of the sphere in [mm].")
+    __properties: ClassVar[List[str]] = ["shape_type", "radius"]
+
+    @field_validator("shape_type")
+    def shape_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["sphere"]):
+            raise ValueError("must be one of enum values ('sphere')")
+        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 Sphere2 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 Sphere2 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"shape_type": obj.get("shape_type"), "radius": obj.get("radius")})
+        return _obj

wandelbots_api_client/models/sphere3.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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Sphere3(BaseModel):
+    """
+    Centered around origin.
+    """  # noqa: E501
+
+    shape_type: str = "sphere"
+    radius: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["shape_type", "radius"]
+
+    @field_validator("shape_type")
+    def shape_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["sphere"]):
+            raise ValueError("must be one of enum values ('sphere')")
+        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 Sphere3 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 Sphere3 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"shape_type": obj.get("shape_type") if obj.get("shape_type") is not None else "sphere", "radius": obj.get("radius")}
+        )
+        return _obj

wandelbots_api_client/models/standstill.py

@@ -0,0 +1,92 @@
+# 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.standstill_standstill import StandstillStandstill
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Standstill(BaseModel):
+    """
+    The response will be sent one time at the end of every execution signalling that the motion group has stopped moving.
+    """  # noqa: E501
+
+    standstill: StandstillStandstill
+    __properties: ClassVar[List[str]] = ["standstill"]
+
+    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 Standstill 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 standstill
+        if self.standstill:
+            _dict["standstill"] = self.standstill.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Standstill from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"standstill": StandstillStandstill.from_dict(obj["standstill"]) if obj.get("standstill") is not None else None}
+        )
+        return _obj

wandelbots_api_client/models/standstill_reason.py

@@ -0,0 +1,36 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class StandstillReason(str, Enum):
+    """
+    The reason why the movement is paused.
+    """
+
+    """
+    allowed enum values
+    """
+    REASON_MOTION_ENDED = "REASON_MOTION_ENDED"
+    REASON_USER_PAUSED_MOTION = "REASON_USER_PAUSED_MOTION"
+    REASON_WAITING_FOR_IO = "REASON_WAITING_FOR_IO"
+    REASON_PAUSED_ON_IO = "REASON_PAUSED_ON_IO"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of StandstillReason from a JSON string"""
+        return cls(json.loads(json_str))