MQTT-datacommando’s#

Commando’s waarmee externe programma’s gegevens in GbbOptimizer kunnen wijzigen. Elk commando stuurt data naar een speciaal topic en ontvangt het resultaat op {PlantId}/ha_gbb/api/result.

Commandoresultaat#

PUB {PlantId}/ha_gbb/api/result

Resultaat van elk datacommando — OK of foutbeschrijving

Veld	Type	Beschrijving
`OrderId`	string?	Gekopieerd uit de request
`Result`	string	`"OK"` of foutbeschrijving
`Data`	object	Gegevens uit de oorspronkelijke request

SetManualPrices Handmatige energieprijzen instellen

{PlantId}/ha_gbb/api/setmanualprices

Veld		Type	Vereist	Beschrijving
`OrderId`		string	nee	Tekst die naar het antwoord wordt gekopieerd
`Data`		array	ja
	`Date`	date	ja	Datum van de prijs
	`StartHour`	int (0-23)	ja	Beginuur
	`StartMinute`	int (0-59)	nee	Minuut (standaard 0)
	`PurchasePrice`	decimal	nee	Inkoopprijs
	`TransferPrice`	decimal	nee	Transportprijs
	`SalePrice`	decimal	nee	Verkoopprijs

Voorbeeld:

1
2
3
4
5
{
  "Data": [
    {"Date": "2024-04-20", "StartHour": 20, "PurchasePrice": 0.23}
  ]
}

SetExtraLoads Extra verbruik instellen

{PlantId}/ha_gbb/api/setextraloads

Veld		Type	Vereist	Beschrijving
`OrderId`		string	nee	Tekst die naar het antwoord wordt gekopieerd
`Data`		array	ja
	`Date`	date	ja	Datum (vandaag of morgen)
	`StartHour`	int (0-23)	ja	Uur
	`StartMinute`	int (0-59)	nee	Minuut (standaard 0)
	`TypeNo`	int	ja	0=EV, 1=Warmtepomp, 2=Andere1, 3=Andere2, …, 7=Andere6
	`ExtraLoads_kWh`	decimal	ja	kWh

Voorbeeld:

1
2
3
4
5
{
  "Data": [
    {"Date": "2024-04-20", "StartHour": 20, "TypeNo": 1, "ExtraLoads_kWh": 1.23}
  ]
}

SetRealTemperature Werkelijke temperatuur instellen

{PlantId}/ha_gbb/api/setrealtemperature

Veld		Type	Vereist	Beschrijving
`OrderId`		string	nee	Tekst die naar het antwoord wordt gekopieerd
`Data`		array	ja
	`Date`	date	ja	Datum (gisteren, vandaag of morgen). Zonder `Hour` — uur uit de datum
	`Hour`	int (0-23)	nee	Uur van de temperatuur
	`RealTemperature`	decimal	ja	Temperatuur (°C)

Voorbeeld:

1
2
3
4
5
{
  "Data": [
    {"Date": "2024-04-20", "Hour": 20, "RealTemperature": 1.23}
  ]
}

SetOptimizer Optimizer-parameters instellen

{PlantId}/ha_gbb/api/setoptimizer

Veld		Type	Vereist	Beschrijving
`OrderId`		string	nee	Tekst die naar het antwoord wordt gekopieerd
`Data`		object	ja
	`Opt2_3x100Request`	int	nee	0 of 1 — 3h×100% forceren
	`CurrentLoadProfileId`	int	nee	ID van het verbruiksprofiel
	`CurrentLoadProfileName`	string	nee	Naam van het verbruiksprofiel (niet hoofdlettergevoelig)

Voorbeeld:

1
{"Data": {"Opt2_3x100Request": 1}}

SetCar Parameters van een EV instellen

{PlantId}/ha_gbb/api/setcar

De auto „HomeAssistant EV Car" moet eerst in het programma worden toegevoegd. Alleen de opgegeven parameters worden gewijzigd — maar het programma vereist actuele waarden voor: SOC, SOC_ChargeLimit, IsConnected, IsCharging, Position_Longitude, Position_Latitude.

