• Stars
    star
    802
  • Rank 55,480 (Top 2 %)
  • Language
    Shell
  • License
    GNU Lesser Genera...
  • Created over 7 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Mycroft interface for Raspberry Pi environment

It's Alive!

Safety Last!

Picroft - Buster Keaton (Pork Pi) release

Picroft is an enclosure for a Raspberry Pi 3, 3B+ or 4 connected to a speaker and microphone, bringing Mycroft to anyone who wants a simple voice interface they have complete control over. This is built on top of the official Raspbian Buster Lite image.

The entire project is available as a pre-built micro-SD image ready to be burned and placed into a Raspberry Pi. You can download the pre-built image here:

Download img Picroft Stable 2020-09-07 image

SHA-256: 3d3c99c53793224b84de02e816435230f2bbe6272b71d8909afee43e5ef9a402

Download img Picroft Release Candidate 2021-06-04 image

SHA-256: 2d5a81375036a1dc4ce30051ea9e9181f4019c8f61264db3a43d87d03df854a6

A list of current and past releases can be found at: https://downloads.mycroft.ai/releases/picroft/

Optionally you can build it yourself by following the Recipe for building the image

Requirements

  • Raspberry Pi 3, 3B+, or 4
    Older Raspberry Pi versions do not have sufficient processing power, and if they work they will be very slow
  • Speaker
    Any analog speaker, or an HDMI monitor with speaker
  • Microphone
    A list of Community tested hardware is available in our documentation.
  • 2.5 Amp or better power supply
    Don't skimp on this! It might appear to work, but you'll have weird issues with a cheapo supply.
  • MicroSD Card
    8 GB or larger
  • HDMI Monitor and keyboard, only required during setup

Installation

  1. Download and burn the image to the SD card.
    See the RaspberryPi.org's guide to Installing Operating System Images for detailed instructions on how to burn an image to your SD card.
  2. Insert the SD card into your Raspberry Pi
  3. Connect speaker, microphone, monitor and keyboard
  4. Apply power
  5. Follow the on-screen prompts to setup Picroft
  6. Follow the verbal prompts to pair your device to an account at Mycroft Home
  7. Talk to Mycroft and enjoy!

Usage

Simply speak to Picroft as you would to any Mycroft. For example:

"Hey Mycroft, what time is it?"
"Mycroft, how tall was Abraham Lincoln?"

Older Versions

Help and more info

To re-run the setup wizard, use mycroft-setup-wizard. Check out the Picroft wiki here. There's also the general Documentation.

Customization

  • audio_setup.sh configures your specific audio setup.
  • custom_setup.sh is a stub meant to initialize anything before Mycroft starts. For example, initializing connected devices, or launching services.

Getting Help

There is an active Picroft community within the Mycroft's Mattermost chat which all are welcome to join!


FAQ

Q1) Why "Buster Keaton (Pork Pi)"?

This image is built on top of Raspbian "Buster" for running on a Raspberry Pi.

Buster Keaton is best known for his silent films, but also his signature Pork Pie hats that he designed and made himself. Coincidentally, Buster Keaton's classic film "Safety Last!" came out of copyright in 2019.

The photo at the top of this page we thought was Buster Keaton wearing his signature hat. It turns out that it is actually a slightly more contemporary Harold Lloyd.

Q2) Can I run this with a the Raspbian desktop GUI?

Sadly, not really. A Raspberry Pi is powerful, but still not well suited to do everything at once. You can add other basic services on top of Picroft, but the desktop GUI requires too many additional resources and neither Mycroft nor the GUI end up running well.

Q3) Can I run this with anything else?

Depends on what you want to add. Serving simple webpages or polling devices periodically is probably fine. Mining bitcoin won't.

Q4) Can I run this on a Pi4?

Yes!

More Repositories

1

mycroft-core

Mycroft Core, the Mycroft Artificial Intelligence platform.
Python
6,472
star
2

mimic3

A fast local neural text to speech engine for Mycroft
Python
1,000
star
3

mycroft-precise

A lightweight, simple-to-use, RNN wake word listener
Python
814
star
4

mimic1

Mycroft's TTS engine, based on CMU's Flite (Festival Lite)
C
782
star
5

mycroft-skills

A repository for sharing and collaboration for third-party Mycroft skills development.
HTML
757
star
6

adapt

Adapt Intent Parser
Python
707
star
7

mimic-recording-studio

Mimic Recording Studio is a Docker-based application you can install to record voice samples, which can then be trained into a TTS voice with Mimic2
JavaScript
491
star
8

Mycroft-Android

