Przejdź do treści

Urządzenia

W dalszej części dokumentacji będę odnosił się do Lan Kontrolera v3, GSM Controller v3/v4.2 i innych urządzeń, które mogą łączyć się z naszym serwerem poprzez MQTT, po prostu jako urządzenia.

Na tej stronie znajdziesz informacje dotyczące dodawania nowego urządzenia do konta, konfigurowania go oraz edycji jego ustawień po stronie serwera.

Strona Urządzenia

Strona Urządzenia jest centralnym punktem serwisu mqtt.ats.pl. Na tej stronie możesz przeglądać wszystkie swoje urządzenia i zarządzać nimi, dodawać nowe urządzenia lub przejść do wykresów i tabel z danymi z Twoich urządzeń.

Poniższy obrazek przedstawia stronę Urządzenia z kilkoma urządzeniami. Można na niej wyróżnić parę istotnych elementów:

  1. Lista urządzeń przypisanych do konta. Zawiera nazwy, typy, prefixy, linki do stron edycji, widoków wykresów i tabel.
  2. Instrukcja dodawania i konfigurowania nowego urządzenia (zawarta w niniejszej dokumentacji).
  3. Formularz dodawania nowego urządzenia. Warto wspomnieć, że Dodaj urządzenie i przejdź do jego strony edycji po dodaniu urządzenia, przekieruje Cię na stronę ustawień serii, którą należy odwiedzić, aby wybrać aktywne serie (dla których mają być zbierane dane).
  4. Linki do stron edycji, gdzie można zarządzać urządzeniem, czy też je usunąć.

Strona Urządzenia

Dodawanie

Pierwszym krokiem do rozpoczęcia korzystania z usługi jest dodanie nowego urządzenia do konta. Poniżej przedstawiono sposób podłączenia i konfiguracji obsługiwanych urządzeń do serwera MQTT.

Kroki do wykonania po stronie serwera dla każdego typu urządzenia:

  1. Na stronie Urządzenia wypełnij formularz dodawania urządzenia.
  2. Zapisz za pomocą przycisku Dodaj urządzenie i poczekaj na przekierowanie oraz wyświetlenie informacji o sukcesie lub ewentualnym błędzie.
  3. Wybierz interesujące Cię serie w Ustawieniach serii w sekcji Edytuj na stronie Urządzenia.

LK3, LK4, tcPDU

Dostępne są dwa sposoby konfiguracji klienta MQTT:

  1. Zalecane Skorzystaj z Szybkiej konfiguracji z sekcji Edytuj na stronie Urządzenia.

  2. Manualnie wprowadź dane w formularzu w zakładce MQTT Klient na LK3:

    • Mqtt włączone - zaznacz
    • Włącz uwierzytelnianie - zaznacz
    • Użyj TLS - odznacz
    • Użyj LWT - obecnie nie ma znaczenia
    • Wyślij przez modem - wybierz tylko w przypadku używania nakładki GSM/LTE
    • Adres serwera - mqtt.ats.pl - nazwa hosta serwera MQTT (dostępne na stronie infomacje o koncie)
    • Port - 1883 - port serwera MQTT (dostępne na stronie infomacje o koncie)
    • Login - Nazwa klienta MQTT (dostępne na stronie infomacje o koncie)
    • Hasło - Nazwa klienta MQTT (dostępne na stronie infomacje o koncie). Pamiętaj, że to nie jest hasło do Twojego konta.
    • Prefiks tematu - Prefix twojego urządzenia (widoczny przy urządzeniu na stronie Urządzenia)
    • Okres wysyłania - 300 (chyba, że podano inaczej na stronie)
    • KeepAlive - 300 (wartość równa Okres wysyłania lub nieco większa)
    • Wysyłane okresowo - Zaznacz przynajmniej jedno pole wyboru, aby były wysyłane dane
    • Wysłane przy zmianie - obecnie nie ma znaczenia (niedostępne na tcPDU)

    Zatwierdź zmiany przyciskiem Zapisz.

Następnie urządzenie powinno rozpocząć wysyłanie danych, które można obserwować w jego widoku wykresu. Zasadniczo pierwsze dane powinny dotrzeć w ciągu około 5 minut od konfiguracji urządzenia.

Rozwiązywanie problemów z konfiguracją

Jeśli skonfigurowałeś swoje urządzenie i odczekałeś przynajmniej 5 minut na dane w widoku Wykresu i nie widzisz żadnych danych, to coś jest nie tak. Aby dowiedzieć się, co poszło nie tak i jak to naprawić, czytaj dalej.

