innovative technology NV10 USB+ User manual

INNOVATIVETECHNOLOGYLTD

ProtocolManual

SSP

NV9USB,NV10USB,NV11 ,SMARTHOPPER,

NV200,SMARTPAYOUT,BV20,BV50,

BV100,SMARTSYSTEM,SMARTTICKET,

COUPONPRINTER,NV150,FLATBED

PRINTER,NV12

versionGA138_2_2_222A

SSPProtocolManualGA138_2_2_222A
Contents
Descriptions
Introduction ........
GeneralDescription ........
Hardwarelayer ........
TransportLayer ........
EncryptionLayer ........
EncryptionKeys ........
GenericCommandsandResponses ........
ProtocolVersions ........
BanknoteValidator ........
RejectCodes ........
SMARTTicket ........
SMARTHopper ........
CouponPrinter ........
SMARTPayout ........
SmartSystem ........
NoteFloat(NV11) ........
TEBS ........
NVR280(NV12) ........
FlatbedPrinter(FBF166) ........
Command/EventTables
NV9USBCommandTable ........
NV9USBEventTable ........
NV10USBCommandTable ........
NV10USBEventTable ........
NV11CommandTable ........
NV11EventTable ........
SMARTHOPPERCommandTable ........
SMARTHOPPEREventTable ........
NV200CommandTable ........
NV200EventTable ........
SMARTPAYOUTCommandTable ........
SMARTPAYOUTEventTable ........
BV20CommandTable ........
BV20EventTable ........
BV50CommandTable ........
BV50EventTable ........
BV100CommandTable ........
BV100EventTable ........
SMARTSYSTEMCommandTable ........
SMARTSYSTEMEventTable ........
SMARTTICKETCommandTable ........
SMARTTICKETEventTable ........
COUPONPRINTERCommandTable ........
COUPONPRINTEREventTable ........
NV150CommandTable ........
NV150EventTable ........
FLATBEDPRINTERCommandTable ........
FLATBEDPRINTEREventTable ........
NV12CommandTable ........
NV12EventTable ........
Commands
Sync ........
Reset ........
HostProtocolVersion ........
Poll ........
GetSerialNumber ........
Disable ........
Enable ........
GetFirmwareVersion ........

GetDatasetVersion ........
SetInhibits ........
DisplayOn ........
DisplayOff ........
SetupRequest ........
Reject ........
UintData ........
ChannelValueData ........
ChannelSecurityData ........
ChannelReteachData ........
LastRejectCode ........
Hold ........
GetBarcodeReaderConfiguration ........
SetBarcodeReaderConfiguration ........
GetBarcodeInhibit ........
SetBarcodeInhibit ........
GetBarcodeData ........
ConfigureBezel ........
PollWithAck ........
EventAck ........
SetDenominationRoute ........
GetDenominationRoute ........
PayoutAmount ........
GetDenominationLevel ........
SetDenominationLevel ........
HaltPayout ........
FloatAmount ........
GetMinPayout ........
SetCoinMechInhibits ........
PayoutByDenomination ........
FloatByDenomination ........
EmptyAll ........
SetOptions ........
GetOptions ........
CoinMechGlobalInhibit ........
SmartEmpty ........
CashboxPayoutOperationData ........
GetAllLevels ........
GetCounters ........
ResetCounters ........
SetRefillMode ........
GetNotePositions ........
PayoutNote ........
StackNote ........
SetValueReportType ........
SetGenerator ........
SetModulus ........
RequestKeyExchange ........
CoinMechOptions ........
GetBuildRevision ........
EnablePayoutDevice ........
DisablePayoutDevice ........
CommsPassThrough ........
SetBaudRate ........
SspSetEncryptionKey ........
SspEncryptionResetToDefault ........
GetRealTimeClockConfiguration ........
SetRealTimeClock ........
GetRealTimeClock ........
SetCashboxPayoutLimit ........
EnableTitoEvents ........
CoinStir ........
TicketPrint ........
AddStaticText ........
AddPlaceHolderText ........
AddStaticBarcode ........
GetImageSize ........
GetBarcodeSize ........

