evancohen
Smart Mirror Documentation

Updated 3 months ago

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. If you are reading this on docs.smart-mirror.io, great! If not you should head on over.

The smart-mirror was inspired by HomeMirror and Michael Teeuw's Magic Mirror. It was originally created in a weekend and is now maintained by a growing community of contributors and enthusiasts.

Smart-mirror is voice controlled, integrates with a growing number of services, and can control your smart devices :)

Video Demo: See it in action

Video link

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 section to get started.

If you encounter problems along the way check out the Troubleshooting section or join us in the discord chat.

Please file any issues or bugs on GitHub.

About this documentation

This documentation is a constant work in progress. 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. 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 project is a step by step process. For successful installation and configuration you must follow it step by step. If you skip a step that seems insignificant it can cause a catastrophic error down the line. Often when troubleshooting in the discord chat we determine that a step was missed.

Having said that we don't mind, nearly everyone on discord chat that has a working install has skipped a step and gone back and fixed it. We're here to help. Following the documentation step by step will greatly reduce your level of frustration while getting started on this project.

Language Translation

If English isn't your first language, you can translate this site.

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.

  • Raspbian
    • Pi 2
    • Pi 3
  • 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.
  • iOS and Android (Experimental!)
    • See the cordova branch for details

\n

Supported Platforms

\n

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.

\n\n

Partially supported Platforms

\n

The smart-mirror is partially compatible with the following operating systems

\n\n"}],"progress":{"chapters":[]}},"languages":[],"hasEbooksVersion":true,"config":{"version":"19.6.16","hasBlog":true,"isEnterprise":false,"apiHost":"https://api.gitbook.com","mainHost":"https://www.gitbook.com","stripePublicKey":"pk_live_iPkbPsG28bjTrkbfHXUq0cA0","gaToken":"UA-57505611-6","mixpanelToken":"aa7ba0807002f1cbd33391bdd14d5ad9","github":{"integrationUrl":"https://github.com/integrations/gitbook/installations/new"}},"req":{"date":"2017-07-21T08:28:04.371Z","csrfToken":"nBkZD7Xn-PSDMr0uvOEQwA1pY5uN1977M22c","query":{},"url":"/book/evancohen/docs-smart-mirror-io/details","duration":163}} }),document.getElementById("application"));})();