AAS HTTP Client
AAS HTTP Client is a flexible Python library for interacting with Asset Administration Shell (AAS) and submodel repository servers over HTTP. It uses standard Python dictionaries for function inputs and outputs, making it easy to integrate with a variety of workflows. The client implements the most widely used endpoints defined in the AAS server specification, ensuring compatibility with multiple AAS repository server implementations. This allows you to connect to different AAS servers without changing your client code.
Notes:
- Each client instance communicates with exactly one AAS server (1-to-1 mapping). For multiple servers, create multiple instances.
- From version 1.0.0 the client includes implementations for all endpoints from BaSxy Java SDK 'aas-registry', 'submodel-registry' and 'aas-environment'.
Table of Contents:
🚀 Features
- ✅ Easy REST communication with AAS-compliant servers
- ✅ Support for Registry, AAS, and Submodel Repository endpoints
- ✅ Optional wrapper for the Eclipse BaSyx Python SDK
- ✅ Built-in authentication (Bearer, OAuth, Basic)
- ✅ Pagination support
- ✅ Utility modules (encoding, model builder, SDK tools)
- ✅ Tested with multiple AAS server implementations
🏗️ Supported Servers
The client has been tested with:
- https://github.com/fluid40/basyx-dotnet
- https://github.com/eclipse-basyx/basyx-java-sdk
- https://github.com/eclipse-basyx/basyx-python-sdk
Actual behavior depends on each server's implementation of the AAS Specification
🧰 Wrappers
Wrappers provide a higher-level interface on top of the raw HTTP client. Use them when you want to work with SDK objects instead of plain Python dictionaries returned by the REST API.
Currently available wrappers:
What the BaSyx Wrapper Adds:
- Accepts and returns
basyx.aas.modelobjects for common AAS and submodel operations - Reuses the same connection and authentication settings as the base HTTP client
- Supports wrapper creation from a URL, a Python dictionary, or a configuration file
- Keeps low-level client access available through
wrapper.get_client()when needed
🔧 Provided Utilities
The AAS HTTP Client package also include some utility functions for for recurring tasks (provided by import aas_http_client.utilities ):
- encoder: base64 encoding and decoding
- sdk_tools: e.g. Framework object serialization and deserialization, basic submodel operations
- model_builder: creation of some basic AAS model elements
📚 Resources
⚡ Quickstart
For a detailed introduction, please read Getting Started.
pip install aas-http-client
Client
from aas_http_client.classes.client import aas_client
client = aas_client.create_by_url(base_url="http://localhost:8081")
shells_paginated = client.shells.get_all_asset_administration_shells()
print(shells_paginated.get("results", []))
Wrapper
from aas_http_client.classes.wrapper import sdk_wrapper
wrapper = sdk_wrapper.create_by_url(base_url="http://localhost:8081")
shells = wrapper.get_all_asset_administration_shells()
print(shells)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aas_http_client-1.2.0.tar.gz.
File metadata
- Download URL: aas_http_client-1.2.0.tar.gz
- Upload date:
- Size: 45.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13c54c59171c0a881b0c0b5fbd36d3756b36467e8b9902c9d7c9f3010ecd4e46
|
|
| MD5 |
f5698380845d5c34c1df82958ee984c5
|
|
| BLAKE2b-256 |
3ff5f22e2c6b9ba92ca03f83fb198f9c214a4be960222678c80d368d02821f71
|
File details
Details for the file aas_http_client-1.2.0-py3-none-any.whl.
File metadata
- Download URL: aas_http_client-1.2.0-py3-none-any.whl
- Upload date:
- Size: 41.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fb0f863b355135097e98e82e35ec93a8e97edadab33caf2a227cb0425ca5e258
|
|
| MD5 |
c9315367121d1efa00284f026c601185
|
|
| BLAKE2b-256 |
7f02c685333adf8742c48da6277371abf90c51ab21ce7057576d4b3de9906309
|