GetTicketResolution ........
GetFontInformation ........
GetQrCodeDimensions ........
PrintTicket ........
PrintBlankTicket ........
GetTextSize ........
SetQrPlaceholder ........
AddQrCode ........
AddQrPlaceholder ........
ClearOnTheFlyBuffer ........
SetPlaceholder ........
ClearTemplate ........
AddPlaceholderBarcode ........
AddImage ........
GetTicketSize ........
GetFreeStorage ........
CheckForTemplate ........
GetPresentTemplates ........
GetPresentFonts ........
GetPresentImages ........
GetTemplateInfo ........
GetTemplateItemInfo ........
GetImageFileChecksum ........
GetTicketBounds ........
GetPixelDensity ........
PrinterConfiguration ........
SetTicketMode ........
SetTicketWidth ........
SetTicketHeight ........
SetPrintingQuality ........
EnableReverseValidation ........
DisableReverseValidation ........
EnableReverseValidation ........
DisableReverseValidation ........
DeleteFile ........
DeleteFileGroup ........
SetPaperSavingMode ........
SetBezelType ........
SetPrintingQuality ........
CancelEscrowTransaction ........
CommitEscrowTransaction ........
ReadEscrowValue ........
GetEscrowSize ........
SetEscrowSize ........
PayoutAmountByDenomination ........
Events
SlaveReset ........
Read ........
NoteCredit ........
Rejecting ........
Rejected ........
Stacking ........
Stacked ........
SafeJam ........
UnsafeJam ........
Disabled ........
FraudAttempt ........
StackerFull ........
NoteClearedFromFront ........
NoteClearedIntoCashbox ........
CashboxRemoved ........
CashboxReplaced ........
BarcodeTicketValidated ........
BarcodeTicketAck ........
NotePathOpen ........
ChannelDisable ........
Initialising ........

Dispensing ........
Dispensed ........
CoinsLow ........
HopperJammed ........
Halted ........
Floating ........
Floated ........
Timeout ........
IncompletePayout ........
IncompleteFloat ........
CashboxPaid ........
CoinCredit ........
CoinMechJammed ........
CoinMechReturnActive ........
Emptying ........
Emptied ........
SmartEmptying ........
SmartEmptied ........
CalibrationFailed ........
NoteStoredInPayout ........
PayoutOutOfService ........
JamRecovery ........
ErrorDuringPayout ........
NoteTransferedToStacker ........
NoteHeldInBezel ........
NoteIntoStoreAtReset ........
NoteIntoStackerAtReset ........
NoteDispensedAtReset ........
NoteFloatRemoved ........
NoteFloatAttached ........
DeviceFull ........
CoinMechError ........
AttachedCoinMechDisabled ........
AttachedCoinMechEnabled ........
ValueAdded ........
TicketsLow ........
TicketsReplaced ........
PrinterHeadRemoved ........
TicketPathOpen ........
TicketJam ........
TicketPrinting ........
TicketPrinted ........
TicketPrintingError ........
PrinterHeadReplaced ........
TicketPathClosed ........
NoPaper ........
PrintHalted ........
TicketInBezel ........
PaperReplaced ........
PrintedToCashbox ........
PayinActive ........
TicketInBezelAtStartup ........

Introduction

SSPProtocolManualGA138_2_2_222A

<<backtoindex



ThismanualdescribestheoperationoftheSmiley®SecureProtocolSSP.

ITLrecommendthatyoustudythismanualastherearemanynewfeaturespermittingnewusesandmore

secureapplications.

IfyoudonotunderstandanypartofthismanualpleasecontacttheITLforassistance.Inthiswaywemay

continuetoimproveourproduct.

Alternativelyvisitourwebsiteatwww.innovativetechnology.co.uk

EnhancementsofSSPcanberequestedbycontacting:

support@innovativetechnology.co.uk

MAINHEADQUARTERS

InnovativeTechnologyLtd

DerkerStreet,Oldham,England.OL14EQ

Tel:+441616269999Fax:+441616202090

Email:support@innovativetechnology.co.uk

Website:www.innovativetechnology.co.uk

Smiley®andtheITLLogoareinternationalregisteredtrademarksandtheyarethepropertyof

InnovativeTechnologyLimited.

InnovativeTechnologyhasanumberofEuropeanandInternationalPatentsandPatentsPendingprotecting

thisproduct.IfyourequirefurtherdetailspleasecontactITL®.

InnovativeTechnologyisnotresponsibleforanyloss,harm,ordamagecausedbytheinstallation

anduseofthisproduct.

Thisdoesnotaffectyourlocalstatutoryrights.

Ifindoubtpleasecontactinnovativetechnologyfordetailsofanychanges.



GeneralDescription

SSPProtocolManualGA138_2_2_222A

<<backtoindex

Smiley®SecureProtocol(SSP)isasecureinterfacespecificallydesignedbyITL®toaddresstheproblems

experiencedbycashhandlingsystemsingamingmachines.Problemssuchasacceptorswapping,

reprogrammingacceptorsandlinetappingarealladdressed.

Theinterfaceusesamasterslavemodel,thehostmachineisthemasterandtheperipherals(noteacceptor,

coinacceptororcoinhopper)aretheslaves.

Datatransferisoveramultidropbususingclockasynchronousserialtransmissionwithsimpleopencollector

drivers.Theintegrityofdatatransfersisensuredthroughtheuseof16bitCRCchecksumsonallpackets.

EachSSPdeviceofaparticulartypehasauniqueserialnumber;thisnumberisusedtovalidateeachdevice

inthedirectionofcredittransferbeforetransactionscantakeplace.Itisrecommendedthattheencryption

systembeusedtopreventfraudthroughbusmonitoringandtapping.Thisiscompulsoryforallpayout

devices.

