https://github.com/mycroftai/enclosure-picroft
Mycroft interface for Raspberry Pi environment
https://github.com/mycroftai/enclosure-picroft
artificial-intelligence hacktoberfest machine-learning mycroft open-source opensource personal-assistant picroft raspberry-pi raspberry-pi-3 raspbian rpi rpi3
Last synced: 11 days ago
JSON representation
Mycroft interface for Raspberry Pi environment
- Host: GitHub
- URL: https://github.com/mycroftai/enclosure-picroft
- Owner: MycroftAI
- License: lgpl-3.0
- Created: 2017-01-15T06:28:08.000Z (over 8 years ago)
- Default Branch: buster
- Last Pushed: 2022-12-14T07:58:23.000Z (over 2 years ago)
- Last Synced: 2025-04-12T14:58:11.462Z (11 days ago)
- Topics: artificial-intelligence, hacktoberfest, machine-learning, mycroft, open-source, opensource, personal-assistant, picroft, raspberry-pi, raspberry-pi-3, raspbian, rpi, rpi3
- Language: Shell
- Homepage: https://mycroft.ai/documentation/picroft
- Size: 417 KB
- Stars: 811
- Watchers: 96
- Forks: 192
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# It's Alive!
## 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:
[ Picroft Stable 2020-09-07 image](https://mycroft.ai/to/picroft-image)
SHA-256: 3d3c99c53793224b84de02e816435230f2bbe6272b71d8909afee43e5ef9a402
[ Picroft Release Candidate 2021-06-04 image](https://mycroft.ai/to/picroft-rc)
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](image_recipe.md)
## 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](https://mycroft-ai.gitbook.io/docs/using-mycroft-ai/get-mycroft/picroft#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](https://www.raspberrypi.org/documentation/installation/installing-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](https://account.mycroft.ai/devices/add)
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
* [Raspbian Jessie version](https://github.com/MycroftAI/enclosure-picroft/tree/master)
## Help and more info
To re-run the setup wizard, use `mycroft-setup-wizard`.
Check out the Picroft wiki [here](https://mycroft.ai/documentation/picroft/).
There's also the general [Documentation](https://mycroft.ai/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](https://chat.mycroft.ai/community/channels/picroft) 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](https://en.wikipedia.org/wiki/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!](https://www.youtube.com/watch?v=V-XZWZVVhvQ&ab_channel=moosetash)"
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](https://en.wikipedia.org/wiki/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!