Hierarchikus Struktúra

Az Aurora Vision lehetővé teszi a felhasználó számára, hogy egyedileg azonosítsa a regisztrált eszközöket (szervezet, portfólió, üzem vagy eszköz ) egy egyedi, automatikusan hozzárendelt sorszámon keresztül, amely az EntityID (EID ).

Tekintettel a többféle típusú eszköz jelenlétére, az Aurora Vision egy hierarchikus struktúrát határoz meg, amely lehetővé teszi a felhasználó számára, hogy egyszerű és gyors módon azonosítsa az érdeklődésre számot tartó erőforrásokat. Ez a struktúra közvetlenül tükröződik a kínált csomagokban és API-hívásokban, hogy olyan eszközt biztosítson, amely lehetővé teszi a hierarchia dinamikus skálázását egy vagy több EntityID (EIDs ) puszta ismeretéből kiindulva.

Nézzük meg a teljes hierarchikus struktúrát:

  • LVL 1 - ORGANIZATION: logikai entitás, amely egyedileg azonosít egy Organization, amely lehetővé teszi portfóliók flottájának kezelését;
  • LVL 2 - PORTFOLIO: logikai entitás, amely egyedileg azonosít egy Portfolio, amely lehetővé teszi egy üzemflotta kezelését;
  • LVL 3 - PLANT: logikai entitás, amely egyedileg azonosít egy Plant (mindig egy portfólióban található), amely lehetővé teszi a kompatibilis eszközök kezelését és regisztrálását;
  • LVL 4 - LOGGER: logikai entitás, amely egyedileg azonosít egy Data Logger (külső vagy beágyazott), amely kezeli az adatnaplózási funkciókat és az Aurora Vision való kommunikációt;
  • LVL 5 - DEVICE: logikai entitás, amely egyedileg azonosít egy Device (eg: inverter, mérő, akkumulátor, időjárás-állomás, töltő fali doboz , string combiners etc…) egy naplózó figyeli;

MEGJEGYZÉS: Az Aurora Vision Organization léte jelenleg csak bizonyos felhasználási esetekre korlátozódik, és csak a FIMER ügyfélszolgálata konfigurálhatja

Az API-k kínálatában található egy programcsomag, amely azonosítja a fent látható minden egyes hierarchikus szintet, és az egyes csomagokon belül van egy API, amely összeköti a hierarchikus szinteket, és lehetővé teszi a fel- vagy lekicsinyítést. a hierarchia a hierarchikus szülő entitásazonosítójának ismeretében.

Az alábbi hierarchikus sémát figyelve vessünk egy pillantást néhány használati esetre, hogy jobban megértsük, hogyan szerezhetünk információkat a különböző hierarchiaszintekhez tartozó eszközökről:

Példa Hierarchikus Séma

Használati Eset 1

Szeretném tudni a Portfolio 1 tartozó Organization EID-jét. Ehhez csökkentenem kell a hierarchia LVL 1 értékét LVL 2 értékre.

Organizations Suite
GET Portfolios in Organization

Lehetővé teszi a felhasználóhoz társított Organization (PortfolioGroup) kapcsolatos információk lekérését, valamint az aktív portfóliók listáját, amelyet a Organization (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   ➜

Használati Eset 2

Szeretném tudni a Plant 1 tartozó Portfolio 1. Ehhez csökkentenem kell a hierarchia LVL 2 értékét LVL 3 értékét.

Portfolios Suite
GET Plants in Portfolio

Lehetővé teszi a portfólióban lévő növények lapszámozott listájának lekérését. Az egyes növények főbb részleteit megadják, például: 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   ➜

Használati Eset 3

Szeretném tudni a Logger 1 hez tartozó Plant 1 EID-jét. Ehhez csökkentenem kell a hierarchia LVL 3 értékét LVL 4 értékét.

Plants Suite
GET Loggers in Plant

Lehetővé teszi az üzemben lévő naplózók listájának lekérését. Minden egyes naplózóhoz megadják a fő részleteket, például: 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   ➜

UHasználati Eset 4

Szeretném tudni, hogy az Logger 1 alatti Plant 1 által felügyelt eszközök. Ehhez csökkentenem kell a hierarchia LVL 4 értékét LVL 5 értékét.

Loggers Suite
GET List of Devices

Lehetővé teszi a naplózó által felügyelt, üzemben regisztrált eszközök listájának lekérését. Az egyes eszközök főbb részleteit megadják, például: 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   ➜