Komunikácia / REST API

Komplexný návod na použitie REST API zariadenia

Nasledujúci návod popisuje, ako pracovať s REST API zariadenia MiniHPC, ktoré využíva 4 JSON súbory:

• config.json
  - obsahuje konfiguráciu zariadenia
• data.json
  - obsahuje údaje (dáta) zo zariadenia
• setconfig.json
  - umožňuje meniť konfiguráciu MiniHPC
• setsensor.json
  - umožňuje zasielať hodnoty externých senzorov

Zmena v konfigurácii a zasielanie hodnôt externých senzorov bude povolené iba v prípade, ak sú povolené oprávnenia v menu 9.4 Oprávnenia

Prehľad dostupných súborov a endpointov

1. config.json

• Tento súbor obsahuje všetky konfiguračné parametre zariadenia.
• Príklad:

  {
      "mode":1,
      "heating_onoff_input":3,
      "heating_reg_input":2,
      "heating_t1_hysteresis":2,
      "heating_reg_temp":2,
      "temperature_T1":235,
      "temperature_T3":35,
      "temperature_T3_cool":18,
      ...
  }
          

2. data.json

• Tento súbor obsahuje dáta, ktoré zariadenie poskytuje alebo zhromažďuje.
• Príklad:

  {
      "t1":25.08,
      "t2":27.36,
      "t3":27.35,
      "t4":-40,
      "t5":42.4,
      "t6":25.61,
      ...
  }
          

3. Endpoint na zmenu konfigurácie:

• URL: setconfig.json?set=JSON_PARAMETERS
• Popis: Slúži na nastavenie alebo zmenu konfiguračných parametrov definovaných v config.json.
• Formát: JSON_PARAMETERS: Parameter set musí obsahovať platné JSON údaje (tzv. JSON objekt) so zodpovedajúcimi kľúčmi, ktoré zodpovedajú položkám v config.json. Je možné nastaviť 1 alebo viacero parametrov naraz.
• Príklad volania: povolená metóda volania je GET

  http://LOCAL_IP/setconfig.json?set={"mode":1,"temperature_T1":230}

  Toto volanie spôsobí prepnutie módu na kúrenie a nastavenie teploty miestnosti T1 na 23°C
• URL bez ukladania: setconfig.json?setns=JSON_PARAMETERS
  V prípade použitia premennej setns namiesto set budú nastavené parametre zmenené v MiniHPC, ale nedôjde k ich uloženiu do pamäte zariadenia. Pamäť MiniHPC má obmedzený počet zapisovacích cyklov a pri bežnom použití nedochádza k jej poškodeniu, avšak v prípade, že sa na úpravu parametrov použije automatizovaný script, ktorý mení parametre niekoľko krát za minútu je vhodné použiť premennú setns.

4. Endpoint na nastavenie hodnôt externých senzorov:

• URL: setsensor.json?set=JSON_PARAMETERS
• Popis: Slúži na ručné nastavenie hodnôt externých senzorov.
• Formát: JSON_PARAMETERS
  • T1 - vnútorná teplota (desatinné číslo)
  • Tout - vonkajšia teplota (desatinné číslo)
  • RH - Relatívna vlhkosť vzduchu (desatinné číslo)
  • Je možné nastaviť 1 alebo viacero parametrov naraz.
• Príklad volania: povolená metóda volania je GET

  http://LOCAL_IP/setsensor.json?set={"T1":24.5,"Tout":-12, "RH": 45.58}

  Toto volanie nastaví teplotu T1 na 24.5°C, Vonkajšiu teplotu na -12.0°C a relatívnu vlhkosť na 45.58%