Giter Club home page Giter Club logo

mirroros's Introduction

MirrorOS

MirrorOS

MirrorOS is a new platform for smart mirrors built on Electron that focuses mainly in interactivity featuring voice commands and a smarthpone remote app. It runs web apps which are easy to build and has a set of APIs that developers can use to easily integrate voice commands and smartphone remote control.

NOTE: This project is in a very early phase. You can expect bugs and crashes. It has been tested on Raspberry Pi 2 and 3.

Setup

Dependencies

NPM v2 or greater: (https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs

Pyaudio:

sudo apt-get install python-pyaudio python3-pyaudio

Installation

# Clone the repository
git clone https://github.com/s6joui/MirrorOS

# Go into the repository
cd MirrorOS

# Install node dependencies and run
npm install && npm start

Follow the configuration steps below to get everything working. To test the different apps I recommend using the remote control smartphone app described below.

Configuration

Most apps will need access to API keys from different services to fully work. Edit the config.json file and add your own API keys. In this file you can also set the default home app and the default assistant app as well as enabling gesture support but this requires you to have the appropiate sensors to work.

Minimunm hardware requirements

  • Raspberry Pi 2 or later

Remote control

You can control MirrorOS from any device that has a browser by going to the IP address that's shown on the top left of the screen. It's specially useful with a smartphone. From the remote control app you can install other apps, launch apps and use your smartphone's microphone to send commands to the mirror.

Apps

Home app

Shows weather and date information. Can set reminders.

Super app (Assistant)

This is a Sri-like app. Ask anything!

YouTube app

Watch YouTube videos.

Social app

Search Instagram pictures by hashtag.

News apps

Shows news from differnet sources. Not customizable yet.

App development

Coming soon... In the meantime check the source of the included apps. They are all in the "apps" folder.

App distribution

Simply zip your files so that the manifest.json stays at the root of the zip and upload to a server. You can then install the app by entering the url on the remote control app.

License

MIT License

mirroros's People

Contributors

s6joui avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mirroros's Issues

google speech

So, I've gotten past the clap to start, really cool btw, but the google speech recognition is not working. I've entered in my API key given in the google developers console, but I can't get it to work.
This is the URL https://console.developers.google.com/apis. Is there another place to go for it? Do you have a solution for me @s6joui ?

Just shows starting

Hi,
I successfully installed MirrorOS on my pi and have finished installing all the dependencies.
But when I do "npm start ".
I just receive an electron window with a single word "starting...". I waited for about half an hour but nothing came up.
Can anybody please help me??

cannot run npm install

I followed the manual installation but cannot execute yarn install or npm install:

pi@RPI3B:~ $ cd MirrorOS
pi@RPI3B:/MirrorOS $ npm install
bash: npm: command not found

I have the latest Raspbian Stretch on Raspberry Pi 3

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.