The Bodgery Wiki

User Tools

Site Tools

Trace:
doorbot

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
doorbot [2020/10/21 21:20] – [Installing the Software] Timm Murraydoorbot [2024/04/05 18:53] (current) – Add link to doorbot connection page Timm Murray
Line 1: Line 1:
 ====== Doorbot ====== ====== Doorbot ======
  
-The doorbot is responsible for scanning key fobs and unlocking the door for members. The software is written in Typescript and deployed to a Raspberry Pi. It expects to use the Wiegand protocol for reading fobs.+The doorbot is responsible for scanning key fobs and unlocking the door for members. The software is written in C++ and runs on an ESP32. It expects to use the Wiegand protocol for reading fobs. It communicates with a server written in Python.
  
 Implementation of the system is split up into a few repositories: Implementation of the system is split up into a few repositories:
  
-  * https://github.com/frezik/doorbotts - The base system +  * https://github.com/bodgery/doorbot-server - The server for the API and management frontend 
-  * https://github.com/frezik/rpi-doorbot-ts - Raspberry Pi-specific code +  * https://github.com/bodgery/esp32_doorbot - ESP32 firmware, plus a hat for making the connections
-  * https://github.com/bodgery/bodgery-doorbot-ts - Bodgery-specific code +
-  * https://github.com/bodgery/bodgery-doorbot-deployment/tree/edd - Deployment code +
-  * https://github.com/frezik/wiegand_pigpio - Weigand reader +
- +
-There are currently two doorbots. "Edd" takes care of the cleanroom doors, and "Hodor" is in the woodshop. These both check that keys are valid using "Tyrion", the main server for the member database.+
  
 ===== Building a Doorbot ===== ===== Building a Doorbot =====
  
