wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2/models/kinematic_model.py

@@ -0,0 +1,118 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.v2.models.dh_parameter import DHParameter
+from wandelbots_api_client.v2.models.pose import Pose
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class KinematicModel(BaseModel):
+    """
+    Kinematics model described by Denavit-Hartenberg parameters.
+    """  # noqa: E501
+
+    dh_parameters: Optional[List[DHParameter]] = None
+    kinematic_chain_offset: Optional[Pose] = Field(
+        default=None,
+        description="Constant coordinate transformation between the motion group base frame and the start of the kinematic chain modeled by Denavit-Hartenberg parameters.",
+    )
+    flange_offset: Optional[Pose] = Field(
+        default=None,
+        description="Constant coordinate transformation between the end of the kinematic chain modelled by Denavit-Hartenberg parameters and the flange frame. This can be used, e.g., to ensure that the flange frame has a certain orientation. ",
+    )
+    inverse_solver: Optional[StrictStr] = Field(default=None, description="Optional name of the inverse kinematics solver.")
+    __properties: ClassVar[List[str]] = ["dh_parameters", "kinematic_chain_offset", "flange_offset", "inverse_solver"]
+
+    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 KinematicModel 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 dh_parameters (list)
+        _items = []
+        if self.dh_parameters:
+            for _item_dh_parameters in self.dh_parameters:
+                if _item_dh_parameters:
+                    _items.append(_item_dh_parameters.to_dict())
+            _dict["dh_parameters"] = _items
+        # override the default output from pydantic by calling `to_dict()` of kinematic_chain_offset
+        if self.kinematic_chain_offset:
+            _dict["kinematic_chain_offset"] = self.kinematic_chain_offset.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of flange_offset
+        if self.flange_offset:
+            _dict["flange_offset"] = self.flange_offset.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of KinematicModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "dh_parameters": [DHParameter.from_dict(_item) for _item in obj["dh_parameters"]]
+                if obj.get("dh_parameters") is not None
+                else None,
+                "kinematic_chain_offset": Pose.from_dict(obj["kinematic_chain_offset"])
+                if obj.get("kinematic_chain_offset") is not None
+                else None,
+                "flange_offset": Pose.from_dict(obj["flange_offset"]) if obj.get("flange_offset") is not None else None,
+                "inverse_solver": obj.get("inverse_solver"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/kuka_controller.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.v2.models.kuka_controller_rsi_server import KukaControllerRsiServer
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class KukaController(BaseModel):
+    """
+    The configuration of a physical KUKA robot controller has to contain an IP address. Additionally an RSI server configuration has to be specified in order to control the robot. Deploying the server is a functionality of this API.
+    """  # noqa: E501
+
+    kind: StrictStr
+    controller_ip: StrictStr
+    controller_port: StrictInt
+    rsi_server: KukaControllerRsiServer
+    slow_cycle_rate: Optional[StrictBool] = Field(default=False, description="If true, uses slower cycle time of 12ms instead of 4ms. ")
+    __properties: ClassVar[List[str]] = ["kind", "controller_ip", "controller_port", "rsi_server", "slow_cycle_rate"]
+
+    @field_validator("kind")
+    def kind_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["KukaController"]):
+            raise ValueError("must be one of enum values ('KukaController')")
+        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 KukaController 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 rsi_server
+        if self.rsi_server:
+            _dict["rsi_server"] = self.rsi_server.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of KukaController from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "kind": obj.get("kind"),
+                "controller_ip": obj.get("controller_ip"),
+                "controller_port": obj.get("controller_port") if obj.get("controller_port") is not None else 54600,
+                "rsi_server": KukaControllerRsiServer.from_dict(obj["rsi_server"]) if obj.get("rsi_server") is not None else None,
+                "slow_cycle_rate": obj.get("slow_cycle_rate") if obj.get("slow_cycle_rate") is not None else False,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/kuka_controller_rsi_server.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: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+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 KukaControllerRsiServer(BaseModel):
+    """
+    The RSI server runs inside of the cell.
+    """  # noqa: E501
+
+    ip: StrictStr
+    port: StrictInt
+    __properties: ClassVar[List[str]] = ["ip", "port"]
+
+    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 KukaControllerRsiServer 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 KukaControllerRsiServer from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "ip": obj.get("ip") if obj.get("ip") is not None else "0.0.0.0",
+                "port": obj.get("port") if obj.get("port") is not None else 30152,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/license.py