Commandsarecurrentlyprovidedforcoinacceptors,noteacceptorsandcoinhoppers.Allcurrentfeaturesof

thesedevicesaresupported.

FEATURES:

SerialcontrolofNote/CoinValidatorsandHoppers

4wire(Tx,Rx,+V,Gnd)system

Opencollectordriver,similartoRS232

HighSpeed9600BaudRate

16bitCRCerrorchecking

DataTransferMode

Encryptionkeynegotiation

128BitAESEncryptedMode

BENEFITS:

Proveninthefield

Simpleandlowcostinterfacingoftransactionperipherals.

Highsecuritycontrolofpayoutperipherals.

Defenceagainstsurrogatevalidatorfraud.

Straightforwardintegrationintohostmachines.

Remoteprogrammingoftransactionperipherals

Openstandardforuniversaluse.



TohelpinthesoftwareimplementationoftheSSP,ITLcanprovide,C/C++Code,C#.NetCode,DLLcontrols

availableonrequest.Pleasecontact:support@innovativetechnology.co.uk

Hardwarelayer

SSPProtocolManualGA138_2_2_222A

<<backtoindex

Communicationisbycharactertransmissionbasedonstandard8bitasynchronousdatatransfer.

OnlyfourwiresarerequiredTxD,RxD,+Vandground.Thetransmitlineofthehostisopencollector,the

receivelineofeachperipheralhasa10Kohmpullupto5volts.Thetransmitoutputofeachslaveisopen

collector,thereceiveinputofthehosthasasingle3k3ohmpullupto5volts.

Thedataformatisasfollows:



Encoding NRZ

BaudRate 9600

Duplex Full

Startbits 1

DataBits 8

Parity none

Stopbits 2



Caution:Pow ertoperipheraldeviceswouldn ormallybeviatheserialbus.Howeverdevicesthat

requireahighcurrentsupplyinexcessof 1.5Amps,e.g.hoppers,wouldbeexpectedtobe

suppliedviaaseparateconnector.

TransportLayer

SSPProtocolManualGA138_2_2_222A

<<backtoindex

Dataandcommandsaretransportedbetweenthehostandtheslave(s)usingapacketformatasshown

below:

STX SEQ/SLAVEID LENGTH DATA CRCL CRCH



STX Singlebyteindicatingthestartofamessage0x7Fhex

SEQ/

Slave

ID

Bit7isthesequenceflagofthepacket,bits60representtheaddressoftheslavethe

packetisintendedfor,thehighestallowableslaveIDis0x7D

LENGTH

ThelengthofthedataincludedinthepacketthisdoesnotincludeSTX,theCRCorthe

slaveID

DATA Commandsanddatatobetransferred

CRCL,

CRCH

LowandhighbyteofaforwardCRC16algorithmusingthePolynomial(X16+X15+X2

+1)calculatedonallbytes,exceptSTX.Itisinitialisedusingtheseed0xFFFF.TheCRC

is

calculatedbeforebytestuffing.

PACKETSEQUENCING

BytestuffingisusedtoencodeanySTXbytesthatareincludedinthedatatobetransmitted.If0x7F(STX)

appearsinthedatatobetransmittedthenitshouldbereplacedby0x7F,0x7F.

BytestuffingisdoneaftertheCRCiscalculated,theCRCitsselfcanbebytestuffed.Themaximumlengthof

datais0xFFbytes.

Thesequenceflagisusedtoallowtheslavetodeterminewhetherapacketisaretransmissionduetoitslast

replybeinglost.Eachtimethemastersendsanewpackettoaslaveitalternatesthesequenceflag.Ifaslave

receivesapacketwiththesamesequenceflagasthelastone,itdoesnotexecutethecommandbutsimply

repeatsit'slastreply.Inareplypackettheaddressandsequenceflagmatchthecommand

packet.

Thisensuresthatnootherslavesinterpretthereplyasacommandandinformsthemasterthatthecorrect

slavereplied.Afterthemasterhassentacommandtooneoftheslaves,itwillwaitfor1secondforareply.

Afterthat,itwillassumetheslavedidnotreceivethecommandintactsoitwillretransmititwiththesame

sequenceflag.Thehostshouldalsorecordthefactthatagapintransmissionhasoccurredandprepareto

polltheslaveforitsserialnumberidentityfollowingthecurrentmessage.Inthisway,thereplacementofthe

hostsvalidatorbyafraudulentunitcanbedetected.

Thefrequencyofpollingshouldbeselectedtominimisethepossibilityofswappingavalidatorbetweenpolls.

Iftheslavehasnotreceivedtheoriginaltransmission,itwillseetheretransmissionasanewcommandsoit

willexecuteitandreply.Iftheslavehadseentheoriginalcommandbutitsreplyhadbeencorruptedthen

theslavewillignorethecommandbutrepeatitsreply.Aftertwentyretries,themasterwillassumethatthe

slavehascrashed.Aslavehasnotimeoutorretrylimit.Ifitreceivesalonesyncbytepartwaythrough

