You are on page 1of 272

INNOVATIVETECHNOLOGYLTD

ProtocolManual

SSP

NV9USB,NV10USB,NV11,SMARTHOPPER,
NV200,SMARTPAYOUT,BV20,BV50,
BV100,SMARTSYSTEM,SMARTTICKET,
COUPONPRINTER,NV150,FLATBED
PRINTER,NV12

versionGA138_2_2_222A
SSPProtocolManualGA138_2_2_222A

Contents

Descriptions
Introduction ........
GeneralDescription ........
Hardwarelayer ........
TransportLayer ........
EncryptionLayer ........
EncryptionKeys ........
GenericCommandsandResponses ........
ProtocolVersions ........
BanknoteValidator ........
RejectCodes ........
SMARTTicket ........
SMARTHopper ........
CouponPrinter ........
SMARTPayout ........
SmartSystem ........
NoteFloat(NV11) ........
TEBS ........
NVR280(NV12) ........
FlatbedPrinter(FBF166) ........
Command/EventTables
NV9USBCommandTable ........
NV9USBEventTable ........
NV10USBCommandTable ........
NV10USBEventTable ........
NV11CommandTable ........
NV11EventTable ........
SMARTHOPPERCommandTable ........
SMARTHOPPEREventTable ........
NV200CommandTable ........
NV200EventTable ........
SMARTPAYOUTCommandTable ........
SMARTPAYOUTEventTable ........
BV20CommandTable ........
BV20EventTable ........
BV50CommandTable ........
BV50EventTable ........
BV100CommandTable ........
BV100EventTable ........
SMARTSYSTEMCommandTable ........
SMARTSYSTEMEventTable ........
SMARTTICKETCommandTable ........
SMARTTICKETEventTable ........
COUPONPRINTERCommandTable ........
COUPONPRINTEREventTable ........
NV150CommandTable ........
NV150EventTable ........
FLATBEDPRINTERCommandTable ........
FLATBEDPRINTEREventTable ........
NV12CommandTable ........
NV12EventTable ........
Commands
Sync ........
Reset ........
HostProtocolVersion ........
Poll ........
GetSerialNumber ........
Disable ........
Enable ........
GetFirmwareVersion ........
GetDatasetVersion ........
SetInhibits ........
DisplayOn ........
DisplayOff ........
SetupRequest ........
Reject ........
UintData ........
ChannelValueData ........
ChannelSecurityData ........
ChannelReteachData ........
LastRejectCode ........
Hold ........
GetBarcodeReaderConfiguration ........
SetBarcodeReaderConfiguration ........
GetBarcodeInhibit ........
SetBarcodeInhibit ........
GetBarcodeData ........
ConfigureBezel ........
PollWithAck ........
EventAck ........
SetDenominationRoute ........
GetDenominationRoute ........
PayoutAmount ........
GetDenominationLevel ........
SetDenominationLevel ........
HaltPayout ........
FloatAmount ........
GetMinPayout ........
SetCoinMechInhibits ........
PayoutByDenomination ........
FloatByDenomination ........
EmptyAll ........
SetOptions ........
GetOptions ........
CoinMechGlobalInhibit ........
SmartEmpty ........
CashboxPayoutOperationData ........
GetAllLevels ........
GetCounters ........
ResetCounters ........
SetRefillMode ........
GetNotePositions ........
PayoutNote ........
StackNote ........
SetValueReportType ........
SetGenerator ........
SetModulus ........
RequestKeyExchange ........
CoinMechOptions ........
GetBuildRevision ........
EnablePayoutDevice ........
DisablePayoutDevice ........
CommsPassThrough ........
SetBaudRate ........
SspSetEncryptionKey ........
SspEncryptionResetToDefault ........
GetRealTimeClockConfiguration ........
SetRealTimeClock ........
GetRealTimeClock ........
SetCashboxPayoutLimit ........
EnableTitoEvents ........
CoinStir ........
TicketPrint ........
AddStaticText ........
AddPlaceHolderText ........
AddStaticBarcode ........
GetImageSize ........
GetBarcodeSize ........
GetTicketResolution ........
GetFontInformation ........
GetQrCodeDimensions ........
PrintTicket ........
PrintBlankTicket ........
GetTextSize ........
SetQrPlaceholder ........
AddQrCode ........
AddQrPlaceholder ........
ClearOnTheFlyBuffer ........
SetPlaceholder ........
ClearTemplate ........
AddPlaceholderBarcode ........
AddImage ........
GetTicketSize ........
GetFreeStorage ........
CheckForTemplate ........
GetPresentTemplates ........
GetPresentFonts ........
GetPresentImages ........
GetTemplateInfo ........
GetTemplateItemInfo ........
GetImageFileChecksum ........
GetTicketBounds ........
GetPixelDensity ........
PrinterConfiguration ........
SetTicketMode ........
SetTicketWidth ........
SetTicketHeight ........
SetPrintingQuality ........
EnableReverseValidation ........
DisableReverseValidation ........
EnableReverseValidation ........
DisableReverseValidation ........
DeleteFile ........
DeleteFileGroup ........
SetPaperSavingMode ........
SetBezelType ........
SetPrintingQuality ........
CancelEscrowTransaction ........
CommitEscrowTransaction ........
ReadEscrowValue ........
GetEscrowSize ........
SetEscrowSize ........
PayoutAmountByDenomination ........
Events
SlaveReset ........
Read ........
NoteCredit ........
Rejecting ........
Rejected ........
Stacking ........
Stacked ........
SafeJam ........
UnsafeJam ........
Disabled ........
FraudAttempt ........
StackerFull ........
NoteClearedFromFront ........
NoteClearedIntoCashbox ........
CashboxRemoved ........
CashboxReplaced ........
BarcodeTicketValidated ........
BarcodeTicketAck ........
NotePathOpen ........
ChannelDisable ........
Initialising ........
Dispensing ........
Dispensed ........
CoinsLow ........
HopperJammed ........
Halted ........
Floating ........
Floated ........
Timeout ........
IncompletePayout ........
IncompleteFloat ........
CashboxPaid ........
CoinCredit ........
CoinMechJammed ........
CoinMechReturnActive ........
Emptying ........
Emptied ........
SmartEmptying ........
SmartEmptied ........
CalibrationFailed ........
NoteStoredInPayout ........
PayoutOutOfService ........
JamRecovery ........
ErrorDuringPayout ........
NoteTransferedToStacker ........
NoteHeldInBezel ........
NoteIntoStoreAtReset ........
NoteIntoStackerAtReset ........
NoteDispensedAtReset ........
NoteFloatRemoved ........
NoteFloatAttached ........
DeviceFull ........
CoinMechError ........
AttachedCoinMechDisabled ........
AttachedCoinMechEnabled ........
ValueAdded ........
TicketsLow ........
TicketsReplaced ........
PrinterHeadRemoved ........
TicketPathOpen ........
TicketJam ........
TicketPrinting ........
TicketPrinted ........
TicketPrintingError ........
PrinterHeadReplaced ........
TicketPathClosed ........
NoPaper ........
PrintHalted ........
TicketInBezel ........
PaperReplaced ........
PrintedToCashbox ........
PayinActive ........
TicketInBezelAtStartup ........
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Introduction

ThismanualdescribestheoperationoftheSmileySecureProtocolSSP.

ITLrecommendthatyoustudythismanualastherearemanynewfeaturespermittingnewusesandmore
secureapplications.
IfyoudonotunderstandanypartofthismanualpleasecontacttheITLforassistance.Inthiswaywemay
continuetoimproveourproduct.
Alternativelyvisitourwebsiteatwww.innovativetechnology.co.uk

EnhancementsofSSPcanberequestedbycontacting:
support@innovativetechnology.co.uk

MAINHEADQUARTERS
InnovativeTechnologyLtd
DerkerStreet,Oldham,England.OL14EQ

Tel:+441616269999Fax:+441616202090
Email:support@innovativetechnology.co.uk

Website:www.innovativetechnology.co.uk

SmileyandtheITLLogoareinternationalregisteredtrademarksandtheyarethepropertyof
InnovativeTechnologyLimited.
InnovativeTechnologyhasanumberofEuropeanandInternationalPatentsandPatentsPendingprotecting
thisproduct.IfyourequirefurtherdetailspleasecontactITL.

InnovativeTechnologyisnotresponsibleforanyloss,harm,ordamagecausedbytheinstallation
anduseofthisproduct.

Thisdoesnotaffectyourlocalstatutoryrights.

Ifindoubtpleasecontactinnovativetechnologyfordetailsofanychanges.

SSPProtocolManualGA138_2_2_222A

<<backtoindex

GeneralDescription

SmileySecureProtocol(SSP)isasecureinterfacespecificallydesignedbyITLtoaddresstheproblems
experiencedbycashhandlingsystemsingamingmachines.Problemssuchasacceptorswapping,
reprogrammingacceptorsandlinetappingarealladdressed.

Theinterfaceusesamasterslavemodel,thehostmachineisthemasterandtheperipherals(noteacceptor,
coinacceptororcoinhopper)aretheslaves.

Datatransferisoveramultidropbususingclockasynchronousserialtransmissionwithsimpleopencollector
drivers.Theintegrityofdatatransfersisensuredthroughtheuseof16bitCRCchecksumsonallpackets.

EachSSPdeviceofaparticulartypehasauniqueserialnumberthisnumberisusedtovalidateeachdevice
inthedirectionofcredittransferbeforetransactionscantakeplace.Itisrecommendedthattheencryption
systembeusedtopreventfraudthroughbusmonitoringandtapping.Thisiscompulsoryforallpayout
devices.

Commandsarecurrentlyprovidedforcoinacceptors,noteacceptorsandcoinhoppers.Allcurrentfeaturesof
thesedevicesaresupported.

FEATURES:

SerialcontrolofNote/CoinValidatorsandHoppers
4wire(Tx,Rx,+V,Gnd)system
Opencollectordriver,similartoRS232
HighSpeed9600BaudRate
16bitCRCerrorchecking
DataTransferMode
Encryptionkeynegotiation
128BitAESEncryptedMode

BENEFITS:

Proveninthefield
Simpleandlowcostinterfacingoftransactionperipherals.
Highsecuritycontrolofpayoutperipherals.
Defenceagainstsurrogatevalidatorfraud.
Straightforwardintegrationintohostmachines.
Remoteprogrammingoftransactionperipherals
Openstandardforuniversaluse.

TohelpinthesoftwareimplementationoftheSSP,ITLcanprovide,C/C++Code,C#.NetCode,DLLcontrols
availableonrequest.Pleasecontact:support@innovativetechnology.co.uk
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Hardwarelayer

Communicationisbycharactertransmissionbasedonstandard8bitasynchronousdatatransfer.

OnlyfourwiresarerequiredTxD,RxD,+Vandground.Thetransmitlineofthehostisopencollector,the
receivelineofeachperipheralhasa10Kohmpullupto5volts.Thetransmitoutputofeachslaveisopen
collector,thereceiveinputofthehosthasasingle3k3ohmpullupto5volts.

Thedataformatisasfollows:

Encoding NRZ
BaudRate 9600
Duplex Full
Startbits 1
DataBits 8
Parity none
Stopbits 2

Caution:Powertoperipheraldeviceswouldnormallybeviatheserialbus.Howeverdevicesthat
requireahighcurrentsupplyinexcessof1.5Amps,e.g.hoppers,wouldbeexpectedtobe
suppliedviaaseparateconnector.
SSPProtocolManualGA138_2_2_222A

<<backtoindex

TransportLayer

Dataandcommandsaretransportedbetweenthehostandtheslave(s)usingapacketformatasshown
below:

STX SEQ/SLAVEID LENGTH DATA CRCL CRCH

STX Singlebyteindicatingthestartofamessage0x7Fhex
SEQ/
Bit7isthesequenceflagofthepacket,bits60representtheaddressoftheslavethe
Slave
packetisintendedfor,thehighestallowableslaveIDis0x7D
ID
ThelengthofthedataincludedinthepacketthisdoesnotincludeSTX,theCRCorthe
LENGTH
slaveID
DATA Commandsanddatatobetransferred
LowandhighbyteofaforwardCRC16algorithmusingthePolynomial(X16+X15+X2
CRCL, +1)calculatedonallbytes,exceptSTX.Itisinitialisedusingtheseed0xFFFF.TheCRC
CRCH is
calculatedbeforebytestuffing.

PACKETSEQUENCING

BytestuffingisusedtoencodeanySTXbytesthatareincludedinthedatatobetransmitted.If0x7F(STX)
appearsinthedatatobetransmittedthenitshouldbereplacedby0x7F,0x7F.
BytestuffingisdoneaftertheCRCiscalculated,theCRCitsselfcanbebytestuffed.Themaximumlengthof
datais0xFFbytes.
Thesequenceflagisusedtoallowtheslavetodeterminewhetherapacketisaretransmissionduetoitslast
replybeinglost.Eachtimethemastersendsanewpackettoaslaveitalternatesthesequenceflag.Ifaslave
receivesapacketwiththesamesequenceflagasthelastone,itdoesnotexecutethecommandbutsimply
repeatsit'slastreply.Inareplypackettheaddressandsequenceflagmatchthecommand
packet.
Thisensuresthatnootherslavesinterpretthereplyasacommandandinformsthemasterthatthecorrect
slavereplied.Afterthemasterhassentacommandtooneoftheslaves,itwillwaitfor1secondforareply.
Afterthat,itwillassumetheslavedidnotreceivethecommandintactsoitwillretransmititwiththesame
sequenceflag.Thehostshouldalsorecordthefactthatagapintransmissionhasoccurredandprepareto
polltheslaveforitsserialnumberidentityfollowingthecurrentmessage.Inthisway,thereplacementofthe
hostsvalidatorbyafraudulentunitcanbedetected.
Thefrequencyofpollingshouldbeselectedtominimisethepossibilityofswappingavalidatorbetweenpolls.
Iftheslavehasnotreceivedtheoriginaltransmission,itwillseetheretransmissionasanewcommandsoit
willexecuteitandreply.Iftheslavehadseentheoriginalcommandbutitsreplyhadbeencorruptedthen
theslavewillignorethecommandbutrepeatitsreply.Aftertwentyretries,themasterwillassumethatthe
slavehascrashed.Aslavehasnotimeoutorretrylimit.Ifitreceivesalonesyncbytepartwaythrough
receivingapacketitwilldiscardthepacketreceivedsofarandtreatthenextbyteasanaddressbyte.
SSPProtocolManualGA138_2_2_222A

<<backtoindex

EncryptionLayer

PACKETFORMAT
Encryptionismandatoryforallpayoutdevicesandoptionalforpayindevices.Encrypteddataandcommands
aretransportedbetweenthehostandtheslave(s)usingthetransportmechanismdescribedabove,the
encryptedinformationisstoredinthedatafieldintheformatshownbelow:

STX SEQ/SLAVEID LENGTH DATA CRCL CRCH

DATA

STEX EncryptedData

EncryptedData

eLENGTH eCOUNT eDATA ePACKING eCRCL eCRCH

STEX Singlebyteindicatingthestartofanencrypteddatablock0x7E
ThelengthofthedataincludedinthepacketthisdoesnotincludeSTEX,COUNT,
eLENGTH the
packingortheCRC
Afourbyteunsignedinteger.Thisisasequencecountofencryptedpackets,itis
incrementedeachtimeapacketisencryptedandsent,andeachtimeanencrypted
eCOUNT
packet
isreceivedanddecrypted.
eDATA Commandsordatatobetransferred
Randomdatatomakethelengthofthelength+count+data+packing+CRCL+
ePACKING CRCH
tobeamultipleof16bytes
LowandhighbyteofaforwardCRC16algorithmusingthepolynomial(X16+X15
eCRCL/eCRCH +X2
+1)calculatedonallbytesexceptSTEX.Itisinitialisedusingtheseed0xFFFF

Afterpowerupandresettheslavewillstaydisabledandwillrespondtoallcommandswiththegeneric
responseKEY_NOT_SET(0xFA),withoutexecutingthecommand,untilthekeyhasbeennegotiated.There
aretwoclassesofcommandandresponse,generalcommandsandcommandsinvolvedincredittransfer.

Generalcommandsmaybesentwithorwithoutusingtheencryptionlayer.Theslavewillreplyusingthe
samemethod,unlesstheresponsecontainscreditinformation,inthiscasethereplywillalwaysbeencrypted.
Credit
transfercommands,ahopperpayoutforexample,willonlybeacceptedbytheslaveifreceivedencrypted.
Commandsthatmustbeencryptedonanencryptionenabledproductareindicatedonthecommand
descriptionsforeachcommand.TheSTEXbyteisusedtodeterminethepackettype.Ideallyall
communicationswillbeencrypted.

AfterthedatahasbeendecryptedtheCRCalgorithmisperformedonallbytesincludingtheCRC.Theresult
ofthiscalculationwillbezeroifthedatahasbeendecryptedwiththecorrectkey.Iftheresultofthis
calculationisnonzerothentheperipheralshouldassumethatthehostdidnotencryptthedata(transmission
errorsaredetectedbythetransportlayer).Theslaveshouldgooutofserviceuntilitis
reset.

Thepacketsaresequencedusingthesequencecountthisisresetto0afterapowercycleandeachtimethe
encryptionkeysaresuccessfullynegotiated.Thecountisincrementedbythehostandslaveeachtimethey
successfullyencryptandtransmita
packet.AfterapacketissuccessfullydecryptedtheCOUNTinthepacketshouldbecomparedwiththe
internalCOUNT,iftheydonotmatchthenthepacketisdiscarded.

SSPProtocolManualGA138_2_2_222A

<<backtoindex

EncryptionKeys

Theencryptionkeylengthis128bits.Howeverthisisdividedintotwoparts.Thelower64bitsarefixedand
specifiedbythemachinemanufacturer,thisallowsthemanufacturercontrolwhichdevicesareusedintheir
machines.
Thehigher64bitsaresecurelynegotiatedbytheslaveandhostatpowerup,thisensureseachmachineand
eachsessionareusingdifferentkeys.ThekeyisnegotiatedbytheDiffieHellmankeyexchangemethod.
See:en.wikipedia.org/wiki/DiffieHellman

Theexchangemethodissummarisedinthetablebelow.Ccodefortheexchangealgorithmisavailablefrom
ITL.

Step Host Slave


1 GenerateprimenumberGENERATOR
UsecommandSetGeneratortosendto
2 CheckGENERATORisprimeandstore
slaveCheckGENERATORisprimeandstore
3 GenerateprimenumberMODULUS
UsecommandSetModulustosendtoslave
4 CheckMODULUSisprimeandstore
CheckMODULUSisprimeandstore
5 GenerateRandomNumberHOST_RND
CalculateHostInterKey:=GENERATOR
6
^HOST_RNDmodMODULUS
UsecommandRequestKeyExchangeto
7 GenerateRandomNumberSLAVE_RND
sendtoslave.
CalculateSlaveInterKey:=GENERATOR^
8
SLAVE_RNDmodMODULUS
SendtohostasreplytoRequestKey
9
Exchange
CalculateKey:=HostInterKey^
CalculateKey:=SlaveInterKey^
10 SLAVE_RNDmod
HOST_RNDmodMODULUS
MODULUS

Note:^representstothepowerof

SSPProtocolManualGA138_2_2_222A

<<backtoindex

GenericCommandsandResponses

AlldevicesmustrespondtoalistofsocalledGenericCommandsasshowinthetablebelow.

Command Code
Reset 0x01
HostProtocolVersion 0x06
GetSerialNumber 0x0C
Sync 0x11
Disable 0x09
Enable 0x0A
GetFirmwareVersion 0x20
GetDatasetVersion 0x21

AdevicewillrespondtoallcommandswiththefirstdatabyteasoneoftheGenericresponseslistbelow..

GenericResponse Code Description


Returnedwhenacommandfromthehostisunderstood
OK 0xF0 and
hasbeen,orisintheprocessof,beingexecuted.
Returnedwhenaninvalidcommandisreceivedbya
COMMANDNOTKNOWN 0xF2
peripheral.
Acommandwasreceivedbyaperipheral,butan
WRONGNoPARAMETERS 0xF3 incorrect
numberofparameterswerereceived.
Oneoftheparameterssentwithacommandisoutof
PARAMETERS 0xF4
range.
Acommandsentcouldnotbeprocessedatthattime.
COMMANDCANNOTBE E.g.
0xF5
PROCESSED sendingadispensecommandbeforethelastdispense
operationhascompleted.
Reportedforerrorsintheexecutionofsoftwaree.g.
Divide
byzero.Thismayalsobereportedifthereisaproblem
SOFTWAREERROR 0xF6
resultingfromafailedremotefirmwareupgrade,inthis
case
thefirmwareupgradeshouldberedone.
FAIL 0xF8 Commandfailure
Theslaveisinencryptedcommunicationmodebutthe
KEYNOTSET 0xFA
encryptionkeyshavenotbeennegotiated.

SSPProtocolManualGA138_2_2_222A

<<backtoindex

ProtocolVersions

AnSSPPollcommandreturnsalistofeventsanddatathathaveoccurredinthedevicesincethelastpoll.

Thehostmachinethenreadsthiseventlisttakingnoteofthedatalength(ifany)ofeachevent.

Onordertointroducenewevents,SSPusesasystemofProtocolVersionlevelstoidentifytheeventtypes
andsizesamachinecanexpecttoseeinreponsetoapoll.Ifthiswerenotdone,newunknowneventswith
unknowndatasizetoamachinenotsetupforthesewouldcausetheeventreadingtofail.

Ahostsystemshouldtakenoteoftheprotocolversionofthedeviceconnectedandensurethatitisnotset
forahigerversionthattheoneitisexpectingtouse.

Thehostcanalsocheckthatthedevicecanalsobesettothehigherprotocollevel,enusringthatexpected
eventswillbeseen.

Thelistedeventsinthismanualshowtheprotocolversionlevelofeachevent.

Aspartofthestartupprocedure,thehostshouldreadthecurrentprotocollevelofthedevice(usingtheset
uprequestcommand).

SSPProtocolManualGA138_2_2_222A

<<backtoindex

BanknoteValidator

ABanknoteValidatorisadevicewhichwillscan,validateandstackabanknoteitdetectsasvalidorrejectit
fromthefrontifnotvalid.Somebanknotevalidatorscanbetransformedintopayoutdevicesbytheaddition
ofapayoutunit.AllITLBanknotevalidatorssupporttheSSPprotocoldescribedhere.

TheBanknoteValidatorshaveadefaultSSPAddressof0.

Thesetuprequestreponsetableforbanknotevalidatortypes:

Protocolversionslessthan6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 0x00=Banknotevalidator
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
3Thevaluetomultiplytheindividualchannelsbytogetthe
Value fullvalue.Ifthisvalueis0thenitindicatesthatthisisa
8 3
Multiplier protocolversion6orgreatercompatibledatasetwherethe
valuesaregivenintheexpandedsegmentofthereturndata.
Numberof
11 1 Thehighestchannelusedinthisdevicedataset[n](116)
channels
Avariablesizearrayofbyes,1foreachchannelwithavalue
Channel from1to255whichwhenmultipliedbythevaluemultiplier
12 n
Values givesthefullvalueofthenote.Ifthevaluemultiplieriszero
thenthesevaluesarezero.
Channel Anobsoletevalueshowingsecuritylevel.Thisissetto2if
12+n n
Security thevaluemultiplieris>0otherwise0.
Realvalue Thevaluebywhichthechannelvaluescanbemultipliedto
12+(n*2) 3
Multiplier showtheirfullvaluee.g.5.00EUR=500EURcents
Protocol
15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice
version

Protocolversionsgreaterthanorequalto6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 0=Banknotevalidator
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
3Thevaluetomultiplytheindividualchannelsbytogetthe
Value fullvalue.Ifthisvalueis0thenitindicatesthatthisisa
8 3
Multiplier protocolversion6orgreatercompatibledatasetwherethe
valuesaregivenintheexpandedsegmentofthereturndata.
Numberof
11 1 Thehighestchannelusedinthisdevicedataset[n](116)
channels
Avariablesizearrayofbyes,1foreachchannelwithavalue
Channel from1to255whichwhenmultipliedbythevaluemultiplier
12 n
Values givesthefullvalueofthenote.Ifthevaluemultiplieriszero
thenthesevaluesarezero.
Channel Anobsoletevalueshowingsecuritylevel.Thisissetto2if
12+n n
Security thevaluemultiplieris>0otherwise0.
Realvalue Thevaluebywhichthechannelvaluescanbemultipliedto
12+(n*2) 3
Multiplier showtheirfullvaluee.g.5.00EUR=500EURcents
Protocol
15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice
version
Expanded
Threebyteasciicodeforeachchannel.Thisallowsmulti
channel
16+(n*2) n*3 currencydatasetstobeusedonSSPdevices.Thesebytesare
country
givenonlyonprotocolversions>=6.
code
Expanded 4bytesforeachchannelvalue.Thesebytesaregivenonlyon
channel 16+(n*5) n*4 protocolversions>=6.
value

SSPProtocolManualGA138_2_2_222A

<<backtoindex

RejectCodes

ThebanknotevalidatorspecificationincludesacommandLastRejectCode.

Usethiscommandafteranotehasbeenrejectedtoreturnaonebytecodetodeterminethecauseofthe
notereject.

Tableshowingrejectcodes:

0x00 0 NOTEACCEPTED Thebanknotehasbeenaccepted.Norejecthasoccured.

Avalidationfail:Thebanknotehasbeenreadbutit'slengthregistersoverthemaxlength
0x01 1 LENGTHFAIL
parameter.

0x02 2 AVERAGEFAIL Internalvalidationfailurebanknotenotrecognised.

0x03 3 COASTLINEFAIL Internalvalidationfailurebanknotenotrecognised.

