README
¶
Marvin
Marvin is a character for your home that enhances your life. Marvin is software that runs on a beaglebone along with a cape that contains a number of added sensors (available upon request).
This github repository contains Marvin's software. Marvin currently has the following abilities:
- to interact via a web interface
- to control hue light bulbs
- to detect motion via its motion sensor
- turn on nightlights upon sensing motion when in sleep mode
- track history of motion
- to detect ambient light levels via its light sensor
- turn on lights when it gets dark if in awake mode
- to track and key off of activity
- sleeping causes Marvin to turn off ligths and turn on motion triggered nightlights
- waking causes Marvin to slowly fade on lights (AKA sunrise)
- to schedule lighting or activity transitions for different times of the day and week
- to turn on and off various behaviours
- nightlights switch for turning off motion triggered nightlights
- schedule switch for turning off schedule
- to detect presence
Components
- marvin - package containing core functionality
- marvin/web - package containing web interface
- marvin/marvin - package containing program
Install 
get ubuntu
If you are installing Marvin on your BeagleBone we've been using 13.04 from ARMhf.
install build tools
sudo apt-get install gcc g++ make mercurial
install latest golang
Marvin is written in Go so you will need a Go environment to build and install it. You will probably want to put the GOPATH and GOROOT environment variables in your ~/.profile.
hg clone -u release https://code.google.com/p/go
sudo mv go /opt/go
cd /opt/go
./all.bash
mkdir $HOME/go
export GOPATH=$HOME/go
export GOROOT=/opt/go
install latest nodejs
Marvin's needs a nodejs environment for managing external javascript and css dependencies using Bower.
wget http://nodejs.org/dist/v0.10.13/node-v0.10.13.tar.gz
tar xvfz node-v0.10.13.tar.gz
cd node-v0.10.13
./configure --without-snapshot
sudo make install
install marvin
go get -v -u github.com/eikeon/marvin/marvin
export MARVIN_HOME=$GOPATH/src/github.com/eikeon/marvin
export PATH=$MARVIN_HOME/web/node_modules/.bin:$PATH
pushd $MARVIN_HOME/web; make install; popd
sudo cp conf/marvin.json /etc/marvin.json
sudo cp conf/marvin.conf /etc/init/marvin.conf
sudo start marvin
# point browser at http://{your-hostname}:8000
Other Marvin channels
Documentation
¶
Index ¶
- type Marvin
- func (m *Marvin) Do(who, what, why string)
- func (m *Marvin) GetActivity(name string) *activity
- func (m *Marvin) LightSensor() bool
- func (m *Marvin) Log() (messages []*Message)
- func (m *Marvin) MotionSensor() bool
- func (sc Marvin) Register(c *chan State)
- func (m *Marvin) Run()
- func (m *Marvin) Save(path string) error
- func (m *Marvin) StateChanged()
- func (sc Marvin) Unregister(c *chan State)
- func (m *Marvin) UpdateActivity(name string)
- type Message
- type State
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Marvin ¶
type Marvin struct {
Hue hue.Hue
Activities map[string]*activity
Activity string
Motion bool
DayLight bool
LastTransition string
Present map[string]bool
Switch map[string]bool
Schedule scheduler.Schedule
Messages []string
States map[string]interface{}
Transitions map[string]struct {
Switch map[string]bool
Commands []struct {
Address string
State string
}
}
StatHatUserKey string
StartedOn time.Time
MotionOn time.Time
RecentMessages cb
// contains filtered or unexported fields
}
func NewMarvinFromFile ¶
func (*Marvin) GetActivity ¶
func (*Marvin) LightSensor ¶
func (*Marvin) MotionSensor ¶
func (*Marvin) StateChanged ¶
func (m *Marvin) StateChanged()
func (Marvin) Unregister ¶
func (sc Marvin) Unregister(c *chan State)
func (*Marvin) UpdateActivity ¶
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.