# fluid40/aas-http-client architecture

> Architecture diagram of the GitHub repository fluid40/aas-http-client, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fluid40/aas-http-client
- Repository: https://github.com/fluid40/aas-http-client

## Overview

AAS HTTP Client is a Python library for interacting with one AAS server per client instance. The main workflow is application code creating a client, then using its endpoint implementations to make REST requests and receive dictionary results. An optional BaSyx SDK wrapper converts between dictionaries and SDK objects; utilities provide model construction, encoding, and SDK-object operations. The README documents Registry, AAS, Submodel Repository, authentication, and wrapper capabilities. Some endpoint implementation details were not sampled, so their HTTP links are documented rather than inferred from sibling modules.

Main entry points: [`aas_http_client/classes/client/aas_client.py`](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/aas_client.py) (Client setup), [`aas_http_client/classes/wrapper/sdk_wrapper.py`](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/wrapper/sdk_wrapper.py) (BaSyx wrapper), [`aas_http_client/classes/client/implementations/sm_implementation.py`](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/sm_implementation.py) (Submodel operations), [`aas_http_client/utilities/sdk_tools.py`](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/sdk_tools.py) (SDK tools)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Client and auth"]
  node_client_factory["Client setup<br/>[aas_client.py]"]
  node_auth_config["Auth settings<br/>[config_classes.py]"]
  node_authentication["Authentication<br/>[authentication.py]"]
end

subgraph group_endpoints["REST endpoints"]
  node_aas_api["AAS operations"]
  node_submodel_api["Submodel operations"]
  node_aas_registry["AAS registry"]
  node_submodel_registry["Submodel registry"]
  node_experimental_api["Experimental API"]
end

subgraph group_wrapper["SDK wrapper"]
  node_sdk_wrapper["BaSyx wrapper<br/>[sdk_wrapper.py]"]
  node_attachment["Attachment handling<br/>[attachment.py]"]
  node_pagination["SDK pagination<br/>[pagination.py]"]
end

subgraph group_utilities["Utilities"]
  node_encoder["Base64 encoding<br/>[encoder.py]"]
  node_http_helper["HTTP errors<br/>[http_helper.py]"]
  node_model_builder["Model builder<br/>[model_builder.py]"]
  node_sdk_tools["SDK tools<br/>[sdk_tools.py]"]
  node_version_check["Update check<br/>[version_check.py]"]
end

node_application(("Application"))
node_aas_server{{"AAS server"}}

node_application -->|"creates client"| node_client_factory
node_client_factory -->|"uses settings"| node_auth_config
node_client_factory -->|"gets tokens"| node_authentication
node_client_factory -->|"initializes endpoints"| node_aas_api
node_client_factory -->|"initializes endpoints"| node_submodel_api
node_client_factory -->|"initializes endpoints"| node_aas_registry
node_client_factory -->|"initializes endpoints"| node_submodel_registry
node_client_factory -->|"initializes endpoints"| node_experimental_api
node_aas_api -->|"sends REST requests"| node_aas_server
node_submodel_api -->|"sends REST requests"| node_aas_server
node_aas_registry -->|"uses REST endpoints"| node_aas_server
node_submodel_registry -->|"uses REST endpoints"| node_aas_server
node_experimental_api -->|"uses REST endpoints"| node_aas_server
node_application -->|"uses optionally"| node_sdk_wrapper
node_sdk_wrapper -->|"delegates operations"| node_client_factory
node_sdk_wrapper -->|"uses handling"| node_attachment
node_sdk_wrapper -->|"uses pagination"| node_pagination
node_pagination -->|"converts objects"| node_sdk_tools
node_sdk_wrapper -->|"converts objects"| node_sdk_tools
node_application -->|"uses utility"| node_encoder
node_application -->|"builds models"| node_model_builder
node_application -->|"uses utility"| node_sdk_tools
node_aas_api -->|"encodes identifiers"| node_encoder
node_submodel_api -->|"encodes identifiers"| node_encoder
node_submodel_api -->|"logs errors"| node_http_helper
node_model_builder -->|"uses tools"| node_sdk_tools
node_application -.->|"package import"| node_version_check

