{"version":1,"pages":[{"id":"-LocrGINfDOv_qWPeO6d","title":"Documentation","pathname":"/docs","siteSpaceId":"sitesp_KONoS","description":"Step by step instructions to get you started using Mycroft AI, developing your own Voice Skills, or learning about the technology that makes it all happen."},{"id":"-LoxICWAGAyK3MEiBeoQ","title":"Why use Mycroft AI?","pathname":"/docs/about-mycroft-ai/why-use-mycroft","siteSpaceId":"sitesp_KONoS","description":"Why would you choose to use Mycroft over alternatives such as Amazon™ Alexa™, Google Assistant™, Microsoft Cortana™ or Apple's Siri™?","breadcrumbs":[{"label":"About Mycroft AI"}]},{"id":"-LouvxwrdkfO2TjYkUXr","title":"Glossary of terms","pathname":"/docs/about-mycroft-ai/glossary","siteSpaceId":"sitesp_KONoS","description":"Use our Glossary to learn more about the specialist terms that we use in natural language processing generally, and more specifically with Mycroft software and hardware.","breadcrumbs":[{"label":"About Mycroft AI"}]},{"id":"-LouvxwsJGjyIWq_Naot","title":"Contributing","pathname":"/docs/about-mycroft-ai/contributing","siteSpaceId":"sitesp_KONoS","description":"We value and recognise your contributions. Mycroft is artificial intelligence for _everyone_ and we warmly welcome both non-technical and technical contributions.","breadcrumbs":[{"label":"About Mycroft AI"}]},{"id":"-LvcAFS0TLoBxcUE86-9","title":"FAQ","pathname":"/docs/about-mycroft-ai/faq","siteSpaceId":"sitesp_KONoS","description":"Questions that we frequently receive about Mycroft and our technologies.","breadcrumbs":[{"label":"About Mycroft AI"}]},{"id":"-LodOWTAjJTFkvMJbhmV","title":"Get Mycroft","pathname":"/docs/using-mycroft-ai/get-mycroft","siteSpaceId":"sitesp_KONoS","description":"Want to give Mycroft a try? Mycroft is open source software that runs where you want it to, whether it’s on your own hardware or one of our dedicated devices.","breadcrumbs":[{"label":"Using Mycroft AI"}]},{"id":"-MSjxt8mC3tPNLQh7_rQ","title":"Mark II","pathname":"/docs/using-mycroft-ai/get-mycroft/mark-ii","siteSpaceId":"sitesp_KONoS","description":"The Mark II is our next-generation smart speaker designed for you and your family, whatever your level of technical expertise. The Dev Kit is open hardware and software to enable development.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Get Mycroft"}]},{"id":"13Gi11RfyV217xTLeAGc","title":"Mark II Dev Kit","pathname":"/docs/using-mycroft-ai/get-mycroft/mark-ii/mark-ii-dev-kit","siteSpaceId":"sitesp_KONoS","description":"The Mark II Dev Kit is intended for Software Developers and Hardware Developers to develop on the Mycroft platform.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Get Mycroft"},{"label":"Mark II"}]},{"id":"-LocrTX1tOOWJ9zThvFJ","title":"Mark 1","pathname":"/docs/using-mycroft-ai/get-mycroft/mark-1","siteSpaceId":"sitesp_KONoS","description":"The Mark 1 device is an Enclosure for Mycroft, based on Raspberry Pi. It is designed as a reference hardware device, and is able to be easily modified, hacked and extended.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Get Mycroft"}]},{"id":"-LocrTX7ddYCr4tVhvzk","title":"Picroft","pathname":"/docs/using-mycroft-ai/get-mycroft/picroft","siteSpaceId":"sitesp_KONoS","description":"Picroft is a ready-made way to run Mycroft on a Raspberry Pi 3, 3B+ or 4 and is provided as a disk image that you can burn to a Micro SD card.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Get Mycroft"}]},{"id":"-LocrTX8MytZ-o_PnhlR","title":"Linux","pathname":"/docs/using-mycroft-ai/get-mycroft/linux","siteSpaceId":"sitesp_KONoS","description":"Install Mycroft on Linux, learn how to start and stop services, configure proxies, or remove Mycroft from your system.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Get Mycroft"}]},{"id":"-LocrTX9KCfGepNsO6Zd","title":"Mac OS and Windows with VirtualBox","pathname":"/docs/using-mycroft-ai/get-mycroft/macos-and-windows-with-virtualbox","siteSpaceId":"sitesp_KONoS","description":"TL;DR: Get an Ubuntu VM up and running, install alsa and pulseaudio, set up mycroft-core, reboot and enjoy!","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Get Mycroft"}]},{"id":"-LocrTXAl4DY9thTN3Kk","title":"Docker","pathname":"/docs/using-mycroft-ai/get-mycroft/docker","siteSpaceId":"sitesp_KONoS","description":"Learn how to install Mycroft for Docker either from a Docker Hub install, or by building the image. Many thanks to Brian Hopkins (@btotharye) for this documentation.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Get Mycroft"}]},{"id":"-LocrTXBKhPtZZ9d-amb","title":"Android","pathname":"/docs/using-mycroft-ai/get-mycroft/android","siteSpaceId":"sitesp_KONoS","description":"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.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Get Mycroft"}]},{"id":"-LodOWTHlx64CfTd8hOs","title":"Pairing Your Device","pathname":"/docs/using-mycroft-ai/pairing-your-device","siteSpaceId":"sitesp_KONoS","description":"Pairing makes information available to your Device to personalise your experience, such as which units of measurement you prefer, and your general location.","breadcrumbs":[{"label":"Using Mycroft AI"}]},{"id":"-LodOWTIlgccAop2E8Jf","title":"Basic Commands","pathname":"/docs/using-mycroft-ai/basic-commands","siteSpaceId":"sitesp_KONoS","description":"Now that your Mycroft Device is Paired with home.mycroft.ai, you may begin issuing commands. Try these to get started.","breadcrumbs":[{"label":"Using Mycroft AI"}]},{"id":"-Lod_FwG-49XRPU_GoLY","title":"Installing New Skills","pathname":"/docs/using-mycroft-ai/installing-new-skills","siteSpaceId":"sitesp_KONoS","description":"Skills are like apps for a voice assistant. They give Mycroft access to new information and new abilities.","breadcrumbs":[{"label":"Using Mycroft AI"}]},{"id":"-LodOWTJLggvZORYG1yD","title":"Customizations","pathname":"/docs/using-mycroft-ai/customizations","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Using Mycroft AI"}]},{"id":"-LpX02WQqlyQpjSbwHDt","title":"Configuration Manager","pathname":"/docs/using-mycroft-ai/customizations/config-manager","siteSpaceId":"sitesp_KONoS","description":"The mycroft-config utility simplifies management of the the various configuration files that control Mycroft. Commands include: edit, show, get, set, reload.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Customizations"}]},{"id":"-LocrTXDtIw94SBQ_Zde","title":"mycroft.conf","pathname":"/docs/using-mycroft-ai/customizations/mycroft-conf","siteSpaceId":"sitesp_KONoS","description":"A configuration file that contains the device and service settings.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Customizations"}]},{"id":"-LodOWTKr4f00jbvVi8E","title":"Languages","pathname":"/docs/using-mycroft-ai/customizations/languages","siteSpaceId":"sitesp_KONoS","description":"Learn about foreign language support in Mycroft, and how to approach configuring Mycroft to support other languages.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Customizations"}]},{"id":"SM60CjjiJGPeH6wkgiEL","title":"Français (French)","pathname":"/docs/using-mycroft-ai/customizations/languages/francais-french","siteSpaceId":"sitesp_KONoS","description":"How to configure Mycroft for use in French.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Customizations"},{"label":"Languages"}]},{"id":"-MOni4HTSBcoKMPHS0YC","title":"Deutsch (German)","pathname":"/docs/using-mycroft-ai/customizations/languages/german","siteSpaceId":"sitesp_KONoS","description":"Dies ist eine Anleitung wie Mycroft in Deutsch eingerichtet werden kann. Diese Seite beinhaltet auch eine Kurzanleitung.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Customizations"},{"label":"Languages"}]},{"id":"-LwmNti79Dt8VF7esk84","title":"Using a Custom Wake Word","pathname":"/docs/using-mycroft-ai/customizations/wake-word","siteSpaceId":"sitesp_KONoS","description":"You might want to change the Wake Word to a phrase that's easier for you to speak, is more culturally appropriate, or just more personal and fun for you.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Customizations"}]},{"id":"-LzCIn_lp91jv5kuZ9t2","title":"Speech-To-Text","pathname":"/docs/using-mycroft-ai/customizations/stt-engine","siteSpaceId":"sitesp_KONoS","description":"Speech-To-Text (STT) is the process of converting audio of spoken words into strings of text. Mycroft supports a range of Speech-To-Text engines.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Customizations"}]},{"id":"-M-L4YBuXaVeFKXSYBoC","title":"Text-To-Speech","pathname":"/docs/using-mycroft-ai/customizations/tts-engine","siteSpaceId":"sitesp_KONoS","description":"Text-To-Speech (TTS) is the process of synthesizing audio from text. Mycroft uses our own TTS engines by default, however we also support a range of third party services.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Customizations"}]},{"id":"-LocrTXEf_ffCnKS8yk4","title":"Troubleshooting","pathname":"/docs/using-mycroft-ai/troubleshooting","siteSpaceId":"sitesp_KONoS","description":"Having trouble with Mycroft? Here are solutions to common problems, and ways to get further support.","breadcrumbs":[{"label":"Using Mycroft AI"}]},{"id":"-LocrTXFtX1QQREpFwL4","title":"General Troubleshooting","pathname":"/docs/using-mycroft-ai/troubleshooting/general-troubleshooting","siteSpaceId":"sitesp_KONoS","description":"Troubleshooting tips and tricks","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Troubleshooting"}]},{"id":"-LocrTXG08xqc78i7gdm","title":"Audio Troubleshooting","pathname":"/docs/using-mycroft-ai/troubleshooting/audio-troubleshooting","siteSpaceId":"sitesp_KONoS","description":"Having trouble with your audio?","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Troubleshooting"}]},{"id":"-M-yfJYwm2ZusWlhaYYO","title":"Wake Word Troubleshooting","pathname":"/docs/using-mycroft-ai/troubleshooting/wake-word-troubleshooting","siteSpaceId":"sitesp_KONoS","description":"Having trouble triggering the wake word?","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Troubleshooting"}]},{"id":"-LocrTXHSCkK4xcPo1-V","title":"Log Files","pathname":"/docs/using-mycroft-ai/troubleshooting/log-files","siteSpaceId":"sitesp_KONoS","description":"Information on the different log files Mycroft uses, where the logs files are located on a Mycroft Device, the sort of data that you will find in them, and some common commands to use to aid diagnosis","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Troubleshooting"}]},{"id":"-LocrTXI3wu_9rbzBSbH","title":"Support Skill","pathname":"/docs/using-mycroft-ai/troubleshooting/support-skill","siteSpaceId":"sitesp_KONoS","description":"The easiest way to find out what's happening on your device.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Troubleshooting"}]},{"id":"-LocrTXMeEjDkPALN6s1","title":"Getting more support","pathname":"/docs/using-mycroft-ai/troubleshooting/getting-more-support","siteSpaceId":"sitesp_KONoS","description":"I've tried everything! Where to get further support.","breadcrumbs":[{"label":"Using Mycroft AI"},{"label":"Troubleshooting"}]},{"id":"-M6VbI6ilvmyY9s7YZvb","title":"Voice User Interface Design Guidelines","pathname":"/docs/skill-development/voice-user-interface-design-guidelines","siteSpaceId":"sitesp_KONoS","description":"Learn about the Design process for planning a Skill, the basics of Voice Interaction, and best practices.","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-M7hpMA7SJamHuYBLmqN","title":"What can a Skill do?","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/what-can-a-skill-do","siteSpaceId":"sitesp_KONoS","description":"You can think of skills as the apps of the Mycroft system.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-M7iLEct6w3rD8u5NjDZ","title":"Design Process","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/design-process","siteSpaceId":"sitesp_KONoS","description":"At Mycroft we are advocates for a User Centered Design or Design Thinking approach.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-M7hpTIkrfSF2o0U6rpC","title":"Voice Assistant Personas","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/voice-assistant-personas","siteSpaceId":"sitesp_KONoS","description":"A Voice Assistant Persona is the personality that the user attributes to the voice assistant.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-M7hpf4hnXVMtA2lPdXU","title":"Interactions","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/interactions-and-guidelines","siteSpaceId":"sitesp_KONoS","description":"In this section, you will learn about the interaction between users and Mycroft. You will learn the terms used to describe the different parts of the interaction, and best practices.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-M7iJV2fqYvpAJX_ckfN","title":"Intents","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/interactions-and-guidelines/intents","siteSpaceId":"sitesp_KONoS","description":"An intent is how the User starts an interaction with Mycroft. It represents the job they are trying to accomplish.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"},{"label":"Interactions"}]},{"id":"-M7iJjWB2PLNAGEhgVGu","title":"Statements and Prompts","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/interactions-and-guidelines/statements-and-prompts","siteSpaceId":"sitesp_KONoS","description":"There are two basic ways for Mycroft to interact with the user, Statements and Prompts.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"},{"label":"Interactions"}]},{"id":"-M7iK6tcHJD_XmylzXpr","title":"Confirmations","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/interactions-and-guidelines/confirmations","siteSpaceId":"sitesp_KONoS","description":"Confirmations are used to verify that the input from the user was understood correctly.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"},{"label":"Interactions"}]},{"id":"-M7iKWlWFdCa_rbeCI2V","title":"Conversations","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/conversations","siteSpaceId":"sitesp_KONoS","description":"Conversations are made up of a series of individual interactions, but are more than the sum of their parts. For more complicated Skills conversations are a necessity.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-M7iL88Mtna36mOLJS2_","title":"Error Handling","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/error-handling","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-M74QMCDNXK2khpnUXDC","title":"Example Interaction Script","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/example-dialogs","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-M7hpxVifoq9qTo2Vioy","title":"Prototyping","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/prototyping","siteSpaceId":"sitesp_KONoS","description":"One way to prototype your skill is to get willing test participants to act as the User of the skill. These tests can be done in person or over a video conferencing tool.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-M7iobloEPl7GJiUFkPy","title":"Design to Development","pathname":"/docs/skill-development/voice-user-interface-design-guidelines/design-to-development","siteSpaceId":"sitesp_KONoS","description":"Use a Behavior Driven approach and write tests in a natural language style before any development begins. This improves communication within your team, and sets your Skill up for success.","breadcrumbs":[{"label":"Skill Development"},{"label":"Voice User Interface Design Guidelines"}]},{"id":"-LocrTXP9QsTxA-n6XAL","title":"Development Setup","pathname":"/docs/skill-development/introduction","siteSpaceId":"sitesp_KONoS","description":"Explore the fundamental building blocks of a Skill, and the knowledge required to create meaningful and engaging voice interactions.","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-Lvh4hhqmhig7Q7I3hYj","title":"Python Resources","pathname":"/docs/skill-development/introduction/python-resources","siteSpaceId":"sitesp_KONoS","description":"Python is an object-oriented, interpreted, high-level programming language. It is known for being easy to read and learn.","breadcrumbs":[{"label":"Skill Development"},{"label":"Development Setup"}]},{"id":"-LocrTXRi-zRG4hcuPqp","title":"Your First Skill","pathname":"/docs/skill-development/introduction/your-first-skill","siteSpaceId":"sitesp_KONoS","description":"Ready to create your first Skill? See how easy it is to get a new Skill up and running, then we will step through the basic anatomy of a Mycroft Skill.","breadcrumbs":[{"label":"Skill Development"},{"label":"Development Setup"}]},{"id":"-M7pjJqQVUHdyPqwD61_","title":"Skill Structure","pathname":"/docs/skill-development/skill-structure","siteSpaceId":"sitesp_KONoS","description":"Exploring the foundational components of a basic Mycroft Skill.","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-LwOKkgES6JZReTMKWks","title":"Lifecycle Methods","pathname":"/docs/skill-development/skill-structure/lifecycle-methods","siteSpaceId":"sitesp_KONoS","description":"Mycroft Skills provide a number of methods to perform actions at different points during the lifecycle of the Class instance.","breadcrumbs":[{"label":"Skill Development"},{"label":"Skill Structure"}]},{"id":"-Ltbsx3qD6VZZo8xshed","title":"Logging","pathname":"/docs/skill-development/skill-structure/logging","siteSpaceId":"sitesp_KONoS","description":"Logging is useful during Skill development, as well as to help end-users diagnose problems in the future.","breadcrumbs":[{"label":"Skill Development"},{"label":"Skill Structure"}]},{"id":"-LocrTXUHxvFIKlqBSDT","title":"Skill Settings","pathname":"/docs/skill-development/skill-structure/skill-settings","siteSpaceId":"sitesp_KONoS","description":"Skill settings allow users to customize their experience or authenticate with external services. Learn how to create and use settings in your Skill.","breadcrumbs":[{"label":"Skill Development"},{"label":"Skill Structure"}]},{"id":"-Lt00sLvS5vIDq2Sa27u","title":"Dependencies","pathname":"/docs/skill-development/skill-structure/dependencies","siteSpaceId":"sitesp_KONoS","description":"Mycroft Skills are powerful because we can make use of external packages and applications, or add voice interfaces to existing tools.","breadcrumbs":[{"label":"Skill Development"},{"label":"Skill Structure"}]},{"id":"-Lt00sLwdDZijuJiZT7o","title":"Manifest.yml","pathname":"/docs/skill-development/skill-structure/dependencies/manifest-yml","siteSpaceId":"sitesp_KONoS","description":"A Skill's `manifest.yml` file is the default method for defining the dependencies of a Mycroft Skill.","breadcrumbs":[{"label":"Skill Development"},{"label":"Skill Structure"},{"label":"Dependencies"}]},{"id":"-Lt00sLx22QGpg5CLPfJ","title":"Requirements files","pathname":"/docs/skill-development/skill-structure/dependencies/requirements-files","siteSpaceId":"sitesp_KONoS","description":"A Skill's `requirements.txt` and `requirements.sh` files provide an alternative method to define the dependencies of a Mycroft Skill.","breadcrumbs":[{"label":"Skill Development"},{"label":"Skill Structure"},{"label":"Dependencies"}]},{"id":"-MSjri_t0-509m1SKHk-","title":"Filesystem access","pathname":"/docs/skill-development/skill-structure/filesystem","siteSpaceId":"sitesp_KONoS","description":"Skills have access to both persistent and temporary namespaced filesystems independent of the Skill's root directory.","breadcrumbs":[{"label":"Skill Development"},{"label":"Skill Structure"}]},{"id":"-MV-h7JgCX5-CUaaOF68","title":"Skill API","pathname":"/docs/skill-development/skill-structure/api","siteSpaceId":"sitesp_KONoS","description":"The Skill API offers a simple and convenient way to use other Skill's methods and export your own to help other Skill creators.","breadcrumbs":[{"label":"Skill Development"},{"label":"Skill Structure"}]},{"id":"-M3GS4t-jhlJPBQ4K8QL","title":"Integration Tests","pathname":"/docs/skill-development/voight-kampff","siteSpaceId":"sitesp_KONoS","description":"Integration testing ensures your Skill works as expected when it is running inside Mycroft in a realistic environment alongside other Skills.","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-M3GS4t0xAABKvaECz3B","title":"Test Steps","pathname":"/docs/skill-development/voight-kampff/test-steps","siteSpaceId":"sitesp_KONoS","description":"Steps define the details of our tests using a Behavior Driven Development framework.","breadcrumbs":[{"label":"Skill Development"},{"label":"Integration Tests"}]},{"id":"-M3GS4t1VCMBY0q5xTUT","title":"Scenario Outlines","pathname":"/docs/skill-development/voight-kampff/scenario-outlines","siteSpaceId":"sitesp_KONoS","description":"One of the simplest, yet most useful features of Voight Kampff is the ability to provide a list of examples that will all be tested within one Scenario.","breadcrumbs":[{"label":"Skill Development"},{"label":"Integration Tests"}]},{"id":"-M3GS4t22J0VuUgS95w_","title":"Test Runner","pathname":"/docs/skill-development/voight-kampff/test-runner","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"},{"label":"Integration Tests"}]},{"id":"-M3GS4t39QSu_R12n_jU","title":"Reviewing the Report","pathname":"/docs/skill-development/voight-kampff/reviewing-the-report","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"},{"label":"Integration Tests"}]},{"id":"-M68QAW9oVEE9lQMsE4f","title":"Adding Custom Steps","pathname":"/docs/skill-development/voight-kampff/custom-steps","siteSpaceId":"sitesp_KONoS","description":"Some Skills require their own unique Steps to test functionality specific to that Skill.","breadcrumbs":[{"label":"Skill Development"},{"label":"Integration Tests"}]},{"id":"-LodOWTdeHNQ460-O_eJ","title":"Old Test System","pathname":"/docs/skill-development/voight-kampff/automatic-testing","siteSpaceId":"sitesp_KONoS","description":"Mycroft has a built-in mechanism to help you automatically test your Skill. This is particularly important when submitting your Skill for inclusion in the Marketplace.","breadcrumbs":[{"label":"Skill Development"},{"label":"Integration Tests"}]},{"id":"-LucgNbJHtQ5jtNi0DVV","title":"User interaction","pathname":"/docs/skill-development/user-interaction","siteSpaceId":"sitesp_KONoS","description":"Now that you have the basics, learn about how to interact get input and create meaningful interactions with Users of your Skill.","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-LrP8tIBGwfOZG9Hfpp8","title":"Intents","pathname":"/docs/skill-development/user-interaction/intents","siteSpaceId":"sitesp_KONoS","description":"An intent is the task the user intends to accomplish when they say something. The role of the intent parser is to extract from the user's speech key data elements that specify their intent.","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"}]},{"id":"-LsWXKtpNfDcVbcs-An6","title":"Padatious Intents","pathname":"/docs/skill-development/user-interaction/intents/padatious-intents","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"},{"label":"Intents"}]},{"id":"-LsRYrD9k7TRVMXyyApB","title":"Adapt Intents","pathname":"/docs/skill-development/user-interaction/intents/adapt-intents","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"},{"label":"Intents"}]},{"id":"-MGkRwRu1t4Gg4wfsvHL","title":"Statements","pathname":"/docs/skill-development/user-interaction/statements","siteSpaceId":"sitesp_KONoS","description":"A statement is any information spoken by Mycroft to the User.","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"}]},{"id":"-MGkRwRvU5qpdc6sls9U","title":"Prompts","pathname":"/docs/skill-development/user-interaction/prompts","siteSpaceId":"sitesp_KONoS","description":"A prompt is any question or statement spoken by Mycroft that expects a response from the User.","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"}]},{"id":"-MGkY8rT-ErnfTI2WUBm","title":"Parsing Utterances","pathname":"/docs/skill-development/user-interaction/parsing","siteSpaceId":"sitesp_KONoS","description":"Mycroft provides a range of easy to use methods to parse the contents of utterances from Users.","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"}]},{"id":"-MGkRwRwUYsLxIwkHm6X","title":"Confirmations","pathname":"/docs/skill-development/user-interaction/confirmations","siteSpaceId":"sitesp_KONoS","description":"Confirmations are used to verify that the input from the User was understood correctly. These may be verbal or non-verbal.","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"}]},{"id":"-LodOWTcSAJBMMNMmFCu","title":"Conversational Context","pathname":"/docs/skill-development/user-interaction/conversational-context","siteSpaceId":"sitesp_KONoS","description":"A Skill can add context to the Intent Parser to create more natural interaction with Mycroft.","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"}]},{"id":"-MGkRwRyNQW4Q2pMk9DI","title":"Converse","pathname":"/docs/skill-development/user-interaction/converse","siteSpaceId":"sitesp_KONoS","description":"Converse allows a recently active Skill to inspect utterances before the normal intent handling process. It allows for Skills to respond to unstructured follow up utterances.","breadcrumbs":[{"label":"Skill Development"},{"label":"User interaction"}]},{"id":"-LucgNbL4JdGkfdnwahh","title":"Displaying information","pathname":"/docs/skill-development/displaying-information","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-LucgNbM1OPsvkhdI6B8","title":"GUI Framework","pathname":"/docs/skill-development/displaying-information/mycroft-gui","siteSpaceId":"sitesp_KONoS","description":"A visual and display framework for Mycroft running on top of KDE Plasma Technology and built using Kirigami, a lightweight user interface framework for convergent applications empowered by Qt.","breadcrumbs":[{"label":"Skill Development"},{"label":"Displaying information"}]},{"id":"-MUvc66_0aHR-GFyFtkt","title":"Show Simple Content","pathname":"/docs/skill-development/displaying-information/show-simple-content","siteSpaceId":"sitesp_KONoS","description":"The Mycroft GUI Framework has a number of common methods for displaying standard simple content types.","breadcrumbs":[{"label":"Skill Development"},{"label":"Displaying information"}]},{"id":"-Mea_Tomxi0SJ9IhC6oF","title":"Mycroft-GUI on a PC","pathname":"/docs/skill-development/displaying-information/mycroft-gui-on-a-pc","siteSpaceId":"sitesp_KONoS","description":"During development, it can be useful to emulate the Mark II display on your primary machine.","breadcrumbs":[{"label":"Skill Development"},{"label":"Displaying information"}]},{"id":"-LouvxxN0uRFE8pRepjl","title":"Mark 1 Display","pathname":"/docs/skill-development/displaying-information/mark-1-display","siteSpaceId":"sitesp_KONoS","description":"How to make use of the enclosure display on the Mark 1.","breadcrumbs":[{"label":"Skill Development"},{"label":"Displaying information"}]},{"id":"-LocrTXVmVYnOzD0YMwD","title":"Advanced Skill Types","pathname":"/docs/skill-development/skill-types","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-LocrTXWb-gTzQybRiCE","title":"Fallback Skill","pathname":"/docs/skill-development/skill-types/fallback-skill","siteSpaceId":"sitesp_KONoS","description":"A Fallback Skill is a Skill that will be called if no Intent is matched to the Utterance.","breadcrumbs":[{"label":"Skill Development"},{"label":"Advanced Skill Types"}]},{"id":"-LocrTXXvcu_0R3Lzs6f","title":"Common Play Framework","pathname":"/docs/skill-development/skill-types/common-play-framework","siteSpaceId":"sitesp_KONoS","description":"To support a range of Skills that can \"play\" things, each Common Play Skill must return a confidence score to indicate their ability to successfully complete the users request.","breadcrumbs":[{"label":"Skill Development"},{"label":"Advanced Skill Types"}]},{"id":"-M7pjt4lXQrTjViNxiZt","title":"Common Query Framework","pathname":"/docs/skill-development/skill-types/common-query-framework","siteSpaceId":"sitesp_KONoS","description":"To support a range of Skills that can answer user's queries, each Common  Query Skill must return a confidence score to indicate their ability to successfully complete the users request.","breadcrumbs":[{"label":"Skill Development"},{"label":"Advanced Skill Types"}]},{"id":"-LocrTXYRnjMnm6nm_mc","title":"Common IoT Framework","pathname":"/docs/skill-development/skill-types/common-iot-framework","siteSpaceId":"sitesp_KONoS","description":"Work in progress - This Framework enables Common IoT Skills to operate together to control a range of IoT devices, providing a better experience for the end user.","breadcrumbs":[{"label":"Skill Development"},{"label":"Advanced Skill Types"}]},{"id":"-MSmJlui4le9TSzb-Xtw","title":"Mycroft Skills Manager","pathname":"/docs/skill-development/mycroft-skills-manager","siteSpaceId":"sitesp_KONoS","description":"Mycroft Skills Manager (msm) is a command line tool used to add, manage and remove Skills on any Mycroft installation.","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-MSmJluj9YX4DAkGGg52","title":"Troubleshooting","pathname":"/docs/skill-development/mycroft-skills-manager/msm-troubleshooting","siteSpaceId":"sitesp_KONoS","description":"Troubleshooting guide for the Mycroft Skills Manager.","breadcrumbs":[{"label":"Skill Development"},{"label":"Mycroft Skills Manager"}]},{"id":"-LocrTXZpq-nE96srzol","title":"Marketplace Submission","pathname":"/docs/skill-development/marketplace-submission","siteSpaceId":"sitesp_KONoS","description":"Want to share your new creation with the world? To have your Skill listed in the Marketplace, we need to ensure it has all the information required and works as expected.","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-LocrTXaY5wYB1eGXrca","title":"Skills Acceptance Process","pathname":"/docs/skill-development/marketplace-submission/skills-acceptance-process","siteSpaceId":"sitesp_KONoS","description":"The Skills Acceptance Process outlines how Skills are tested, reviewed, deployed and promoted through the Mycroft Marketplace.","breadcrumbs":[{"label":"Skill Development"},{"label":"Marketplace Submission"}]},{"id":"-Lof8Hmed7dU0rgZLJpe","title":"Information Review Template","pathname":"/docs/skill-development/marketplace-submission/skills-acceptance-process/skills-review-information-template","siteSpaceId":"sitesp_KONoS","description":"Template for the Information Review component of the Skills Acceptance Process.","breadcrumbs":[{"label":"Skill Development"},{"label":"Marketplace Submission"},{"label":"Skills Acceptance Process"}]},{"id":"-Lof8HmfEqFd1Ro3NtvU","title":"Code Review Template","pathname":"/docs/skill-development/marketplace-submission/skills-acceptance-process/skills-review-code-template","siteSpaceId":"sitesp_KONoS","description":"Template for the Code Review component of the Skills Acceptance Process.","breadcrumbs":[{"label":"Skill Development"},{"label":"Marketplace Submission"},{"label":"Skills Acceptance Process"}]},{"id":"-Lof8Hmg1bIx60DjU7xt","title":"Functional Review Template","pathname":"/docs/skill-development/marketplace-submission/skills-acceptance-process/skills-review-functional-template","siteSpaceId":"sitesp_KONoS","description":"Template for the Functional Review component of the Skills Acceptance Process.","breadcrumbs":[{"label":"Skill Development"},{"label":"Marketplace Submission"},{"label":"Skills Acceptance Process"}]},{"id":"-Lof8HmhuD-hmtNHtrq3","title":"Combined Template","pathname":"/docs/skill-development/marketplace-submission/skills-acceptance-process/skills-review-template","siteSpaceId":"sitesp_KONoS","description":"Complete template for the Skills Acceptance Process.","breadcrumbs":[{"label":"Skill Development"},{"label":"Marketplace Submission"},{"label":"Skills Acceptance Process"}]},{"id":"-LouHYGTXnHykB2FheLi","title":"Skill README.md","pathname":"/docs/skill-development/marketplace-submission/skill-readme-md","siteSpaceId":"sitesp_KONoS","description":"The README.md file in each Skill repository is used to provide an overview of the Skill and its functionality.","breadcrumbs":[{"label":"Skill Development"},{"label":"Marketplace Submission"}]},{"id":"-LrP8tIX6lXcd3N2VZal","title":"FAQ","pathname":"/docs/skill-development/faq","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Skill Development"}]},{"id":"-LodOWTpJccwt2-mfwHP","title":"Technology Overview","pathname":"/docs/mycroft-technologies/overview","siteSpaceId":"sitesp_KONoS","description":"A broad overview of the technology that makes up Mycroft AI.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-LodPZwaWeekrp4ZO8Ok","title":"Roadmap","pathname":"/docs/mycroft-technologies/mycroft-roadmap","siteSpaceId":"sitesp_KONoS","description":"A list of roadmaps to help you see where Mycroft's technology is headed. Note that with the pace of change, these documents can become dated quickly.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-LodOWTq-gAW-CVVJ7v8","title":"Mycroft Core","pathname":"/docs/mycroft-technologies/mycroft-core","siteSpaceId":"sitesp_KONoS","description":"Mycroft Core sits at the centre of all Mycroft installations. The code itself includes anything that is generic to all instances of Mycroft.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-LodPZwZ5st1lAvMBq2s","title":"MessageBus","pathname":"/docs/mycroft-technologies/mycroft-core/message-bus","siteSpaceId":"sitesp_KONoS","description":"A Message Bus is mechanism for independent systems to communicate with each other using a set of Messages for common commands or notifiers. In the Mycroft ecosystem, the Messagebus is a websocket.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"}]},{"id":"-LxvQJMXgFhDpMjpmd9_","title":"Message Types","pathname":"/docs/mycroft-technologies/mycroft-core/message-types","siteSpaceId":"sitesp_KONoS","description":"Messages are used to communicate information between Mycroft services and other components. This list of Message types outlines the details and provides sample code for each.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"}]},{"id":"-MSVgKZekJVr7vLHF3GF","title":"Services","pathname":"/docs/mycroft-technologies/mycroft-core/services","siteSpaceId":"sitesp_KONoS","description":"Work In Progress: This section will detail the Services that make up Mycroft.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"}]},{"id":"-MDxMlse2Ky8HdZSpJKV","title":"Enclosure","pathname":"/docs/mycroft-technologies/mycroft-core/services/enclosure","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"},{"label":"Services"}]},{"id":"-MDxMlsdszC8YHnoJpG1","title":"Voice Service","pathname":"/docs/mycroft-technologies/mycroft-core/services/voice-service","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"},{"label":"Services"}]},{"id":"-LodOWTrqxgRPy76500e","title":"Audio Service","pathname":"/docs/mycroft-technologies/mycroft-core/services/audio-service","siteSpaceId":"sitesp_KONoS","description":"The audio service handles playback and queueing of tracks.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"},{"label":"Services"}]},{"id":"-MDxMlsbWkEjr65NT3rS","title":"Skills Service","pathname":"/docs/mycroft-technologies/mycroft-core/services/skills-service","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"},{"label":"Services"}]},{"id":"-MEKY_SE973Pb_g5UvyY","title":"Plugins","pathname":"/docs/mycroft-technologies/mycroft-core/plugins","siteSpaceId":"sitesp_KONoS","description":"Mycroft plugins allows developers to create and distribute new features for some of Mycroft's main systems.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"}]},{"id":"-MEKY_SHEhdzddus5iGn","title":"Audioservice Plugins","pathname":"/docs/mycroft-technologies/mycroft-core/plugins/audioservice","siteSpaceId":"sitesp_KONoS","description":"An Audioservice Backend plugin adds an interface to a media player allowing Mycroft to play new types of media files or on remote devices.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"},{"label":"Plugins"}]},{"id":"-MEKY_SFWHOWv_Y2pFKm","title":"STT Plugins","pathname":"/docs/mycroft-technologies/mycroft-core/plugins/stt","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"},{"label":"Plugins"}]},{"id":"-MEKY_SGcPQW6SzGXGEJ","title":"TTS Plugins","pathname":"/docs/mycroft-technologies/mycroft-core/plugins/tts","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"},{"label":"Plugins"}]},{"id":"-MJzLz2h4xZzvXiejciU","title":"Wake Word Plugins","pathname":"/docs/mycroft-technologies/mycroft-core/plugins/wake-word-plugins","siteSpaceId":"sitesp_KONoS","description":"","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"},{"label":"Plugins"}]},{"id":"-MSVgYTbxb_y-JB1ae0a","title":"Testing","pathname":"/docs/mycroft-technologies/mycroft-core/testing","siteSpaceId":"sitesp_KONoS","description":"An overview of the test frameworks used by mycroft-core.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"}]},{"id":"-LodOWTvDkC7x8342xK_","title":"Legacy Repo","pathname":"/docs/mycroft-technologies/mycroft-core/legacy-repo","siteSpaceId":"sitesp_KONoS","description":"Maintaining the history of Mycroft contributions to our legacy repo.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft Core"}]},{"id":"-LocrTXdpEMSdw5_ra2c","title":"Adapt","pathname":"/docs/mycroft-technologies/adapt","siteSpaceId":"sitesp_KONoS","description":"Adapt is an intent parser - meaning that it is a library for converting natural language into machine-readable data structures, such as JSON.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-LodOWTxbuWGcaSXdKkN","title":"Adapt Examples","pathname":"/docs/mycroft-technologies/adapt/adapt-examples","siteSpaceId":"sitesp_KONoS","description":"There are several **Intent Parser** examples for Adapt on GitHub, and this page walks you through what they are, and where you might use them.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Adapt"}]},{"id":"-LodOWTyOhPpHwP4hiul","title":"Adapt Tutorial","pathname":"/docs/mycroft-technologies/adapt/adapt-tutorial","siteSpaceId":"sitesp_KONoS","description":"A step by step tutorial in using Adapt Intent Parser, using the `single_intent_parser.py` file as a starting point.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Adapt"}]},{"id":"-LodOWTz70Xg9ulqdY_n","title":"Lingua Franca","pathname":"/docs/mycroft-technologies/lingua-franca","siteSpaceId":"sitesp_KONoS","description":"Lingua Franca is our multilingual language parsing and formatting library. This is what allows Mycroft to both understand and respond with naturally expressed dates, numbers and times.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"NQo070Rb9khLjicHM84V","title":"Mimic TTS","pathname":"/docs/mycroft-technologies/mimic-tts","siteSpaceId":"sitesp_KONoS","description":"Mimic is Mycroft AI's family of Text to Speech engines.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"PEM5BLkkLbPx19wTZFhv","title":"Mimic 3","pathname":"/docs/mycroft-technologies/mimic-tts/mimic-3","siteSpaceId":"sitesp_KONoS","description":"A fast, privacy-focused, open-source, neural Text to Speech (TTS) engine.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mimic TTS"}]},{"id":"2Go7A2XL7JlTwXJK0ecS","title":"Mimic 2","pathname":"/docs/mycroft-technologies/mimic-tts/mimic-2","siteSpaceId":"sitesp_KONoS","description":"Mimic II is a machine learning Text-to-Speech engine designed to run in the cloud.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mimic TTS"}]},{"id":"-LouLmAKOi_GveuIYirR","title":"Mimic 1","pathname":"/docs/mycroft-technologies/mimic-tts/mimic-overview","siteSpaceId":"sitesp_KONoS","description":"Mimic 1 is a fast, light-weight Text to Speech engine developed by Mycroft AI and VocaliD.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mimic TTS"}]},{"id":"-LocrTXhueLUfSmpUHTs","title":"Mimic Recording Studio","pathname":"/docs/mycroft-technologies/mimic-tts/mimic-recording-studio","siteSpaceId":"sitesp_KONoS","description":"Mimic Recording Studio provides simplifies the collection of voice training data from individuals, by allowing you to speak and record phrases from a corpus.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mimic TTS"}]},{"id":"-MV-kJxW3djluOtJdJil","title":"Mycroft GUI","pathname":"/docs/mycroft-technologies/mycroft-gui","siteSpaceId":"sitesp_KONoS","description":"Mycroft-GUI is an open source visual and display framework for Mycroft.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-MV-kOy2F8jjS8vhXbql","title":"Remote STT and TTS","pathname":"/docs/mycroft-technologies/mycroft-gui/remote-stt-and-tts","siteSpaceId":"sitesp_KONoS","description":"Utilize the STT and TTS services of a remotely hosted mycroft-core instance.","breadcrumbs":[{"label":"Mycroft Technologies"},{"label":"Mycroft GUI"}]},{"id":"-LocrTXQ-p9oMlmSHcSq","title":"Mycroft Skills Kit","pathname":"/docs/mycroft-technologies/mycroft-skills-kit","siteSpaceId":"sitesp_KONoS","description":"Learn how to use the Mycroft Skills Kit - MSK - to make the creation, testing and submission of Skills a lot easier.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-MCimaxlKtgGQHCvQzIz","title":"Mycroft Skills Manager","pathname":"/docs/mycroft-technologies/mycroft-skills-manager","siteSpaceId":"sitesp_KONoS","description":"Mycroft Skills Manager (msm) is a command line tool used to add, manage and remove Skills on any Mycroft installation.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-LocrTXe9k-18Bo8ctEj","title":"Padatious","pathname":"/docs/mycroft-technologies/padatious","siteSpaceId":"sitesp_KONoS","description":"Padatious is a machine-learning, neural-network based intent parser.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-LocrTXfT9sCEWFwWEh8","title":"Precise","pathname":"/docs/mycroft-technologies/precise","siteSpaceId":"sitesp_KONoS","description":"Precise is a Wake Word Listener based on a neural network trained on sound samples.","breadcrumbs":[{"label":"Mycroft Technologies"}]},{"id":"-MSfXCxVO1XYaMO3Covm","title":"Platforms","pathname":"/docs/mycroft-technologies/platforms","siteSpaceId":"sitesp_KONoS","description":"A list of Mycroft hardware devices and software platforms and the repositories specific to them.","breadcrumbs":[{"label":"Mycroft Technologies"}]}]}