Hierarchische Struktur

Aurora vision ermöglicht dem benutzer die eindeutige identifizierung der registrierten assets (organisation, portfolio, anlage oder gerät ) durch eine eindeutige fortlaufende nummer, die automatisch zugewiesen wird und den namen EntityID (EID ).

Angesichts des vorhandenseins mehrerer arten von assets definiert Aurora Vision eine hierarchische struktur, die es dem benutzer ermöglicht, die interessierenden ressourcen auf einfache und schnelle weise zu identifizieren. Diese struktur spiegelt sich direkt in den angebotenen suiten und API-Aufrufen wider, um ein werkzeug bereitzustellen, das es ermöglicht, die hierarchie ausgehend von der bloßen kenntnis einer oder mehrerer EntityIDs (EIDs ) dynamisch zu skalieren.

Lassen sie uns einen blick auf die komplette hierarchische struktur werfen:

  • LVL 1 - ORGANIZATION: logische entität, die eine Organization, eindeutig identifiziert, die es ermöglicht, eine vielzahl von portfolios zu verwalten;
  • LVL 2 - PORTFOLIO: logische entität, die eine Portfolio, eindeutig identifiziert, das die verwaltung einer flotte von anlagen ermöglicht;
  • LVL 3 - PLANT: logische entität, die eine Plant eindeutig identifiziert (immer in einem portfolio enthalten), wodurch kompatible geräte verwaltet und registriert werden können;
  • LVL 4 - LOGGER: logische entität, die eine Data Logger eindeutig identifiziert (extern oder eingebettet), eindeutig identifiziert, der die datenprotokollierungsfunktionen und die kommunikation mit Aurora Vision verwaltet;
  • LVL 5 - DEVICE: logische entität, die eine Device eindeutig identifiziert (eg: wechselrichter, messgerät, batterie, wetterstation, wallbox mit ladefunktion, string combiners etc…) von einem logger überwacht;

HINWEIS: das vorhandensein einer Organization auf Aurora Vision ist derzeit auf bestimmte anwendungsfälle beschränkt und kann nur vom FIMER-Kundensupport konfiguriert werden

Innerhalb des angebots der APIs gibt es eine Suite, die jede einzelne oben gezeigte hierarchische ebene identifiziert, und innerhalb jeder der suiten gibt es eine API, die die hierarchischen ebenen verbindet und ihnen eine skalierung nach oben oder nach unten ermöglicht der hierarchie durch kenntnis der Entitäts-ID des hierarchischen elternteils.

Lassen sie uns unter beachtung des hierarchischen schemas unten einen blick auf einige anwendungsfälle werfen, um besser zu verstehen, wie man informationen zu assets erhält, die zu verschiedenen hierarchieebenen gehören::

Beispiel für ein Hierarchisches Schema

Anwendungsfall 1

Ich möchte die EID von Portfolio 1 wissen, das zu meiner Organization. Dazu muss ich die hierarchie von LVL 1 auf LVL 2 herunterskalieren.

Organizations Suite
GET Portfolios in Organization

Ermöglicht das abrufen von informationen über die Organisation (PortfolioGroup) der benutzer zugeordnet ist, zusammen mit der liste der aktiven Portfolios, die in der Organisation (portfolioGroupPortfolios).

Request

GET   https://api.auroravision.net/api/rest/v1/portfolioGroup

Path

//

Header

X-AuroraVision-Token

Query

//

Curl

curl --request GET https://api.auroravision.net/api/rest/v1/portfolioGroup --header "X-AuroraVision-Token: 1/?abcde==2fgh/+3lmn4JoPqrSTuv"

OpenAPIs Swagger   ➜

Anwendungsfall 2

Ich möchte die EID von Plant 1 wissen, die zu Portfolio 1. Dazu muss ich die hierarchie von LVL 2 auf LVL 3 herunterskalieren.

Portfolios Suite
GET Plants in Portfolio

Ermöglicht das abrufen der paginierten liste der pflanzen in einem portfolio. Für jede anlage werden die wichtigsten details bereitgestellt, wie zum beispel: plantEntityID, plantName, plantDescription, plantState, plantStatus.

Request

GET   https://api.auroravision.net/api/rest/v1/portfolio/{entityID}/plants

Path

Portfolio entityID

Header

X-AuroraVision-Token

Query

page

Curl

curl --request GET https://api.auroravision.net/api/rest/v1/portfolio/123456/plants?page=0 --header "X-AuroraVision-Token: 1/?abcde==2fgh/+3lmn4JoPqrSTuv"

OpenAPIs Swagger   ➜

Anwendungsfall 3

Ich möchte die EID von Logger 1 wissen, der zur überwachten Plant 1. Dazu muss ich die hierarchie von LVL 3 auf LVL 4 herunterskalieren.

Plants Suite
GET Loggers in Plant

Ermöglicht das abrufen der liste der logger in einer anlage. Für jeden logger werden die wichtigsten details bereitgestellt, wie zum beispiel: loggerEntityID, loggerName, loggerDescription, loggerState, loggerMACAddress, loggerModel.

Request

GET   https://api.auroravision.net/api/rest/v1/plant/{entityID}/loggers

Path

entityID

Header

X-AuroraVision-Token

Query

//

Curl

curl --reqest GET https://api.auroravision.net/api/rest/v1/plant/123456/loggers --header "X-AuroraVision-Token: 1/?abcde==2fgh/+3lmn4JoPqrSTuv"

OpenAPIs Swagger   ➜

Anwendungsfall 4

Ich möchte wissen, welche geräte von Logger 1 unter Plant 1. Dazu muss ich die hierarchie von LVL 4 auf LVL 5 herunterskalieren.

Loggers Suite
GET List of Devices

Ermöglicht das abrufen der liste der von einem logger überwachten geräte, die in einer anlage registriert sind. Für jedes gerät werden die wichtigsten details bereitgestellt wie zum beispel: deviceEntityID, deviceCategory, deviceName, deviceDescription, deviceState, deviceModel, deviceFWVersion, deviceFirstReporteDate.

Request

GET   https://api.auroravision.net/api/rest/v1/logger/{entityID}/devices

Path

entityID

Header

X-AuroraVision-Token

Query

//

Curl

curl --request GET https://api.auroravision.net/api/rest/v1/loggers/123456/devices --header "X-AuroraVision-Token: 1/?abcde==2fgh/+3lmn4JoPqrSTuv"

OpenAPIs Swagger   ➜