receivingapacketitwilldiscardthepacketreceivedsofarandtreatthenextbyteasanaddressbyte.

EncryptionLayer

SSPProtocolManualGA138_2_2_222A

<<backtoindex

PACKETFORMAT

Encryptionismandatoryforallpayoutdevicesandoptionalforpayindevices.Encrypteddataandcommands

aretransportedbetweenthehostandtheslave(s)usingthetransportmechanismdescribedabove,the

encryptedinformationisstoredinthedatafieldintheformatshownbelow:

STX SEQ/SLAVEID LENGTH DA TA CRCL CRCH

DATA

STEX EncryptedData

EncryptedData

eLENGTH eCOUNT eDATA ePACKING eCRCL eCRCH



STEX Singlebyteindicatingthestartofanencrypteddatablock0x7E

eLENGTH

ThelengthofthedataincludedinthepacketthisdoesnotincludeSTEX,COUNT,

the

packingortheCRC

eCOUNT

Afourbyteunsignedinteger.Thisisasequencecountofencryptedpackets,itis

incrementedeachtimeapacketisencryptedandsent,andeachtimeanencrypted

packet

isreceivedanddecrypted.

eDATA Commandsordatatobetransferred

ePACKING

Randomdatatomakethelengthofthelength+count+data+packing+CRCL+

CRCH

tobeamultipleof16bytes

eCRCL/eCRCH

LowandhighbyteofaforwardCRC16algorithmusingthepolynomial(X16+X15

+X2

+1)calculatedonallbytesexceptSTEX.Itisinitialisedusingtheseed0xFFFF



Afterpowerupandresettheslavewillstaydisabledandwillrespondtoallcommandswiththegeneric

responseKEY_NOT_SET(0xFA),withoutexecutingthecommand,untilthekeyhasbeennegotiated.There

aretwoclassesofcommandandresponse,generalcommandsandcommandsinvolvedincredittransfer.

Generalcommandsmaybesentwithorwithoutusingtheencryptionlayer.Theslavewillreplyusingthe

samemethod,unlesstheresponsecontainscreditinformation,inthiscasethereplywillalwaysbeencrypted.

Credit

transfercommands,ahopperpayoutforexample,willonlybeacceptedbytheslaveifreceivedencrypted.

Commandsthatmustbeencryptedonanencryptionenabledproductareindicatedonthecommand

descriptionsforeachcommand.TheSTEXbyteisusedtodeterminethepackettype.Ideallyall

communicationswillbeencrypted.

AfterthedatahasbeendecryptedtheCRCalgorithmisperformedonallbytesincludingtheCRC.Theresult

ofthiscalculationwillbezeroifthedatahasbeendecryptedwiththecorrectkey.Iftheresultofthis

calculationisnonzerothentheperipheralshouldassumethatthehostdidnotencryptthedata(transmission

errorsaredetectedbythetransportlayer).Theslaveshouldgooutofserviceuntilitis

reset.

Thepacketsaresequencedusingthesequencecount;thisisresetto0afterapowercycleandeachtimethe

encryptionkeysaresuccessfullynegotiated.Thecountisincrementedbythehostandslaveeachtimethey

successfullyencryptandtransmita

packet.AfterapacketissuccessfullydecryptedtheCOUNTinthepacketshouldbecomparedwiththe

internalCOUNT,iftheydonotmatchthenthepacketisdiscarded.



EncryptionKeys

SSPProtocolManualGA138_2_2_222A

<<backtoindex

Theencryptionkeylengthis128bits.Howeverthisisdividedintotwoparts.Thelower64bitsarefixedand

specifiedbythemachinemanufacturer,thisallowsthemanufacturercontrolwhichdevicesareusedintheir

machines.

Thehigher64bitsaresecurelynegotiatedbytheslaveandhostatpowerup,thisensureseachmachineand

eachsessionareusingdifferentkeys.ThekeyisnegotiatedbytheDiffieHellmankeyexchangemethod.

See:en.wikipedia.org/wiki/DiffieHellman



Theexchangemethodissummarisedinthetablebelow.Ccodefortheexchangealgorithmisavailablefrom

ITL.



Step Host Slave

1 GenerateprimenumberGENERATOR 

2

UsecommandSetGeneratortosendto

slaveCheckGENERATORisprimeandstore

CheckGENERATORisprimeandstore

3 GenerateprimenumberMODULUS 

4

UsecommandSetModulustosendtoslave

CheckMODULUSisprimeandstore

5 GenerateRandomNumberHOST_RND 

6

CalculateHostInterKey:=GENERATOR

^HOST_RNDmodMODULUS



7

UsecommandRequestKeyExchangeto

sendtoslave.

GenerateRandomNumberSLAVE_RND

8 

CalculateSlaveInterKey:=GENERATOR^

SLAVE_RNDmodMODULUS

9 

SendtohostasreplytoRequestKey

Exchange

10

CalculateKey:=SlaveInterKey^