Android companion app, sends commands from your Android device to your Mycroft system and returns the output as speech or other medium to the Android device.
Kotlin
343
star
9

mycroft-gui

The Graphical User Interface used by the Mycroft Mark II and more
C++
165
star
10

padatious

A neural network intent parser
Python
158
star
11

selene-backend

Microservices and web apps to support Mycroft devices
Python
143
star
12

ZZZ-RETIRED__openstt

RETIRED - OpenSTT is now retired. If you would like more information on Mycroft AI's open source STT projects, please visit:
143
star
13

mimic3-voices

Voice models for Mimic 3 text to speech system
HTML
115
star
14

personal-backend

WORK IN PROGRESS: A Flask personal backend alternative for running your own version of https://home.mycroft.ai
Python
114
star
15

hardware-mycroft-mark-II

Mycroft's Mark II Rpi mechanical, electrical and industrial designs
Python
106
star
16

docker-mycroft

Mycroft Development Environment inside Docker!
Dockerfile
98
star
17

hardware-mycroft-mark-1

Open-sourcing our mechanical, electrical and industrial designs
92
star
18

MycroftCore-Android

MycroftCore on Android as a native app
Java
86
star
19

documentation

Mycroft.AI documentation for all public facing technical components.
Python
81
star
20

sonopy

A simple audio feature extraction library
Python
78
star
21

lingua-franca

Mycroft's multilingual text parsing and formatting library
Python
73
star
22

selene-ui

Web applications to support the Mycroft AI project.
TypeScript
48
star
23

Precise-Community-Data

Pre-trained Precise models and training data provided by the Mycroft Community
47
star
24

ZZZ-RETIRED__mycroft-core-documentation

ZZZ ARCHIVED - Documentation for Mycroft Core.
34
star
25

mycroft-skills-kit

Mycroft Skills Kit
Python
29
star
26

installers

Installers and instructions for getting Mycroft working on different equipment, OS platforms and desktops.
Shell
28
star
27

contributors

Contributors building the Mycroft open source project
23
star
28

ZZZ-RETIRED__rpi3-headless-wifi-setup

Retired project, replaced by:
Python
21
star
29

mycroft-dinkum

A consumer ready version of Mycroft specifically for the Mark II.
Python
19
star
30

skill-weather

Mycroft AI official Weather Skill, providing weather conditions and forecasts.
Python
19
star
31

skill-wiki

Query Wikipedia articles
Python
18
star
32

skill-hello-world

Mycroft AI Hello World Skill - use this basic Skill to see how Mycroft AI Skills work.
Python
16
star
33

mimic1-core

Core of the mimic TTS system
C
14
star
34

mycroft-skills-manager

Mycroft Skills Manager
Python
14
star
35

skill-alarm

Mycroft AI official Alarm Skill - Set single and recurring alarms, with a choice of alarm sounds
Python
14
star
36

skill-reminder

Mycroft AI official Reminder Skill - set reminders
Python
14
star
37

skill-singing

Mycroft AI official Singing Skill - Mycroft speaks lyrics to popular songs
Python
14
star
38

mycroft-messagebus-client

Python module for connecting to the mycroft messagebus
Python
13
star
39

skill-installer

Mycroft AI official Skill installation Skill - allowing voice installation of Skills
Python
12
star
40

mycroft-precise-python-experiments

Python Experiments for Mycroft Precise Wake Word Listener
Python
12
star
41

snapcraft-mycroft-core

This project is for building mycroft-core snaps
Jsonnet
12
star
42

pylisten

A simple pyaudio microphone interface
Python
11
star
43

padaos

A rigid, lightweight, dead-simple intent parser
Python
11
star
44

ZZZ-RETIRED__adapt-documentation

Retired repo, formerly was the source of docs shown on https://adapt.mycroft.ai
11
star
45

skill-desktop-launcher

Mycroft AI official Desktop Launcher Skill - launch applications in Linux
Python
11
star
46

skill-volume

Mycroft AI official Volume Skill - control the volume of your Device
Python
10
star
47

precise-data

Binary data used for Mycroft Precise
9
star
48

fallback-duckduckgo

Mycroft AI official Duck Duck Go Skill - used as a fallback if an Utterance can't be matched to an Intent
Python
9
star
49

skill-npr-news

Mycroft AI official News Skill, providing the latest news report from your favorite broadcast.
Python
9
star
50

enclosure-mark1

Replacing the faceplate repo
C++
9
star
51

mycroft-skills-data

Metrics and data relating to Skills built for the Mycroft Core system
8
star
52

ML-Tools

Tools for ML Research
Jupyter Notebook
8
star
53

