Skip to content

Latest commit

 

History

History
1449 lines (876 loc) · 30.1 KB

events.md

File metadata and controls

1449 lines (876 loc) · 30.1 KB
Raw

Back to Documentation

Events

  1. Jam Recovery
  2. Error During Payout
  3. Smart Emptying
  4. Smart Emptied
  5. Channel Disable
  6. Initialising
  7. Coin Mech Error
  8. Emptying
  9. Emptied
  10. Coin Mech Jammed
  11. Coin Mech Return Pressed
  12. Payout Out Of Service
  13. Note Float Removed
  14. Note Float Attached
  15. Note Transfered To Stacker
  16. Note Paid Into Stacker At Power-up
  17. Note Paid Into Store At Power-up
  18. Note Stacking
  19. Note Dispensed At Power-up
  20. Note Held In Bezel
  21. Device Full
  22. Bar Code Ticket Acknowledge
  23. Dispensed
  24. Jammed
  25. Halted
  26. Floating
  27. Floated
  28. Time Out
  29. Dispensing
  30. Note Stored In Payout
  31. Incomplete Payout
  32. Incomplete Float
  33. Cashbox Paid
  34. Coin Credit
  35. Note Path Open
  36. Note Cleared From Front
  37. Note Cleared To Cashbox
  38. Cashbox Removed
  39. Cashbox Replaced
  40. Bar Code Ticket Validated
  41. Fraud Attempt
  42. Stacker Full
  43. Disabled
  44. Unsafe Note Jam
  45. Safe Note Jam
  46. Note Stacked
  47. Note Rejected
  48. Note Rejecting
  49. Credit Note
  50. Read Note
  51. Ok
  52. Slave Reset
  53. Command Not Known
  54. Wrong No Parameters
  55. Parameter Out Of Range
  56. Command Cannot Be Processed
  57. Software Error
  58. Fail
  59. Key Not Set

JAM_RECOVERY

Code dec Code hex
176 0x76

Devices

SMART Payout

Description

The SMART Payout unit is in the process of recovering from a detected jam. This process will typically move five notes to the cash box; this is done to minimise the possibility the unit will go out of service

Data

This event has no data associated with it

(back to top)

ERROR_DURING_PAYOUT

Code dec Code hex
177 0x77

Devices

SMART Payout

Description

Returned if an error is detected whilst moving a note inside the SMART Payout unit. The cause of error (1 byte) indicates the source of the condition; 0x00 for note not being correctly detected as it is routed to cashbox or for payout, 0x01 if note is jammed in transport. In the case of the incorrect detection, the response to Cashbox Payout Operation Data request would report the note expected to be paid out.

Data

Protocol version < 7

Name Type
error string

Protocol version >= 7

Name Type
value Object[]
value[].value number
value[].country_code string
error string

(back to top)

SMART_EMPTYING

Code dec Code hex
179 0x79

Devices

SMART Payout, SMART Hopper, NV11

Description

The device is in the process of carrying out its Smart Empty command from the host. The value emptied at the poll point is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

SMART_EMPTIED

Code dec Code hex
180 0x80

Devices

SMART Payout, SMART Hopper, NV11

Description

The device has completed its Smart Empty command. The total amount emptied is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

CHANNEL_DISABLE

Code dec Code hex
181 0x81

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

The device has had all its note channels inhibited and has become disabled for note insertion.

Data

This event has no data associated with it

(back to top)

INITIALISING

Code dec Code hex
182 0x82

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11, SMART Hopper

Description

This event is given only when using the Poll with ACK command. It is given when the BNV is powered up and setting its sensors and mechanisms to be ready for Note acceptance. When the event response does not contain this event, the BNV is ready to be enabled and used.

Data

This event has no data associated with it

(back to top)

COIN_MECH_ERROR

Code dec Code hex
183 0x83

Devices

SMART Hopper

Description

The attached coin mechanism has generated an error. Its code is given in the event data.

Data

This event has no data associated with it

(back to top)

