aas-http-client 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

aas_http_client/client.py

@@ -121,6 +121,8 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
+# region shells
+
     def post_shells(self, aas_data: dict) -> dict | None:
         """Post an Asset Administration Shell (AAS) to the REST API.
 
@@ -311,11 +313,15 @@ class AasHttpClient(BaseModel):
 
         return True
 
-    def post_submodels(self, submodel_data: dict) -> dict:
-        """Post a submodel to the REST API.
+# endregion
 
-        :param submodel_data: Json data of the Submodel to post
-        :return: Response data as a dictionary or None if an error occurred
+# region submodels
+
+    def post_submodels(self, submodel_data: dict) -> dict | None:
+        """Create a new Submodel.
+
+        :param Submodel_data: Json data of the Submodel to post
+        :return: Submodel data or None if an error occurred
         """
         url = f"{self.base_url}/submodels"
 
@@ -325,19 +331,19 @@ class AasHttpClient(BaseModel):
 
             if response.status_code not in (STATUS_CODE_201, STATUS_CODE_202):
                 log_response_errors(response)
-                return False
+                return None
 
         except requests.exceptions.RequestException as e:
             logger.error(f"Error call REST API: {e}")
-            return False
+            return None
 
         content = response.content.decode("utf-8")
         return json.loads(content)
 
     def put_submodels_by_id(self, identifier: str, submodel_data: dict) -> bool:
-        """Update a submodel by its ID in the REST API.
+        """Updates a existing Submodel.
 
-        :param identifier: Identifier of the submodel to update
+        :param identifier: Encoded ID of the Submodel to update
         :param submodel_data: Json data of the Submodel to update
         :return: True if the update was successful, False otherwise
         """
@@ -359,9 +365,9 @@ class AasHttpClient(BaseModel):
         return True
 
     def get_submodels(self) -> list[dict] | None:
-        """Get all submodels from the REST API.
+        """Returns all Submodels
 
-        :return: Submodel objects or None if an error occurred
+        :return: List of Submodel data or None if an error occurred
         """
         url = f"{self.base_url}/submodels"
 
@@ -381,10 +387,10 @@ class AasHttpClient(BaseModel):
         return json.loads(content)
 
     def get_submodels_by_id(self, submodel_id: str) -> dict | None:
-        """Get a submodel by its ID from the REST API.
+        """Returns a specific Submodel.
 
-        :param submodel_id: ID of the submodel to retrieve
-        :return: Submodel object or None if an error occurred
+        :param submodel_id: Encoded ID of the Submodel to retrieve
+        :return: Submodel data or None if an error occurred
         """
         decoded_submodel_id: str = decode_base_64(submodel_id)
         url = f"{self.base_url}/submodels/{decoded_submodel_id}"
@@ -404,7 +410,12 @@ class AasHttpClient(BaseModel):
         content = response.content.decode("utf-8")
         return json.loads(content)
 
-    def patch_submodel_by_id(self, submodel_id: str, submodel_data: dict):
+    def patch_submodel_by_id(self, submodel_id: str, submodel_data: dict) -> bool:
+        """Updates an existing Submodel
+
+        :param submodel_id: Encoded ID of the Submodel to delete
+        :return: True if the patch was successful, False otherwise
+        """
         decoded_submodel_id: str = decode_base_64(submodel_id)
         url = f"{self.base_url}/submodels/{decoded_submodel_id}"
 
@@ -423,9 +434,9 @@ class AasHttpClient(BaseModel):
         return True
 
     def delete_submodels_by_id(self, submodel_id: str) -> bool:
-        """Delete a submodel by its ID from the REST API.
+        """Deletes a existing Submodel.
 
-        :param submodel_id: ID of the submodel to delete
+        :param submodel_id: Encoded ID of the Submodel to delete
         :return: True if the deletion was successful, False otherwise
         """
         decoded_submodel_id: str = decode_base_64(submodel_id)
@@ -445,6 +456,57 @@ class AasHttpClient(BaseModel):
 
         return True
 