0x04 4 GRAPHFAIL Internalvalidationfailurebanknotenotrecognised.

0x05 5 BURIEDFAIL Internalvalidationfailurebanknotenotrecognised.

0x06 6 CHANNELINHIBIT Thisbanknotehasbeeninhibitedforacceptanceinthedatasetconfiguration.

SECONDNOTE Asecondbanknotewasinsertedintothevalidatorwhilethefirstonewasstillbeing
0x07 7
DETECTED transportedthroughthebanknotepath.

0x08 8 REJECTBYHOST ThehostsystemissuesaRejectcommandwhenthisbanknotewasheldinescrow.

CROSSCHANNEL Thisbanknotewasidentifiedasexisitingintwoormoreseperatechanneldefinitionsinthe
0x09 9
DETECTED dataset.

REARSENSOR
0x0A 10 Aninconsistencyinapositionsensordetectionwasseen
ERROR

0x0B 11 NOTETOOLONG Thebanknotefaileddatasetlengthchecks.

Thebanknotewasvalidatedonachannelthathasbeeninhibitedforacceptancebythe
0x0C 12 DISABLEDBYHOST
hostsystem.

0x0D 13 SLOWMECH Theinternalmechanismwasdetectedasmovingtooslowlyforcorrectvalidation.

0x0E 14 STRIMATTEMPT Anattempttofraudthesystemwasdetected.

0x0F 15 FRAUDCHANNEL Obseleteresponse.

NONOTES
0x10 16 Abanknotedetectionwasinitiatedbutnobanknoteswereseenatthevalidationsection.
DETECTED

0x11 17 PEAKDETECTFAIL Internalvalidationfail.Banknotenotrecognised.

TWISTEDNOTE
0x12 18 Internalvalidationfail.Banknotenotrecognised.
REJECT

Abanknoteheldinescrowwasrejectedduetothehostnotcommunicatingwithinthetime
0x13 19 ESCROWTIMEOUT
outperiod.

BARCODESCAN
0x14 20 Internalvalidationfail.Banknotenotrecognised.
FAIL

0x15 21 NOCAMACTIVATE Abanknotedidnotreachtheinternalnotepathforvalidationduringtransport.

0x16 22 SLOTFAIL1 Internalvalidationfail.Banknotenotrecognised.

0x17 23 SLOTFAIL2 Internalvalidationfail.Banknotenotrecognised.

0x18 24 LENSOVERSAMPLE Thebanknotewastransportedfasterthanthesystemcouldsamplethenote.

WIDTHDETECTION
0x19 25 Thebanknotefailedameasurementtest.
FAIL

SHORTNOTE
0x1A 26 Thebanknotemeasuredlengthfelloutsideofthevalidationparameterforminimumlength.
DETECT

Therejectcodecammandwasissuedafteranotewaspayedoutusinganotepayout
0x1B 27 PAYOUTNOTE
device.

DOUBLENOTE
0x1C 28 Motethanonebanknotewasdetectedasoverlayedduringnoteentry.
DETECTED
Thebankwasunabletoreachit'scorrectstackingpositionduringtransport.
0x1D 29 UNABLETOSTACK
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SMARTTicket

TheSMARTTicketdeviceisanaddonunittotheNV200toenableprintingandpayoutviatheNV200bezelof
paperticketsofconfigurabaledesigns.ArangeofSSPcommandsmaybeimplementedtoconfigure,modify
andmaintainprintdesignsfromthehostontheflyorbypreconfiguredtemplates.
TheSMARTTicketdeviceisaddressedseperatelyfromtheNV200,theNV200setuprequestcommandwill
return0x08fortheUinttypeifaSMARTTicketdeviceisattached.

WhencommunicatingwiththeNV200attachedtotheprinter,optionaladditionalpolleventsmaybeenabled.
TheseareenabledbysendinganSSPpacketwiththecommandheader0x72totheNV200.Pollswillthe
respondwiththesameprinting(0xA5)andprinted(0xA6)pollresponsesastheprinter.

TheSMARTTickethasadefaultSSPAddressof64dec0x40hex

ThesetuprequestreponsetableforSMARTTickettypes:

size
Data byteoffset notes
(bytes)
Unittype 0 1 8=AddonPrinter
Firmware ASCIIdataofdevicefirmwareversion(e.g.'0110'=
1 4
version 1.10)
Cutterenabled
5 1 (0fordisabled)
status
Tabenabled
6 1 (0fordisabled)
status
Reverse
validation
7 1 (0fordisabled)
enabled
status
Fontpackcode
8 3 e.g.'FP1'
(ASCII)
PrinterType:0x0forFanFold,0x1PaperRoll
Printertype 11 1
(Cutterfitted)
SDcardfitted
12 1 1fordetected
status
Printer
darkness/quality 13 1 Thecurrentprotocolversionsetforthisdevice
setting

SSPProtocolManualGA138_2_2_222A

<<backtoindex

SMARTHopper

SMARTHopperisacoinpayoutdevicecapableofdiscriminatingandpayingoutmultidenominationsof
storedcoinsfromitsinternalstoragehopper.
Coinsaddedtothehoppercanbedesignatedtoberoutedtoanexternalcashboxondetectionorrecycledand
storedinthehopperunittobeavailableforarequestedpayout.
SMARTHopperalsosupportstheadditionofaconnectedcctalkoreSSPcoinmechanismwhichwill
automaticallyadditsvalidatedcoinstotheSMARTHoppersystemlevels.

Notethatpayoutvaluesareintermsoftheofthepennyvalueofthatcurrency.Sofor5.00,thevaluesent
andreturnedbythehopperwouldbe500.AlltransactionswithaSMARThoppermustbeencryptedto
preventdispensecommandsbeingrecordedandreplayedbyanexternaldevice.

Addressing

TheSMARTHopperhasadefaultSSPAddressof16dec0x10hex.

Thesetuprequestreponsetableforcoinhoppertypes:

Protocolversionlessthan6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 3=SMARTHopper
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
Protocol
8 1 Thecurrentprotocolversionsetforthisdevice
Version
Numberof Thenumberofcoindenominationsinthisdevicedataset.
9 1
coinvalues [n]
2byteeachvalueforthecoindenominations(e.g.0.05
Coinvalues 10 n*2
coin=0x05,0x00)

Protocolversiongreaterorequalto6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 3=SMARTHopper
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
Protocol
8 1 Thecurrentprotocolversionsetforthisdevice
Version
Numberof
9 1 Thenumberofcoindenominationsinthisdevicedataset.[n]
coinvalues
2byteeachvalueforthecoindenominations(e.g.0.05coin
Coinvalues 10 n*2
=0x05,0x00)
Anobsoletevalueshowingsecuritylevel.Thisissetto2if
Countrycodes 10+(n*2)
thevaluemultiplieris>0otherwise0.
SSPProtocolManualGA138_2_2_222A

<<backtoindex

CouponPrinter

TheCouponPrinterdeviceisastandalonethermalprinterdesignedforprintingcoupons/recepits/tickets
usingrollmediawithawidthof58mm.ArangeofSSPcommandmaybeimplementedtoconfigure,modify
andmaintainprintdesignsfromthehostontheflyorbypreconfiguredtemplates.
Thecommandsrelyonperexistingresourcesofimages,fontsandtemplatesthatareprogrammedintothe
CouponPrinterdevice.

TheCouponPrinterhasadefaultSSPAddressof65dec0x41hex

ThesetuprequestreponsetableforCouponPrintertypes:

size
Data byteoffset notes
(bytes)
Unittype 0 1 0x0B=StandAlonePrinter
Firmware ASCIIdataofdevicefirmwareversion(e.g.'0110'=
1 4
version 1.10)
Cutterenabled
5 1 (0fordisabled)
status
Tabenabled
6 1 (0fordisabled)
status
Reverse
validation
7 1 (0fordisabled)
enabled
status
Fontpackcode
8 3 e.g.'FP1'
(ASCII)
PrinterType:0x0forFanFold,0x1PaperRoll
Printertype 11 1
(Cutterfitted)
SDcardfitted
12 1 1fordetected
status
Printer
Thecurrentprotocolversionsetforthisdevice
darkness/quality 13 1

setting
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SMARTPayout

TheSmartPayoutisanextensionofabanknotevalidator,allcommandsaresenttothevalidatorusingits
address(0x00).Informationonthetypesofnotethatcanbehandledisobtainedfromthestandardnote
validatorcommands.
Notethatpayoutvaluesareintermsofthepennyvalueofthatcurrency.Sofor5.00,thevaluesentand
returnedbythepayoutwouldbe500.

Thehostsimplyhastotelltheunitthevalueitwishestodispense.Theunitwillmanagewhichnotesare
storedtobeusedforpayoutandtheirlocationtominimisethepayouttime,andwhichnotes,ofthetype
enableforstorage,aresenttothestacker.Thisistherecommendedmodeofoperation.

TheSMARTPayouthasadefaultSSPAddressof0.

ThesetuprequestreponsetableforSMARTPayouttypes:

Protocolversionslessthan6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 0x06=SMARTPayout
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
3Thevaluetomultiplytheindividualchannelsbytogetthe
Value fullvalue.Ifthisvalueis0thenitindicatesthatthisisa
8 3
Multiplier protocolversion6orgreatercompatibledatasetwherethe
valuesaregivenintheexpandedsegmentofthereturndata.
Numberof
11 1 Thehighestchannelusedinthisdevicedataset[n](116)
channels
Avariablesizearrayofbyes,1foreachchannelwithavalue
Channel from1to255whichwhenmultipliedbythevaluemultiplier
12 n
Values givesthefullvalueofthenote.Ifthevaluemultiplieriszero
thenthesevaluesarezero.
Channel Anobsoletevalueshowingsecuritylevel.Thisissetto2if
12+n n
Security thevaluemultiplieris>0otherwise0.
Realvalue Thevaluebywhichthechannelvaluescanbemultipliedto
12+(n*2) 3
Multiplier showtheirfullvaluee.g.5.00EUR=500EURcents
Protocol
15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice
version

Protocolversionsgreaterthanorequalto6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 0x06=SMARTPayout
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
3Thevaluetomultiplytheindividualchannelsbytogetthe
Value fullvalue.Ifthisvalueis0thenitindicatesthatthisisa
8 3
Multiplier protocolversion6orgreatercompatibledatasetwherethe
valuesaregivenintheexpandedsegmentofthereturndata.
Numberof
11 1 Thehighestchannelusedinthisdevicedataset[n](116)
channels
Avariablesizearrayofbyes,1foreachchannelwithavalue
Channel from1to255whichwhenmultipliedbythevaluemultiplier
12 n
Values givesthefullvalueofthenote.Ifthevaluemultiplieriszero
thenthesevaluesarezero.
Channel Anobsoletevalueshowingsecuritylevel.Thisissetto2if
12+n n
Security thevaluemultiplieris>0otherwise0.
Realvalue Thevaluebywhichthechannelvaluescanbemultipliedto
12+(n*2) 3
Multiplier showtheirfullvaluee.g.5.00EUR=500EURcents
Protocol
15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice
version
Expanded
Threebyteasciicodeforeachchannel.Thisallowsmulti
channel
16+(n*2) n*3 currencydatasetstobeusedonSSPdevices.Thesebytesare
country
givenonlyonprotocolversions>=6.
code
Expanded 4bytesforeachchannelvalue.Thesebytesaregivenonlyon
channel 16+(n*5) n*4 protocolversions>=6.
value

SSPProtocolManualGA138_2_2_222A

<<backtoindex

SmartSystem

TheSmartSystemdeviceisamulticoinpayin,payoutsystemwithdetachablefastcoinpayinfeeder.

Coinsfedintothepayinheadwillbevalidatedandcountedandrecognisedcoinsareroutedtotheattached
hopperwhilerejectedcoinsarefedoutofthefrontofthesystem.

Coinhopperlevelsareadjustedinternally.

Thesystemcanfunctionasastandalonehopperpayoutsystemifthepayinfeederheadisremoved.

TheSMARTSystemhasadefaultSSPAddressof16dec0x10hex

Thesetuprequestreponsetableforcoinhoppertypes:

Protocolversionlessthan6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 3=SMARTHopper
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
Protocol
8 1 Thecurrentprotocolversionsetforthisdevice
Version
Numberof Thenumberofcoindenominationsinthisdevicedataset.
9 1
coinvalues [n]
2byteeachvalueforthecoindenominations(e.g.0.05
Coinvalues 10 n*2
coin=0x05,0x00)

Protocolversiongreaterorequalto6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 3=SMARTHopper
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
Protocol
8 1 Thecurrentprotocolversionsetforthisdevice
Version
Numberof
9 1 Thenumberofcoindenominationsinthisdevicedataset.[n]
coinvalues
2byteeachvalueforthecoindenominations(e.g.0.05coin
Coinvalues 10 n*2
=0x05,0x00)
Anobsoletevalueshowingsecuritylevel.Thisissetto2if
Countrycodes 10+(n*2)
thevaluemultiplieris>0otherwise0.
SSPProtocolManualGA138_2_2_222A

<<backtoindex

NoteFloat(NV11)

TheNoteFloatisanextensionofabanknotevalidator,allcommandsaresenttothevalidatorusingits
address(0x00).Informationonthetypesofnotethatcanbehandledisobtainedfromthestandardnote
validatorcommands.

TheNV11(NoteFloat)hasadefaultSSPAddressof0.

ThesetuprequestreponsetableforNoteFloattypes:

Protocolversionslessthan6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 0x07=NoteFloat(NV11)
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
3Thevaluetomultiplytheindividualchannelsbytogetthe
Value fullvalue.Ifthisvalueis0thenitindicatesthatthisisa
8 3
Multiplier protocolversion6orgreatercompatibledatasetwherethe
valuesaregivenintheexpandedsegmentofthereturndata.
Numberof
11 1 Thehighestchannelusedinthisdevicedataset[n](116)
channels
Avariablesizearrayofbyes,1foreachchannelwithavalue
Channel from1to255whichwhenmultipliedbythevaluemultiplier
12 n
Values givesthefullvalueofthenote.Ifthevaluemultiplieriszero
thenthesevaluesarezero.
Channel Anobsoletevalueshowingsecuritylevel.Thisissetto2if
12+n n
Security thevaluemultiplieris>0otherwise0.
Realvalue Thevaluebywhichthechannelvaluescanbemultipliedto
12+(n*2) 3
Multiplier showtheirfullvaluee.g.5.00EUR=500EURcents
Protocol
15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice
version

Protocolversionsgreaterthanorequalto6:

size
Data byteoffset notes
(bytes)
Unittype 0 1 0x07=NoteFloat(NV11)
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
3Thevaluetomultiplytheindividualchannelsbytogetthe
Value fullvalue.Ifthisvalueis0thenitindicatesthatthisisa
8 3
Multiplier protocolversion6orgreatercompatibledatasetwherethe
valuesaregivenintheexpandedsegmentofthereturndata.
Numberof
11 1 Thehighestchannelusedinthisdevicedataset[n](116)
channels
Avariablesizearrayofbyes,1foreachchannelwithavalue
Channel from1to255whichwhenmultipliedbythevaluemultiplier
12 n
Values givesthefullvalueofthenote.Ifthevaluemultiplieriszero
thenthesevaluesarezero.
Channel Anobsoletevalueshowingsecuritylevel.Thisissetto2if
12+n n
Security thevaluemultiplieris>0otherwise0.
Realvalue Thevaluebywhichthechannelvaluescanbemultipliedto
12+(n*2) 3
Multiplier showtheirfullvaluee.g.5.00EUR=500EURcents
Protocol
15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice
version
Expanded
Threebyteasciicodeforeachchannel.Thisallowsmulti
channel
16+(n*2) n*3 currencydatasetstobeusedonSSPdevices.Thesebytesare
country
givenonlyonprotocolversions>=6.
code
Expanded 4bytesforeachchannelvalue.Thesebytesaregivenonlyon
channel 16+(n*5) n*4 protocolversions>=6.
value
SSPProtocolManualGA138_2_2_222A

<<backtoindex

TEBS

TEBSorTamperEvidentBagSystemisaversionoftheNV200banknotevalidatorwithaspecialcashbox
attachedmentwhichoperatesasdevicetostorebanknotesintoaspecialbagwhichwillthenbesealedwhen
thecashboxisextracted.

EachofthebagshasauniquebarcodewhichisregisteredbytheTEBSsystemenableingthehostsystemto
registercashamountsineachbag.

ThesetuprequestreponsetableforTEBStypes:

Protocolversionslessthan6:

size
Data byteoffset notes
(bytes)
0x0D=TEBS,0x0E=TEBSwithSMARTPayout,0x0F=
Unittype 0 1
TEBSwithSMARTTicket
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
3Thevaluetomultiplytheindividualchannelsbytogetthe
Value fullvalue.Ifthisvalueis0thenitindicatesthatthisisa
8 3
Multiplier protocolversion6orgreatercompatibledatasetwherethe
valuesaregivenintheexpandedsegmentofthereturndata.
Numberof
11 1 Thehighestchannelusedinthisdevicedataset[n](116)
channels
Avariablesizearrayofbyes,1foreachchannelwithavalue
Channel from1to255whichwhenmultipliedbythevaluemultiplier
12 n
Values givesthefullvalueofthenote.Ifthevaluemultiplieriszero
thenthesevaluesarezero.
Channel Anobsoletevalueshowingsecuritylevel.Thisissetto2if
12+n n
Security thevaluemultiplieris>0otherwise0.
Realvalue Thevaluebywhichthechannelvaluescanbemultipliedto
12+(n*2) 3
Multiplier showtheirfullvaluee.g.5.00EUR=500EURcents
Protocol
15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice
version

Protocolversionsgreaterthanorequalto6:

size
Data byteoffset notes
(bytes)
0x0D=TEBS,0x0E=TEBSwithSMARTPayout,0x0F=
Unittype 0 1
TEBSwithSMARTTicket
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')
3Thevaluetomultiplytheindividualchannelsbytogetthe
Value fullvalue.Ifthisvalueis0thenitindicatesthatthisisa
8 3
Multiplier protocolversion6orgreatercompatibledatasetwherethe
valuesaregivenintheexpandedsegmentofthereturndata.
Numberof
11 1 Thehighestchannelusedinthisdevicedataset[n](116)
channels
Avariablesizearrayofbyes,1foreachchannelwithavalue
Channel from1to255whichwhenmultipliedbythevaluemultiplier
12 n
Values givesthefullvalueofthenote.Ifthevaluemultiplieriszero
thenthesevaluesarezero.
Channel Anobsoletevalueshowingsecuritylevel.Thisissetto2if
12+n n
Security thevaluemultiplieris>0otherwise0.
Realvalue Thevaluebywhichthechannelvaluescanbemultipliedto
12+(n*2) 3
Multiplier showtheirfullvaluee.g.5.00EUR=500EURcents
Protocol
15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice
version
Expanded
Threebyteasciicodeforeachchannel.Thisallowsmulti
channel
16+(n*2) n*3 currencydatasetstobeusedonSSPdevices.Thesebytesare
country
givenonlyonprotocolversions>=6.
code
Expanded 4bytesforeachchannelvalue.Thesebytesaregivenonlyon
channel 16+(n*5) n*4 protocolversions>=6.
value

SSPProtocolManualGA138_2_2_222A

<<backtoindex

NVR280(NV12)

TheNVR280isanaddonprinterfortheNV9USBPlus.CombinedwiththeNV9USBPlus,thedeviceis
knownasanNV12.ThisdevicesallowstheprintingofticketswithwillexitthroughtheNV9'snotepathand
outofit'sbezel.ItalsoallowstheNV9toreadbarcodesontheseprintedtickets.

ArangeofSSPcommandsmaybeimplementedtoconfigure,modifyandmaintainprintdesignsfromthe
hostontheflyorbypreconfiguredtemplates.
TheNVR280deviceisaddressedseperatelyfromtheNV9,theNV9setuprequestcommandwillreturn0x08
fortheUnittypeifanNVR280deviceisattached.

WhencommunicatingwiththeNV9attachedtotheprinter,optionaladditionalpolleventsmaybeenabled.
TheseareenabledbysendinganSSPpacketwiththecommandheader0x72totheNV9.Pollswillthe
respondwiththesameprinting(0xA5)andprinted(0xA6)pollresponsesastheprinter.

TheNVR280hasadefaultSSPAddressof64dec0x40hex

ThesetuprequestreponsetableforNVR280types:

size
Data byteoffset notes
(bytes)
Unittype 0 1 8=AddonPrinter
Firmware
1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)
version
Cutterenabled
5 1 (0fordisabled,always1onthisprinter)
status
Tabenabled
6 1 (0fordisabled,always0onthisprinter)
status
Reverse
validation
7 1 (0fordisabled)
enabled
status
Fontpackcode
8 3 e.g.'FP1'
(ASCII)
PrinterType:0x0forFanFold,0x1PaperRoll
Printertype 11 1
(Cutterfitted)(Always0x1onthisprinter)
SDcardfitted
12 1 1fordetected
status
Printer
darkness/quality 13 1 Thecurrentprotocolversionsetforthisdevice
setting

SSPProtocolManualGA138_2_2_222A

<<backtoindex

FlatbedPrinter(FBF166)

TheFlatbedPrinterdeviceisastandalonethermalprinterdesignedforprintingticketsusingfanfoldmedia
withawidthof65mm.ArangeofSSPcommandmaybeimplementedtoconfigure,modifyand
maintainprintdesignsfromthehostontheflyorbypreconfiguredtemplates.
Thecommandsrelyonperexistingresourcesofimages,fontsandtemplatesthatareprogrammedintothe
FlatbedPrinterdevice.

TheFlatbedPrinterhasadefaultSSPAddressof65dec0x41hex

ThesetuprequestreponsetableforCouponPrintertypes:

size
Data byteoffset notes
(bytes)
Unittype 0 1 0x0B=StandAlonePrinter
Firmware ASCIIdataofdevicefirmwareversion(e.g.'0110'=
1 4
version 1.10)
Cutterenabled
5 1 (0fordisabled)
status
Tabenabled
6 1 (0fordisabled)
status
Reverse
validation
7 1 (0fordisabled)
enabled
status
Fontpackcode
8 3 e.g.'FP1'
(ASCII)
PrinterType:0x0forFanFold,0x1PaperRoll
Printertype 11 1
(Cutterfitted)
SDcardfitted
12 1 1fordetected
status
Printer
darkness/quality 13 1 Thecurrentprotocolversionsetforthisdevice
setting
SSPProtocolManualGA138_2_2_222A

<<backtoindex

NV9USBCommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
Hold 0x18 24
PollWithAck 0x56 86
EventAck 0x57 87
GetCounters 0x58 88
ResetCounters 0x59 89
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
SSPProtocolManualGA138_2_2_222A

NV9USBEventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Read 0xEF 239
NoteCredit 0xEE 238
Rejecting 0xED 237
Rejected 0xEC 236
Stacking 0xCC 204
Stacked 0xEB 235
SafeJam 0xEA 234
UnsafeJam 0xE9 233
Disabled 0xE8 232
StackerFull 0xE7 231
NoteClearedFromFront 0xE1 225
NoteClearedIntoCashbox 0xE2 226
ChannelDisable 0xB5 181
Initialising 0xB6 182
TicketInBezel 0xAD 173
PrintedToCashbox 0xAF 175
SSPProtocolManualGA138_2_2_222A

<<backtoindex

NV10USBCommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
Hold 0x18 24
PollWithAck 0x56 86
EventAck 0x57 87
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
SSPProtocolManualGA138_2_2_222A

NV10USBEventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Read 0xEF 239
NoteCredit 0xEE 238
Rejecting 0xED 237
Rejected 0xEC 236
Stacking 0xCC 204
Stacked 0xEB 235
SafeJam 0xEA 234
UnsafeJam 0xE9 233
Disabled 0xE8 232
FraudAttempt 0xE6 230
StackerFull 0xE7 231
NoteClearedIntoCashbox 0xE2 226
ChannelDisable 0xB5 181
SSPProtocolManualGA138_2_2_222A

<<backtoindex

NV11CommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
Hold 0x18 24
PollWithAck 0x56 86
EventAck 0x57 87
SetDenominationRoute 0x3B 59
GetDenominationRoute 0x3C 60
EmptyAll 0x3F 63
SmartEmpty 0x52 82
CashboxPayoutOperationData 0x53 83
GetCounters 0x58 88
ResetCounters 0x59 89
GetNotePositions 0x41 65
PayoutNote 0x42 66
StackNote 0x43 67
SetValueReportType 0x45 69
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
GetBuildRevision 0x4F 79
EnablePayoutDevice 0x5C 92
DisablePayoutDevice 0x5B 91
SetBaudRate 0x4D 77
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
SSPProtocolManualGA138_2_2_222A

