wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2/models/bus_io_modbus_server.py

@@ -0,0 +1,127 @@
+# 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_extensions import Annotated
+from wandelbots_api_client.v2.models.bus_io_modbus_tcp_server import BusIOModbusTCPServer
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BusIOModbusServer(BaseModel):
+    """
+    MODBUS server inputs/outputs service configuration.
+    """  # noqa: E501
+
+    bus_type: StrictStr
+    network: BusIOModbusTCPServer
+    connections: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(
+        description="Number of connections this MODBUS server can handle. "
+    )
+    coils_size: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="Size of the Coils memory area. ")
+    discrete_inputs_size: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(
+        description="Size of the Discrete Inputs memory area. "
+    )
+    holding_registers_size: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(
+        description="Size of the Holding Registers memory area. "
+    )
+    input_registers_size: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(
+        description="Size of the Input Registers memory area. "
+    )
+    __properties: ClassVar[List[str]] = [
+        "bus_type",
+        "network",
+        "connections",
+        "coils_size",
+        "discrete_inputs_size",
+        "holding_registers_size",
+        "input_registers_size",
+    ]
+
+    @field_validator("bus_type")
+    def bus_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["modbus_server"]):
+            raise ValueError("must be one of enum values ('modbus_server')")
+        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 BusIOModbusServer from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of network
+        if self.network:
+            _dict["network"] = self.network.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BusIOModbusServer from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "bus_type": obj.get("bus_type"),
+                "network": BusIOModbusTCPServer.from_dict(obj["network"]) if obj.get("network") is not None else None,
+                "connections": obj.get("connections"),
+                "coils_size": obj.get("coils_size"),
+                "discrete_inputs_size": obj.get("discrete_inputs_size"),
+                "holding_registers_size": obj.get("holding_registers_size"),
+                "input_registers_size": obj.get("input_registers_size"),
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/bus_io_modbus_tcp_client.py

@@ -0,0 +1,98 @@
+# 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 BusIOModbusTCPClient(BaseModel):
+    """
+    BusIOModbusTCPClient
+    """  # noqa: E501
+
+    network_type: Optional[StrictStr] = None
+    ip: StrictStr = Field(description="IP address of the MODBUS server to establish communication with. ")
+    port: Annotated[int, Field(le=65534, strict=True, ge=1)] = Field(
+        description="Port number of the MODBUS server to establish communication with. "
+    )
+    __properties: ClassVar[List[str]] = ["network_type", "ip", "port"]
+
+    @field_validator("network_type")
+    def network_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["tcp"]):
+            raise ValueError("must be one of enum values ('tcp')")
+        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 BusIOModbusTCPClient 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 BusIOModbusTCPClient from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"network_type": obj.get("network_type"), "ip": obj.get("ip"), "port": obj.get("port")})
+        return _obj

wandelbots_api_client/v2/models/bus_io_modbus_tcp_server.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, 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 BusIOModbusTCPServer(BaseModel):
+    """
+    BusIOModbusTCPServer
+    """  # noqa: E501
+
+    network_type: Optional[StrictStr] = None
+    port: Annotated[int, Field(le=65534, strict=True, ge=1)] = Field(
+        description="Port number of the MODBUS server to establish communication with. "
+    )
+    __properties: ClassVar[List[str]] = ["network_type", "port"]
+
+    @field_validator("network_type")
+    def network_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(["tcp"]):
+            raise ValueError("must be one of enum values ('tcp')")
+        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 BusIOModbusTCPServer 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 BusIOModbusTCPServer from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"network_type": obj.get("network_type"), "port": obj.get("port")})
+        return _obj

wandelbots_api_client/v2/models/bus_io_modbus_virtual.py

@@ -0,0 +1,90 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BusIOModbusVirtual(BaseModel):
+    """
+    Virtual MODBUS inputs/outputs service configuration.
+    """  # noqa: E501
+
+    bus_type: StrictStr
+    __properties: ClassVar[List[str]] = ["bus_type"]
+
+    @field_validator("bus_type")
+    def bus_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["modbus_virtual"]):
+            raise ValueError("must be one of enum values ('modbus_virtual')")
+        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 BusIOModbusVirtual 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 BusIOModbusVirtual from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"bus_type": obj.get("bus_type")})
+        return _obj

