wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2/models/io_description.py

@@ -0,0 +1,116 @@
+# 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.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 IODescription(BaseModel):
+    """
+    IODescription
+    """  # noqa: E501
+
+    io: StrictStr = Field(description="Unique identifier of the input/output. ")
+    name: StrictStr = Field(
+        description="Name of the input/output. Customize it on the physical controller or in the virtual robot specification. "
+    )
+    group: Optional[StrictStr] = Field(
+        default=None,
+        description="Name of the input/output group. Customize it on the physical controller or in the virtual robot specification. ",
+    )
+    direction: IODirection
+    value_type: IOValueType
+    unit: Optional[UnitType] = None
+    min: Optional[IOBoundary] = None
+    max: Optional[IOBoundary] = None
+    __properties: ClassVar[List[str]] = ["io", "name", "group", "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 IODescription 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 IODescription 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"),
+                "group": obj.get("group"),
+                "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/io_direction.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 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 IODirection(str, Enum):
+    """
+    Identifies the input/output type.
+    """
+
+    """
+    allowed enum values
+    """
+    IO_TYPE_INPUT = "IO_TYPE_INPUT"
+    IO_TYPE_OUTPUT = "IO_TYPE_OUTPUT"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of IODirection from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/io_float_value.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 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, 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 IOFloatValue(BaseModel):
+    """
+    IOFloatValue
+    """  # noqa: E501
+
+    io: StrictStr = Field(description="Unique identifier of the input/output.")
+    value: Union[StrictFloat, StrictInt] = Field(description="Value of an analog input/output in floating number representation. ")
+    value_type: StrictStr
+    __properties: ClassVar[List[str]] = ["io", "value", "value_type"]
+
+    @field_validator("value_type")
+    def value_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["float"]):
+            raise ValueError("must be one of enum values ('float')")
+        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 IOFloatValue 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 IOFloatValue 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"), "value": obj.get("value"), "value_type": obj.get("value_type")})
+        return _obj

wandelbots_api_client/v2/models/io_integer_value.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 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
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class IOIntegerValue(BaseModel):
+    """
+    IOIntegerValue
+    """  # noqa: E501
+
+    io: StrictStr = Field(description="Unique identifier of the input/output.")
+    value: StrictStr = Field(
+        description="Value of an input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > Recommended: Use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value. "
+    )
+    value_type: StrictStr
+    __properties: ClassVar[List[str]] = ["io", "value", "value_type"]
+
+    @field_validator("value_type")
+    def value_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["integer"]):
+            raise ValueError("must be one of enum values ('integer')")
+        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 IOIntegerValue 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 IOIntegerValue 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"), "value": obj.get("value"), "value_type": obj.get("value_type")})
+        return _obj

wandelbots_api_client/v2/models/io_origin.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 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 IOOrigin(str, Enum):
+    """
+    States the source of the input/output signal.
+    """
+
+    """
+    allowed enum values
+    """
+    CONTROLLER = "CONTROLLER"
+    BUS_IO = "BUS_IO"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of IOOrigin from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/io_value.py

