Adapter - CRT-571-RFID-Dispenser
This page describes version 2.0.6 of the adapter.
Overview
This adapter controls the CRT-571 RFID Dispenser over an Ethernet LAN connection. Adapter communication with the CRT-571 requires Ethernet to serial conversion using either hardware or software.
Configuration Options
Hardware Solution
A hardware device such as the Perle IOLAN DS1 can be used convert TCP to RS-232 serial. The hardware device must be configured to convert Raw TCP packets to and from RS232. The TCP listen port must match the port configured in the adapters configuration. Note: Most hardware solutions do not support SSL/TLS.
Software Solution
A software solution is available from NEC that performs the same conversion as the hardware solution. The software can be installed as a Windows service and configured to use an optional SSL/TLS certificate. As with the hardware solution, the adapters connection port must match the listen port.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| deviceAddress | Controller Service Address | True | The fully qualified domain name (FQDN) or IP-Address for the CRT571 device controller service. | string | 1024 | 1 | |||
| devicePort | Controller Port | True | The TCP port to connect to the CRT-571 device controller service. | integer | 10001 | 65535 | 1 | ||
| crtHardwareAddress | CRT-571 Hardware Address | False | The unit's hardware address as determined by the 4 position dip switch settings on the physical CRT-571 device. (0-15). (Default=0) | integer | 0 | 15 | 0 | ||
| initOption | CRT-571 Initialization Option | False | Sets state of the dispenser if a card is present while initializing. The card will be moved to the following possible positions. ("0"-Holding Position, "1"-Recycle Bin, "3"-Do Nothing) (Default=3) | integer | 3 | 7 | 0 | ||
| serviceSsl | Use TLS (optional) | False | boolean | false | |||||
| serviceSecretKey | Service Secret Key | False | The password for the CRT-571 device controller service. | password | 1024 |
Commands
Read Status (readStatus)
Gets the current status of the CRT-571 device.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
| cardStackerLow | The card stacker is low on cards | string |
| cardStackerEmpty | The card stacker does not have any cards left. Please, add more cards. | string |
| errorBinFull | The card error bin is full and requires maintenance. | string |
| cardAtRFSlot | A card is present at the RFID antenna and is ready to read. | string |
| cardAtHoldingSlot | The card is present at the exit slot and is ready for the user to take. | string |
Move To RF Position (move2RF)
Moves a card and presents it under the RF antenna for reading
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Eject To Front (move2Exit)
Moves card to the exit slot and onto the floor.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Capture To Recycle Bin (move2Recycle)
Moves a card to the recycle or error bin.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Move To Holding Position (move2Holding)
Moves a card to the exit slot's holding position.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Enable Accept (acceptEnable)
Enables the exit slot to accept a card. When card is inserted into exit slot, the card is automatically moved to RF-Slot position.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| timeout | Wait Time (s) | How long to wait for the user to insert a card. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Disable Accept (acceptDisable)
Disables the exit slot from accepting cards.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Read Firmware Revision (firmwareRevision)
Returns the firmware revision for the device.
Response Properties
| Name | Description | Type |
|---|---|---|
| revision | The firmware revision for the device. | string |
| status | Status result of the command. | string |
Read Software Version (softwareVersionDispenser)
Returns the software version information for the dispenser
Response Properties
| Name | Description | Type |
|---|---|---|
| version | The software version information for the dispenser. | string |
| status | The current status result of the command. | string |
Read Recycled Card Count (recycleCountGet)
Returns the recycled card count value.
Response Properties
| Name | Description | Type |
|---|---|---|
| count | The card recycle count value. | string |
| status | The current status result of the command. | string |
Write Recycled Card Count (recycleCountSet)
Sets the recycled card count to an initial value.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| count | Initial Recycle Count | Sets the initial value of card-recycling. (0-999) | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | The current status result of the command. | string |
Read Configuration (deviceConfig)
Returns the dispenser configuration for the CRT-571 device.
Response Properties
| Name | Description | Type |
|---|---|---|
| version | The configuration for the CRT-571 device. | string |
| status | The current status result of the command. | string |
Events
CRT571 Connected (crt571ConnectedEvent)
The connection to CRT-571 RFID Dispenser has been established.
No properties defined
Card Holding Event (cardHoldingEvent)
A card is at the exit slot's holding position.
No properties defined
Card Removed Event (cardRemovedEvent)
A card was removed from the exit slot's holding position.
No properties defined
Card At RF Slot Event (cardReadyEvent)
A card is at the RF slot and is ready to read.
No properties defined
Stacker Low Event (stackerLowEvent)
The card stacker level is low.
No properties defined
Stacker Empty Event (stackerEmptyEvent)
The card stacker is empty.
No properties defined
Malfunction Event (malfunctionEvent)
The CRT-571 dispenser has a mechanical issue or a card is jammed.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| errCode | Error Code | The error code returned by the CRT-571 device. | string |
| errDetail | Error Detail | The detailed error information. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.3 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.4 | Bug fix | Fix dispenser adapter stuck state | NAP-22446 | |
| 2.0.5 | Bug fix & Maintenance | Adapter did not load and trust UIP Trusted CA certificates. Updated third-party components and improved maintainability. |
NAP-23864 NAP-23945 |
2022-12-01 |
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-27635 | 2024-07-31 |