wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2/models/merge_trajectories_segment.py

@@ -0,0 +1,126 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.v2.models.blending_position import BlendingPosition
+from wandelbots_api_client.v2.models.collision_setup import CollisionSetup
+from wandelbots_api_client.v2.models.joint_trajectory import JointTrajectory
+from wandelbots_api_client.v2.models.limits_override import LimitsOverride
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class MergeTrajectoriesSegment(BaseModel):
+    """
+    MergeTrajectoriesSegment
+    """  # noqa: E501
+
+    trajectory: JointTrajectory = Field(
+        description="The trajectory segment to merge. Both the time and location arrays must start at 0 and be strictly increasing. "
+    )
+    limits_override: Optional[LimitsOverride] = Field(
+        default=None,
+        description="Limits override is used to override the global limits of the motion group for the blending at the end of this segment. ",
+    )
+    blending: Optional[BlendingPosition] = Field(
+        default=None,
+        description="Blending configuration for merging this trajectory segment with the next one. Specifies how the end of this trajectory should be blended with the start of the next trajectory. Ignored for the last segment. ",
+    )
+    collision_setups: Optional[Dict[str, CollisionSetup]] = Field(
+        default=None,
+        description="Collision setups set here override the collsion setups of the Motion Group Configuration. Collisions are checked only on the trajectory section that deviates from the original path due to blending. ",
+    )
+    __properties: ClassVar[List[str]] = ["trajectory", "limits_override", "blending", "collision_setups"]
+
+    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 MergeTrajectoriesSegment 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 trajectory
+        if self.trajectory:
+            _dict["trajectory"] = self.trajectory.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of limits_override
+        if self.limits_override:
+            _dict["limits_override"] = self.limits_override.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of blending
+        if self.blending:
+            _dict["blending"] = self.blending.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in collision_setups (dict)
+        _field_dict = {}
+        if self.collision_setups:
+            for _key_collision_setups in self.collision_setups:
+                if self.collision_setups[_key_collision_setups]:
+                    _field_dict[_key_collision_setups] = self.collision_setups[_key_collision_setups].to_dict()
+            _dict["collision_setups"] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MergeTrajectoriesSegment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "trajectory": JointTrajectory.from_dict(obj["trajectory"]) if obj.get("trajectory") is not None else None,
+                "limits_override": LimitsOverride.from_dict(obj["limits_override"]) if obj.get("limits_override") is not None else None,
+                "blending": BlendingPosition.from_dict(obj["blending"]) if obj.get("blending") is not None else None,
+                "collision_setups": dict((_k, CollisionSetup.from_dict(_v)) for _k, _v in obj["collision_setups"].items())
+                if obj.get("collision_setups") is not None
+                else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/merge_trajectories_validation_error.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 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.error_invalid_joint_count import ErrorInvalidJointCount
+from wandelbots_api_client.v2.models.location1_inner import Location1Inner
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class MergeTrajectoriesValidationError(BaseModel):
+    """
+    MergeTrajectoriesValidationError
+    """  # noqa: E501
+
+    loc: List[Location1Inner]
+    msg: StrictStr
+    type: StrictStr
+    input: Dict[str, Any]
+    data: Optional[ErrorInvalidJointCount] = Field(
+        default=None, description="Optional data further specifying the merge validation error. "
+    )
+    __properties: ClassVar[List[str]] = ["loc", "msg", "type", "input", "data"]
+
+    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 MergeTrajectoriesValidationError 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 loc (list)
+        _items = []
+        if self.loc:
+            for _item_loc in self.loc:
+                if _item_loc:
+                    _items.append(_item_loc.to_dict())
+            _dict["loc"] = _items
+        # override the default output from pydantic by calling `to_dict()` of data
+        if self.data:
+            _dict["data"] = self.data.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MergeTrajectoriesValidationError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "loc": [Location1Inner.from_dict(_item) for _item in obj["loc"]] if obj.get("loc") is not None else None,
+                "msg": obj.get("msg"),
+                "type": obj.get("type"),
+                "input": obj.get("input"),
+                "data": ErrorInvalidJointCount.from_dict(obj["data"]) if obj.get("data") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/midpoint_insertion_algorithm.py