Najpierw zacznij od kilku sprawdzeń:

  1. Czy na górze zakładki klienta MQTT (na stronie urządzenia) jest widoczny komunikat MQTT connected? Jeśli nie ma żadnego komunikatu o stanie, zdecydowanie zaleca się aktualizację oprogramowania urządzenia do nowszej wersji, aby mieć tę funkcję.
    • Tak - Problem dotyczy konfiguracji klienta MQTT na urządzeniu.
    • Nie - Problem występuje w konfiguracji sieci lub konfiguracji klienta MQTT na urządzeniu.
  2. Czy urządzenie może pobrać czas przez NTP (zakładka Czas na urządzeniu) z ustawieniami domyślnymi (pool.ntp.org:123)?
    • Tak - Problem dotyczy konfiguracji klienta MQTT na urządzeniu.
    • Nie - Problem występuje w konfiguracji sieci na urządzeniu.

Rozwiązania:

  • Konfiguracja sieci - W przypadku konfiguracji statycznej należy wprowadzić poprawny adres IP, bramę i DNS (8.8.8.8 może być użyty jako podstawowy DNS). Jeśli nie masz pewności co do tych wartości, użyj DHCP, ale pamiętaj, że będziesz musiał znaleźć nowy adres IP swojego urządzenia, aby uzyskać do niego dostęp (dzierżawy w sekcji serwer DHCP w większości routerów).
  • Konfiguracja klienta MQTT - Najłatwiejszym i najszybszym rozwiązaniem jest użycie Szybkiej konfiguracji, o której mowa w sekcji Dodawanie. Jeśli z jakiegoś powodu nie możesz z niej skorzystać, ostrożnie przejdź przez ręczną procedurę konfiguracji opisaną na początku tej sekcji. Upewnij się, że w żadnym z pól nie ma dodatkowych spacji (szczególnie przy haśle i prefixie).

Powyższe problemy są najpowszechniejsze, ale mogą występować problemy spowodowane czynnikami zewnętrznymi, np. restrykcyjna zapora blokująca dane wychodzące.

GSMv4.2

  1. Włóż kartę SIM do GSM Kontrolera, podłącz zasilanie. Po chwili zielona dioda powinna migać 3 razy na sekundę.

    Uwaga

    Domyślne ustawienia APN GSM Kontrolera to "internet","","" (nazwa użytkownika i hasło nie ustawione). Jeśli ustawienia twojego operatora są inne koniecznie zmień je na Kontrolerze, wysyłając na jego numer SMS o treści (z wstawionymi danymi dla twojego operatora):

    1234:gprsapn="NAZWA_APN","NAZWA_UŻYTKOWNIKA","HASŁO"

    Uwaga

    Jeśli zielona dioda miga raz na sekundę to urządzenie nie jest połączone z siecią - sprawdź ważność karty.

  2. Wróć na stronę Urządzenia na mqtt.ats.pl, przy dodanym urządzeniu wybierz Parowanie GSM w sekcji Edytuj.

  3. Znajdź numer GSM ID na naklejce na krótkiej instrukcji (pod kodem kreskowym) dołączonej do urządzenia, następnie wprowadź go w polu na stronie i naciśnij Sparuj kontroler GSM z serwerem. Parowanie GSM
  4. GSM Kontroler powinien otrzymać konfigurację z serwera i zrestartować się. Procedura na stronie powinna zająć około 5 sekund (z limitem 30 sekund), a restart urządzenia około 40 sekund.
  5. Przejdź do strony Konfiguracji GSM (pod przyciskiem Edytuj), aby dalej skonfigurować urządzenie. Istotne jest, aby w sekcji Ustawienia MQTT po wybraniu serii zapisać zmiany na urządzeniu klikając Zastosuj wybrane serie na urządzeniu. Konfiguracja GSM

WR-01, Tiny Smart Relay (Tasmota)

  1. Otwórz stronę urządzenia Tasmota.

    Tasmota

  2. W sekcji Configure MQTT wprowadź:

    Tasmota - Configure MQTT

  3. Upewnij się, że w sekcji Configure Other jest zaznaczone MQTT enable.

    Tasmota - Configure Other

tinyESP