EMPTYING

Code dec Code hex
194 0x94

Devices

SMART Payout, SMART Hopper, NV11

Description

The device is in the process of emptying its content to the system cashbox in response to an Empty command.

Data

This event has no data associated with it

(back to top)

EMPTIED

Code dec Code hex
195 0x95

Devices

SMART Payout, SMART Hopper, NV11

Description

The device has completed its Empty process in response to an Empty command from the host.

Data

This event has no data associated with it

(back to top)

COIN_MECH_JAMMED

Code dec Code hex
196 0x96

Devices

SMART Hopper

Description

The attached coin mechanism has been detected as having a jam.

Data

This event has no data associated with it

(back to top)

COIN_MECH_RETURN_PRESSED

Code dec Code hex
197 0x97

Devices

SMART Hopper

Description

The attached coin mechanism has been detected as having is reject or return button pressed.

Data

This event has no data associated with it

(back to top)

PAYOUT_OUT_OF_SERVICE

Code dec Code hex
198 0x98

Devices

SMART Payout, NV11

Description

This event is given if the payout goes out of service during operation. If this event is detected after a poll, the host can send the ENABLE PAYOUT DEVICE command to determine if the payout unit comes back into service.

Data

This event has no data associated with it

(back to top)

NOTE_FLOAT_REMOVED

Code dec Code hex
199 0x99

Devices

NV11

Description

Reported when a note float unit has been detected as removed from its validator.

Data

This event has no data associated with it

(back to top)

NOTE_FLOAT_ATTACHED

Code dec Code hex
200 0x00

Devices

NV11

Description

Reported when a note float unit has been detected as removed from its validator.

Data

This event has no data associated with it

(back to top)

NOTE_TRANSFERED_TO_STACKER

Code dec Code hex
201 0x01

Devices

SMART Payout, NV11

Description

Reported when a note has been successfully moved from the payout store into the stacker cashbox.

Data

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

NOTE_PAID_INTO_STACKER_AT_POWER-UP

Code dec Code hex
202 0x02

Devices

SMART Payout, NV11

Description

Reported when a note has been detected as paid into the cashbox stacker as part of the power-up procedure.

Data

Protocol version >= 8

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

NOTE_PAID_INTO_STORE_AT_POWER-UP

Code dec Code hex
203 0x03

Devices

SMART Payout, NV11

Description

Reported when a note has been detected as paid into the payout store as part of the power-up procedure.

Data

Protocol version >= 8

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

NOTE_STACKING

Code dec Code hex
204 0x04

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

The note is being moved from the escrow position to the host exit section of the device.

Data

This event has no data associated with it

(back to top)

NOTE_DISPENSED_AT_POWER-UP

Code dec Code hex
205 0x05

Devices

NV11

Description

Reported when a note has been dispensed as part of the power-up procedure.

Data

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

NOTE_HELD_IN_BEZEL

Code dec Code hex
206 0x06

Devices

SMART Payout, NV11

Description

Reported when a dispensing note is held in the bezel of the payout device.

Data

Protocol version >= 8

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

DEVICE_FULL

Code dec Code hex
207 0x07

Devices

NV11

Description

This event is reported when the Note Float has reached its limit of stored notes. This event will be reported until a note is paid out or stacked.

Data

This event has no data associated with it

(back to top)

BAR_CODE_TICKET_ACKNOWLEDGE

Code dec Code hex
209 0x09

Devices

NV200, NV201

Description

The bar code ticket has been passed to a safe point in the device stacker.

Data

This event has no data associated with it

(back to top)

DISPENSED

Code dec Code hex
210 0x10

Devices

SMART Payout, SMART Hopper, NV11

Description

The device has completed its pay-out request. The final value paid is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

JAMMED

Code dec Code hex
213 0x13

Devices

SMART Payout, SMART Hopper, NV11

Description

The device has detected that coins are jammed in its mechanism and cannot be removed other than by manual intervention. The value paid at the jam point is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

HALTED

