Indice dei contenuti

API locale del Gateway

L'API locale del Gateway è utilizzata da un sistema di terze parti per leggere i dati di tutti i contatori Modbus o MBus configurati e collegati al Gateway Climkit.

Le richieste devono essere effettuate localmente sulla stessa rete (LAN).

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

1. Valori istantanei del contatore elettrico

URL: /meter/<prim_ad>/

Method: GET

Auth required: No

Parameters (URL)
----------
prim_ad: int
    L'indirizzo sul bus del contatore elettrico

Returns
-------
Un dizionario strutturato come

{
    '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'],
}

dove last_reading è l'ultimo record della lettura del contatore (La frequenza dipende dalla configurazione del contatore, 1 secondo o 15 minuti)

2. Valori dei registri dei contatori

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

Method: GET

Auth required: No

Parameters (URL)
----------
meter_type: str
    Il tipo di contatore in ['electricity', 'hot_water', 'cold_water', 'heating']
meter_ad: int
    L'indirizzo sul bus del contatore

Returns
-------
Un dizionario strutturato come
{
    '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']
}

dove last_reading è l'ultimo record della lettura del contatore (La frequenza dipende dal tipo e dalla configurazione del contatore, 1 secondo o 15 minuti).

La mappatura tipo contatore -> registri è la seguente:
{
  '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'],
}

How did we do?

API di Climkit

Contatto