HOST_RNDmodMODULUS

CalculateKey:=HostInterKey^

SLAVE_RNDmod

MODULUS

Note:^representstothepowerof



GenericCommandsandResponses

SSPProtocolManualGA138_2_2_222A

<<backtoindex

AlldevicesmustrespondtoalistofsocalledGenericCommandsasshowinthetablebelow.

Command Code

Reset 0x01

HostProtocolVersion 0x06

GetSerialNumber 0x0C

Sync 0x11

Disable 0x09

Enable 0x0A

GetFirmwareVersion 0x20

GetDatasetVersion 0x21



AdevicewillrespondtoallcommandswiththefirstdatabyteasoneoftheGenericresponseslistbelow..

GenericResponse Code Description

OK 0xF0

Returnedwhenacommandfromthehostisunderstood

and

hasbeen,orisintheprocessof,beingexecuted.

COMMANDNOTKNOWN 0xF2

Returnedwhenaninvalidcommandisreceivedbya

peripheral.

WRONGNoPARAMETERS 0xF3

Acommandwasreceivedbyaperipheral,butan

incorrect

numberofparameterswerereceived.

PARAMETERS 0xF4

Oneoftheparameterssentwithacommandisoutof

range.

COMMANDCANNOTBE

PROCESSED

0xF5

Acommandsentcouldnotbeprocessedatthattime.

E.g.

sendingadispensecommandbeforethelastdispense

operationhascompleted.

SOFTWAREERROR 0xF6

Reportedforerrorsintheexecutionofsoftwaree.g.

Divide

byzero.Thismayalsobereportedifthereisaproblem

resultingfromafailedremotefirmwareupgrade,inthis

case

thefirmwareupgradeshouldberedone.

FAIL 0xF8 Commandfailure

KEYNOTSET 0xFA

Theslaveisinencryptedcommunicationmodebutthe

encryptionkeyshavenotbeennegotiated.



ProtocolVersions

SSPProtocolManualGA138_2_2_222A

<<backtoindex

AnSSPPollcommandreturnsalistofeventsanddatathathaveoccurredinthedevicesincethelastpoll.

Thehostmachinethenreadsthiseventlisttakingnoteofthedatalength(ifany)ofeachevent.

Onordertointroducenewevents,SSPusesasystemofProtocolVersionlevelstoidentifytheeventtypes

andsizesamachinecanexpecttoseeinreponsetoapoll.Ifthiswerenotdone,newunknowneventswith

unknowndatasizetoamachinenotsetupforthesewouldcausetheeventreadingtofail.

Ahostsystemshouldtakenoteoftheprotocolversionofthedeviceconnectedandensurethatitisnotset

forahigerversionthattheoneitisexpectingtouse.

Thehostcanalsocheckthatthedevicecanalsobesettothehigherprotocollevel,enusringthatexpected

eventswillbeseen.

Thelistedeventsinthismanualshowtheprotocolversionlevelofeachevent.

Aspartofthestartupprocedure,thehostshouldreadthecurrentprotocollevelofthedevice(usingtheset

uprequestcommand).



BanknoteValidator

SSPProtocolManualGA138_2_2_222A

<<backtoindex

ABanknoteValidatorisadevicewhichwillscan,validateandstackabanknoteitdetectsasvalidorrejectit

fromthefrontifnotvalid.Somebanknotevalidatorscanbetransformedintopayoutdevicesbytheaddition

ofapayoutunit.AllITL™BanknotevalidatorssupporttheSSPprotocoldescribedhere.

TheBanknoteValidatorshaveadefaultSSPAddressof0 .

Thesetuprequestreponsetableforbanknotevalidatortypes:

Protocolversionslessthan6:

Data byteoffset

size

(bytes)

notes

Unittype 0 1 0x00=Banknotevalidator

Firmware

version

1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)

Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')

Value

Multiplier

8 3

3Thevaluetomultiplytheindividualchannelsbytogetthe

fullvalue.Ifthisvalueis0thenitindicatesthatthisisa

protocolversion6orgreatercompatibledatasetwherethe

valuesaregivenintheexpandedsegmentofthereturndata.

Numberof

channels

11 1 Thehighestchannelusedinthisdevicedataset[n](116)

Channel

Values

12 n

Avariablesizearrayofbyes,1foreachchannelwithavalue

from1to255whichwhenmultipliedbythevaluemultiplier

givesthefullvalueofthenote.Ifthevaluemultiplieriszero

thenthesevaluesarezero.

Channel

Security

12+n n

Anobsoletevalueshowingsecuritylevel.Thisissetto2if

thevaluemultiplieris>0otherwise0.

Realvalue

Multiplier

12+(n*2) 3

Thevaluebywhichthechannelvaluescanbemultipliedto

showtheirfullvaluee.g.5.00EUR=500EURcents

Protocol

version

15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice



Protocolversionsgreaterthanorequalto6:

Data byteoffset

size

(bytes)

notes

Unittype 0 1 0=Banknotevalidator