+    def get_submodels_submodel_elements(self, submodel_id: str) -> list[dict] | None:
+        """Returns all Submodel elements including their hierarchy.
+
+        :param submodel_id: Encoded ID of the Submodel to retrieve elements from
+        :return: List of Submodel element data or None if an error occurred
+        """
+        decoded_submodel_id: str = decode_base_64(submodel_id)
+        url = f"{self.base_url}/submodels/{decoded_submodel_id}/submodel-elements"
+
+        try:
+            response = self._session.get(url, headers=HEADERS, timeout=self.time_out)
+            logger.debug(f"Call REST API url '{response.url}'")
+
+            if response.status_code != STATUS_CODE_200:
+                log_response_errors(response)
+                return None
+
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Error call REST API: {e}")
+            return None
+
+        content = response.content.decode("utf-8")
+        return json.loads(content)
+
+    def post_submodels_submodel_elements(self, submodel_id: str, submodel_element_data: dict) -> dict | None:
+        """Create a new Submodel element.
+
+        :param submodel_id: Encoded ID of the Submodel to create elements for
+        :return: Submodel element data or None if an error occurred
+        """
+        decoded_submodel_id: str = decode_base_64(submodel_id)
+        url = f"{self.base_url}/submodels/{decoded_submodel_id}/submodel-elements"
+
+        try:
+            response = self._session.post(url, headers=HEADERS, json=submodel_element_data, timeout=self.time_out)
+            logger.debug(f"Call REST API url '{response.url}'")
+
+            if response.status_code != STATUS_CODE_201:
+                log_response_errors(response)
+                return None
+
+        except requests.exceptions.RequestException as e:
+            logger.error(f"Error call REST API: {e}")
+            return None
+
+        content = response.content.decode("utf-8")
+        return json.loads(content)
+
+# endregion
+
+# region client
 
 def create_client_by_url(
     base_url: str,
@@ -480,7 +542,6 @@ def create_client_by_url(
     config_string = json.dumps(config_dict, indent=4)
     return _create_client(config_string, password)
 
-
 def create_client_by_config(config_file: Path, password: str = "") -> AasHttpClient | None:
     """Create a AAS HTTP client from the given parameters.
 
@@ -499,7 +560,6 @@ def create_client_by_config(config_file: Path, password: str = "") -> AasHttpCli
 
     return _create_client(config_string, password)
 
-
 def _create_client(config_string: str, password) -> AasHttpClient | None:
     try:
         connection_settings = AasHttpClient.model_validate_json(config_string)
@@ -525,7 +585,6 @@ def _create_client(config_string: str, password) -> AasHttpClient | None:
 
     return client
 
-
 def _connect_to_api(client: AasHttpClient) -> bool:
     start_time = time.time()
     logger.debug(f"Try to connect to REST API '{client.base_url}' for {client.connection_time_out} seconds")
@@ -544,3 +603,5 @@ def _connect_to_api(client: AasHttpClient) -> bool:
         counter += 1
         logger.warning(f"Retrying connection (attempt: {counter})")
         time.sleep(1)
+
+# endregion

aas_http_client/demo/demo_process.py

@@ -5,45 +5,54 @@ from aas_http_client.wrapper.sdk_wrapper import SdkWrapper, create_wrapper_by_co
 from pathlib import Path
 import json
 import basyx.aas.adapter.json
-from basyx.aas.model import AssetAdministrationShell
+import basyx.aas.model
+
+from basyx.aas import model
 
 logger = logging.getLogger(__name__)
 
 def start():
     """Start the demo process."""
-
-    aas_1 = _create_shell()
-    aas_2 = _create_shell()
+    # create a submodel element
+    sme_short_id: str = model_builder.create_unique_short_id("poc_sme")
+    sme = model_builder.create_base_submodel_element_Property(sme_short_id, model.datatypes.String, "Sample Value")
     
-    client = _create_client()
-    java_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/java_server_config.json"))
-    dotnet_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/dotnet_server_config.json"))
-
-    java_sdk_wrapper.get_shells_by_id(aas_1.id)
-    dotnet_sdk_wrapper.get_shells_by_id(aas_1.id)
+    # create a submodel
+    sm_short_id: str = model_builder.create_unique_short_id("poc_sm")
+    submodel = model_builder.create_base_submodel(sm_short_id)
+    # add submodel element to submodel
+    # submodel.submodel_element.add(sme)
     
-    java_sdk_wrapper.get_submodels_by_id(aas_1.id)
-    dotnet_sdk_wrapper.get_submodels_by_id(aas_1.id)
+    # create an AAS
+    aas_short_id: str = model_builder.create_unique_short_id("poc_aas")
+    aas = model_builder.create_base_ass(aas_short_id)
     
-    exist_shells = java_sdk_wrapper.get_shells()
-    exist_shells = dotnet_sdk_wrapper.get_shells()
+    # add submodel to AAS
+    model_builder.add_submodel_to_aas(aas, submodel)
     
-    for shell in exist_shells:
-        logger.warning(f"Delete shell '{shell.id}'")
-        java_sdk_wrapper.delete_shells_by_id(shell.id)
+    java_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/java_server_config.json"))
+    # dotnet_sdk_wrapper = _create_sdk_wrapper(Path("./aas_http_client/demo/dotnet_server_config.json"))
 
-    java_sdk_wrapper.post_shells(aas_1)
+    for existing_shell in java_sdk_wrapper.get_shells():
+        logger.warning(f"Delete shell '{existing_shell.id}'")
+        java_sdk_wrapper.delete_shells_by_id(existing_shell.id)
 
+    for existing_submodel in java_sdk_wrapper.get_submodels():
+        logger.warning(f"Delete submodel '{existing_submodel.id}'")
+        java_sdk_wrapper.delete_submodels_by_id(existing_submodel.id)
 
-    aas_dict_string = json.dumps(aas_2, cls=basyx.aas.adapter.json.AASToJsonEncoder)
-    aas_dict = json.loads(aas_dict_string)
-    client.post_shells(aas_dict)
-    
-    shells = client.get_shells()
+    java_sdk_wrapper.post_shells(aas)
+    java_sdk_wrapper.post_submodels(submodel)
 
-    logger.info(f"Client created successfully. {shells}")
+    shell = java_sdk_wrapper.get_shells_by_id(aas.id)    
+    submodel = java_sdk_wrapper.get_submodels_by_id(submodel.id)
 
-def _create_shell() -> AssetAdministrationShell:
+    java_sdk_wrapper.post_submodels_submodel_elements(submodel.id, sme)
+
+    submodel = java_sdk_wrapper.get_submodels_by_id(submodel.id)
+    
+
+def _create_shell() -> basyx.aas.model.AssetAdministrationShell:
     # create an AAS
     aas_short_id: str = model_builder.create_unique_short_id("poc_aas")
     aas = model_builder.create_base_ass(aas_short_id)
@@ -57,11 +66,11 @@ def _create_shell() -> AssetAdministrationShell:
     
     return aas
 
-def _create_client() -> AasHttpClient:
+def _create_client(config: Path) -> AasHttpClient:
     """Create client for java servers."""
 
     try:
-        file = Path("./aas_http_client/demo/java_server_config.json")
+        file = config
         client = create_client_by_config(file, password="")
     except Exception as e:
         logger.error(f"Failed to create client for {file}: {e}")

aas_http_client/utilities/model_builder.py

@@ -5,15 +5,8 @@ Provides some helper methods for easier work with basyx sdk data model
 
 import uuid
 
-from basyx.aas.model import (
-    AssetAdministrationShell,
-    AssetInformation,
-    AssetKind,
-    ModelReference,
-    MultiLanguageTextType,
-    Submodel,
-)
-
+from basyx.aas import model
+from typing import Any
 
 def create_unique_short_id(id_short: str) -> str:
     """Generate a unique identifier string by appending a UUID to the provided ID short.
@@ -23,8 +16,29 @@ def create_unique_short_id(id_short: str) -> str:
     """
     return f"{id_short}_{str(uuid.uuid4()).replace('-', '_')}"
 
+def create_base_submodel_element_Property(id_short: str, type: model.datatypes, value: Any, display_name: str = "", description: str = "") -> model.Property:
+    """Create a basic Property Submodel Element.
+    """
+    sme = model.Property(
+        id_short=id_short, 
+        value_type=type,
+        value=value)     
+    
+    if not description:
+        description = f"This is the submodel element with ID short '{id_short}'"
+
+    description_text = {"en": f"{description}"}
+    sme.description = model.MultiLanguageTextType(description_text)
+    
+    if not display_name:
+        display_name = "POC Submodel Element"
+
+    display_name_text = {"en": f"{display_name}"}
+    sme.display_name = model.MultiLanguageTextType(display_name_text)
+    
+    return sme
 
-def create_base_submodel(id_short: str, namespace: str = "basyx_python_aas_server", display_name: str = "", description: str = "") -> Submodel:
+def create_base_submodel(id_short: str, namespace: str = "basyx_python_aas_server", display_name: str = "", description: str = "") -> model.Submodel:
     """Create a basic Submodel.
 
     :param id_short: ID short of the Submodel
@@ -37,27 +51,27 @@ def create_base_submodel(id_short: str, namespace: str = "basyx_python_aas_serve
         identifier = f"{namespace}/{id_short}"
     else:   
         identifier = id_short
-    sm = Submodel(identifier)
+    sm = model.Submodel(identifier)
     sm.id_short = id_short
 
     if not description:
         description = f"This is the submodel with ID short '{id_short}'"
 
     description_text = {"en": f"{description}"}
-    sm.description = MultiLanguageTextType(description_text)
+    sm.description = model.MultiLanguageTextType(description_text)
 
     if not display_name:
         display_name = "POC AAS"
 
     display_name_text = {"en": f"{display_name}"}
-    sm.display_name = MultiLanguageTextType(display_name_text)
+    sm.display_name = model.MultiLanguageTextType(display_name_text)
 
     return sm
 
 
 def create_base_ass(
     id_short: str, namespace: str = "basyx_python_aas_server", display_name: str = "", description: str = ""
-) -> AssetAdministrationShell:
+) -> model.AssetAdministrationShell:
     """Create a basic AAS.
 
     :param id_short: ID short of the AAS
@@ -68,35 +82,35 @@ def create_base_ass(
     """
     asset_info = create_base_asset_information(id_short, namespace)
 
-    aas = AssetAdministrationShell(id_=asset_info.global_asset_id, asset_information=asset_info)
+    aas = model.AssetAdministrationShell(id_=asset_info.global_asset_id, asset_information=asset_info)
     aas.id_short = id_short
 
     if not description:
         description = f"This is the asset administration shell with ID short '{id_short}'"
 
     description_text = {"en": f"{description}"}
-    aas.description = MultiLanguageTextType(description_text)
+    aas.description = model.MultiLanguageTextType(description_text)
 
     if not display_name:
         display_name = "POC AAS"
 
     display_name_text = {"en": f"{display_name}"}
-    aas.display_name = MultiLanguageTextType(display_name_text)
+    aas.display_name = model.MultiLanguageTextType(display_name_text)
 
     return aas
 
 
-def add_submodel_to_aas(aas: AssetAdministrationShell, submodel: Submodel) -> None:
+def add_submodel_to_aas(aas: model.AssetAdministrationShell, submodel: model.Submodel) -> None:
     """Add a given Submodel correctly to a provided AssetAdministrationShell.
 
     :param aas: provided AssetAdministrationShell to which the Submodel should be added
     :param submodel: given Submodel to add
     """
     # aas.submodel.add(submodel)
-    aas.submodel.add(ModelReference.from_referable(submodel))
+    aas.submodel.add(model.ModelReference.from_referable(submodel))
 
 
-def create_base_asset_information(id_short: str, namespace: str = "basyx_python_aas_server") -> AssetInformation:
+def create_base_asset_information(id_short: str, namespace: str = "basyx_python_aas_server") -> model.AssetInformation:
     """Return a basic AssetInformation instance.
 
     :param id_short: short ID of the AssetInformation
@@ -107,13 +121,13 @@ def create_base_asset_information(id_short: str, namespace: str = "basyx_python_
         identifier = f"{namespace}/{id_short}"
     else:   
         identifier = id_short
-    return AssetInformation(AssetKind.INSTANCE, identifier)
+    return model.AssetInformation(model.AssetKind.INSTANCE, identifier)
 
 
-def create_reference(id: str) -> ModelReference:
+def create_reference(id: str) -> model.ModelReference:
     """Create a ModelReference.
 
     :param id: ID of the Submodel to reference
     :return: ModelReference instance
     """
-    return ModelReference.from_referable(Submodel(id))
+    return model.ModelReference.from_referable(model.Submodel(id))

aas_http_client/wrapper/sdk_wrapper.py

@@ -7,24 +7,27 @@ from typing import Any
 
 import basyx.aas.adapter.json
 
-from basyx.aas.model import AssetAdministrationShell, Reference, Submodel, ModelReference
+from basyx.aas import model
 from aas_http_client.client import AasHttpClient, _create_client
 logger = logging.getLogger(__name__)
 
 class SdkWrapper():
-    """Represents a SdkWrapper to communicate with a REST API."""
-    _client: AasHttpClient = None
+    """Represents a wrapper for the BaSyx Python SDK to communicate with a REST API."""
+    _client: AasHttpClient = None  
 
-    def post_shells(self, aas: AssetAdministrationShell) -> dict | None:
+# region shells
+
+    def post_shells(self, aas: model.AssetAdministrationShell) -> model.AssetAdministrationShell | None:
         """Post an Asset Administration Shell (AAS) to the REST API.
 
         :param aas: Asset Administration Shell to post
         :return: Response data as a dictionary or None if an error occurred
         """
         aas_data = _to_dict(aas)
-        return self._client.post_shells(aas_data)
+        content: dict = self._client.post_shells(aas_data)
+        return _to_object(content)
 
-    def put_shells(self, identifier: str, aas: AssetAdministrationShell) -> bool:
+    def put_shells(self, identifier: str, aas: model.AssetAdministrationShell) -> bool:
         """Update an Asset Administration Shell (AAS) by its ID in the REST API.
 
         :param identifier: Identifier of the AAS to update
@@ -34,7 +37,7 @@ class SdkWrapper():
         aas_data = _to_dict(aas)
         return self._client.put_shells(identifier, aas_data)
 
-    def put_shells_submodels_by_id(self, aas_id: str, submodel_id: str, submodel: Submodel) -> bool:
+    def put_shells_submodels_by_id(self, aas_id: str, submodel_id: str, submodel: model.Submodel) -> bool:
         """Update a submodel by its ID for a specific Asset Administration Shell (AAS).
 
         :param aas_id: ID of the AAS to update the submodel for
@@ -44,7 +47,7 @@ class SdkWrapper():
         sm_data = _to_dict(submodel)
         return self._client.put_shells_submodels_by_id(aas_id, submodel_id, sm_data)
 
-    def get_shells(self) -> list[AssetAdministrationShell] | None:
+    def get_shells(self) -> list[model.AssetAdministrationShell] | None:
         """Get all Asset Administration Shells (AAS) from the REST API.
 
         :return: AAS objects or None if an error occurred
@@ -59,7 +62,7 @@ class SdkWrapper():
             logger.warning("No shells found on server.")
             return []
 
-        aas_list: list[AssetAdministrationShell] = []
+        aas_list: list[model.AssetAdministrationShell] = []
 
         for result in results:
             if not isinstance(result, dict):
@@ -73,7 +76,7 @@ class SdkWrapper():
 
         return aas_list
 
-    def get_shells_by_id(self, aas_id: str) -> AssetAdministrationShell | None:
+    def get_shells_by_id(self, aas_id: str) -> model.AssetAdministrationShell | None:
         """Get an Asset Administration Shell (AAS) by its ID from the REST API.
 
         :param aas_id: ID of the AAS to retrieve
@@ -87,15 +90,15 @@ class SdkWrapper():
         
         return _to_object(content)
 
-    def get_shells_reference_by_id(self, aas_id: str) -> Reference | None:
+    def get_shells_reference_by_id(self, aas_id: str) -> model.Reference | None:
         #workaround because serialization not working
         aas = self.get_shells_by_id(aas_id)
-        return ModelReference.from_referable(aas)
+        return model.ModelReference.from_referable(aas)
         
         # content: dict = self._client.get_shells_reference_by_id(aas_id)
         # return json.loads(content, cls=basyx.aas.adapter.json.AASFromJsonDecoder)
 
-    def get_shells_submodels_by_id(self, aas_id: str, submodel_id: str) -> Submodel | None:
+    def get_shells_submodels_by_id(self, aas_id: str, submodel_id: str) -> model.Submodel | None:
         """Get a submodel by its ID for a specific Asset Administration Shell (AAS).
 
         :param aas_id: ID of the AAS to retrieve the submodel from
@@ -113,16 +116,21 @@ class SdkWrapper():
         """
         return self._client.delete_shells_by_id(aas_id)
 
-    def post_submodels(self, submodel: Submodel) -> bool:
+# endregion
+
+# region submodels
+
+    def post_submodels(self, submodel: model.Submodel) -> model.Submodel | None:
         """Post a submodel to the REST API.
 
         :param submodel: submodel data as a dictionary
         :return: Response data as a dictionary or None if an error occurred
         """
         sm_data = _to_dict(submodel)
-        return self._client.post_submodels(sm_data)
+        content: dict = self._client.post_submodels(sm_data)
+        return _to_object(content)
 
-    def put_submodels_by_id(self, identifier: str, submodel: Submodel) -> bool:
+    def put_submodels_by_id(self, identifier: str, submodel: model.Submodel) -> bool:
         """Update a submodel by its ID in the REST API.
 
         :param identifier: Identifier of the submodel to update
@@ -132,7 +140,7 @@ class SdkWrapper():
         sm_data = _to_dict(submodel)
         return self._client.put_submodels_by_id(identifier, sm_data)
 
-    def get_submodels(self) -> list[Submodel] | None:
+    def get_submodels(self) -> list[model.Submodel] | None:
         """Get all submodels from the REST API.
 
         :return: Submodel objects or None if an error occurred
@@ -147,7 +155,7 @@ class SdkWrapper():
             logger.warning("No submodels found on server.")
             return []
 
-        submodels: list[Submodel] = []
+        submodels: list[model.Submodel] = []
 
         for result in results:
             if not isinstance(result, dict):
@@ -161,7 +169,7 @@ class SdkWrapper():
 
         return submodels
 
-    def get_submodels_by_id(self, submodel_id: str) -> Submodel | None:
+    def get_submodels_by_id(self, submodel_id: str) -> model.Submodel | None:
         """Get a submodel by its ID from the REST API.
 
         :param submodel_id: ID of the submodel to retrieve
@@ -175,7 +183,7 @@ class SdkWrapper():
         
         return _to_object(content)
 
-    def patch_submodel_by_id(self, submodel_id: str, submodel: Submodel):
+    def patch_submodel_by_id(self, submodel_id: str, submodel: model.Submodel):
         sm_data = _to_dict(submodel)
         return self._client.patch_submodel_by_id(submodel_id, sm_data)
 
@@ -187,6 +195,52 @@ class SdkWrapper():
         """
         return self._client.delete_submodels_by_id(submodel_id)
 
+    def get_submodels_submodel_elements(self, submodel_id: str, ) -> list[model.SubmodelElement] | None:
+        """Returns all Submodel elements including their hierarchy.
+        !!! Serialization to model.SubmodelElement currently not possible
+
+        :param submodel_id: Encoded ID of the Submodel to retrieve elements from
+        :return: List of Submodel elements or None if an error occurred
+        """
+        content = self._client.get_submodels_submodel_elements(submodel_id)
+        
+        if not content:
+            return []
+
+        results: list = content.get("result", [])
+        if not results:
+            logger.warning("No submodels found on server.")
+            return []
+
+        submodel_elements: list[model.SubmodelElement] = []
+
+        for result in results:
+            if not isinstance(result, dict):
+                logger.error(f"Invalid submodel data: {result}")
+                return None
+
+            submodel_element = _to_object(result)
+
+            if submodel_element:
+                submodel_elements.append(submodel_element)
+
+        return submodel_elements
+
+    def post_submodels_submodel_elements(self, submodel_id: str, submodel_element: model.SubmodelElement) -> model.SubmodelElement | None:
+        """Create a new submodel element.
+        !!! Serialization to model.SubmodelElements currently not possible
+        
+        :param submodel_id: Encoded ID of the submodel to create elements for
+        :param submodel_element: Submodel element to create
+        :return: List of submodel element objects or None if an error occurred
+        """
+        sme_data = _to_dict(submodel_element)
+        content: dict = self._client.post_submodels_submodel_elements(submodel_id, sme_data)
+        return _to_object(content)
+
+
+# endregion
+
 def _to_object(content: dict) -> Any | None:
     try:
         dict_string = json.dumps(content)
@@ -205,6 +259,8 @@ def _to_dict(object: Any) -> dict | None:
         logger.error(f"In object: {object}")
         return None    
 
+# region wrapper
+
 def create_wrapper_by_url(
     base_url: str,
     username: str = "",
@@ -215,7 +271,7 @@ def create_wrapper_by_url(
     connection_time_out: int = 60,
     ssl_verify: str = True,  # noqa: FBT002
 ) -> SdkWrapper | None:
-    """Create a BaSyx server interface client from the given parameters.
+    """Create a wrapper for the BaSyx Python SDK from the given parameters.
 
     :param base_url: base URL of the BaSyx server, e.g. "http://basyx_python_server:80/"_
     :param username: username for the BaSyx server interface client, defaults to ""_
@@ -225,9 +281,9 @@ def create_wrapper_by_url(
     :param time_out: timeout for the API calls, defaults to 200
     :param connection_time_out: timeout for the connection to the API, defaults to 60
     :param ssl_verify: whether to verify SSL certificates, defaults to True
-    :return: An instance of HttpClient initialized with the provided parameters.
+    :return: An instance of SdkWrapper initialized with the provided parameters.
     """
-    logger.info(f"Create BaSyx server interface client from URL '{base_url}'")
+    logger.info(f"Create BaSyx Python SDK wrapper from URL '{base_url}'")
     config_dict: dict[str, str] = {}
     config_dict["base_url"] = base_url
     config_dict["username"] = username
@@ -247,14 +303,12 @@ def create_wrapper_by_url(
     wrapper._client = client          
     return wrapper
     
-
-
-def create_wrapper_by_config(config_file: Path, password: str = "") -> AasHttpClient | None:
-    """Create a BaSyx server interface client from the given parameters.
+def create_wrapper_by_config(config_file: Path, password: str = "") -> SdkWrapper | None:
+    """Create a wrapper for the BaSyx Python SDK from the given parameters.
 
     :param config_file: Path to the configuration file containing the BaSyx server connection settings.
     :param password: password for the BaSyx server interface client, defaults to ""_
-    :return: An instance of HttpClient initialized with the provided parameters.
+    :return: An instance of SdkWrapper initialized with the provided parameters.
     """
     logger.info(f"Create BaSyx Python SDK wrapper from configuration file '{config_file}'")
     if not config_file.exists():
@@ -271,4 +325,6 @@ def create_wrapper_by_config(config_file: Path, password: str = "") -> AasHttpCl
         return None
     
     wrapper._client = client       
-    return wrapper
+    return wrapper
+
+# endregion

{aas_http_client-0.2.2.dist-info → aas_http_client-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aas-http-client
-Version: 0.2.2
+Version: 0.2.4
 Summary: Generic python HTTP client for communication with various types of AAS servers
 Author-email: Daniel Klein <daniel.klein@em.ag>
 License: # :em engineering methods AG Software License
@@ -127,17 +127,27 @@ Dynamic: license-file
 [![CI](https://github.com/fluid40/aas-http-client/actions/workflows/CI.yml/badge.svg?branch=main&cache-bust=1)](https://github.com/fluid40/aas-http-client/actions)
 [![PyPI version](https://img.shields.io/pypi/v/aas-http-client.svg)](https://pypi.org/project/aas-http-client/)
 
-This is a generic HTTP client that can communicate with various types of AAS and submodel repository servers. The client uses Python dictionaries for input and output parameters.
-Additionally, wrappers are provided that work with various AAS frameworks and use the HTTP client as middleware.  
+This is a generic HTTP client that can communicate with various types of AAS and submodel repository servers. It uses Python dictionaries for input and output parameters of functions. It supports the most common endpoints for the [specified AAS server endpoint](https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.1.1/specification/interfaces.html). The client is compatible with various types of AAS repository server.
+The client should be compatible with various types of AAS repository server. 
 
-Currently, wrappers are available for the following frameworks:
-- BaSyx Python SDK
+Tested servers include:
+- [Eclipse BaSyx .Net SDK server](https://github.com/eclipse-basyx/basyx-dotnet)
+- [Eclipse BaSyx .Net SDK server (Fluid4.0 Fork)](https://github.com/fluid40/basyx-dotnet)
+- [Eclipse BaSyx Java SDK server](https://github.com/eclipse-basyx/basyx-java-sdk)
+- [Eclipse BaSyx Python SDK server](https://github.com/eclipse-basyx/basyx-python-sdk)
+- [Eclipse AASX server](https://github.com/eclipse-aaspe)  
+
+The behavior may vary depending on the details of the implementation and compliance with the [AAS specification](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). It also depends on which endpoints are provided by the server.
+
+Additionally, wrappers are provided that work with various AAS frameworks and use the HTTP client as middleware. These wrappers use the SDK-specific data model classes for function input and output parameters.
+Wrappers are currently available for the following frameworks:
+- [Eclipse BaSyx Python SDK](https://github.com/eclipse-basyx/basyx-python-sdk)
 
 ## Links
 
 🚀 [Getting Started](docs/getting_started.md)
 
-💻 [Developer Quickstart](docs/dev_guide.md)
+💻 [Tutorials](docs/tutorials.md)
 
 👨‍⚕️ [Troubleshooting](docs/troubleshooting.md)
 
@@ -167,12 +177,12 @@ client = create_client_by_url(
 print(client.get_shells())
 ```
 
-### SDK Wrapper
+### BaSyx Python SDK Wrapper
 
 ```python
-from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_config
+from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_url
 
-wrapper = create_wrapper_by_config(
+wrapper = create_wrapper_by_url(
     base_url="http://myaasserver:5043/"
 )
 

aas_http_client-0.2.4.dist-info/RECORD

@@ -0,0 +1,14 @@
+aas_http_client/__init__.py,sha256=cAr1mQzWp0G0LKtkAOYzc9t95OY3jM3Aj4bKnxx0Dso,901
+aas_http_client/client.py,sha256=8pgEd3xV8BDBhqQvYfdLGOVEOJI5-ZfzXhjRe5OZZ_0,22916
+aas_http_client/core/encoder.py,sha256=FS7P0FPakzFsGz70eRFDHQZFA_2nlKLlWIxavtnFrPg,660
+aas_http_client/core/version_check.py,sha256=721Zs3xSRrJTYZtAxkaUWg9LLKtpU7oFM62DzQHZdE4,705
+aas_http_client/demo/demo_process.py,sha256=kW1f8D6cjlzRS2Ald_LYM_Qk7lc_XxEV53asjaJDhKw,3188
+aas_http_client/demo/logging_handler.py,sha256=VJtZ4u3x_LhYZQtfNck7FuXhGFZm7gid0uDhvf9GjJ8,5596
+aas_http_client/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+aas_http_client/utilities/model_builder.py,sha256=mL06SX208dMJHpiB-ol51JA9Bm3czoI8ELYTfismCq8,4633
+aas_http_client/wrapper/sdk_wrapper.py,sha256=G0bqZB2AL4-E7FhQF4jDJtsRREq55knj1RmYNpLHxzI,12368
+aas_http_client-0.2.4.dist-info/licenses/LICENSE,sha256=ayt4HY-Tjoe1Uvj47j6UdNq8mEufKcKFangurChIHxQ,5990
+aas_http_client-0.2.4.dist-info/METADATA,sha256=D8d3xu5re1-uIXnlSfZUCjTptwwtBPbtf4kJ9AuGA4I,10301
+aas_http_client-0.2.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+aas_http_client-0.2.4.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
+aas_http_client-0.2.4.dist-info/RECORD,,

aas_http_client-0.2.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-aas_http_client/__init__.py,sha256=cAr1mQzWp0G0LKtkAOYzc9t95OY3jM3Aj4bKnxx0Dso,901
-aas_http_client/client.py,sha256=6d3g9VNhex1JrZwIXtBTopSTw3bsf5NZBSWG5mHYuQg,20705
-aas_http_client/core/encoder.py,sha256=FS7P0FPakzFsGz70eRFDHQZFA_2nlKLlWIxavtnFrPg,660
-aas_http_client/core/version_check.py,sha256=721Zs3xSRrJTYZtAxkaUWg9LLKtpU7oFM62DzQHZdE4,705
-aas_http_client/demo/demo_process.py,sha256=ESR0ETJdEWXHZRswcuNh9qArStFyHFWCNYxhJjLB0tA,2616
-aas_http_client/demo/logging_handler.py,sha256=VJtZ4u3x_LhYZQtfNck7FuXhGFZm7gid0uDhvf9GjJ8,5596
-aas_http_client/utilities/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aas_http_client/utilities/model_builder.py,sha256=bL4hy3uHh1Y_uL6KmLIfo9ORiUqWNlyToJrAt8G1rpw,3877
-aas_http_client/wrapper/sdk_wrapper.py,sha256=MClsjWDuKDMN_R5b9vEkbxn_sFQ-UhGN3DBzWkLiVQU,10314
-aas_http_client-0.2.2.dist-info/licenses/LICENSE,sha256=ayt4HY-Tjoe1Uvj47j6UdNq8mEufKcKFangurChIHxQ,5990
-aas_http_client-0.2.2.dist-info/METADATA,sha256=7NJUrDZSukbER5QnPI6CEL_oIsVeaarzy_CLQX8PFvg,9144
-aas_http_client-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-aas_http_client-0.2.2.dist-info/top_level.txt,sha256=vzvoz2vjeTLwpuz-Y-eEfoQ7T3byoaKshVlFMFH5NaM,16
-aas_http_client-0.2.2.dist-info/RECORD,,