discovery_standalone

Eclipse BaSyx Python SDK - Discovery Service

This is a Python-based implementation of the BaSyx Asset Administration Shell (AAS) Discovery Service. It provides basic discovery functionality for AAS IDs and their corresponding assets, as specified in the official Discovery Service Specification v3.1.1_SSP-001.

Overview

The Discovery Service stores and retrieves relations between AAS identifiers and asset identifiers. It acts as a lookup service for resolving asset-related queries to corresponding AAS.

Features

Function	Description	Example URL
get_description	Return the supported Discovery Service profiles	GET http://localhost:8084/api/v3.1/description
get_all_aas_ids_by_asset_link	Find AAS identifiers by asset link query parameter	GET http://localhost:8084/api/v3.1/lookup/shells?assetIds={assetIds}
search_all_aas_ids_by_asset_link	Find AAS identifiers by providing asset link values	POST http://localhost:8084/api/v3.1/lookup/shellsByAssetLink
get_all_specific_asset_ids_by_aas_id	Return specific asset ids associated with an AAS ID	GET http://localhost:8084/api/v3.1/lookup/shells/{aasIdentifier}
post_all_asset_links_by_id	Register specific asset ids linked to an AAS	POST http://localhost:8084/api/v3.1/lookup/shells/{aasIdentifier}
delete_all_asset_links_by_id	Delete all asset links associated with a specific AAS ID	DELETE http://localhost:8084/api/v3.1/lookup/shells/{aasIdentifier}

Configuration

The example Docker compose configuration compose.dev.yml builds a discovery server locally. This is usually only necessary for development:

$ docker compose -f compose.dev.yml up

To just run the discovery server, use the pre-built image eclipsebasyx/basyx-python-discovery:latest on DockerHub.

Persistence

The discovery service can run in persistent or non-persistent mode.

Persistent Mode

Persistent mode configuration is provided in the compose.dev.yml.

Only the AAS-to-asset-ID mapping is persisted. The reverse lookup index is rebuilt in memory when the service starts.

Non-Persistent Mode

If storage_path is not set, the discovery service runs in memory only.

Notes

• Stop the service before manually editing discovery_store.json.
• Note that the image is built from the server directory. The local sdk directory is passed in as an additional build context named sdk. To include the package license, a second additional build context license passes in the repository root.