wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/models/standstill_standstill.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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
+from typing import Any, ClassVar, Dict, List, Union
+from wandelbots_api_client.models.robot_controller_state import RobotControllerState
+from wandelbots_api_client.models.standstill_reason import StandstillReason
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class StandstillStandstill(BaseModel):
+    """
+    StandstillStandstill
+    """  # noqa: E501
+
+    reason: StandstillReason
+    location: Union[StrictFloat, StrictInt]
+    state: RobotControllerState = Field(description="Current state of the controller and motion group which came to a standstill.")
+    __properties: ClassVar[List[str]] = ["reason", "location", "state"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of StandstillStandstill 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 StandstillStandstill from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "reason": obj.get("reason"),
+                "location": obj.get("location"),
+                "state": RobotControllerState.from_dict(obj["state"]) if obj.get("state") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/models/start_movement_request.py

@@ -0,0 +1,135 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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.models.direction import Direction
+from wandelbots_api_client.models.pause_on_io import PauseOnIO
+from wandelbots_api_client.models.set_io import SetIO
+from wandelbots_api_client.models.start_on_io import StartOnIO
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class StartMovementRequest(BaseModel):
+    """
+    Moves the motion group along a trajectory, added via [planTrajectory](#/operations/planTrajectory) or [planMotion](#/operations/planMotion). Trajectories can be executed forwards or backwards(\"in reverse\").  Pause the execution with PauseMovementRequest. Resume execution with StartMovementRequest.  Precondition: To start execution, the motion group must be located at the trajectory's start location specified in InitializeMovementRequest.
+    """  # noqa: E501
+
+    message_type: Optional[StrictStr] = Field(default="StartMovementRequest", description="Type specifier for server, set automatically. ")
+    direction: Optional[Direction] = Direction.DIRECTION_FORWARD
+    set_ios: Optional[List[SetIO]] = Field(
+        default=None,
+        description="Attaches a list of I/O commands to the trajectory. The I/Os are set to the specified values right after the specified location was reached. If the specified location is located before the start location (forward direction: value is smaller, backward direction: value is bigger), the I/O is not set. ",
+    )
+    start_on_io: Optional[StartOnIO] = Field(
+        default=None,
+        description="Defines an I/O that is listened to before the movement. Execution starts if the defined comparator evaluates to `true`. ",
+    )
+    pause_on_io: Optional[PauseOnIO] = Field(
+        default=None,
+        description="Defines an I/O that is listened to during the movement. Execution pauses if the defined comparator evaluates to `true`. ",
+    )
+    __properties: ClassVar[List[str]] = ["message_type", "direction", "set_ios", "start_on_io", "pause_on_io"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of StartMovementRequest 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 set_ios (list)
+        _items = []
+        if self.set_ios:
+            for _item in self.set_ios:
+                # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                #     to not drop empty elements in lists
+                if _item is not None:
+                    _items.append(_item.to_dict())
+                # <<< End modification
+            _dict["set_ios"] = _items
+        # override the default output from pydantic by calling `to_dict()` of start_on_io
+        if self.start_on_io:
+            _dict["start_on_io"] = self.start_on_io.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pause_on_io
+        if self.pause_on_io:
+            _dict["pause_on_io"] = self.pause_on_io.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StartMovementRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "message_type": obj.get("message_type") if obj.get("message_type") is not None else "StartMovementRequest",
+                "direction": obj.get("direction"),
+                "set_ios": [
+                    # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                    #     to allow dicts in lists
+                    SetIO.from_dict(_item) if hasattr(SetIO, "from_dict") else _item
+                    # <<< End modification
+                    for _item in obj["set_ios"]
+                ]
+                if obj.get("set_ios") is not None
+                else None,
+                "start_on_io": StartOnIO.from_dict(obj["start_on_io"]) if obj.get("start_on_io") is not None else None,
+                "pause_on_io": PauseOnIO.from_dict(obj["pause_on_io"]) if obj.get("pause_on_io") is not None else None,
+            }
+        )
+        return _obj