plugin-tts-mimic3

Text to speech plugin for Mycroft using Mimic 3
Python
8
star
54

skill-stop

Mycroft AI official Stop Skill - stop the actions of a Skill that are in progress
Python
8
star
55

fallback-wolfram-alpha

Mycroft AI official Wolfram Alpha Skill - used as a fallback if an Intent is not matched
Python
8
star
56

skill-audio-record

Mycroft AI official Audio Record Skill - record audio and play it back
Python
8
star
57

ZZZ-RETIRED__mycroft-slackbot

Retired, Mycroft Slack is no longer active
Java
8
star
58

skill-stock

Mycroft AI official Stock Skill - providing current prices of stocks
Python
7
star
59

skill-joke

Mycroft AI official Joke Skill - provide basic jokes
Python
7
star
60

skill-camera

Camera Skill for Mycroft AI
QML
7
star
61

mycroft-timer

Mycroft AI official Timer Skill - set multiple named timers
Python
7
star
62

skill-homescreen

Python
7
star
63

skill-mark-2

Control of the Mycroft Mark 2 enclosure
QML
7
star
64

skill-personal

Mycroft AI official Personality Skill - answers basic personality questions around Mycroft
Python
7
star
65

skill-date-time

Mycroft AI official Date and Time Skill, providing the current time, date and day of week for cities around the world.
Python
6
star
66

mycroft-gui-mark-2

QML
6
star
67

skill-playback-control

Mycroft AI official Playback Control Skill - providing Intents for other Skills to use common playback functionality (via Common Play)
QML
6
star
68

skill-spelling

Mycroft AI spelling Skill
Python
6
star
69

skill-ip

Mycroft AI official IP Skill - find the IP address of your Device
Python
5
star
70

skill-fallback-persona

Mycroft AI official Persona Skill - used as a fallback if the Utterance can't be matched to an Intent
Python
5
star
71

mark-ii-sandbox

Image for the Mark II based on Raspberry Pi OS
Python
5
star
72

skill-configuration

Mycroft AI official Configuration Skill - synchronize settings with home.mycroft.ai
Python
5
star
73

docker-openvpn-client

An OpenVPN client built into a docker container. Allows for attaching other containers to a VPN
Shell
5
star
74

skill-query

Skill Negotiating for the best source for an answer via Common QA
Python
5
star
75

mimic1-packaging

Shell
5
star
76

skill-pairing

Mycroft AI official Pairing Skill - connect your Device to home.mycroft.ai
QML
5
star
77

skill-speak

Mycroft AI official Speak Skill - make Mycroft speak back text
Python
5
star
78

mycroft-wifi-setup

Mycroft WiFi Setup Client
Python
4
star
79

respeaker-dev-filesystem

Development file system for Seeed ReSpeaker Core v2
4
star
80

mimic1-full

Build mimic (without runtime plugins if desired)
C
4
star
81

pako

The universal package manager library
Python
4
star
82

fallback-unknown

Mycroft AI official Unknown Fallback Skill - used if no Intent is matched to an Utterance
Python
4
star
83

arriz

A real-time array visualization tool
Python
4
star
84

skill-release-test

Mycroft AI official Release Test Skill - used during `mycroft-core` release testing
Python
4
star
85

mycroft-mark-1

Mycroft AI official Mark 1 Skill - control the Mark 1 enclosure
Python
4
star
86

rnn-demo

Demo of using various recurrent networks to make streaming predictions
Python
4
star
87

skill-support

Mycroft AI official Support Skill - create information for a support request using voice
Python
3
star
88

mycroft-devices

Shell
3
star
89

skill-send-sms

Python
3
star
90

design

Place to share designy things from Mycroft.
3
star
91

mycroft-core-release

A project to automate the mycroft-core release process.
Python
3
star
92

mimic1-documentation

Documentation for https://github.com/mycroftai/mimic1
3
star
93

skill-naptime

Mycroft AI official Naptime Skill - put Mycroft to sleep for a while
Python
3
star
94

mimic1-english

English language support for the mimic TTS system
C
3
star
95

ZZZ-RETIRED__chatter

A Mycroft AI chatbot solution framework
3
star
96

skill-repeat-interactions

Mycroft AI official Repeat Interaction Skill - repeat recent commands
Python
3
star
97

mark-ii-product

Software packaging for the default Mark II operating system.
C
2
star
98

skill-version-checker

Mycroft AI official Version Checker Skill - check the version of mycroft-core that is installed
Python
2
star
99

skill-dial-call

Python
2
star
100

skill-standard-gui

Handles standard, non-platform-specific GUI activities.
Python
2
star