This documentation was last modified: Tuesday, August 13th, 2019 at 3:56 pm
Mycroft for Android is still in proof of concept and is not ready for general use. There is no .apk available, and to use Mycroft for Android at the moment, you will need to be familiar with Android Studio.
- Mycroft for Android
There are two components to Mycroft for Android:
The Android companion app. The app works by opening a websocket connection to the
mycroft-coremessagebus, 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-coreinstalled 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 Android Studio installed, and are familiar with using Android Studio. If not, this introduction is a good starting point.
- 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-Android Cloning into 'Mycroft-Android'... remote: Counting objects: 1381, done. remote: Total 1381 (delta 0), reused 0 (delta 0), pack-reused 1381 Receiving 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