Firmware

version

1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)

Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')

Value

Multiplier

8 3

3Thevaluetomultiplytheindividualchannelsbytogetthe

fullvalue.Ifthisvalueis0thenitindicatesthatthisisa

protocolversion6orgreatercompatibledatasetwherethe

valuesaregivenintheexpandedsegmentofthereturndata.

Numberof

channels

11 1 Thehighestchannelusedinthisdevicedataset[n](116)

Channel

Values

12 n

Avariablesizearrayofbyes,1foreachchannelwithavalue

from1to255whichwhenmultipliedbythevaluemultiplier

givesthefullvalueofthenote.Ifthevaluemultiplieriszero

thenthesevaluesarezero.

Channel

Security

12+n n

Anobsoletevalueshowingsecuritylevel.Thisissetto2if

thevaluemultiplieris>0otherwise0.

Realvalue

Multiplier

12+(n*2) 3

Thevaluebywhichthechannelvaluescanbemultipliedto

showtheirfullvaluee.g.5.00EUR=500EURcents

Protocol

version

15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice

Expanded

channel

country

code

16+(n*2) n*3

Threebyteasciicodeforeachchannel.Thisallowsmulti

currencydatasetstobeusedonSSPdevices.Thesebytesare

givenonlyonprotocolversions>=6.

Expanded

channel

value

16+(n*5) n*4

4bytesforeachchannelvalue.Thesebytesaregivenonlyon

protocolversions>=6.



RejectCodes

SSPProtocolManualGA138_2_2_222A

<<backtoindex

ThebanknotevalidatorspecificationincludesacommandLastRejectCode.

Usethiscommandafteranotehasbeenrejectedtoreturnaonebytecodetodeterminethecauseofthe

notereject.

Tableshowingrejectcodes:

0x00 0 NOTEACCEPTED Thebanknotehasbeenaccepted.Norejecthasoccured.

0x01 1 LENGTHFAIL

Avalidationfail:Thebanknotehasbeenreadbutit'slengthregistersoverthemaxlength

parameter.

0x02 2 AVERAGEFAIL Internalvalidationfailurebanknotenotrecognised.

0x03 3 COASTLINEFAIL Internalvalidationfailurebanknotenotrecognised.

0x04 4 GRAPHFAIL Internalvalidationfailurebanknotenotrecognised.

0x05 5 BURIEDFAIL Internalvalidationfailurebanknotenotrecognised.

0x06 6 CHANNELINHIBIT Thisbanknotehasbeeninhibitedforacceptanceinthedatasetconfiguration.

0x07 7

SECONDNOTE

DETECTED

Asecondbanknotewasinsertedintothevalidatorwhilethefirstonewasstillbeing

transportedthroughthebanknotepath.

0x08 8 REJECTBYHOST ThehostsystemissuesaRejectcommandwhenthisbanknotewasheldinescrow.

0x09 9

CROSSCHANNEL

DETECTED

Thisbanknotewasidentifiedasexisitingintwoormoreseperatechanneldefinitionsinthe

dataset.

0x0A 10

REARSENSOR

ERROR

Aninconsistencyinapositionsensordetectionwasseen

0x0B 11 NOTETOOLONG Thebanknotefaileddatasetlengthchecks.

0x0C 12 DISABLEDBYHOST

Thebanknotewasvalidatedonachannelthathasbeeninhibitedforacceptancebythe

hostsystem.

0x0D 13 SLOWMECH Theinternalmechanismwasdetectedasmovingtooslowlyforcorrectvalidation.

0x0E 14 STRIMATTEMPT Anattempttofraudthesystemwasdetected.

0x0F 15 FRAUDCHANNEL Obseleteresponse.

0x10 16

NONOTES

DETECTED

Abanknotedetectionwasinitiatedbutnobanknoteswereseenatthevalidationsection.

0x11 17 PEAKDETECTFAIL Internalvalidationfail.Banknotenotrecognised.

0x12 18

TWISTEDNOTE

REJECT

Internalvalidationfail.Banknotenotrecognised.

0x13 19 ESCROWTIMEOUT

Abanknoteheldinescrowwasrejectedduetothehostnotcommunicatingwithinthetime

outperiod.

0x14 20

BARCODESCAN

FAIL

Internalvalidationfail.Banknotenotrecognised.

0x15 21 NOCAMACTIVATE Abanknotedidnotreachtheinternalnotepathforvalidationduringtransport.

0x16 22 SLOTFAIL1 Internalvalidationfail.Banknotenotrecognised.

0x17 23 SLOTFAIL2 Internalvalidationfail.Banknotenotrecognised.

0x18 24 LENSOVERSAMPLE Thebanknotewastransportedfasterthanthesystemcouldsamplethenote.

0x19 25

WIDTHDETECTION

FAIL

Thebanknotefailedameasurementtest.

0x1A 26

SHORTNOTE

DETECT

Thebanknotemeasuredlengthfelloutsideofthevalidationparameterforminimumlength.