NV11EventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Read 0xEF 239
NoteCredit 0xEE 238
Rejecting 0xED 237
Rejected 0xEC 236
Stacking 0xCC 204
Stacked 0xEB 235
SafeJam 0xEA 234
UnsafeJam 0xE9 233
Disabled 0xE8 232
StackerFull 0xE7 231
NoteClearedFromFront 0xE1 225
NoteClearedIntoCashbox 0xE2 226
ChannelDisable 0xB5 181
Dispensing 0xDA 218
Halted 0xD6 214
Timeout 0xD9 217
Emptying 0xC2 194
Emptied 0xC3 195
SmartEmptying 0xB3 179
SmartEmptied 0xB4 180
NoteStoredInPayout 0xDB 219
PayoutOutOfService 0xC6 198
NoteTransferedToStacker 0xC9 201
NoteHeldInBezel 0xCE 206
NoteIntoStoreAtReset 0xCB 203
NoteIntoStackerAtReset 0xCA 202
NoteDispensedAtReset 0xCD 205
NoteFloatRemoved 0xC7 199
NoteFloatAttached 0xC8 200
DeviceFull 0xCF 207
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SMARTHOPPERCommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetupRequest 0x05 5
PollWithAck 0x56 86
EventAck 0x57 87
SetDenominationRoute 0x3B 59
GetDenominationRoute 0x3C 60
PayoutAmount 0x33 51
GetDenominationLevel 0x35 53
SetDenominationLevel 0x34 52
HaltPayout 0x38 56
FloatAmount 0x3D 61
GetMinPayout 0x3E 62
SetCoinMechInhibits 0x40 64
PayoutByDenomination 0x46 70
FloatByDenomination 0x44 68
EmptyAll 0x3F 63
SetOptions 0x50 80
GetOptions 0x51 81
CoinMechGlobalInhibit 0x49 73
SmartEmpty 0x52 82
CashboxPayoutOperationData 0x53 83
GetAllLevels 0x22 34
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
CoinMechOptions 0x5A 90
GetBuildRevision 0x4F 79
CommsPassThrough 0x37 55
SetBaudRate 0x4D 77
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
SetCashboxPayoutLimit 0x4E 78
SSPProtocolManualGA138_2_2_222A

SMARTHOPPEREventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Disabled 0xE8 232
FraudAttempt 0xE6 230
Initialising 0xB6 182
Dispensing 0xDA 218
CoinsLow 0xD3 211
HopperJammed 0xD5 213
Halted 0xD6 214
Floating 0xD7 215
Floated 0xD8 216
Timeout 0xD9 217
IncompletePayout 0xDC 220
IncompleteFloat 0xDD 221
CashboxPaid 0xDE 222
CoinCredit 0xDF 223
CoinMechJammed 0xC4 196
CoinMechReturnActive 0xC5 197
Emptying 0xC2 194
Emptied 0xC3 195
SmartEmptying 0xB3 179
SmartEmptied 0xB4 180
CalibrationFailed 0x83 131
CoinMechError 0xB7 183
AttachedCoinMechDisabled 0xBD 189
AttachedCoinMechEnabled 0xBE 190
SSPProtocolManualGA138_2_2_222A

<<backtoindex

NV200CommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
Hold 0x18 24
GetBarcodeReaderConfiguration 0x23 35
SetBarcodeReaderConfiguration 0x24 36
GetBarcodeInhibit 0x25 37
SetBarcodeInhibit 0x26 38
GetBarcodeData 0x27 39
ConfigureBezel 0x54 84
PollWithAck 0x56 86
EventAck 0x57 87
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
GetBuildRevision 0x4F 79
SetBaudRate 0x4D 77
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
EnableTitoEvents 0x72 114
SSPProtocolManualGA138_2_2_222A

NV200EventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Read 0xEF 239
NoteCredit 0xEE 238
Rejecting 0xED 237
Rejected 0xEC 236
Stacking 0xCC 204
Stacked 0xEB 235
SafeJam 0xEA 234
UnsafeJam 0xE9 233
Disabled 0xE8 232
FraudAttempt 0xE6 230
StackerFull 0xE7 231
NoteClearedFromFront 0xE1 225
NoteClearedIntoCashbox 0xE2 226
CashboxRemoved 0xE3 227
CashboxReplaced 0xE4 228
BarcodeTicketValidated 0xE5 229
BarcodeTicketAck 0xD1 209
NotePathOpen 0xE0 224
ChannelDisable 0xB5 181
Initialising 0xB6 182
TicketPrinting 0xA5 165
TicketPrinted 0xA6 166
TicketPrintingError 0xA8 168
PrintHalted 0xAE 174
TicketInBezel 0xAD 173
PrintedToCashbox 0xAF 175
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SMARTPAYOUTCommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
GetBarcodeReaderConfiguration 0x23 35
SetBarcodeReaderConfiguration 0x24 36
GetBarcodeInhibit 0x25 37
SetBarcodeInhibit 0x26 38
GetBarcodeData 0x27 39
ConfigureBezel 0x54 84
PollWithAck 0x56 86
EventAck 0x57 87
SetDenominationRoute 0x3B 59
GetDenominationRoute 0x3C 60
PayoutAmount 0x33 51
GetDenominationLevel 0x35 53
HaltPayout 0x38 56
FloatAmount 0x3D 61
GetMinPayout 0x3E 62
PayoutByDenomination 0x46 70
FloatByDenomination 0x44 68
EmptyAll 0x3F 63
SmartEmpty 0x52 82
CashboxPayoutOperationData 0x53 83
GetAllLevels 0x22 34
GetCounters 0x58 88
ResetCounters 0x59 89
SetRefillMode 0x30 48
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
GetBuildRevision 0x4F 79
EnablePayoutDevice 0x5C 92
DisablePayoutDevice 0x5B 91
SetBaudRate 0x4D 77
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
CancelEscrowTransaction 0x76 118
CommitEscrowTransaction 0x77 119
ReadEscrowValue 0x78 120
GetEscrowSize 0x79 121
SetEscrowSize 0x7A 122
SSPProtocolManualGA138_2_2_222A

SMARTPAYOUTEventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Read 0xEF 239
NoteCredit 0xEE 238
Rejecting 0xED 237
Rejected 0xEC 236
Stacked 0xEB 235
SafeJam 0xEA 234
UnsafeJam 0xE9 233
Disabled 0xE8 232
FraudAttempt 0xE6 230
StackerFull 0xE7 231
NoteClearedFromFront 0xE1 225
NoteClearedIntoCashbox 0xE2 226
CashboxRemoved 0xE3 227
CashboxReplaced 0xE4 228
BarcodeTicketValidated 0xE5 229
BarcodeTicketAck 0xD1 209
NotePathOpen 0xE0 224
ChannelDisable 0xB5 181
Initialising 0xB6 182
Dispensing 0xDA 218
Dispensed 0xD2 210
HopperJammed 0xD5 213
Halted 0xD6 214
Floating 0xD7 215
Floated 0xD8 216
Timeout 0xD9 217
IncompletePayout 0xDC 220
IncompleteFloat 0xDD 221
Emptying 0xC2 194
Emptied 0xC3 195
SmartEmptying 0xB3 179
SmartEmptied 0xB4 180
NoteStoredInPayout 0xDB 219
PayoutOutOfService 0xC6 198
JamRecovery 0xB0 176
ErrorDuringPayout 0xB1 177
NoteTransferedToStacker 0xC9 201
NoteHeldInBezel 0xCE 206
NoteIntoStoreAtReset 0xCB 203
NoteIntoStackerAtReset 0xCA 202
SSPProtocolManualGA138_2_2_222A

<<backtoindex

BV20CommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
Hold 0x18 24
PollWithAck 0x56 86
EventAck 0x57 87
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
SetBaudRate 0x4D 77
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
SSPProtocolManualGA138_2_2_222A

BV20EventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Read 0xEF 239
NoteCredit 0xEE 238
Rejecting 0xED 237
Rejected 0xEC 236
Stacking 0xCC 204
Stacked 0xEB 235
SafeJam 0xEA 234
UnsafeJam 0xE9 233
Disabled 0xE8 232
FraudAttempt 0xE6 230
StackerFull 0xE7 231
ChannelDisable 0xB5 181
Initialising 0xB6 182
SSPProtocolManualGA138_2_2_222A

<<backtoindex

BV50CommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
Hold 0x18 24
PollWithAck 0x56 86
EventAck 0x57 87
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
SetBaudRate 0x4D 77
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
SSPProtocolManualGA138_2_2_222A

BV50EventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Disabled 0xE8 232
StackerFull 0xE7 231
NoteClearedFromFront 0xE1 225
NoteClearedIntoCashbox 0xE2 226
CashboxRemoved 0xE3 227
CashboxReplaced 0xE4 228
ChannelDisable 0xB5 181
Initialising 0xB6 182
SSPProtocolManualGA138_2_2_222A

<<backtoindex

BV100CommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
Hold 0x18 24
PollWithAck 0x56 86
EventAck 0x57 87
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
SetBaudRate 0x4D 77
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
SSPProtocolManualGA138_2_2_222A

BV100EventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Read 0xEF 239
NoteCredit 0xEE 238
Rejecting 0xED 237
Rejected 0xEC 236
Stacking 0xCC 204
Stacked 0xEB 235
SafeJam 0xEA 234
UnsafeJam 0xE9 233
Disabled 0xE8 232
FraudAttempt 0xE6 230
StackerFull 0xE7 231
NoteClearedFromFront 0xE1 225
NoteClearedIntoCashbox 0xE2 226
CashboxRemoved 0xE3 227
CashboxReplaced 0xE4 228
ChannelDisable 0xB5 181
Initialising 0xB6 182
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SMARTSYSTEMCommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
GetDatasetVersion 0x21 33
SetInhibits 0x02 2
SetupRequest 0x05 5
PollWithAck 0x56 86
EventAck 0x57 87
SetDenominationRoute 0x3B 59
GetDenominationRoute 0x3C 60
PayoutAmount 0x33 51
GetDenominationLevel 0x35 53
SetDenominationLevel 0x34 52
HaltPayout 0x38 56
FloatAmount 0x3D 61
GetMinPayout 0x3E 62
SetCoinMechInhibits 0x40 64
PayoutByDenomination 0x46 70
FloatByDenomination 0x44 68
EmptyAll 0x3F 63
SetOptions 0x50 80
GetOptions 0x51 81
CoinMechGlobalInhibit 0x49 73
SmartEmpty 0x52 82
CashboxPayoutOperationData 0x53 83
GetAllLevels 0x22 34
GetCounters 0x58 88
ResetCounters 0x59 89
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
CoinMechOptions 0x5A 90
GetBuildRevision 0x4F 79
CommsPassThrough 0x37 55
SetBaudRate 0x4D 77
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
GetRealTimeClockConfiguration 0x62 98
SetRealTimeClock 0x64 100
GetRealTimeClock 0x63 99
SetCashboxPayoutLimit 0x4E 78
CoinStir 0x5D 93
PayoutAmountByDenomination 0x39 57
SSPProtocolManualGA138_2_2_222A

SMARTSYSTEMEventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Disabled 0xE8 232
FraudAttempt 0xE6 230
Initialising 0xB6 182
Dispensing 0xDA 218
Dispensed 0xD2 210
HopperJammed 0xD5 213
Halted 0xD6 214
Floating 0xD7 215
Floated 0xD8 216
Timeout 0xD9 217
IncompletePayout 0xDC 220
IncompleteFloat 0xDD 221
CashboxPaid 0xDE 222
CoinMechJammed 0xC4 196
CoinMechReturnActive 0xC5 197
Emptying 0xC2 194
Emptied 0xC3 195
SmartEmptying 0xB3 179
SmartEmptied 0xB4 180
CalibrationFailed 0x83 131
DeviceFull 0xCF 207
CoinMechError 0xB7 183
AttachedCoinMechDisabled 0xBD 189
AttachedCoinMechEnabled 0xBE 190
ValueAdded 0xBF 191
PayinActive 0xC1 193
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SMARTTICKETCommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
SetupRequest 0x05 5
PollWithAck 0x56 86
EventAck 0x57 87
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
GetRealTimeClockConfiguration 0x62 98
SetRealTimeClock 0x64 100
GetRealTimeClock 0x63 99
TicketPrint 0x70 112
PrinterConfiguration 0x71 113
SSPProtocolManualGA138_2_2_222A

SMARTTICKETEventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Disabled 0xE8 232
TicketsLow 0xA0 160
TicketsReplaced 0xA1 161
PrinterHeadRemoved 0xA2 162
TicketPathOpen 0xA3 163
TicketJam 0xA4 164
TicketPrinting 0xA5 165
TicketPrinted 0xA6 166
TicketPrintingError 0xA8 168
PrinterHeadReplaced 0xA9 169
TicketPathClosed 0xAA 170
NoPaper 0xAB 171
PaperReplaced 0xAC 172
SSPProtocolManualGA138_2_2_222A

<<backtoindex

COUPONPRINTERCommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
PollWithAck 0x56 86
EventAck 0x57 87
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
SspSetEncryptionKey 0x60 96
SspEncryptionResetToDefault 0x61 97
GetRealTimeClockConfiguration 0x62 98
SetRealTimeClock 0x64 100
GetRealTimeClock 0x63 99
TicketPrint 0x70 112
PrinterConfiguration 0x71 113
SSPProtocolManualGA138_2_2_222A

COUPONPRINTEREventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Disabled 0xE8 232
TicketsLow 0xA0 160
TicketsReplaced 0xA1 161
PrinterHeadRemoved 0xA2 162
TicketJam 0xA4 164
TicketPrinting 0xA5 165
TicketPrinted 0xA6 166
TicketPrintingError 0xA8 168
PrinterHeadReplaced 0xA9 169
NoPaper 0xAB 171
PaperReplaced 0xAC 172
SSPProtocolManualGA138_2_2_222A

<<backtoindex

NV150CommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
SetInhibits 0x02 2
DisplayOn 0x03 3
DisplayOff 0x04 4
SetupRequest 0x05 5
Reject 0x08 8
UintData 0x0D 13
ChannelValueData 0x0E 14
ChannelSecurityData 0x0F 15
ChannelReteachData 0x10 16
LastRejectCode 0x17 23
Hold 0x18 24
GetBarcodeReaderConfiguration 0x23 35
SetBarcodeReaderConfiguration 0x24 36
GetBarcodeInhibit 0x25 37
SetBarcodeInhibit 0x26 38
GetBarcodeData 0x27 39
PollWithAck 0x56 86
EventAck 0x57 87
SetGenerator 0x4A 74
SetModulus 0x4B 75
RequestKeyExchange 0x4C 76
SetBaudRate 0x4D 77
SSPProtocolManualGA138_2_2_222A

NV150EventTable

Headercode(hex) dec

SlaveReset 0xF1 241


Read 0xEF 239
NoteCredit 0xEE 238
Rejecting 0xED 237
Rejected 0xEC 236
Stacking 0xCC 204
Stacked 0xEB 235
SafeJam 0xEA 234
UnsafeJam 0xE9 233
Disabled 0xE8 232
FraudAttempt 0xE6 230
StackerFull 0xE7 231
NoteClearedFromFront 0xE1 225
NoteClearedIntoCashbox 0xE2 226
BarcodeTicketValidated 0xE5 229
BarcodeTicketAck 0xD1 209
NotePathOpen 0xE0 224
SSPProtocolManualGA138_2_2_222A

<<backtoindex

FLATBEDPRINTERCommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
SetupRequest 0x05 5
SspSetEncryptionKey 0x60 96
GetRealTimeClockConfiguration 0x62 98
SetRealTimeClock 0x64 100
GetRealTimeClock 0x63 99
TicketPrint 0x70 112
PrinterConfiguration 0x71 113
SSPProtocolManualGA138_2_2_222A

FLATBEDPRINTEREventTable

Headercode(hex) dec

TicketsLow 0xA0 160


TicketsReplaced 0xA1 161
PrinterHeadRemoved 0xA2 162
TicketPathOpen 0xA3 163
TicketJam 0xA4 164
TicketPrinting 0xA5 165
TicketPrinted 0xA6 166
TicketPrintingError 0xA8 168
PrinterHeadReplaced 0xA9 169
TicketPathClosed 0xAA 170
NoPaper 0xAB 171
PaperReplaced 0xAC 172
TicketInBezelAtStartup 0xA7 167
SSPProtocolManualGA138_2_2_222A

<<backtoindex

NV12CommandTable

Headercode(hex) dec

Sync 0x11 17
Reset 0x01 1
HostProtocolVersion 0x06 6
Poll 0x07 7
GetSerialNumber 0x0C 12
Disable 0x09 9
Enable 0x0A 10
GetFirmwareVersion 0x20 32
SetupRequest 0x05 5
GetBarcodeReaderConfiguration 0x23 35
SetBarcodeReaderConfiguration 0x24 36
GetBarcodeInhibit 0x25 37
SetBarcodeInhibit 0x26 38
GetBarcodeData 0x27 39
SspSetEncryptionKey 0x60 96
GetRealTimeClockConfiguration 0x62 98
SetRealTimeClock 0x64 100
GetRealTimeClock 0x63 99
EnableTitoEvents 0x72 114
TicketPrint 0x70 112
PrinterConfiguration 0x71 113
SSPProtocolManualGA138_2_2_222A

NV12EventTable

Headercode(hex) dec

TicketsLow 0xA0 160


TicketsReplaced 0xA1 161
PrinterHeadRemoved 0xA2 162
TicketJam 0xA4 164
TicketPrinting 0xA5 165
TicketPrinted 0xA6 166
TicketPrintingError 0xA8 168
PrinterHeadReplaced 0xA9 169
NoPaper 0xAB 171
PaperReplaced 0xAC 172
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

Sync 0x11 17

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
optional
NV150,NV200,NV9USB,SMARTHOPPER,
SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

SSPusesasystemofsequencebitstoensurethatpacketshavebeenreceivedbytheslave
andthereplyreceivedbythehost.Iftheslavereceivesthesamesequencebitasthe
previouscommandpacketthenthisissignaltoretransmitthelastreply.

Amechanismisrequiredtoinitiallysetthehostandslavetothesamesequencebitsand
thisisdonebytheuseoftheSYNCcommand.

ASynccommandresetstheseqbitofthepacketsothattheslavedeviceexpectsthenext
seqbittobe0.Thehostthensetsitsnextseqbitto0andtheseqsequenceis
synchronised.

TheSYNCcommandshouldbethefirstcommandsenttotheslaveduringasession.

Packetexamples

Setseqbitto1

Hosttransmit: 7F 80 01 11 65 82
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

Reset 0x01 1

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
optional
NV150,NV200,NV9USB,SMARTHOPPER,
SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

Performsasoftwareandhardwareresetofthedevice.

AfterthiscommandhasbeenacknowledgedwithOK(0xF0),anyencryption,baudrate
changes,etcwillberesettodefaultsettings.

Packetexamples

Nodataparameters,sequencebitsetandaddress0

Hosttransmit: 7F 80 01 01 06 02
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

HostProtocolVersion 0x06 6

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
optional
NV150,NV200,NV9USB,SMARTHOPPER,
SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

ITLSSPdevicesuseasystemofprotocollevelstocontroltheeventresponsestopollsto
ensurethatchangeswouldnotaffectsystemswithfinitestatemachinesunabletotestfor
neweventswithnondefineddatalengths.

Usethiscommandtoallowthehosttosetwhichprotocolversiontooperatetheslave
device.

IfthedevicesupportstherequestedprotocolOK(0xF0)willbereturned.IfnotthenFAIL
(0xF8)willbereturned

Packetexamples

Theslavesupportstheprotocolversion8

Hosttransmit: 7F 80 02 06 08 03 94
SlaveReply: 7F 80 01 F0 23 80

Hostprotocolversion9notsupported

Hosttransmit: 7F 80 02 06 09 06 14
SlaveReply: 7F 80 01 F8 10 00
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

Poll 0x07 7

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
optional
NV150,NV200,NV9USB,SMARTHOPPER,
SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

Thiscommandreturnsalistofeventsoccuredinthedevicesincethelastpollwassent.

TheSSPdevicessharesomecommoneventsandhavesomeuniqueeventsoftheirown.
Seeeventtablesfordetailsforaspecificdevice.

Packetexamples

Pollcommandreturningdeviceresetanddisabledresponse

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 F1 F8 DC 0C

Eventresponsenotecreditchannel1andnotestacked

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 04 F0 EE 01 EB B9 48
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetSerialNumber 0x0C 12

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
optional
NV150,NV200,NV9USB,SMARTHOPPER,
SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

Thiscommandreturnsa4bytebigendianarrayrepresentingtheuniquefactory
programmedserialnumberofthedevice.

Packetexamples

Thedevicerespondswith4bytesofserialnumberdata.Inthiscase,theserialnumberis
01873452=0x1c962c.Thereturnarrayisformattedasbigendian(MSBfirst).

Hosttransmit: 7F 80 01 0C 2B 82
SlaveReply: 7F 80 05 F0 00 1C 96 2C D4 97
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

Disable 0x09 9

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
optional
NV150,NV200,NV9USB,SMARTHOPPER,
SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

Disabledtheslavedevicefromoperation.

Forexample,thiscommandwouldblockabanknotevalidatorfromallowinganymore
banknotestobeentered.

FormostSSPdevices,thedefaultstateistobedisabledafterreset.

Packetexamples

Singlebytecommandwithnoparameters

Hosttransmit: 7F 80 01 09 35 82
SlaveReply: 7F 80 01 F0 23 80

NV11whennotefloatisjammed/disconnectedrespondsCOMMAND_CANNOT_BE_PROCESSED

Hosttransmit: 7F 80 01 09 35 82
SlaveReply: 7F 80 01 F5 3D 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

Enable 0x0A 10

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
optional
NV150,NV200,NV9USB,SMARTHOPPER,
SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

ThiscommandwillenabletheSSPdevicefornormaloperation.Forexample,itwillallowa
banknotevalidatortocommencevalidatingbanknotesenteredintoit'sbezel.

Packetexamples

Singlebytecommandwithnoparameters

Hosttransmit: 7F 80 01 0A 3F 82
SlaveReply: 7F 80 01 F0 23 80

NV11whennotefloatisjammed/disconnectedrespondsCOMMAND_CANNOT_BE_PROCESSED

Hosttransmit: 7F 80 01 0A 3F 82
SlaveReply: 7F 80 01 F5 3D 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetFirmwareVersion 0x20 32

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
optional
NV200,NV9USB,SMARTHOPPER,SMART
PAYOUT,SMARTSYSTEM,SMARTTICKET

Description

ReturnsavariablelengthASCIIarraycontaingthefullfirmwareversionoftheattached
device.

Packetexamples

Inthisexample,thefirmwareversionofthedeviceis:NV02004141498000

Hosttransmit: 7F 80 01 20 C0 02
SlaveReply: 7F 80 11 F0 4E 56 30 32 30 30 34 31 34 31 34 39 38 30 30 30 DE 55
ascii: . N V 0 2 0 0 4 1 4 1 4 9 8 0 0 0
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetDatasetVersion 0x21 33

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV200,
NV9USB,SMARTHOPPER,SMARTPAYOUT, optional
SMARTSYSTEM

Description

ReturnsavaribalelengthASCIIarraygivingtheinstalleddatasetversionofthedevice.

Packetexamples

ThisexampleshowsadevicewithdatasetversionEUR01610.

Hosttransmit: 7F 80 01 21 C5 82
SlaveReply: 7F 80 09 F0 45 55 52 30 31 36 31 30 B8 2A
ascii: . E U R 0 1 6 1 0
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetInhibits 0x02 2

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
NV200,NV9USB,SMARTPAYOUT,SMART optional
SYSTEM

Description

Setsthechannelinhibitlevelforthedevice.eachbytesentrepresents8bits(channelsof
inhibit).

Nv200hastheoptiontosend2,3,or4bytestorepresent16,24,or64channels,theother
BNVdeviceshavetheoptionofsending1or2bytesfor8or16channeloperation.

Setthebitlowtoinhibitallnoteacceptanceonthatchannel,hightoallownoteacceptance.

Packetexamples

Setchannels13enabled,416inhibited

Hosttransmit: 7F 80 03 02 07 00 2B B6
SlaveReply: 7F 80 01 F0 23 80

Allchannelsenabled

Hosttransmit: 7F 80 03 02 FF FF 25 A4
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

DisplayOn 0x03 3

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB,SMARTPAYOUT

Description

Allowsthehosttocontroltheilluminationofthebezel.Sendthiscommandtoshowbezel
illuminationwhenthedeviceisenabledforbanknotevalidation.(Thisisthedefault
conditionatreset).

Notethatthevalidatorwillstilloverridetheilluminationofthebezel,i.e.thebezelwillnot
beilluminatedifthedeviceisnotenabledevenifthiscommandissent.

Packetexamples

Singlebytecommandwithnoparameters.

Hosttransmit: 7F 80 01 03 09 82
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

DisplayOff 0x04 4

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB,SMARTPAYOUT

Description

Allowsthehosttocontrolbanknotevalidatorbezelillumination.Usethiscommandto
disableilluminationwhnethevalidatorisenabledfornoteentry.

Packetexamples

Singlebytecommandwithnoparameters

Hosttransmit: 7F 80 01 04 18 02
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetupRequest 0x05 5

Implementedon EncryptionRequired

BV100,BV20,BV50,FLATBEDPRINTER,
NV10USB,NV11,NV12,NV150,NV200,NV9USB,
optional
SMARTHOPPER,SMARTPAYOUT,SMART
SYSTEM,SMARTTICKET

Description

Requestthesetupconfigurationofthedevice.Givesdetailsaboutversions,channel
assignments,countrycodesandvalues.

Eachdevicetypehasadifferentreturndataformat.Pleaserefertothetableinformationfor
eachindividualdevice.

SMARTTicket/CouponPrinterResponse

Response
SmartTicketData Size Notes
Offset

0x08=SMARTTicket,0x0B=Coupon
UnitType 0 1
Printer

FirmwareVersion 1 4 Asciidataofdevicefirmware(eg0123)

CutterEnabled 5 1 (0fordisabled)

Tabenabledstatus 6 1 (0fordisabled)

Reversevalidation
7 1 (0fordisabled)
enabledstatus

Fontpackcode(ASCII) 8 3 e.g.FP1

PrinterType:0x0forFanFold,0x1Paper
Printertype 11 1 Roll(Cutter
fitted)

SDcardfittedstatus 12 1 (1fordetected)

Printerdarkness/quality
13 1 valuebetween03
setting

SSPProtocolVersion 14 1

Packetexamples

ThisexampleshowsthedatareturnedforaBNVwithGBPdataset,firmwareversion1.00,3
channelsGBP5,GBP10,GBP20

