Skip to main content

Generic python HTTP client for communication with various types of AAS servers

Project description

AAS HTTP Client

aas_http_client

License: em CI PyPI version

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.

Note: Each client instance is designed to communicate with a single AAS server at a time (1-to-1 mapping). To interact with multiple servers, create a separate client instance for each server.

Tested servers include:

The actual behavior of the client may vary depending on the specific server implementation and its level of compliance with the AAS specification. Supported endpoints and features depend on what each server provides.

In addition to the core HTTP client, this library offers wrapper modules for popular AAS frameworks. These wrappers use the HTTP client as middleware and expose SDK-specific data model classes for input and output, making integration with those frameworks seamless.

Currently available wrappers:

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

Documentation

🚀 Getting Started

🛠️ Configuration

📝 Changelog

Resources

🤖 Releases

📦 Pypi Packages

📜 em AG Software License

⚡ Quickstart

For a detailed introduction, please read Getting Started.

pip install aas-http-client

Client

from aas_http_client import create_client_by_url

client = create_client_by_url(
    base_url="http://myaasserver:5043/"
)

print(client.shell.get_shells())

BaSyx Python SDK Wrapper

from aas_http_client.wrapper.sdk_wrapper import create_wrapper_by_url

wrapper = create_wrapper_by_url(
    base_url="http://myaasserver:5043/"
)

print(wrapper.get_shells())

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aas_http_client-0.7.0.tar.gz (37.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aas_http_client-0.7.0-py3-none-any.whl (38.7 kB view details)

Uploaded Python 3

File details

Details for the file aas_http_client-0.7.0.tar.gz.

File metadata

  • Download URL: aas_http_client-0.7.0.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for aas_http_client-0.7.0.tar.gz
Algorithm Hash digest
SHA256 87f81dd5d4dfcb65d94c2c692982b396075ef8e19c77d49b3f5808b20f1795bd
MD5 8e9c71c7a516d408effa0f1be0caa0fb
BLAKE2b-256 a3986c2c93e0047cdef5f32acaf11ce2bad7d0988b5d7f8ae88948f17a5e673d

See more details on using hashes here.

File details

Details for the file aas_http_client-0.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aas_http_client-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c09ed59d6b61e350b9f620e52a07d2ec7637037eedd260c6e8189d2ec4100bf8
MD5 36cb262764bc79fcafc74d5b59aa8bc7
BLAKE2b-256 832d89e1feea3155db32f51eb8e1747e47a17d4f4ea95498959a763fc0b226e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page