Fórmulas MiroxQL (referência da API)

Uma fórmula MiroxQL combina métricas diárias da exportação legada numa coluna calculada, por exemplo um performance ratio a partir de uma energia e de uma meta.

MiroxQL ou Métricas?

Rotas de fórmulas

Todos os caminhos são relativos a https://service.mirox.io/api/v1/export/metric/formula. As rotas requerem uma sessão iniciada ou um token de API do grupo Acesso total; um token Metric Export não lhes chega. A leitura está aberta aos membros da organização, a escrita às funções de organização Administrador, Moderador, Gestor de ativos (técnico) e Gestor de ativos (comercial).

As fórmulas que o Mirox fornece não podem ser alteradas nem eliminadas.

Campos de uma fórmula

{
  "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"
}

IDs

Um ID tem de estar livre. 409 metric_id_taken significa que uma fórmula ou uma métrica da sua organização, ou uma métrica do Mirox, já tem esse ID. Isto aplica-se também quando altera uma fórmula existente cujo ID foi entretanto ocupado; desativá-la com active=false continua a ser possível.

Escala e casas decimais

Calcule em unidades base e converta com scale. As métricas diárias são avaliadas em unidades base (Wh, W, Wh/m²), pelo que uma soma de energias com scale=0.001 é exportada em kWh. scale e digits aplicam-se apenas ao valor exportado. Uma fórmula que lê outra fórmula recebe o resultado desta sem escala e sem arredondamento.

Nível de cálculo

Sintaxe

Referências

Uma métrica é lida com @ e o seu ID. Os IDs são os IDs de métricas legadas e os IDs de outras fórmulas.

@energy_grid_daily
@gti_sensor_daily

Um valor da configuração da central é lido com $ e o seu caminho:

GET /config-fields responde com a lista atual.

Operadores

Uma comparação responde 1 ou 0. Uma divisão por zero responde 0. Uma métrica sem dados conta como 0.

As operações são avaliadas por esta ordem, da prioridade mais alta para a mais baixa: parênteses, funções, * / %, + -, < <= > >=, == !=, &&, ||.

Exemplos

Produção específica:

@energy_grid_daily / $park.peak_production_w

Irradiação do sensor, ou do modelo meteorológico quando o sensor não tem valor:

@gti_sensor_daily > 0 ? @gti_sensor_daily : @gti_weather_daily

Proporção das perdas por corte:

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

Regras

• Uma fórmula lê pelo menos uma métrica.
• Os parênteses estão equilibrados, e dois operadores não se seguem um ao outro, exceto !.
• Uma fórmula não pode depender de si própria, diretamente ou através de outras fórmulas.
• Uma fórmula trabalha sobre valores diários. Não pode ler valores dentro de um dia, nem recuar a linhas anteriores.

Passar uma fórmula para Métricas

Uma fórmula e uma métrica são escritas em linguagens diferentes, pelo que uma fórmula é reescrita, não convertida. Na maioria dos casos a métrica é mais curta, porque indica o que acontece num intervalo de 15 minutos e deixa o resto à sua Agregação.

1. Abra Exportação de dados ▸ Glossário e clique em Nova métrica.
2. Descreva o indicador ao assistente no editor, ou escreva a expressão por si. O painel lateral lista as séries a partir das quais pode construir.
3. Escolha a Agregação que corresponde à fórmula:

4. Verifique a pré-visualização numa central e depois use a métrica num relatório ou exporte-a.

O performance ratio, a produção esperada e a produção específica não precisam de uma métrica sua. A coleção tem-nos: plant.pr_weather, plant.pr_pyranometer, plant.expected_weather, plant.expected_pyranometer, plant.specific_yield.

Funcionalidades relacionadas

• Métricas — o sucessor: indicadores que a sua organização define por si
• Exportação de métricas — exportar métricas em qualquer passo
• API de exportação legada — os modelos e as ligações que avaliam fórmulas
• Migrar para a exportação de métricas — as colunas calculadas e os seus equivalentes
• Tokens de API — um token Acesso total para as rotas de fórmulas