Door control system

From London Hackspace Wiki
(Redirected from Doorbot)
Jump to: navigation, search

Preface

The major difference between a thing that might go wrong and a thing that cannot possibly go wrong is that when a thing that cannot possibly go wrong goes wrong it usually turns out to be impossible to get at or repair.
- Douglas Adams, 'Mostly Harmless'

Adding a card

If you're a new or pending member and looking to add a card to enter the space on your own, be sure you have an RFID or Contactless Smart Card that operates on the 13.56MHz frequency. You likely have several in your wallet and may not even know it. Note that our doorbot RFID readers do NOT read the older 125kHz frequency RFID cards frequently used for older 1990s/early 2000s era office/housing access, so not every card works in our system. You are likely in luck and have at least one 13.56MHz card already: the Transport for London Oyster card is by far the most popular card used by LHS members, but several members have also successfully used various hotel RFID keycards, contactless credit and debit cards, some RFID wristbands, and some compatible government ID cards as well.

Cards that are known to work well

Cards that don't work as well

  • Contactless bank cards have more processing power on-board, and need quite a lot of RF energy to activate, so may not work as reliably as simpler cards like Oyster card or simple keyfobs. We have refitted all readers known to have problems activating bank cards with more reliable readers. Don't worry, we don't have the decryption keys to do anything banking related with your bank card, we just read the serial number, not the number printed on the front.
  • Passports with RFID chips will not work, and by attempting to use them will reset some internal read count in the passport, which may raise questions at border crossings.

'Cards' that don't work at all

  • Apple Pay
  • Android Pay
  • Most Android card-simulator apps

All of these generate a random UID for each transaction.

  • The new "N26" Bank contactless card - also generates random UID each time!
  • 125kHz frequency RFID cards (HID building entry systems)

If you still cannot find a capable card, you can buy them relatively easy off of eBay or Amazon UK or a local vendor such as Cool Components

Entering a working RFID into the member DB

Access is based on the RFID UID - it is not the number written on the back of your Oyster card. There are several ways to add a card:

  1. Use the Membership Kiosk which is on the first floor. You will need to enter your email address and password.
  2. Run the "Add card to Doorbot" script on Tesla (hint: the shortcut is on desktop) and follow the instructions (basically, swipe your card and then enter your hackspace website login details).
  3. If you have a similar ACR122U card reader, you can get the code at Github and run addcard.sh on your own. If you have another reader that can give you the UID, log in to the website and add it at the Member Addcard webpage. Note that our doorbot code is case sensitive; enter the (hex encoded) ID using without colons.
  4. If you have an Android phone that supports NFC, you can download one of the following free apps. Once you've downloaded and opened it, you'll be able to scan your RFID card and enter your card ID here. Your phone may need to activate NFC connections/reading on your phone. On Android, you can find this in Config/Settings>Wireless and Network Connections.
    1. NFC TagInfo by NXP (under Detailed Protocol Information, possibly removed in recent versions)
    2. NFC Tools by wakdev (under Serial number)

Note that UID is entered in without colons. If your mobile NFC scanning application shows 04:2b:2e:6e:fa:bc:de you should enter it into the website as 042b2e6efabcde

Do not worry if your card UID is shorter than the example - UIDs can be as short as 8 characters (4 hex pairs).

There is the possibility for an integrated LHS membership RFID reader app - Hackspace member and former trustee Jasper had built an Android app that automated the previous mobile task but the website changed and the app broke. If you're into mobile development and want to try to make something updated, please refer to the LHS Self Enrol App (Background details and more info in the blog post from 2012).

Doorbot sounds

Set your wave file (in wav or mp3 format) on the members site. The easiest way of doing this is to have a URL as the filename, and it will stream directly from that URL.

Many early members enjoyed doorbot audio greetings in the style of GLaDOS - an artificial-intelligence sounding voice used in the Portal series of video games and in the movie Pacific Rim. Want to fit in with the 'classical' spirit of the Hackspace? Generate your own GLaDOS voice file on this site here.

To avoid annoying people in the hackspace with overly long introduction sounds, the playback is limited to the first 17 seconds.

Old GLaDOS Voice Generation Guide