Veld		Type	Vereist	Beschrijving
`OrderId`		string	nee	Tekst die naar het antwoord wordt gekopieerd
`Data`		array	ja	Meerdere auto’s kunnen worden bijgewerkt
	`VIN`	string	ja	Identificatiesleutel. Nieuwe VIN = nieuwe auto (max. 10)
	`BatteryKWh`	decimal	nee	Accucapaciteit van de auto
	`ChargeA`	decimal	nee	Standaard laadstroom (A)
	`Phases`	int	nee	1 of 3 fases
	`SOC`	int	nee	Huidige SOC
	`SOC_ChargeLimit`	int	nee	Doel-SOC
	`InService`	bool	nee	Of de auto in onderhoud is
	`IsConnected`	bool	nee	Of aangesloten op de lader
	`IsCharging`	bool	nee	Of momenteel aan het laden
	`Position_Longitude`	double	nee	Lengtegraad
	`Position_Latitude`	double	nee	Breedtegraad

Voorbeeld:

1
2
3
4
5
{
  "Data": [
    {"VIN": "vin1234", "SOC": 40, "SOC_ChargeLimit": 90}
  ]
}

SetAutoCharging EV AutoCharging-parameters instellen

{PlantId}/ha_gbb/api/setautocharging

Veld		Type	Vereist	Beschrijving
`OrderId`		string	nee	Tekst die naar het antwoord wordt gekopieerd
`Data`		array	ja	Meerdere items kunnen worden bijgewerkt
	`Name`	string	ja	Naam van het laadschema
	`On`	int	nee	0 — uit, 1 — aan

Voorbeeld:

1
2
3
4
5
{
  "Data": [
    {"Name": "Codziennie", "On": 1}
  ]
}

SetHP Parameters van de warmtepomp instellen

{PlantId}/ha_gbb/api/sethp

Veld		Type	Vereist	Beschrijving
`OrderId`		string	nee	Tekst die naar het antwoord wordt gekopieerd
`Data`		object	ja	Alleen de opgegeven parameters worden gewijzigd
	`HPForecast_Break_On`	bool	nee	Onderbreking van de WP: aan/uit
	`HPForecast_BreakFromDate`	date	nee	Begindatum van de onderbreking
	`HPForecast_BreakFromHour`	int (0-23)	nee	Beginuur
	`HPForecast_BreakToDate`	date	nee	Einddatum (inclusief)
	`HPForecast_BreakToHour`	int (0-23)	nee	Einduur (inclusief)

Voorbeeld:

1
2
3
4
5
6
7
{
  "Data": {
    "HPForecast_Break_On": true,
    "HPForecast_BreakToDate": "2026-01-30",
    "HPForecast_BreakToHour": 23
  }
}

SetPVForecast PV-productieprognose instellen

{PlantId}/ha_gbb/api/setpvforecast

Veld		Type	Vereist	Beschrijving
`OrderId`		string	nee	Tekst die naar het antwoord wordt gekopieerd
`Data`		array	ja	Prognoses per dag
	`Date`	date	ja	Prognosedatum (vandaag, morgen, tot 7 dagen)
	`Number`	int	nee	Nummer van het PV-vlak (standaard 1)
	`Hours`	array	ja	Uurwaarden (zie hieronder)

Velden van een Hours-element:

Veld	Type	Vereist	Beschrijving
`Hour`	decimal (0-23)	ja	Prognose-uur
`kWh`	decimal	ja	PV-productieprognose

Dit commando maakt het mogelijk om een PV-prognose vanuit externe bronnen te sturen, bijv. vanuit Home Assistant. Stel de bron voor de PV-prognose in op „HomeAssistant" in de installatieparameters.

Voorbeeld:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "Data": [
    {
      "Date": "2024-04-20",
      "Hours": [
        {"Hour": 6, "kWh": 0.5},
        {"Hour": 7, "kWh": 1.23},
        {"Hour": 8, "kWh": 2.45},
        {"Hour": 12, "kWh": 5.67},
        {"Hour": 18, "kWh": 1.10}
      ]
    }
  ]
}