Webservices

Bardziej szczegółowe informacje o interfejsie API

OGÓLNE

• Polecenia webservice obsługują zarówno dostęp wewnętrzny, jak i zewnętrzny.
• Obecny Miniserver obsługuje również protokół HTTPS

Struktura polecenia webservice jest następująca:

http://user:password@IPAddressMiniserver/command/control/value

Ze względów bezpieczeństwa podczas korzystania z protokołu HTTP (Miniserver Gen.1) zaleca się pominięcie poświadczeń dostępu podczas wprowadzania polecenia w pasku adresu. Zamiast tego przeglądarka wyświetli monit o podanie danych logowania w osobnym oknie.

Niektóre polecenia wymagają użytkownika z pełnymi prawami.

Po wykonaniu polecenia wynik jest wyświetlany w przeglądarce.

Na przykład poniższe polecenie pobiera aktualną wersję oprogramowania Miniservera:

Jeśli polecenie się powiedzie, odpowiedź będzie zawierać kod statusu „200”, wskazujący, że żądanie zostało zaakceptowane i przetworzone.

Struktura w szczegółach

• control: może być dowolnym wejściem lub wyjściem, rzeczywistym lub wirtualnym. Wyjścia mogą być używane tylko do żądań stanu.
• value: gdy 'value’ nie jest dostępne, zwracana jest bieżąca wartość.
  • Dla wartości cyfrowych dozwolone są następujące wartości:
    • „Ein„, „On„, „Aus„, „Off„, „1„, „0„, „Impuls” or „Pulse„.
• Wirtualne wejścia cyfrowe z 2 wyjściami (góra-dół, lewo-prawo, od wersji 1.5.4.16), dozwolone są następujące wartości.

• • Dla wejść analogowych dozwolone są następujące wartości:
    • (0-10V) działają w zakresie od 0 do 10,00.
    • Nie ma formalnego ograniczenia (np. temperatury 21,5 lub -5,2 są prawidłowe).
    • Kropka (.) jest używana jako separator dziesiętny.
  • Następujące wartości są dozwolone dla wprowadzania tekstu:
    • Miniserver działa przy użyciu UTF-8, więc każdy znak obsługiwany przez UTF-8 powinien działać poprawnie.

Przykład – wejście impulsowe

Przed wysłaniem impulsu do systemu, Miniserver potrzebuje wirtualnego wejścia, które zaakceptuje polecenie.

Po dodaniu i zapisaniu naszego wirtualnego wejścia do Miniservera należy wysłać polecenie. Poniżej znajduje się przykład aplikacji innej firmy* wysyłającej polecenie impulsowe do Loxone Miniserver:

W tym przykładzie mamy domyślne poświadczenia (nazwa użytkownika: admin, hasło: admin) i wirtualne wejście w poleceniu o nazwie „Test Input”. Po naciśnięciu przycisku „Wyślij” w aplikacji, ciąg użyje adresu IP do znalezienia Miniservera w sieci, zalogowania się, a następnie przetworzenia polecenia.

Jeśli polecenie wysłania zostanie zaakceptowane, zwróconą odpowiedzią w formacie XML będzie:

W Loxone Config wirtualne wejście podświetli się na ułamek sekundy, jeśli aktywny jest podgląd na żywo:

*W tych przykładach Postman jest aplikacją zewnętrzną używaną do wysyłania poleceń.

STATUS I KONTROLA

ZAPYTANIE: STATUS

Żądania stanu za pośrednictwem usługi internetowej są możliwe tylko w przypadku wejść i wyjść i nie są możliwe w przypadku bloków funkcyjnych.

PRZYCISK

Przykład – Push Button

Przed wysłaniem polecenia do systemu, Miniserver potrzebuje bloku funkcyjnego Przycisk, który zaakceptuje polecenie.

Teraz, po dodaniu i zapisaniu naszego przycisku Push Button w Miniserverze, należy wysłać polecenie. Poniżej znajduje się przykład aplikacji innej firmy* wysyłającej komendę „On” do Loxone Miniserver:

W tym przykładzie mamy domyślne poświadczenia (nazwa użytkownika: admin, hasło: admin) i przycisk Push Button w poleceniu o nazwie „Push-Button”. Po naciśnięciu przycisku „Wyślij” w aplikacji, ciąg użyje adresu IP, aby znaleźć Miniserver w sieci, zalogować się, a następnie przetworzyć polecenie. Możemy zmienić ostatnią część polecenia na „On” lub „Off”, w zależności od różnych sytuacji.

Jeśli polecenie wysłania zostanie zaakceptowane, zwróconą odpowiedzią w formacie XML będzie:

Kod „200” oznacza, że polecenie zostało zaakceptowane i przetworzone.

W interfejsie Loxone zobaczysz również, że przycisk będzie zmieniał stan w zależności od wysłanego polecenia (włącz/wyłącz).

*W tych przykładach Postman jest aplikacją zewnętrzną używaną do wysyłania poleceń.

ZAPYTANIE: ZMIANY STATUSU

Konfiguracja, statystyki i polecenia Miniservera

Poniższe polecenia zapewniają sterowanie systemem, operacje PLC, statystyki sieciowe i opcje konfiguracji dla Miniservera.

1. Polecenia PLC (programowalny sterownik logiczny)

Polecenia te umożliwiają monitorowanie i sterowanie systemem PLC.

2. Polecenia konfiguracyjne

Polecenia te umożliwiają pobieranie lub modyfikowanie ustawień programu Miniservera.

3.Polecenia monitorowania systemu

Polecenia te dostarczają informacji o wydajności i statystykach systemu.

4. Zarządzanie datą i czasem

Zarządzanie systemowymi ustawieniami daty i godziny.

5. Monitorowanie zadań

Pobieranie statusu i właściwości zadań systemowych.

6. Kontrola systemu i zarządzanie plikami

Polecenia te umożliwiają ponowne uruchomienie Miniservera i zarządzanie plikami systemowymi.

7. Logi i statystyki systemowe

Pobieranie logów i danych systemowych.

8. Wykonanie webservice zewnętrznie

Wysyłanie żądań webservice do urządzeń zewnętrznych.

Polecenia dla urządzeń

Extensions

Poniższe polecenia mają zastosowanie do rozszerzeń.

Do ich wykonania wymagany jest użytkownik z pełnymi prawami dostępu.

Urządzenia Tree i Air

Poniższe polecenia dotyczą określonych urządzeń Tree lub Air.

Do ich wykonania wymagany jest użytkownik z pełnymi prawami dostępu.

Korzystanie z interfejsu internetowego Miniservera w ramce iFrame

Domyślnie serwer Miniserver nie zezwala na osadzanie w ramkach iFrame ze względów bezpieczeństwa. Aby włączyć tę funkcję, należy jawnie zezwolić na nią za pomocą następującego polecenia usługi sieci Web:

http://<miniserver-ip>/dev/sys/allowhttpiframe/1