Hosttransmit: 7F 80 01 05 1D 82
SlaveReply: 7F 80 17 F0 00 30 31 30 30 47 42 50 00 00 01 03 05 0A 14 02 02 02 40 00
00 05 61 81
ascii: . . 0 1 0 0 G B P . . . . . . . . . . @ .
. .
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

Reject 0x08 8

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB,SMARTPAYOUT

Description

Afterabanknotevalidatordevicereportsavalidnoteisheldinescrow,thiscommandmay
besenttocausethebanknotetoberejectedbacktotheuser.

Packetexamples

Singlebytecommandwithnoparameters

Hosttransmit: 7F 80 01 08 30 02
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

UintData 0x0D 13

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB,SMARTPAYOUT

Description

Acommandtoreturnversioninformationabouttheconnecteddevicetotheformat
describedinthetablebelow:

byteoffset function size

0 GenericOKResponse(OxF0) 1

1 Unittype:seeUintTypeTableforcodes 1

2 Firmwareversion(4byteASCII) 4

6 Datasetcountry(3byteASCII) 3

9 Valuemultiplier 3

12 Protocolversion 1

Packetexamples

ThisisaresponseexampleforabanknotevalidatorEUR5,10,20version3.00protocolversion
7

Hosttransmit: 7F 80 01 0D 2E 02
SlaveReply: 7F 80 0D F0 00 30 33 30 30 45 55 52 01 00 00 07 01 85
ascii: . . 0 3 0 0 E U R . . . .
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

ChannelValueData 0x0E 14

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB,SMARTPAYOUT

Description

Returnschannelvaluedataforabanknotevalidator.Notethatthiswilldifferdepeneindon
theprotoclversionused/supported.

Forprotocolversionslessthan6:

byteoffset function size

0 GenericOk(0xF0) 1

1 Highestchannelinset116(n) 1

Abytevalueforeachchannelgivesthe
totalchannelvaluewhennultipliedbythe
2:(2+n) n
valuemultiplier.Zerovalueshowsthatthe
channelisnotused

Forprotocolversionsgreaterorequalto6:

byteoffset function size

0 GenericOk(0xF0) 1

1 Highestchannelinset116(n) 1

Abytevalueforeachchannelgivesthe
totalchannelvaluewhennultipliedbythe n
2
valuemultiplier.Zerovalueshowsthatthe
channelisnotused

2+n 3byteforeachASCIIcountrycodeinset 3*n

(2+n)+(3*n) 4bytevalueforeachdenomination 4*n

Packetexamples

Thisexampleshowsaresponsefornotesinchannels1,2,4,6,7wheninprotocolversion5

Hosttransmit: 7F 80 01 0E 24 02
SlaveReply: 7F 80 09 F0 07 05 0A 00 14 00 32 64 BC DA

Thisexampleshowsaresponsefornotesinchannels1,2,4,6,7wheninprotocolversion6
Hosttransmit: 7F 80 01 0E 24 02
SlaveReply: 7F 80 3C F0 07 00 00 00 00 00 00 00 45 55 52 45 55 52 45 55 52 00 45 55
52 45 55 52 00 45 55 52 45 55 52 05 00 00 00 0A 00 00 00 00 00 00 00 14
00 00 00 00 00 00 00 32 00 00 00 64 00 00 00 D0 DF
ascii: . . . . . . . . . E U R E U R E U R . E U
R E U R . E U R E U R . . . . . . . . . . . . .
. . . . . . . 2 . . . d . . .
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

ChannelSecurityData 0x0F 15

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB,SMARTPAYOUT

Description

Commandwhichreturnsanumberofchannelsbyte(thehighestchannelused)andthen1
tonbyteswhichgivethesecurityofeachchanneluptothehighestone,azeroindicates
thatthechannelisnotimplemented.
(1=low,2=std,3=high,4=inhibited).

Packetexamples

Inthisexampleavalidatorhasnotesinchannels1,2,4,6,7allatstandardsecurity.

Hosttransmit: 7F 80 01 0F 21 82
SlaveReply: 7F 80 09 F0 07 02 02 00 02 00 02 02 94 84
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

ChannelReteachData 0x10 16

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB,SMARTPAYOUT

Description

Thisisavestigialcommandandmaybedeprecatedinfutureversions.Donotuse.Ifitis
supportedinadeviceitwillreturnallzeros.

Packetexamples

Alwaysreturnszerosifimplementedinadevice.

Hosttransmit: 7F 80 01 10 60 02
SlaveReply: 7F 80 04 F0 00 00 00 98 C1

ReturnsCOMMANDNOTKNOWNinunsupporteddevices.

Hosttransmit: 7F 80 01 10 60 02
SlaveReply: 7F 80 02 F0 F2 10 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

LastRejectCode 0x17 23

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB,SMARTPAYOUT

Description

ReturnsaonebytecoderepresentingthereasontheBNVrejectedthelastnote.SeeReject
Codetablefordetails.

Packetexamples

Noterejectedduetoarequestbythehost

Hosttransmit: 7F 80 01 17 71 82
SlaveReply: 7F 80 02 F0 08 0C 20
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

Hold 0x18 24

Implementedon EncryptionRequired

BV100,BV20,BV50,NV10USB,NV11,NV150,
optional
NV200,NV9USB

Description

SSPbanknotevalidatorsincludeapolltimeoutoffiveseconds.Ifanewpollisnotreceived
withinhthistime,thenanoteheldinescrowwillberejected.

Thehostmayrequirethatthenoteiscontinuedtobeheld,butanewpollwouldacceptthe
note.

Sendthiscommandtoresetthetimeoutandcontinuetoholdthenoteinescrowuntilsuch
timeaseitherarejectorpollcommandissent.

Packetexamples

ReturnsOKifnoteisinescrow

Hosttransmit: 7F 80 01 18 53 82
SlaveReply: 7F 80 01 F0 23 80

ReturnsFAILifnonoteinescrow

Hosttransmit: 7F 80 01 18 53 82
SlaveReply: 7F 80 01 F8 10 00
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetBarcodeReaderConfiguration 0x23 35

Implementedon EncryptionRequired

NV12,NV150,NV200,SMARTPAYOUT optional

Description

Returnsthesetupdataforthedevicebarcodereaders.

Responds(ifsupported)withfivebytesofdataformattedas:

byte function size

0 GenericOK 1

Barcodehardwarestatus(0x00=none,0x01=Topreaderfitted,0x02=
1 Bottomreader 1
fitted,0x03=bothfitted)

2 Readersenabled(0x00=none,0x01=top,0x02=bottom,0x03=both) 1

3 Barcodeformat(0x01=Interleaved2of5) 1

4 Numberofcharacters(Min6max24) 1

Packetexamples

Responsefordevicewithtopandbottomreadersfitted,bothenabled,interleaved2of5with
18chars

Hosttransmit: 7F 80 01 23 CA 02
SlaveReply: 7F 80 05 F0 03 03 01 12 D5 58
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetBarcodeReaderConfiguration 0x24 36

Implementedon EncryptionRequired

NV12,NV150,NV200,SMARTPAYOUT optional

Description

Thiscommandallowsthehosttosetupthebarcodereader(s)configurationonthedevice.

Threebytesofdatadefinetheconfiguarion:

byte function size

0x00Enablenone,0x01enabletop,0x02=enablebottom,0x03=enable
0 1
both

1 Barcodeformat(0x01=Interleaved2of5) 1

2 Numberofcharacters(Min6Max24) 1

Packetexamples

Enablebothreaderswithformatinterleaved1of5for18characters.

Hosttransmit: 7F 80 04 24 03 01 12 EC D7
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetBarcodeInhibit 0x25 37

Implementedon EncryptionRequired

NV12,NV150,NV200,SMARTPAYOUT optional

Description

Commandtoreturnthecurrentbarcode/currencyinhibitstatus.

Ifsupported,respondswith1bytebitregsiterdata:

bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0

not not not not not not


barcodereadenable currencyreadenable
used used used used used used
(0=enabled) (0=enabled)
1 1 1 1 1 1

Packetexamples

Aresponsefromadevicewithbarcodedisabled,currencyenabled

Hosttransmit: 7F 80 01 25 DE 02
SlaveReply: 7F 80 02 F0 FE 38 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetBarcodeInhibit 0x26 38

Implementedon EncryptionRequired

NV12,NV150,NV200,SMARTPAYOUT optional

Description

Setsupthebarcodeinhibitstatusregister.

Sendasingledatabitregisterbyteformattedas:

bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0

not not not not not not currencyreadenable


barcodereadenable
used used used used used used (0=enabled)
(0=enabled)
1 1 1 1 1 1

Packetexamples

Showsarequesttoenabledbarcode,disablecurrencyonthedevice

Hosttransmit: 7F 80 02 26 FD 3E D6
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetBarcodeData 0x27 39

Implementedon EncryptionRequired

NV12,NV150,NV200,SMARTPAYOUT optional

Description

Commandtoobtainlastvalidbarcodeticketdata,sendinresponsetoabarcodeticket
validatedevent.Thiscommandwillreturnavariablelengthdatasteam,agenericresponse
(OK)followedbyastatusbyte,abarcodedatalengthbyte,thenastreamofbytesofthe
ticketdatainASCII.

Responseisformattedas:

byte function size

0 GenericOK 1

Status(0=novaliddata,1=ticketinescrow,2=ticketstacked,3=ticket
1 1
rejected)

2 datalength 1

3 variablelengthASCIIarrayofbarcodedata v

Packetexamples

showsticketisinescrowwithdatalength6anddata123456.

Hosttransmit: 7F 80 01 27 D1 82
SlaveReply: 7F 80 09 F0 01 06 31 32 33 34 35 36 A1 05
ascii: . . . 1 2 3 4 5 6
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

ConfigureBezel 0x54 84

Implementedon EncryptionRequired

NV200,SMARTPAYOUT optional

Description

ThiscommandallowsthehosttoconfigureasupportedBNVbezel.

InNV200firmware4.28anextraoptionalbytewasaddedtospecifythebezeltype.

Commandformat:

byte function size

0 redpwm(0255) 1

1 greenpwm(0255) 1

2 bluepwm(0255) 1

3 Config0forvolatile,1fornonvolatile. 1

OptionalBezelType(0EnableSolidColour,1EnableFlashingColour,2
4 1
DisableColour)

Packetexamples

Inthisexample,wewantaredbezelfixedtoEEPROM.

Hosttransmit: 7F 80 05 54 FF 00 00 01 48 DC
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

PollWithAck 0x56 86

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
NV10USB,NV11,NV150,NV200,NV9USB,
yes
SMARTHOPPER,SMARTPAYOUT,SMART
SYSTEM,SMARTTICKET

Description

AcommandthatbehavesinthesamewayasthePollcommandbutwiththiscommand,the
specifiedeventswillneedtobeacknowledgedbythehostusingtheEVENTACKcommand
(0x56).

TheeventswillrepeatuntiltheEVENTACKcommandissentandtheBNVwillnotallowany
furthernoteactionsuntiltheeventhasbeenclearedbytheEVENTACKcommand.Ifthis
commandisnotsupportedbytheslavedevice,thengenericresponse0xF2willbereturned
andstandardpollcommand(0x07)willhavetobeused.

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

EventAck 0x57 87

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
NV10USB,NV11,NV150,NV200,NV9USB,
yes
SMARTHOPPER,SMARTPAYOUT,SMART
SYSTEM,SMARTTICKET

Description

ThiscommandwillcleararepeatingPollACKresponseandallowfurthernoteoperations.

Packetexamples

Hosttransmit: 7F 80 01 57 F2 03
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetDenominationRoute 0x3B 59

Implementedon EncryptionRequired

NV11,SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Thiscommandwillconfigurethedenominationtobeeitherroutedtothecashboxon
detectionorstoredtobemadeavailableforlaterpossiblepayout.

Noteonprotocolversions:Forprotocolversionslessthan6avalueonlydataarray
issent.Forprotocolversiongreaterorequalto6,a3bytecountrycodeisalso
senttoallowmulitcurrencyfunctionalitytothepayout.

PleasenotethatthereexistsadifferenceinthedataformatbetweenSMART
PayoutandSMARTHopperforprotocolversionslessthan6.Intheseprotocol
versionsthevaluewasdeterminedbya2bytearrayratherthan4bytearrayfor
SMARTHopper.

ForNV11devicesthehostmustsendtherequirednotevalueinthesameformthatthe
deviceissettoreportby(seeSetValueReportingTypecommand).

Protocolversionlessthan6commandformat:

byte function size

0 requestedroute(0=payout,1=cashbox) 1

1 value(2bytesforhopper,4bytesforothers) 2or4

Protocolversiongreaterofequalto6format:

byte function size

0 requestedroute(0=payout,1=cashbox) 1

valueofrequesteddenominationtoroute(4byte
1 4
integer)

5 ASCIIcountrycodeofrequesteddenomination 3

Withnotepayouts,thedevicerespondswithCOMMANDCANNOTBEPROCESSEDandan
errorbyteforrequestfailure:

Error code

Nopayoutconnected 1

Invalidcurrencydetected 2

Payoutdevicefailure 3


Packetexamples

Anexampleofarequesttoroutea10cEURcointobestoredforpayoutusingprotocolversion
6

Hosttransmit: 7F 80 09 3B 00 0A 00 00 00 45 55 52 08 43
SlaveReply: 7F 80 01 F0 23 80

ExamplecommandwitherrorresponseInvalidcurrencydetected

Hosttransmit: 7F 80 09 3B 00 0A 00 00 00 45 55 52 08 43
SlaveReply: 7F 80 02 F5 02 30 3E
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetDenominationRoute 0x3C 60

Implementedon EncryptionRequired

NV11,SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Thiscommandallowsthehosttodeterminetherouteofadenomination.
Noteprotocolversions:
Forprotocolversionslessthan6avalueonlydataarrayissent.Forprotocolversiongreater
orequalto6,a3bytecountrycodeisalsosenttoallowmulticurrencyfunctionalitytothe
payout.

PleasenotethatthereexistsadifferenceinthedataformatbetweenSMART
PayoutandSMART
Hopperforprotocolversionslessthan6.Intheseprotocolversionsthevaluewas
determinedbya2bytearrayratherthan4bytearray
ForNV11devicesthehostmustsendtherequirednotevalueinthesameformthatthe
deviceissettoreportby(seeSetValueReportingTypecommand).

Protocolversionlessthan6commandformat:

byte function size

0 value(2bytesforhopper,4bytesforothers) 2or4

Protocolversiongreaterofequalto6format:

byte function size

valueofrequesteddenominationtoroute(4byte
0 4
integer)

3
4 ASCIIcountrycodeofrequesteddenomination

Thedevicerespondswithadatabyterepresentingthecurrentrouteofthedenomination.

byte function size

0 GenericOK 1

1 Route(0=recycleforpayout,1=systemcashbox) 1

Withnotepayouts,thedevicerespondswithCOMMANDCANNOTBEPROCESSEDandan
errorbyteforrequestfailure:
Error code

Nopayoutconnected 1

Invalidcurrencydetected 2

3
Payoutdevicefailure

Packetexamples

ThisexampleshowsarequesttoobtaintherouteofEUR5.00noteinprotocolversion6.
Returns0forpayout.

Hosttransmit: 7F 80 08 3C F4 01 00 00 45 55 52 2F 0E
SlaveReply: 7F 80 02 F0 00 3F A0
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

PayoutAmount 0x33 51

Implementedon EncryptionRequired

SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Acommandtosetthemonetaryvaluetobepaidbythepayoutunit.

Thiscommandwasexpandedafterandincludingprotocolversion6toinclude
countrycodesandpayouttestoption.

Commandformatprotocolversionlessthan6:

byte function size

payoutvalue(4byteintegerofthefullpenny
0 4
amount)

Commandformatprotocolgreaterthanorequalto6:

byte function size

payoutvalue(4byteintegerofthefullpenny 4
0
amount)

4 ASCIIcountrycodeofcurrencytopay 3

Optionbyte(TEST_PAYOUT_AMOUT0x19,
8 1
PAYOUT_AMOUNT0x58),

Forrequestfailure,thedevicerespondswithCOMMANDCANNOTBEPROCESSEDandadata
byteshowingthe
errorcode.

Error Code

Notenoughvalueindevice 1

Cannotpayexactamount 2

Devicebusy 3

Devicedisabled 4

Packetexamples
ShowsarequesttopayoutEUR5.00usingprotocolversion4

Hosttransmit: 7F 80 05 33 F4 01 00 00 32 50
SlaveReply: 7F 80 01 F0 23 80

ShowsanexampleisarequesttopayoutEUR5.00inprotocolversion6withcommitoption.

Hosttransmit: 7F 80 09 33 F4 01 00 00 45 55 52 58 C3 EE
SlaveReply: 7F 80 01 F0 23 80

ShowsanexampleisarequesttopayoutEUR5.00inprotocolversion6failedduetocannot
payexactamount

Hosttransmit: 7F 80 09 33 F4 01 00 00 45 55 52 58 C3 EE
SlaveReply: 7F 80 02 F5 02 30 3E
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetDenominationLevel 0x35 53

Implementedon EncryptionRequired

SMARTHOPPER,SMARTPAYOUT,SMART
optional
SYSTEM

Description

Thiscommandreturnsthelevelofadenominationstoredinapayoutdeviceasa2byte
value.

Thiscommandwasexpandedinprotocolversion6toincludecountrycodesformulti
currencyfunctionality.

Protocolversion5commandformat:

byte function size

0 4bytevalueofdenominationrequested 4

Protocolversion6andgreatercommandformat:

byte function size

4
0 4bytevalueofdenominationrequested

4 ASCIIcountrycodeofdenominationrequired 3

Packetexamples

Exampleshowsarequesttofindtheamountof0.10ccoinsinprotocolversion5.Returnsa
levelof100

Hosttransmit: 7F 80 05 35 0A 00 00 00 1E 49
SlaveReply: 7F 80 03 F0 64 00 C5 F0

ShowsarequesttofindthelevelofEUR5.00notesusingprotocolversion6.Returns12.

Hosttransmit: 7F 80 08 35 F4 01 00 00 45 55 52 19 9E
SlaveReply: 7F 80 03 F0 0C 00 C3 80

Ifthedenominationisnotinthedevice,itwillrespondwithCOMMANDCANNOTBE
PROCESSED

Hosttransmit: 7F 80 08 35 F4 01 00 00 45 55 52 19 9E
SlaveReply: 7F 80 01 F5 3D 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetDenominationLevel 0x34 52

Implementedon EncryptionRequired

SMARTHOPPER,SMARTSYSTEM yes

Description

Acommandtoincrementthelevelofcoinsofadenominationstoredinthehopper.The
commandisformattedwiththecommandbytefirst,amountofcoinstoaddasa2byte
littleendian,thevalueofcoinas2bytelittleendianand(ifusingprotocolversion6)the
countrycodeofthecoinas3byteASCII.Thelevelofcoinsforadenominationcanbesetto
zerobysendingazerolevelforthatvalue.

Thiscommandwasupdatedwhenusingversion6andgreatertoallowforlarger4
bytecoinvaluesandcountrycodes.

Protocolversionlessthan6:

byte function size

numberofcoinstoaddtolevel(0willclearthe
0 2
level)

2 valuefodenimonationtoset 2

Protocolversiongreatorequalto6:

byte function size

numberofcoinstoaddtolevel(0willclearthe
0 2
level)

4
2 valueofdenominationtoset

6 ASCIIcountrycodeofdenomination 3

Packetexamples

Exampletoincreasethelevelof.50ccoinby20usingprotocolversion5

Hosttransmit: 7F 80 05 34 14 00 32 00 63 FD
SlaveReply: 7F 80 01 F0 23 80

ExampletoincreasethelevelofEUR1.00coinsby12onadevicesetwithprotocolversion6

Hosttransmit: 7F 80 0A 34 0C 00 64 00 00 00 45 55 52 C7 28
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

HaltPayout 0x38 56

Implementedon EncryptionRequired

SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Acommandtostoptheexecutionofanexistingpayout.Thedevicewillstoppayoutatthe
earliestconvenientplaceandgenerateaHaltedeventgivingthevaluepaiduptothatpoint.

Packetexamples

Okresponseforhaltcommandaccepted.

Hosttransmit: 7F 80 01 38 90 02
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

FloatAmount 0x3D 61

Implementedon EncryptionRequired

SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Acommandtofloatthepayoutunittoleavearequestedvalueofmoney,witharequested
minimumpossiblepayoutlevel.Allmoniesnotrequiredtomeetfloatvalueareroutedto
cashbox.Usingprotocolversion6,thehostalsosendsapretestoptionbyte
(TEST_FLOAT_AMOUT0x19,FLOAT_AMOUNT0x58),whichwilldetermineifthecommand
amountistestedorfloated.Thisisusefulformultipayoutsystemssothattheabilitytopay
asplitdownamountcanbetestedbeforecommittingtoactualfloat.

Thiscommandwasexpandedafterandincludingprotocolversion6toinclude
countrycodesandpayouttestoption.

Commandformatprotocolversionlessthan6:

byte function size

0 valueofminimumpayouttoremain 2

2 floatvalue(4byteintegerofthefullpennyamount) 4

Commandformatprotocolgreaterthanorequalto6:

byte function size

0 valueofminimumpayouttoremain 2

payoutvalue(4byteintegerofthefullpenny 4
2
amount)

6 ASCIIcountrycodeofcurrencytopay 3

Optionbyte(TEST_FLOAT_AMOUT0x19,
9 1
FLOAT_AMOUNT0x58),

Forrequestfailure,thedevicerespondswithCOMMANDCANNOTBEPROCESSEDandadata
byteshowingthe
errorcode.
Error Code

Notenoughvalueindevice 1

Cannotpayexactamount 2

Devicebusy 3

4
Devicedisabled

Packetexamples

Exampletorequesttofloattoavalueof100.00leavingaminpossiblepayoutof0.50cfor
protocolversion5

Hosttransmit: 7F 80 07 3D 32 00 10 27 00 00 1D 1C
SlaveReply: 7F 80 01 F0 23 80

Inprotocolversiongreaterthan6,weadda3byteasciicountrycodeandatestorcommit
databyte.InthisexamplearequesttofloattoavalueofEUR100.00leavingaminpossible
payoutof0.50c

Hosttransmit: 7F 80 0B 3D 32 00 27 10 00 00 45 55 52 58 A7 DA
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetMinPayout 0x3E 62

Implementedon EncryptionRequired

SMARTHOPPER,SMARTPAYOUT,SMART
optional
SYSTEM

Description

Acommandtorequesttheminimumpossiblepayoutamountthatthisdevicecanprovide.

Forprotocolversionslessthan6,noparametersaresent.

Forprotocolversion6orgreater,weaddthe3bytecountrycodeofthecountryweare
requesting.

Packetexamples

Exampleforprotocolversion5returningminpayoutof200

Hosttransmit: 7F 80 01 3E 84 02
SlaveReply: 7F 80 05 F0 C8 00 00 00 A7 C2

Protocolversion6examplereturningaminpayoutvalueof5.00EUR

Hosttransmit: 7F 80 04 3E 45 55 52 14 E3
ascii: . . > E U R . .
SlaveReply: 7F 80 05 F0 F4 01 00 00 BA 72
ascii: . . . . .
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetCoinMechInhibits 0x40 64

Implementedon EncryptionRequired

SMARTHOPPER,SMARTSYSTEM yes

Description

Thiscommandisusedtoenableordisableacceptanceofindividualcoinvaluesfromacoin
acceptorconnectedtothehopper.

Protocolversionslessthan6:

byte function size

0 Requestedinhibitstate(0=inhibit,1=enable) 1

1 coinvalue(2byteinteger) 2

Protocolversionsgreaterorequalto6:.

byte function size

0 Requestedinhibitstate(0=inhibit,1=enable) 1

2
1 coinvalue(2byteinteger)

3 ASCIIcountrycodeofvalue 3

Packetexamples

ExamplewewanttoenableacceptanceofEUR0.50ccoinsinprotocolversion6.

Hosttransmit: 7F 80 07 40 01 32 00 45 55 52 CA 5E
ascii: . . @ . 2 . E U R . ^
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

PayoutByDenomination 0x46 70

Implementedon EncryptionRequired

SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Acommandtopayouttherequestedquantityofindividualdenominations.

RequiresProtocolVersion6orabove.
Attemptingtousethecommandwithanearlierprotocolversionwillgeneratea
response0xF4(parameteroutofrange).

Thequantitiesofdenominationstopayaresentasa2bytelittleendianarraythemoney
valuesas4bytelittleendianarrayandthecountrycodeasa3byteASCIIarray.

Thehostalsoaddsanoptionbytetotheendofthecommandarray(TEST_PAYOUT_AMOUT
0x19orPAYOUT_AMOUNT0x58).Thiswillallowapretestoftheabilitytopayout
therequestedlevelsbeforeactualpayoutexecutes.

Commandformat:

byte function size

0 thenumberofindividualrequestsinthiscommand(max20) 1

1 thenumbertopay 2

3 thedenominationvalue 4

7 thedenominationASCIIcountrycode 3

10 repeatblockforeachrequireddenomination

Theoptionbyte(TEST_FLOAT_AMOUT0x19orFLOAT_AMOUNT0x58). 1

Forrequestfailure,thedevicerespondswithCOMMANDCANNOTBEPROCESSEDandadata
byteshowingthe
errorcode.

Error Code

Notenoughvalueindevice 1

Cannotpayexactamount 2

Devicebusy 3

4
Devicedisabled

Packetexamples
ExampleAhopperunithasstored100x0.10EUR,50x0.20EUR,30x1.00EUR,10x1.00
GBP,50x0.50GBPandthehostwishestopayoutto5x1.00EUR,5x0.10EUR,3x1.00
GBPand2x0.50GBP.

