Inhaltsübersicht

Gateway API-Lokalisierung

Die lokale Gateway-API wird von einem Drittsystem verwendet, um die Daten aller konfigurierten und mit dem Climkit Gateway verbundenen Modbus- oder MBus-Zähler auszulesen.

Die Anfragen müssen lokal im selben Netzwerk (LAN) erfolgen.

API-Endpunkt: http://<IP-ADDRESS-OF-THE-GATEWAY:8080/api/v1 (Bsp.: http://192.168.2.10:8080/api/v1)

1. Momentane Werte des Stromzählers

URL: /meter/<prim_ad>/

Methode: GET

Authentifizierung erforderlich: Nein

Parameter (URL)
----------
prim_ad: int
    Die Bus-Adresse des Stromzählers

Rückgabe
-------
Ein Wörterbuch (Dictionary) strukturiert als

{
    'L1_a': last_reading['L1_a'],
    'L2_a': last_reading['L2_a'],
    'L3_a': last_reading['L3_a'],
    'total_W': last_reading['total_W'],
    'ts': last_reading['ts'],
    'valid': last_reading['connect'],
}

wobei last_reading der letzte Datensatz des Zählerstandes ist (Die Frequenz hängt von der Zählerkonfiguration ab, entweder 1 Sekunde oder 15 Minuten)

2. Zählerregisterwerte

URL: /meter/<meter_type>/<meter_ad>/

Methode: GET

Authentifizierung erforderlich: Nein

Parameter (URL)
----------
meter_type: str
    Der Zählertyp in ['electricity', 'hot_water', 'cold_water', 'heating']
meter_ad: int
    Die Bus-Adresse des Zählers

Rückgabe
-------
Ein Wörterbuch (Dictionary) strukturiert als
{
    'L1_a': last_reading['L1_a'],
    'L2_a': last_reading['L2_a'],
    'L3_a': last_reading['L3_a'],
    'total_W': last_reading['total_W'],
    'ts': last_reading['ts'],
    'valid': last_reading['connect']
}

wobei last_reading der letzte Datensatz des Zählerstandes ist (Die Frequenz hängt vom Zählertyp und der Konfiguration ab, entweder 1 Sekunde oder 15 Minuten).

Die Zuordnung Zählertyp -> Register lautet wie folgt:
{
  'electricity': ['en_im', 'en_ex', 'L1_a', 'L2_a', 'L3_a', 'total_W'],
  'hot_water': ['vol_m3'],
  'cold_water': ['vol_m3'],
  'heating': ['heat_energy_kwh', 'power_kw', 'diff_temp', 'flow_temp', 'vol_flow_m3_h'],
}

Wie haben wir abgeschnitten?

Climkit API

Kontakt