wandelbots_api_client/models/start_on_io.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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
+from wandelbots_api_client.models.comparator import Comparator
+from wandelbots_api_client.models.io_value import IOValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class StartOnIO(BaseModel):
+    """
+    Defines an I/O that the motion should wait for to start the execution.
+    """  # noqa: E501
+
+    io: IOValue
+    comparator: Comparator = Field(
+        description="Comparator for the comparison of two values. Use the measured I/O as the base value (a) and the expected input/output value as the comparator (b): e.g., a > b. "
+    )
+    __properties: ClassVar[List[str]] = ["io", "comparator"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of StartOnIO 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 io
+        if self.io:
+            _dict["io"] = self.io.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of StartOnIO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"io": IOValue.from_dict(obj["io"]) if obj.get("io") is not None else None, "comparator": obj.get("comparator")}
+        )
+        return _obj

wandelbots_api_client/models/status.py

@@ -0,0 +1,119 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from wandelbots_api_client.models.google_protobuf_any import GoogleProtobufAny
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class Status(BaseModel):
+    """
+    The `Status` type defines a logical error model that is suitable for different programming environments including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+    """  # noqa: E501
+
+    code: Optional[StrictInt] = Field(
+        default=None,
+        description="The status code, which should be an enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). ",
+    )
+    message: Optional[StrictStr] = Field(default=None, description="An error message in English. ")
+    details: Optional[List[GoogleProtobufAny]] = Field(
+        default=None,
+        description="A list of messages that carry the error details. There is a common set of message types for APIs to use. > Currently, this is unused. ",
+    )
+    __properties: ClassVar[List[str]] = ["code", "message", "details"]
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Status 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 details (list)
+        _items = []
+        if self.details:
+            for _item in self.details:
+                # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                #     to not drop empty elements in lists
+                if _item is not None:
+                    _items.append(_item.to_dict())
+                # <<< End modification
+            _dict["details"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Status from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "code": obj.get("code"),
+                "message": obj.get("message"),
+                "details": [
+                    # >>> Modified from https://github.com/OpenAPITools/openapi-generator/blob/v7.6.0/modules/openapi-generator/src/main/resources/python/model_generic.mustache
+                    #     to allow dicts in lists
+                    GoogleProtobufAny.from_dict(_item) if hasattr(GoogleProtobufAny, "from_dict") else _item
+                    # <<< End modification
+                    for _item in obj["details"]
+                ]
+                if obj.get("details") is not None
+                else None,
+            }
+        )
+        return _obj

wandelbots_api_client/models/stop_response.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: 1.4.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, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class StopResponse(BaseModel):
+    """
+    The response will be sent once at the end of every motion signalling that the motion group has stopped moving.
+    """  # noqa: E501
+
+    stop_code: StrictStr
+    message: Optional[StrictStr] = Field(default=None, description="Will provide detailed information about the reason for stopping.")
+    location_on_trajectory: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["stop_code", "message", "location_on_trajectory"]
+
+    @field_validator("stop_code")
+    def stop_code_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(
+            [
+                "STOP_CODE_UNKNOWN",
+                "STOP_CODE_USER_REQUEST",
+                "STOP_CODE_PATH_END",
+                "STOP_CODE_JOINT_LIMIT_REACHED",
+                "STOP_CODE_IO",
+                "STOP_CODE_FORCE_LIMIT",
+                "STOP_CODE_ERROR",
+            ]
+        ):
+            raise ValueError(
+                "must be one of enum values ('STOP_CODE_UNKNOWN', 'STOP_CODE_USER_REQUEST', 'STOP_CODE_PATH_END', 'STOP_CODE_JOINT_LIMIT_REACHED', 'STOP_CODE_IO', 'STOP_CODE_FORCE_LIMIT', 'STOP_CODE_ERROR')"
+            )
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=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, exclude_none=True))
+
+    def to_json(self) -> str:
+        """
+        Returns the JSON representation of the model using alias
+
+        Do not use pydantic v2 .model_dump_json(by_alias=True, exclude_unset=True) here!
+        It is unable to resolve nested types generated by openapi-generator.
+        """
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of StopResponse 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 StopResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"stop_code": obj.get("stop_code"), "message": obj.get("message"), "location_on_trajectory": obj.get("location_on_trajectory")}
+        )
+        return _obj