click node_client_factory "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/aas_client.py"
click node_auth_config "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/Configuration/config_classes.py"
click node_authentication "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/authentication.py"
click node_aas_api "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/shell_implementation.py"
click node_submodel_api "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/sm_implementation.py"
click node_aas_registry "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/shell_registry_implementation.py"
click node_submodel_registry "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/sm_registry_implementation.py"
click node_experimental_api "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/experimental_implementation.py"
click node_sdk_wrapper "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/wrapper/sdk_wrapper.py"
click node_attachment "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/wrapper/attachment.py"
click node_pagination "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/wrapper/pagination.py"
click node_encoder "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/encoder.py"
click node_http_helper "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/http_helper.py"
click node_model_builder "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/model_builder.py"
click node_sdk_tools "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/sdk_tools.py"
click node_version_check "https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/version_check.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_client_factory,node_auth_config,node_authentication toneBlue
class node_aas_api,node_submodel_api,node_aas_registry,node_submodel_registry,node_experimental_api toneAmber
class node_sdk_wrapper,node_attachment,node_pagination,node_aas_server toneMint
class node_encoder,node_http_helper,node_model_builder,node_sdk_tools,node_version_check toneRose
class node_application toneIndigo
```

## Components

### Client and auth

- [Client setup](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/aas_client.py): `aas_http_client/classes/client/aas_client.py`
- [Auth settings](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/Configuration/config_classes.py): `aas_http_client/classes/Configuration/config_classes.py`
- [Authentication](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/authentication.py): `aas_http_client/classes/client/implementations/authentication.py`

### REST endpoints

- [AAS operations](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/shell_implementation.py): `aas_http_client/classes/client/implementations/shell_implementation.py`
- [Submodel operations](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/sm_implementation.py): `aas_http_client/classes/client/implementations/sm_implementation.py`
- [AAS registry](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/shell_registry_implementation.py): `aas_http_client/classes/client/implementations/shell_registry_implementation.py`
- [Submodel registry](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/sm_registry_implementation.py): `aas_http_client/classes/client/implementations/sm_registry_implementation.py`
- [Experimental API](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/client/implementations/experimental_implementation.py): `aas_http_client/classes/client/implementations/experimental_implementation.py`

### SDK wrapper

- [BaSyx wrapper](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/wrapper/sdk_wrapper.py): `aas_http_client/classes/wrapper/sdk_wrapper.py`
- [Attachment handling](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/wrapper/attachment.py): `aas_http_client/classes/wrapper/attachment.py`
- [SDK pagination](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/classes/wrapper/pagination.py): `aas_http_client/classes/wrapper/pagination.py`

### Utilities

- [Base64 encoding](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/encoder.py): `aas_http_client/utilities/encoder.py`
- [HTTP errors](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/http_helper.py): `aas_http_client/utilities/http_helper.py`
- [Model builder](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/model_builder.py): `aas_http_client/utilities/model_builder.py`
- [SDK tools](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/sdk_tools.py): `aas_http_client/utilities/sdk_tools.py`
- [Update check](https://github.com/fluid40/aas-http-client/blob/main/aas_http_client/utilities/version_check.py): `aas_http_client/utilities/version_check.py`

### Other components

- **Application**
- **AAS server**

## Connections

- Application → Client setup: creates client (evidence: `README.md`)
- Client setup → Auth settings: uses settings (evidence: `aas_http_client/classes/client/aas_client.py`)
- Client setup → Authentication: gets tokens (evidence: `aas_http_client/classes/client/aas_client.py`)
- Client setup → AAS operations: initializes endpoints (evidence: `aas_http_client/classes/client/aas_client.py`)
- Client setup → Submodel operations: initializes endpoints (evidence: `aas_http_client/classes/client/aas_client.py`)
- Client setup → AAS registry: initializes endpoints (evidence: `aas_http_client/classes/client/aas_client.py`)
- Client setup → Submodel registry: initializes endpoints (evidence: `aas_http_client/classes/client/aas_client.py`)
- Client setup → Experimental API: initializes endpoints (evidence: `aas_http_client/classes/client/aas_client.py`)
- AAS operations → AAS server: sends REST requests (evidence: `aas_http_client/classes/client/implementations/shell_implementation.py`)
- Submodel operations → AAS server: sends REST requests (evidence: `aas_http_client/classes/client/implementations/sm_implementation.py`)
- AAS registry → AAS server: uses REST endpoints (evidence: `README.md`)
- Submodel registry → AAS server: uses REST endpoints (evidence: `README.md`)
- Experimental API → AAS server: uses REST endpoints (evidence: `README.md`)
- Application → BaSyx wrapper: uses optionally (evidence: `README.md`)
- BaSyx wrapper → Client setup: delegates operations (evidence: `aas_http_client/classes/wrapper/sdk_wrapper.py`)
- BaSyx wrapper → Attachment handling: uses handling (evidence: `aas_http_client/classes/wrapper/sdk_wrapper.py`)
- BaSyx wrapper → SDK pagination: uses pagination (evidence: `aas_http_client/classes/wrapper/sdk_wrapper.py`)
- SDK pagination → SDK tools: converts objects (evidence: `aas_http_client/classes/wrapper/pagination.py`)
- BaSyx wrapper → SDK tools: converts objects (evidence: `aas_http_client/classes/wrapper/sdk_wrapper.py`)
- Application → Base64 encoding: uses utility (evidence: `README.md`)
- Application → Model builder: builds models (evidence: `README.md`)
- Application → SDK tools: uses utility (evidence: `README.md`)
- AAS operations → Base64 encoding: encodes identifiers (evidence: `aas_http_client/classes/client/implementations/shell_implementation.py`)
- Submodel operations → Base64 encoding: encodes identifiers (evidence: `aas_http_client/classes/client/implementations/sm_implementation.py`)
- Submodel operations → HTTP errors: logs errors (evidence: `aas_http_client/classes/client/implementations/sm_implementation.py`)
- Model builder → SDK tools: uses tools (evidence: `aas_http_client/utilities/model_builder.py`)
- Application → Update check: package import
