Adapter - CRT Dispenser
This page describes version 2.0.1 of the adapter.
Overview
This adapter controls a CRT dispenser device using the Kiosk Router.
The card dispenser device is connected to a serial port on the Kiosk Client. 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.
Supported Dispensers
The following dispenser models are supported:
- CRT 571-M
- CRT 591-Y
The model of the device is specified in the adapter properties under "model".
- m = the device is a CRT 571-M
- y = the device is a CRT 591-Y
NOTE: The CRT hardware address is only used when the device is a CRT 571-M.
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 | |||||
| model | CRT Dispenser Model | False | m=CRT571-M y=CRT591-Y (Default: m) | string | 4 | ||||
| crtHardwareAddress | CRT Hardware Address | False | The unit's hardware address as determined by the 4 position dip switch settings on the physical CRT device. (0-15). (Default=0) | integer | 0 | 15 | 0 | ||
| initOption | Dispenser 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 |
Commands
Read Status (readStatus)
Gets the current status of the dispenser 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 |
| cardStackerFull | The card stacker is full. | 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 |
| cardAtIC | A card is present at IC. | 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 |
Move To IC Position (move2IC)
Move the card to IC card operation position
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status result of the command. | string |
Move To Card Hopper (move2Hopper)
Move the card to the card hopper
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 configuration for the dispenser device.
Response Properties
| Name | Description | Type |
|---|---|---|
| version | The configuration for the dispenser device. | string |
| status | The current status result of the command. | string |
Events
Connected (connectedEvent)
The connection to the dispenser device 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 dispenser device has a mechanical issue or a card is jammed.
Event Properties
| Name | Display | Description | Type |
|---|---|---|---|
| errCode | Error Code | The error code returned by the dispenser 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. | 2023-01-31 |