Hosttransmit: 7F 80 27 46 04 04 00 64 00 00 00 45 55 52 05 00 0A 00 00 00 45 55 52 03
00 64 00 00 00 47 42 50 02 00 32 00 00 00 47 42 50 58 94 B7
ascii: . ' F . . . d . . . E U R . . . . . . E U R .
. d . . . G B P . . 2 . . . G B P X . .
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

FloatByDenomination 0x44 68

Implementedon EncryptionRequired

SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Acommandtofloat(leaveindevice)therequestedquantityofindividualdenominations.

RequiresProtocolVersion6orabove.
Attemptingtousethecommandwithanearlierprotocolversionwillgeneratea
response0xF4(parameteroutofrange).

Thequantitiesofdenominationstoleavearesentasa2bytelittleendianarraythemoney
valuesas4bytelittleendianarrayandthecountrycodeasa3byteASCIIarray.Thehost
alsoaddsanoptionbytetotheendofthecommandarray(TEST_PAYOUT_AMOUT0x19or
PAYOUT_AMOUNT0x58).Thiswillallowapretestoftheabilitytofloattotherequested
levelsbeforeactualfloatexecutes.

Commandformat:

byte function size

0 thenumberofindividualrequestsinthiscommand(max20) 1

1 thenumberrequiredtoleaveindevice(littleendianarray) 2

3 thedenominationvalue(littleendianarray) 4

7 thedenominationASCIIcountrycode 3

10... repeatblockforeachrequireddenomination

last Theoptionbyte(TEST_FLOAT_AMOUT0x19orFLOAT_AMOUNT0x58). 1

Forrequestfailure,thedevicerespondswithCOMMANDCANNOTBEPROCESSEDandadata
byteshowingthe
errorcode.

Error Code

Notenoughvalueindevice 1

Cannotpayexactamount 2

Devicebusy 3

4
Devicedisabled

Eventsusedtoindicateprogress:
Whilefloatingisbeingcarriedout,theFloatingandFloatedeventsareusedtokeepthehost
informed.

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

EmptyAll 0x3F 63

Implementedon EncryptionRequired

NV11,SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Thiscommandwilldirectallstoredmoniestothecashboxwithoutreportinganyvalueand
resetallthestoredcounterstozero.SeeSmartEmptycommandtorecordthevalue
emptied.

ApollcommandduringthisprocesswillrespondwithEmptyingandEmptyevents

Packetexamples

Commandformat(noparameters)foracknowledgedrequest.

Hosttransmit: 7F 80 01 3F 81 82
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetOptions 0x50 80

Implementedon EncryptionRequired

SMARTHOPPER,SMARTSYSTEM yes

Description

ThehostcansetthefollowingoptionsfortheSmartHopper.Theseoptionsdonotpersistin
memoryandafteraresettheywillThiscommandisvalidonlywhenusingprotocolversion
6orgreater.

TablebelowshowstheavailableoptionsfortheSMARTHopper.Thecommanddatais
formattedasa2byteregisterREG_0andREG_1
Reg_0bitsandtheirmeaning

Bit parameter

Splitbyhighestvalue(0x00)Thedevicewillattempttopayoutarequested
valueby
startingfromthehighesttothelowestcoinsavailable.Thismodewillpayout
the
minimumnumberofcoinspossible.Freepay(0x01)(Defaultstateafterreset).
The
0 paymode
devicewillpayoutacoinasitpassesitsdiscriminatorsystemifitfitsintothe
current
payoutvalueandwillleaveenoughofothercoinstopayouttherestofthe
value.This
maygiveafasterpayoutbutcouldresultinalargenumberofcoinsofsmall
denominationspaidout.

Disabled(0x00).Thedevicewillnotrefertothelevelcounterswhen
calculatingifa
payoutvaluecanbemade.Enabled(0x01)(Defaultstateafterreset).The
1 levelcheck devicewill
checkthelevelcountersandacceptorrefuseapayoutrequestbasedonlevels
and/or
splitofavailablelevels.

Lowspeed(0x00).Payoutsrunatalowermotorspeed.HighSpeed(Default
2 motorspeed state
afterreset)(0x01).Themotorsrunatmaxspeedforpayouts.

ThisbitisusedinconjunctionwithBit0.Ifbit3iszero,thenthePaymodes
willbeas
cashboxpay
3 describedinbit0.IfBit3issetthencoinsroutedtothecashboxwillbeused
active
incoins
paidoutofthefrontiftheycanfitintothecurrentpayoutrequest.

Route0level Setto1meansthatanycoinsdetectedwithalevelsettingof0willbepaidto
4 coinsto the
cashbox cashbox,evenifitisroutedtothepayout

Setto1toenableamoreefficient,smartercoinpayoutalgorithmwhichwill
High
5 tendtousecoinswhichhavehigherlevelcountsthusspeedingupthepayout
efficiencysplit
process

Unknownto Setto1meansanyunknowncoinswillbepaidoutduringSmartEmpty
6
payout (otherwisetheywillberoutedtocashbox)

7 Valueadded setto0forcoinaddedeventsetto1forvalueaddedevent

REG_1:requiredbutnotusedsobitssetto0.

Response

Whenrespondingtothiscommand,theSmartHopperreturnsabytewhichindicatesthe
currentoperationalmodeasfollows:

SetOptions:ResponseCodes

Code Meaning

0xFC Highestsplit,usecoinsroutedtocashboxinthesplit

0xFD Freepay,usecoinsroutedtocashboxinthesplit

0xFE Highestsplit

0xFF Freepay

Packetexamples

Theexampleshowsarequesttoturnofflevelcheck,runathighspeedandsplitbyhighest
value.

Hosttransmit: 7F 80 03 50 04 00 40 38
SlaveReply: 7F 80 02 F0 FE 38 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetOptions 0x51 81

Implementedon EncryptionRequired

SMARTHOPPER,SMARTSYSTEM yes

Description

Thiscommandreturns2optionregisterbytesdescribedinSetOptionscommand.

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

CoinMechGlobalInhibit 0x49 73

Implementedon EncryptionRequired

SMARTHOPPER,SMARTSYSTEM yes

Description

Thiscommandallowsthehosttoenable/disabletheattachedcoinmechinonecommand
ratherthanbyeachindividualvaluewithpreviousfirmwareversions.Sendthiscommand
andoneModedatabyte:Databyte=0x00mechdisabled.Datebyte=0x01mech
enabled.

Packetexamples

Inthisexamplewearesendingacommandtoenablethecoinmech.

Hosttransmit: 7F 80 02 49 01 33 36
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SmartEmpty 0x52 82

Implementedon EncryptionRequired

NV11,SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

Emptiespayoutdeviceofcontents,maintainingacountofvalueemptied.Thecurrenttotal
valueemptiedisgivenisresponsetoapollcommand.Allcoincounterswillbesetto0after
runningthiscommand.UseCashboxPayoutOperationDatacommandtoretrieve
abreakdownofthedenominationsroutedtothecashboxthroughthisoperation.

Packetexamples

Hosttransmit: 7F 80 01 52 EC 03
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

CashboxPayoutOperationData 0x53 83

Implementedon EncryptionRequired

NV11,SMARTHOPPER,SMARTPAYOUT,SMART
yes
SYSTEM

Description

CanbesentattheendofaSMARTEmpty,floatordispenseoperation.Returnstheamount
emptiedtocashboxfromthepayoutinthelastdispense,floatoremptycommand.

Responseformat:

byte function size

0 genericOK 1

1 numberofdenominationsinreport 2

3 qtyofdenomination 2

6 denominationvalue 4

10 denominationcountry(ASCII) 3

... repeatedaboveblockforeachdenomination ...

... qauntityofunknown 4

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetAllLevels 0x22 34

Implementedon EncryptionRequired

SMARTHOPPER,SMARTPAYOUT,SMART
optional
SYSTEM

Description

Usethiscommandtoreturnallthestoredlevelsofdenominationsinthedevice(including
thoseatzerolevel).
Thisgivesafasterresponsethansendingeachindividualdenominationlevelrequest.

Responsedataconsistsofblocksofninebytesdataforeachdenimonationinthedevice:

byte function size

0 GenericOK 1

1 numberofdenominationsinthedevice 1

2 levelofdenominationstored 2

4 denominationvalue(4bytelittleendianinteger) 4

7 denominationcode(3ByteASCII) 3

10.. Repeatforeachdenomination 9

Packetexamples

Inthisexample,wehaveadevicecoindatasetofEUROswith20c,50c,1EURand2EUR.It
currentlyhas100x20c,65x50x,0x1EURand12x2EUR.

Hosttransmit: 7F 80 01 22 CF 82
SlaveReply: 7F 80 26 F0 04 64 00 14 00 00 00 45 55 52 41 00 32 00 00 00 45 55 52 00
00 64 00 00 00 45 55 52 0C 00 C8 00 00 00 45 55 52 84 D0
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetCounters 0x58 88

Implementedon EncryptionRequired

NV11,NV9USB,SMARTPAYOUT,SMARTSYSTEM optional

Description

Acommandtoreturnaglobalnoteactivitycountersetfortheslavedevice.Theresponseis
formattedasinthetablebelowandthecountervaluesarepersistentinmemoryaftera
powerdownpowerupcycle.

Thesecountersarenotesetindependentandwillwraptozeroandbeginagainiftheir
maximumvalueisreached.Eachcounterismadeupof4bytesofdatagivingamaxvalue
of4294967295.

Responseformat:

byte function size

0 GenericOK 1

1 Numberofcountersinset 1

2 Stacked 4

6 Stored 4

10 Dispensed 4

14 Transferredtostack 4

18 Rejected 4

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

ResetCounters 0x59 89

Implementedon EncryptionRequired

NV11,NV9USB,SMARTPAYOUT,SMARTSYSTEM optional

Description

ResetsthenoteactivitycountersdescribedinGetCounterscommandtoallzerovalues.

Packetexamples

Commandformat(noparameters)foracknowledgedrequest.

Hosttransmit: 7F 80 01 59 D5 83
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetRefillMode 0x30 48

Implementedon EncryptionRequired

SMARTPAYOUT optional

Description

Acommandsequencetosetorresetthefacilityforthepayouttorejectnotesthatare
routedtothepayoutstorebutthefirmwaredeterminesthattheyareunsuitablefor
storage.Indefaultmode,theywouldbereroutedtothestacker.Inrefillmodetheywillbe
rejectedfromthefrontoftheNV200.

Packetexamples

Thisexampleshowthesequenceofcommandbytestosetthemode.

Hosttransmit: 7F 80 06 30 05 81 10 11 01 52 F5
SlaveReply: 7F 80 01 F0 23 80

Thissequencewillunsetthemodefornormaloperation.

Hosttransmit: 7F 80 06 30 05 81 10 11 00 57 75
SlaveReply: 7F 80 01 F0 23 80

Toreadthecurrentrefillmodesendthissequence:Returns1byte:0x00theoptionisnotset,
0x01theoptionisset.Thisshowsareturnwithoptionset.

Hosttransmit: 7F 80 05 30 05 81 10 01 94 EE
SlaveReply: 7F 80 02 F0 01 3A 20
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetNotePositions 0x41 65

Implementedon EncryptionRequired

NV11 yes

Description

ThiscommandwillreturnthenumberofnotesintheNoteFloatandthevalueineach
position.ThewaythevalueisreportedisspecifiedbytheSetReportingTypecommand.
Thevaluecanbereportedbyitsvalueorbythechannelnumberofthebillvalidator.The
firstnoteinthetableisthefirstnotethatwaspaidintotheNoteFloat.

TheNoteFloatisaLIFOsystem,sothenotethatislastinthetableistheonlyonethatis
availabletobepaidoutormovedintothestacker.

DataresponseformatwhenReportbyvalueisset:

byte function size

0 GenericOK 1

1 Numberofnotesstored 1

2 Valueofnoteinslot1 4

6 Valueofnoteinslot2 4

10 Valueofnoteinslot3 4

... continuesforhowmanynotesstored...

DataresponseformatwhenReportbychannelisset:

byte function size

0 GenericOK 1

1 Numberofnotesstored 1

2 Channelofnoteinslot1 1

3 Channelofnoteinslot2 1

4 Channelofnoteinslot3 1

... continuesforhowmanynotesstored...

Ifthecurrencyinthevalidatordoesnotmatchthecountryofthenotesstored,thenthis
commandwillrespondwithCOMMANDCANNOTBEPROCESSEDanderrorbyte2(Invalid
currency)

Packetexamples
Responseexamplefor2notesstorevalue5and10

Hosttransmit: 7F 80 01 41 85 83
SlaveReply: 7F 80 09 02 F4 01 00 00 E8 03 00 00 7D CF

ResponsegiventocommandwhenBNVcurrencydoesnotmatchstorednotecurrency.

Hosttransmit: 7F 80 01 41 85 83
SlaveReply: 7F 80 02 F5 02 30 3E
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

PayoutNote 0x42 66

Implementedon EncryptionRequired

NV11 yes

Description

TheNoteFloatwillpayoutthelastnotethatwasstored.Thisisthenotethatisinthe
highestpositioninthetablereturnedbytheGetNotePositionsCommand.Ifthepayoutis
possibletheNoteFloatwillreplywithgenericresponseOK.

IfthepayoutisnotpossiblethereplywillbegenericresponseCOMMANDCANNOT
BEPROCESSED,followedbyanerrorcodeshowninthetablebelow.

Error Code

notconnected 1

empty 2

busy 3

disabled 4

Packetexamples

Commandacknowledgedtopayoutfirstnoteinqueue.

Hosttransmit: 7F 80 01 42 8F 83
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

StackNote 0x43 67

Implementedon EncryptionRequired

NV11 yes

Description

TheNoteFloatwillstackthelastnotethatwasstored.Thisisthenotethatisinthehighest
positioninthetablereturnedbytheGetNotePositionsCommand.Ifthestackoperationis
possibletheNoteFloatwillreplywithgenericresponseOK.

IfthestackoperationisnotpossiblethereplywillbegenericresponseCOMMANDCANNOT
BEPROCESSED,followedbyanerrorcodeshowninthetablebelow.

Error Code

notconnected 1

empty 2

busy 3

4
disabled

Packetexamples

Commandacknowledgedtostackfirstnoteinqueue.

Hosttransmit: 7F 80 01 43 8A 03
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetValueReportType 0x45 69

Implementedon EncryptionRequired

NV11 yes

Description

Thiswillsetthemethodofreportingvaluesofnotes.Therearetwooptions,byafourbyte
valueofthenoteorbythechannelnumberofthevaluefromthebanknotevalidator.Ifthe
channelnumberisusedthentheactualvaluemustbedeterminedusingthedatafromthe
ValidatorcommandUnitData.Thedefaultoperationisby4bytevalue.Send0x00toset
Reportbyvalue,0x01tosetReportByChannel.

IfthesettingisnotpossiblethereplywillbegenericresponseCOMMANDCANNOT
BEPROCESSED,followedbyanerrorcodeshowninthetablebelow.

Error Code

notconnected 1

empty 2

busy 3

4
disabled

Packetexamples

exampletosetreportbyvalue

Hosttransmit: 7F 80 02 45 00 36 9E
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetGenerator 0x4A 74

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
NV10USB,NV11,NV150,NV200,NV9USB,
optional
SMARTHOPPER,SMARTPAYOUT,SMART
SYSTEM,SMARTTICKET

Description

PartoftheeSSPencryptionnegotiationsequence.

Eightdatabytesaresent.Thisisa64bitnumberrepresentingtheGeneratorandmustbea
primenumber.TheslavewillreplywithOKorPARAMETER_OUT_OF_RANGEifthenumber
isnotprime.

Packetexamples

Inthisexamplewearesendingtheprimenumber982451653.This=3A8F05C5hex

Hosttransmit: 7F 80 09 4A C5 05 8F 3A 00 00 00 00 B2 73
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetModulus 0x4B 75

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
NV10USB,NV11,NV150,NV200,NV9USB,
optional
SMARTHOPPER,SMARTPAYOUT,SMART
SYSTEM,SMARTTICKET

Description

PartoftheeSSPencryptionnegotiationsequence.

Eightdatabytesaresent.Thisisa64bitnumberrepresentingtheModulsandmustbea
primenumber.TheslavewillreplywithOKorPARAMETER_OUT_OF_RANGEifthenumber
isnotprime.

Packetexamples

Inthisexamplewearesendingtheprimenumber1287821.This=13A68Dhex

Hosttransmit: 7F 80 09 4B 8D A6 13 00 00 00 00 00 6C F6
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

RequestKeyExchange 0x4C 76

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
NV10USB,NV11,NV150,NV200,NV9USB,
optional
SMARTHOPPER,SMARTPAYOUT,SMART
SYSTEM,SMARTTICKET

Description

Theeightdatabytesarea64bitnumberrepresentingtheHostintermediatekey.Ifthe
GeneratorandModulushavebeensettheslavewillcalculatethereplywiththegeneric
responseandeightdatabytesrepresentingtheslaveintermediatekey.Thehostandslave
willthencalculatethekey.

IfGeneratorandModulusarenotsetthentheslavewillreplyFAIL.

Packetexamples

AnexampleofHostintermediatekeyof7554354432121=6DEE29CC879hex

Hosttransmit: 7F 80 09 4C 79 C8 9C E2 DE 06 00 00 9D 52
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

CoinMechOptions 0x5A 90

Implementedon EncryptionRequired

SMARTHOPPER,SMARTSYSTEM yes

Description

ThehostcansetthefollowingoptionsfortheSmartHopper.Theseoptionsdonotpersistin
memoryandafteraresettheywillgototheirdefaultvalues.

Bitfunction
0CoinMecherrorevents1=ccTalkformat,0=CoinmechjamandCoinreturnmechopen
only
1:7Unusedsetto0

IfcoinmecherroreventsaresettoccTalkformat,theneventCoinMechError0xB7isgiven
with1byteccTalk
coinmecherrorreasondirectlyfromcoinmechccTalkeventqueue.Otherwiseonlyerror
eventsCoinMech
Jam0xC4andCoinMechReturn0xC5aregiven.

Packetexamples

Inthisexamplewesendregisterbyteconfiguredtoreturncctalkstyleevents.

Hosttransmit: 7F 80 02 5A 01 30 DC
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetBuildRevision 0x4F 79

Implementedon EncryptionRequired

NV11,NV200,SMARTHOPPER,SMARTPAYOUT,
optional
SMARTSYSTEM

Description

Acommandtoreturnthebuildrevisioninformationofadevice.Thecommandreturns3
bytesofinformationrepresentingthebuildoftheproduct.

Byte0istheproducttype,nexttwobytesmakeuptherevisionnumber(065536).
ForNV200andNv9usb,thetypebyteis0,forNoteFloat,byteis3andforSMARTPayout
thebyteis6.

Packetexamples

ThisexampleisfromanNV200(issue20)withpayoutattached(issue21).

Hosttransmit: 7F 80 01 4F A2 03
SlaveReply: 7F 80 07 F0 00 14 00 06 15 00 0F 97
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

EnablePayoutDevice 0x5C 92

Implementedon EncryptionRequired

NV11,SMARTPAYOUT yes

Description

Acommandtoenabletheattachedpayoutdeviceforstoring/payingoutnotes.Asuccessful
enablewillreturnOK,Ifthereisaproblemthereplywillbegenericresponse
COMMAND_CANNOT_BE_PROCESSED,followedbyanerrorcode.

ForNV11devices,thiscommandusesanadditiondatabyte,abitregisterallowssome
optionstobeset.

bit function

GIVE_VALUE_ON_STORED.Setto1toenablethevalueofthenotestoredtobe
0 givenwiththeNoteStoredevent

NO_HOLD_NOTE_ON_PAYOUT.Setto1toenablethefunctionoffullyrejecting
1
thedispensedbanknoteratherthenholdingitinthebezel.

2:7 Unusedsetto0

ForSMARTPayoutdeviceswithfirmwaregreaterorequalto4.16,thiscommandusesan
additiondatabyte.Abitregisterallowssomeoptionstobeset.

bit function

REQUIRE_FULL_STARTUP.Ifsetto1,theSmartPayoutwillreturnbusyuntilit
hasfullycompletedthe
0
startupprocedure

OPTIMISE_FOR_PAYIN_SPEED.Ifsetto1TheSmartPayoutwillalwaysmove
1 towardsanemptyslot
whenidletotryandensuretheshortestpayinspeedpossible.

Unusedsetto0
2:7

ThedevicerespondswithCOMMANDCANNOTBEPROCESSEDandanerrorbyteforfailure
toenable.

error code

Nodeviceconnected 1

Invalidcurrencydetected 2

Busy 3

Emptyonly(Notefloatonly) 4

Deviceerror 5
Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

DisablePayoutDevice 0x5B 91

Implementedon EncryptionRequired

NV11,SMARTPAYOUT yes

Description

Allacceptednoteswillberoutedtothestackerandpayoutcommandswillnotbeaccepted.

Packetexamples

Commandformat(noparameters)foracknowledgedrequest.

Hosttransmit: 7F 80 01 5B DA 03
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

CommsPassThrough 0x37 55

Implementedon EncryptionRequired

SMARTHOPPER,SMARTSYSTEM optional

Description

TheSMARTHopperincludestwoserialconnectionsandthiscommandenablestheuserto
converteitheroftheseintoaUSBtoserialconvertorsothatthehostcancommunicate
directlywithperiferlaconnectedtotheseports.

Thismaybeusfulforupdatingorspecialconfigurationsoutsideofthescopeoftheusual
SMARTHoppertoperiferalprotocols.

Commanddataformat:

byte function size

0 UARTselect(0SSPUart,1cctalkUART) 1

OncethiscommandissentthedevicewillrespondwithOK(0xF0)andfromthenallserial
dataviatheUSBwillberoutedtotheperiferalportdirectly.

Toexitthismode,thehostwaitsforatleast500mssincethelastcommunicationthen
sendsbytearray0x55,0xAA,0xAA,0x55waitsfor500msandthensendsthearrayagain.
Thedevicewillthenresetandcommunicationswillrestoretonormal.

Packetexamples

Commandformat(noparameters)foracknowledgedrequest.

Hosttransmit: 7F 80 01 37 B2 02
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetBaudRate 0x4D 77

Implementedon EncryptionRequired

BV100,BV20,BV50,NV11,NV150,NV200,
SMARTHOPPER,SMARTPAYOUT,SMART optional
SYSTEM

Description

Thiscommandhastwodatabytestoallowcommunicationspeedtobesetonadevice.

byte function size

0 Requiredrate(0=9600,1=38400,2=15200) 1

Changepersist(1=changewillremainoverreset,0=ratesetstodefault
1 1
afterreset)

Thedevicewillrespondwith0xF0attheoldbaudratebeforechanging.Pleaseallowa
minimumof100millsecondsbeforeattemptingtocommunicateatthenewbaudrate.

Packetexamples

Inthisexample,wewanttosetthespeedto38400bdwithbuttoresettodefault(9600)on
reset.

Hosttransmit: 7F 80 03 4D 01 00 E4 27
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SspSetEncryptionKey 0x60 96

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
FLATBEDPRINTER,NV10USB,NV11,NV12,
yes
NV200,NV9USB,SMARTHOPPER,SMART
PAYOUT,SMARTSYSTEM,SMARTTICKET

Description

AcommandtoallowthehosttochangethefixedpartoftheeSSPkey.Theeightdatabytes
area64bitnumberrepresentingthefixedpartofthekey.Thiscommandmustbe
encrypted.

byte function size

0 newfixedkey64bit,8byte 8

Packetexamples

Exampletosetnewfixedkeyto0x0123456701234567

Hosttransmit: 7F 80 09 60 67 45 23 01 67 45 23 01 BF 6F
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SspEncryptionResetToDefault 0x61 97

Implementedon EncryptionRequired

BV100,BV20,BV50,COUPONPRINTER,
NV10USB,NV11,NV200,NV9USB,SMART
optional
HOPPER,SMARTPAYOUT,SMARTSYSTEM,
SMARTTICKET

Description

Resetsthefixedencryptionkeytothedevicedefault.Thedevicemayhaveextrasecurity
requirementsbeforeitwillacceptthiscommand(e.g.TheHoppermustbeempty)ifthese
requirementsarenotmet,thedevicewillreplywithCommandCannotbeProcessed.If
successful,thedevicewillreplyOK,thenreset.Whenitstartsupthefixedkeywillbethe
default.

Packetexamples

Commandformat(noparameters)foracknowledgedrequest.

Hosttransmit: 7F 80 01 61 46 03
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetRealTimeClockConfiguration 0x62 98

Implementedon EncryptionRequired

COUPONPRINTER,FLATBEDPRINTER,NV12,
optional
SMARTSYSTEM,SMARTTICKET

Description

ReturnstheconfigurationofthedeviceRealTimeClock.

Response
Thedevicerespondswith1databytegivingtheconfigurationoftheRTC.Data=0,theRTC
resetsonpowerupandthedate/timewillneedtobesetup.Data=1,thedate/timeis
persistantafterapowercycle.

Packetexamples

InthisexamplethedevicerespondsthattheRTCdoesnotholdit\'ssettingsafterapower
cycle.

Hosttransmit: 7F 80 01 62 4C 03
SlaveReply: 7F 80 02 F0 00 3F A0
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetRealTimeClock 0x64 100

Implementedon EncryptionRequired

COUPONPRINTER,FLATBEDPRINTER,NV12,
optional
SMARTSYSTEM,SMARTTICKET

Description

Sendsixbytesofparameterdatatosetthesystemtimeanddate.

Commanddataformat:

byte function size

0 GenericOK 1

1 Dayofmonth(131) 1

2 Monthofyear(112) 1

3 Year(099) 1

4 Hourofday(023) 1

5 Minuteofhour(059) 1

1
6 Secondofminute(059)

Packetexamples