wandelbots_api_client/v2/models/bus_io_profinet.py

@@ -0,0 +1,131 @@
+# 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 wandelbots_api_client.v2.models.bus_io_profinet_default_route import BusIOProfinetDefaultRoute
+from wandelbots_api_client.v2.models.bus_io_profinet_network import BusIOProfinetNetwork
+from wandelbots_api_client.v2.models.bus_io_profinet_slot import BusIOProfinetSlot
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+
+class BusIOProfinet(BaseModel):
+    """
+    PROFINET BUS inputs/outputs service configuration.
+    """  # noqa: E501
+
+    bus_type: StrictStr
+    network_config: Optional[BusIOProfinetNetwork] = Field(
+        default=None,
+        description="Used to enable IP communication through the same physical ethernet interface while PROFINET driver is active. ",
+    )
+    plc_ip: StrictStr = Field(
+        description="IP address of the PLC to establish PROFINET communication with.  The IP address is used to configure the host machine's firewall. The firewall configuration is applied while the BUS input/output service is active. Without proper firewall configuration, PROFINET device discovery, configuration exchanges, and real-time cyclic data communication will fail. "
+    )
+    mac: StrictStr = Field(description="MAC address of the physical ethernet interface that you want to use for PROFINET communication. ")
+    slots: Optional[Annotated[List[BusIOProfinetSlot], Field(min_length=1)]] = Field(
+        default=None,
+        description="Optional PROFINET slot configuration.  If not provided, the default configuration is used for backward compatibility: one slot with a size of 64 bytes. ",
+    )
+    default_route: Optional[BusIOProfinetDefaultRoute] = None
+    __properties: ClassVar[List[str]] = ["bus_type", "network_config", "plc_ip", "mac", "slots", "default_route"]
+
+    @field_validator("bus_type")
+    def bus_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["profinet"]):
+            raise ValueError("must be one of enum values ('profinet')")
+        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 BusIOProfinet from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of network_config
+        if self.network_config:
+            _dict["network_config"] = self.network_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in slots (list)
+        _items = []
+        if self.slots:
+            for _item_slots in self.slots:
+                if _item_slots:
+                    _items.append(_item_slots.to_dict())
+            _dict["slots"] = _items
+        # override the default output from pydantic by calling `to_dict()` of default_route
+        if self.default_route:
+            _dict["default_route"] = self.default_route.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BusIOProfinet from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "bus_type": obj.get("bus_type"),
+                "network_config": BusIOProfinetNetwork.from_dict(obj["network_config"]) if obj.get("network_config") is not None else None,
+                "plc_ip": obj.get("plc_ip"),
+                "mac": obj.get("mac"),
+                "slots": [BusIOProfinetSlot.from_dict(_item) for _item in obj["slots"]] if obj.get("slots") is not None else None,
+                "default_route": BusIOProfinetDefaultRoute.from_dict(obj["default_route"])
+                if obj.get("default_route") is not None
+                else None,
+            }
+        )
+        return _obj

wandelbots_api_client/v2/models/bus_io_profinet_default_route.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, Field, 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 BusIOProfinetDefaultRoute(BaseModel):
+    """
+    Current default route configuration of your NOVA instance. The default route is a setting that tells data where to go if there isn’t a specific path already known for its destination. Usually this will be the path to your router, enabling accessing the internet. On Linux, use `ip route show` to view your default routes and match the output `default via <gateway> dev <interface> ...` to get your gateway and interface.
+    """  # noqa: E501
+
+    gateway: StrictStr = Field(description="Gateway for the default route.")
+    interface: StrictStr = Field(description="Interface for the default route.")
+    __properties: ClassVar[List[str]] = ["gateway", "interface"]
+
+    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 BusIOProfinetDefaultRoute 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 BusIOProfinetDefaultRoute from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"gateway": obj.get("gateway"), "interface": obj.get("interface")})
+        return _obj