wandelbots-api-client 25.6.0.dev7__py3-none-any.whl → 25.10.0rc2__py3-none-any.whl

wandelbots_api_client/v2/models/profinet_io.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    Wandelbots NOVA API
+
+    Interact with robots in an easy and intuitive way. 
+
+    The version of the OpenAPI document: 2.1.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 typing_extensions import Annotated
+from wandelbots_api_client.v2.models.profinet_io_direction import ProfinetIODirection
+from wandelbots_api_client.v2.models.profinet_io_type_enum import ProfinetIOTypeEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ProfinetIO(BaseModel):
+    """
+    ProfinetIO
+    """ # noqa: E501
+    description: StrictStr = Field(description="Descriptive name or note for the input/output variable. ") 
+    type: ProfinetIOTypeEnum 
+    direction: ProfinetIODirection = Field(description="The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA's PROFINET service. ") 
+    byte_address: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The byte address of the input/output variable in the PROFINET device, e.g., NOVA's PROFINET service. The byte address is used to locate the specific input/output variable within the device's memory or data structure. ") 
+    bit_address: Optional[Annotated[int, Field(le=7, strict=True, ge=0)]] = Field(default=None, description="The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable. ") 
+    io: StrictStr = Field(description="The unique identifier for the input/output value. This identifier is used to reference the specific input/output variable in the PROFINET device, e.g., NOVA's PROFINET service. ") 
+    __properties: ClassVar[List[str]] = ["description", "type", "direction", "byte_address", "bit_address", "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 ProfinetIO 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 ProfinetIO 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"),
+            "type": obj.get("type"),
+            "direction": obj.get("direction"),
+            "byte_address": obj.get("byte_address"),
+            "bit_address": obj.get("bit_address"),
+            "io": obj.get("io")
+        })
+        return _obj
+
+

wandelbots_api_client/v2/models/{program_request.py → profinet_io_data.py}

@@ -3,9 +3,9 @@
 """
     Wandelbots NOVA API
 
-    Interact with robots in an easy and intuitive way.  > **Note:** API version 2 is experimental and will experience functional changes. 
+    Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 2.0.0 beta
+    The version of the OpenAPI document: 2.1.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -19,18 +19,22 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.profinet_io_direction import ProfinetIODirection
+from wandelbots_api_client.v2.models.profinet_io_type_enum import ProfinetIOTypeEnum
 from typing import Optional, Set
 from typing_extensions import Self
 
-class ProgramRequest(BaseModel):
+class ProfinetIOData(BaseModel):
     """
-    ProgramRequest
+    ProfinetIOData
     """ # noqa: E501
-    program: StrictStr
-    default_robot: Optional[StrictStr] = Field(default=None, description="Identifier of the default robot to use for execution")
-    default_tcp: Optional[StrictStr] = Field(default=None, description="Identifier of the default TCP to use for execution")
-    run_args: Optional[Dict[str, Any]] = Field(default=None, description="Initial arguments that are available within the program")
-    __properties: ClassVar[List[str]] = ["program", "default_robot", "default_tcp", "run_args"]
+    description: StrictStr = Field(description="Descriptive name or note for the input/output variable. ") 
+    type: ProfinetIOTypeEnum 
+    direction: ProfinetIODirection = Field(description="The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA's PROFINET service. ") 
+    byte_address: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The byte address of the input/output variable in the PROFINET device, e.g., NOVA's PROFINET service. The byte address is used to locate the specific input/output variable within the device's memory or data structure. ") 
+    bit_address: Optional[Annotated[int, Field(le=7, strict=True, ge=0)]] = Field(default=None, description="The bit address of the input/output variable within the byte or word address. The bit address is used to specify the exact bit within the byte or word that corresponds to the input/output variable. ") 
+    __properties: ClassVar[List[str]] = ["description", "type", "direction", "byte_address", "bit_address"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -54,7 +58,7 @@ class ProgramRequest(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of ProgramRequest from a JSON string"""
+        """Create an instance of ProfinetIOData from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -79,7 +83,7 @@ class ProgramRequest(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ProgramRequest from a dict"""
+        """Create an instance of ProfinetIOData from a dict"""
         if obj is None:
             return None
 
