beaubrewer / bellman

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bellman

at your service

Bellman is a Google Calendar driven doorbell sound manager. Doobell themes are defined in the event description using YAML. Bellman really needs a cool logo!

Installation

Bellman requires

  • A MQTT Broker to run. CloudMQTT offers a free tier if you prefer not to install one.
  • A Google Account and Calendar to schedule sound themes

Clone the bellman repo into your $GOPATH

Install Glide - the package manager bellman uses.

$ curl https://glide.sh/get | sh

If you are using a Mac, Glide can be installed via homebrew. brew install glide

Move into bellmans project root and run glide install to install dependencies.

If you are building on a Raspberry PI you may need to install alsa sound libs via

$ apt-get install libasound2-dev

Build bellman via go build bellman.go

Configure bellman

$ ./bellman configure

Once you have configured Bellman run...

$ ./bellman server

Development

Want to contribute to Bellman? Great! Let's work together to make the only doorbell manager... the best doorbell manager!

Todos

  • Dockerize
  • Add sound events that play at specified date/times
  • Improve configuration

License

MIT License

Copyright (c) 2018 Beau Brewer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Free Software for WildWorks VIPs :)

About


Languages

Language:Go 100.0%