(This doesn't work any more, the websites, and videos, that it refers to are no longer active) There was a guide on Youtube made to show the process as its hard to describe simply in text: http://www.youtube.com/watch?v=OE8S9knXcW0

The original GLaDOS voices were generated by oni following the method found by Tom Wyatt. To create a GLaDOS voice one must do the following:

  • Go to ATandT's Text to Speech Website (now offline). Type in your name and download the file. Alternately, use Cepstral or another online text-to-speech site allowing downloads.
  • Load up the program Melodyne
  • Select the entire Waveform
  • Using the melodic algorithm, double click on one section of the waveform. I believe this moves the form to its nearest notes.
  • Using the zig Zag looking tool, flatten the pitch.
  • Up the pitch by dragging upwards by 160 or so.
  • Save

Hardware

Card readers are based around a pn532 chipset reader, configured to HSU (High Speed UART) mode. This should allow us to read the UID field from block zero of almost all 13.56MHz RFID cards,rings,bands,fobs. HOWEVER, some reader modules are better than others:

  • Elechouse V3 modules (genuine, red boards). Need a good +5V Vcc supply to be able to energise bank cards., use a DC/DC boost converter on long cable runs.
  • Deek-Robot modules (blue boards), beware the pinouts are incorrecly labelled on the silkscreen on one side of the board. These boards appear to no longer be manufactured.
  • Fake Elechouse V3 modules. Don't read very well at all except for very simple fobs with limited power draw. These can be identified by not having the word 'Elechouse' in italics, or having a full stop after the "NFC MODULE V3" label.

Also on the reader modules, there's normally a pushbutton (for menu access on acnodes, or for doorbell action on the door readers), and an RGB LED.

Front doorbot

The front doorbot at 388 High Road is based on a TI Connected Launchpad, and works alongside the building landlord's door entry system. During normal 'office hours', the maglock on the front door between the street and the shared lift lobby will be unlocked by the landlord's system. Only outside of normal hours will the door entry phone (only used by other tenants), and Hackspace's Front Doorbot will be necessary. Exit button is the landlord's door release button.

The Hackspace card reader is a small blue enclosure on the right hand glass. The reader loop is at the top of the enclosure near the logo.

Front doorbot is in a shared enclosure with the Ground floor (aka Workshops) doorbot, and has a battery backup. In the event of power failure, it will still try to open doors with cached credentials, though some functions will depend on working networking and working acserver.

The front doorbot sends out notifications using MQTT, to the topic base /door/gf-front-external. Any network device can listen in to these messages and set up their own bot/reporting infrastructure, etc.

Back Doorbot

The back doorbot is the same as the front - with two differences: there's no bell, and the relay is activated by setting the pin state to HIGH.

Radio Lab Doorbot

The radio room is fitted with the same as the workshop door setup. The reader is a standard reader with a doorbell button, but there is currently no software to pick up on the button and make a noise, should there be a need for it. In the same enclosure as the Electronics Lab doorbot. SLA 12V backup battery. Restricted access. You need to have an amateur radio licence and have a facility induction to gain access. Contact marrold or tgreer. Fitted with a reader with a doorbell button; though that doesn't do much yet.

Biohackspace Doorbot

This is the same as above. You need to be a member of the Biohackers to get in. Not currently deployed.

1st Floor Doorbot

Dual Solenoid bolt, 1st floor entrance from lift lobby. SLA 12V backup battery. ACNode shield v1. Node id 2

Rebuilt to make it more like the ground floor / front doorbot, and to implement a doorbell button on the reader.

Back cage gate doorbot

Maglock on cage gate. Exit button in shrouded case. ACNode/Doorbot board. Doorbell button fitted in IP55 reader enclosure. Reader needs replacement with a more reliable module. Fitted with SD card for cacheing credentials.

Maglock vs Solenoid latch vs Solenoid deadbolt

Though we currently use maglocks (because we had them in stock), we were aware of some issues with them, and have replaced some of them with solenoid deadbolts. The old Cisa solenoid latch on the back door required very gentle adjustments, and was not really suited to a double-leaf door installation.

Software

The source code for the software on the nodes is on Github, the server is here acserver-django

All the logs go over the network to /var/log/network/ on adminstuff, but it's not configured yet.

The access list is JSON file.

Notification and status messages go via mqtt to the mqtt server. All the listener clients will subscribe to feeds on the mqtt server, and action notifications accordingly.

The door opener sends an MQTT message whenever the door is opened by a member using their card , or if the front doorbell is pushed.

Doorbot listener scripts

There are listeners on hamming that connect to robonaut to announce on IRC, and flash the lights using Lighted. By default, this will include your full real name. If you wish to change this behaviour, you can set up a nickname in the cards section of the member area.

hamming also runs listeners for the scrolling led board and the audio announcements.

The announcement listener uses the GLaDOS voice. You can generate and use your own file as a greeting. Update your 'Glados file' with a URL of an audio file, and it will play a maximum 12 seconds of the sample when you enter the 1st floor. File formats supported include mp3, m4a, wav, and non-DRM-protected aac. It will not play 'audio' from a YouTube URL. The Announcement listener runs on Hamming, announcing the 1st floor door, and on Holonyak, announcing the back door, Workshops door, and cage door.

The code that runs the bandwidth meter on adminstuff also listens for doorbell and member entry messages.

Managing Doorbots

Logging & maintenance

If you make changes or discover a problem with doorbot, please add it to the logbook.

On hamming, and Holonyak the listeners are at /srv/doorbot/listeners

sudo supervisorctl restart all


Emergency Exit door release

Next to all doors that act as emergency exits, and may need to be held open in the event of firefighters needing to retain access back into the building in the event of a fire, there are green 'break glass' style emergency exit buttons. Do not use these except in an emergency situation. You don't need to break the glass - which is actually plastic - but if they are triggered, then you will need a special key to reset them. The key is an orange plastic key, one of which is kept in the 1st Floor comms room doorbot enclosure, and the emergency exit button is reset by inserting the key into the underside of the emergency door release.

All normal door exit buttons used in the hackspace are failsafe, that as well as signalling to the electronics to open the door (with a timed release), will also use another contact to break the circuit that would hold the door closed while the button is pressed.