wandelbots_api_client 26.3.0__py3-none-any.whl

wandelbots_api_client/v2/models/blending_auto.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BlendingAuto(BaseModel):
+    """
+    BlendingAuto
+    """  # noqa: E501
+
+    min_velocity_in_percent: Optional[Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(
+        default=None,
+        description="Auto-blending is used to keep a constant velocity when blending between two motion commands. To use auto-blending, the TCP velocity limit must be set. It changes the TCP path around the target point of the motion command. The value represents the percentage of the original velocity. Auto-blending is always performed in cartesian space. ",
+    )
+    blending_name: StrictStr
+    __properties: ClassVar[List[str]] = ["min_velocity_in_percent", "blending_name"]
+
+    @field_validator("blending_name")
+    def blending_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["BlendingAuto"]):
+            raise ValueError("must be one of enum values ('BlendingAuto')")
+        return value
+
+    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 BlendingAuto 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 BlendingAuto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"min_velocity_in_percent": obj.get("min_velocity_in_percent"), "blending_name": obj.get("blending_name")}
+        )
+        return _obj

wandelbots_api_client/v2/models/blending_position.py

@@ -0,0 +1,143 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.blending_space import BlendingSpace
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BlendingPosition(BaseModel):
+    """
+    BlendingPosition
+    """  # noqa: E501
+
+    position_zone_radius: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None,
+        description="Specifies the maximum radius in [mm] around the motion command's target point where the TCP path can be altered to blend the motion command into the following one. If auto-blending blends too much of the resulting trajectory, use position-blending to restrict the blending zone radius. ",
+    )
+    position_zone_percentage: Optional[
+        Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]
+    ] = Field(
+        default=None,
+        description="Specifies the maximum blending percentage based on the trajectory length in position space around the motion command's target point. Percentage indicated in 0.0 - 100.0. ",
+    )
+    orientation_zone_radius: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None,
+        description="Specifies the maximum radius in [rad] for orientation blending around the motion command's target orientation. At the target's orientation, the TCP orientation can be altered to blend into the following motion. ",
+    )
+    orientation_zone_percentage: Optional[
+        Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]
+    ] = Field(
+        default=None,
+        description="Specifies the maximum blending percentage for orientation blending based on the trajectory length in orientation space. Percentage indicated in 0.0 - 100.0. ",
+    )
+    joints_zone_radius: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None,
+        description="Specifies the maximum radius in [rad] for joint space blending around the motion command's target joint configuration. At the target joint configuration, the joint path can be altered to blend into the following motion. ",
+    )
+    joints_zone_percentage: Optional[
+        Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]
+    ] = Field(
+        default=None,
+        description="Specifies the maximum blending percentage for joint space blending based on the trajectory length in joint space. Percentage indicated in 0.0 to 100.0. ",
+    )
+    space: Optional[BlendingSpace] = Field(default=None, description="Defines the space in which blending is performed. ")
+    blending_name: StrictStr
+    __properties: ClassVar[List[str]] = [
+        "position_zone_radius",
+        "position_zone_percentage",
+        "orientation_zone_radius",
+        "orientation_zone_percentage",
+        "joints_zone_radius",
+        "joints_zone_percentage",
+        "space",
+        "blending_name",
+    ]
+
+    @field_validator("blending_name")
+    def blending_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["BlendingPosition"]):
+            raise ValueError("must be one of enum values ('BlendingPosition')")
+        return value
+
+    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 BlendingPosition 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 BlendingPosition from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "position_zone_radius": obj.get("position_zone_radius"),
+                "position_zone_percentage": obj.get("position_zone_percentage"),
+                "orientation_zone_radius": obj.get("orientation_zone_radius"),
+                "orientation_zone_percentage": obj.get("orientation_zone_percentage"),
+                "joints_zone_radius": obj.get("joints_zone_radius"),
+                "joints_zone_percentage": obj.get("joints_zone_percentage"),
+                "space": obj.get("space"),
+                "blending_name": obj.get("blending_name"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/blending_space.py

@@ -0,0 +1,34 @@
+# 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 BlendingSpace(str, Enum):
+    """
+    Defines the space in which blending is performed. - `JOINT`: Zone blending is performed in joint space - `CARTESIAN`: Auto-blending is performed in cartesian space
+    """
+
+    """
+    allowed enum values
+    """
+    JOINT = "JOINT"
+    CARTESIAN = "CARTESIAN"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BlendingSpace from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/boolean_value.py

@@ -0,0 +1,91 @@
+# 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, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BooleanValue(BaseModel):
+    """
+    Value of a digital input/output.
+    """  # noqa: E501
+
+    value: StrictBool
+    value_type: StrictStr
+    __properties: ClassVar[List[str]] = ["value", "value_type"]
+
+    @field_validator("value_type")
+    def value_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["boolean"]):
+            raise ValueError("must be one of enum values ('boolean')")
+        return value
+
+    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 BooleanValue 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 BooleanValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"value": obj.get("value"), "value_type": obj.get("value_type")})
+        return _obj

