wandelbots_api_client 26.3.0__py3-none-any.whl

wandelbots_api_client/v2/models/safety_geometry_plane.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: 2.3.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_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class SafetyGeometryPlane(BaseModel):
+    """
+    Mathematical half-space plane shape defined by its 3D vertices. A minimum of three coplanar points is required to define the plane's orientation. The plane extends infinitely in all directions parallel to the defined surface. For collision avoidance, planner implementations may approximate it using a large, thin box proxy.
+    """  # noqa: E501
+
+    point: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=9)] = Field(
+        description="Vertices defining a plane as a flattened array [x1, y1, z1, x2, y2, z2, x3, y3, z3, ...] in [mm]. Minimum 3 points required (9 values). Points define plane orientation and position; the plane is mathematically unbounded. "
+    )
+    __properties: ClassVar[List[str]] = ["point"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SafetyGeometryPlane 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 SafetyGeometryPlane from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"point": obj.get("point")})
+        return _obj

wandelbots_api_client/v2/models/safety_geometry_prism.py

@@ -0,0 +1,88 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class SafetyGeometryPrism(BaseModel):
+    """
+    Prism (extruded polygon) shape. The base polygon is defined by 2D points in the XY plane, and the prism extends along the Z axis between the bottom and top Z coordinates.
+    """  # noqa: E501
+
+    point: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=6)] = Field(
+        description="2D points defining the base polygon as a flattened array [x1, y1, x2, y2, ...] in [mm]. Minimum 3 points required (6 values). Points should form a closed polygon in the XY plane. "
+    )
+    top: Union[StrictFloat, StrictInt] = Field(description="Top z-coordinate of the prism in [mm].")
+    bottom: Union[StrictFloat, StrictInt] = Field(description="Bottom z-coordinate of the prism in [mm].")
+    __properties: ClassVar[List[str]] = ["point", "top", "bottom"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SafetyGeometryPrism 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 SafetyGeometryPrism from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"point": obj.get("point"), "top": obj.get("top"), "bottom": obj.get("bottom")})
+        return _obj

wandelbots_api_client/v2/models/safety_geometry_sphere.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class SafetyGeometrySphere(BaseModel):
+    """
+    Sphere shape defined by a center point and a radius.
+    """  # noqa: E501
+
+    center: Annotated[List[Union[StrictFloat, StrictInt]], Field(min_length=3, max_length=3)] = Field(
+        description="Center of the sphere as Vector3 [x, y, z] in [mm]."
+    )
+    radius: Union[StrictFloat, StrictInt] = Field(description="Radius of the sphere in [mm].")
+    __properties: ClassVar[List[str]] = ["center", "radius"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SafetyGeometrySphere 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 SafetyGeometrySphere from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"center": obj.get("center"), "radius": obj.get("radius")})
+        return _obj

wandelbots_api_client/v2/models/safety_state_type.py