@@ -87,34 +91,11 @@ class ProgramRequest(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "program": obj.get("program") if obj.get("program") is not None else '''# Read the current pose of the robot.
-#
-# Note: Please replace <controller_id> with the controller name you've
-#   selected and <motion_group_id> with the motion group ID
-#
-# Example:
-#   - "0@abb" = get_controller("abb")[0]
-#   - "1@fanuc" = get_controller("fanuc")[1]
-#
-robot = get_controller("controller")[0]
-tcp("Flange")
-home = read(robot, "pose")
-sync
-
-# Set the velocity of the robot to 200 mm/s
-velocity(200)
-
-for i = 0..3:
-    move via ptp() to home
-    # Move to a pose concatenating the home pose
-    move via line() to (50, 20, 30, 0, 0, 0) :: home
-    move via line() to (100, 20, 30, 0, 0, 0) :: home
-    move via line() to (50, 20, 30, 0, 0, 0) :: home
-    move via ptp() to home
-''',
-            "default_robot": obj.get("default_robot"),
-            "default_tcp": obj.get("default_tcp"),
-            "run_args": obj.get("run_args")
+            "description": obj.get("description"),
+            "type": obj.get("type"),
+            "direction": obj.get("direction"),
+            "byte_address": obj.get("byte_address"),
+            "bit_address": obj.get("bit_address")
         })
         return _obj
 

wandelbots_api_client/v2/models/profinet_io_direction.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    Wandelbots NOVA API
+
+    Interact with robots in an easy and intuitive way. 
+
+    The version of the OpenAPI document: 2.1.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 ProfinetIODirection(str, Enum):
+    """
+    The direction of the input/output variable, indicating whether it is an input or output for the PROFINET device, e.g., NOVA's PROFINET service.
+    """
+
+    """
+    allowed enum values
+    """
+    PROFINET_IO_DIRECTION_INPUT = 'PROFINET_IO_DIRECTION_INPUT'
+    PROFINET_IO_DIRECTION_OUTPUT = 'PROFINET_IO_DIRECTION_OUTPUT'
+    PROFINET_IO_DIRECTION_INOUT = 'PROFINET_IO_DIRECTION_INOUT'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ProfinetIODirection from a JSON string"""
+        return cls(json.loads(json_str))
+
+

wandelbots_api_client/v2/models/profinet_io_type_enum.py

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+"""
+    Wandelbots NOVA API
+
+    Interact with robots in an easy and intuitive way. 
+
+    The version of the OpenAPI document: 2.1.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 ProfinetIOTypeEnum(str, Enum):
+    """
+    Value type of the PROFINET input/output variable. Is used to interpret the corresponding bits correctly. 
+    """
+
+    """
+    allowed enum values
+    """
+    PROFINET_IO_TYPE_UNKNOWN = 'PROFINET_IO_TYPE_UNKNOWN'
+    PROFINET_IO_TYPE_BOOL = 'PROFINET_IO_TYPE_BOOL'
+    PROFINET_IO_TYPE_USINT = 'PROFINET_IO_TYPE_USINT'
+    PROFINET_IO_TYPE_SINT = 'PROFINET_IO_TYPE_SINT'
+    PROFINET_IO_TYPE_UINT = 'PROFINET_IO_TYPE_UINT'
+    PROFINET_IO_TYPE_INT = 'PROFINET_IO_TYPE_INT'
+    PROFINET_IO_TYPE_UDINT = 'PROFINET_IO_TYPE_UDINT'
+    PROFINET_IO_TYPE_DINT = 'PROFINET_IO_TYPE_DINT'
+    PROFINET_IO_TYPE_REAL = 'PROFINET_IO_TYPE_REAL'
+    PROFINET_IO_TYPE_LREAL = 'PROFINET_IO_TYPE_LREAL'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ProfinetIOTypeEnum from a JSON string"""
+        return cls(json.loads(json_str))
+
+

wandelbots_api_client/v2/models/{list_io_descriptions_response.py → profinet_slot_description.py}

@@ -3,9 +3,9 @@
 """
     Wandelbots NOVA API
 
-    Interact with robots in an easy and intuitive way.  > **Note:** API version 2 is experimental and will experience functional changes. 
+    Interact with robots in an easy and intuitive way. 
 
-    The version of the OpenAPI document: 2.0.0 beta
+    The version of the OpenAPI document: 2.1.0 dev
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -17,18 +17,21 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
-from wandelbots_api_client.v2.models.io_description import IODescription
+from typing_extensions import Annotated
+from wandelbots_api_client.v2.models.profinet_sub_slot_description import ProfinetSubSlotDescription
 from typing import Optional, Set
 from typing_extensions import Self
 
