Skip to content

[DOC] Update outdated documentation: Edge.Websocket -> Edge.Manager #3748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mrcjkb wants to merge 1 commit into
base: develop
Choose a base branch
from
+26 −26
Open

[DOC] Update outdated documentation: Edge.Websocket -> Edge.Manager #3748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/modules/ROOT/pages/gettingstarted.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,14 +223,14 @@ NOTE: Apache Felix Web Console for OpenEMS Backend is started on port 8079 by de
+
Login with username *admin* and password *admin*.

. Configure Edge.Websocket
. Configure Edge.Manager
+
NOTE: The _**Edge.Websocket**_ service is responsible for the communication between OpenEMS Backend and OpenEMS Edge.
NOTE: The _**Edge.Manager**_ service is responsible for the communication between OpenEMS Backend and OpenEMS Edge.
+
In the example we are configuring the `Port '8081'`. This port needs to match with what we configure later in OpenEMS Edge. The `Debug Mode 'DETAILED'` setting helps us to get some more details on the internal behaviour.
+
.Configuration of Backend Edge.Websocket
image::config-backend-edge.websocket.png[Configuration of Backend Edge.Websocket]
.Configuration of Backend Edge.Manager
image::config-backend-edge.websocket.png[Configuration of Backend Edge.Manager]

. Configure Ui.Websocket
+
Expand Down Expand Up @@ -266,12 +266,12 @@ You should have seen some important log messages by now, that indicate that the
INFO [d.timedata.dummy.TimedataDummy] [Timedata.Dummy] Activate
INFO [d.metadata.dummy.MetadataDummy] [Metadata.Dummy] Activate
INFO [socket.AbstractWebsocketServer] [Ui.Websocket] Starting websocket server [port=8082]
INFO [socket.AbstractWebsocketServer] [Edge.Websocket] Starting websocket server [port=8081]
INFO [socket.AbstractWebsocketServer] [Edge.Manager] Starting websocket server [port=8081]
```

=== Configure OpenEMS Edge

Next we will configure OpenEMS Edge to connect to the OpenEMS Backend _**Edge.Websocket**_ service.
Next we will configure OpenEMS Edge to connect to the OpenEMS Backend _**Edge.Manager**_ service.

. Switch back to the http://localhost:8080/system/console/configMgr[Apache Felix Web Console Configuration for OpenEMS Edge icon:external-link[]].

Expand All @@ -283,7 +283,7 @@ image::config-controller-api-backend.png[Configuration of Controller Api Backend
Some configuration parameters are still noteworthy here:
+
.. _Apikey_ is used to authenticate this Edge at the Backend Metadata service. It has to be unique for each Edge.
.. _Uri_ is set to `ws://localhost:8081`. This defines an unencrypted websocket (`ws://`) connection to the local computer on port `8081` like we configured before for the _**Edge.Websocket**_. For a production setup you would want to use a TLS encrypted websocket with a `wss://` uri.
.. _Uri_ is set to `ws://localhost:8081`. This defines an unencrypted websocket (`ws://`) connection to the local computer on port `8081` like we configured before for the _**Edge.Manager**_. For a production setup you would want to use a TLS encrypted websocket with a `wss://` uri.
+
Once you press btn:[save] you should see logs in OpenEMS Edge
+
Expand Down
24 changes: 12 additions & 12 deletions doc/modules/ROOT/pages/i18n/de.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5090,13 +5090,13 @@ msgstr "apache-felix-console-backend-configuration.png"

#. type: Plain text
#: gettingstarted.adoc:263
msgid "Configure Edge.Websocket"
msgstr "Edge.Websocket konfigurieren"
msgid "Configure Edge.Manager"
msgstr "Edge.Manager konfigurieren"

#. type: Plain text
#: gettingstarted.adoc:265
msgid "The *Edge.Websocket* service is responsible for the communication between OpenEMS Backend and OpenEMS Edge."
msgstr "Der * Edge.Websocket *-Service ist für die Kommunikation zwischen OpenEMS Backend und OpenEMS Edge verantwortlich."
msgid "The *Edge.Manager* service is responsible for the communication between OpenEMS Backend and OpenEMS Edge."
msgstr "Der * Edge.Manager *-Service ist für die Kommunikation zwischen OpenEMS Backend und OpenEMS Edge verantwortlich."

#. type: Plain text
#: gettingstarted.adoc:267
Expand All @@ -5106,8 +5106,8 @@ msgstr "In dem Beispiel konfigurieren wir den Port 8081. Dieser Port muss mit de
#. type: Block title
#: gettingstarted.adoc:268
#, no-wrap
msgid "Configuration of Backend Edge.Websocket"
msgstr "Konfiguration von Backend Edge.Websocket"
msgid "Configuration of Backend Edge.Manager"
msgstr "Konfiguration von Backend Edge.Manager"

#. type: Target for macro image
#: gettingstarted.adoc:269
Expand Down Expand Up @@ -5204,8 +5204,8 @@ msgstr "OpenEMS Edge"

#. type: Plain text
#: gettingstarted.adoc:301
msgid "Next we will configure OpenEMS Edge to connect to the OpenEMS Backend `Edge.Websocket` service."
msgstr "Als nächstes werden wir OpenEMS Edge konfigurieren, um uns mit dem OpenEMS-Backend ' Edge.Websocket ' zu verbinden."
msgid "Next we will configure OpenEMS Edge to connect to the OpenEMS Backend `Edge.Manager` service."
msgstr "Als nächstes werden wir OpenEMS Edge konfigurieren, um uns mit dem OpenEMS-Backend ' Edge.Manager ' zu verbinden."

#. type: Plain text
#: gettingstarted.adoc:303
Expand Down Expand Up @@ -5241,8 +5241,8 @@ msgstr "\"Apikey\" wird verwendet, um diesen Edge im Backend Metadata-Dienst zu

#. type: Plain text
#: gettingstarted.adoc:313
msgid "\"Uri\" is set to `ws://localhost:8081`. This defines an unencrypted websocket (\"ws://\") connection to the local computer on port \"8081\" like we configured before for the Edge.Websocket."
msgstr "\"Uri\" ist auf ' ws://localhost:8081 ' gesetzt. Damit wird eine unverschlüsselte Websocket (\"ws://\")-Verbindung zum lokalen Computer auf Port \"8081\" definiert, wie wir sie zuvor für den Edge.Websocket konfiguriert haben."
msgid "\"Uri\" is set to `ws://localhost:8081`. This defines an unencrypted websocket (\"ws://\") connection to the local computer on port \"8081\" like we configured before for the Edge.Manager."
msgstr "\"Uri\" ist auf ' ws://localhost:8081 ' gesetzt. Damit wird eine unverschlüsselte Websocket (\"ws://\")-Verbindung zum lokalen Computer auf Port \"8081\" definiert, wie wir sie zuvor für den Edge.Manager konfiguriert haben."

#. type: Plain text
#: gettingstarted.adoc:314
Expand All @@ -5266,8 +5266,8 @@ msgstr "**OpenEMS Edge** läuft vor Ort und steuert die lokalen Geräte"

#. type: Plain text
#: gettingstarted.adoc:322
msgid "`[Edge.Websocket] Edge [edge0] connected`"
msgstr "' [Edge.Websocket] Edge [edge0] connected '"
msgid "`[Edge.Manager] Edge [edge0] connected`"
msgstr "' [Edge.Manager] Edge [edge0] connected '"

#. type: Title ===
#: gettingstarted.adoc:323
Expand Down
12 changes: 6 additions & 6 deletions doc/modules/ROOT/pages/i18n/translate.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5714,13 +5714,13 @@ msgstr ""

#. type: Plain text
#: gettingstarted.adoc:263
msgid "Configure Edge.Websocket"
msgid "Configure Edge.Manager"
msgstr ""

#. type: Plain text
#: gettingstarted.adoc:265
msgid ""
"The *Edge.Websocket* service is responsible for the communication between "
"The *Edge.Manager* service is responsible for the communication between "
"OpenEMS Backend and OpenEMS Edge."
msgstr ""

Expand All @@ -5734,7 +5734,7 @@ msgstr ""
#. type: Block title
#: gettingstarted.adoc:268
#, no-wrap
msgid "Configuration of Backend Edge.Websocket"
msgid "Configuration of Backend Edge.Manager"
msgstr ""

#. type: Target for macro image
Expand Down Expand Up @@ -5849,7 +5849,7 @@ msgstr ""
#: gettingstarted.adoc:301
msgid ""
"Next we will configure OpenEMS Edge to connect to the OpenEMS Backend "
"`Edge.Websocket` service."
"`Edge.Manager` service."
msgstr ""

#. type: Plain text
Expand Down Expand Up @@ -5895,7 +5895,7 @@ msgstr ""
msgid ""
"\"Uri\" is set to `ws://localhost:8081`. This defines an unencrypted "
"websocket (\"ws://\") connection to the local computer on port \"8081\" like "
"we configured before for the Edge.Websocket."
"we configured before for the Edge.Manager."
msgstr ""

#. type: Plain text
Expand All @@ -5920,7 +5920,7 @@ msgstr ""

#. type: Plain text
#: gettingstarted.adoc:322
msgid "`[Edge.Websocket] Edge [edge0] connected`"
msgid "`[Edge.Manager] Edge [edge0] connected`"
msgstr ""

#. type: Title ===
Expand Down
2 changes: 1 addition & 1 deletion ...ms-backend/config.d/Edge/Websocket.config → ...nems-backend/config.d/Edge/Manager.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
debugMode="OFF"
poolSize=I"10"
port=I"8081"
service.pid="Edge.Websocket"
service.pid="Edge.Manager"