@@ -0,0 +1,48 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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 SafetyStateType(str, Enum):
+    """
+    Current safety state of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - SAFETY_STATE_NORMAL - SAFETY_STATE_REDUCED All other modes are considered as non-operational.
+    """
+
+    """
+    allowed enum values
+    """
+    SAFETY_STATE_UNKNOWN = "SAFETY_STATE_UNKNOWN"
+    SAFETY_STATE_FAULT = "SAFETY_STATE_FAULT"
+    SAFETY_STATE_NORMAL = "SAFETY_STATE_NORMAL"
+    SAFETY_STATE_MASTERING = "SAFETY_STATE_MASTERING"
+    SAFETY_STATE_CONFIRM_SAFETY = "SAFETY_STATE_CONFIRM_SAFETY"
+    SAFETY_STATE_OPERATOR_SAFETY = "SAFETY_STATE_OPERATOR_SAFETY"
+    SAFETY_STATE_PROTECTIVE_STOP = "SAFETY_STATE_PROTECTIVE_STOP"
+    SAFETY_STATE_REDUCED = "SAFETY_STATE_REDUCED"
+    SAFETY_STATE_STOP = "SAFETY_STATE_STOP"
+    SAFETY_STATE_STOP_0 = "SAFETY_STATE_STOP_0"
+    SAFETY_STATE_STOP_1 = "SAFETY_STATE_STOP_1"
+    SAFETY_STATE_STOP_2 = "SAFETY_STATE_STOP_2"
+    SAFETY_STATE_RECOVERY = "SAFETY_STATE_RECOVERY"
+    SAFETY_STATE_DEVICE_EMERGENCY_STOP = "SAFETY_STATE_DEVICE_EMERGENCY_STOP"
+    SAFETY_STATE_ROBOT_EMERGENCY_STOP = "SAFETY_STATE_ROBOT_EMERGENCY_STOP"
+    SAFETY_STATE_VIOLATION = "SAFETY_STATE_VIOLATION"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SafetyStateType from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/safety_zone.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.v2.models.safety_geometry import SafetyGeometry
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class SafetyZone(BaseModel):
+    """
+    Defines a safety zone with geometric boundaries and constraints. Safety zones are used to restrict robot motion or define protected areas.
+    """  # noqa: E501
+
+    id: StrictInt = Field(description="Unique identifier of the safety zone.")
+    name: StrictStr = Field(description="Name of the safety zone.")
+    priority: Optional[StrictInt] = Field(default=0, description="Priority of the safety zone.")
+    restricted: Optional[StrictBool] = Field(default=False, description="If `true`, the zone is restricted and the robot cannot enter it.")
+    geometry: SafetyGeometry = Field(description="The geometric shape of the safety zone.")
+    mg_uid: Optional[StrictInt] = Field(
+        default=None,
+        description="UID of the motion group this safety zone is attached to. Must match an existing motion group UID on the controller. ",
+    )
+    uid_ref_cs: Optional[StrictStr] = Field(
+        default=None,
+        description='UID of the coordinate system in which the geometry coordinates are expressed. The coordinate system must be defined on the controller beforehand. If empty (""), the World coordinate system is used. ',
+    )
+    active: Optional[StrictBool] = Field(default=True, description="If `true`, the safety zone is active.")
+    __properties: ClassVar[List[str]] = ["id", "name", "priority", "restricted", "geometry", "mg_uid", "uid_ref_cs", "active"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SafetyZone 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 geometry
+        if self.geometry:
+            _dict["geometry"] = self.geometry.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SafetyZone from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "id": obj.get("id"),
+                "name": obj.get("name"),
+                "priority": obj.get("priority") if obj.get("priority") is not None else 0,
+                "restricted": obj.get("restricted") if obj.get("restricted") is not None else False,
+                "geometry": SafetyGeometry.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None,
+                "mg_uid": obj.get("mg_uid"),
+                "uid_ref_cs": obj.get("uid_ref_cs"),
+                "active": obj.get("active") if obj.get("active") is not None else True,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/safety_zone_pose.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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
+from pydantic_core import to_jsonable_python
+
+
+class SafetyZonePose(BaseModel):
+    """
+    Pose with position (x, y, z) in [mm] and orientation as quaternion (qx, qy, qz, qw).
+    """  # noqa: E501
+
+    x: Union[StrictFloat, StrictInt] = Field(description="X position in [mm].")
+    y: Union[StrictFloat, StrictInt] = Field(description="Y position in [mm].")
+    z: Union[StrictFloat, StrictInt] = Field(description="Z position in [mm].")
+    qx: Union[StrictFloat, StrictInt] = Field(description="Quaternion X component.")
+    qy: Union[StrictFloat, StrictInt] = Field(description="Quaternion Y component.")
+    qz: Union[StrictFloat, StrictInt] = Field(description="Quaternion Z component.")
+    qw: Union[StrictFloat, StrictInt] = Field(description="Quaternion W component.")
+    __properties: ClassVar[List[str]] = ["x", "y", "z", "qx", "qy", "qz", "qw"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SafetyZonePose 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 SafetyZonePose from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "x": obj.get("x"),
+                "y": obj.get("y"),
+                "z": obj.get("z"),
+                "qx": obj.get("qx"),
+                "qy": obj.get("qy"),
+                "qz": obj.get("qz"),
+                "qw": obj.get("qw"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/safety_zones.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.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.v2.models.safety_zone import SafetyZone
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class SafetyZones(BaseModel):
+    """
+    Response containing all safety zones.
+    """  # noqa: E501
+
+    safety_zones: List[SafetyZone] = Field(description="List of all safety zones.")
+    __properties: ClassVar[List[str]] = ["safety_zones"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=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))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of SafetyZones 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 each item in safety_zones (list)
+        _items = []
+        if self.safety_zones:
+            for _item_safety_zones in self.safety_zones:
+                if _item_safety_zones:
+                    _items.append(_item_safety_zones.to_dict())
+            _dict["safety_zones"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SafetyZones from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "safety_zones": [SafetyZone.from_dict(_item) for _item in obj["safety_zones"]]
+                if obj.get("safety_zones") is not None
+                else None
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/service_group.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: 2.3.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 ServiceGroup(str, Enum):
+    """
+    ServiceGroup
+    """
+
+    """
+    allowed enum values
+    """
+    SYSTEMSERVICE = "SystemService"
+    CELLSERVICE = "CellService"
+    ROBOTCONTROLLER = "RobotController"
+    APP = "App"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ServiceGroup from a JSON string"""
+        return cls(json.loads(json_str))