Skip to content

Commit

Permalink
feat(README): add link to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianDue committed Dec 16, 2024
1 parent d260c7b commit c25b114
Showing 1 changed file with 29 additions and 29 deletions.
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,41 @@
# SWAP-IT Registry Module
The SWAP-IT Registry Module is a base module of the SWAP-IT Architecture (https://github.com/swap-it/demo-scenario). The module is supposed to map server of SWAP-Assets and thus,
make them available for process execution steps. Doing so, the Registry Module provides three main functionalities,
make them available for process execution steps. Doing so, the Registry Module provides three main functionalities,
which can be accessed through OPC UA Method calls:

1. **Register Asset:** The addition of an Asset to the Registry Module. The Data Values are mapped to the registry module and the
asset can be considered for process execution steps within the SWAP-IT Architecture.

2. **Unregister Asset:** The removal of an Asset from the Registry Module. The Data Values are no longer mapped to the registry module and the
asset cannot be considered for process execution steps within the SWAP-IT Architecture anymore.
1. **Register Asset:** The addition of an Asset to the Registry Module. The Data Values are mapped to the registry module and the
asset can be considered for process execution steps within the SWAP-IT Architecture.

2. **Unregister Asset:** The removal of an Asset from the Registry Module. The Data Values are no longer mapped to the registry module and the
asset cannot be considered for process execution steps within the SWAP-IT Architecture anymore.

3. **Filter Asset:** Provision of assets to the swap-it-execution-engine from a set of registered assets. The Filter Asset Method can
evaluate product capabilities and match them against asset capabilities.


<img src="documentation/source/images/registry_overview.png" alt="">


An extensive documentation or the SWAP-IT Registry Module can be found here: https://fraunhoferiosb.github.io/swap-it-registry-module
or build from the repository. Here, sphinx and the sphinx rtd theme are required. Both can be installed with:

pip install sphinx
pip install sphinx-rtd-theme

3. **Filter Asset:** Provision of assets to the swap-it-execution-engine from a set of registered assets. The Filter Asset Method can
evaluate product capabilities and match them against asset capabilities.

<p align="center">
<img src="documentation/source/images/registry_overview.png" alt="">
</p>
Build the documentation:

cd swap-it-registry-module
#html
sphinx-build -M html documentation/source/ documentation/build/html
#pdf
sphinx-build -b pdf documentation/source/ documentation/build/pdf/


## Dependencies
The SWAP-IT Regitry Module requires a locally installed version of the C-based OPC UA SDK open62541 (https://github.com/open62541/open62541) version 1.4.6,
The SWAP-IT Registry Module requires a locally installed version of the C-based OPC UA SDK open62541 (https://github.com/open62541/open62541) version 1.4.6,
as well as a locally installed version of the swap-it-open62541-server-template (https://github.com/FraunhoferIOSB/swap-it-open62541-server-template).

For the installation of the dependencies, see section Build the Registry-Module

## Build the Registry-Module:

Expand Down Expand Up @@ -58,7 +73,7 @@ The default URL of the registry module is: **opc.tcp://localhost:8000**
./swap-it-registry-module

## Related Projects
Since the SWAP-IT Regitry Module is part of the SWAP-IT Architecture, its application is linked to other SWAP-IT projects. Here are some other relevant repositories:
Since the SWAP-IT Registry Module is part of the SWAP-IT Architecture, its application is linked to other SWAP-IT projects. Here are some other relevant repositories:

- SWAP-IT Demo Scenario: https://github.com/swap-it/demo-scenario
- SWAP-IT open62541 server-template: https://github.com/FraunhoferIOSB/swap-it-open62541-server-template
Expand All @@ -67,18 +82,3 @@ Since the SWAP-IT Regitry Module is part of the SWAP-IT Architecture, its applic
- SWAP-IT Dashboard: https://github.com/iml130/swap-it-dashboard
- Common Information Model: https://github.com/FraunhoferIOSB/swap-it-common-information-model

## Build Documentation

To build the documentation, sphinx and the sphinx rtd theme are required. Both can be installed with:

pip install sphinx
pip install sphinx-rtd-theme


Build the documentation:

cd swap-it-registry-module
#html
sphinx-build -M html documentation/source/ documentation/build/html
#pdf
sphinx-build -b pdf documentation/source/ documentation/build/pdf/

0 comments on commit c25b114

Please sign in to comment.