Packetexampleforsettingsystemtimeto21stDecember201210:22:30

Hosttransmit: 7F 80 07 64 15 0C 0C 0A 16 1E AF EC
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetRealTimeClock 0x63 99

Implementedon EncryptionRequired

COUPONPRINTER,FLATBEDPRINTER,NV12,
optional
SMARTSYSTEM,SMARTTICKET

Description

GetsthecurrentsystemRTCdateandtime.Respondswith6bytesofdata.

Responseformat:

byte function size

0 GenericOK 1

1 Dayofmonth(131) 1

2 Monthofyear(112) 1

3 Year(099) 1

4 Hourofday(023) 1

5 Minuteofhour(059) 1

6 Secondofminute(059) 1

Packetexamples

Inthisexamplethesystemtimeis21stDecember201210:22:30

Hosttransmit: 7F 80 01 63 49 83
SlaveReply: 7F 80 07 F0 15 0C 0C 0A 16 1E EC F1
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetCashboxPayoutLimit 0x4E 78

Implementedon EncryptionRequired

SMARTHOPPER,SMARTSYSTEM yes

Description

Allowthehosttospecifyamaximumlevelofcoins,bydenomination,tobeleftinthe
hopper.

Duringanypayoutoperation,iftherearecoinsinthehopperinexcessofthesetlevels,
whentheyareencounteredontheconveyorbelttheywillbesenttothecashbox(beneath
thehopper).

Thismeansthatovertime(andmultiplepayoutoperations)anyexcesscoinswillbesentto
thecashboxandthedesiredlevelwillbeachieved.

Iteffectivelyallowsthehoppertodothe'floating'forthehostmachinei.e.itisanautofloat
mechanism.

NB:Ifacoinrouteischangedfromcashboxtopayoutandthenbacktocashboxthenthe
levelforthiscoinwillberesetto0(anyofthecoinswillthenbesenttocashbox).

Commandformat.

byte function size

0 Thenumberofindividualrequests 1

1 Thelevellimittoset 2

3 Thedenominationvalue 4

7 Thedenominationcountrycode(3byteASCII) 3

... Repeataboveblockforeachdenominationrequired ...

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

EnableTitoEvents 0x72 114

Implementedon EncryptionRequired

NV12,NV200 optional

Description

WhencommunicatingwiththeNV200attachedtotheprinter,optionaladditionalpollevents
maybeenabled.TheseareenabledbysendinganSSPpacketwiththecommandheader
0x72totheNV200.Pollswilltherespondwiththesameprinting(0xA5)andprinted(0xA6)
pollresponsesastheprinter.

Packetexamples

Commandformat(noparameters)foracknowledgedrequest.

Hosttransmit: 7F 40 01 72 2F 8C
SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

CoinStir 0x5D 93

Implementedon EncryptionRequired

SMARTSYSTEM yes

Description

MixesthecoinsbyperformsarotationoftheCoinHopperMotorforaspecifedtime.

Commandhas1parameter,abytevalue(1255)givingthetimeinsecondsforwhichtostir
thecoins.

Packetexamples

Stirthecoinsfor5seconds

Hosttransmit: 7F 80 02 5D 05 28 CE
SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

TicketPrint 0x70 112

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

TheTicketPrintcommandusesasystemofsubcommandstoallowthehosttosend
printercommandstothedevice.

Seethesubcommandlistfordetails.
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

AddStaticText(0101)

Encryptionrequired

yes

Description

Addsafixedtextitemtoatickettemplate,ortotheontheflyticketbuffer.

Thefonttouse,position,rotation,andtexttodisplayaresentwiththiscommand.The
templatenumbertoaddthistexttoisalsosent,andif0isusedforthis,theitemisadded
totheontheflybuffer.

Ifaddedtoanumberedtemplate,thetextitemwillbestoredintheselectedtemplatefile
andprintedeverytimethattemplateisprintedout.

Ifitisaddedtotheontheflybuffer,itwillbeprintedwhenthetheprintticketcommandis
calledwithatemplateparameterof0.Ifatemplatefileisprinted,itwilloverwritethe
contentsoftheontheflybufferandthetextwillbelost.

Themaximumnumberofcharaterstoprintis50.ThetexttodisplayissentwithUTF16
encoding.

Thefollowingtableshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 01 1 AddTextSubCommand

3 v 1 TemplatetoAddto(0foronthefly,1255forothertemplates)

4 v 1 FontindexID(0255)

5 v 1 Orientation(03,multiplesof90o)

6 v 2 16bitxPositionofText

8 v 2 16bityPositionofText

TheTexttoDisplay,EncodedasaUTF16String.Maximumof50
10 v v
Charaters(100bytes)


Packetexamples

Addthetext\"Hello\"totemplate1withnorotation,atposition20,25usingfont1

Host
7F 40 14 70 01 03 01 01 00 14 00 19 00 48 00 65 00 6C 00 6C 00 6F 00 1D E2
transmit:

Slave
7F 40 01 F0 23 8F
Reply:
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

AddPlaceHolderText(0102)

Encryptionrequired

yes

Description

Addsaplaceholderfortexttoatemplate.

ThistextcanthenbefilledinwiththeSetPlaceholderVariablecommand,allowingfor
thingssuchasdynamiccountersonaticketwhichchangeseverytimewhileprintingfrom
thesametemplate.Themaximumnumberofcharacterstoprintislimitedto50(100bytes
UTF16).

Thetablebelowshowsthecommandformat:

Byte Value(hex) Size Function

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 02 1 AddPlaceholderTextSubCommand

3 v 1 TemplatetoAddto(1255only,notallowedtoaddtoonthefly)

4 v 1 FontIndex(0255)

5 v 1 Orientation,(03,multiplesof90o)

6 v 2 16bitxPositionofText

8 v 2 16bityPositionofText

10 v 1 MaximumCharacterCount(max50)

11 v 1 ThePlaceHolderReferenceID(019)

Packetexamples

Exampletoaddthetextwithmax10characterstotemplate1usingfont2with0x90degreesofrotation
atposition20,25usingplaceholderindex1:

Hosttransmit: 7F 80 0C 70 01 02 01 02 00 14 00 19 00 0A 01 F7 9B

SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

AddStaticBarcode(0103)

Encryptionrequired

yes

Description

Addabarcodetotheticket.

Thisisdoneinthesamewayastext,andthenumbersarepassedasUTF16characters
ratherthanstraight
values.Thepassedinheightwillbetheheightofthebarcodeontheticket.Thewidth
representsthewidthof
asinglethinbarinthebarcode.Themaximumnumberofcharacterstoprintislimitedto
50(100bytesUTF16).

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 03 1 AddStaticBarcodeSubCommand

3 v 1 TemplatetoAddto(0foronthefly,1255forothertemplates)

TypeofBarcode:0x00=Interleaved2of5(onlycurrentlysupported
4 v 1
format)

5 v 1 Orientation(03,multiplesof90o)

6 v 2 16bitxPositionofBarcode

8 v 2 16bityPositionofBarcode

10 v 2 16bitWidthofBars

12 v 2 16bitHeightofBarcode

TheBarcodeNumber(UTF16),Maximumof50Characters(100
14 v v
bytes)

Packetexamples

Addthebarcode\"1234\"totemplate1with0x90degreesofrotationatposition20,25withbarwidth5
andheight120

Host
7F 40 16 70 01 03 01 00 00 14 00 19 00 05 00 78 00 31 00 32 00 33 00 34 00 2B C1
transmit:

Slave
7F 40 01 F0 23 8F
Reply:
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetImageSize(0502)

Encryptionrequired

optional

Description

Getsthearea,inpixels,thatanimagewilltakeuponaticket.Thewidthandheightofthe
imagearereturnedas16bitunsignedintegers.Thecommandassumesnorotation,andthe
imageistoberotated,thereturnedheightshouldbeusedaswidth,andthewidthasheight
inanylayoutcalculations.

Thefollwingtableshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 02 1 GetImageSizeSubCommand

3 v 1 ImageIndex(0255)

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitWidthofImage(inDots)

3 v 2 16BitHeightofImage(inDots)

Packetexamples

Getsthesizeofimageatindex5,andreturnsthesize30x40

Hosttransmit: 7F 40 04 70 05 02 05 32 CD

SlaveReply: 7F 40 04 1E 00 28 00 79 E9
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetBarcodeSize(0503)

Encryptionrequired

optional

Description

Calculatesandreturnsthewidth,inpixels,thatagivenbarcodewilltakeupontheticket.

Thewidthofthebarcodeisreturnedasa16bitunsignedinteger.Theheightisnot
calculatedorreturned,asthatissetdirectlybythecommandtoaddabarcode.

Thefollwingtableshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 03 1 GetBarcodeSizeSubCommand

TypeofBarcode:0x00=Interleaved2of5(onlycurrentlysupported
3 v 1
format)

4 v 1 TheWidthofanindividualbar

TheBarcodeNumber(UTF16),Maximumof50Characters(100
5 v v
bytes)

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitWidthofResultingBarcode

Packetexamples

Getsthesizeofabarcode\"1234\"andreturnsthesize256

Hosttransmit: 7F 40 0D 70 05 03 00 04 31 00 32 00 33 00 34 00 57 65

SlaveReply: 7F 40 03 F0 00 01 C6 0A
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetTicketResolution(0504)

Encryptionrequired

optional

Description

Getstheheightandwidththattheticketimageprintedcanbe,inpixels,foruseinsetting
thecoordinatesofprintedelements.Respondswitha16bitwidthand16bitheight.

Thefollowingtableshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 04 1 GetTicketResolutionCommand

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitWidth(x)ofTicket

2 v 2 16BitHeight(y)ofTicket

Packetexamples

Getsthe16bitxandyresolutionoftheticketat1096x520

Hosttransmit: 7F 40 03 70 05 04 DB 9E

SlaveReply: 7F 40 05 F0 48 04 08 02 C7 3E
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetFontInformation(0505)

Encryptionrequired

optional

Description

Getsinformationaboutafont.Returnsthe16bitmaxcharacterwidth,16bitmaxcharacter
height,16bitfontsize,1bytebold,1byteitallicandvariablelengthfontnamestring.

Thefollowingtableshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 05 1 GetFontInfoSubCommand

3 v 1 TheFontIndexID(0255)

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitMaximumCharacterWidthinPixels(inDots)

4 v 2 16BitMaximumCharacterHeightinPixels(inDots)

6 v 2 16BitFontSize

8 v 1 BoldFlag

9 v 1 ItalicFlag

10 v v ASCIIWindowsFontFilename


Packetexamples

Getsthefontinformationforfont2.Returnsinfoonafontwithsize10,maximumcharacterwidth15,
maximumcharacterheight28,andfilenameconsola

Hosttransmit: 7F 40 04 70 05 05 02 20 DF

SlaveReply: 7F 40 10 F0 0F 00 1C 00 0A 00 00 00 63 6F 6E 73 6F 6C 61 78 71
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetQrCodeDimensions(050C)

Encryptionrequired

optional

Description

FindtheheightandwidthindotsofaQRcode.

ThegetQRcodedimensionscommandcanbeusedtofindtheheightandwidthindotsofa
QRcodewithaparticularsetofdata(theheightandwidthwillalwaysbethesameasthe
QRCodeissquare.)Thiscanbemultipliedbythedotsizeyouintendtousetofindouthow
muchroomtheQRcodewilltakeupontheticket.

Thefollwingtableshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 SetupSubCommand

2 12 1 GetQRCodeDimensionsSubCommand

3 v 1 TheLengthoftheASCIIDatatobeUsed(1120)

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitWidthandHeightofQRCode(inDots)

Packetexamples

GetthesizeofaQRcodewithdataoflength21,returningasizeof25

Hosttransmit: 7F 80 04 70 05 12 15 9E AD

SlaveReply: 7F 80 02 F0 19 6A 20
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

PrintTicket(02)

Encryptionrequired

yes

Description

Printsaticketfromatemplateorontheflydata.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 02 1 PrintTicketSubCommand

2 v 1 TemplatetoPrint(1255)or0forOntheflyBuffer

Packetexamples

Tellthedevicetoprinttemplate7

Hosttransmit: 7F 40 03 70 02 07 D2 0C

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

PrintBlankTicket(03)

Encryptionrequired

yes

Description

Causesablank(noprint)tickettobedispensed.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 03 1 PrintBlankTicketSubCommand

Packetexamples

Hosttransmit: 7F 40 02 70 03 1E 20

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetTextSize(0501)

Encryptionrequired

optional

Description

Findstheamountofspaceatextstringwilltakeupontheticket.Returnsthewidthand
heightofthetextas16bitunsignedintegers.Assumesnorotation.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 GetInfoSubCommand

2 01 1 GetTextSizeSubCommand

3 v 1 FontindexID(0255)

TheUFT16textsringarraythatwillbeused(Max50characters
4 v v
(100bytes))

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitWidthofText(inDots)

3 v 2 16BitHeightofText(inDots)

Packetexamples

Getsthesizeofthetext\"WIN\"usingfont2,andreportsbackawidthof45,andheightof28

Hosttransmit: 7F 40 0A 70 05 01 02 57 00 49 00 4E 00 02 4A

SlaveReply: 7F 40 05 F0 2D 00 1C 00 8A 02
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

SetQrPlaceholder(010B)

Encryptionrequired

yes

Description

LoadthedesignatedQRplaceholderwiththesuppliedASCIIdata.

QRplaceholdervaluesaresetwithadifferentcommandtostandardones,asthedatafor
QRcodesisinASCIIformatandnotUTF16.TherearethreeQRplaceholderbuffers
available.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 0B 1 SetQRCodePlaceholderSubCommand

3 v 1 PlaceholderIndextoUse(02)

4 v v TheASCIIDatatoPlaceinthePlaceholder

Packetexamples

SetQRplaceholderindex0totest

Hosttransmit: 7F 80 08 70 01 0B 00 74 65 73 74 85 43

ascii: . . p . . . t e s t . C

SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

AddQrCode(0109)

Encryptionrequired

yes

Description

AddsaQRcodeimagetotheticket.

Thesize(heightandwidth,whicharealwaysthesameaseachother)ofthedotsissentin
thecommand.Unlikeotherticketdata,theinfowithintheQRcodeissendasASCIItext,as
opposetoUTF16.ThemaximumnumberofASCIIcharacterstheQRcodecanstoreis120.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 09 1 AddStaticQRCodeSubCommand

3 v 1 TemplatetoAddto(0foronthefly,1255forothertemplates)

4 v 1 DotSize(>=1)

5 v 1 Orientation(03,multiplesof90o)

6 v 2 16bitxPositionofQRCode

8 v 2 16bityPositionofQRCode

10 v v ASCIIData(1120characters)

Packetexamples

AddaQRcodetotemplate2,withadotsizeof4,norotation,atcoordinates50,50withthedatahello

Hosttransmit: 7F 80 0F 70 01 09 02 04 00 32 00 32 00 68 65 6C 6C 6F 57 2F

ascii: . . p . . . . . 2 . 2 . h e l l o W /

SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

AddQrPlaceholder(010A)

Encryptionrequired

yes

Description

AddsaplaceholderQRcodetotheticket.

PlaceholderQRcodesdonotusethesameplaceholderbuffersasotherplaceholderitems,
andtheirplaceholdersaresetwithadifferentcommand(detailedseparately.)The
maximumdatasizefortheQRcodeissentwiththecommand.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 0A 1 AddPlaceholderQRCodeSubCommand

3 v 1 TemplatetoAddto(1255only,notallowedtoaddtoonthefly)

4 v 1 DotSize(>=1)

5 v 1 Orientation(03,multiplesof90o)

6 v 2 16bitxPositionofQRCode

8 v 2 16bityPositionofQRCode

10 v 1 MaximumDataLength(1120characters)

11 v 1 PlaceholdertoUse(02)

Packetexamples

AddQRPlaceholder:totemplate2,dotsize4,norotation,atlocation320,116,withmaxdatasizeof120,
usingplaceholder0

Hosttransmit: 7F 80 0C 70 01 0A 02 04 00 40 01 74 00 78 00 D0 59

SlaveReply: 7F 80 01 F0 23 80
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

ClearOnTheFlyBuffer(0107)

Encryptionrequired

yes

Description

Clearsallstoredinformationintheontheflyticketbuffer.Sendthiscommandbefore
sendinganewsetofontheflyinformation.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 07 1 ClearOntheflyBufferSubCommand

Packetexamples

Hosttransmit: 7F 40 03 70 01 07 D2 06

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

SetPlaceholder(0108)

Encryptionrequired

yes

Description

Setsthevalueofaplaceholdervariableatagivenindexforthenextprint.Themaximum
numberofcharacterstoprintislimitedto50(100bytesUTF16).

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 08 1 SetPlaceholderVariableSubCommand

3 v 1 PlaceholderIndex(019)

TheTexttoDisplay,EncodedasaUTF16String.Maximumof50
4 v v
Charaters(100bytes)

Packetexamples

Setstheplaceholderstring6tocontain\"$3.00\"

Hosttransmit: 7F 40 0E 70 01 08 06 24 00 33 00 2E 00 30 00 30 00 58 03

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

ClearTemplate(0106)

Encryptionrequired

yes

Description

Clearsallstoredinformationforagiventemplate.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 06 1 ClearTemplateSubCommand

3 v 1 TemplatetoClear(1255)

Packetexamples

Clearstemplate13

Hosttransmit: 7F 40 04 70 01 06 0D 51 55

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

AddPlaceholderBarcode(0104)

Encryptionrequired

yes

Description

Addsaplaceholderbarcodetoallowdynamicupdatingofticketcodes.Themaximum
numberofcharacterstoprintislimitedto50(100bytesUTF16).

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 04 1 AddPlaceholderBarcodeSubCommand

3 v 1 TemplatetoAddto(0foronthefly,1255forothertemplates)

TypeofBarcode:0x00=Interleaved2of5(onlycurrentlysupported
4 v 1
format)

5 v 1 Orientation(03,multiplesof90o)

6 v 2 16bitxPositionofBarcode

8 v 2 16bityPositionofBarcode

10 v 2 16bitWidthofBars

12 v 2 16bitHeightofBarcode

14 v 1 MaximumChracterCount(Max50characters,100bytes)

15 v 1 ThePlaceHolderReferenceID(019)

Packetexamples

Addsaplaceholdertotemplate9,atposition60,60,withabarwidthof4,aheightof100,amaximumof
20characters,usingpalceholder3

Hosttransmit: 7F 40 10 70 01 04 09 00 00 3C 00 3C 00 04 00 64 00 20 03 48 7E

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

AddImage(0105)

Encryptionrequired

yes

Description

Allowsthehosttospecifytheresourceindexandplacementvariablesoftheimagetoaddto
theticketortemplate.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 01 1 SetupSubCommand

2 05 1 AddImageSubCommand

3 v 1 TemplatetoAddto(0foronthefly,1255forothertemplates)

4 v 1 ImageIndexID(0255)

5 v 1 Orientation(03,multiplesof90o)

6 v 2 16bitxPositionofText

8 v 2 16bityPositionofText

Packetexamples

Addsimage18totemplate7,atposition300,50,with90degreesrotation

Hosttransmit: 7F 40 0A 70 01 05 07 12 01 2C 01 00 32 5C EE

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetTicketSize(0506)

Encryptionrequired

optional

Description

Getsthesizeoftheticketinmmthattheprinterissettouse.Returns16bitlengthand16
bitheight.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 06 1 GetTicketSizeSubCommand

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitWidthofText(mm)

3 v 2 16BitHeightofText(mm)

Packetexamples

Getstheticketsizeinmmof155x65mm

Hosttransmit: 7F 40 03 70 05 06 D4 1E

SlaveReply: 7F 40 05 F0 9B 00 41 00 B9 F4
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetFreeStorage(0507)

Encryptionrequired

optional

Description

Getstheamountoffreestorage,inKB,oneithertheprinterinternalmemory,oran
insertedsdcardas32bitlittleendiannumber.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 07 1 GetFreeStorageSubCommand

3 v 1 LocationofMemorytoCheck(0forInternalMemory,1forSDCard.)

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 4 32BitAmountofFreeSpaceinKB

Packetexamples

Getthefreestorageontheinternalflash,returning1964KB

Hosttransmit: 7F 40 04 70 05 07 00 2C D3

SlaveReply: 7F 40 05 F0 AC 07 00 00 DA 5E
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

CheckForTemplate(0508)

Encryptionrequired

optional

Description

Checkifatemplatewithagivenindexexistsonthedevice.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 08 1 CheckforTemplateSubCommand

3 v 1 TemplateIndextoCheck

Response

Ifatemplatewiththerequestedindexexists,thecommandwillreturnagenericSSPOK
(0xF0)andwillreturnaParameterOutofRange(0xF4)ifitdoesnot.

Packetexamples

Checkstoseeiftemplate18exists

Hosttransmit: 7F 40 05 70 70 05 08 12 B9 62

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetPresentTemplates(0509)

Encryptionrequired

optional

Description

Returnsa32bytebitmasktoindicatewhichtemplateindexesarepresentonthedevice
(index0to255).Thebytesaresentlittleendian,withbit0ofthearrayrepresentingindex
0.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 09 1 GetPresentTemplatesSubCommand

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 32 256BitResourceMask

Packetexamples

Returnsabitmaskwheretemplates1to11arepresent

Host
7F 40 03 70 05 09 F6 1E
transmit:

Slave
7F 40 21 F0 FE 0F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Reply:
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetPresentFonts(050A)

Encryptionrequired

optional

Description

Returnsa32bytebitmasktoindicatewhichfontindexes(0255)arepresentonthe
device.Thebytesaresentlittleendian,withbit0ofthearrayrepresentingindex0.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 08 1 GetInfoSubCommand

2 0A 1 GetPresentFontsSubCommand

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 32 256BitResourceMask

Packetexamples

Returnsabitmaskwheretemplates1to5arepresent

Host
7F 40 03 70 08 0A FF B0
transmit:

Slave
7F 40 21 F0 3F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Reply:
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetPresentImages(050B)

Encryptionrequired

optional

Description

Returnsa32bytebitmasktoindicatewhichimageindexes(0255)arepresentonthe
device.Thebytesaresentlittleendian,withbit0ofthearrayrepresentingindex0.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 08 1 GetInfoSubCommand

2 0B 1 GetPresentImagesSubCommand

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 32 256BitResourceMask

Packetexamples

Returnsabitmaskwheretemplates1to11arepresent

Host
7F 40 03 70 05 0B F9 9E
transmit:

Slave
7F 40 21 F0 FE 0F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Reply:
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetTemplateInfo(050D)

Encryptionrequired

optional

Description

Returnstheinformationaboutthemakeupofaparticularstoredtemplateindex.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 0D 1 GetTemplateInfoSubCommand

3 v 1 TemplateIndex

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 1 TotalNumberofItemsinTemplate

2 v 1 NumberofStaticTextItems

3 v 1 NumberofPlaceholderTextItems

4 v 1 NumberofStaticBarcodeItems

5 v 1 NumberofPlaceholderBarcodeItems

6 v 1 NumberofImageItems

7 v 1 NumberofStaticQRCodeItems

8 v 1 NumberofPlaceholderQRCodeItems

Packetexamples
Getsinformationabouttemplate2,whichhasatotalof8items:4statictexts,1placeholderbarcode,and3
images

Hosttransmit: 7F 40 04 70 05 0D 02 23 6F

SlaveReply: 7F 40 09 F0 08 04 00 00 01 03 00 00 C7 C2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetTemplateItemInfo(050E)

Encryptionrequired

optional

Description

Returnstheinformationaboutthemakeupofaparticularstoredtemplateindex.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 0E 1 GetTemplateItemInfoSubCommand

3 v 1 TemplateIndex

4 v 1 Itemindex*

*ThisindexisobtainedusingtheGetTemplateInfocommand.Ifthisreturns7itemsona
templatethentheindexesoftheitemswillbe(06).

Response

Thereturneddatavariesbasedontheitemtype.Thestartofthedataisgenericandis
formattedasfollows:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

TypeofItem
(1=StaticText,2=PlaceholderText,3=StaticBarcode,4=
1 v 1
PlaceholderBarcode,5=Image,
8=StaticQRCode,9=PlaceholderQRCode)

2 v 2 16BitxPositionofItem

4 v 2 16BityPositionofItem

6 v 1 Orientation(03,multiplesof90o)

StaticTextItemInformation


Value
Byte Size Function
(hex)

7 v 1 TextFontID

8 v v UTF16ItemText

PlaceholderTextItemInformation

Value
Byte Size Function
(hex)

7 v 1 TextFontID

8 v 1 PlaceholderIndex

9 v 1 MaximumLength

StaticBarcodeItemInformation

Value
Byte Size Function
(hex)

7 v 1 BarcodeType

8 v 2 ThinBarWidth

10 v 2 BarcodeHeight

12 v v UTF16ItemCode

PlaceholderBarcodeItemInformation

Value
Byte Size Function
(hex)

7 v 1 TextFontID

8 v 2 ThinBarWidth

10 v 2 BarcodeHeight

12 v 1 PlaceholderIndex

13 v 1 MaximumLength

ImageItemInformation

Value
Byte Size Function
(hex)

7 v 1 TextFontID

8 v v ImageIndex

StaticQRCodeItemInformation

Value
Byte Size Function
(hex)

7 v 1 DotSize

8 v v ASCIIQRCodeData

PlaceholderQRCodeItemInformation

Value
Byte Size Function
(hex)

7 v 1 DotSize

8 v 1 PlaceholderIndex

9 v 1 MaximumDataLength

Packetexamples

Getsinformationabouttemplateitem6intemplate2,whichisastatictextitematposition534,406,with
norotation,usingfont1,withthetext\"SMARTTicket\"

Host
7F 40 05 70 05 0E 02 06 49 DA
transmit:

