Overview
Use this page to get the external RFID reader working on a FUYL 8 or FUYL 23 (MK4) for a demo, using your own ID card. It assumes the locker is standing, powered and online, with the RFID Kiosk Kit installed. The kit's reader is an HID OMNIKEY 5427CK, plugged into the back of the control door and routed as shown in the Kiosk Kit's quick start guide.
Often the reader works as soon as it's plugged in, because we've preconfigured it at ForwardPass for the cards it'll be reading. A normal rollout includes that planning up front (we'll ask for your card details and a sample card before the readers ship). For a demo with a card we haven't tested, the reader may not respond to it, and If the reader doesn't respond to your card explains how to change that from a Windows PC.
The full details of RFID on FUYL Enhanced are in RFID Authentication.
Before you start
- Locker: a FUYL 8 or FUYL 23 (MK4) on FUYL Enhanced, with the RFID Kiosk Kit installed.
- Card: the ID card you'll demo with.
- FUYL Portal access: an Admin login to the account the locker belongs to.
- Demo user: a user who can sign in at the Kiosk. They'll need your card's value as their RFID credential.
- Windows PC: only needed if the reader doesn't respond to your card (see below).
Check the reader
- Check the light Once the locker has booted, the light on the reader should be on.
- If it's off, check the cable Power off the locker and open the control door. The reader's USB cable should be plugged into a USB-A port on the controller (next to the Ethernet port). Power the locker back on.
- Tap your card Hold the card flat against the reader. It should beep, and the light should change colour (usually from white to blue).
Note: the locker only picks up the reader when it starts, so restart the locker after plugging the reader in or reconnecting it.
If the reader beeps or changes colour, go on to Set up the FUYL Portal. If it does neither, it isn't set up for your card type; see If the reader doesn't respond to your card.
Set up the FUYL Portal
The RFID readers are on by default, so the only change here is making RFID the Kiosk login method.
- Open the Kiosk login settings In the FUYL Portal, go to Settings > FUYL Kiosk login .
- Select RFID You can also add a prompt for users, e.g. "Tap your ID card on the reader".
- Save the changes
Match your card to the demo user
The locker signs in the user whose RFID credential matches the value read from the card. For a demo, leave Type and Data format under Settings > RFID unset. The value then comes through unchanged, so the demo user's credential needs to match what the reader sends exactly.
- Find your card's value Go to Settings > RFID and find Conduct test read. Select the Kiosk station group the locker is in, enter any value as the expected value, click Run Test, then tap your card. The result shows the value the locker read.
-
Give the value to the demo user Set the demo user's RFID credential to that value. Credentials come from your identity provider, through an attribute mapped to
rfid_credential, so it'll appear after the next provisioning sync. - Test again Run the test read again, this time with your card's value as the expected value. Read & Transform Match, Database Lookup and Expected Value Lookup should all pass.
Mapping the attribute is covered in the Sync RFID Data section of RFID Authentication.
Note: a test read listens to every reader in the selected station group. If there are other lockers with readers in that group, check nobody else taps a card during the test.
Run the demo
- Start a workflow On the FUYL Kiosk, pick a workflow as the demo user.
- Tap your card On the reader in the Kiosk Kit.
- Carry on The Kiosk signs you in and the workflow continues.
Note: for now, the Kiosk's "tap your card" animation points at the control door, even with an external reader fitted. Tap your card on the Kiosk Kit's reader instead.
If the reader doesn't respond to your card
The reader only responds to the card types it's been set up for. If it doesn't beep or change colour when you tap your card, your card's type needs turning on in the reader's own settings. That's done from a Windows PC, and then the reader goes back on the locker.
You'll need:
- A Windows PC that you're sitting at. The reader's driver is Windows-only (there's no macOS version), and remote desktop sessions and virtual machines often ignore what the reader types, so the Notepad check below won't work through them.
- The HID OMNIKEY 5427CK EEM driver, which you can download from HID. HID has several OMNIKEY drivers, so check it's the one for the 5427CK.
Connect the reader to the PC
- Install the driver Run the installer and accept the Typical installation. This is only needed once per PC.
- Unplug the reader from the locker Power off the locker, then unplug the reader from the controller.
- Plug the reader into the PC Any USB-A port will do.
-
Open the reader's settings In a web browser on the PC, go to
http://192.168.63.99. There's no login.
Turn on your card type
You'll set the reader to type each card's value like a keyboard so you can check it in Notepad, then switch it back to the mode the locker uses.
- Switch to keyboard mode Under Keyboard Wedge > General Config, set the output type to Keyboard Wedge and check it's enabled.
-
Choose your card type Under Card Data Selection, tick your card type and untick the rest (so other cards in the same wallet, like transit cards or visitor badges, aren't read). Then choose which part of the card to read;
- HID Prox (26-bit H10301): FSK Prox, with PACS in the first data field and no leading byte.
- MIFARE Classic: MIFARE Classic, with CSN in the first data field and PACS off.
- Not sure: look for a model number on the back of the card, or ask whoever issues them. If that doesn't help, tick every type, see which one reads the card, then untick the others.
- Leave the output as HEX Under Out 1 Data Manipulation, leave the string format as HEX.
- Apply the changes Go to System Config, click Apply Changes, and reboot the reader if it asks.
Check it in Notepad
- Open Notepad Click into a blank document.
- Tap your card The reader should beep and type a value. That's the value the locker will read, and what the demo user's RFID credential needs to be.
- Tap it a few more times You should get the same value each time, and a card from another system shouldn't type anything.
If nothing appears, check the output type is Keyboard Wedge and the changes were applied, then unplug the reader and plug it back in. If it beeps but doesn't type, you're probably working through remote desktop or a virtual machine.
Put the reader back on the locker
- Switch back to locker mode Under Keyboard Wedge > General Config, set the output type to Custom Report. Go to System Config, click Apply Changes and reboot the reader. It won't type into Notepad any more, which is what you want.
- Save the settings (optional) Under System Config > Export, export the settings file and keep a copy. If you send it to us, we can apply it to more readers later.
- Reconnect the reader With the locker powered off, plug the reader back into a USB-A port on the controller (next to the Ethernet port).
- Power on the locker Once it's booted, tap your card. The reader should beep or change colour.
From there, go back to Set up the FUYL Portal.
Troubleshooting
| What you see | What to do |
|---|---|
| The reader's light is off | Power off the locker, check the USB cable at the controller, then power it back on. The reader is only picked up when the locker starts. |
| No beep when you tap your card | Watch the light as you tap. It usually changes from white to blue on a read, so if it changes colour the card is being read and the beep has been turned off in the reader's settings. If it doesn't change, the reader isn't set up for your card type (see If the reader doesn't respond to your card). |
| It beeps, but the test read doesn't pick anything up | Check the reader is in Custom Report mode (not Keyboard Wedge), then restart the locker. |
| The test reads a value, but Database Lookup fails | The demo user's RFID credential doesn't match the value read, or hasn't synced yet. Compare the two character for character, including leading zeros and upper or lower case. |
| The test reads the wrong value, or a different value each time | Another card type is probably turned on in the reader. Turn on only your card's type. |
Note: a beep or colour change only means the reader saw a card it's set up for. It doesn't confirm the locker got the value you expected, so always run a test read.
More help
If you get stuck with the reader or the RFID settings, just raise a ticket and we're happy to help, including live on a call if that's easier.