intouch machine edition (v2.2.x) - cognex

t it le:InTouchMachineEdit ion(v2.2.x);ver:2.6.x 1/28

InTouchMachineEdition(v2.2.x)

Introduct ion

InthiswikipageswewillexplainhowtouseourcmbSDKtroughcordovapluginascustomwidgetinITMEproject

Gett ingStarted

OpenITMEStudioandcreatenewproject


Setyourprojectresolution


Project Tags

GoinGlobalsectionofProjectExplorer,openProjectTags->DatasheetViewandinsertprojecttagsthatwewilluse.Wewillexplaineverytaglaterinthissection


Alltagsarelocalandchangetothetagvalueaffectsonlythestationonwhichthechangewasmade.

BarcodeWidget

Howthiswidgetisworking?Thereistriggerpropertiesthatcallapimethodsfromcordovaplugin.Thereisoutputpropertieswherewereturnresultsfromapimethodsandthereiseventslikecallbackfunctionsthatarecalledwhenapimethodisexecuted.Onthislinkyoucanreadabouteverypropertyandhereaboutevents.

Project screens

https://cmbdn.cognex.com/v2.2.x/knowledge/intouch-machine-edition/barcode-widget-properties

https://cmbdn.cognex.com/v2.2.x/knowledge/intouch-machine-edition/barcode-widget-events


GobackinGraphicssection,rightclickonScreenscategoryandclickInsert

SetscreenattributesandpressOK.


Designyourheaderscreenandnameitasheader.

Herewehaveheadertext,labelwherewewillshowreaderdevicebatterylevelandsmartmessageobjectthatshowcurrentreaderdeviceconnectionstatus.

InheaderscreenwewilladdourbarcodeReadercustomwidget.

ClickonCustomWidgeticon


ClickimportandfindyourbarcodeReader.cwpfile .barcodeReadershouldbeshownasavailablewidget.SelectitandclickOK.

barcodeReadercustomwidgetisaddedinheaderscreen

OpenbarcodeReaderpropertiesandgoinwidgetmembers


MappropertiesfromcustomwidgetwithprojecttagsandsetactionSet+Getandsetscriptthatyouwanttoexecuteincallbackevents.

ThenopenheaderscreenscriptandcallsetPreviewContainerPositionAndSizeEventTriggerandloadScannermethodswhenheaderscreenisopened.Alsoopenanotherscreen(main)whilethisoneisopening.


Nowcreateanotherscreenandnameitmain.


Inthisscreenwehaverectanglewherewedisplayscannedresults,buttontostart/stopscanningandbuttontocleardisplayedresults.


LaterrightclickonScreenGroupcategoryandcreateStartUpscreengroup.


OpenProjectpropertiesandsetthisgroupasStartupscreen.

BecausewewanttodeploythisapplicationasHTMLwebinterfaceandinteractfrommobiledevicesweneedtoopenMobileAccessmenuatleastonesandsavechangesonclose.Also,forbettercommunicationwithcustomwidget,setProcessValuesatminimumvaluewhichis100.


WhenwefinishwithourscreensandconfigurationsVerifyproject.

andSaveallscreensasHTMLforwebaccess


WithallthesestepswefinishedourITMEproject.

Serverconfigurat ion

NavigatetoyourITMEwebapplicationphysicalpath.IfyouuselocalIISserverusuallythispathisC:\inetpub\wwwroot\ITME81andcopybarcodeReaderServerFilesthatyou'vedownload.


Thesecordovafilesthatwillbehostedonserverwillhelpustousenativefeaturestroughcustomwidgets.Lateropenindex.htmlandreferencethesescripts:

WhenwenavigatetoserverURLweaddplatformthatweareusingasattributeinquerystring.

WithbarcodeReader.jswecheckthisattributetoknowwhichcordovafilestoload(iOSor


android).

NowopenIISmanagerrightclickonyourITME81applicationandclickAddVirtualDirectory:

Set“CustomWidget”asAliasandasphysicalpatsetpathtoyourITMEproject(C:\Users\Marko\Documents\InTouchMachineEditionv8.1Projects\cmbSdkSampleinourcase)

Besurethatyoumakeconnectionwithuserthathaveauthorizationtoselectedpath.


CognexWrapperApplicat ion