wandelbots_api_client/v2/models/box.py

@@ -0,0 +1,109 @@
+# 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, StrictStr, field_validator
+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 Box(BaseModel):
+    """
+    Defines a cuboid shape centred around an origin.  If a margin is applied to the box type full, it is added to all size values. The shape will keep its edges. The hollow box type consists of thin boxes that make up its walls. If a margin is applied to the box type hollow, its size values are reduced by the margin.
+    """  # noqa: E501
+
+    shape_type: StrictStr
+    size_x: Union[StrictFloat, StrictInt] = Field(description="The dimension in x-direction in [mm].")
+    size_y: Union[StrictFloat, StrictInt] = Field(description="The dimension in y-direction in [mm].")
+    size_z: Union[StrictFloat, StrictInt] = Field(description="The dimension in z-direction in [mm].")
+    box_type: StrictStr = Field(description="The box type defines if the box is hollow or full.")
+    __properties: ClassVar[List[str]] = ["shape_type", "size_x", "size_y", "size_z", "box_type"]
+
+    @field_validator("shape_type")
+    def shape_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["box"]):
+            raise ValueError("must be one of enum values ('box')")
+        return value
+
+    @field_validator("box_type")
+    def box_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["HOLLOW", "FULL"]):
+            raise ValueError("must be one of enum values ('HOLLOW', 'FULL')")
+        return value
+
+    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 Box 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 Box 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"),
+                "size_x": obj.get("size_x"),
+                "size_y": obj.get("size_y"),
+                "size_z": obj.get("size_z"),
+                "box_type": obj.get("box_type") if obj.get("box_type") is not None else "FULL",
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/bus_io_description.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.v2.models.io_boundary import IOBoundary
+from wandelbots_api_client.v2.models.io_direction import IODirection
+from wandelbots_api_client.v2.models.io_value_type import IOValueType
+from wandelbots_api_client.v2.models.unit_type import UnitType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BusIODescription(BaseModel):
+    """
+    BusIODescription
+    """  # noqa: E501
+
+    io: StrictStr = Field(description="Unique identifier of the input/output. ")
+    name: StrictStr = Field(
+        description="Name of the input/output. Customize it using the respective BUS service, e.g., [addProfinetIO](#/operations/addProfinetIO) for PROFINET service. "
+    )
+    direction: IODirection
+    value_type: IOValueType
+    unit: Optional[UnitType] = None
+    min: Optional[IOBoundary] = None
+    max: Optional[IOBoundary] = None
+    __properties: ClassVar[List[str]] = ["io", "name", "direction", "value_type", "unit", "min", "max"]
+
+    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 BusIODescription 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 min
+        if self.min:
+            _dict["min"] = self.min.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of max
+        if self.max:
+            _dict["max"] = self.max.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BusIODescription from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "io": obj.get("io"),
+                "name": obj.get("name"),
+                "direction": obj.get("direction"),
+                "value_type": obj.get("value_type"),
+                "unit": obj.get("unit"),
+                "min": IOBoundary.from_dict(obj["min"]) if obj.get("min") is not None else None,
+                "max": IOBoundary.from_dict(obj["max"]) if obj.get("max") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/bus_io_modbus_client.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.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from wandelbots_api_client.v2.models.bus_io_modbus_tcp_client import BusIOModbusTCPClient
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BusIOModbusClient(BaseModel):
+    """
+    MODBUS client inputs/outputs service configuration.
+    """  # noqa: E501
+
+    bus_type: StrictStr
+    network: BusIOModbusTCPClient
+    __properties: ClassVar[List[str]] = ["bus_type", "network"]
+
+    @field_validator("bus_type")
+    def bus_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["modbus_client"]):
+            raise ValueError("must be one of enum values ('modbus_client')")
+        return value
+
+    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 BusIOModbusClient 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 network
+        if self.network:
+            _dict["network"] = self.network.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BusIOModbusClient from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "bus_type": obj.get("bus_type"),
+                "network": BusIOModbusTCPClient.from_dict(obj["network"]) if obj.get("network") is not None else None,
+            }
+        )
+        return _obj