https://github.com/evancohen/docs.smart-mirror.io
https://github.com/evancohen/docs.smart-mirror.io
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/evancohen/docs.smart-mirror.io
- Owner: evancohen
- Created: 2016-02-05T21:44:38.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-10-29T20:45:12.000Z (about 4 years ago)
- Last Synced: 2025-03-18T16:22:35.195Z (10 months ago)
- Language: CSS
- Size: 4.67 MB
- Stars: 6
- Watchers: 10
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Smart Mirror
A voice controlled life automation hub, most commonly powered by the Raspberry Pi.
# Introduction
This is the official documentation for the [smart-mirror](https://github.com/evancohen/smart-mirror), a voice controlled interface that controls your smart devices and displays information from a growing number of services. The smart mirror is powered by:
- The [Raspberry Pi 3 or 4](http://amzn.to/2iU0kRn)
- A webcam ([PlayStation Eye](http://amzn.to/2w5XjCy))
- Observation mirror (aka mirror pane)
- Computer monitor
The smart-mirror was originally inspired by [HomeMirror](https://github.com/HannahMitt/HomeMirror) and Michael Teeuw's [Magic Mirror](http://michaelteeuw.nl/tagged/magicmirror). It was originally created in a weekend and is now maintained by a growing community of contributors and enthusiasts.
##### Video Demo: [See it in action](https://youtu.be/PDIbhV8Nvq8)
{% youtube %}
https://www.youtube.com/watch?v=PDIbhV8Nvq8
{% endyoutube %}
> Note: The current video demonstrations do not display the mirror in its current state. Such as keyword spotting and remote configuration.
Starting from scratch? No problem. Head on over to the [Hardware](docs/hardware.md) section to get started.
If you encounter problems along the way check out the [Troubleshooting](docs/troubleshooting.md) section or join us in the [discord chat](https://discord.gg/EMb4ynW).
Please file any issues or bugs [on GitHub](https://github.com/evancohen/smart-mirror/issues/new).
## About this documentation
This documentation is constantly evolving. It is updated as we find issues and as we add new features. Who is the "we"? We are a community of people contributing, supporting, and improving this project. We are working to make the documentation as helpful, clear, and accurate as possible.
Issues and/or concerns with the documentation?
Please file an issue [on GitHub](https://github.com/evancohen/smart-mirror/issues/new). Commenting in line can cause readability issues for others. It is also difficult for anyone other than Evan Cohen to address or remove after resolving the documentation.
> #### This documentation outlines a sequential installation process. For successful installation and configuration you must follow it step by step. If you skip a step that seems insignificant it can cause issues down the line.
##Language Translation
If English isn't your first language, you can translate this site.
function googleTranslateElementInit() {
new google.translate.TranslateElement({pageLanguage: 'en', layout: google.translate.TranslateElement.InlineLayout.SIMPLE}, 'google_translate_element');
}
### Supported Platforms
The smart-mirror is fully compatible with the following operating systems. Note that a small number of features require GPIO, devices without this will not be able to take advantage of these features.
-  Raspberry Pi OS
- Pi 2
- Pi 3
- Pi 4
-  Linux (Most major distributions)
-  OS X >= 10.8
### Partially supported Platforms
The smart-mirror is partially compatible with the following operating systems
-  Windows 7 / Server 2008 R2 or higher
- Keyword Spotter is not supported. See [snowboy#31](https://github.com/Kitt-AI/snowboy/issues/31).
-  iOS and Android (Experimental!)
- See the `cordova` branch for details