Instrukcja przygotowana dla oprogramowania ESP Easy w wersji ESP_Easy_mega_20220427_normal_IRext_no_rx_ESP8266_4M2M.

  1. Po wstępnej konfiguracji (WiFi, ustawienia dostępu, itp.). W ESP Easy przejdź do zakładki Config i w polu Unit Name wprowadź prefix urządzenia wygenerowany na mqtt.ats.pl (widoczny przy urządzeniu na stronie Urządzenia). Ta wartość będzie wykorzystana jako nazwa hosta, MQTT client ID oraz część tematów MQTT.

    tinyESP - Config

  2. W zakładce Controllers kliknij Add obok pierwszej pozycji, wybierz Home Assistant (openHAB) MQTT i wypełnij formularz:

    • Locate Controller: Use Hostname
    • Controller Hostname: mqtt.ats.pl
    • Controller Port: 1883
    • Client Timeout: 1000
    • Use Extended Credentials: zaznacz
    • Controller User: Nazwa klienta MQTT (dostępne na stronie infomacje o koncie)
    • Controller Password: Hasło klienta MQTT (dostępne na stronie infomacje o koncie)
    • Controller Client ID: wpisz %sysname%
    • Controller Subscribe: wpisz %sysname%/#
    • Controller Publish: wpisz %sysname%/%valname%
    • Enabled: zaznacz

    Opcjonalnie możesz także zaznaczyć opcję Send LWT to broker i Will Retain.

    tinyESP - Controllers

  3. Następnie skonfiguruj podłączone czujniki/moduły w zakładce Devices.

    1. Przekaźnik out0 - dodaj Switch input - Switch zmieniając tylko:

      • Name: output
      • Enabled: zaznacz
      • GPIO: GPIO-5 (D1)
      • Send To Controller: zaznacz przy pierwszej pozycji (kontroler MQTT ustawiony w punkcie 2)
      • Interval: 300
      • Values: 1 - out0

      tinyESP - Devices out0

    2. Czujnik BME280 (temperatura, wilgotność i ciśnienie) - dodaj Environment - BMx280:

      • Name: bme
      • Enabled: zaznacz
      • I2C Address: prawdopodobnie 0x76 (118) - (default)
      • Send To Controller: zaznacz przy pierwszej pozycji
      • Interval: 300
      • Values: 1 - t1, 2 - h1, 3 - p1

      Opcjonalnie możesz ustawić Altitude i Temperature offset według potrzeb.

      tinyESP - Devices BME280

    3. W przypadku innych czujników pamiętaj, że wartość wpisana w sekcji Values musi odpowiadać tematom dostępnych serii na stronie mqtt.ats.pl Ustawienia serii, np. ds1, custom1, itd.

Konfiguracja

Po dodaniu urządzenia do swojego konta będziesz mógł skonfigurować niektóre opcje (wymienione w dziale strony Urządzenia). Poniżej znajduje się krótki opis dostępnych ustawień i funkcji zarządzania związanych z urządzeniem, dostępnych w sekcji Edycja.

Zmiana nazwy

W tej sekcji możesz zmienić nazwę urządzenia. Dobrym pomysłem może być użycie opisowych nazw, aby łatwo rozróżniać swoje urządzenia. Nazwa może mieć do 100 znaków, w tym litery, cyfry, spacje oraz kropki.

Ustawienia serii

Tutaj wybierzesz aktywne serie, które powinny być dostępne w widokach wykresów i tabel. Poza tym możesz też ustawić nazwy serii oraz ich kolor na wykresie.

W momencie gdy seria jest aktywowana po raz pierwszy, jest też konfigurowane dla niej zbieranie danych, odebranych po MQTT, do prezentacji na wykresie i w tabeli.

Podgląd strony.

Ustawienia wykresu

Umożliwiają wybranie zakresu danych do pobrania, który będzie prezentowany na wykresie. Wybrany zakres jest zawsze liczony do momentu wyświetlenia wykresu, np. przy wybranym zakresie 7 dni, będą wyświetlane dane z ostatnich 7 dni od momentu wizyty widoku wykresu. Domyślnie jest to ostatni miesiąc (dokładniej ostatnie 30 dni). Należy pamietać, że wraz z większą ilością serii i szerszym zakresem danych, wzrasta też czas przygotowania wykresu do wyświetlenia.

Można też wybrać czy dany wykres powinien być dostępny publicznie, tj. bez konieczności logowania, pod adresem podanym na stronie.

Podgląd strony.

Szybka Konfiguracja (dla LK3, LK4, tcPDU)

Funkcja ułatwiająca konfigurację LK3, LK4 i tcPDU do współpracy z serwerem. Jest zalecana zamiast ręcznej konfiguracji Klienta MQTT na urządzeniu, ponieważ jest szybsza i pozwala uniknąć typowych błędów, takich jak literówki lub wprowadzenie nieprawidłowej wartości. Polega na wygenerowaniu konfiguracji klienta MQTT dla urządzenia, zgodnie z ustawieniami na serwerze (aktywne serie, dane klienta MQTT).