RunCognexWrapperApplicationonyourmobiledevice.InServerURLinputboxinsertyourserverURLandinquerystringsendscreenandguestuserattributes.ClickNavigatebuttonandyouwillberedirectedtoyourserverURL(htttp://192.168.1.103/ITME81?screen=header&guestuser=1inourcase).WhenyouclickNavigatebuttonapplicationautomaticallyaddplatforminquerystringasattribute.

NotethatyoumusttorunyourITMEprojectbeforeyounavigatetoserverURLfromCognexWrapperApp.


BarcodeWidget Propert ies

loadScannerEventTrigger

$loadScannerEventTrigger="loadScanner(deviceType,sdk_key)"

WiththispropertywecallloadScanner(deviceType,sdk_key)methodwhichisthefirstthingweneedtodotoinordertousereaderdevice

Hastwoinputparameters.Firstoneshouldbe0ifwewanttouseMXDevicetoperform


scanningor1ifwewilluseMobileDeviceforscanning.Secondinputparameterissdk_keywhichisoptional.WeneedtosetoursdklicensekeyonlyifweuseMobileDeviceforscanningbarcodes.Otherwisewewillhaveasterisksinbarcodereaderresult.

ResultfromthiseventisreturnedinloadScannerOutputDatapropertyandloadScannereventiscalledascallbackfunction

Example:

'ForMXDevice$loadScannerEventTrigger="loadScanner(0)"'ForMobileDevice$loadScannerEventTrigger="loadScanner(1,SDK_KEY)"

connectEventTrigger

$connectEventTrigger="connect()"

Withthispropertywecallconnect()methodtoconnectwithourreaderdeviceandshouldbecalledafterweloadreaderdevice.

ResultfromthiseventisreturnedinconnectOutputDatapropertyandconnecteventiscalledascallbackfunction.

Example:

$connectEventTrigger="connect()"

disconnectEventTrigger

$disconnectEventTrigger="disconnect()"

Withthispropertywecalldisconnect()methodtoreleaseconnectionfromreaderdevice

ResultfromthiseventisreturnedindisconnectOutputDatapropertyanddisconnecteventiscalledascallbackfunction.

Example:


$disconnectEventTrigger="disconnect()"

setPreviewContainerPosit ionAndSizeEventTrigger

$setPreviewContainerPositionAndSizeEventTrigger=setPreviewContainerPositionAndSize(startPointX,startPointY,width,height)

WiththispropertywecallsetPreviewContainerPositionAndSize(startPointX,startPointY,width,height)methodwhichhas4inputparameters.startPointX,startPointY,widthandheightandtheyaremeasuredin%.

ThisshouldbecalledbeforeloadScannermethodandweuseittoplaceMobileDevicepreviewcontainer.

Example:

'PreviewContainerpositionedon0,0(left,top)100%rightand30%bottom.$setPreviewContainerPositionAndSizeEventTrigger="setPreviewContainerPositionAndSize(0,0,100,30)"

toggleScannerEventTrigger

$toggleScannerEventTrigger=“toggleScanner()”

WiththispropertywecalltoggleScanner()methodtostart/stopscanningprocess.

Example:

$toggleScannerEventTrigger=“toggleScanner()”

setSymbologyEnabledEventTrigger


$setSymbologyEnabledEventTrigger=setSymbologyEnabled(p1,p2,p3..)

Toenable/disablesymbologiesweusethispropertywhichtriggersetSymbologyEnabled(p1,p2,p3..)method.Asinputparameterswesetsymbologyandstatus.Wecanenable/disableoneormoresymbologiesinonecall.

Listofsymbols:UNKNOWN,DATAMATRIX,QR,C128,UPC-EAN,C11,C39,C93,I2O5,CODABAR,EAN-UCC,PHARMACODE,MAXICODE,PDF417,MICROPDF417,DATABAR,POSTNET,PLANET,4STATE-JAP,4STATE-AUS,4STATE-UPU,4STATE-IMB,VERICODE,RPC,MSI,AZTECCODE,DOTCODE,C25,C39-CONVERT-TO-C32,OCR,4STATE-RMC.

ResultfromthiseventisreturnedinsetSymbologyEnabledOutputDatapropertyandsetSymbologyEnabledeventiscalledascallbackfunction.

Example:

$setSymbologyEnabledEventTrigger="setSymbologyEnabled(DataMatrixON,C128OFF)"

setLightsOnEventTrigger

$setLightsOnEventTrigger=“setLightsOn(p1)”

Wecansetlighttobeenabled/disabledbydefaultwhenwestartscanningwiththispropertybytriggeringsetLightsOn(p1)method.AsinputparameterwesetONifwewanttoenableandOFFifwewanttodisablelightbydefault.

ResultfromthiseventisreturnedinsetLightsOnOutputDatapropertyandsetLightsOneventiscalledascallbackfunction.

Example:

$setLightsOnEventTrigger=“setLightsOn(ON)”

isLightsOnEventTrigger

$isLightsOnEventTrigger=“isLightsOn()”


TocheckiflightisenabledbydefaultwetriggerisLightsOn()method

ResultfromthiseventisreturnedinisLightsOnOutputDatapropertyandisLightsOneventiscalledascallbackfunction.

Example:

$isLightsOnEventTrigger=“isLightsOn()”

sendCommandEventTrigger

$sendCommandEventTrigger=“sendCommand(p1,p2,p3…)"

WiththispropertywecallsendCommand(p1,p2,p3…)methodthatexecutesDMCcommandswhicharesetasinputparameters.Wecansetoneormoredmccommandsasinputparameters.

ResultfromthiseventisreturnedinsendCommandOutputDatapropertyandsendCommandeventiscalledascallbackfunction

Example:

$sendCommandEventTrigger=“sendCommand(GETBATTERY.CHARGE)”

connect ionStateDidChangeOfReaderCallbackOutputData

Integerpropertythatrepresentcurrentreaderconnectionstate.Thereisfourstate:

0-CONNECTION_STATE_DISCONNECTED

1-CONNECTION_STATE_CONNECTING

2-CONNECTION_STATE_CONNECTED

3-CONNECTION_STATE_DISCONNECTING

resultCallbackOutputData


Stringpropertythatcontainlastscannedresult

availabilityCallbackOutputData

Booleanpropertythatistrueifourreaderdeviceisavailableorfalseifreaderdeviceisunavailable.

act iveStartScanningCallbackOutputData

Booleanpropertywhichwillbetruewhenscanningisactiveorfalsewhenscanningisstopped.

loadScannerOutputData

WhenloadScannermethodisexecuteditreturnsuccessmessageorerrormessageifreaderdevicecan’tbeloaded.

connectOutputData

Whenconnectmethodisexecuteditreturntrueifconnectionissuccessfulorerrormessageifconnectioncan’tbecompleted

disconnectOutputData

Whendisconnectmethodisexecuteditreturnsuccessmessageorerrormessageifthereisproblemwhileweexecutethismethod

isSymbologyEnabledOutputData

InthispropertywereturnresultfromisSymbologyEnabledmethod.ResultwillbeONifcertainsymbologyisenabled,OFFifisdisabledorerrormessageifthereissomeerrorthrownwhileweexecutethismethod.SinceisSymbologyEnabledmethodcanhavemorethanoneparameterwewillreturnsymbologystatusseparatedwith“,”.Forexampleifwecall$isSymbologyEnabledEventTrigger="isSymbologyEnabled(DataMatrix,C128)"resultwillbe“ON,ON”ifbothsymbologiesareenabled.

NotethatbydefaultifweuseMobileDevicethereisnosymbologiesenabled.


isLightsOnOutputData

ResultfromisLightsOnmethodthatcanbeONiflightisenabled,OFFifisdisabledorerrormessageifsomethingwronghappenedwhilethiscommandisexecuted

sendCommandOutputData

StringpropertythatrepresentresultfromsendCommand()method.IfthereismorethanoneDMCcommandsasinputparametersresultfromeverycommandwillbeseparatedwith“,”.

Forexample,ifwecall$sendCommandEventTrigger=“sendCommand(GETBATTERY.CHARGE,GETLIGHT.INTERNAL-ENABLE)”resultwillbe“50,OFF”

setLightsOnOutputData

ResultfromsetLightsOnmethodthatcanbeONiflightisenabled,OFFifisdisabledorerrormessageifsomethingwronghappenedwhilethiscommandisexecuted

setSymbologyEnabledOutputData

InthispropertywereturnresultfromsetSymbologyEnabledmethod.ResultwillbeONifcertainsymbologyisenabled,OFFifisdisabledorerrormessageifthereissomeerrorthrownwhileweexecutethismethod.SincesetSymbologyEnabledmethodcanhavemorethanoneparameterwewillreturnsymbologystatusseparatedwith“,”.Forexampleifwecall$setSymbologyEnabledEventTrigger="setSymbologyEnabled(DataMatrix,C128)"resultwillbe“ON,ON”ifbothsymbologiesareenabled.

BarcodeWidget Events

sendCommand

ThiscallbackeventwillbeexecutedwhensendCommandmethodistriggeredandfinished:$sendCommandEventTrigger="sendCommand(p1,p2,p3...)"

isLightsOn


ThiscallbackeventwillbeexecutedwhenisLightsOnmethodistriggeredandfinished:$isLightsOntEventTrigger="isLightsOn()"

setLightsOn

ThiscallbackeventwillbeexecutedwhensetLightsOnmethodistriggeredandfinished:$setLightsOnEventTrigger="setLightsOn(p1)"

isSymbologyEnabled

ThiscallbackeventwillbeexecutedwhenisSymbologyEnabledmethodistriggeredandfinished:$isSymbologyEnabledEventTrigger="isSymbologyEnabled(p1,p2,p3,.....)"

setSymbologyEnabled

ThiscallbackeventwillbeexecutedwhensetSymbologyEnabledmethodistriggeredandfinished:$setSymbologyEnabledTrigger="setSymbologyEnabled(p1,p2,p3,.....)"

disconnect

Thiscallbackeventwillbeexecutedwhendisconnectmethodistriggeredandfinished:$disconnectEventTrigger="disconnect()"

connect

Thiscallbackeventwillbeexecutedwhenconnectmethodistriggeredandfinished:$connectEventTrigger="connect()"

loadScanner

ThiscallbackeventwillbeexecutedwhenloadScannermethodistriggeredandfinished:$loadScannerEventTrigger="loadScanner(0)"

setAct iveStartScanningCallback


'ThiscallbackeventwillbeexecutedwhentoggleScannermethodistriggeredandfinished:$toggleScannerEventTrigger="toggleScanner()"

setAvailabilityCallback

ThiscallbackeventwillbeexecutedwhenavailabilityofMXDeviceischanged.

setResultCallback

Whenbarcodeisscannedthiscallbackeventwillbeexecuted

setConnect ionStateDidChangeOfReaderCallback

Thiscallbackeventwillbeexecutedwhenconnectionstateofreaderdeviceischanged