0x1B 27 PAYOUTNOTE

Therejectcodecammandwasissuedafteranotewaspayedoutusinganotepayout

device.

0x1C 28

DOUBLENOTE

DETECTED

Motethanonebanknotewasdetectedasoverlayedduringnoteentry.

0x1D 29 UNABLETOSTACK

Thebankwasunabletoreachit'scorrectstackingpositionduringtransport.

SMARTTicket

SSPProtocolManualGA138_2_2_222A

<<backtoindex

TheSMARTTicketdeviceisanaddonunittotheNV200toenableprintingandpayoutviatheNV200bezelof

paperticketsofconfigurabaledesigns.ArangeofSSPcommandsmaybeimplementedtoconfigure,modify

andmaintainprintdesignsfromthehostontheflyorbypreconfiguredtemplates.

TheSMARTTicketdeviceisaddressedseperatelyfromtheNV200,theNV200setuprequestcommandwill

return0x08fortheUinttypeifaSMARTTicketdeviceisattached.

WhencommunicatingwiththeNV200attachedtotheprinter,optionaladditionalpolleventsmaybeenabled.

TheseareenabledbysendinganSSPpacketwiththecommandheader0x72totheNV200.Pollswillthe

respondwiththesameprinting(0xA5)andprinted(0xA6)pollresponsesastheprinter.

TheSMARTTickethasadefaultSSPAddressof64dec0x40hex

ThesetuprequestreponsetableforSMARTTickettypes:



Data byteoffset

size

(bytes)

notes

Unittype 0 1 8=AddonPrinter

Firmware

version

1 4

ASCIIdataofdevicefirmwareversion(e.g.'0110'=

1.10)

Cutterenabled

status

5 1 (0fordisabled)

Tabenabled

status

6 1 (0fordisabled)

Reverse

validation

enabled

status

7 1 (0fordisabled)

Fontpackcode

(ASCII)

8 3 e.g.'FP1'

Printertype 11 1

PrinterType:0x0forFanFold,0x1PaperRoll

(Cutterfitted)

SDcardfitted

status

12 1 1fordetected

Printer

darkness/quality

setting

13 1 Thecurrentprotocolversionsetforthisdevice



SMARTHopper

SSPProtocolManualGA138_2_2_222A

<<backtoindex

SMARTHopperisacoinpayoutdevicecapableofdiscriminatingandpayingoutmultidenominationsof

storedcoinsfromitsinternalstoragehopper.

Coinsaddedtothehoppercanbedesignatedtoberoutedtoanexternalcashboxondetectionorrecycledand

storedinthehopperunittobeavailableforarequestedpayout.

SMARTHopperalsosupportstheadditionofaconnectedcctalk™oreSSP™coinmechanismwhichwill

automaticallyadditsvalidatedcoinstotheSMARTHoppersystemlevels.

Notethatpayoutvaluesareintermsoftheofthepennyvalueofthatcurrency.Sofor5.00,thevaluesent

andreturnedbythehopperwouldbe500.AlltransactionswithaSMARThoppermustbeencryptedto

preventdispensecommandsbeingrecordedandreplayedbyanexternaldevice.

Addressing

TheSMARTHopperhasadefaultSSPAddressof16dec0x10hex.

Thesetuprequestreponsetableforcoinhoppertypes:

Protocolversionlessthan6:

Data byteoffset

size

(bytes)

notes

Unittype 0 1 3=SMARTHopper

Firmware

version

1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)

Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')

Protocol

Version

8 1 Thecurrentprotocolversionsetforthisdevice

Numberof

coinvalues

9 1

Thenumberofcoindenominationsinthisdevicedataset.

[n]

Coinvalues 10 n*2

2byteeachvalueforthecoindenominations(e.g.0.05

coin=0x05,0x00)



Protocolversiongreatero requalto6:

Data byteoffset

size

(bytes)

notes

Unittype 0 1 3=SMARTHopper

Firmware

version

1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)

Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')

Protocol

Version

8 1 Thecurrentprotocolversionsetforthisdevice

Numberof

coinvalues

9 1 Thenumberofcoindenominationsinthisdevicedataset.[n]

Coinvalues 10 n*2

2byteeachvalueforthecoindenominations(e.g.0.05coin

=0x05,0x00)

Countrycodes 10+(n*2) 

Anobsoletevalueshowingsecuritylevel.Thisissetto2if

thevaluemultiplieris>0otherwise0.

CouponPrinter

SSPProtocolManualGA138_2_2_222A

<<backtoindex

TheCouponPrinterdeviceisastandalonethermalprinterdesignedforprintingcoupons/recepits/tickets

usingrollmediawithawidthof58mm.ArangeofSSPcommandmaybeimplementedtoconfigure,modify

andmaintainprintdesignsfromthehostontheflyorbypreconfiguredtemplates.

Thecommandsrelyonperexistingresourcesofimages,fontsandtemplatesthatareprogrammedintothe

