Giter Club home page Giter Club logo

doorbot's Introduction

Doorbot

Door-opening server with user management AKA: "freesee"

Uses a raspberrypi and a solid-state relay to unlock the door. A node server running optionally elsewhere manages the users and serves the WebUI.

Setup

Hardware

All you need is a RasberryPi, a Relay, and a lock (Amazon). Install rasbian then plugin the relay. It's recommended to use a signal pin above 8, because they will default to Low, and wont open the door on reboot. pin-layout

raspberry-pi

Server

The server can be run on the PI or anywhere else. Docker images exist for ARM and x86.

The docker-compose.yml file has been configured for x86. For other architectures, like on the raspberry pi, uncomment the proper two lines like: image: thann/doorbot:arm7.

Then, from the cloned repo, run:

docker-compose up -d

Navigate to http://localhost:3000 and login with the username and password admin Change your password then add users and doors. When creating a user they are given a random password, that you should email them.

Alternativly, if you don't want to use docker, from the cloned repo run:

npm install then ./server --build

Door

Once you have added a door in the WebUI, copy the token then paste it into docker-compose.yml replacing "abc123"

Then re-run sudo docker-compose up -d After refreshing the WebUI, you should see the "Open" button appear for the door.

Alternativly, if you don't want to use docker, from the cloned repo run:

./door -k -s <SERVER_IP> -t <TOKEN> and use the --dummy flag when not on a PI.

doorbot's People

Contributors

darrenrm avatar thann avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

willyum

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.