Formule MiroxQL (riferimento API)

Una formula MiroxQL combina metriche giornaliere dell'esportazione legacy in una colonna calcolata, ad esempio un performance ratio a partire da un'energia e da un target.

MiroxQL o Metriche?

Route delle formule

Tutti i percorsi seguono https://service.mirox.io/api/v1/export/metric/formula. Le route richiedono un accesso oppure un token API del gruppo Full Access; un token Metric Export non le raggiunge. La lettura è aperta ai membri dell'organizzazione, la scrittura ai ruoli organizzativi Admin, Moderatore, Asset Manager (tecnico) e Asset Manager (commerciale).

Le formule fornite da Mirox non possono essere modificate né eliminate.

Campi di una formula

{
  "metric_id": "energy_total_incl_losses",
  "name": "Total Energy Including Losses",
  "description": "Sum of grid energy and all shutdown losses",
  "unit": "kWh",
  "scale": 0.001,
  "digits": 2,
  "formula": "@energy_grid_daily + @energy_shutdown_grid_daily + @energy_shutdown_external_daily",
  "calculation_level": "daily",
  "aggregation_method": "sum"
}

ID

Un ID deve essere libero. 409 metric_id_taken significa che una formula o una metrica della tua organizzazione, oppure una metrica di Mirox, ha già quell'ID. Questo vale anche quando modifichi una formula esistente il cui ID nel frattempo è stato occupato; disattivarla con active=false resta possibile.

Scala e cifre

Calcola nelle unità di base e converti con scale. Le metriche giornaliere vengono valutate nelle unità di base (Wh, W, Wh/m²), quindi una somma di energie con scale=0.001 viene esportata in kWh. scale e digits si applicano solo al valore esportato. Una formula che legge un'altra formula ne riceve il risultato non scalato e non arrotondato.

Livello di calcolo

Sintassi

Riferimenti

Una metrica si legge con @ e il suo ID. Gli ID sono gli ID di metrica legacy e gli ID di altre formule.

@energy_grid_daily
@gti_sensor_daily

Un valore della configurazione dell'impianto si legge con $ e il suo percorso:

GET /config-fields restituisce l'elenco attuale.

Operatori

Un confronto restituisce 1 o 0. Una divisione per zero restituisce 0. Una metrica senza dati conta come 0.

Le operazioni vengono valutate in questo ordine, dalla più alta: parentesi, funzioni, * / %, + -, < <= > >=, == !=, &&, ||.

Esempi

Resa specifica:

@energy_grid_daily / $park.peak_production_w

Irradiazione dal sensore, oppure dal modello meteo dove il sensore non ha un valore:

@gti_sensor_daily > 0 ? @gti_sensor_daily : @gti_weather_daily

Quota delle perdite per spegnimento:

(@energy_shutdown_grid_daily + @energy_shutdown_external_daily) / (@energy_grid_daily + @energy_shutdown_grid_daily + @energy_shutdown_external_daily) * 100

Regole

• Una formula legge almeno una metrica.
• Le parentesi sono bilanciate e due operatori non si susseguono, tranne !.
• Una formula non deve dipendere da se stessa, né direttamente né tramite altre formule.
• Una formula lavora su valori giornalieri. Non può leggere valori all'interno di un giorno e non può guardare indietro alle righe precedenti.

Spostare una formula nelle Metriche

Una formula e una metrica sono scritte in linguaggi diversi, quindi una formula viene riscritta, non convertita. Nella maggior parte dei casi la metrica è più breve, perché dice che cosa accade in un intervallo di 15 minuti e lascia il resto alla sua Aggregazione.

1. Apri Esportazione dati ▸ Glossario e fai clic su Nuova metrica.
2. Descrivi il valore all'assistente nell'editor, oppure scrivi tu l'espressione. Il pannello laterale elenca le serie da cui puoi partire.
3. Scegli l'Aggregazione che corrisponde alla formula:

4. Controlla l'anteprima su un impianto, poi usa la metrica in un report oppure esportala.

Il performance ratio, la produzione attesa e la resa specifica non richiedono una metrica tua. La raccolta li ha già: plant.pr_weather, plant.pr_pyranometer, plant.expected_weather, plant.expected_pyranometer, plant.specific_yield.

Funzionalità correlate

• Metriche — il successore: i valori che la tua organizzazione definisce da sé
• Metric Export — esporta le metriche a ogni passo
• API di esportazione legacy — i modelli e i link che valutano le formule
• Migrare al Metric Export — le colonne calcolate e i loro equivalenti
• Token API — un token Full Access per le route delle formule