lisa-box
v0.0.22
Published
Home automation system L.I.S.A.
Downloads
76
Maintainers
Readme
L.I.S.A.
Home automation system L.I.S.A. http://mylisabox.com
WORK IN PROGRESS
How to use it
The easiest way to test L.I.S.A. is to use the pre configured image for Raspberry PI 2 or 3. Take a look here
Development
To run the project you need to do multiple things:
1) Retrieve the project
- For some functionality L.I.S.A. need some linux module already installed,
#Mandatory dependencies
apt-get install -y mongodb-server libzmq3-dev
#Matrix board dependencies
apt-get install -y matrix-creator-openocd matrix-creator-init matrix-creator-malos lirc
#Voice recognition dependencies
apt-get install -y sox libsox-fmt-all alsa-utils libatlas-base-dev libatlas3gf-base
git clone https://github.com/mylisabox/lisa-box.git
cd lisa-box
yarn //or npm i
2) Initialize plugins
For now no UI or way to install plugins, you have to do it manually, for that clone or copy plugins project you want
under /plugins
, if plugins need dependencies don't `forget to yarn/npm them.
After that you need to enable plugins on database in order to them to be loaded, you have an example on
config/bootstrap.js
on how to do this (at the bottom, the commented part).
3) Setup voice recognition
Voice recognition work in 2 phases thanks to the sonus module:
- First offline recognition of the hotwords "Hey lisa", nothing to do here it should work
- Then the next part use Google Speech API to recognize the voice command, Google API need a config file to work.
This file should be under
/config/speech/LISA-gfile.json
, to create this file please follow those steps and copy/paste/rename the file in the correct place.
4) Run the project
yarn start //npm start //node server.js
- Go to http://localhost:3000
5) Enable SSL
To enable SSL just put a file server.key
and server.crt
under config/ssl/
, if you want other file name just edit config/web.js
to specify the correct values.
Notification
There multiple template available for notifications. Here there are :
- Basic with left image, title and message
- Basic with right button
- Basic with two right button
Contributing
We love contributions! Please see our Contribution Guide for more information.