From 1f4241f01788e319a8feede9b36b9b008f01e39e Mon Sep 17 00:00:00 2001 From: Nora Kristiansen <106915799+NoraKri@users.noreply.github.com> Date: Thu, 12 Dec 2024 15:19:14 +0100 Subject: [PATCH] Update README with info on how to run multiple comm.pckg frontend --- www/README.md | 57 +++++++++++++++++++++++++++------------------------ 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/www/README.md b/www/README.md index d6dd361..cf1f309 100644 --- a/www/README.md +++ b/www/README.md @@ -1,28 +1,31 @@ -# Select boundary in browser +# Commissioning Package creation in browser -1) Run the dexpi.rdfox script, the documentation for this script is found [here](../rdfox/README.md) -2) Run the frontend as described in [RunGuide.md](./RunGuide.md) -3) Select the boundary points and an internal component - - shift+left click to select or deselect the internal component - 1) If the node is not a member of the internal class: - - Add the node to the internal class to indicate that it is selected - - Update rdfox with the following triple :nodeId a :insideBoundary . - 2) If the node is a member of the internal class: - - Remove the node from the internal class to indicate that it is deselected - - Update rdfox, delete the following triple :nodeId a :insideBoundary . - 3) If the node is not a member of the internal class, but is a member of the boundary class: - - Add the node to the internal class, and remove it from the boundary class. - - Update rdfox, insert the following triple :nodeId a :insideBoundary . - - Update rdfox, delete the following triple :nodeId a :boundary . - - Left click to select or deselect boundary nodes - 1) If the node is not a member of the boundary class: - - Add the node to the boundary class to indicate that it is selected - - Update rdfox with the following triple :nodeId a :boundary . - 2) If the node is a member of the boundary class: - - Remove the node from the boundary class to indicate that it is deselected - - Update rdfox, delete the following triple :nodeId a :boundary . - 3) If the node is not a member of the boundary class, but is a member of the internal class: - - Add the node to the boundary class, and remove it from the internal class. - - Update rdfox, insert the following triple :nodeId a :boundary . - - Update rdfox, delete the following triple :nodeId a :insideBoundary . -4) Hit enter to query RDFox for the boundary - the output of the query can be found in the logs. \ No newline at end of file +1) Run docker. [See the Docker README for instructions.](../docker/README.md) +2) React frontend will now run on http://localhost:8081/ +3) Use the *Select Boundaries* tool from the tool selector on the left to set boundaries for your commissioning package. Click again to deselect. + 1) If the selected node is not already a boundary: + - Add the node as a boundary + - Update rdfox with the following triple :nodeId a :boundary . + 2) If the selected node is already a boundary: + - Remove the node as a boundary + - Update rdfox, delete the following triple :nodeId a :boundary . + 3) If the selected node is not a boundary, but is an internal node: + - Remove the node as an internal node, then add it as a boundary node. + - Update rdfox, insert the following triple :nodeId a :boundary . + - Update rdfox, delete the following triple :nodeId a :insideBoundary . +4) Use the *Select Inside of Boundary* tool to select the inside of your boundary. Click again to deselect. + 1) If the selected node is not an internal node: + - Add the node as an internal node. + - Update rdfox with the following triple :nodeId a :insideBoundary . + 2) If the node is an internal node: + - Remove the node as an internal node. + - Update rdfox, delete the following triple :nodeId a :insideBoundary . + 3) If the selected node is not an internal node, but is a boundary node: + - Remove the node as a boundary. + - Add the node as an internal node. + - Update rdfox, insert the following triple :nodeId a :insideBoundary . + - Update rdfox, delete the following triple :nodeId a :boundary . +5) Use the *Create new Commissioning Package* button to open the commissioning package creation window. Define a display name, ID and color for your package. + - All package IDs are automatically prefixed with "asset:". +6) Define boundaries and internals for the new package as you did with the first package. +7) Switch between packages by using the *Commissioning Packages* dropdown. The packages are labeled with their display name. Your active package is displayed in the top bar. \ No newline at end of file