Struttura Gerarchica

Aurora Vision consente all’utente di identificare in modo univoco gli assets registrati (organization, portfolio, plant or device ) attraverso un numero sequenziale univoco, assegnato automaticamente, che prende il nome di EntityID (EID ).

Data la presenza di molteplici tipologie di assets, Aurora Vision definisce una struttura gerarchica che permette all’utente di identificare le risorse di interesse in modo semplice e veloce. Questa struttura si riflette direttamente nelle suites e nelle chiamate APIs offerte, al fine di fornire uno strumento che consenta di scalare dinamicamente la gerarchia partendo dalla semplice conoscenza di uno o più EntityIDs (EIDs ).

Diamo un’occhiata alla struttura gerarchica completa:

  • LVL 1 - ORGANIZATION: entità logica che identifica univocamente una Organization, che permette di gestire una flotta di portafogli;
  • LVL 2 - PORTFOLIO: entità logica che identifica univocamente un Portfolio, che permette di gestire una flotta di impianti;
  • LVL 3 - PLANT: entità logica che identifica univocamente un Plant (sempre contenuto in un portfolio), che permette di gestire e registrare i dispositivi compatibili;
  • LVL 4 - LOGGER: entità logica che identifica univocamente un Data Logger (esterno o embedded), che gestisce le funzioni di data logging e la comunicazione con Aurora Vision;
  • LVL 5 - DEVICE: entità logica che identifica univocamente un Device (eg: inverter, meter, batteria, stazione meteo, wallbox di ricarica , string combiners etc…) monitorati da un logger;

NOTA: l’esistenza di una Organization su Aurora Vision è attualmente limitata a casi d’uso specifici e può essere configurata solo dall’assistenza clienti FIMER

All’interno dell’offerta delle APIs esiste una suite che identifica ogni singolo livello gerarchico visto sopra ed, all’interno di ciascuna delle suites, c’è un’API che collega i livelli gerarchici e permette di scalare verso l’altro od il basso la gerarchia conoscendo l’ID entità del padre gerarchico.

Osservando lo schema gerarchico di seguito, diamo un’occhiata ad alcuni casi d’uso per capire meglio come ottenere informazioni sugli assets appartenenti a diversi livelli gerarchici:

Esempio di Schema Gerarchico

Caso d’Uso 1

Voglio conoscere l’EID del Portfolio 1 appartenente alla mia Organization. Per farlo, devo scalare dal LVL 1 al LVL 2 della gerarchia.

Organizations Suite
GET Portfolios in Organization

Consente di recuperare informazioni sull’organizzazione (PortfolioGroup) a cui l’utente è associato, insieme all’elenco dei portfolios attivi contenuti nell’organizzazione (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   ➜

Caso d’Uso 2

Voglio conoscere l’EID di Plant 1 appartenente al Portfolio 1. Per farlo, devo scalare dal LVL 2 al LVL 3 della gerarchia.

Portfolios Suite
GET Plants in Portfolio

Consente di recuperare l’elenco impaginato degli impianti in un portfolio. Per ogni impianto vengono forniti i dettagli principali quali: 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   ➜

Caso d’Uso 3

Voglio conoscere l’EID di Logger 1 appartenente a Plant 1. Per farlo, devo scalare dal LVL 3 al LVL 4 della gerarchia.

Plants Suite
GET Loggers in Plant

Consente di recuperare l’elenco dei logger in un impianto. Per ogni logger vengono forniti i dettagli principali quali: 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   ➜

Caso d’Uso 4

Voglio conoscere i dispositivi monitorati da Logger 1 registrato in Plant 1. Per farlo, devo scalare dal LVL 4 al LVL 5 della gerarchia.

Loggers Suite
GET List of Devices

Consente di recuperare l’elenco dei dispositivi monitorati da un logger, registrati in un impianto. Per ogni dispositivo vengono forniti i dettagli principali quali: 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   ➜