Loxone umożliwia kontrolę i konfigurację za pomocą prostych poleceń HTTP.
Polecenia można wywoływać na przykład za pośrednictwem wiersza adresu przeglądarki aby uzyskać informacje z Miniservera. API Miniservera jest bardziej opisane tutaj: API
Ogólnie
Polecenia usług sieci Web są obsługiwane zarówno w przypadku dostępu wewnętrznego, jak i zewnętrznego.
Obecny Miniserver obsługuje również HTTPS.
Struktura polecenia usługi sieciowej jest następująca:
http://użytkownik:hasło@IPAdresMiniserver/command/control/value
W przypadku korzystania z protokołu HTTP dane dostępowe są przesyłane w postaci zwykłego tekstu w adresie URL!
Dlatego przy korzystaniu z protokołu HTTP (Miniserver Gen.1) wpisując komendę w linii adresowej należy na razie pominąć dane dostępowe.
Dane dostępowe są następnie wprowadzane przez okno w przeglądarce:
Niektóre polecenia wymagają danych dostępowych użytkownika z pełnym dostępem.
Polecenie jest następnie wykonywane, a wynik wyświetlany w przeglądarce.
W poniższym przykładzie otrzymujemy aktualną wersję oprogramowania Miniservera:
ŁATWA KOMUNIKACJA
Usługi sieciowe umożliwiają dostęp do informacji, dokonywanie ustawień i przełączanie za pomocą prostych poleceń http. Komunikacja odbywa się za pośrednictwem Loxone Miniserver.
Możesz znaleźć bardziej szczegółowe informacje na temat naszego API tutaj.
INFORMACJE OGÓLNE
USŁUGI INTERNETOWE SĄ BUDOWANE NASTĘPUJĄCO
Zastosowano technologię usługi Restful Web Service.
UWAGA: W przypadku tej metody nazwa użytkownika i hasło są przesyłane zwykłym tekstem. Stanowi to zagrożenie dla bezpieczeństwa, dlatego zalecamy korzystanie z naszego bezpiecznego uwierzytelniania w usłudze internetowej.
http://użytkownik:hasło@AdresMiniservera/command/control/value
- „control“:może być dowolnym wejściem lub wyjściem (w tym wirtualnymi wejściami i wyjściami). Jednak dane wyjściowe mogą być używane tylko do zapytań o status..
- „value“: Jeśli „value” nie jest dostępna, zwracana jest bieżąca wartość kontroli. Dozwolone są następujące wartości: „On”, „On”, „Off”, „Off”, „Impulse”, „Pulse” lub wartość dziesiętna (z miejscami dziesiętnymi). (Tylko użytkownik, który jest upoważniony do wprowadzania zmian w odpowiednim obiekcie, może zmieniać wartości za pośrednictwem usług internetowych na tym obiekcie)
- Dla cyfrowych wirtualnych wejść z 2 wyjściami istnieją następujące wartości (góra-dół, lewo-prawo, od wersji 1.5.4.16):
| ImpulsPlus ImpulsMinus |
PulseUp PulseDown |
ImpulsAuf ImpulsAb |
PulseOpen PulseClose |
| PlusEin PlusAus |
UpOn UpOff |
AufEin AufAus |
OpenOn OpenOff |
| MinusEin MinusAus |
DownOn DownOff |
AbEin AbAus |
CloseOn CloseOff |
- Dla wejść i wyjść cyfrowych dla ‚On‘ zawsze używa się 1 a dla ‚Off‘ zawsze 0
- Wejścia analogowe (0-10 V) działają w zakresie 0-10,00. Formalny limit nie istnieje (na przykład czujnik temperatury EIB 21,5 lub -5,2).
- Dla wyjść zamiast przecinka dziesiętnego używa się kropki dziesiętnej.
STATUS & PRZEŁĄCZANIE
STATUS ZAPYTANIE KONTROLNE
| Polecenie | http://miniserver/dev/sps/io/lampaKuchnia/state |
| Funkcja | Zwraca status wejścia |
| Odpowiedź | <LL control=“dev/sps/io/lampaKuchnia“ value=“0“ Code=“200“/> |
| Polecenie | http://miniserver/dev/sps/io/lampaKuchnia/astate |
| Funkcja | Zwraca wartości przypisanych wyjść (jednoznaczną wartość dla wszystkich lub różne wartości) |
| Odpowiedź | <LL control=“dev/sps/io/lampaKuchnia“ value=“1“ Code=“200“/> |
| Polecenie | http://miniserver/data/status |
| Funkcja | Wyświetla listę wszystkich urządzeń podłączonych do mini serwera wraz z ich statusem. |
| Odpowiedź | <Status Modified=““> <Miniserver Name=“Miniserver Biuro“ Internalname=““ IP=““ Mask=““ Gateway=““ DHCP=““ DNS1=““ DNS2=““ MAC=““ Device=““ Version=““> <Extension Name=““ Internalname=““ Serial=““ Version=““ Online=““/> </Miniserver> </Status> |
Zapytanie o status za pośrednictwem serwisu internetowego jest możliwe tylko dla wejść i wyjść, ale nie dla bloków programu.
PRZEŁĄCZANIE
| Polecenie | http://miniserver/dev/sps/io/Przycisk1/On |
| Funkcja | Przełączanie wejścia analogowego lub cyfrowego |
| Odpowiedź | <LL control=“dev/sps/io/Przycisk1“ value=“1“ Code=“200“/> |
Jeśli wymagane jest hasło do wizualizacji, polecenie należy wysłać w postaci zaszyfrowanej. Możesz znaleźć bardziej szczegółowe informacje w naszym API
ZAPYTANIA O WSZYSTKIE ZMIANY WYJŚĆ
| Polecenie | http://miniserver/dev/sps/event |
| Funkcja | Tworzy serwer zdarzeń na serwerze WWW. Program obsługi zdarzeń musi być zaprogramowany w kliencie WWW (np. Nowy EventSource (http: // miniserver / dev / sps / event). |
| Odpowiedź | Wysyła wszystkie wyjścia, które zostały zmienione, bez konieczności wysyłania nowego żądania. http://www.w3.org/TR/eventsource/ Event: changed data: Name data: uuid data: Wert |
| Polecenie | http://miniserver/dev/sps/enablestatusupdate |
| Funkcja | Umożliwia automatyczne wysyłanie zmian statusu w gniazdach sieciowych. |
| Odpowiedź | Wysyła bieżący status przez gniazda sieciowe. |
KONFIGURACJA & STATYSTYKI
POLECENIA SPS
| Polecenie | Funkcja | Wymagane uprawnienia administratora? |
| http://miniserver/dev/sps/state | SPS Statusabfrage 0 – brak statusu 1 – SPS PLC włącza się 2 – SPS Program PLC wczytuje si 3 – SPS PLC uruchamia się 4 – Uruchomienie magistrali 5 – SPS PLC pracuje 6 – SPS zmiana 7 – SPS bląd 8 – obecnie trwa aktualizacja |
X |
| http://miniserver/dev/sps/status | Zapytaj o bieżącą częstotliwość PLC | X |
| http://miniserver/dev/sps/restart | SPS Restart | ✓ |
| http://miniserver/dev/sps/stop | SPS Zatrzymanie | ✓ |
| http://miniserver/dev/sps/run | SPS Kontynuacja | ✓ |
| http://miniserver/dev/sps/log | SPS włącz globalne statystki | ✓ |
| http://miniserver/dev/sps/enumdev | Lista wszystkich urządzeń PLC Minisever, Extensions, itd) | ✓ |
| http://miniserver/dev/sps/enumin | Lista wszystkich wejść PLC | ✓ |
| http://miniserver/dev/sps/enumout | Lista wszystkich wyjść PLC | ✓ |
| http://miniserver/dev/sps/identify | Od wersji 1.5.6.7: Miniserver musi zostać zidentyfikowany. W przypadku rozszerzeń numer seryjny musi być parametrem. |
✓ |
POLECENIA CONFIG
| Polecenie | Funkcja | Wymagane uprawnienia admnistratora? |
| http://miniserver/dev/cfg/mac | Pokaż adres MAC | X |
| http://miniserver/dev/cfg/version | Pokaż wersję firmware | X |
| http://miniserver/dev/cfg/versiondate | Pokaż datę firmware | X |
| http://miniserver/dev/cfg/dhcp | Wczytywanie konfiguracji DHCP | ✓ |
| http://miniserver/dev/cfg/ip | Uzyskaj adres IP | ✓ |
| http://miniserver/dev/cfg/mask | Uzyskaj maskę IP | ✓ |
| http://miniserver/dev/cfg/gateway | Uzystkaj adres IP bramy | ✓ |
| http://miniserver/dev/cfg/device | Uzyskaj nazwę urządzenia Miniserver | ✓ |
| http://miniserver/dev/cfg/dns1 | Zwraca adres DNS1 | ✓ |
| http://miniserver/dev/cfg/dns2 | Zwraca adres DNS2 | ✓ |
| http://miniserver/dev/cfg/ntp | Zwraca adres NTP | ✓ |
| http://miniserver/dev/cfg/timezoneoffset | Wczytywanie zmiany strefy czasowej | X |
| http://miniserver/dev/cfg/http | Pokaż port HTTP | ✓ |
| http://miniserver/dev/cfg/ftp | Pokaż port FTP | ✓ |
| http://miniserver/dev/cfg/LoxPLAN | Pokaż port LoxPLAN | ✓ |
| http://miniserver/dev/cfg/ftllocalonly | Wczytywanie „FTP, Telnet, tylko dostęp do lokalnego oprogramowania“ | ✓ |
POLECENIA SYSTEMOWE
| Polecenie | Funkcja | Wymagane prawa administratora? |
| http://miniserver/dev/lan/txp | Wczyta liczbę przesłanych pakietów | ✓ |
| http://miniserver/dev/lan/txe | Wczyta liczbę przesłanych pakietów błędów | ✓ |
| http://miniserver/dev/lan/txc | Wczyta liczbę przesłanych pakietów kolizji | ✓ |
| http://miniserver/dev/lan/exh | Wczyta liczbę błędów w buforu podczas przenoszenia | ✓ |
| http://miniserver/dev/lan/txu | Wczyta liczbę błędów LAN | ✓ |
| http://miniserver/dev/lan/rxp | Wczyta liczbę odebranych pakietów LAN | ✓ |
| http://miniserver/dev/lan/eof | Wczyta liczbę błędów EOF LAN | ✓ |
| http://miniserver/dev/lan/rxo | Wczyta liczbę błędów – przepełnienie LAN | ✓ |
| http://miniserver/dev/lan/nob | Wczyta liczbę błędów LAN „No receive Buffer“ | ✓ |
| http://miniserver/dev/bus/ packetssent |
Wczyta liczbę pakietów wysłanych do magistrali Loxone | ✓ |
| http://miniserver/dev/bus /packetsreceived |
Wczyta liczbę pakietów odebranych przez magistralę Loxone | ✓ |
| http://miniserver/dev/bus/ receiveerrors |
Wczyta liczbę błędów odebranych na magistrali Loxone | ✓ |
| http://miniserver/dev/bus/ frameerrors |
Wczyta liczbę błędów „frame“ na magistrali Loxone | ✓ |
| http://miniserver/dev/bus/ overruns |
Wczyta liczbę błędów „overflow“ na magistrali Loxone | ✓ |
| http://miniserver/dev/bus/ parityerrors |
Wczyta liczbę błędów parzystości na magistrali Loxone | ✓ |
| http://miniserver/dev/sys/ numtasks |
Wczyta liczbę zadań | ✓ |
| http://miniserver/dev/sys/cpu | Wczyta obciążenie procesora | ✓ |
| http://miniserver/dev/sys /contextswitches |
Wczyta liczbę przełączeń między zadaniami | ✓ |
| http://miniserver/dev/sys /contextswitchesi |
Wczyta liczbę przełączeń zadań, które zostały przerwane | ✓ |
| http://miniserver/dev/sys/heap | Wczyta rozmiar pamięci | X |
| http://miniserver/dev/sys/ints | Wczyta liczbę przerw w działaniu systemu | ✓ |
| http://miniserver/dev/sys/comints | Wczyta liczbę przerw w komunikacji | ✓ |
| http://miniserver/dev/sys/lanints | Wczyta liczbę przerw w sieci LAN | ✓ |
| http://miniserver/dev/sys/watchdog | Wczyta bity „watchdog“ | ✓ |
| http://miniserver/dev/sys/date | Przywróci datę | ✓ |
| http://miniserver/dev/sys/time | Przywróci czas | ✓ |
| http://miniserver/dev/sys/ setdatetime |
Ustawi systemowy format daty i czasu: 2010-04-20 14:35:00 lub 2010/20/04 14:35:00. | ✓ |
| http://miniserver/dev/sys/spscycle | Wczyta liczbę cykli SPS | ✓ |
| http://miniserver/dev/sys/ntp | Wymusi żądanie NTP | ✓ |
| http://miniserver/dev/task0/name | Wczyta zadanie o nazwie 0 (0- http://loxlive/dev/sys/numtasks – 1) |
✓ |
| http://miniserver/dev/task0/priority | Wczyta priorytet zadania 0 | ✓ |
| http://miniserver/dev/task0/stack | Wczyta „stack“ zadania 0 | ✓ |
| http://miniserver/dev/task0 /contextswitches |
Wczyta liczbę przełączeń zadań 0 | ✓ |
| http://miniserver/dev/task0/ waittimeout |
Wczyta czas oczekiwania dla zadań w ms | ✓ |
| http://miniserver/dev/task0/state | Wczyta status zadania 0 | ✓ |
| http://miniserver/dev/sys/reboot | Reboot miniservera | ✓ |
| http://miniserver/dev/sys/check | Wyświetli aktywne połączenia Loxone Config | X |
| http://miniserver/dev/sys/logoff | Przerwie istniejące połączenia Loxone Config | ✓ |
| http://miniserver/dev/sys/sdtest | Test karty SD | ✓ |
| http://miniserver/dev/sys/lastcpu | Wyświetla ostatnią wartość użycia procesora i liczbę cykli PLC | ✓ |
| http://miniserver/dev/sys /searchdata |
Lista wyników wyszukiwania | X |
| http://miniserver/dev/fslist/ | Wyświetla katalog główny karty SD | ✓ |
| http://miniserver/dev/fslist/path/ | Wyświetli ścieżkę na karcie SD | ✓ |
| http://miniserver/dev/fsget/filepath | Wczyta plik (ścieżka do pliku do zastąpienia) | ✓ |
| http://miniserver/dev/fsdel/filepath | Usunie plik (według ścieżki do pliku) | ✓ |
| http://miniserver/data/status | Wyświetli status Miniservera i wszystkich Extensionów | X |
| http://miniserver/stats | Wyświetla statystyki | ✓ |
| http://miniserver/data/weatheru.xml | Wyświetli dane o pogodzie (z weather service) | X |
| http://miniserver/data/LoxAPP3.json | Struktura plików do wizualizacji | X |
| http://miniserver/dev/fsget/log/def.log | Służy do pobierania informacji w pliku def.log | ✓ |
| http://miniserver/dev/sys/ ExtStatistics/05000001 |
Wczyta statystyki z 1-Wire Extension (05000001 zastąpić aktualnym numerem seryjnym) | ✓ |
| http://miniserver/dev/sys/ AirStatistics/0C000001/DeviceIndex |
Wczyta statystyki z Air Base Extension (0C000001 zastąpić aktualnym numerem seryjnym) | ✓ |
Polecenia dla urządzeń
Poniższe polecenia dotyczą określonych urządzeń Air lub Tree.
Wymagane są dane logowania użytkownika z pełnym dostępem.
| http://miniserver/dev/sys/wsdevice/serial/ForceUpdate | Wymuś aktualizację oprogramowania urządzenia |
| http://miniserver/dev/sys/wsdevice/serial/Reboot | Uruchom ponownie urządzenie |
W przypadku „serial” używany jest numer seryjny (bez dwukropków) urządzenia.
Tutaj można również użyć nazwy urządzenia w Loxone Config.
Musi być unikalny i nie może zawierać żadnych znaków specjalnych.