@@ -0,0 +1,102 @@
+# 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, 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 MidpointInsertionAlgorithm(BaseModel):
+    """
+    MidpointInsertionAlgorithm
+    """  # noqa: E501
+
+    algorithm_name: StrictStr = Field(
+        description="Algorithm discriminator.  Midpoint insertion algorithm configuration for collision-free path planning. This algorithm adds a single midpoint between the start and target joint position to find collision-free paths. "
+    )
+    max_iterations: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(
+        default=1000,
+        description="Maximum number of iterations for the midpoint insertion algorithm. Higher values increase likelyhood of success, but also computation time (linear). ",
+    )
+    __properties: ClassVar[List[str]] = ["algorithm_name", "max_iterations"]
+
+    @field_validator("algorithm_name")
+    def algorithm_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["MidpointInsertionAlgorithm"]):
+            raise ValueError("must be one of enum values ('MidpointInsertionAlgorithm')")
+        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 MidpointInsertionAlgorithm 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 MidpointInsertionAlgorithm from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "algorithm_name": obj.get("algorithm_name"),
+                "max_iterations": obj.get("max_iterations") if obj.get("max_iterations") is not None else 1000,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/modbus_io.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 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
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.modbus_io_area import ModbusIOArea
+from wandelbots_api_client.v2.models.modbus_io_byte_order import ModbusIOByteOrder
+from wandelbots_api_client.v2.models.modbus_io_type_enum import ModbusIOTypeEnum
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ModbusIO(BaseModel):
+    """
+    ModbusIO
+    """  # noqa: E501
+
+    description: StrictStr = Field(description="Descriptive name or note for the input/output variable. ")
+    address: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(
+        description="The byte address of the input/output variable in the MODBUS device, e.g., NOVA's MODBUS service. Used to locate the input/output variable within the device's memory or data structure. "
+    )
+    type: ModbusIOTypeEnum
+    byte_order: ModbusIOByteOrder = Field(
+        description="The byte sequence of the input/output variable, indicating the order of bytes in memory for the MODBUS device, e.g., NOVA's MODBUS service. "
+    )
+    area: ModbusIOArea = Field(
+        description="The area of the input/output variable, indicating the memory region it belongs to for the MODBUS device, e.g., NOVA's MODBUS service. "
+    )
+    io: StrictStr = Field(
+        description="The unique identifier for the input/output value. Used to reference the input/output variable in the MODBUS device, e.g., NOVA's MODBUS service. "
+    )
+    __properties: ClassVar[List[str]] = ["description", "address", "type", "byte_order", "area", "io"]
+
+    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 ModbusIO 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 ModbusIO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "description": obj.get("description"),
+                "address": obj.get("address"),
+                "type": obj.get("type"),
+                "byte_order": obj.get("byte_order"),
+                "area": obj.get("area"),
+                "io": obj.get("io"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/modbus_io_area.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 ModbusIOArea(str, Enum):
+    """
+    Area of the MODBUS input/output variable. Is used to interpret the corresponding bits correctly.
+    """
+
+    """
+    allowed enum values
+    """
+    MODBUS_IO_AREA_UNKNOWN = "MODBUS_IO_AREA_UNKNOWN"
+    MODBUS_IO_AREA_COILS = "MODBUS_IO_AREA_COILS"
+    MODBUS_IO_AREA_DISCRETE_INPUTS = "MODBUS_IO_AREA_DISCRETE_INPUTS"
+    MODBUS_IO_AREA_HOLDING_REGISTERS = "MODBUS_IO_AREA_HOLDING_REGISTERS"
+    MODBUS_IO_AREA_INPUT_REGISTERS = "MODBUS_IO_AREA_INPUT_REGISTERS"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ModbusIOArea from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/modbus_io_byte_order.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 ModbusIOByteOrder(str, Enum):
+    """
+    Byte order of the MODBUS input/output variable. Used to interpret the corresponding bits correctly.
+    """
+
+    """
+    allowed enum values
+    """
+    MODBUS_IO_BYTE_ORDER_UNKNOWN = "MODBUS_IO_BYTE_ORDER_UNKNOWN"
+    MODBUS_IO_BYTE_ORDER_ABCD = "MODBUS_IO_BYTE_ORDER_ABCD"
+    MODBUS_IO_BYTE_ORDER_BADC = "MODBUS_IO_BYTE_ORDER_BADC"
+    MODBUS_IO_BYTE_ORDER_CDAB = "MODBUS_IO_BYTE_ORDER_CDAB"
+    MODBUS_IO_BYTE_ORDER_DCBA = "MODBUS_IO_BYTE_ORDER_DCBA"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ModbusIOByteOrder from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/modbus_io_data.py

@@ -0,0 +1,105 @@
+# 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
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.modbus_io_area import ModbusIOArea
+from wandelbots_api_client.v2.models.modbus_io_byte_order import ModbusIOByteOrder
+from wandelbots_api_client.v2.models.modbus_io_type_enum import ModbusIOTypeEnum
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class ModbusIOData(BaseModel):
+    """
+    ModbusIOData
+    """  # noqa: E501
+
+    description: StrictStr = Field(description="Descriptive name or note for the input/output variable. ")
+    address: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(
+        description="The byte address of the input/output variable in the MODBUS device, e.g., NOVA's MODBUS service. Used to locate the input/output variable within the device's memory or data structure. "
+    )
+    type: ModbusIOTypeEnum
+    byte_order: ModbusIOByteOrder = Field(
+        description="The byte sequence of the input/output variable, indicating the order of bytes in memory for the MODBUS device, e.g., NOVA's MODBUS service. "
+    )
+    area: ModbusIOArea = Field(
+        description="The area of the input/output variable, indicating the memory region it belongs to for the MODBUS device, e.g., NOVA's MODBUS service. "
+    )
+    __properties: ClassVar[List[str]] = ["description", "address", "type", "byte_order", "area"]
+
+    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 ModbusIOData 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 ModbusIOData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "description": obj.get("description"),
+                "address": obj.get("address"),
+                "type": obj.get("type"),
+                "byte_order": obj.get("byte_order"),
+                "area": obj.get("area"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/modbus_io_type_enum.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 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 ModbusIOTypeEnum(str, Enum):
+    """
+    Value type of the MODBUS input/output variable. Used to interpret the corresponding bits correctly.
+    """
+
+    """
+    allowed enum values
+    """
+    MODBUS_IO_TYPE_UNKNOWN = "MODBUS_IO_TYPE_UNKNOWN"
+    MODBUS_IO_TYPE_BOOL = "MODBUS_IO_TYPE_BOOL"
+    MODBUS_IO_TYPE_UINT16 = "MODBUS_IO_TYPE_UINT16"
+    MODBUS_IO_TYPE_FLOAT32 = "MODBUS_IO_TYPE_FLOAT32"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ModbusIOTypeEnum from a JSON string"""
+        return cls(json.loads(json_str))