CouponPrinterdevice.

TheCouponPrinterhasadefaultSSPAddressof65dec0x41hex

ThesetuprequestreponsetableforCouponPrintertypes:



Data byteoffset

size

(bytes)

notes

Unittype 0 1 0x0B=StandAlonePrinter

Firmware

version

1 4

ASCIIdataofdevicefirmwareversion(e.g.'0110'=

1.10)

Cutterenabled

status

5 1 (0fordisabled)

Tabenabled

status

6 1 (0fordisabled)

Reverse

validation

enabled

status

7 1 (0fordisabled)

Fontpackcode

(ASCII)

8 3 e.g.'FP1'

Printertype 11 1

PrinterType:0x0forFanFold,0x1PaperRoll

(Cutterfitted)

SDcardfitted

status

12 1 1fordetected

Printer

darkness/quality

setting

13 1

Thecurrentprotocolversionsetforthisdevice



SMARTPayout

SSPProtocolManualGA138_2_2_222A

<<backtoindex

TheSmartPayoutisanextensionofabanknotevalidator,allcommandsaresenttothevalidatorusingits

address(0x00).Informationonthetypesofnotethatcanbehandledisobtainedfromthestandardnote

validatorcommands.

Notethatpayoutvaluesareintermsofthepennyvalueofthatcurrency.Sofor5.00,thevaluesentand

returnedbythepayoutwouldbe500.

Thehostsimplyhastotelltheunitthevalueitwishestodispense.Theunitwillmanagewhichnotesare

storedtobeusedforpayoutandtheirlocationtominimisethepayouttime,andwhichnotes,ofthetype

enableforstorage,aresenttothestacker.Thisistherecommendedmodeofoperation.

TheSMARTPayouthasadefaultSSPAddressof0.

ThesetuprequestreponsetableforSMARTPayouttypes:

Protocolversionslessthan6:

Data byteoffset

size

(bytes)

notes

Unittype 0 1 0x06=SMARTPayout

Firmware

version

1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)

Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')

Value

Multiplier

8 3

3Thevaluetomultiplytheindividualchannelsbytogetthe

fullvalue.Ifthisvalueis0thenitindicatesthatthisisa

protocolversion6orgreatercompatibledatasetwherethe

valuesaregivenintheexpandedsegmentofthereturndata.

Numberof

channels

11 1 Thehighestchannelusedinthisdevicedataset[n](116)

Channel

Values

12 n

Avariablesizearrayofbyes,1foreachchannelwithavalue

from1to255whichwhenmultipliedbythevaluemultiplier

givesthefullvalueofthenote.Ifthevaluemultiplieriszero

thenthesevaluesarezero.

Channel

Security

12+n n

Anobsoletevalueshowingsecuritylevel.Thisissetto2if

thevaluemultiplieris>0otherwise0.

Realvalue

Multiplier

12+(n*2) 3

Thevaluebywhichthechannelvaluescanbemultipliedto

showtheirfullvaluee.g.5.00EUR=500EURcents

Protocol

version

15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice



Protocolversionsgreaterthanorequalto6:

Data byteoffset

size

(bytes)

notes

Unittype 0 1 0x06=SMARTPayout

Firmware

version

1 4 ASCIIdataofdevicefirmwareversion(e.g.'0110'=1.10)

Countrycode 5 3 ASCIIcodeofthedevicedataset(e.g.'EUR')

Value

Multiplier

8 3

3Thevaluetomultiplytheindividualchannelsbytogetthe

fullvalue.Ifthisvalueis0thenitindicatesthatthisisa

protocolversion6orgreatercompatibledatasetwherethe

valuesaregivenintheexpandedsegmentofthereturndata.

Numberof

channels

11 1 Thehighestchannelusedinthisdevicedataset[n](116)

Channel

Values

12 n

Avariablesizearrayofbyes,1foreachchannelwithavalue

from1to255whichwhenmultipliedbythevaluemultiplier

givesthefullvalueofthenote.Ifthevaluemultiplieriszero

thenthesevaluesarezero.

Channel

Security

12+n n

Anobsoletevalueshowingsecuritylevel.Thisissetto2if

thevaluemultiplieris>0otherwise0.

Realvalue

Multiplier

12+(n*2) 3

Thevaluebywhichthechannelvaluescanbemultipliedto

showtheirfullvaluee.g.5.00EUR=500EURcents

Protocol

version

15+(n*2) 1 Thecurrentprotocolversionsetforthisdevice

Expanded

channel

country

code

16+(n*2) n*3

Threebyteasciicodeforeachchannel.Thisallowsmulti

currencydatasetstobeusedonSSPdevices.Thesebytesare

givenonlyonprotocolversions>=6.

Expanded

channel

value

16+(n*5) n*4

4bytesforeachchannelvalue.Thesebytesaregivenonlyon

protocolversions>=6.



Page is loading ...

innovative technology NV10 USB+ User manual

innovative technology NV10 USB+ User manual

Related papers

Other documents