Подготовка

Перед использованием Promobot JS API, рекомендуем скачать архив SDK Promobot. В состав архива входит документация, а также пример использования Promobot JS API.

В качестве локального http сервера на роботе предустановлен nginx. JS приложение запускается в GUI робота через встроенный браузер (webview).

Пример использования JS API

Приложение js-example создано для ознакомления с основными возможностями API.

Чтобы запустить js-example выполните следующие действия:

• Установите SDK по инструкции из файла README.md
• Скопируйте файлы из ExampleJSApp/www/example (из архива с SDK) в директорию /var/www/example (на роботе).
• Откройте приложение js-example из меню приложений GUI Promobot.

Установка собственного приложения

Для установки готового приложения требуется выполнить следующие шаги:

• Загрузить страницу с JS приложением на робота.

Директория для установки приложения: /var/www/<project_name>, где project_name – уникальное имя JS приложения.

• Создать C++ плагин для запуска страницы приложения.

Для этого в директории /var/src создайте каталог <project_name>, а затем скопируйте в созданный каталог содержимое ExampleJSApp.

В файле CMakeLists.txt заполнить поле project (название должно быть уникальным).

В файле description.json заполнить поле sys_name (название должно быть уникальным), а также в поле type выставить значение 0 (тип приложения по умолчанию).

0 - приложение будет работать как главное (нельзя закрыть)
1 - обычное приложение, можно запустить из другого

В файле package.xml заполнить поле name (название должно совпадать с указанным в CMakeLists.txt).

В файле examplejsdialogobject.cpp вместо "http://localhost/example/index.html" указать "http://localhost/<project_name>/index.html", где project_name – уникальное имя JS приложения.

• Установить плагин

Для этого требуется выполнить в консоли следующую команду:

./build.sh install -DCMAKE_INSTALL_PREFIX=/opt/promobot/

• Выбрать новое приложение по умолчанию

Чтобы задать приложение, используемое по умолчанию, требуется изменить соответствующую настройку в меню робота (Управление > Настройки > Приложения), после чего перезагрузить GUI.