DOCSEARCHbyAlgolia
Submit Docs

AzureDT WoDT Adapter Documentation

website·Indexed 29 days ago

https://web-of-digital-twins.github.io

Technical documentation and API reference for the AzureDT WoDT Adapter, featuring components such as AzureDTClientImpl, DslLoaderImpl, and SignalRDigitalTwinEventType for managing digital twin semantics, property mapping, and platform registration.

Tokens
93.5K
Snippets
734
Records
1.1K
Agent score
71%

What's inside AzureDT WoDT Adapter

  1. Overview of the Azure Digital Twins (ADT) HWoDT Adapter

    The HWoDT Framework provides a Kotlin-based middleware adapter that makes Azure Digital Twins (ADT) compliant with HWoDT ecosystems. It allows users to configure which ADT Digital Twins (DTs) to adapt and expose, reifies internal ADT graph relationships, and enables modeling relationships with external WoDT DTs. The adapter provides two primary interfaces: an HTTP-based API implementing HWoDT interaction patterns and a WebSocket-based DTKG observation endpoint.

  3. Overview of the WoDT Adapter package structure

    The WoDT Adapter is organized into several functional packages, separating API definitions from their implementations. Key packages include:

    • io.github.webbasedwodt: Core adapter logic.
    • io.github.webbasedwodt.common & .common.model: Shared utilities and data models.
    • io.github.webbasedwodt.config: Configuration loading logic.
    • io.github.webbasedwodt.ontology: Ontology and RDF-related models.
    • io.github.webbasedwodt.DTDManager (api/impl): Management of Digital Twin Definitions.
    • io.github.webbasedwodt.DTKGEngine (api/impl): Knowledge Graph engine logic.
    • io.github.webbasedwodt.PlatformManagementInterface (api/impl): Platform registration and management.
    • io.github.webbasedwodt.WoDTDigitalTwinInterface (api/impl): Web server and twin interface logic.
    • io.github.webbasedwodt.WoDTShadowingAdapter (api/impl): Shadowing adapter and configuration.

  4. Overview of PlatformKnowledgeGraphEngine

    The PlatformKnowledgeGraphEngine is a central component of the WoDT Digital Twins Platform Abstract Architecture. It extends both PlatformKnowledgeGraphEngineReader and PlatformKnowledgeGraphEngineWriter, providing a unified interface to manage the Platform Knowledge Graph, handle Digital Twin descriptions, and execute graph queries.
    interface PlatformKnowledgeGraphEngine : PlatformKnowledgeGraphEngineReader, PlatformKnowledgeGraphEngineWriter

  6. Represent RDF nodes using the RdfNode interface

    The RdfNode is a sealed interface used within the Digital Twin Knowledge Graph to model the concept of an RDF node. An RdfNode can represent any entity in the Knowledge Graph, specifically either an RDF Resource or an RDF Literal. The interface is extended by RdfLiteral and RdfResource.
    sealed interface RdfNode

  8. Notify the registration of a WoDT Digital Twin

    The sendRegistrationNotification method in the EcosystemManagementHttpClient class performs an HTTP request to notify an administrator about the registration of a WoDT Digital Twin. It requires the Digital Twin's URI as an identifier and returns a boolean indicating the success of the operation.
    abstract suspend fun sendRegistrationNotification(dtUri: String): Boolean

  9. Use WoDTDigitalTwinsObserverComponent to observe Digital Twins

    The WoDTDigitalTwinsObserverComponent is the implementation of the WoDTDigitalTwinsObserver component. It leverages a WoDTDigitalTwinsObserverWsClient to manage the observation of WoDT Digital Twins. It requires an EcosystemRegistryDeletionSignaler and a WoDTDigitalTwinsObserverWsClient during initialization.
    val observer = WoDTDigitalTwinsObserverComponent(
    ecosystemRegistry = ecosystemRegistryDeletionSignaler,
    wsClient = wodtDigitalTwinsObserverWsClient
)

  10. Manage Digital Twin registries with EcosystemRegistry

    The EcosystemRegistry interface models the Ecosystem Registry component of the Abstract Architecture. It extends three specialized interfaces:

    • EcosystemRegistryCatalog: Maintains the catalog of registered Digital Twins.
    • EcosystemRegistryMapper: Provides URI/URL mappings for WoDT Digital Twins.
    • EcosystemRegistryDeletionSignaler: A restricted client used specifically to signal the deletion of a Digital Twin.