Dokumentacja

Informacje o lokalnym interfejsie API

Podzbiór lokalnego interfejsu API oprogramowania układowego obsługiwany przez ten symulator. Interfejsy API debugowania przeznaczone wyłącznie do symulatora są udokumentowane osobno.

Lokalne interfejsy API oprogramowania sprzętowego IAMMETER

IAMMETER obsługuje lokalne interfejsy API HTTP. Zobacz oficjalną dokumentację, aby zapoznać się z możliwościami rzeczywistego urządzenia. Ten symulator implementuje tylko podzbiór wymieniony poniżej.

Ścieżki i sesje

Przedstaw każdy punkt końcowy licznika za pomocą /WEM3080, /WEM2067 lub /WEM3050T. Strony urządzeń i interfejsy API obsługują HTTP na porcie 80 oraz HTTPS na porcie 443. Urządzenia fizyczne zwykle korzystają z lokalnego HTTP.

Publiczne żądania pomiarów działają bez sesji i zwracają domyślne źródło Inverter and grid. Ustawienia prywatne wymagają istniejącego pliku cookie strony licznika. Oddzielne żądanie curl nie dziedziczy wybranego źródła ani ustawień przeglądarki.

HTTP i HTTPS korzystają z oddzielnych sesji przeglądarki. Przed zmianą ustawień otwórz stronę miernika, korzystając z tego samego schematu. Odczyty anonimowe korzystają z domyślnego źródła Inverter and grid.

Obsługiwany podzbiór API oprogramowania sprzętowego

MetodaPunkt końcowyZamiarObsługiwane modele
GET/api/monitorOdczytaj napięcie, prąd, moc i energię.Wszystkie modele
GET/api/monitorjson · /monitorjsonPrzeczytaj starszą wersję JSON z opcjonalnymi danymi reaktywnymi.Wszystkie modele
GET/api/wifidataPrzeczytaj ustawienia wirtualnej sieci Wi-Fi i urządzenia.Wszystkie modele
POST/api/setwifiadvZapisz ustawienia wirtualnej sieci Wi-Fi dla tej sesji i modelu.Wszystkie modele
GET/api/getadvPrzeczytaj ustawienia zaawansowane i prześlij; hasło jest puste.Wszystkie modele
POST/api/setadvZapisz ustawienia przesyłania, flagi Reactive i NEM.Wszystkie modele; NEM tylko w WEM3050T

Odpowiedzi pomiarowe

WEM3080 zwraca Data; WEM2067 i WEM3050T zwracają Datas z jednym wierszem na kanał. Kolejność pól pokazano poniżej. Przykłady mają charakter poglądowy, a nie odpowiedzi na żywo.

IndeksPomiarJednostka
0NapięcieV
1PrądA
2Moc czynnaW
3Energia pobranakWh
4Energia oddanakWh
5CzęstotliwośćHz
6Współczynnik mocy—

Przeczytaj pomiary publiczne

curl 'https://simulator.iammeter.com/WEM3050T/api/monitor'

Kształt odpowiedzi

{
  "ssid": "IAMMETER-Simulator",
  "sig": 100,
  "mac": "020000003050",
  "version": "simulator-1.0",
  "server": "em",
  "SN": "1AD9B537",
  "model": "WEM3050T",
  "Datas": [
    [230.0,1.252,270.0,2.092,0.000,50.00,0.94],
    [229.5,0.487,110.0,1.280,0.000,50.00,0.98],
    [229.0,0.399,90.0,0.747,0.000,50.00,0.98]
  ]
}

Ustawienia wirtualnej sieci Wi-Fi

setwifiadv akceptuje ssid, pwd, dhcp (boolean), ip, maskę sieci, gw i dns. Te wartości zmieniają tylko urządzenie wirtualne; nie powodują one ponownej konfiguracji karty sieciowej.

Przykładowa treść żądania

{"ssid":"Test network","dhcp":true}

Pomyślne zapisanie

{"successful":1,"message":"ok"}

Ustawienia zaawansowane

setadv akceptuje częściowe aktualizacje JSON. Nieokreślone pola zachowują swoje bieżące wartości. Interwał przesyłania wynosi 10–3600 sekund.

Reactive dodaje EA.Reactive do monitorjson i przesyła, a nie api/monitor. Każdy rząd to [var, indukcyjny kvarh, pojemnościowy kvarh].

NEM jest obsługiwany tylko przez WEM3050T. Czwarty wiersz Datas sumuje moc czynną, oddzielnie importuje kWh i eksportuje kWh; wszystkie pozostałe pola mają wartość zerową.

ParametrAkceptowane wartości
runMode1 = TCP/TLS; 2 = HTTP/HTTPS; 3 = MQTT/MQTTS; 4 = stand alone
uploadAddressAdres odbiorcy; postępuj zgodnie ze wskazówkami dotyczącymi wprowadzania danych Settings.
mqttUsername · mqttPasswordreferencje brokera; getadv nigdy nie zwraca zapisanego hasła.
uploadInterval10–3600 s
reactive0 / 1
netmetering0 / 1
ntpServerTylko zapisany tekst; nie zmienia czasu serwera.
haDiscovery · ctcRatioOdpowiednio tylko 0 i 1; funkcje nie są zaimplementowane.

Włącz Reactive i NEM na WEM3050T

{"reactive":1,"netmetering":1}

Sprawdzanie wyników

Pomyślne zapisanie zwraca successful=1. Nieprawidłowe wartości ustawień mogą zwrócić HTTP 200 z successful=0; sprawdź JSON i kod stanu. Brakujące sesje zwracają 401; zapisy między źródłami są odrzucane.

Zapisanie ustawień przesyłania nie stanowi dowodu dostarczenia. Sprawdź status przesyłania debugowania i potwierdź komunikaty na odbiorniku.

Nie zaimplementowano

Poniższe funkcje służą wyłącznie do wyświetlania lub nie są obsługiwane. Nie zapewniają działających interfejsów API zapisu.

FunkcjonowaćAktualne zachowanie
Skanowanie Wi-Fi · restart · reset do ustawień fabrycznychŻadnej prawdziwej operacji.
Bezpieczeństwo urządzenia · aktualizacja oprogramowania sprzętowegoTylko wyświetlacz.
Chmura IAMMETER · HA Discovery · Łącze w dół MQTTBez przesyłania do chmury, wykrywania i zdalnej konfiguracji.

Narzędzia symulacyjne są udokumentowane osobno

Punkty końcowe debugowania symulatora nie są interfejsami API oprogramowania sprzętowego IAMMETER. Są one wykluczone z powyższej listy API oprogramowania sprzętowego.

← Wracając do symulatora