@@ -0,0 +1,183 @@
+# 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
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from wandelbots_api_client.v2.models.io_boolean_value import IOBooleanValue
+from wandelbots_api_client.v2.models.io_float_value import IOFloatValue
+from wandelbots_api_client.v2.models.io_integer_value import IOIntegerValue
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+IOVALUE_ONE_OF_SCHEMAS = ["IOBooleanValue", "IOFloatValue", "IOIntegerValue"]
+
+
+class IOValue(BaseModel):
+    """
+    IOValue
+    """
+
+    # data type: IOBooleanValue
+    oneof_schema_1_validator: Optional[IOBooleanValue] = None
+    # data type: IOIntegerValue
+    oneof_schema_2_validator: Optional[IOIntegerValue] = None
+    # data type: IOFloatValue
+    oneof_schema_3_validator: Optional[IOFloatValue] = None
+    actual_instance: Optional[Union[IOBooleanValue, IOFloatValue, IOIntegerValue]] = None
+    one_of_schemas: Set[str] = {"IOBooleanValue", "IOFloatValue", "IOIntegerValue"}
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    discriminator_value_class_map: Dict[str, str] = {}
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = IOValue.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: IOBooleanValue
+        if not isinstance(v, IOBooleanValue):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `IOBooleanValue`")
+        else:
+            match += 1
+        # validate data type: IOIntegerValue
+        if not isinstance(v, IOIntegerValue):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `IOIntegerValue`")
+        else:
+            match += 1
+        # validate data type: IOFloatValue
+        if not isinstance(v, IOFloatValue):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `IOFloatValue`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when setting `actual_instance` in IOValue with oneOf schemas: IOBooleanValue, IOFloatValue, IOIntegerValue. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when setting `actual_instance` in IOValue with oneOf schemas: IOBooleanValue, IOFloatValue, IOIntegerValue. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # use oneOf discriminator to lookup the data type
+        _data_type = json.loads(json_str).get("value_type")
+        if not _data_type:
+            raise ValueError("Failed to lookup data type from the field `value_type` in the input.")
+
+        # check if data type is `IOBooleanValue`
+        if _data_type == "boolean":
+            instance.actual_instance = IOBooleanValue.from_json(json_str)
+            return instance
+
+        # check if data type is `IOFloatValue`
+        if _data_type == "float":
+            instance.actual_instance = IOFloatValue.from_json(json_str)
+            return instance
+
+        # check if data type is `IOIntegerValue`
+        if _data_type == "integer":
+            instance.actual_instance = IOIntegerValue.from_json(json_str)
+            return instance
+
+        # deserialize data into IOBooleanValue
+        try:
+            instance.actual_instance = IOBooleanValue.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into IOIntegerValue
+        try:
+            instance.actual_instance = IOIntegerValue.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into IOFloatValue
+        try:
+            instance.actual_instance = IOFloatValue.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError(
+                "Multiple matches found when deserializing the JSON string into IOValue with oneOf schemas: IOBooleanValue, IOFloatValue, IOIntegerValue. Details: "
+                + ", ".join(error_messages)
+            )
+        elif match == 0:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into IOValue with oneOf schemas: IOBooleanValue, IOFloatValue, IOIntegerValue. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], IOBooleanValue, IOFloatValue, IOIntegerValue]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())

wandelbots_api_client/v2/models/io_value_type.py

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 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 IOValueType(str, Enum):
+    """
+    Data type of the input/output.
+    """
+
+    """
+    allowed enum values
+    """
+    IO_VALUE_BOOLEAN = "IO_VALUE_BOOLEAN"
+    IO_VALUE_ANALOG_FLOAT = "IO_VALUE_ANALOG_FLOAT"
+    IO_VALUE_ANALOG_INTEGER = "IO_VALUE_ANALOG_INTEGER"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of IOValueType from a JSON string"""
+        return cls(json.loads(json_str))

wandelbots_api_client/v2/models/jogging_details.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 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, field_validator
+from typing import Any, ClassVar, Dict, List
+from wandelbots_api_client.v2.models.jogging_details_state import JoggingDetailsState
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class JoggingDetails(BaseModel):
+    """
+    State of jogging execution. This state is sent during jogging movement, response-rate closest to the nearest multiple of controller step-rate but not exceeding the configured rate. The jogging state can be one of the following: - RUNNING: Jogging is active. - PAUSED_BY_USER: User has paused jogging. - PAUSED_NEAR_JOINT_LIMIT: Jogging was paused because a joint is near its limit. - PAUSED_NEAR_COLLISION: Jogging was paused because the motion group neared a collision. - PAUSED_NEAR_SINGULARITY: Jogging was paused because the motion group neared a singularity or the workspace boundary. - PAUSED_ON_IO: Jogging was paused because of an I/O event.
+    """  # noqa: E501
+
+    state: JoggingDetailsState
+    kind: StrictStr
+    __properties: ClassVar[List[str]] = ["state", "kind"]
+
+    @field_validator("kind")
+    def kind_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["JOGGING"]):
+            raise ValueError("must be one of enum values ('JOGGING')")
+        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 JoggingDetails 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 state
+        if self.state:
+            _dict["state"] = self.state.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of JoggingDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"state": JoggingDetailsState.from_dict(obj["state"]) if obj.get("state") is not None else None, "kind": obj.get("kind")}
+        )
+        return _obj