Skip to content

Latest commit

 

History

History
106 lines (60 loc) · 4.29 KB

notify-install.rst

File metadata and controls

106 lines (60 loc) · 4.29 KB
Raw

ODK-X Notify

:dfn:`ODK-X Notify` has 2 components:

  • Desktop application(Skunkworks-Parrot)
  • Mobile application(Skunkworks-Bat)

:program:`Skunkworks-Parrot` is the desktop application, written in Java, that provides a user interface for writing messages, creating user groups to receive them, and sending those messages via the Firebase Cloud Messaging.

:program:`Skunkworks-Bat` is the Android application that receives these messages via Firebase, checks the user credentials to see if the user is in the group that should receive this message, and displays the message to the user.

Installing ODK-X Notify

Prerequisites

Setting up ODK-X Notify

:program:`Skunkworks-Parrot (Desktop App)`:

  1. Navigate to https://github.com/odk-x/skunkworks-parrot/releases and download the latest ODK-X_Notify_Desktop.jar file.
  2. Double click the file to start. If that fails try running:
$ java -jar path/to/jar
  1. When the application opens, Click Configure. A window shown below will appear
/img/notify-setup/notify-setup.*
  1. To use the Skunkworks-Parrot App, the user needs to create a firebase project and add that project's information in the configure window. The step-by-step instructions can be found in this guide.
  2. After adding all the required information in configure window, Click :menuselection:`Save`.

:program:`Sync-Endpoint`:

Note

Make sure you have installed the ODK-X Services app and ODK-X Tables app in an android device and have a running Sync-Endpoint server before proceeding for following steps.

  1. Download all the folders from this link and move them to :file:`sdcard/opendatakit/default/config/tables/` directory in your android device.
  2. Place “google-services.json” file obtained from step 8 of firebase setup under the :file:`sdcard/opendatakit/default/config/assets/` directory.
  3. Open the ODK-X Tables app. Tables app will automatically generate all the required files for server setup. After you see the message “Initialization completed successfully” you can close the ODK-X Tables app.
  4. Using ODK-X Services app :ref:`reset app server<services-managing>`.

:program:`Skunkworks-Bat (Android App)`:

Note

Before installing the Bat app make sure you have installed the :ref:`ODK-X Services<services-using>` app.

  1. From your device's :guilabel:`Settings`, choose :menuselection:`Security`.
  1. Open a web browser on your phone.
  2. Navigate to https://github.com/odk-x/skunkworks-bat/releases/ and download the latest ODK-X Notify APK.
  3. In the download window, you will see ODK-X_Notify.N.N.apk. - Select it to download the file.
  • On older devices, the APK will automatically install after you approve the security settings.
  • On newer devices, you must go to the download list, rename the file to restore the .apk extension (the extension will have been renamed to .man during the download process), then click on it to install it.

Note

You can also download the ODK-X Notify-Bat APK to your computer and load it on your device via adb or another tool like AirDroid.

Using ODK-X Notify

.. toctree::
  :maxdepth: 2

  notify-using