There are two components to Mycroft for Android:
The Android companion app. The app works by opening a websocket connection to the
mycroft-core messagebus, and sending and receiving messages from there. It implements voice recognition and Text to Speech (TTS) via Google APIs at the moment,
Mycroft Core. Mycroft for Android requires that you already have
mycroft-core installed and working on a machine that the Android application can access via a websocket connection.
This section of documentation assumes the following:
That you already have an Android device, and that you're comfortable loading Android applications on to the device from Android Studio.
First, you will need to clone the
git repo and import it into your IDE.
$ git clone https://github.com/MycroftAI/Mycroft-AndroidCloning into 'Mycroft-Android'...remote: Counting objects: 1381, done.remote: Total 1381 (delta 0), reused 0 (delta 0), pack-reused 1381Receiving objects: 100% (1381/1381), 538.46 KiB | 210.00 KiB/s, done.Resolving deltas: 100% (648/648), done.Checking connectivity... done.
From Android Studio, choose
File -> Open file or Project and select the directory you cloned
Mycroft-Android into. Android Studio will attempt to load the project, and build the project using Gradle. You may be prompted to install additional components.
@TODO not sure how this works
There is no need to pair Mycroft for Android, as the companion app connects to your
mycroft-core instance, and uses the pairing from that.
The easiest way to keep Mycroft for Android updated is to clone the
git repo when you want to build a new image to deploy to your Android phone.
@TODO link to Troubleshooting