/smart-mirror

The fairest of them all

Primary LanguageJavaScript

Smart Mirror

This project is inspired by HomeMirror and Michael Teeuw's Magic Mirror. It uses annyang for voice interactivity, electron to make it cross platform, and integrates with Philips Hue. It is my own take on what a "smart mirror" can be.

Why start from scratch?

Starting from scratch was less about other projects not being good enough and more about my own learning experience. While I did get a lot of inspiration from other projects I really wanted this to be my own!

Take it for a spin:

Check it out: https://evancohen.github.io/smart-mirror/. The version running on this link has limited functionality and it quite out of date. It's just to give you an idea of what it's like.

Getting Started

Hardware Components

  • Raspberry Pi 2
  • USB Microphone (Or Webcam w/ microphone)
  • Monitor (with the bezel removed)
  • Mirror Pane (aka Observation Glass)
  • Philips Hue

Installation

In order to get started I suggest a clean install of Raspbian. You can snag a fresh copy of Jessie (recommended, it's the future) or Wheezy from the Raspbian Download Page.

You'll also need to install Node and npm to make things work.

Getting the code

Next up you'll want to clone this repository onto your Pi if you haven't already yet

git clone git@github.com:evancohen/smart-mirror.git
Setting up the configuration

Done? Excellent, let's continue.

Time to update the config file... You'll need to fill in two things into js/config.js:

  1. A Forecast API key (don't worry, it's free)
  2. Philips Hue Bridge IP address with a configured user. Details about how to set this up in the Philips Hue Developer Documentation
Install dependencies and run

Before we can run the thing we've got to install the projects dependencies. From the root of the smart-mirror directory run:

npm install

This will take a minute, it has to download electron-prebuild. Once that is done you can launch the mirror with

npm start

Disabling the debug console

If you don't want the debug console to open up every time you launch the mirror you'll want to comment this line out from main.js:

mainWindow.webContents.openDevTools();

License:

MIT

More info:

Favicon from In the Wake of the King, a head nod to The Watcher – "A byblow of the king and a queen of the sea, she has remained apart from the workings of her family, more home beneath the waves, watching all through water and mirror. Her ambitions lie outside the Eternal Kingdom, but her secrets are valuable everywhere."

Awesome.