Code dec Code hex
214 0x14

Devices

SMART Payout, SMART Hopper, NV11

Description

This event is given when the host has requested a halt to the device. The value paid at the point of halting is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

FLOATING

Code dec Code hex
215 0x15

Devices

SMART Payout, SMART Hopper

Description

The device is in the process of executing a float command and the value paid to the cashbox at the poll time is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

FLOATED

Code dec Code hex
216 0x16

Devices

SMART Payout, SMART Hopper

Description

The device has completed its float command and the final value floated to the cashbox is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

TIME_OUT

Code dec Code hex
217 0x17

Devices

SMART Payout, SMART Hopper, NV11

Description

The device has been unable to complete a request. The value paid up until the time-out point is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

DISPENSING

Code dec Code hex
218 0x18

Devices

SMART Payout, SMART Hopper, NV11

Description

The device is in the process of paying out a requested value. The value paid at the poll is given in the vent data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

NOTE_STORED_IN_PAYOUT

Code dec Code hex
219 0x19

Devices

SMART Payout, NV11

Description

The note has been passed into the note store of the payout unit.

Data

This event has no data associated with it

(back to top)

INCOMPLETE_PAYOUT

Code dec Code hex
220 0x20

Devices

SMART Payout, SMART Hopper, NV11

Description

The device has detected a discrepancy on power-up that the last payout request was interrupted (possibly due to a power failure). The amounts of the value paid and requested are given in the event data.

Data

Protocol version < 6

Name Type
actual number
requested number

Protocol version >= 6

Name Type
value Object[]
value[].actual number
value[].requested number
value[].country_code string

(back to top)

INCOMPLETE_FLOAT

Code dec Code hex
221 0x21

Devices

SMART Payout, SMART Hopper, NV11

Description

The device has detected a discrepancy on power-up that the last float request was interrupted (possibly due to a power failure). The amounts of the value paid and requested are given in the event data.

Data

Protocol version < 6

Name Type
actual number
requested number

Protocol version >= 6

Name Type
value Object[]
value[].actual number
value[].requested number
value[].country_code string

(back to top)

CASHBOX_PAID

Code dec Code hex
222 0x22

Devices

SMART Hopper

Description

This is given at the end of a payout cycle. It shows the value of stored coins that were routed to the cashbox that were paid into the cashbox during the payout cycle.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

COIN_CREDIT

Code dec Code hex
223 0x23

Devices

SMART Hopper

Description

A coin has been detected as added to the system via the attached coin mechanism. The value of the coin detected is given in the event data.

Data

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

NOTE_PATH_OPEN

Code dec Code hex
224 0x24

Devices

NV200

Description

The device has detected that its note transport path has been opened.

Data

This event has no data associated with it

(back to top)

NOTE_CLEARED_FROM_FRONT

Code dec Code hex
225 0x25

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

At power-up, a note was detected as being rejected out of the front of the device. The channel value, if known is given in the data byte.

Data

All

Name Type
channel number

(back to top)

NOTE_CLEARED_TO_CASHBOX

Code dec Code hex
226 0x26

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

At power up, a note was detected as being moved into the stacker unit or host exit of the device. The channel number of the note is given in the data byte if known.

Data

All

Name Type
channel number

(back to top)

CASHBOX_REMOVED

Code dec Code hex
227 0x27

Devices

BV50, BV100, NV200, SMART Payout, NV11

Description

A device with a detectable cashbox has detected that it has been removed.

Data

This event has no data associated with it

(back to top)

CASHBOX_REPLACED

Code dec Code hex
228 0x28

Devices

BV50, BV100, NV200, SMART Payout, NV11

Description

A device with a detectable cashbox has detected that it has been replaced.

Data

This event has no data associated with it

(back to top)

BAR_CODE_TICKET_VALIDATED

Code dec Code hex
229 0x29

Devices

NV200, NV201

Description

A validated barcode ticket has been scanned and is available at the escrow point of the device.

Data

This event has no data associated with it

(back to top)

