Tutorial
Celem tego krótkiego tutorialu jest pokazanie podstawowych funkcji aplikacji vb4nao oraz demonstrację ich działania na symulowanym w konsoli robocie. Dzięki temu, w ciągu kilku minut można rozpocząć pracę z programem i korzystać z jego podstawowych funkcjonalności.
Aby uruchomić program należy najpierw sklonować repozytorium (wymagany Git), a następnie zbudować projekt poleceniem make (potrzebna Java oraz Maven). Szczegółowe informacje jak to zrobić znajdują się w pliku README.md na stronie głównej tego repozytorium.
Po zbudowaniu aplikacji program powinien uruchomić się automatycznie, jeśli jednak tak się nie stanie można skorzystać z gotowych skryptów uruchamiających znajdujących się w folderze release. Dla systemów UNIXowych przygotowany został plik vb4nao.sh, natomiast na maszyny z Windowsem vb4nao.cmd. Jeśli chcemy uruchomić program na konsoli, a nie na rzeczywistym robocie, należy uruchomić skrypt z argumentem console.
~$ ./release/vb4nao.sh console
Po uruchomieniu programu okno konsoli powinno wyglądać w ten sposób:
Robot po uruchomieniu zaczyna pracę w manu głównym, gdzie użytkownik może dokonać trzech wyborów:
- predefined
- dictate
- exit
Pierwsze słowo wprowadza nas w tryb wybierania predefiniowanych stron. Robot ma zapisane w pamięci kilka stron internetowych, które następnie można odwiedzić mówiąc jedno słowo, a nie dyktując cały adres. Więcej o tym trybie w podrozdziale Predefiniowane strony.
Słowo dictate powoduje wejście w tryb dyktowania, w którym można podyktować robotowi dowolny adres strony którą ma przeczytać. Więcej na temat tego trybu w podrozdziale Dyktowanie stron.
Aby wyjść z menu głównego i zakończyć pracę należy użyć słowa exit. Słowo to jest rozpoznawane później również w innych trybach i zawsze powoduje zamknięcie programu i zakończenie pracy.
Aby wejść do trybu dyktowania należy w menu głównym skorzystać z opcji dictate. Robot zaczyna wtedy nasłuchiwać i czeka na kolejne litery alfabetu.
Aby usprawnić komunikację głosową do dyktowania liter należy używać alfabetu fonetycznego NATO, który robot jest w stanie rozpoznać znacznie lepiej niż dźwięk pojedynczych liter. Po każdym podyktowanym słowie robot powtarza co usłyszał, aby uniknąć błędu. Do określenia kropki należy użyć słowa kluczowego dot.
Do zakończenia dyktowania służy słowo kluczowe okay po którym robot upewnia się czy wpisano poprawny adres.
Aby zatwierdzić stronę należy wpisać okay, natomiast słowo no umożliwia dyktowanie adresu od początku. Po pobraniu danej strony robot wypisuje znalezione na niej sekcje i czeka na wybór użytkownika. Więcej o tym menu w podrozdziale Sekcje.
Aby skorzystać z możliwości wyboru predefiniowanych stron, należy w menu głównym użyć opcji predefined. W tej sytuacji robot pyta o słowo kluczowe definiujące daną stronę:
Po wpisaniu danego słowa robot ściąga określoną stronę, wydziela sekcje oraz wypisuje je użytkownikowi.
Przeglądarka vb4nao umożliwia czytanie tylko wybranych, interesujących nas fragmentów danej witryny, które wybieramy w menu Sekcje. Robot pobiera wybraną stronę, parsuje jej zawartość i arbitralnie dzieli ją na sekcje zawierające tytuł oraz treść. Następnie wypisuje użytkownikowi wszystkie tytuły wydzielonych sekcji wraz z literą alfabetu (fonetycznego NATO) przyporządkowaną do każdej z nich. Wybranie sekcji następuje poprzez wpisanie litery odpowiadającej pożądanej przez nas sekcji.
Po wybraniu sekcji robot odczytuje jej zawartość, a następnie przechodzi z powrotem do menu sekcji, w którym możemy wybrać kolejny fragment witryny do odczytania. Poza literami wyboru w tym menu można również skorzystać z poleceń start, again oraz exit, które umożliwiają odpowiednio przejście do menu głównego, powtórzenie wszystkich znalezionych sekcji oraz zakończenie pracy i zamknięcie programu. Po odczytaniu dowolnej ilości fragmentów możemy na przykład zdecydować się na powrót do menu głównego, a następnie wyjście z programu
Poniżej zamieszczono diagram, który podsumowuje sposób działania aplikacji w formie maszyny stanowej:
