Adapter - DE5240-RFID-Dispenser
This page describes version 2.0.7 of the adapter.
Overview
This adapter controls the DE5240-RFID-Dispenser device using the Kiosk Router. Adapter remote communication with the DE5240 requires an Ethernet to Serial converter device such as the Perle IOLAN DS1 or a remote serial port software service provided by NEC, like Serial2TCP. The remote software service has the option to use certificates. The Serial2TCP Windows service must be configured to connect to the Kiosk Router and to communicate with the serial port the dispenser is connected to.
Connection Information
The adapter connects to Kiosk Router using information specified in the adapter properties.
- The URL to the Kiosk Server such as https://kioskserver:8080.
- The Kiosk position name the device is connected to.
- The router token specified in Serial2TCP on the device.
- The client certificate and private key for the adapter to connect.
- This is available in Kiosk Admin under UIP Adapter Connection in Connection Settings.
The Kiosk position name and router token together make a unique key to match the adapter and Serial2TCP running on the client.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| routerUrl | Kiosk Server URL | True | The URL to connect to the Kiosk Server (e.g https://address:8080). | string | 1024 | 1 | |||
| kioskPosition | Kiosk Position | True | The name of the kiosk position the device is on. | string | 128 | 1 | |||
| routerToken | Router Token | True | The token defined on the device side. | string | 128 | 1 | |||
| clientCertificate | Client Certificate | True | The adapter client certificate (PEM format). | string | |||||
| clientPrivateKey | Client Private Key | True | The private key for the adapter client certificate (PEM format). | string |
Commands
Get Status (getStatus)
Gets the current status of the device.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
| hopperloLow | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | The card is present at the bezel ready for the user to take. | string |
| error | The card device has encountered and error. | string |
| mechanicalProblem | The card device has a mechanical issue or a card is jammed. | string |
Dispense Card (dispenseCard)
Dispenses a card and presents it under the antenna for reading
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
| hopperLevelLow | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | The card is present at the bezel ready for the user to take. | string |
| error | The card device has encountered and error. | string |
| mechanicalProblem | The card device has a mechanical issue or a card is jammed. | string |
Transfer Card To Bezel (transfer2Bezel)
Transfers the card to the bezel.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
| hopperLevelLow | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | The card is present at the bezel ready for the user to take. | string |
| error | The card device has encountered and error. | string |
| mechanicalProblem | The card device has a mechanical issue or a card is jammed. | string |
Internal Card Capture (captureCard)
The device captures the ejected card underneath.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
| hopperLevelLow | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | The card is present at the bezel ready for the user to take. | string |
| error | The card device has encountered and error. | string |
| mechanicalProblem | The card device has a mechanical issue or a card is jammed. | string |
Accept Card (acceptCard)
Accepts a presented card from the exterior bezel and carries it under the antenna.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| timeout | Wait Time (s) | How long to wait for the user to insert a card into the bezel. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
| hopperLevelLow | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | The card is present at the bezel ready for the user to take. | string |
| error | The card device has encountered and error. | string |
| mechanicalProblem | The card device has a mechanical issue or a card is jammed. | string |
Cancel Accept (cancelAccept)
clear any accept a card pending command
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Clean Rollers (cleanRollers)
Cleans the rollers on the device. (see documentation for procedure)
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
| hopperLevelLow | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | The card is present at the bezel ready for the user to take. | string |
| error | The card device has encountered and error. | string |
| mechanicalProblem | The card device has a mechanical issue or a card is jammed. | string |
LED On (ledOn)
Turns the green LED on.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
LED Off (ledOff)
Turns the green LED off.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Firmware Version (firmwareVersion)
Return the firmware version for the device.
Response Properties
| Name | Description | Type |
|---|---|---|
| version | The firmware version for the device. | string |
| status | Status result of the command. | string |
Events
DE5240 Connected (de5240Connected)
The connection to DE5240 RFID Dispenser has been established.
No properties defined
Card Accept Response (cardAcceptEvent)
A card accept command response event that contains the state of the card.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| hopperLevelLow | Hopper Level Low | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | Card Present Under RFID Antenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | Card Present At Bezel | The card is present at the bezel ready for the user to take. | string |
| error | Error | The card device has encountered and error. | string |
| mechanicalProblem | Mechanical Problem | The card device has a mechanical issue or a card is jammed. | string |
Card Hopper Level Low (cardHopperLevelLowEvent)
The card hopper has less than 25 cards left.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| hopperLevelLow | Hopper Level Low | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | Card Present Under RFID Antenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | Card Present At Bezel | The card is present at the bezel ready for the user to take. | string |
| error | Error | The card device has encountered and error. | string |
| mechanicalProblem | Mechanical Problem | The card device has a mechanical issue or a card is jammed. | string |
Mechanical Problem (mechanicalProblemEvent)
The card device has a mechanical issue or is jammed.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| hopperLevelLow | Hopper Level Low | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | Card Present Under RFID Antenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | Card Present At Bezel | The card is present at the bezel ready for the user to take. | string |
| error | Error | The card device has encountered and error. | string |
| mechanicalProblem | Mechanical Problem | The card device has a mechanical issue or a card is jammed. | string |
Card Removed From Bezel (cardRemovedFromBezelEvent)
A card was removed from the bezel.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| hopperLevelLow | Hopper Level Low | The card hopper has less than 25 cards left. | string |
| cardPresentUnderRFIDAntenna | Card Present Under RFID Antenna | The card is present under the RFID antenna and is ready to be read. | string |
| cardPresentAtBezel | Card Present At Bezel | The card is present at the bezel ready for the user to take. | string |
| error | Error | The card device has encountered and error. | string |
| mechanicalProblem | Mechanical Problem | The card device has a mechanical issue or a card is jammed. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.5 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |
| 2.0.7 | New feature | Use Kiosk Router | KSK-12165 | 2023-01-31 |