Slave
7F 40 20 F0 01 16 02 96 01 00 01 53 00 4D 00 41 00 52 00 54 00 20 00 54 00 69 00 63 00 6B 00 65
Reply:
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetImageFileChecksum(050F)

Encryptionrequired

optional

Description

ReturnstheCRCchecksumforanimagestoredontheSMARTTicketfilesystem.Thismay
beusefulforcheckingwhichimagesarepresentonasystem.(Seed=0xFFFF,same
functionasthepacketchecksumforSSP).

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 0F 1 GetImageChecksumSubCommand

3 v 1 ImageIndex(0255)

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitCRCChecksumoftheFileonthePrinter

Packetexamples

Getsachecksumofimage3,whichhasachecksumofE5AA(hex)

Hosttransmit: 7F 40 04 70 05 0F 03 25 63

SlaveReply: 7F 40 03 F0 AA E5 94 F4
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetTicketBounds(0510)

Encryptionrequired

optional

Description

Aticketprintercommandtogetinformationabouttheprintableareaoftheticket(pixel
offsets).

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 10 1 GetPixelBoundsSubCommand

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 2 16BitTopmostPrintablePixelCoordinate

3 v 2 16BitBottommostPrintablePixelCoordinate

5 v 2 16BitLeftmostPrintablePixelCoordinate

7 v 2 16BitRightmostPrintablePixelCoordinate

Packetexamples

Returnstheticketboundsof28,224,80,1176

Hosttransmit: 7F 40 05 70 70 05 10 03 DF 32

SlaveReply: 7F 40 09 F0 1C 00 24 02 50 00 98 04 1B 62
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofTICKETPRINT

GetPixelDensity(0511)

Encryptionrequired

optional

Description

ReturnstheDPIorDPmmofthedeviceprinter.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 70 1 PrintCommand

1 05 1 GetInfoSubCommand

2 11 1 GetPixelDensitySubCommand

3 v 1 ReturnType.0=DotsPermm,1=DotsPerInch

Response

Thefollowingtableshowsthestructureoftheresponsedata:

Value
Byte Size Function
(hex)

0 F0 1 GenericOK

1 v 1 PixelDensityintheSelectedUnit

Packetexamples

Getsbackthepixelspermmof8

Hosttransmit: 7F 40 04 70 05 11 00 2F 27

SlaveReply: 7F 40 02 F0 08 2E 20
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

PrinterConfiguration 0x71 113

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

ThePrinterConfigurationcommandusesasystemofsubcommandstoallowthehostto
sendprinterconfigurationcommandstothedevice.

Seethesubcommandlistfordetails.
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

SetTicketMode(01)

Encryptionrequired

optional

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

SetTicketWidth(02)

Encryptionrequired

optional

Description

Setsthewidth(sizeinthedirectionofprint)oftheticket(xdirection,anddirectionofticket
travel)inmmusinga16bitinteger.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 02 1 SetTicketWidthSubCommand

2 v 2 TicketWidth(mm)

Packetexamples

Setstheticketwidthto130mm

Hosttransmit: 7F 40 03 71 02 82 D8 0F

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

SetTicketHeight(03)

Encryptionrequired

optional

Description

Setstheheight(sizeperpendiculartothedirectionofprint)oftheticket(ydirection)inmm
usinga16bitinteger.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 03 1 SetTicketHeightSubCommand

2 v 2 TicketHeight(mm)

Packetexamples

Setstheticketheightto50mm

Hosttransmit: 7F 40 03 71 03 32 78 0A

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

SetPrintingQuality(06)

Encryptionrequired

optional

Description

Packetexamples

Hosttransmit: 7F 80 01 71 25 83

SlaveReply: 7F 80 01 00 03 82
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

EnableReverseValidation(07)

Encryptionrequired

optional

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

DisableReverseValidation(08)

Encryptionrequired

optional

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

EnableReverseValidation(07)

Encryptionrequired

optional

Description

Enablesreversevalidationonprinterswhichattachtoavalidator.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 07 1 EnableReverseValidatorSubCommand

Packetexamples

Hosttransmit: 7F 40 02 71 07 06 26

SlaveReply: 7F 40 01 00 03 8D
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

DisableReverseValidation(08)

Encryptionrequired

optional

Description

Disablesreversevalidationonprinterswhichattachtoavalidator.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 08 1 DisableReverseValidatorSubCommand

Packetexamples

Hosttransmit: 7F 40 02 71 08 24 26

SlaveReply: 7F 40 01 00 03 8D
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

DeleteFile(0A)

Encryptionrequired

optional

Description

Deletesaselectedresourcefileoftheselectedtype,ontheselecteddrive.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 0A 1 DeleteFileSubCommand

Thetypeoffiletobedeleted.0x01fortemplates,0x02forfonts,
2 v 1
0x03forimages.

Thelocationtodeletethefilefrom.0x01forinternalflash,0x02for
3 v 1
SDcard,0x03forboth.

4 v 1 Theindexofthefiletodelete(0255)

Packetexamples

Deletefont6fromtheinternalflash

Hosttransmit: 7F 40 05 71 0A 02 01 06 C2 9C

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

DeleteFileGroup(0B)

Encryptionrequired

optional

Description

Removesallinstancesofaselectedtypeofresourcefromaselecteddrive.

Thetablebelowshowsthecommandformat:

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 0B 1 DeleteFileGroupSubCommand

Thetypeoffiletobedeleted.0x01fortemplates,0x02forfonts,
2 v 1
0x03forimages.

Thelocationtodeletethefilefrom.0x01forinternalflash,0x02for
3 v 1
SDcard,0x03forboth.

Packetexamples

DeletealltemplatesfromtheSDcard

Hosttransmit: 7F 40 04 71 0B 01 02 FB 53

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

SetPaperSavingMode(0D)

Encryptionrequired

optional

Description

Setsthepapersavingmodeonprinterswhichsupportvariablelengthtickets.Withpaper
savingmodeenabled,ifthecontentsoftheticketdoens'ttakeuptheentireticketlength,a
shorterticketwillbeprinted.

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 0D 1 SetPaperSavingModeSubCommand

2 v 1 ThePaperSavingSetting.0x00forDisabled,0x01forEnabled

Packetexamples

Turnonpapersavingmode

Hosttransmit: 7F 40 03 71 0D 01 D1 AE

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

SetBezelType(0E)

Encryptionrequired

optional

Description

Setsthebezeltypeonprinterswhichsupportbezelsofdifferentlength.Thiswilleffectthe
minimumticketlength,asthelengthoftheticketmustbeabletoexitthebezel.

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 0E 1 SetBezelTypeSubCommand

2 v 1 TheBezelTypeSetting

Packetexamples

Hosttransmit: 7F 40 02 71 E001 12 26

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

SubcommandofPRINTERCONFIGURATION

SetPrintingQuality(06)

Encryptionrequired

optional

Description

Setsthequalitysettingforprintedtickets.Highervalueswillproduceabetterqualityprint,
butprinttimeswillbeincreased.

Value
Byte Size Function
(hex)

0 71 1 PrinterConfigCommand

1 06 1 SetPrintQualitySubCommand

TheQualitySetting.0x00=HighSpeed,0x01=Standard,0x02=
2 v 1
HighQuality

Packetexamples

Settheprintqualitysettingtohighquality

Hosttransmit: 7F 40 03 71 06 02 D8 14

SlaveReply: 7F 40 01 F0 23 8F
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

CancelEscrowTransaction 0x76 118

Implementedon EncryptionRequired

SMARTPAYOUT optional

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

CommitEscrowTransaction 0x77 119

Implementedon EncryptionRequired

SMARTPAYOUT optional

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

ReadEscrowValue 0x78 120

Implementedon EncryptionRequired

SMARTPAYOUT optional

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

GetEscrowSize 0x79 121

Implementedon EncryptionRequired

SMARTPAYOUT optional

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

SetEscrowSize 0x7A 122

Implementedon EncryptionRequired

SMARTPAYOUT optional

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Command Codehex Codedecimal

PayoutAmountByDenomination 0x39 57

Implementedon EncryptionRequired

SMARTSYSTEM yes

Description

Thiscommandissimilarto'PayoutAmount'buthastwovaluesinthepayoutwhichyoucan
selectthedenominationsforeach.

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

SlaveReset 0xF1 241

Implementedon

BV100,BV20,BV50,COUPONPRINTER,NV10USB,NV11,NV150,NV200,NV9USB,SMART
HOPPER,SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

Aneventgvenwhenthedevicehasbeenpowereduporpowercycledandhasrunthrough
itsresetprocess.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollreturnsslaveresetevent

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 01 F1 26 00
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Read 0xEF 239

Implementedon

BV100,BV20,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

AneventgivenwhentheBNVisreadingabanknote.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 1 yes no

Additionalinfomation

Iftheeventdatabyteiszero,thenthenoteisintheprocessofbeingscannedandvalidated.
Ifthedatabytevaluechangesfromzerotoavaulegreaterthenzero,thisindicatesavalidbanknoteis
nowheldintheescrowposition.Thebytevalueshowsthechannelofthebanknotethathasbeen
validated.Apollcommandafterthisvaluehasbeengivenwillcausethebanknotetobeacceptedfrom
theescrowposition.Thehostcanalsoissuearejectcommandatthispointtorejectthebanknote
backtotheuser.

Protocolminimumversion9

Type Datasize(bytes) Repeat PollwithAck

Status 7 yes no

Additionalinfomation

FortheSMARTCurrencydeviceonly7databytesaregiven.Ifallbytesarezerothenabanknote
isintheprocessofbeingscannedandvalidated.Nonzeroshowthecountrycodeandvalueofa
validatedbanknoteheldinescrow.

databyte function size

0 3byteASCIIcodeforcountryvalidated 3

3 4bytecodeforbanknotevalue 4

Packetexamples

Pollresponseshowingabiilbeingreadbutnotyetvalidated.

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 EF 00 CF CA

Pollresponseshowingchannel3billheldinescrow

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 EF 03 C5 CA
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteCredit 0xEE 238

Implementedon

BV100,BV20,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

Thiseventisgeneratedwhenthebanknotehasbeenmovedfromtheescrowpositiontoa
safepostionwithinthevalidatorsystemwherethebaknotecannotberetreivedbytheuser.

Atthispoint,itissafeforthehosttousethiseventasit's'Credt'point.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 1 yes yes

Additionalinfomation

Thedatabyteindicatesthedatasetchannelofthebaknotetobecredited.

Protocolminimumversion9

Type Datasize(bytes) Repeat PollwithAck

Status 7 yes no

Additionalinfomation

FortheSMARTCurrencydeviceonly7databytesaregivenshowingthecountrycodeandvalue
ofaCreditedbanknote.

databyte function size

0 3byteASCIIcodeforcountryvalidated 3

4
3 4bytecodeforbanknotevalue

Packetexamples

Pollresponseshowingbillcreditchannel4

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 EE 04 D7 CC
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Rejecting 0xED 237

Implementedon

BV100,BV20,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

AbillisintheprocessofbeingrejectedbacktotheuserbytheBanknteValidator.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples

Pollresponseshowingbillrejecting

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 ED 51 A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Rejected 0xEC 236

Implementedon

BV100,BV20,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

AbillhasbeenrejectedbacktotheuserbytheBanknoteValidator.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingbillrejectedbythevalidator.

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 EC 54 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Stacking 0xCC 204

Implementedon

BV100,BV20,NV10USB,NV11,NV150,NV200,NV9USB

Description

Thebilliscurrentlybeingtransportedtoandthroughthedevicestacker.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Stacked 0xEB 235

Implementedon

BV100,BV20,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

Abillhasbeentransportedtroughthebanknotevalidatorandisinit'sstackedposition.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingstackedbillseen

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 EB 45 A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

SafeJam 0xEA 234

Implementedon

BV100,BV20,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

Abillhasbeendetectedasjammedduringit'stransporttothestackedposition.ASfaejam
indicatesthatthebillisnotretrievablebytheuseratthispoint.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Error 0 yes no

Packetexamples

Pollresponseshowingsafejamdetected

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 EA 40 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

UnsafeJam 0xE9 233

Implementedon

BV100,BV20,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

Abillhasbeendetectedasjammedduringit'stransportthroughthevalidator.Anunsafe
jamindicatesthatthisbillmaybeinapositionwhentheusercouldretrieveitfromthe
validatorbezel.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Error 0 yes no

Packetexamples

Pollresponseshowingunsafebilljamdetected

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 E9 4A 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Disabled 0xE8 232

Implementedon

BV100,BV20,BV50,COUPONPRINTER,NV10USB,NV11,NV150,NV200,NV9USB,SMART
HOPPER,SMARTPAYOUT,SMARTSYSTEM,SMARTTICKET

Description

Adisabledeventisgiveninresponsetoapollcommandwhenadevicehasbeendisabled
bythehostorbysomeotherinternalfunctionofthedevice.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Responsetopollshowingdisabledevent

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 E8 4F A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

FraudAttempt 0xE6 230

Implementedon

BV100,BV20,NV10USB,NV150,NV200,SMARTHOPPER,SMARTPAYOUT,SMART
SYSTEM

Description

Thevalidatorsystemhasdetectedanattempttomauipulatethecoin/banknoteinorderto
foolthesystemtoregistercreditswithnomoniesadded.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Fraud 1 no yes

Additionalinfomation

Thedatabyteindicatesthedatasetchannelofthebanknotethatisbeingtampetedwith.Azero
indicatesthatthechannleisunknown.

Packetexamples

Pollresponseshowingfraudattemptseenonchannel2

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 E6 02 C0 7C
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

StackerFull 0xE7 231

Implementedon

BV100,BV20,BV50,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

Eventinresponsetopollgivenwhenthedevicehasdetectedthatthestackerunithas
stackedit'sfulllimitofbanknotes.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingstackerfull

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 E7 6D A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteClearedFromFront 0xE1 225

Implementedon

BV100,BV50,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

Duringthedevicepowerupsequenceabillwasdetectedasbeinginthenotepath.Thisbill
isthenrejectedfromthedeviceviathebezelandthiseventisissued.Ifthebillvalueis
knownthenthechannelnumberisgiveninthedatabyte,otherwisethedatabytewillbe
zerovalue.

Packetexamples

Pollresponseshowingunknownbillrejectedfromthefrontatpowerup

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 E1 00 CC 6E
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteClearedIntoCashbox 0xE2 226

Implementedon

BV100,BV50,NV10USB,NV11,NV150,NV200,NV9USB,SMARTPAYOUT

Description

Duringthedevicepowerupsequenceabillwasdetectedasbeinginthestackpath.Thisbill
isthenmovedintothedevicecashboxandthiseventisissued.Ifthebillvalueisknown
thenthechannelnumberisgiveninthedatabyte,otherwisethedatabytewillbezero
value.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Payin 1 no yes

Packetexamples

Pollresponseshowingachannel2billmovedtothecashboxatpowerup

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 E2 02 C3 E4
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CashboxRemoved 0xE3 227

Implementedon

BV100,BV50,NV200,SMARTPAYOUT

Description

Thesystemhasdetectedthatthecashboxunithasbeenremovedfromit'sworkingposition.

Thesystemwillremaindisabledforbillentryuntilthecashboxunitisreplacedintoit's
workingposition.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples

Pollresponseshowingcashboxremoved

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 E3 76 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CashboxReplaced 0xE4 228

Implementedon

BV100,BV50,NV200,SMARTPAYOUT

Description

Thedevicecashboxboxunithasbeendetectedasreplacedintoit'sworkingposition.

Thevalidatorwillreenableifithasnotalredaybeendisabledbythehostsystem.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingcashboxreplaced

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 E4 67 A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

BarcodeTicketValidated 0xE5 229

Implementedon

NV150,NV200,SMARTPAYOUT

Description

Abarcodetickethasbeenscannedandidentifiedbythesystemandiscurrentlyheldinthe
escrowposition.

ThehostcansendtheGetBarcodeDatacommandtoretrivethenumberoftheticket
scanned.ThehostcanthensednaRejectorPollcommandtorejectoraccepttheticketas
required.

Packetexamples

Pollresponseshowingbarcodeheldinescrow

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 E5 62 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

BarcodeTicketAck 0xD1 209

Implementedon

NV150,NV200,SMARTPAYOUT

Description

Thedevicehasmovedthebarcodetickettoasafestackposition.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 no yes

Packetexamples

Pollresponseshowingbarcodeticketack

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 D1 D9 A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NotePathOpen 0xE0 224

Implementedon

NV150,NV200,SMARTPAYOUT

Description

Thedevicehasdetectedthatit'snotepathhasbeenopened.Thedevicewillbedisabledfor
billentryuntilthenotepathisreclosed.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Error 0 yes no

Packetexamples

Pollresponseshowingnotepathopen

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 E0 7C 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

ChannelDisable 0xB5 181

Implementedon

BV100,BV20,BV50,NV10USB,NV11,NV200,NV9USB,SMARTPAYOUT

Description

Thedevicehashadallitsnotechannelsinhibitedandhasbecomedisabledfornote
insertion.

Protocolminimumversion7

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 B5 82 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Initialising 0xB6 182

Implementedon

BV100,BV20,BV50,NV200,NV9USB,SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

ThiseventisgivenonlywhenusingthePollwithACKcommand.ItisgivenwhentheBNVis
poweredupandsettingitssensorsandmechanismstobereadyforNoteacceptance.When
theeventresponsedoesnotcontainthisevent,theBNVisreadytobeenabledandused.

Protocolminimumversion7

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes yes

Additionalinfomation

ThiseventisonlygivenwhenusingthePollWithAckcommand.

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 B6 88 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Dispensing 0xDA 218

Implementedon

NV11,SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Thedeviceisintheprocessofpayingoutarequestedvalue.Thevaluepaidatthepollis
givenintheeventdata.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 4 yes no

Additionalinfomation

$bytedatagivingtheamountdispenseduptothepoll.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable yes no

Additionalinfomation

Anarrayofdatagivingthedispensedatthepollpointforeachofthecountriessupportedinthe
dataset.Thefirstbytegivesthenumberofcountriesinthesettheablockofdataforeachofthe
countries.

byte function size

0 numberofcountriesinset 1

1 valuedispenseduptothispoint 4

5 countrycode 3

..
... repeataboveblockforeachcountryinset

Packetexamples

Protocolversion5pollresponseshowing12.50dispensedatthispoint

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 05 F0 E2 04 00 00 F8 4A

Protocolversion6pollresponseshowing23.00EURand12.00GBPdispensedtothispoint

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 10 F0 02 FC 08 00 00 45 55 52 B0 04 00 00 47 42 50 04 B3
ascii: . . . . . . E U R . . . . G B P
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Dispensed 0xD2 210

Implementedon

SMARTPAYOUT,SMARTSYSTEM

Description

ShowthetotalvaluethedevicehasdispensedinrepsonsetoaDispensecommand.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 4 no yes

Additionalinfomation

4bytevalueshowingtotalvaluedispensed.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable no yes

Additionalinfomation

Anarrayofdatagivingthetotaldispensedforeachofthecountriessupportedinthedataset.Thefirst
bytegivesthenumberofcountriesinthesettheablockofdataforeachofthecountries.

byte function size

0 numberofcountriesinset 1

1 valuedispensed 4

5 countrycode 3

..
... repeataboveblockforeachcountryinset

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CoinsLow 0xD3 211

Implementedon

SMARTHOPPER

Description

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

HopperJammed 0xD5 213

Implementedon

SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Aneventshowingthehopperunithasjammedandgivingthevaluepaid/floateduptothat
jam.

Onthesmartpayoutthiseventisusedwhenajamoccursduringapayout/float/empty
operation.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Error 4 yes no

Additionalinfomation

4bytesshowingthevaluedispenseduptothejampoint

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Error variable yes no

Additionalinfomation

Anarrayofdatagivingthedispensed/floatedatthejammedpointforeachofthecountriessupported
inthedataset.Thefirstbytegivesthenumberofcountriesinthesettheablockofdataforeachof
thecountries.

byte function size

0 numberofcountriesinset 1

1 valuedispensed/floateduptothispoint 4

5 countrycode 3

..
... repeataboveblockforeachcountryinset

Packetexamples

Protocolversion5pollresponseshowing2.30paiduptothejampoint

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 06 F0 D5 E6 00 00 00 49 DB
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Halted 0xD6 214

Implementedon

NV11,SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Triggeredwhenpayoutisinterruptedforsomereason.

ProtocolVersion6andearlier

Thiseventisgivenwhen:

thehosthasrequestedahalttothedevice.

thepayoutisautomaticallycancelled(duetoajam/reversevalidationfail/cashbox
erroretc.)

Thevaluepaidatthepointofhaltingisgivenintheeventdata.

ProtocolVersion7andlater

Thiseventisgivenwhen:

thehosthasrequestedahalttothedevice.

Thevaluepaidatthepointofhaltingisgivenintheeventdata.

Note:adifferentevent'ErrorDuringPayout'isgeneratedwhenerrorsoccur

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 4 no no

Additionalinfomation

4byteshowingthevaluepaiduptothehaltpoint

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable no no

Additionalinfomation

Anarrayofdatagivingthedispensed/floatedatthepollpointforeachofthecountriessupportedin
thedataset.Thefirstbytegivesthenumberofcountriesinthesettheablockofdataforeachofthe
countries.
byte function size

0 numberofcountriesinset 1

1 valuedispensed/floateduptothispoint 4

5 countrycode 3

..
... repeataboveblockforeachcountryinset

Packetexamples

Protocolversion6pollresponseshowing15.30GBPtothehaltpoint

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 0A F0 D6 01 FA 05 00 00 45 55 52 4D 49
ascii: . . . . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Floating 0xD7 215

Implementedon

SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Eventshowingtheamountofcashfloateduptothepollpoint

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 4 yes no

Additionalinfomation

4bytesshowingthevaluefloatedtothecashboxuptothepoll

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable yes no

Additionalinfomation

Anarrayofdatagivingthefloatedvalueatthepollpointforeachofthecountriessupportedinthe
dataset.Thefirstbytegivesthenumberofcountriesinthesettheablockofdataforeachofthe
countries.

byte function size

0 numberofcountriesinset 1

1 valuefloatedtothispoint 4

5 countrycode 3

..
... repeataboveblockforeachcountryinset

Packetexamples

Protocolversion5pollresponseshowing45.00floated

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 05 F0 94 11 00 00 E8 F3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Floated 0xD8 216

Implementedon

SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Eventgivenattheendofthefloatingprocesswhichwilldisplaytheamountactuallyfloated.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 4 no yes

Additionalinfomation

4Bytesshowingtheamountfloated

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable no yes

Additionalinfomation

Anarrayofdatagivingthefloatedvalueattheendoftheprocessforeachofthecountriessupported
inthedataset.Thefirstbytegivesthenumberofcountriesinthesettheablockofdataforeachof
thecountries.

byte function size

0 numberofcountriesinset 1

1 valuefloated 4

5 countrycode 3

..
... repeataboveblockforeachcountryinset

Packetexamples

Protocolversion6pollresponseshowingafloatedvalueof20.50EUR

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 0A F0 D8 01 02 08 00 00 45 55 52 81 C0
ascii: . . . . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Timeout 0xD9 217

Implementedon

NV11,SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Thedevicehasbeenunabletocompletearequest.Thevaluepaidupuntilthetimeout
pointisgivenintheeventdata.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 4 no yes

Additionalinfomation

4bytesshowingthevaluedispensedorfloatedtothatpoint.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable no yes

Additionalinfomation

Anarrayofdatagivingthedispensed/floatedatthepollpointforeachofthecountriessupportedin
thedataset.Thefirstbytegivesthenumberofcountriesinthesettheablockofdataforeachofthe
countries.

byte function size

0 numberofcountriesinset 1

1 valuedispensed/floateduptothispoint 4

5 countrycode 3

..
... repeataboveblockforeachcountryinset

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

IncompletePayout 0xDC 220

Implementedon

SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Thedevicehasdetectedadiscrepancyonpowerupthatthelastpayoutrequestwas
interrupted(possiblyduetoapowerfailure).Theamountsofthevaluepaidandrequested
aregivenintheeventdata.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Payout 8 no yes

Additionalinfomation

Eightdatabytesshowingthevaluedispensedandthevaluerequested.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Payout variable no yes

Additionalinfomation

Anarrayofdatagivingthevaluedispensedandtheoriginalvaluerequestedbeforethepowerdown
foreachofthecountriessupportedinthedataset.Thefirstbytegivesthenumberofcountriesinthe
setthenablockofdataforeachofthecountries(seetablebelow).

byte function size

0 numberofcountriesinset 1

1 valuedispensed 4

5 valuerequested 4

9 countrycode(ASCII) 3

..
... repeataboveblockforeachcountryinset

Packetexamples

Protocolversion5pollresponseshowing25.20paidoutofrequestfor50.00

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 09 F0 D8 09 00 00 58 0D 00 00 3B C9

Protocolversion6pollresponseshowing23.00EURpaidoutofarequesttopayout50.00EUR

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 0D F0 01 FC 08 00 00 88 13 00 00 45 55 52 C3 E5
ascii: . . . . . . . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

IncompleteFloat 0xDD 221

Implementedon

SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Thedevicehasdetectedadiscrepancyonpowerupthatthelastfloatrequestwas
interrupted(possiblyduetoapowerfailure).Theamountsofthevaluepaidandrequested
aregivenintheeventdata.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Payout 8 no yes

Additionalinfomation

8databytesgivingthevalueoffloatedandthefloatvaluerequestedbeforethepowerwas
interrupted

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Payout variable no yes

Additionalinfomation

Anarrayofdatagivingthevaluefloatedandtheoriginalvaluerequestedbeforethepowerdownfor
eachofthecountriessupportedinthedataset.Thefirstbytegivesthenumberofcountriesintheset
thenablockofdataforeachofthecountries(seetablebelow).

