Originally forked from raudette/lockandkey but heavily modified. This project was created to solve a technoligical shortcoming in my current apartment. At least in my building the buzzer system is only designed to ring phones directly connected to a phonejack in the unit. This isn't ideal since I may not always be home when I want to let someone into my building.
A Raspberry Pi runs a nodejs application backed by a mongo database for persistent data. The TFM-561U USB modem (56k dial up sounds anyone?) handles passing the call along to the Raspberry Pi so we can determine what we want to do with it. If a guest has the necessary login credentials they can visit my login portal. On successful authentication the user is redirected to a page which tells them they have xx number of minutes to buzz in before the system will lock them out again. The admin is also sent an email letting them know which user has just logged in.
When the app notices a succesful login it handles a few things:
- Sets the usesrs
LOCKflag toFalse - Updates the users last successful login
timestamp - Sets the
auto-answerflag toTrue
Now when the guest dials my unit number the application will answer the call, dial 6, and hang up the call. The main entrance door will be unlocked and my guest can enter the building. A check runs every 10 seconds looking for users who have their LOCK flag set to False and current time is not greater than the login time + unlocktimeout. When it finds a user that matches that criteria it sets the LOCK flag back to True and disables the auto-answer.
The admin portal listens on a seperate port and should ONLY be accessible from your private LAN. It allows you to add new users as well as delete exisiting ones.
- Raspberry Pi Model B
- TFM-561U
lockandkeyconfig.json contains a few options you can customize to your liking:
- port: port used for the publicaly available login portal
- adminport: port used for the admin portal (should be restricted to private lan)
- unlocktimeout: number of minutes to wait after a succesful login. During this window the system will pickup, dial 6, and hangup.
- modem_id: string used to identify the modem which should be used by the application
- sendgridkey: Send Grid API key used for sending emails on succesful logins
- emailto: Address which emails will be sent to.
- emailfrom: You can essentially put whatever you want here. I'm using [email protected]
{
"port":3000,
"adminport":3001,
"unlocktimeout":15,
"modem_id":"Conexant"
"sendgridkey": "<API_KEY>",
"emailto": "[email protected]",
"emailfrom": "[email protected]"
}sudo apt-get update
sudo apt-get install git npm nodejs mongodb
sudo ln -s /usr/bin/nodejs /usr/bin/node
git clone https://github.com/raudette/lockandkey.git
cd lockandkey/
npm install
sudo npm install -g forever
sudo npm install -g forever-service
sudo forever-service install lockandkey --script lockandkey.js
sudo service lockandkey start
Logs will write to /var/log/lockandkey.log
- Setup Lets Encrypt for SSL
- Text-To-Speach greeting
Original codebase: raudette/lockandkey
Login form design: vineethtr