Estimated reading time: 6 minutes

This documentation was last modified: Tuesday, July 10th, 2018 at 5:27 pm

Documentation Home

Welcome to the documentation for all elements of Mycroft – the open source voice assistant.

Our documentation, just like our source code, is open source, and you can contribute to improving it here. Alternatively, please rate our documentation and leave comments on how we can improve.

About Mycroft

This is a useful starting point, and provides an overview of all the elements of the Mycroft ecosystem.

Contributing

Aimed at developers, our Contributing section provides detailed instructions on how to contribute to Mycroft.

Release notes

Release notes for Mycroft software releases.

Roadmap

Aimed at developers and investors, our Roadmap illustrates our key development effort and goals.

Glossary

A handy reference of all new terms you might come across while working with Mycroft.

Getting Mycroft

How to download and install Mycroft for your preferred Device or platform.

Your home.mycroft.ai account

How to pair your Device with home.mycroft.ai, and set basic configuration fields such as location.

Basic commands

Getting started using Mycroft Skills.

Mark 1

In depth information about the Mark 1 reference hardware Device.

Picroft

In depth information about the Picroft build of Mycroft for Raspberry Pi.

Configuring Picroft audio for USB, HDMI and Bluetooth

Learn how to configure your Raspberry Pi 3 to output audio via USB, HDMI and Bluetooth

Manually configuring WiFi for Picroft

Are you on an enterprise network? The automated WiFi network connection process not working? Learn how to manually configure WiFi.

Reconfiguring automatic updates for Picroft

Want to turn off automatic updates? Change what time they occur? Learn how to manually configure updates.

Mycroft for Linux platforms

In depth information on how to build Mycroft for common Linux distributions.

Mycroft for Docker

How to build Mycroft in a Docker container either by building an image or pulling the image off Docker Hub.

Mycroft for Android

In depth information on the Mycroft companion app for Android.

mycroft-conf file

Learn about the mycroft.conf file and the settings it contains.

Mycroft Skills

An overview of the Skills that can be installed on your Mycroft Device.

Introduction to developing Skills for Mycroft

Aimed at developers, this section is an introduction to developing new Skills for Mycroft

Developing Skills for Mycroft

Take your next step in Developing Skills for Mycroft. Learn about the structure of a Skill, and how to start creating your own.

Automatic testing for Mycroft Skills

Learn how to use the Integration Test Runner for automatic testing of your Mycroft Skills.

Skills acceptance process

Read more about the process used by Skill Authors, the Skill Management Team and Mycroft staff to ensure the robustness and quality of Skills in the Mycroft AI ecosystem.

Preparing your Skill for submission to the Mycroft Skills Repo

Aimed at developers, this is a step by step guide to submitting a new Skill you’ve developed to the Mycroft Skills Repo.

Mycroft Skills Kit

Learn how to use the Mycroft Skills Kit to make the creation, testing and submission of Skills a lot easier.

Skill Settings

Aimed at Developers, this is a step by step guide to storing and retrieving persistent settings that your Skill needs.

Common issues in Skills development

Explanations of common issues developers encounter in building new Skills, and helpful advice for overcoming them.

Repurposing Skills developed for other platforms

Already develop for another voice assistant? Learn how to transfer those skills to Mycroft.

Conversational Context

Want to add more natural interaction to Mycroft? Conversational context allows a Skill to add context to the Intent Parser to create a more natural interaction style.

Audio Service

The Audio Service handles playback of audio files within a Skill. If your Skill deals with audio files, you’ll want to know about the Audio Service.

Display Control

Display Control manages features of the Enclosure, such as the mouth and eyes on the Mark 1.

Fallback Skills

Fallback Skills handle an Intent if one can’t be matched with an Utterance and are a useful catch-all. This documentation shows how to write a new Fallback Skill and set its order of precedence.

Mycroft Skill Manager

Learn how to use msm to install, search and update Skills. Includes a comprehensive list of msm error codes, and how to resolve them.

Message Bus

Aimed at advanced Skill Authors, learn how the Mycroft MessageBus is used to emit and consume messages.

Language support in Mycroft

Learn more about languages support in Mycroft.

Adding a new language to Mycroft

Adding a new language to Mycroft is complex; this documentation takes you through the different layers of the voice stack that need to be adapted for a new language.

Configuring Mycroft for French language support

Parlez-vous français? Follow these steps to change Mycroft’s language to French (BCP 47: fr)

Configuring Mycroft for Italian language support

Parli italiano? Follow these steps to change Mycroft’s language to Italian (BCP 47: it)

Configuring Mycroft for German language support

Sprechen Sie Deutsch? Follow these steps to change Mycroft’s language to German (BCP 47: de)

Configuring Mycroft for Spanish language support

Puedes hablar español? Follow these steps to change Mycroft’s language to Spanish (BCP 47: es)

Configuring Mycroft for Portuguese language support

Olá, falas Português? Follow these steps to change Mycroft’s language to Portuguese (BCP 47:pt)

Adapt

Learn more about the Adapt Intent Parser, which matches spoken words with Intents.

Adapt examples

Examples of the different types of Intent Parsing supported by Adapt.

Adapt tutorial

A tutorial on writing Intent Parsers using Adapt.

Mimic

Learn about the Mimic Text to Speech (TTS) tool.

Precise

Precise is a Wake Word Listener that listens and then ‘wakes up’ Mycroft, ready to hear your commands and questions.

Padatious

Padatious is an Intent parser. Unlike Adapt, which is based on Speech to Text, Padatious is trained on sounds.

Troubleshooting and known errors

Stuck? Learn common tricks and techniques for resolving common errors.

Audio troubleshooting

Audio is one of the most common areas that requires troubleshooting.

Getting help and support

Need to chat things over with a human? No problem. You can join our Chat, Forum or make contact via this web form.


Help us serve you better by rating this documentation