byte function size

0 numberofcountriesinset 1

1 valuefloated 4

5 valuerequested 4

9 countrycode(ASCII) 3

..
... repeataboveblockforeachcountryinset

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CashboxPaid 0xDE 222

Implementedon

SMARTHOPPER,SMARTSYSTEM

Description

Coinvalueshavebeendetectedandpaidtothecashboxsincethelastpoll.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 4 no no

Additionalinfomation

Databytesshowthecoinvaluepaid

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable no no

Additionalinfomation

Databytesgivecountrycodesandvaluesforeachofthecurrenciesinthedataset:

byte function size

0 numberofcountriesinset 1

1 valuedispensed 4

5 countrycode 3

..
... repeataboveblockforeachcountryinset

Packetexamples

Protocolversion5pollresponseshowing2.00(200c)coinpaidtocashbox

Hosttransmit: 7F 90 01 07 51 83
SlaveReply: 7F 90 06 F0 DE C8 00 00 00 68 00

Protocolversion6pollresponseshowing5.30GBPadn0.20EURpaidtocashbox

Hosttransmit: 7F 90 01 07 51 83
SlaveReply: 7F 90 11 F0 DE 02 12 02 00 00 47 42 50 14 00 00 00 45 55 52 3A 50
ascii: . . . . . . . G B P . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CoinCredit 0xDF 223

Implementedon

SMARTHOPPER

Description

Acoinhasbeendetectedasaddedtothesystem.Thiswouldbeusuallyviatheseperate
coinmechattachedtothesystemport.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 4 no no

Additionalinfomation

Datagives4bytevalueofthecoinadded

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 7 no no

Additionalinfomation

Databytesgive4bytecoinvalueand3byteASCIIcountrycodeofthecoinadded

Packetexamples

Protocolversion5pollresponseshowing1.00(100c)coinadded

Hosttransmit: 7F 90 01 07 51 83
SlaveReply: 7F 90 05 F0 64 00 00 00 97 A3

Protocolversion6pollresponseshowing5.00GBPcoinadded

Hosttransmit: 7F 90 01 07 51 83
SlaveReply: 7F 90 09 F0 DF F4 01 00 00 47 42 50 89 0F
ascii: . . . . . . G B P
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CoinMechJammed 0xC4 196

Implementedon

SMARTHOPPER,SMARTSYSTEM

Description

Theattachedcoinmechanismhasbeendetectedashavingajam.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingcoinmechjam

Hosttransmit: 7F 90 01 07 51 83
SlaveReply: 7F 90 02 F0 C4 A2 62
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CoinMechReturnActive 0xC5 197

Implementedon

SMARTHOPPER,SMARTSYSTEM

Description

Theattachedcoinmechanismhasbeendetectedashavingit'srejectorreturnbutton
pressed.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Emptying 0xC2 194

Implementedon

NV11,SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

ThedeviceiscurrentlyperformingisemptyoperationfollowinganEmptycommandrequest.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples

Pollresponseshowingdeviceemptying

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 C2 B0 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

Emptied 0xC3 195

Implementedon

NV11,SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

Thedevicehascompletedit'semptyoperationinresponsetotheEmptycommand.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingdeviceemptied

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 C3 B5 A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

SmartEmptying 0xB3 179

Implementedon

NV11,SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

ThedeviceisintheprocessofcarryingoutitsSmartEmptycommandfromthehost.The
valueemptiedatthepollpointisgivenintheeventdata

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 4 yes no

Additionalinfomation

4byteintegershowingthevalueemptiedsofar.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable yes no

Additionalinfomation

Databytesgivecountrycodesandvaluesforeachofthecurrenciesinthedataset:

byte function size

0 numberofcountriesinset 1

1 valuedispensed 4

5 countrycode 3

... repeataboveblockforeachcountryinset ..

Packetexamples

Adevicehasemptied22.60EURuptothispollwithprotocolversion5

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 07 F0 B3 01 D4 08 00 00 53 F7

Adevicehasemptied22.60EURuptothispollwithprotocolversion6

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 0A F0 B3 01 D4 08 00 00 45 55 52 44 F6
ascii: . . . . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

SmartEmptied 0xB4 180

Implementedon

NV11,SMARTHOPPER,SMARTPAYOUT,SMARTSYSTEM

Description

ThedevicehascompleteditsSmartEmptycommand.Thetotalamountemptiedisgivenin
theeventdata.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 4 no yes

Additionalinfomation

4byteintergershowingthetotalvalueemptiedinthissession.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status variable no yes

Additionalinfomation

Databytesgivecountrycodesandvaluesforeachofthecurrenciesinthedatasetofthetotalamount
emptied.

byte function size

0 numberofcountriesinset 1

1 valuedispensed 4

5 countrycode 3

... repeataboveblockforeachcountryinset ..

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CalibrationFailed 0x83 131

Implementedon

SMARTHOPPER,SMARTSYSTEM

Description

Duringthedevicesnormalrecalibrationprocess,anerrorhasbeendetectedwhich
indicatesasensorfailureoroutofrangeissue.Thisusuallyindicateahardwarefailureand
thedeviceshouldbetakenoutofserviceuntilthecauseisfound.

Protocolminimumversion7

Type Datasize(bytes) Repeat PollwithAck

Error 1 no no

Additionalinfomation

Adatabyteerrorreasonisgivendetailedinthetablebelow.

Error Code

Payoutflapsensor 1

Exitsensor 2

Coil1sensor 3

Coil2sensor 4

Unitnotinitialised 5

Checksumerror 6

Recalibrationbycommandrequired(obsolete) 7

Motoroptosloterror 8,9

Exitsensorerror2 10

Packetexamples

Theexamplebelowshowsacalibrationfailduetoanissuewithcoil1.

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 83 03 C0 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteStoredInPayout 0xDB 219

Implementedon

NV11,SMARTPAYOUT

Description

Thenotehasbeenpassedintothenotestoreofthepayoutunit.

NotethatNV11devicesreportavalueofnotestoredifReportByValueoptionhas
beenset.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Additionalinfomation

SMARTPayoutprotocolversion4notestored

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 8 no no

Additionalinfomation

NV11protocolversion6withreportbyvalueoptionset.

Packetexamples

PollresponseshowingnotestoredinpayoutforSMARTPayout

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 DB E5 A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

PayoutOutOfService 0xC6 198

Implementedon

NV11,SMARTPAYOUT

Description

Thiseventisgivenifthepayoutgoesoutofserviceduringoperation.Ifthiseventis
detectedafterapoll,thehostcansendtheENABLEPAYOUTDEVICEcommandtodetermine
ifthepayoutunitcomesbackintoservice.

Protocolminimumversion4

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingpayoutoutofservice

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 C6 AB A2
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

JamRecovery 0xB0 176

Implementedon

SMARTPAYOUT

Description

TheSMARTPayoutunitisintheprocessofrecoveringfromadetectedjam.Thisprocesswill
typicallymovefivenotestothecashboxthisisdonetominimisethepossibilitytheunit
willgooutofservice.

Protocolminimumversion7

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 B0 9C 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

ErrorDuringPayout 0xB1 177

Implementedon

SMARTPAYOUT

Description

ReturnedifanerrorisdetectedwhilstmovinganoteinsidetheSMARTPayoutunit.The
causeoferror(1byte)indicatesthesourceoftheconditionseetablebelowforerror
causes.

Inthecaseoftheincorrectdetection,theresponsetoCashboxPayoutOperationData
requestwouldreportthenoteexpectedtobepaidout.

Protocolminimumversion7

Type Datasize(bytes) Repeat PollwithAck

Error variable no yes

Additionalinfomation

Thedatawiththiseventhasvariablelengthdependingonthenumberofdatasetdenominationsin
thedevice:

byte function size

0 numberofcountriesinset 1

1 valuedispensed 4

5 countrycode 3

... repeataboveblockforeachcountryinset ..

1
last Finalbyteisanerrorcode(seetablebelow)


ErrorCode(finalbytefromabove):

Value Meaning

0x00 notenotcorrectlydetectedasitisrouted(reversevalidationfail)

0x01 notejammedintransport*

0x02 cashboxerrore.g.stackerfull.removed,jammed**

0x03 payoutstallede.g.unabletoseeknoteinpayout

0x04 payoutcancelledduetopolltimeout
*thiserrorcanbereportedfordifferentfaulttypessuchasanotemissingfromthecashboxastheunitonlyknowsthat
thenotedoesnotarriveatpayoutexit
**stackermayberequiredduringpayout(forrecoveryorstackingpoorconditionnotes)

Packetexamples

PayouterrorduetojamafterGBP50.00andEUR20.00havebeenpaid
Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 0F F0 B1 02 88 13 00 00 47 42 50 D0 07 00 00 01 34 B3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteTransferedToStacker 0xC9 201

Implementedon

NV11,SMARTPAYOUT

Description

Reportedwhenanotehasbeensuccessfullymovedfromthepayoutstoreintothestacker
cashbox.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 7 no yes

Additionalinfomation

Sevenbytesdatagivingthevalueandcountrycodeofthenotemovedtostacker.

Packetexamples

Pollresponseshowing5.00EURnotemovedfrompayouttostacker

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 09 F0 C9 F4 01 00 00 45 55 52 DA C9
ascii: . . . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteHeldInBezel 0xCE 206

Implementedon

NV11,SMARTPAYOUT

Description

Reportedwhenadispensingnoteisheldinthebezelofthepayoutdevice.

Protocolminimumversion8

Type Datasize(bytes) Repeat PollwithAck

Status 7 yes no

Additionalinfomation

Sevenbytesgivingthevalueandcountrycodeofthenoteheld.

Packetexamples

Pollresponseshowing10.00EURbillheldinbezel

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 09 F0 CE E8 03 00 00 45 55 52 08 54
ascii: . . . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteIntoStoreAtReset 0xCB 203

Implementedon

NV11,SMARTPAYOUT

Description

Aneventshowingthatabillwasmovedintothepaoutstorageaspartofthepowerup
proceedure.

Protocolminimumversion8

Type Datasize(bytes) Repeat PollwithAck

Status 7 no yes

Additionalinfomation

Sevenbytesgivingthevalueandcountrycodeofthenotestored.

Packetexamples

Pollresponseshowinga20.00GBPnotemovetopayoutstoreduringpowerup

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 09 F0 CB D0 07 00 00 47 42 50 B7 2D
ascii: . . . . . . G B P
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteIntoStackerAtReset 0xCA 202

Implementedon

NV11,SMARTPAYOUT

Description

Reportedwhenanotehasbeendetectedaspaidintothecashboxstackeraspartofthe
powerupprocedure.

Protocolminimumversion8

Type Datasize(bytes) Repeat PollwithAck

Status 7 no yes

Additionalinfomation

Sevenbytesgivingthevalueandcountrycodeofthenotestacked.

Packetexamples

Pollresponseshowing5.00EURnotestackedatpowerup

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 09 F0 CA F4 01 00 00 45 55 52 D0 F9
ascii: . . . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteDispensedAtReset 0xCD 205

Implementedon

NV11

Description

Reportedwhenanotehasbeendispensedaspartofthepowerupprocedure.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 7 no yes

Additionalinfomation

Sevenbytesgivingthevalueandcountrycodeofthenotestored.

Packetexamples

Pollresponseshowing10.00EURnotestoredatpowerup

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 09 F0 CD E8 03 00 00 45 55 52 02 64
ascii: . . . . . . E U R
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteFloatRemoved 0xC7 199

Implementedon

NV11

Description

Reportedwhenanotefloatunithasbeendetectedasremovedfromitsvalidator.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingnotefloatunitremoved

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 C7 AE 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoteFloatAttached 0xC8 200

Implementedon

NV11

Description

Reportedwhenanotefloatunithasbeenattachedtoitsvalidator.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingnotefloatattached

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 C8 8C 22
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

DeviceFull 0xCF 207

Implementedon

NV11,SMARTSYSTEM

Description

Thedevicehasdetectedthatitisfullofcoins/banknotesandnomorecanbeadded.

Protocolminimumversion5

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

CoinMechError 0xB7 183

Implementedon

SMARTHOPPER,SMARTSYSTEM

Description

ThiseventwillonlybegereratediftheCoinMechOptionscommandhasbeensent
tothedevicewithdatabitsettoenableerrorevents.

Thedatabytegivenwiththiseventindicatestheerrortype.

Code
Error
Description
1
Rejectcoin
Acoinwasinsertedwhichdidnotmatchanyoftheprogrammedtypes.Thecoinisreturned
tothecustomerandnocreditisgiven.
2
Inhibitedcoin
Acoinwasinsertedwhichdidmatchaprogrammedwindowtypebutwaspreventedfrom
acceptingbytheinhibitregister.Theinhibitregistercanbecontrolledseriallybutmayalso
belinkedtoexternalDILswitches.
3
Multiplewindow
Acoinwasinsertedwhichmatchedmorethanoneenabledwindowtype.Thiscoinwas
rejectedasthecreditcodewasindeterminate.
4
Wakeuptimeout
Acoinacceptorfittedwithawakeupsensorpickedupacoinenteringtheacceptorbutit
wasnotseensubsequentlyinthevalidationarea.Possiblecoinjam.
5
Validationtimeout
Acoinwasdetectedenteringthevalidationareabutfailedtoleaveit.Possiblecoinjam.
6
Creditsensortimeout
Acoinwasvalidatedastruebutnevermadeittothepostgatecreditsensor.Possiblecoin
jam.
7
Sorteroptotimeout
Acoinwassentintothesorter/diverterbutwasnotseencomingout.Possiblecoinjam.
8
2ndclosecoinerror
Acoinwasinsertedtooclosetotheoneinfront.Oneorbothcoinswillhaverejected.
9
Acceptgatenotready
Acoinwasinsertedwhiletheacceptgateforthecoininfrontwasstilloperating.Coinshave
beeninsertedtooquickly.
10
Creditsensornotready
Acoinwasstilloverthecreditsensorwhenanothercoinwasreadytoaccept.Coinshave
beeninsertedtooquickly.
11
Sorternotready
Acoinwasinsertedwhilethesorterflapsforthecoininfrontwerestilloperating.Coins
havebeeninsertedtooquickly.
12
Rejectcoinnotcleared
Acoinwasinsertedbeforeapreviouslyrejectedcoinhadtimetoclearthecoinacceptor.
Coinshavebeeninsertedtooquickly.
13
Validationsensornotready
Thevalidatorinductivesensorswerenotreadyforcoinvalidation.Possiblefaultdeveloping.
14
Creditsensorblocked
Thereisapermanentblockageatthecreditsensor.Thecoinacceptorwillnotacceptany
morecoins.
15
Sorteroptoblocked
Thereisapermanentblockageatthesorterexitsensor.Thecoinacceptorwillnotaccept
anymorecoins.
16
Creditsequenceerror
Acoinorobjectwasdetectedgoingbackwardsthroughadirectionalcreditsensor.Possible
fraudattempt.
17
Coingoingbackwards
Acoinwasdetectedgoingbackwardsthroughthecoinacceptor.Possiblefraudattempt.
18
Cointoofast(overcreditsensor)
Acoinwastimedgoingthroughthecreditsensorandwastoofast.Possiblefraudattempt.
19
Cointooslow(overcreditsensor)
20
C.O.S.mechanismactivated
(coinonstring)
Aspecificsensorfordetectingacoinonstringwasactivated.Possiblefraudattempt.
21
DCEoptotimeout
AcoinacceptorfittedwithaDualCoinEntrychutesawacoinortokenwhichwasnotseen
subsequentlyinthevalidationarea.Possiblecoinjam.
22
DCEoptonotseen
AcoinacceptorfittedwithaDualCoinEntrychutesawacoinwhichwasnotseenpreviously
bythechutesensor.Possiblefraudattempt.
23
Creditsensorreachedtooearly
Acoinwastimedfromtheendofthevalidationareatothepostgatecreditsensor.It
arrivedtooearly.Possiblefraudattempt.
24
Rejectcoin(repeatedsequentialtrip)
AcoinwasrejectedNtimesinsuccessionwithnointerveningtruecoins.Statistically
unlikelyifNgreaterthanorequalto5.Possiblefraudattempt.
25
Rejectslug
Acoinwasrejectedbutwasidentifiedasaknownslugtypethismaybeapre
programmedfraudcoinoraknownfraudmaterial.
26
Rejectsensorblocked
Thereisapermanentblockageattherejectsensor.Thecoinacceptorwillnotacceptany
morecoins.Notallcoinacceptorshavearejectsensor.
27
Gamesoverload
Totalisermode:Agamevaluewassettoolowpossiblyzero.Thisisaproduct
configurationerror.
28
Max.coinmeterpulsesexceeded
Totalisermode:Ametervaluewassettoolowpossiblyzero.Thisisaproduct
configurationerror.
29
Acceptgateopennotclosed
Theacceptgatewasforcedopenwhenitshouldhavebeenclosed.
30
Acceptgateclosednotopen
Theacceptgatedidnotopenwhenthesolenoidwasdriven.
31
Manifoldoptotimeout
Acoinwassentintothemanifoldmodule(coindiverter)butwasnotseencomingout.
Possiblecoinjam.
32
Manifoldoptoblocked
Thereisapermanentblockageatthemanifoldmodulesensor(coindiverter).Thecoin
acceptorwillnotacceptanymorecoins.
128
Inhibitedcoin(Type1)
Atruecoin(type1,coininposition1)wasinsertedbutwaspreventedfromacceptingby
theinhibitregister.

Inhibitedcoin(Typen)
Atruecoin(typen,coininpositionn)wasinsertedbutwaspreventedfromacceptingby
theinhibitregister.
159
Inhibitedcoin(Type32)
Atruecoin(type32,coininposition32)wasinsertedbutwaspreventedfromaccepting
bytheinhibitregister.
253
Datablockrequest(note)
Anotyetusedmechanismforacoinacceptortorequestattentionfromthehostmachine.
Perhapsitneedssomedatafromthehostmachineoranotherperipheral.
254
Coinreturnmechanismactivated
(Flightdeckopen)
Anattempttoclearacoinjambyopeningtheflightdeckwasdetected.Thecoinacceptor
cannotoperateuntiltheflightdeckisclosed.
255
Unspecifiedalarmcode
Anyalarmcodewhichdoesnotfitintotheabovecategories.

Protocolminimumversion7

Type Datasize(bytes) Repeat PollwithAck

Error 1 no no

Packetexamples

Acoinerror:tooslowdetected

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 B7 14 B1 1A
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

AttachedCoinMechDisabled 0xBD 189

Implementedon

SMARTHOPPER,SMARTSYSTEM

Description

Thedeviceseperatecoinmechanismattachedtothisdevicehasbeendisabled.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingcoinmechdisabled

Hosttransmit: 7F 90 01 07 51 83
SlaveReply: 7F 90 02 F0 BD B7 E3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

AttachedCoinMechEnabled 0xBE 190

Implementedon

SMARTHOPPER,SMARTSYSTEM

Description

Theseperatecoinmechanismattachedtothisdevicehasbeenenabled.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Pollresponseshowingcoinmechenabled

Hosttransmit: 7F 90 01 07 51 83
SlaveReply: 7F 90 02 F0 BE BD E3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

ValueAdded 0xBF 191

Implementedon

SMARTSYSTEM

Description

Aneventgivingthecumulativevalueofcurrencydetectedasaddedtothesystemsincethe
lastpoll.

Protocolminimumversion7

Type Datasize(bytes) Repeat PollwithAck

Payin variable no yes

Additionalinfomation

Databytesgivecountrycodesandvaluesforeachofthecurrencieswherevaluehasbeenadded

byte function size

0 GenericOK 1

1 Eventcode 1

2 numberofcountriesindata 1

3 valueadded(4byteinteger) 4

7 countrycode(3ByteASCII) 3

..
... repeataboveblockforeachcountrydata

Packetexamples

5.50EURhasbeenaddedsincethelastpoll

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 0A F0 BF 01 26 02 00 00 45 55 52 ED 91

2.20EURand3.60GBPhavebeenaddedsincethelastpoll

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 11 F0 BF 02 DC 00 00 00 45 55 52 68 01 00 00 47 42 50 D1 05
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketsLow 0xA0 160

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

Thiseventisreportedwhenthelevelofticketsinthedevicearedetectedasbeingatalow
levelonthedevice'sticketlevelsensor.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Additionalinfomation

Notfiytorefilltickets.

Packetexamples

Hosttransmit:
SlaveReply: 7F 80 02 F0 A0 FF A3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketsReplaced 0xA1 161

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

Thiseventisreportedwhenthelevelofticketshasbeendetectedasgoingoverthelow
levelagain.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 A1 FA 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

PrinterHeadRemoved 0xA2 162

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

Theheadfortheprinterhasbeentakenoutandticketscannotbeprinted.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Error 0 yes no

Additionalinfomation

Replaceheadforoperation

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 A2 F0 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketPathOpen 0xA3 163

Implementedon

FLATBEDPRINTER,SMARTTICKET

Description

Theprinter'spathhasbeenopened,andticketscannotbeprinted.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Error 0 yes no

Additionalinfomation

Closepathtoenabledevice.

Packetexamples
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketJam 0xA4 164

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

Ajamoccuredwhenattemptingtoprintaticket.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Error 0 yes no

Additionalinfomation

Clearjamfrompathandresetdevice.

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 A4 E4 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketPrinting 0xA5 165

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,NV200,SMARTTICKET

Description

Aticketiscurrentlybeingprinted.OnanNV200thiseventwillonlybereportedifthereisa
SMARTTicketattached,andticketeventshavebeenenabled.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 A5 E1 A3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketPrinted 0xA6 166

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,NV200,SMARTTICKET

Description

Atickethassuccessfullybeenprintedanddispensed.OnanNV200thiseventwillonlybe
reportedifthereisaSMARTTicketattached,andticketeventshavebeenenabled.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 A6 EB A3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketPrintingError 0xA8 168

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,NV200,SMARTTICKET

Description

Unabletoprinttherequestedticket.Theeventincludesadatabyteindicatingthereasonfor
failure:

Error Code Devices

Nopaper 0 SMARTTicket,CouponPrinter

Loadfail 1 SMARTTicket,CouponPrinter

Nohead 2 SMARTTicket,CouponPrinter

Diverterdidnotopen 3 SMARTTicket

Diverterdidnotclose 4 SMARTTicket

Burstfail 5 SMARTTicket

Cutfail 6 SMARTTicket,CouponPrinter

Reversevalidatefail 7 SMARTTicket,NV200

Jam 8 SMARTTicket,NV200

NV200fail 9 SMARTTicket

NV200Timeout 10 SMARTTicket

NV200CashboxError 17 NV200

SMARTTicketTimeout 19 NV200

OnanNV200thiseventwillonlybereportedifthereisaSMARTTicketattached,andticket
eventshavebeenenabled.

TheSMARTTicketwillreportreasons0to10asanerror.IftheerroriswiththeNV200,it
willreportNV200FailorNV200Timeout.TheNV200willreportreason7,8,17or19.The
twodeviceswillgenerallyreportdifferenterrors.JamfromaSMARTTicketreferstoa
specificjamintransitfromtheSMARTTickettotheNV200whenreportedfromtheSMART
Ticket.FromtheNV200,ajamcouldbeanyofthejamconditionstheSMARTTicketmay
encounter,andtheeventdatafromtheSMARTTicketshouldbedeferedto.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Error 1 no no

Additionalinfomation
Examineerrorbytecauseandremedy.

Packetexamples

Showprintfailresponseduetojam

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 03 F0 A8 08 F9 58
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

PrinterHeadReplaced 0xA9 169

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

Theprinterheadwasreplacedafterbeingremoved.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 A9 C9 A3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketPathClosed 0xAA 170

Implementedon

FLATBEDPRINTER,SMARTTICKET

Description

Theticketpathwasclosedafterbeingopened.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 AA C3 A3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

NoPaper 0xAB 171

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

Thereisnopapercurrentlyfedintothedevice.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Error 0 yes no

Additionalinfomation

Fitticketpaper.

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 AB C6 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

PrintHalted 0xAE 174

Implementedon

NV200

Description

Theticketprintingprocessstopped.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 AE D8 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketInBezel 0xAD 173

Implementedon

NV200,NV9USB

Description

Printedticketisheldinbezel.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 AD D2 23
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

PaperReplaced 0xAC 172

Implementedon

COUPONPRINTER,FLATBEDPRINTER,NV12,SMARTTICKET

Description

Ticketpaperwasreplacedinthedevice.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 AC D7 A3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

PrintedToCashbox 0xAF 175

Implementedon

NV200,NV9USB

Description

Aprintedtickethasbeedstoredinthedevicecashbox.

Protocolminimumversion6

Type Datasize(bytes) Repeat PollwithAck

Status 0 no no

Packetexamples

Hosttransmit: 7F 80 01 07 12 02
SlaveReply: 7F 80 02 F0 AF DD A3
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

PayinActive 0xC1 193

Implementedon

SMARTSYSTEM

Description

Thepayinfunctionofthesystemisactive.

Protocolminimumversion7

Type Datasize(bytes) Repeat PollwithAck

Status 0 yes no

Packetexamples

Pollresponseshowingpayinfunctionisactive

Hosttransmit: 7F 90 01 07 51 83
SlaveReply: 7F 90 02 F0 C1 BC 62
SSPProtocolManualGA138_2_2_222A

<<backtoindex

Event Codehex Codedecimal

TicketInBezelAtStartup 0xA7 167

Implementedon

FLATBEDPRINTER

Description

Aticketwasdispensedoutofthefrontofthedeviceatstartupduetopowerlossduringa
print.It'spossiblethisticketprintwasincomplete,andsoanydataprintedontheticket
shouldbeinvalidated.

Packetexamples

You might also like