A remote door api and web application for Raspberry Pi, Odroid, Orange Pi or BeagleBoard (based on python).

Clone the repository to your installation path with git clone https://github.com/blinzelaffe/roseguarden.git

First of all update and upgrade your raspberry pi os

1. sudo apt-get update
2. sudo apt-get upgrade

For the frontend we need nodejs to get a module called bower and a fast nodejs http-server. The http-server serve the http-request. Bower will handle all the frontend dependencies. You can install the most actual nodejs package like this.

3. wget http://node-arm.herokuapp.com/node_0.10.36_armhf.deb
4. sudo dpkg -i node_0.10.36_armhf.deb

NOTE: for the old raspberry pi the nodejs 0.10.36 is used. Some newer versions have problems with the c++ libaries. Have a look at http://weworkweplay.com/play/raspberry-pi-nodejs/ for further informations and instructions. The newest nodejs-version 4.2.1 suppose to have direct raspberry pi (ARM6/ARM7) support included. It has to be tested with RoseGuarden.

First we install the nodejs-http-server For this step you have to switch to the client-directory and prompt

5. sudo npm install -g http-server

Now we could install bower and let bower get us the packages for the frontend (css, angularjs, smarttable, etc.). In the same client-directory prompt

6. sudo npm install -g bower
7. install the bower packages with bower install (in the client-directory install)

Now the frontend is ready.

For the backend (python) we have to install dependecies, too. The python package manager pip will handle this for us. So we need to install pip like this.

8. sudo apt-get install python-pip

At this point we will get the python packages list in the requirement.txt file. Switch to the server-directory and prompt.

9. sudo pip install -r requirements.txt (in the server-directory)

To use the rfid-reader (rc522) we have to install SPI-Py. Switch to the server/app/SPI-Py-directory and install the dependencies and the module.

10. sudo apt-get install python-dev needed to compile c++-bindings with python
11. sudo apt-get install gcc needed to compile c++
12. sudo python setup.py install install the module

Note: depending on your raspberry pi and kernel you have to re/enable the spi-module and the device tree support with sudo raspi-config -> 'Advanded Options'

• add your MAIL_USERNAME to your enviroment variables (for enabling mail service, default mail-server-configuration is for googlemail)
• add your MAIL_PASSWORD to your enviroment variables (for enabling mail-service, default mail-server-configuration is for googlemail)
• initialize RoseGuarden database in the server - directory with sudo python db_create.py

• start the http-server in the client - directory with http-server -p 8000
• start the RoseGuarden-app in the server - directory with sudo python run.py

To update the software to the latest version on github, use git.

• git fetch --all
• git reset --hard origin/master

The hardware consists of the following electronics types mounted on a board.

• the control unit (Rapsberry Pi, Orange Pi, Beagleboard or Odroid): running the Python based app and server.
• a RFID-reader (e.g. RC552): reading and writing the tags
• a relay-module: controling the door-openers
• a dc-dc-converter: supplying the control unit with a input of e.g. 12V / 24V and a output of 5V
• a micro-usb cable of 30cm length: connect dc-dc-converter to the control unit
• some internal cable: e.g. from dc-dc converter to the relay module or to the raspberry pi

Here some photos of the assembled and mounted Roseguarden device in the early stage.

We recommend the following devices, to use on the provided case:

• Rapsberry Pi 1 B (found on watterot, rs online, digikey)
• KIS3R33S dc-dc converter (found on ebay from various distributoirs from about 3€ per piece)
• RC552 rfid reader, including 2 rfid-tags (found on ebay from various distributors from about 3€ per piece)
• SainSmart 2 ch. relay module or compatible (found on ebay from various distributors and producers from about 3€ per piece)
• the 3d-printed case on below
• 4 x M2 and 10 x M3 screws to mount the electronic to the case

additional for connecting and supllying the device:

• some breadboard female-female connector (found on pollin, watterot or sparkun)
• some cable with at least 3 wires @ 1A (found on pollin, reichelt, digikey or your local electronic store)
• a ethernet-patch-cable (found on pollin, reichelt, digikey or your laocal electronic store)
• or a wifi-dongle (found on pollin, reichelt, digikey or your laocal electronic store)

additional for mounting the device on walls or doors:

• suckers with 40mm diameter and M4-bolts (found on ebay from various distributors from about 7€ per 10 pieces)
• or glue tape for mounting
• or screws for mounting

The case ist modeled with the powerful open source software FreeCAD. Have a look in the hardware folder for the current stable version of the board and its case. It is designed to be 3d-printed with dimensions of 145mm x 145mm x 60mm. The design uses suckers to mount the device to windows or doors. With a few modifications you can also use screws for a more stable mounting. Be aware that the RFID-communication could only reach throw about 30mm non-metallic walls or glass (+ aboout 20mm rfid-module-to-wall distance).

Feel free to change the design to your needs. Please share your changed designs and new versions with the community (by asking for a push request).

To assemble the components, you only need some additional M2 and M3 screws to put the electronics on the board. While using other electronics than recommended, change the board modell to your needs. The positions are marked for easy assembly. The cable can put throw cable holes and routed along dedicated bolts.

The schematic show the connection between raspberry pi and the modules.

Further documentation and information on components and installation could be found on the project-wiki http://h2371910.stratoserver.net/projects/tuer-und-geraeteverwaltung-rosenguarden/wiki/Wiki (german language only, please translate via google translate or other services).

The rfid don't read any tag

With Kernel 3.18 and above Rasbian switch to device tree support on default. A detailed description is shown here: https://www.raspberrypi.org/forums/viewtopic.php?t=97314 This could encounter problems with the spi.

To fix the issue you have to re/enable the spi-module. To setup this use sudo raspi-config -> 'Advanded Options' or write the changes directly to /boot/config.txt on your own.

For Raspbbery Pi B

dtparam=spi=on

dtoverlay=spi-bcm2708

have to been set.

For Raspberry Pi 2 (not tested, yet)

dtparam=spi=on

dtoverlay=spi-bcm2835

should be working (not tested yet)

For Raspberry Pi 2 please consider, there is be a another pin-out-connectio needed. Some instructions described here: https://www.raspberrypi.org/forums/viewtopic.php?f=37&t=106313 or a alternative way to enable SPI here http://bsd.ee/~hadara/blog/?p=1017

Mifare_RC522_RFID Raspberry Pi 2 B

MOSI ——————————> pin 19 e.g. GPIO 10

MISO ——————————> pin 21 e.g. GPIO 9

SCLK ——————————> pin 23 e.g. GPIO 11

SDA ——————————> pin 24 e.g. GPIO 8

RST ——————————> pin 22 e.g. GPIO 25

IRQ ——————————> NONE

RoseGuarden is published under the terms of the GPL v3 license. See LICENSE.