================================================================================ GeViScope_SDK.pdf - Pages 71 to 80 ================================================================================ ──────────────────────────────────────────────────────────────────────────────── Page 71 ──────────────────────────────────────────────────────────────────────────────── TheaffectedWorkingPlacewillbeidentifiedviatheparameter"Workingplace".Further parameterswillbefilledwithaccompanyingmetadataonthepartoftheCashManagement System. TheParameter"StepID"canbeaddressedbytheCashManagementSystemwithacode figureforthecurrentlyrunningprocessstep. Parameter Function working place WorkingPlaceWorkingplaceno. starttimeStartTime Timestamp,whenthehandlingofthesafebagbegan. safebag no. SafebagNoAlphanumericalidentificationofsafebag;searchcriteriainGscView safebag info SafebagInfoAdditionalalphanumericalidentificationofsafebag stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenbycashman- agementsystemindividually Safebagpassingofriskdata Actionname:SafebagPassingOfRiskData(WorkingPlace,StartTime,SafebagNo,Safe- bagInfo,StepID,UserID1,UserID2,TourNumber,TargetWorkingPlace, PassingOfRiskType) Actioncategory:command TheintegratedCashManagementSystemsendstheactioncontinuouslyforeachsafebag whiletheamountofsafebagsbetweentwoemployeeswillbetransferredandthiswillbe confirmedtotheCashManagementSystem.Thispartofthemoneyhandlingprocessisa "passingofrisk".Viatheparameter"workingplace"theaffectedtransferplaceandrespect- ivelytheworkingplacewillbeidentified.Thefurtherparameterswillbefilledwithaccom- panyingvideodatabytheCashManagementSystem.Theparameter"StepID"canbe providedwithacodefigurebytheCashManagementSystemforthecurrentlyrunningpro- cessstep. Parameter Function working place WorkingPlace Workingplaceno. starttime StartTime Timestamp,whenthehandlingofthesafebagbegan. safebagno.SafebagNo Alphanumericalidentificationofsafebag;searchcriteriain GscView safebag info SafebagInfo Additionalalphanumericalidentificationofsafebag stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby cashmanagementsystemindividually user1 UserID1 Numberofemployee,transferringthesafebagtoanother employee. user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother employee. tourno TourNumber Tour-Number(optional) targetwork- ingplace TargetWorkingPlaceAlphanumericalidentificationofaplacerespectivelyaworking placewheresafebagswillbetransferredto(optional) passingof risktype PassingOfRiskTypeDetailedinformationto"passingofrisk"(optional) ──────────────────────────────────────────────────────────────────────────────── Page 72 ──────────────────────────────────────────────────────────────────────────────── Safebagpassingofriskstart Actionname:SafebagPassingOfRiskStart(WorkingPlace,StartTime,SafebagNo,Safe- bagInfo,StepID,UserID1,UserID2,TourNumber,TargetWorkingPlace, PassingOfRiskType) Actioncategory:command TheintegratedCashManagementSystemsendstheactionassoonasanumberofsafe bagswillbetransferredbetweentwoemployeesandthisisconfirmedtotheCashMan- agementSystem.Thispartofthemoneyhandlingprocessisa"passingofrisk".Viathe parameter"workingplace"theaffectedtransferplaceandrespectivelytheworkingplace willbeidentified.Thefurtherparameterswillbefilledwithaccompanyingmetadatabythe CashManagementSystem.Theparameter"StepID"canbeprovidedwithacodefigureby theCashManagementSystemforthecurrentlyrunningprocessstep. Parameter Function working place WorkingPlace Workingplaceno. starttime StartTime Timestamp,whenthehandlingofthesafebagbegan. safebagno.SafebagNo Alphanumericalidentificationofsafebag;searchcriteriain GscView safebag info SafebagInfo Additionalalphanumericalidentificationofsafebag stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby cashmanagementsystemindividually user1 UserID1 Numberofemployee,transferringthesafebagtoanother employee. user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother employee. tourno TourNumber Tour-Number(optional) targetwork- ingplace TargetWorkingPlaceAlphanumericalidentificationofaplacerespectivelyaworking placewheresafebagswillbetransferredto(optional) passingof risktype PassingOfRiskTypeDetailedinformationto"passingofrisk"(optional) Safebagpassingofriskstop Actionname:SafebagPassingOfRiskStop(WorkingPlace,StartTime,StopTime,Safe- bagNo,SafebagInfo,StepID,UserID1,UserID2,TourNumber,TargetWorkingPlace, PassingOfRiskType) Actioncategory:command TheintegratedCashManagementSystemsendstheactionclosingafterthelastsafebag, whilethenumberofsafebagswillbetransferredbetweentwoemployeesandthisiscon- firmedtotheCashManagementSystem.Thispartofthemoneyhandlingprocessisa "passingofrisk".Viatheparameter"Workingplace"theaffectedtransferplacerespective workingplacewillbeidentified.Thefurtherparameterswillbefilledwithaccompanying videodatabytheCashManagementSystem.Theparameter"StepID"canbesuppliedby CashManagementSystemwithacodefigureforacurrentlyrunningprocessstep Parameter Function working place WorkingPlace Workingplaceno. starttime StartTime Timestamp,whenthehandlingofthesafebagbegan. safebagno.SafebagNo Alphanumericalidentificationofsafebag;searchcriteriain ──────────────────────────────────────────────────────────────────────────────── Page 73 ──────────────────────────────────────────────────────────────────────────────── Parameter Function GscView safebag info SafebagInfo Additionalalphanumericalidentificationofsafebag stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby cashmanagementsystemindividually user1 UserID1 Numberofemployee,transferringthesafebagtoanother employee. user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother employee. tourno TourNumber Tour-Number(optional) targetwork- ingplace TargetWorkingPlaceAlphanumericalidentificationofaplacerespectivelyaworking placewheresafebagswillbetransferredto(optional) passingof risktype PassingOfRiskTypeDetailedinformationto"passingofrisk"(optional) Deviceinformation Allactionsforlow-levelnotificationofthedeviceormediachannelschanges. Devicefound Actionname:DeviceFound(Type,Name,Serial) Actioncategory:logical ThisactionwillbefiredwhentheUSBorNETdeviceisconnectedtothesystem.Itisalso firedatstart-upforalldetecteddevices. Parameter Function devicetypeTypeTypeofthedevice. devicenameNameDevicenameifassignedinsetup,emptyotherwise. serialID SerialSerialIDofthedevice. Newfirmwarereceived Actionname:DeviceNewFirmware(Type,Name,Serial,Firmware) Actioncategory:logical ThisactionwillbefiredwhentheUSBorNETdevicehasgotthenewfirmware. Parameter Function devicetype Type Typeofthedevice. devicename Name Devicenameifassignedinsetup,emptyotherwise. serialID Serial SerialIDofthedevice. firmwareserialFirmwareSerialIDofthefirmware. Devicepluginerror Actionname:DevicePluginError(Channel,Type,SubType,Name,Serial,ErrorClass, ErrorCode,Description) Actioncategory:logical Thisactionnotifiesdevicepluginerror. Parameter Function channel Channel Channel. devicetype Type Typeofthedevice. devicesubtypeSubType Subtypeofthedevice. ──────────────────────────────────────────────────────────────────────────────── Page 74 ──────────────────────────────────────────────────────────────────────────────── Parameter Function devicename Name Devicename. serialID Serial SerialIDofthedevice. errorclass ErrorClassErrorclassoftheerroroccured. errorcode ErrorCodePlugintypespecificerrorcode. description DescriptionErrordescription. Devicepluginstate Actionname:DevicePluginState(Channel,Type,SubType,Name,Serial,State,Intern- alState,Description) Actioncategory:logical Thisactionnotifiesdevicepluginstate. Parameter Function channel Channel Channel. devicetype Type Typeofthedevice. devicesubtypeSubType Subtypeofthedevice. devicename Name Devicename. serialID Serial SerialIDofthedevice. pluginstate State Newplugindevicestate. internalstate InternalStatePlugindevicespecificstate. description DescriptionStatedescription. Devicereattached Actionname:DeviceReattached(Type,Name,Serial) Actioncategory:logical ThisactionwillbefiredwhentheUSBorNETdeviceisreattachedtothesystem. Parameter Function devicetypeTypeTypeofthedevice. devicenameNameDevicenameifassignedinsetup,emptyotherwise. serialID SerialSerialIDofthedevice. Deviceremoved Actionname:DeviceRemoved(Type,Name,Serial) Actioncategory:logical ThisactionwillbefiredwhentheUSBorNETdeviceisdisconnectedfromthesystem.Itis alsofiredatthestart-upforallparameterizedbutnotpresentdevices. Parameter Function devicetypeTypeTypeofthedevice. devicenameNameDevicenameifassignedinsetup,emptyotherwise. serialID SerialSerialIDofthedevice. Digitalcontacts Allactionsforhandlingdigitalinputsandoutputs. Digitalinput Actionname:DigitalInput(Contact,State) ──────────────────────────────────────────────────────────────────────────────── Page 75 ──────────────────────────────────────────────────────────────────────────────── Actioncategory:logical Thisactionwillbefiredwhenthestateofthedigitalinputhaschanged. Parameter Function contactContactContact. state State Newstate. IOI43resetmainboard Actionname:IOI43ResetMainboard() Actioncategory:logical ResetmainboardusingIOI43a/abUSBAlarm-I/O. IOI43temperaturenotification Actionname:IOI43Temperature(ID,Temperature) Actioncategory:logical TemperaturenotificationfromIOI43a/abUSBAlarm-I/O. Parameter Function ID ID IDoftheIOI43module(likeIOI43-00). temperatureTemperatureTemperature. IOI43watchdogactivate Actionname:IOI43WDActivate() Actioncategory:logical ActivatewatchdogonIOI43a/abUSBAlarm-I/O. IOI43watchdogdeactivate Actionname:IOI43WDDeactivate() Actioncategory:logical DeactivatewatchdogonIOI43a/abUSBAlarm-I/O. IOI43watchdogtrigger Actionname:IOI43WDTrigger() Actioncategory:logical TriggerwatchdogonIOI43a/abUSBAlarm-I/O. Keypressed Actionname:KeyPressed(Key) Actioncategory:logical ThisactionisnotifiedifoneoftheGEVISCOPEsystemkeysispressed. ParameterFunction Key Key Systemkey. Keyreleased Actionname:KeyReleased(Key) Actioncategory:logical ThisactionisnotifiedifoneoftheGEVISCOPEsystemkeysisreleased. ──────────────────────────────────────────────────────────────────────────────── Page 76 ──────────────────────────────────────────────────────────────────────────────── ParameterFunction Key Key Systemkey. Setdigitaloutput Actionname:SetDigitalOutput(Contact,State) Actioncategory:logical Thisactionisusedtomodifythestateofthedigitaloutputandtonotifythischange. Parameter Function contactContactContact. state State Newstate. SetsystemLED Actionname:SetLED(LED,State) Actioncategory:logical ThisactionisusedtoturnthesystemLEDsonoroff. ParameterFunction LED LED SystemLED. stateStateNewstate. SetsystemLEDtoblink Actionname:SetLEDBlink(LED,LedTimeOnMs,LedTimeOffMs) Actioncategory:logical ThisactionisusedtoblinkthesystemLEDs. Parameter Function LED LED SystemLED. LedtimeON LedTimeOnMsTimeinmillisecondstheLEDwillbeswitchedon. LedtimeOFFLedTimeOffMsTimeinmillisecondstheLEDwillbeswitchedoff. Lenel LenelOnGuardactions. Lenelaccessevent Actionname:LenelAccessEvent(ID,Panel,Device,SecondaryDevice,CardNumber, AccessResult,Type,SubType,Description,SerialNumber,TimeStamp,AreaEnteredID, AreaExitedID,AssetID,CardholderEntered,Duress,ElevatorFloor,FacilityCode,IsRead- ableCard,IssueCode,CommServerHostName,EventText) Actioncategory:logical LenelOnGuardaccessevent. Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary device SecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. cardnumberCardNumber ThebadgeIDforthecardthatwasread,ifavailable. accessresultAccessResult Thelevelofaccessthatwasgrantedthatresultedfrom readingthecard. ──────────────────────────────────────────────────────────────────────────────── Page 77 ──────────────────────────────────────────────────────────────────────────────── Parameter Function type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. descriptionDescription Ahumanreadable,briefdescriptionofthisevent. serialnumberSerialNumber Anumberthatuniquelyidentifiestheinstanceofthe eventforaparticularpanel. timestamp TimeStamp Timestamp. areaenteredAreaEnteredID TheIDoftheareathatwasentered,ifany. areaexited AreaExitedID TheIDoftheareathatwasexited,ifany. assetID AssetID TheIDoftheassetrelatedtothisevent,ifany. cardholder entered CardholderEnteredWhetherentrywasmadebythecardholder. duress Duress Indicateswhetherthiscardaccessindicatesanunder duress/emergencystate. elevatorfloorElevatorFloor Theelevatorflooronwhichtheaccesseventwasgen- erated,ifany. facilitycode FacilityCode Thefacilitycodeforthecardthatwasread,ifavailable. readablecardIsReadableCard Whetherthecardcouldberead. issuecode IssueCode Theissuecodeforthecardthatwasread,ifavailable. serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhich theeventarrived. eventtext EventText Textassociatedwithevent Lenelfireevent Actionname:LenelFireEvent(ID,Panel,Device,SecondaryDevice,TroubleCode,Type, SubType,Description,SerialNumber,TimeStamp,CommServerHostName,EventText) Actioncategory:logical LenelOnGuardfireevent. Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary device SecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. troublecodeTroubleCode Atroublecodeassociatedwiththefireevent. type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. descriptionDescription Ahumanreadable,briefdescriptionofthisevent. serialnum- ber SerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent foraparticularpanel. timestampTimeStamp Timestamp. serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhichthe eventarrived. eventtext EventText Textassociatedwithevent Lenelintercomevent Actionname:LenelIntercomEvent(ID,Panel,Device,SecondaryDevice,IntercomData, LineNumber,Type,SubType,Description,SerialNumber,TimeStamp,Com- mServerHostName,EventText) Actioncategory:logical LenelOnGuardintercomevent. ──────────────────────────────────────────────────────────────────────────────── Page 78 ──────────────────────────────────────────────────────────────────────────────── Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary device SecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. intercom data IntercomData Additionaldatafortheintercomeventthatoccurred. linenumberLineNumber Thelinenumberinvolvedintheintercomevent. type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. descriptionDescription Ahumanreadable,briefdescriptionofthisevent. serialnum- ber SerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent foraparticularpanel. timestampTimeStamp Timestamp. serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhichthe eventarrived. eventtext EventText Textassociatedwithevent Lenelrawdata Actionname:LenelRawData(TimeStamp,LenelData) Actioncategory:logical LenelOnGuardrawdata. Parameter Function timestampTimeStampTimestamp. data LenelDataLenelOnGuarddata. Lenelrefreshnames Actionname:LenelRefreshNames() Actioncategory:logical LenelOnGuardrefreshnames. Lenelsecurityevent Actionname:LenelSecurityEvent(ID,Panel,Device,SecondaryDevice,Type,SubType, Description,SerialNumber,TimeStamp,CommServerHostName,EventText) Actioncategory:logical LenelOnGuardsecurityevent. Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary device SecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. descriptionDescription Ahumanreadable,briefdescriptionofthisevent. serialnum- ber SerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent foraparticularpanel. timestampTimeStamp Timestamp. serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhichthe eventarrived. ──────────────────────────────────────────────────────────────────────────────── Page 79 ──────────────────────────────────────────────────────────────────────────────── Parameter Function eventtext EventText Textassociatedwithevent Lenelvideoevent Actionname:LenelVideoEvent(ID,Panel,Device,SecondaryDevice,Channel,Type, SubType,Description,SerialNumber,TimeStamp,StartTime,EndTime,Com- mServerHostName,EventText) Actioncategory:logical LenelOnGuardvideoevent. Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary device SecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. channel Channel Thephysicalchannelthecameraisconnectedtothatis creatingthisevent. type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. descriptionDescription Ahumanreadable,briefdescriptionofthisevent. serialnum- ber SerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent foraparticularpanel. timestampTimeStamp Timestamp. startstampStartTime Thetimethevideoeventstarted endtime EndTime Thetimethevideoeventended. serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhichthe eventarrived. eventtext EventText Textassociatedwithevent Logistic Logisticactionsareusedinthelogisticenvironmentwheremetadata,e.g.barcodes,is usedtostartrecordingevents.Later,aresearchonthebarcodesisdonetoshowthescan- ningoperationintherecordedimages.Tospeedupthesearch,aCRC32checksumisused asahashandservesasaforeignkeyoftheeventstartd.Theforeignkeyisindexedinthe eventtableancanthereforebefoundmuchfasterthanalookuponthestringitself.Addi- tionalparametersareusedtonotifypositioninginformationsincetheassignmentofscan- ningandrecordingcameraisoftendoneaccordingtothepositionofthescanner. Logbarcodedata Actionname:LogBarcodeData(Barcode,Hash,Scanner,AreaID,AreaName,Channel, TimeStamp) Actioncategory:notification Logisticbarcodedata. Parameter Function barcode Barcode Barcode. hashvalue Hash Hashvalueofbarcode(Optional) scannernameScanner ScannernameorIPAddress(Optional) areanumberAreaID Globalnumberofareaforeventmapping(Optional) ──────────────────────────────────────────────────────────────────────────────── Page 80 ──────────────────────────────────────────────────────────────────────────────── Parameter Function areaname AreaNameAreaname(Optional) channel Channel Globalnumberofamediachannelformapping(Optional) timestamp TimeStampTimestamp(Optional) LogbarcodedataLPS Actionname:LogBarcodeDataLPS(Barcode,Hash,Scanner,AreaID,AreaName,Channel, TimeStamp,X,Y,Z,LpsTagID,LpsStatus,LpsCellID,LpsAreaID,UserParam) Actioncategory:notification Logisticbarcodedataincludingpositioningandareainformation. Parameter Function barcode Barcode Barcode. hashvalue Hash Hashvalueofthebarcode(Optional) scannernameScanner ScannernameorIPAddress(Optional) areanumberAreaID Globalnumberofareaforeventmapping(Optional) areaname AreaNameAreaname.(Optional) channel Channel Globalnumberofamediachannelformapping(Optional) timestamp TimeStampTimestamp(Optional) XcoordinateX Xcoordinateofthepositionquery(Optional) YcoordinateY Ycoordinateofthepositionquery(Optional) ZcoordinateZ Zcoordinateofthepositionquery(Optional) LPStagID LpsTagIDTagIDofthepositioningsystem(Optional) LPSstatus LpsStatusLPSstatusofthepositionquery(Optional) LPScellID LpsCellIDCellIDofthepositioningsystem(Optional) LPSareaID LpsAreaIDAreaIDofthepositioningsystem(Optional) Userparam UserParamUserparamforinternaluse(Optional) LogNPRrecognition Actionname:LogNPRRecognition(PlateNo,Hash,Country,Channel,TimeStamp,Restric- tion,Category) Actioncategory:logical LogNPRrecognition. Parameter Function plateno. PlateNo Recognizedplateno. hashvalueHash Hashvalueoftherecognizedplateno.(Optional) country Country Country(Optional) channel Channel Channel(Optional) timestampTimeStampTimestamp(Optional) restrictionRestrictionRestrictionofrecognizednumber(Optional) categoryCategoryCategoryofrecognizednumber(Optional) LPSActions LPS(LocalPositioningSystem)actionsareusedtoqueryandreceivepositiondata.The positioningsystemisintegratedbytheGscLPSpluginandisusedtolocatetaggedobjects, e.g.mobilescannersinthelogisticenvironment.ThetagshaveIDsthatcanbeusedto querythepositionwhichisthennotifiedascartesianorgeograficcoordinates.Sometags areabletoinitiateapositionrequestbyanexternaltriggerorbyascaneventonamobile scanner.