# Introduction

## Smart Mirror

[![Discord Chat](https://discordapp.com/api/guilds/258802311298547713/widget.png)](https://discord.gg/EMb4ynW)

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)

{% embed url="<https://www.youtube.com/watch?v=PDIbhV8Nvq8>" %}

\> 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](https://docs.smart-mirror.io/hardware) section to get started.

If you encounter problems along the way check out the [Troubleshooting](https://docs.smart-mirror.io/troubleshooting) 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.

* ![](https://2641184416-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA1bNgDKQhj0N6JxjNM%2Fuploads%2Fgit-blob-b967639baac00d576e660a23c6cc908d56ea8966%2Fraspbian.png?alt=media) Raspberry Pi OS
  * Pi 2
  * Pi 3
  * Pi 4
* ![](https://2641184416-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA1bNgDKQhj0N6JxjNM%2Fuploads%2Fgit-blob-f9475bbda9b74f02d90955fd2d9cff62e8a31e78%2Flinux.png?alt=media) Linux (Most major distributions)
* ![](https://2641184416-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA1bNgDKQhj0N6JxjNM%2Fuploads%2Fgit-blob-dd807114464b65e1e95b4f30533b5eac76063fa6%2Fmac.png?alt=media) OS X >= 10.8

#### Partially supported Platforms

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

* ![](https://2641184416-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA1bNgDKQhj0N6JxjNM%2Fuploads%2Fgit-blob-cf51a8213de5c2bc95dc5c88f8a74387d37ef87b%2Fwindows.png?alt=media) Windows 7 / Server 2008 R2 or higher
  * Keyword Spotter is not supported. See [snowboy#31](https://github.com/Kitt-AI/snowboy/issues/31).
* ![](https://2641184416-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MA1bNgDKQhj0N6JxjNM%2Fuploads%2Fgit-blob-54e19c55de1f4451f0858c2b9999f561efe13589%2Fcordova.png?alt=media) iOS and Android (Experimental!)
  * See the `cordova` branch for details


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.smart-mirror.io/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.