Aby jej użyć należy:

  1. Upewnić się, że urządzenie używa wspieraną wersję firmware (zgodną z opcjami dostępnymi w polu Wersja urządzenia w formularzu Szybkiej Konfiguracji). Instrukcje aktualizacji firmware są dostępne w dokumentacjach LK3, LK4, tcPDU.
  2. Upewnić się, że strona urządzenia jest osiągalna w przeglądarce.
  3. Wybrać jako aktywne serie, które chcesz monitorować, w Ustawieniach serii.
  4. Użyć formularza Szybkiej Konfiguracji, wybierając odpowiednią wersję urządzenia (HW i SW) oraz podając adres IP urządzenia i klikając przycisk Wykonaj Szybką Konfigurację (opcjonalnie kopiując adres linku pod przyciskiem i wklejając go w nowej karcie w przeglądarce).
  5. W efekcie na stronie Klient MQTT na urządzeniu powinien być widoczny komunikat MQTT CONNECTED na zielonym tle. W przeciwnym razie należy sprawdzić instrukcje dostępne w sekcji Rozwiązywanie problemów z konfiguracją.

Podgląd strony.

Parowanie GSM (dla GSMv4.2)

Funkcja do połączenia GSM Kontrolera v4.2 z serwerem. Polega na wysłaniu konfiguracji połączenia MQTT do GSMv4.2, który domyślnie łączy się z serwerem konfiguracyjnym. Użycie parowania GSM jest przedstawione w pierwszych 4 krokach instrukcji dodawania urządzenia.

Konfiguracja GSM (dla GSMv4.2)

Funkcja pozwalająca na konfigurację ustawień GSM Kontrolera v4.2, takich jak automatyzacja (podobna do Zdarzeń na LK), wybór zaufanych numerów, wybór czujników, wybór aktywnych serii do wysyłania ich danych po MQTT do serwera.

Konfiguracji GSMv4.2 można też dokonać korzystając z portu szeregowego lub wiadomości SMS (funkcja na stronie wykorzystuje połączenie MQTT).

Zarządzanie danymi

Obecnie ogranicza się do usunięcia zebranych danych dla danego urządzenia. Może być przydatne gdy urządzenie zostaje użyte do pomiarownia innego miejsca, tak by dane dotyczyły tylko nowej lokacji.

Podgląd strony.

Usuwanie

Nie jest to do końca konfiguracja, ale występuje w interfejsie obok innych funkcji dostępnych dla urządzenia. Pozwala po prostu usunąć urządzenie z konta, np. gdy chcesz dodać urządzenie innego typu, ale nie masz już wolnych miejsc.

Kontrolowanie

Możesz kontrolować swoje urządzenia zdalnie, o ile są one podłączone do naszego serwera MQTT.

Poniższy przykład/instrukcja pokazuje, jak wysłać polecenia do twojego urządzenia (tutaj do LK3), używając strony klienta MQTT.

  1. Subskrybuj tematy /cmd i /cmdr dla Twojego urządzenia (jego prefix + /cmd). Temat /cmd to ten do którego powinny być wysłane polecenia, a /cmdr to ten na który LK3 przysyła potwierdzenia przetworzenia polecenia.
  2. Wybierz temat /cmd w sekcji Publikuj (ten sam z poprzedniego kroku). Wpisz polecenie w polu Wiadomość, np. out0=0 lub out0=1, i wyślij je za pomocą przycisku Publikuj.
  3. W rezultacie, wiadomości wysłane do tematu /cmd i odpowiedzi z /cmdr powinny się pojawić w sekcji Wiadomości.

Wysyłanie polecenia do LK3

Polecenia MQTT

Urządzenia obsługiwane przez nasz serwer mają dostępne różne polecenia oraz drobne różnice w tematach na które, należy je wysyłać.

  • Polecenia dla LK3 są opisane w dokumentacji LK3.

  • Polecenia dla GSMv4.2 są opisane w dokumentacji GSMv4.2.

  • W przypadku WR-01 (Sonoff-Basic module) pełny opis poleceń jest dostępny w dokumentacji oprogramowania Tasmota. W naszym przypadku wystarczające są następujące informacje:

    • temat polecenia - kończy się na /cmnd/power
    • temat wyniku polecenia - kończy się na /RESULT
    • polecenia:
      • włącz wyjście - 1, on, ON
      • wyłącz wyjście - 0, off, OFF
      • przełącz wyjście - 2, toggle, TOGGLE