HTTP
HTTP API umożliwia sterowanie urządzeniem wysyłając odpowiednio sparametryzowane żądania / adresy url bezpośrednio do urządzenia.
Urządzenie powinno mieć zawsze ten sam adres IP. Do skonfigurowania w routerze WiFi lub AFE Firmware.
Sterowanie przekaźnikiem
Format komendy sterującej
http://adres-ip-urzadzenia/?device=relay&name=NAZWA_PRZEKAZNIKA&command=KOMENDA
Parametery:
- NAZWA_PRZEKAZNIKA
- Nazwa przekaźnika wprowadzona w konfiguracji przekaźnika
- Nazwa przekaźnika wprowadzona w konfiguracji przekaźnika
- KOMENDA
- on - włączenie przekaźnika
- off - wyłączenie przekaźnika
- toggle - przełączenie przekaźnika w stan przeciwny
- get - uzyskanie informacji w jakim stanie jest przekaźni
Wywołanie komendy zwraca odpowiedź w postaci JSON:
{"device":"relay", "name":"NAZWA_PRZEKAZNIKA","command":"KOMENDA","value":"STAN_PRZEKAZNIKA","status":"STATUS_WYKONANIA"}
gdzie STAN_PRZEKAZNIKA
- on
- off
STATUS_WYKONANIA
- success
- error
Przykłady:
- http://192.168.1.2/?device=relay&name=lampa&command=on
- http://192.168.1.2/?device=relay&name=lampa&command=off
- http://192.168.1.2/?device=relay&name=lampa&command=toggle
- http://192.168.1.2/?device=relay&name=lampa&command=get
Sterowanie bramą/dzwiami (AFE T5)
Format komendy sterującej
http://adres-ip-urzadzenia/?device=gate&name=NAZWA_BRAMY&command=KOMENDA
Parametery:
- NAZWA_BRAMY
- Nazwa bramy wprowadzona w konfiguracji bramy
- KOMENDA
- toggle - włącza przekaźnik na czas określony w konfiguracji przekaźnika
- get - uzyskanie informacji w jakim stanie otwarcia/zamknięcia jest brama/drzwi
Wywołanie komendy zwraca odpowiedź w postaci JSON:
{"device":"gate", "name":"NAZWA_BRAMY","command":"KOMENDA","value":"STAN_BRAMY","status":"STATUS_WYKONANIA"}
gdzie STAN_BRAMY
- open
- closed
- partiallyOpen
- unknown
STATUS_WYKONANIA
- success
- error
Przykłady:
- http://192.168.1.2/?device=gate&name=BramaWjazdowa&command=toggle
- http://192.168.1.2/?device=gate&name=BramaWjazdowa&command=get
Odczyt stanów czujników magnetycznych (AFE T5)
Format komendy
http://adres-ip-urzadzenia/?device=contactron&name=NAZWA_CZUJNIKA&command=KOMENDA
Parametery:
- NAZWA_CZUJNIKA
- Nazwa czujnika magnetycznego wprowadzona w konfiguracji czujników magnetycznych
- KOMENDA
- get - uzyskanie informacji w jakim stanie jest czujnik magnetyczny
Wywołanie komendy zwraca odpowiedź w postaci JSON:
{"device":"contactron", "name":"NAZWA_CZUJNIKA","command":"KOMENDA","value":"STAN_CZUJNIKA","status":"STATUS_WYKONANIA"}
gdzie STAN_CZUJNIKA
- open
- closed
STATUS_WYKONANIA
- success
- error
Przykłady:
- http://192.168.1.2/?device=contactron&name=czujnik&command=get
Odczyt danych z czujnika BME680/BME280/BMP180/BMP085
Format komendy
http://adres-ip-urzadzenia/?device=BMEX80&name=NAZWA_CZUJNIKA&command=KOMENDA
Parametery:
- NAZWA_CZUJNIKA
- Nazwa czujnika wprowadzona w konfiguracji czujnika Bosch BMx80
- KOMENDA
- get - uzyskanie informacji z czujnika
Wywołanie komendy zwraca odpowiedź w postaci JSON:
{"device":"BMEX80", "name":"NAZWA_CZUJNIKA","command":"KOMENDA","data":{JSON_STRING},"status":"STATUS_WYKONANIA"}
gdzie JSON_STRING
- zawiera dane odczytane z czujnika w formacie JSON
STATUS_WYKONANIA
- success
- error
Przykłady:
- http://192.168.1.2/?device=BMEX80&name=WarunkiPowietrzne&command=get
Odczyt danych z czujnika BH1750
Format komendy
http://adres-ip-urzadzenia/?device=BH1750&name=NAZWA_CZUJNIKA&command=KOMENDA
Parametery:
- NAZWA_CZUJNIKA
- Nazwa czujnika wprowadzona w konfiguracji czujnika BH1750
- KOMENDA
- get - uzyskanie informacji z czujnika
Wywołanie komendy zwraca odpowiedź w postaci JSON:
{"device":"BH1750", "name":"NAZWA_CZUJNIKA","command":"KOMENDA","data":{JSON_STRING},"status":"STATUS_WYKONANIA"}
gdzie JSON_STRING
- zawiera dane odczytane z czujnika w formacie JSON
STATUS_WYKONANIA
- success
- error
Przykłady:
- http://192.168.1.2/?device=BH1750&name=NatezenieSwiatla&command=get
Odczyt danych z czujnika Honeywell HPMA115S0
Format komendy
http://adres-ip-urzadzenia/?device=HPMA115S0&name=NAZWA_CZUJNIKA&command=KOMENDA
Parametery:
- NAZWA_CZUJNIKA
- Nazwa czujnika wprowadzona w konfiguracji czujnika HPMA115S0
- KOMENDA
- get - uzyskanie informacji z czujnika
Wywołanie komendy zwraca odpowiedź w postaci JSON:
{"device":"HPMA115S0", "name":"NAZWA_CZUJNIKA","command":"KOMENDA","data":{JSON_STRING},"status":"STATUS_WYKONANIA"}
gdzie JSON_STRING
- zawiera dane odczytane z czujnika w formacie JSON
STATUS_WYKONANIA
- success
- error
Przykłady:
- http://192.168.1.2/?device=HPMA115S0&name=JakoscPowietrza&command=get
Odczyt danych z czujnika AS3935
Format komendy
http://adres-ip-urzadzenia/?device=AS3935&name=NAZWA_CZUJNIKA&command=KOMENDA
Parametery:
- NAZWA_CZUJNIKA
- Nazwa czujnika wprowadzona w konfiguracji czujnika AS3935
- KOMENDA
- get - uzyskanie informacji z czujnika
Wywołanie komendy zwraca odpowiedź w postaci JSON:
{"device":"AS3935", "name":"NAZWA_CZUJNIKA","command":"KOMENDA","data":{JSON_STRING},"status":"STATUS_WYKONANIA"}
gdzie JSON_STRING
- zawiera dane odczytane z czujnika w formacie JSON
STATUS_WYKONANIA
- success
- error
Przykłady:
- http://192.168.1.2/?device=AS3935&name=Burza&command=get
Odczyt danych z czujnika DHT
Format komendy
http://adres-ip-urzadzenia/?device=dht&name=NAZWA_CZUJNIKA&command=KOMENDA
Parametery:
- NAZWA_CZUJNIKA
- Nazwa czujnika wprowadzona w konfiguracji czujnika DHT
- KOMENDA
- get - uzyskanie informacji z czujnika
Wywołanie komendy zwraca odpowiedź w postaci JSON:
{"device":"dht", "name":"NAZWA_CZUJNIKA","command":"KOMENDA","data":{JSON_STRING},"status":"STATUS_WYKONANIA"}
gdzie JSON_STRING
- zawiera dane odczytane z czujnika w formacie JSON
STATUS_WYKONANIA
- success
- error
Przykłady:
- http://192.168.1.2/?device=dht&name=CzujnikAM3202&command=get