Mycroft AI
  • Documentation
  • About Mycroft AI
    • Why use Mycroft AI?
    • Glossary of terms
    • Contributing
    • FAQ
  • Using Mycroft AI
    • Get Mycroft
      • Mark II
        • Mark II Dev Kit
      • Mark 1
      • Picroft
      • Linux
      • Mac OS and Windows with VirtualBox
      • Docker
      • Android
    • Pairing Your Device
    • Basic Commands
    • Installing New Skills
    • Customizations
      • Configuration Manager
      • mycroft.conf
      • Languages
        • Français (French)
        • Deutsch (German)
      • Using a Custom Wake Word
      • Speech-To-Text
      • Text-To-Speech
    • Troubleshooting
      • General Troubleshooting
      • Audio Troubleshooting
      • Wake Word Troubleshooting
      • Log Files
      • Support Skill
      • Getting more support
  • Skill Development
    • Voice User Interface Design Guidelines
      • What can a Skill do?
      • Design Process
      • Voice Assistant Personas
      • Interactions
        • Intents
        • Statements and Prompts
        • Confirmations
      • Conversations
      • Error Handling
      • Example Interaction Script
      • Prototyping
      • Design to Development
    • Development Setup
      • Python Resources
      • Your First Skill
    • Skill Structure
      • Lifecycle Methods
      • Logging
      • Skill Settings
      • Dependencies
        • Manifest.yml
        • Requirements files
      • Filesystem access
      • Skill API
    • Integration Tests
      • Test Steps
      • Scenario Outlines
      • Test Runner
      • Reviewing the Report
      • Adding Custom Steps
      • Old Test System
    • User interaction
      • Intents
        • Padatious Intents
        • Adapt Intents
      • Statements
      • Prompts
      • Parsing Utterances
      • Confirmations
      • Conversational Context
      • Converse
    • Displaying information
      • GUI Framework
      • Show Simple Content
      • Mycroft-GUI on a PC
      • Mark 1 Display
    • Advanced Skill Types
      • Fallback Skill
      • Common Play Framework
      • Common Query Framework
      • Common IoT Framework
    • Mycroft Skills Manager
      • Troubleshooting
    • Marketplace Submission
      • Skills Acceptance Process
        • Information Review Template
        • Code Review Template
        • Functional Review Template
        • Combined Template
      • Skill README.md
    • FAQ
  • Mycroft Technologies
    • Technology Overview
    • Roadmap
    • Mycroft Core
      • MessageBus
      • Message Types
      • Services
        • Enclosure
        • Voice Service
        • Audio Service
        • Skills Service
      • Plugins
        • Audioservice Plugins
        • STT Plugins
        • TTS Plugins
        • Wake Word Plugins
      • Testing
      • Legacy Repo
    • Adapt
      • Adapt Examples
      • Adapt Tutorial
    • Lingua Franca
    • Mimic TTS
      • Mimic 3
      • Mimic 2
      • Mimic 1
      • Mimic Recording Studio
    • Mycroft GUI
      • Remote STT and TTS
    • Mycroft Skills Kit
    • Mycroft Skills Manager
    • Padatious
    • Precise
    • Platforms
Powered by GitBook
On this page
  • Prerequisites
  • Getting Started
  • Connecting to a mycroft-core instance
  • Pairing Mycroft for Android
  • Keeping Mycroft for Android updated
  • Common issues with Mycroft for Android

Was this helpful?

  1. Using Mycroft AI
  2. Get Mycroft

Android

Mycroft for Android is a Community led project. It is a proof of concept and is not ready for general use. There is no .apk available.

PreviousDockerNextPairing Your Device

Last updated 5 years ago

Was this helpful?

There are two components to Mycroft for Android:

  1. 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,

  2. 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.

Prerequisites

This section of documentation assumes the following:

  • That you already have installed, and are familiar with using Android Studio. If not, 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.

Getting Started

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.

Connecting to a mycroft-core instance

@TODO not sure how this works

Pairing Mycroft for Android

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.

Keeping Mycroft for Android updated

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.

Common issues with Mycroft for Android

@TODO link to Troubleshooting

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 . You may be prompted to install additional components.

Android Studio with Mycroft-Android loaded
Android Studio
this introduction
Gradle