From bbca72d77c5a80200962e8976a6713963ef376db Mon Sep 17 00:00:00 2001 From: Marc Jakobi Date: Thu, 28 May 2026 16:12:35 +0200 Subject: [PATCH] [DOC] Update outdated documentation: Edge.Websocket -> Edge.Manager --- doc/modules/ROOT/pages/gettingstarted.adoc | 14 +++++------ doc/modules/ROOT/pages/i18n/de.po | 24 +++++++++---------- doc/modules/ROOT/pages/i18n/translate.pot | 12 +++++----- .../Edge/{Websocket.config => Manager.config} | 2 +- 4 files changed, 26 insertions(+), 26 deletions(-) rename tools/gitpod/openems-backend/config.d/Edge/{Websocket.config => Manager.config} (76%) diff --git a/doc/modules/ROOT/pages/gettingstarted.adoc b/doc/modules/ROOT/pages/gettingstarted.adoc index d7bfa161cd2..afafe19f18c 100644 --- a/doc/modules/ROOT/pages/gettingstarted.adoc +++ b/doc/modules/ROOT/pages/gettingstarted.adoc @@ -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 + @@ -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[]]. @@ -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 + diff --git a/doc/modules/ROOT/pages/i18n/de.po b/doc/modules/ROOT/pages/i18n/de.po index 08c04c06326..875a063e3a0 100644 --- a/doc/modules/ROOT/pages/i18n/de.po +++ b/doc/modules/ROOT/pages/i18n/de.po @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/doc/modules/ROOT/pages/i18n/translate.pot b/doc/modules/ROOT/pages/i18n/translate.pot index ac8b4e9e2f9..fdd42831693 100644 --- a/doc/modules/ROOT/pages/i18n/translate.pot +++ b/doc/modules/ROOT/pages/i18n/translate.pot @@ -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 "" @@ -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 @@ -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 @@ -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 @@ -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 === diff --git a/tools/gitpod/openems-backend/config.d/Edge/Websocket.config b/tools/gitpod/openems-backend/config.d/Edge/Manager.config similarity index 76% rename from tools/gitpod/openems-backend/config.d/Edge/Websocket.config rename to tools/gitpod/openems-backend/config.d/Edge/Manager.config index add7f45c496..af3e4c63a80 100644 --- a/tools/gitpod/openems-backend/config.d/Edge/Websocket.config +++ b/tools/gitpod/openems-backend/config.d/Edge/Manager.config @@ -2,4 +2,4 @@ debugMode="OFF" poolSize=I"10" port=I"8081" -service.pid="Edge.Websocket" \ No newline at end of file +service.pid="Edge.Manager"