-A new doorbot can be built with the following components: +To deploy a doorbot, you will need the following major materials:
- +
-  * 12V power supply: https://www.amazon.com/gp/product/B00D7CWSCG/ (if only driving a single solenoid lock, this can be slimmed down to 10A, or even 5A)  +
-  * 4x power supply holders: https://www.thingiverse.com/thing:2062755 +
-  * 120V power socket w/switch: https://www.amazon.com/URBEST-Module-Switch-Socket-IEC320/dp/B00ME5YAPK  +
-  * 5V voltage converter: https://www.amazon.com/gp/product/B00J3MHRNO  +
-  * Micro-USB cable (can be short)  +
-  * 3/8" plywood sheet, 2'x4'  +
-  * Raspberry Pi (a multicore model is strongly recommended)  +
-  * Raspberry Pi mounting bracket: https://www.thingiverse.com/thing:2480304  +
-  * Raspberry Pi prototype breakout board: https://www.amazon.com/gp/product/B07BF8Z3HS  +
-  * MOSFET, IRL540: https://www.digikey.com/product-detail/en/vishay-siliconix/IRL540/IRL540-ND/51133 +
-  * Schottky diode: https://www.digikey.com/product-detail/en/vishay-semiconductor-diodes-division/1N5819-E3-54/1N5819-E3-54GICT-ND/1023531 +
-  * SD card (8GB or more, recommend A1 rated or better)  +
-  * DB9 port breakout board pair: https://www.amazon.com/gp/product/B071ZLNDYT  +
-  * Mounting bracket for DB9 (you'll need to use OpenSCAD to convert this to an STL): https://github.com/bodgery/bodgery-doorbot-ts/blob/master/hardware/cable-mount.scad  +
-  * 120mm computer fan: https://www.amazon.com/ARCTIC-F12-Standard-Configuration-possible/dp/B002KTVFTE  +
-  * Red and Black hookup wire +
-  * Breadboard breakoff pin headers +
-  * Wood screws that won't poke through the plywood when you screw in the mounts +
-  * 4-pin molex computer connector +
-  * C13 power cable (standard computer power cable): https://www.amazon.com/gp/product/B005WKJQ4E +
- +
-{{:doorbot_internals.jpg?400|Doorbot Internal Layout}} +
- +
-First, make the box by cutting the plywood on a laser cutter using this pattern: https://github.com/bodgery/bodgery-doorbot-ts/blob/master/hardware/bodgery-doorbot-box.svg. Run off all the 3D printed parts (power supply holders, Pi bracket, DB9 bracket). Install Raspbian to the SD card. +
- +
-Using the brackets, screw down the power supply and Raspberry Pi, as well as the 5V power converter and the fan. The Pi should be placed near the open slot in the back, so you can plug in an Ethernet cable later. +
- +
-Cut the end off the micro-USB cable, with enough length to run between the Pi and the 5V power converter. Connect the power wire (usually red) to the 5V output, and the ground (black) line to ground. Use hookup wire to connect the 12V output from the power supply to the input of the 5V converter, as well as the ground line. +
- +
-Connect the 12V line of the molex connector (yellow wire) to the 12V power supply output, as well as the two central ground pins on the connector. Connect this to the fan. +
- +
-Connect the hot/neutral/ground wires of the power supply to the plug. //WARNING: These connections will be handling 120V power. Be sure they are well insulated and appropriately sized.// +
- +
-At this point, you should be able to plugin everything and have the Pi bootup. +
- +
-==== DB9 Port ==== +
- +
-The DB9 port connects the box to the components being controlled. Although it should work as long as you connect up both sides the same, it's best if we keep all the doorbots in the shop the same. Here's the recommended pinout: +
- +
-  - +12V +
-  - +5V +
-  - Wiegand Data 0 +
-  - Wiegand Data 1 +
-  - GND +
-  - GND +
-  - Door Latch +
-  - +5V +
-  - GND +
- +
-Wiegand Data 0 should go to the Rasbperry Pi's GPIO 12, and Data 1 should go to GPIO 13. Door Latch should go to the breakout board's MOSFET. +
- +
- +
-==== Raspberry Pi Breakout Board ==== +
- +
-Here's a wiring diagram for connecting the Pi: +
- +
-{{:pibreakoutboard_schem.png?400|Rasbperry Pi Hookup Schematic}} +
- +
-Connect header pins on GPIO12 and 13, plus two for the door latch. You'll also want pins for an incoming 12V input and its ground. Add a few more pins for the 5V, 3.3V, and the Pi's ground. +
- +
-Here's an example of a completed board: +
- +
-{{:mosfet_board.jpg?400|Completed breakout board}} +
- +
-This board has a few extras, like a jumper pin that could go to a switch, allowing power to be entirely cut to the latch (which might be useful for a magnetic hold system). There's also an LED indicator coming off an extra GPIO pin. +
- +
-===== Installing the Software ===== +
- +
-The Raspberry Pi will need git and Node.js installed. The wiegand reader also needs the pigio library. Install typescript globally +
- +
-''$ sudo apt-get install nodejs git pigpio'' +
- +
-''$ sudo npm -g install typescript'' +
- +
-Then, clone the deployment repository, branch "edd": +
- +
-''$ git clone https://github.com/bodgery/bodgery-doorbot-deployment.git'' +
- +
-''$ cd bodgery-doorbot-deployment'' +
- +
-''$ git checkout edd'' +
- +
-Install all the dependencies +
- +
-''$ npm install'' +
- +
-Copy the systemd startup file, and set it to start at boot: +
- +
-''$ sudo cp rfid.service /etc/systemd/system/'' +
- +
-To get the tight timings required, using a C program to read the Wiegand data tends to be more reliable than doing it in Typescript. So we'll install that: +
- +
-''$ git clone https://github.com/frezik/wiegand_pigpio.git'' +
- +
-''$ cd wiegand_pigpio'' +
- +
-''$ make && sudo cp wiegand_c /usr/local/sbin/'' +
- +
-The cache file should go in a tmpfs. Create the directory for this: +
- +
-''$ sudo mkdir /var/tmp-ramdisk'' +
- +
-''$ sudo chmod 777 /var/tmp-ramdisk'' +
- +
-And add this line to ''/etc/fstab'': +
- +
-''tmpfs /var/tmp-ramdisk tmpfs nodev,nosuid,size=100M 0 0'' +
- +
-Install some dependencies for the cache update script: +
- +
-''$ sudo apt-get update'' +
- +
-''$ sudo apt-get install cpanminus'' +
- +
-''$ sudo cpanm Sereal::Decoder LWP::UserAgent Cpanel::JSON::XS LWP::Protocol::https'' +
- +
-A username/password will need to be assigned to the box, which is created on the nginx frontend running on ''margery0''. You should then set them at the top of ''update_cache_file.pl''.+
  
-Add it to the crontab (with ''crontab -e''):+  * RFID reader for 125KHz fobs that outputs the Wiegand protocol (https://www.amazon.com/Waterproof-Wiegand-125KHz-Control-Proximity/dp/B01LWRQMN5) 
 +  * Electronic strike running at 12V or 24V (https://www.amazon.com/UHPPOTE-Standard-Fail-Secure-Fail-Safe-Adjustable/dp/B00V49S2NI) 
 +  * A power supply matching your 12V or 24V strike 
 +  * An ESP32 [TODO: exact model of dev board] 
 +  * The doorbot hat (see below) 
 +  * An enclosure (3d printed)
  
-''1 * * * * perl /home/pi/doorbot/update_cache_file.pl > /dev/null''+[[Howto connect the doorbot|doorbot_connection_howto]]
  
-Which will update the cache file hourly.+Building the hat is covered elsewhere (TODO make that page)
  
-Finally, start the whole thing running:+  * TODO: RFID reader connections 
 +  * TODO: Power connection 
 +  * TODO: Strike connection 
 +  * TODO: Configure firmware 
 +  * TODO: Uploading firmware
  
-''$ sudo systemctl start rfid''+===== Serial Port Debugging =====
  
-And have it start at boot:+The ESP32 has a USB port, and much useful information is given about the cache status, key reading, etc. There are also a few commands you can send:
  
-''$ sudo systemctl enable rfid''+  * check <ID> - Check if a keyfob is valid 
 +  * newcache - Rebuild the cache 
 +  * open - Open the door 
 +  * stats - Dump info about this doorbot
doorbot.1603315201.txt.gz · Last modified: 2022/05/29 16:01 (external edit)