Skip to content

[Doc] Backend: document the Edge connection architecture (Backend.Edge.App)#3818

Merged
sfeilmeier merged 1 commit into
OpenEMS:developfrom
arindahills:pr/backend-architecture-docs
Jul 9, 2026
Merged

[Doc] Backend: document the Edge connection architecture (Backend.Edge.App)#3818
sfeilmeier merged 1 commit into
OpenEMS:developfrom
arindahills:pr/backend-architecture-docs

Conversation

@arindahills

Copy link
Copy Markdown
Contributor

The backend Architecture page was empty. This documents how an OpenEMS Edge connects to the Backend:

  • the Edge-facing endpoint was split out of the central Backend into its own scalable application, Backend.Edge.App;
  • an Edge always connects (via its unchanged Controller.Api.Backend) to a Backend.Edge.App, which relays to the central Edge.Manager;
  • deployment options: one or more Backend.Edge.App on separate servers, or a single one on the central server via localhost.

This follows up on the discussion in #3795, where this setup was noted as not yet documented. Happy to adjust the wording or add a diagram image if preferred.

…e.App)

The backend Architecture page was empty. Document how an OpenEMS Edge connects
to the Backend via the Backend.Edge.App: the Edge-facing endpoint was split out
of the central Backend into its own scalable application, so the Edge
Controller.Api.Backend connects to a Backend.Edge.App (deployed on separate
servers, or on the central server via localhost) which relays to the central
Edge.Manager. Follows up on the discussion in OpenEMS#3795.

Signed-off-by: arindahills <293051436+arindahills@users.noreply.github.com>

@sfeilmeier sfeilmeier left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, this is very helpful! 👍

@sfeilmeier
sfeilmeier merged commit 63e64e9 into OpenEMS:develop Jul 9, 2026
2 checks passed
@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop    #3818      +/-   ##
=============================================
- Coverage      60.48%   60.44%   -0.04%     
  Complexity       105      105              
=============================================
  Files           3456     3456              
  Lines         151072   151072              
  Branches       11528    11528              
=============================================
- Hits           91363    91300      -63     
- Misses         56265    56336      +71     
+ Partials        3444     3436       -8     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@tushabe
tushabe deleted the pr/backend-architecture-docs branch July 10, 2026 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants