7.6 SERVICES

Routery RACOM są wyposażone w narzędzie SDK, które umożliwia w prosty i szybki sposób na implementację dodatkowych funkcji, potrzebnych klientowi.

Narzędzie składa się z:

• Hosta SDK, który definiuje środowisko uruchomieniowe (zwane również 'piaskownicą'), kontroluje dostęp do zasobów systemu (pamięci, nośników i procesora),
• interpreter języka programowania ARENA, lekki skryptowy język optymalizowany na systemy osadzone, który wykorzystuje składnię podobną do ANSI-C ale też daje wsparcie dla wyjątków, automatyczne zarządzanie pamięcią i  polimorficzny/wielopostaciowy runtime,
• API firmy RACOM to dedykowany interfejs programowania aplikacji, który zawiera wszechstronny zestaw funkcji dostępowych dla warstwy sprzętowej, jak: porty I/O, GPS, USB, RS-232, a także pobieranie parametrów stanu systemu, oraz wysyłanie powiadomień e-mail lub SMS lub zapisania tych danych w pamięci routera.

Programiści, pracujący w języku C bez problemów poradzą sobie w tym środowisku. Jakkolwiek w razie problemów prosimy o kontakt ze wsparciem technicznym na adres pomoc@karczpolska.pl

Język programowania

Język skryptowy arena oferuje szeroki zakres funkcji POSIX (printf lub open),  udostępnia interfejs API (Interfejs programowania aplikacji), co umożliwia wdrożenie różnego typu aplikacji do obsługi urządzenia MiDGE lub łączenia się z jego usługami, np. za pomocą telefonu GSM.

Tutaj prosty przykład:

/* This script prints short status and if the SMS section is setted properly, the status will be send even to your mobile phone :-)
 */
 
printf("------------------------------");
printf("\n\n");
printf(nb_status_summary(all));
printf("\n\n");
printf("------------------------------");
 
/* Please change the following number to your mobile phone number
 */
nb_sms_send("+420123456789", nb_status_summary(all));

Zestaw prostych skryptów można pobrać bezpośrednio z routera.  Instrukcja znajduje się w menu SERVICES -> Administration -> Troubleshootings -> SDK API, które zawiera szczegółowe wprowadzenie do języka, w tym opis wszystkich dostępnych funkcji.

Funkcje SDK API

Zakres funkcji API może być użyty do wdrożenia następujących funkcji:

• odbieranie wysyłanie SMS
• wysyłanie e-mail
• odczyt/zapis od/do portu szeregowego
• kontrola nad portami I/O
• uruchamianie serwera TCP/UDP
• uruchamianie klienta IP/TCP/UDP
• dostęp do plików na zewnętrznym nośniku danych (pendrive usb)
• odbieranie informacji o statusie systemu
• pobieranie/wysyłanie konfiguracji
• zapis do syslog
• transfer plików przez HTTP/FTP
• pobieranie zdarzeń systemowych / reboot systemu
• kontrola diod LED

Instrukcja SDK API jest w menu SERVICES-Administration-Troubleshootings-SDK zawiera dokładne wyjaśnienie tych funkcji.

Proszę zauważyć że niektóre funkcje wymagają prawidłowo skonfigurowanych odpowiednich usług (email, sms) aby ich używać w SDK.

Opisana tutaj zostanie funkcja API nb_status. Jest ona wykorzystywana do odpytywania routera o statusy wartości – w podobny sposób jak pokazuje to CLI. Pokazuje strukturę zmiennych dla odpowiedniej sekcji.

Przez użycie funkcji dump możesz sprawdzić treści zwracanej struktury.

/* Dump current WAN status */

dump ( nb_status ("wan") );

Wtedy skrypt wygeneruje podobną odpowiedź:

struct(17): {
  .WANLINK1_GATEWAY = string[11]: "10.64.64.64"
  .WANLINK1_STATE = string[2]: "up"
  .WANLINK1_STATE_UP_SINCE = string[19]: "2013-01-22 09:00:47"
  .WANLINK1_DIAL_ATTEMPTS = string[1]: "1"
  .WANLINK5_STATE = string[8]: "disabled"
  .WANLINK1_DIAL_SUCCESS = string[1]: "1"
  .WANLINK1_ADDRESS = string[10]: "10.204.8.0"
  .WANLINK1_SERVICE_TYPE = string[4]: "hspa"
  .WANLINK1_TYPE = string[4]: "wwan"
  .WANLINK1_DIAL_FAILURES = string[1]: "0"
  .WANLINK1_REGISTRATION_STATE = string[23]: "registeredInHomeNetwork"
  .WANLINK1_SIM = string[4]: "SIM1"
  .WANLINK1_INTERFACE = string[5]: "wwan0"
  .WANLINK3_STATE = string[8]: "disabled"
  .WANLINK1_SIGNAL_STRENGTH = string[3]: "-73"
  .WANLINK4_STATE = string[8]: "disabled"
  .WANLINK2_STATE = string[8]: "disabled"
}

W połączeniu z funkcją nb_config_set jest możliwe przekonfigurowanie każdej części systemu w momencie zmiany stanu. Możesz zapytać możliwe sekcje i parametry ponownie z CLI:

~ $ cli get -c network
Showing configuration sections (matching 'network'):
 
network.link
network.hostname
network.lanInterface
network.wlanInterface
network.wanInterface
network.DNS
network.DHCP
network.NTP
network.timezone
network.MSS
 
~ $ cli get -c network.NTP
Showing configuration sections (matching 'network.NTP'):
 
network.NTP.status
network.NTP.server
network.NTP.server2
network.NTP.gpstime

Dzięki uruchomienie CLI w trybie interaktywnym możesz także przejść przez możliwe parametry konfiguracyjne przy pomocy klawisza TAB.

Tutaj przykład jak możesz zaadaptować taką funkcję:

/* Check the current NTP server and set it to the IP address 192.168.0.2
   and enable the NTP synchronisation
*/
 
printf ("The NTP server was previously using IP address: ");
printf (nb_config_get("network.NTP.server"));
printf("\n\n");
nb_config_set("network.NTP.server=192.168.0.2");
 
if (nb_config_get ("network.NTP.status") == "0"){
  
   printf ("and was not running."); 
   printf("\n\n");
   nb_config_set ("network.NTP.status=1");
   }
   else {
   printf ("and was running."); 
   printf("\n\n");
   }
 
printf ("The NTP server is now running with IP address: ");
printf (nb_config_get("network.NTP.server"));

Uruchomienie SDK

W przypadku SDK mówimy o skryptach (scripts) i wyzwalaczach (triggers) które biorą się z zadań (jobs). Każdy skrypt może być wysłany do routera albo zaimportowany przy użyciu odpowiedniej paczki konfiguracyjnej. Można także edytować te skrypty bezpośrednio przez WEB MANAGER’a albo wybrać jeden z naszych przykładów. Następnie w sekcji Testing routera, możesz sprawdzić składnię albo uruchomić test.

Po załadowaniu, musisz określić wyzwalacz – czyli powiedzieć routerowi kiedy ma uruchomić skrypt. Można to określić w czasie (w każdy poniedziałek ) albo wyzwolić za pomocą jednego ze zdefiniowanych zdarzeń systemowych (np. uruchomianie WAN). Dzięki skryptowi i wyzwalaczowi możesz ustawić zadanie SDK. Dzięki funkcji testowania można sprawdzić czy zadanie działa prawidłowo. Sekcja administracyjna oferuje możliwości rozwiązywania wszystkich problemów i kontroli uruchomienia skryptów. Za SDK Host (sdkhost) odpowiada  „daemon” zarządzający skryptami i ich działaniami – aby system nie uległ uszkodzeniu. Pod względem zasobów ograniczy zużycie procesora i pamięci dla działających skryptów i zapewni predefiniowaną część dostępnego nośnika flash. Można ją rozszerzyć przez nośnik USB albo jeśli model routera posiada – kartę SD.

Pliki zapisane do /tmp będą przechowywane w pamięci oraz usunięte podczas restartu skryptu. Dopóki skrypt działa w ‘piaskownicy’ (sandbox) nie masz dostępu do narzędzi systemowych (np. ifconfig)/

Administracja SDK

Na stronie SDK Administration możesz kontrolować SDK host i wprowadzać następujące ustawienia:

Zakładka Status informuje o bieżącym statusie SDK. Zawiera informacje o każdym zakończonym zadaniu, możesz tutaj także zatrzymać działający skrypt oraz zobaczyć „wyjście” skryptu. W zakładce rozwiązywania problemów (Troubleshooting) można znaleźć łącza do pobierania, podręczników oraz przykładów.

Job Managment

Zarządzanie zadaniami

Ta strona jest używana do konfiguracji skryptów, wyzwalaczy i zadań.

Można teraz dodać twój skrypt do systemu i wprowadzić następujące parametry:

Prawidłowa metoda to stworzenie wyzwalacza zbudowanego z następujących parametrów:

Teraz możemy ustawić już zadanie, może być stworzone z następującymi parametrami:

Testowanie

Strona testowa oferuje edytor i pole wprowadzania wartości i opcjonalnych argumentów które mogą być używane do wykonywania testów według skryptu lub przetestować dedykowane jego fragmenty.

W przypadku błędów składni, Arena wyświetli numer błędu (wskazując linię i pozycję gdzie błąd się pojawił) :
/scripts/testrun:2:10:FATAL: parse error, unexpected $, expecting ’;’

SDK - Przykładowe Aplikacje

Jako wprowadzenie przedstawiamy przykładową aplikacje: „SMS control scripts”, która implementuje zdalną kontrolę SMS na routerem oraz może być też używana do wysyłania informacji o statusie systemu. Skrypt możemy edytować. Jego źródło jest widoczne po ponownym wejściu w zakładkę Services/SDK/Job Management -> Scripts.

Wiadomość wysyłamy na numer MSISDN (telefonu) przypisanego do karty SIM w routerze. Wymagane jest hasło w pierwszej linii i komendę w drugiej linii jak w przykładzie:

admin01
status

Rekomendujemy zabezpieczenie hasłem aby uniknąć nieautoryzowanego dostępu, jednak można użyć parametru „noauth” by je wyłączyć. Możesz wtedy pominąć pierwszą linię zawierającą hasło. W skrypcie można też zdefiniować listę dozwolonych nadawców. Błędy skryptów będą pokazane w logu systemowym.

Obsługiwane są następujące polecenia:

Odpowiedź na polecenie status zazwyczaj wygląda tak:

7.6.2 DHCP Serwer

Tego menu używamy do konfiguracji serwisu DHCP dla każdego interfejsu LAN.

7.6.3 Serwer DNS

Serwer DNS może być użyty jako proxy DNS dla serwerów w sieci LAN. Przez wskazanie żądań DNS do routera można zmniejszyć wychodzący ruch DNS który jest buforowany, ale  może być również stosowany do podawania ustalonych adresów dla poszczególnych hostów.

Można dodatkowo skonfigurować statyczne hosty dla obsługi statycznych adresów IP dla różnych hostów

NTP Serwer

MiDGE może być serwerem czasu NTP dla urządzeń pracujących po stronie LAN. Serwis wystarczy włączyć (enabled) oraz ustawić zakres hostów, które będą korzystać z usługi.

Status administracyjny: Włączony lub wyłączony

Poll interwal (interwał odpytywania): Definiuje interwał odpytywania (64-2048 sekund) dla synchronizowania czasu z zegarem czasu master serwera

Allowed hosts (dopuszczone hosty): Definiuje zakres adresów IP które są dopuszczone do serwera NTP

7.6.4 Dynamic DNS

Klient Dynamicznego DNS jest kompatybilny z różnymi serwisami DynDNS dostępnych w Internecie w rozumieniu definicji podanej przez www.dyndns.com Router RACOM może działać jako serwer DynDNS po wprowadzeniu odpowiedniej licencji SERWERA. Wówczas pozostałe hosty muszą wskazywać na router MiDGE.

7.6.5 E-mail client

Klient poczty e-mail może być wykorzystany do wysyłania powiadomień zawierających pewne wydarzenia systemowe lub użyty w skryptach SDK.

Ze względu na aktualne zabezpieczenia serwerów pocztowych, zalecamy korzystanie z konta pocztowego oparatora sieci, w której pracuje karta SIM. Jest to jedyna gwarancja poprawności działania usługi.

7.6.6 Events

Dzięki funkcji menadżera zdarzeń możemy powiadamiać jednego lub wielu administratorów przez SMS lub EMAIL o wybranych zdarzeniach systemowych. Wiadomość zawiera opis i krótką notatkę systemową.

Ta strona pozwala na zarządzanie wiadomościami SMS.

Administracja

Na routerach Racom możliwe jest wysyłanie i odbieranie wiadomości SMS przez każdy zainstalowany modem (w zależności od wersji urządzenia). Komunikaty są odbierane przez odpytywanie karty SIM przez modem, przez co wymagane jest przypisanie karty SIM do modemu na stronie w zakładce SIM.

Proszę pamiętać, że w przypadku, gdy działa wiele interfejsów WWAN korzystających z tej samej karty SIM, system może przełączyć kartę SIM podczas pracy, co również skutkować różnymi ustawieniami w komunikacji SMS.

Odebrane wiadomości są pobierane z karty SIM i tymczasowo przechowywane na routerze (system usuwa je po restarcie). Jeśli chcesz zachować ich kopię należy przygotować odpowiedni skrypt SDK.

Wysyłanie SMS zależy od stanu rejestracji modemu oraz stanu Centrum SMS (czy działa prawidłowo czy nie). Można użyć raportów SMS do sprawdzenia czy wiadomość została doręczona.

Proszę pamiętać, że modem może zalogować się w roamingu do obcej sieci gdzie obowiązują inne stawki za połączenia. Można ręcznie wybrać sieć (LAI Location area identity) w zakładce SIM.

Na stronie poniżej można włączyć/wyłączyć serwis SMS:

Administracja

Na routerach Racom możliwe jest wysyłanie i odbieranie wiadomości SMS przez każdy zainstalowany modem (w zależności od wersji urządzenia). Komunikaty są odbierane przez odpytywanie karty SIM przez modem, przez co wymagane jest przypisanie karty SIM do modemu na stronie w zakładce SIM.

Proszę pamiętać, że w przypadku, gdy działa wiele interfejsów WWAN korzystających z tej samej karty SIM, system może przełączyć kartę SIM podczas pracy, co również skutkować różnymi ustawieniami w komunikacji SMS.

Odebrane wiadomości są pobierane z karty SIM i tymczasowo przechowywane na routerze (system usuwa je po restarcie). Jeśli chcesz zachować ich kopię należy przygotować odpowiedni skrypt SDK.

Wysyłanie SMS zależy od stanu rejestracji modemu oraz stanu Centrum SMS (czy działa prawidłowo czy nie). Można użyć raportów SMS do sprawdzenia czy wiadomość została doręczona.

Proszę pamiętać, że modem może zalogować się w roamingu do obcej sieci gdzie obowiązują inne stawki za połączenia. Można ręcznie wybrać sieć (LAI Location area identity) w zakładce SIM.

Na stronie poniżej można włączyć/wyłączyć serwis SMS

Routing i filtrowanie

Dzięki routingowi SMS możesz zdefiniować reguły ruchu wychodzącego dla SMSów. Dla danego numeru, można na przykład wymusić wysyłanie wiadomości przez dedykowaną kartę SIM.

Numery telefonów można również opisać przez wyrażenia regularne, oto kilka przykładów:

+12345678 - Wybrany na stałe numer

+1* - Numer zaczynający się od +1

+1*9 - Numer zaczynający się na +1 kończący się na 9

+[12]* - Numery zaczynające się na 1 lub 2

Numery muszą być podane w formacie międzynarodowym zawierającym prawidłowy prefix. Można także zdefiniować reguły odrzucające wychodzące wiadomości w celu uniknięcia drogich serwisów lub międzynarodowych numerów.

Oba typy reguł z listy będą przetwarzane na żądanie, będą przesyłać wiadomości wychodzące przez wybrany modem albo je anulować. Wiadomości które nie pasują do żadnej reguły będą przekazywane do pierwszego wolnego modemu.

Status

Menu Status jest wykorzystywane przez bieżący modem do pobierania informacji o każdej wysłanej lub odebranej wiadomości. Jest zaimplementowany czytnik SMS inbox do podglądu albo usuwania wiadomości. Skrzynka inbox będzie czyszczona jeśli przekroczy 512 kBytes.

Testowanie

Ta strona jest przeznaczona do testowania wysyłania wiadomości SMS oraz filtrowania i routingu komunikatów. Maksymalna długość wiadomości to 160 znaków, sugerujemy korzystać wyłącznie z liter, które są obsługiwane przez 7-bitowy alfabet GSM – polskich znaków.

7.6.8 SSH/Telnet Server

Poza Web Managerem, dostęp do routera jest też obsługiwany przez SSH i serwis TELNET. Do prawidłowego logowania potrzebne jest prawidłowe hasło użytkowników ‘root’ i ‘admin’. Dodatkowi użytkownicy, utworzeni w zakładce ‘User Accounts’, mogą uzyskać dostęp do routera za pomocą SSH/Telent ale nie będą mieli uprawnień na dokonanie jakichkolwiek zmian. CLI jest dostępne jest dla wszystkich użytkowników, jednak będą tylko widzieć wartości statusu.

Tylko Administrator lub Root (zależnie od konsoli) może dokonywać zmian w systemie.

SSH i Telnet dostępne są również z interfejsu ETH. Aby wyłączyć lub ograniczyć dostęp do nich dostęp należy zdefiniować odpowiednie reguły w zaporze firewall.

Konfiguracja usługi Telnet/SSH:

M!DGE jest wyposażony usługę SNMP, wspierającą tabele MIB (np. ifTable) oraz dodatkowe rozwiązania systemowe MIB do zarządzania wieloma urządzeniami. M!DGE OID zaczyna się od prefixu 1.3.6.1.4.1.33555.10. Odpowiedni VENDOR MIB znajduje się na routerze.

Po włączeniu agenta SNMP, pułapki SNMP generowane są dla następujących warunków:

• Uruchomienie systemu
• Zamknięcie systemu
• VPN połączony
• VPN rozłączony
• Siła sygnału spadła poniżej progu pułapki "Siła sygnału"

Pułapka (trap) na start wyzwalana jest z użyciem standardowej funkcji cold Start i warm Start. Pułapka (trap) zamknięcia systemu jest wysłana, kiedy system jest restartowany przez funkcje ‘reboot’ z interfejsu Web lub kiedy 'watchdog' zrestartuje system.

Rozszerzenia M!DGE zawierają wsparcie do:

• Restartu urządzenia
• Zaktualizowania nowego oprogramowania systemowego przez FTP/TFTP/http
• Zaktualizowania nowej konfiguracji  przez FTP/TFTP/http
• Pobranie informacji o WWAN/GNSS/WLAN/DIO

Ustawienie wartości MIB jest zarezerwowane dla SNMPv3 i tylko „admin” jest uprawniony do wyzwolenia rozszerzenia.

Uwaga: Należy zwrócić uwagę na fakt, że hasła SNMP muszą zawierać więcej niż 8 znaków. Krótsze hasła będą zdublowane np. hasło „admin01” zamieni się na „admin01admin01”

Rozszerzenia SNMP mogą być odczytywane i wywołane w następujący sposób:

- Aby pobrać wersję systemu:

snmpget -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1

1.3.6.1.4.1.33555.10.40.1.0

- Aby pobrać wersję kernela:

snmpget -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1

1.3.6.1.4.1.33555.10.40.2.0

- Aby pobrać numer seryjny:

snmpget -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1

1.3.6.1.4.1.33555.10.40.3.0

- Aby zrestartować urządzenie:

snmpset -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1

1.3.6.1.4.1.33555.10.40.10.0 i 1

- Aby uruchomić aktualizację konfiguracji:

snmpset -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1

1.3.6.1.4.1.33555.10.40.11.0 s "http://server/directory"

UWAGA: Aktualizacja konfiguracji spodziewa się pliku zip nazwanego <numer-seryjny>.zip w wybranym katalogu zawierającym „user-config.zip”. Wspierane protokoły to TFTP, http(s), i FTP. Określanie nazwy użytkownika / hasła lub portu nie jest jeszcze obsługiwane.

- pobranie status aktualizacji konfiguracji:

snmpget -v 3 -u snmpadmin -n "" -l authNoPriv -a MD5 -x DES -A snmpadmin 192.168.1.1

1.3.6.1.4.1.31496.10.40.12.0

Wynikowa wartości może być: (1) sukcjes, (2) porażka, (3) w trakcie, (4) nie wystartowała.

- uruchomienie aktualizacji systemu:

snmpset -v 3 -u admin -n "" -l authNoPriv -a MD5 -x DES -A admin01admin01 192.168.1.1

1.3.6.1.4.1.31496.10.40.13.0 s "http://server/directory"

- pobranie status aktualizacji systemu:

snmpget -v 3 -u snmpadmin -n "" -l authNoPriv -a MD5 -x DES -A snmpadmin 192.168.1.1

1.3.6.1.4.1.31496.10.40.14.0

Wynikowa wartości może być: (1) sukces, (2) niepowodzenie, (3) w trakcie, (4) nie wystartowała.

Konfiguracja SNMP

7.6.10 Serwer WWW

Na tej stronie możesz ustawić porty dostępowe dla Web Managera, czyli zdalnej komunikacji z routerem M!DGE. Rekomendujemy HTTPS jako dostępo do serwisów MiDGE przez interfejs WAN, ponieważ jest on zaszyfrowany.

Standardowo wykorzystywane są porty 80 dla http i 443 dla https. Zalecamy zmianę na inne, aby nie kolidowały z ewentualnymi usługami. Stosowanie portów 8080, 20000, czy 446, 447 jest jak najbardziej wskazane.

Aby używać https należy wygenerować albo zaimportować do routera certyfikaty. Odpowiednie narzędzia dostępne są w sekcji SYSTEM -> Keys and Certificates.

Pamiętaj, że jeżeli ustawisz przekierowanie NAT 1:1 (cały ruch na serwer "za routerem"), powyższe porty również zostaną przekierowane!