-class ListIODescriptionsResponse(BaseModel):
+class ProfinetSlotDescription(BaseModel):
     """
-    Array of input/output description values.
+    An array of PROFINET slots.  PROFINET models each device’s input/output hardware as a hierarchy of slots (modules) and subslots (submodules). A slot can represent a physical or virtual input/output card and each subslot one of its individual channels or functions. Every slot and subslot has unique identifiers that the controller uses to map cyclic input/output data and parameter records to its process image. This slot/subslot separation enables e.g., addressing each input/output stream when establishing input/output application relations (I/O-AR). 
     """ # noqa: E501
-    io_descriptions: List[IODescription]
-    __properties: ClassVar[List[str]] = ["io_descriptions"]
+    number: Annotated[int, Field(le=2147483647, strict=True, ge=0)] = Field(description="The number/index of the PROFINET slot. Per default, slot 0 is reserved for the device access point (DAP). Slots that are part of the cyclic input/output data exchange start at number 1. ") 
+    api: Annotated[int, Field(le=2147483647, strict=True, ge=0)] = Field(description="The application process identifier (API) number of the PROFINET input. The API identifies the application relation (AR) that is using the slot. ") 
+    subslots: List[ProfinetSubSlotDescription] = Field(description="An array of PROFINET subslots. ") 
+    __properties: ClassVar[List[str]] = ["number", "api", "subslots"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -52,7 +55,7 @@ class ListIODescriptionsResponse(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of ListIODescriptionsResponse from a JSON string"""
+        """Create an instance of ProfinetSlotDescription from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -73,21 +76,21 @@ class ListIODescriptionsResponse(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of each item in io_descriptions (list)
+        # override the default output from pydantic by calling `to_dict()` of each item in subslots (list)
         _items = []
-        if self.io_descriptions:
-            for _item in self.io_descriptions:
+        if self.subslots:
+            for _item in self.subslots:
                 # >>> 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['io_descriptions'] = _items
+            _dict['subslots'] = _items
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ListIODescriptionsResponse from a dict"""
+        """Create an instance of ProfinetSlotDescription from a dict"""
         if obj is None:
             return None
 
@@ -95,13 +98,15 @@ class ListIODescriptionsResponse(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "io_descriptions": [
+            "number": obj.get("number"),
+            "api": obj.get("api"),
+            "subslots": [
                 # >>> 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
-                IODescription.from_dict(_item) if hasattr(IODescription, 'from_dict') else _item
+                ProfinetSubSlotDescription.from_dict(_item) if hasattr(ProfinetSubSlotDescription, 'from_dict') else _item
                 # <<< End modification
-                for _item in obj["io_descriptions"]
-            ] if obj.get("io_descriptions") is not None else None
+                for _item in obj["subslots"]
+            ] if obj.get("subslots") is not None else None
         })
         return _obj
 

wandelbots_api_client/v2/models/profinet_sub_slot_description.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: 2.1.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 typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ProfinetSubSlotDescription(BaseModel):
+    """
+    ProfinetSubSlotDescription
+    """ # noqa: E501
+    number: Annotated[int, Field(le=2147483647, strict=True, ge=0)] = Field(description="The number/index of the PROFINET subslot. ") 
+    input_length: Annotated[int, Field(le=2147483647, strict=True, ge=0)] = Field(description="The amount of bytes allocated for the subslot in the input process image buffer. ") 
+    output_length: Annotated[int, Field(le=2147483647, strict=True, ge=0)] = Field(description="The amount of bytes allocated for the subslot in the output process image buffer. ") 
+    __properties: ClassVar[List[str]] = ["number", "input_length", "output_length"]
+
+    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 ProfinetSubSlotDescription 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 ProfinetSubSlotDescription from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "number": obj.get("number"),
+            "input_length": obj.get("input_length"),
+            "output_length": obj.get("output_length")
+        })
+        return _obj
+
+

wandelbots_api_client/v2/models/program.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.1.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
+
+class Program(BaseModel):
+    """
+    A program is a collection of instructions that are executed in the robot cell.
+    """ # noqa: E501
+    program: Annotated[str, Field(min_length=1, strict=True, max_length=255)] 
+    name: Optional[StrictStr] = None 
+    description: Optional[StrictStr] = None 
+    app: StrictStr 
+    input_schema: Optional[Dict[str, Any]] = None 
+    preconditions: Optional[Dict[str, Any]] = None 
+    __properties: ClassVar[List[str]] = ["program", "name", "description", "app", "input_schema", "preconditions"]
+
+    @field_validator('program')
+    def program_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^[a-zA-Z0-9_-]+$", value):
+            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_-]+$/")
+        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 Program 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 Program from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "program": obj.get("program"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "app": obj.get("app"),
+            "input_schema": obj.get("input_schema"),
+            "preconditions": obj.get("preconditions")
+        })
+        return _obj
+
+