FRAUD_ATTEMPT

Code dec Code hex
230 0x30

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11, SMART Hopper

Description

The device has detected an attempt to tamper with the normal validation/stacking/payout process.

Data

Banknote validators

Name Type
channel number

Protocol version < 6

Name Type
value number

Protocol version >= 6

Name Type
value Object[]
value[].value number
value[].country_code string

(back to top)

STACKER_FULL

Code dec Code hex
231 0x31

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

The banknote stacker unit attached to this device has been detected as at its full limit

Data

This event has no data associated with it

(back to top)

DISABLED

Code dec Code hex
232 0x32

Devices

All

Description

The device is not active and unavailable for normal validation functions.

Data

This event has no data associated with it

(back to top)

UNSAFE_NOTE_JAM

Code dec Code hex
233 0x33

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

The note is stuck in a position where the user could possibly remove it from the front of the device.

Data

This event has no data associated with it

(back to top)

SAFE_NOTE_JAM

Code dec Code hex
234 0x34

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

The note is stuck in a position not retrievable from the front of the device (user side)

Data

This event has no data associated with it

(back to top)

NOTE_STACKED

Code dec Code hex
235 0x35

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

The note has exited the device on the host side or has been placed within its note stacker.

Data

This event has no data associated with it

(back to top)

NOTE_REJECTED

Code dec Code hex
236 0x36

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

The note has been rejected from the validator and is available for the user to retrieve.

Data

This event has no data associated with it

(back to top)

NOTE_REJECTING

Code dec Code hex
237 0x37

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

The note is in the process of being rejected from the validator

Data

This event has no data associated with it

(back to top)

CREDIT_NOTE

Code dec Code hex
238 0x38

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

A note has passed through the device, past the point of possible recovery and the host can safely issue its credit amount. The byte value is the channel number of the note to credit.

Data

All

Name Type
channel number

(back to top)

READ_NOTE

Code dec Code hex
239 0x39

Devices

BV20, BV50, BV100, NV9USB, NV10USB, NV200, SMART Payout, NV11

Description

A note is in the process of being scanned by the device (byte value 0) or a valid note has been scanned and is in escrow (byte value gives the channel number)

Data

All

Name Type
channel number

(back to top)

OK

Code dec Code hex
240 0x40

Description

Returned when a command from the host is understood and has been, or is in the process of, being executed.

Data

This event has no data associated with it

(back to top)

SLAVE_RESET

Code dec Code hex
241 0x41

Devices

All

Description

The device has undergone a power reset.

Data

This event has no data associated with it

(back to top)

COMMAND_NOT_KNOWN

Code dec Code hex
242 0x42

Description

Returned when an invalid command is received by a peripheral.

Data

This event has no data associated with it

(back to top)

WRONG_NO_PARAMETERS

Code dec Code hex
243 0x43

Description

A command was received by a peripheral, but an incorrect number of parameters were received.

Data

This event has no data associated with it

(back to top)

PARAMETER_OUT_OF_RANGE

Code dec Code hex
244 0x44

Description

One of the parameters sent with a command is out of range.

Data

This event has no data associated with it

(back to top)

COMMAND_CANNOT_BE_PROCESSED

Code dec Code hex
245 0x45

Description

A command sent could not be processed at that time. E.g. sending a dispense command before the last dispense operation has completed.

Data

This event has no data associated with it

(back to top)

SOFTWARE_ERROR

Code dec Code hex
246 0x46

Description

Reported for errors in the execution of software e.g. Divide by zero. This may also be reported if there is a problem resulting from a failed remote firmware upgrade, in this case the firmware upgrade should be redone.

Data

This event has no data associated with it

(back to top)

FAIL

Code dec Code hex
248 0x48

Description

Command failure

Data

This event has no data associated with it

(back to top)

KEY_NOT_SET

Code dec Code hex
250 0x50

Description

The slave is in encrypted communication mode but the encryption keys have not been negotiated.

Data

This event has no data associated with it

(back to top)