@@ -0,0 +1,121 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import date, datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.v2.models.license_status import LicenseStatus
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class License(BaseModel):
+    """
+    License
+    """  # noqa: E501
+
+    product_name: StrictStr = Field(description="Name of the licensed product.")
+    owner_email: StrictStr = Field(description="Mail address of the license owner.")
+    license_key: StrictStr = Field(description="Identification key of the license.")
+    license_expiry_date: Optional[date] = Field(default=None, description="Expiration date of the license.")
+    grace_period_expiry_date: datetime = Field(description="End date of grace period, given if instance is not connected to internet.")
+    consumed_activations: StrictInt = Field(description="Amount of times the license was activated.")
+    allowed_activations: StrictInt = Field(description="Amount of times the license can be activated.")
+    feature_limitations: Optional[Dict[str, StrictInt]] = Field(default=None, description="Feature limitations of the license.")
+    feature_flags: Optional[List[StrictStr]] = Field(default=None, description="Features enabled by a license.")
+    status: LicenseStatus
+    __properties: ClassVar[List[str]] = [
+        "product_name",
+        "owner_email",
+        "license_key",
+        "license_expiry_date",
+        "grace_period_expiry_date",
+        "consumed_activations",
+        "allowed_activations",
+        "feature_limitations",
+        "feature_flags",
+        "status",
+    ]
+
+    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 License 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 status
+        if self.status:
+            _dict["status"] = self.status.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of License from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "product_name": obj.get("product_name"),
+                "owner_email": obj.get("owner_email"),
+                "license_key": obj.get("license_key"),
+                "license_expiry_date": obj.get("license_expiry_date"),
+                "grace_period_expiry_date": obj.get("grace_period_expiry_date"),
+                "consumed_activations": obj.get("consumed_activations"),
+                "allowed_activations": obj.get("allowed_activations"),
+                "feature_limitations": obj.get("feature_limitations"),
+                "feature_flags": obj.get("feature_flags"),
+                "status": LicenseStatus.from_dict(obj["status"]) if obj.get("status") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/license_status.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from wandelbots_api_client.v2.models.license_status_enum import LicenseStatusEnum
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class LicenseStatus(BaseModel):
+    """
+    Status of the license.
+    """  # noqa: E501
+
+    status: LicenseStatusEnum
+    message: StrictStr
+    __properties: ClassVar[List[str]] = ["status", "message"]
+
+    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 LicenseStatus 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 LicenseStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"status": obj.get("status"), "message": obj.get("message")})
+        return _obj

wandelbots_api_client/v2/models/license_status_enum.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+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 LicenseStatusEnum(str, Enum):
+    """
+    LicenseStatusEnum
+    """
+
+    """
+    allowed enum values
+    """
+    OK = "OK"
+    EXPIRED = "EXPIRED"
+    SUSPENDED = "SUSPENDED"
+    GRACE_PERIOD_OVER = "GRACE_PERIOD_OVER"
+    NOT_FOUND = "NOT_FOUND"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of LicenseStatusEnum from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/limit_range.py

@@ -0,0 +1,84 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class LimitRange(BaseModel):
+    """
+    The upper_limit must be greater then the lower_limit.
+    """  # noqa: E501
+
+    lower_limit: Optional[Union[StrictFloat, StrictInt]] = None
+    upper_limit: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["lower_limit", "upper_limit"]
+
+    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 LimitRange 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 LimitRange from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"lower_limit": obj.get("lower_limit"), "upper_limit": obj.get("upper_limit")})
+        return _obj