Cognex移动条码SDK - Cordova插件

要启动并运行扫描仪，首先要做的是调用loadScanner ()方法

预计一个设备类型和一个回调函数作为第二个参数回调函数在承诺中包裹，它返回为一个。

/ * @返回{常量（串）动作：将采取的行动（总是返回LOAD READER）（字符串）结果：从服务器（布尔）消息状态：如果读者被加载，它将返回true（字符串）错误：串错误，如果错误被抛出（INT）类型：我们连接到[0,1]（字符串）名称的设备的类型：设备的设备的类型的名称[类型]} * /

设备类型参数可以是一个字符串常量，具有可能的值：

设备:[“DEVICE_TYPE_MX_1000”、“DEVICE_TYPE_MOBILE_DEVICE”]

或者我们可以传入0作为DEVICE_TYPE_MX, 1作为DEVICE_TYPE_MOBILE_DEVICE

例子

//作为回调示例:cmbScanner.loadScanner("DEVICE_TYPE_MOBILE_DEVICE"，function(result){cmbScanner.connect();}）;// cmbScanner.loadScanner("DEVICE_TYPE_MOBILE_DEVICE").then(function(result){cmbScanner.connect();}）;//将设备类型作为整数传递cmbScanner.loadScanner(0).then(function(result){cmbScanner.connect();}）;

要在加载后连接到READER，我们需要使用连接．

cmbScanner.connect((回调));

/ * @返回（承诺）{状态：布尔，如果不是假的故障如果连接succeded真：字符串，如果状态虚假ERR将不能为null} * /

例子

/ **使用Connect和返回值作为一个承诺* / cmbScanner.connect（），然后（函数（connectionState）{执行console.log（connectionState）; // { “地位”：假的， “犯错”：“没返回成功”}}）确定;/ **使用连接和返回值作为回调函数* / cmbScanner.connect（函数（connectionState）{的console.log（connectionState）;}）;

即使我们返回连接action对connect回调的结果进行操作，以更新DOM元素或调用只有在拥有连接集后才有效的API方法。

有一个倾听者回调（setConnectionStatedIdChangeOfReaderCallback.）可以设置的函数，它总是会触发每当连接状态发生变化时我们应该把代码保留在那里。

/ * @返回（承诺）{状态：布尔，如果不是假的故障如果连接succeded真：字符串，如果状态虚假ERR将不能为null} * /

正如有connect ()，有一个断开连接（）方法，做的opossiteconnect ()：

cmbScanner.断开连接（[回调]）

类似于connect ()那断开连接（）too返回回调函数中的connectionState(它被包装到Promise中)，我们可以对connectionState进行操作，例如将标签从“connected”更改为“disconnected”:

cmbScanner.disconnect(function(connectionState){if(connectionState == cmbScanner.CONSTANTS.CONNECTION_STATE_DISCONNECTED){document.getElementById('some-label').innerHtml('DISCONNECTED');} else if (connectionState == cmbScanner.CONSTANTS.CONNECTION_STATE_CONNECTED){document.getElementById('some-label').innerHtml('DISCONNECTED');}})

但是,就像connect ()，我们不必因为setConnectionStateDidChangeOfReaderCallback ()这将侦听器设置为所有连接/断开/连接/断开事件。

为了处理成功的扫描结果，我们需要设置RESULTSCALLBALL.函数。这是通过setResultCallback．

它为所有人设置回调函数DidReceivedResultFromReader事件。

cmbscanner.setresultCallback（函数（结果）{if（结果.SymbologyString =='否读取'）{//在没有读取条形码时执行某些操作或只是将其留空// navigator.notification.alert（“停止”）;}否则如果（结果&& result.readstring）{//对条形码读取//示例执行一些操作：document.getElementById（'内容'）。InsternAdjententhtml（'之前'，' '+结果.SyybologyString +'：'+结果.ReadString +''）; //我们可以将所有这个DOM处理在DOM帮助器对象中处理，但由于它只是一行代码让我们离开它是}}）;

ResultCallback将在每次进行条形码扫描时触发（或手动停止扫描仪，或在没有结果的情况下停止扫描仪）。

结果对象

条码结果的结构如下:

interface BarcodeResult {readString: string, symbologyString: string, symbology: integer, goodRead: bool, xml: string, imageGraphics?:字符串,图片吗?:字符串};

要监控MX设备使用的可用性:

在可用性更改时设置侦听器。当设备可用或失去可用性时会发射。

使用

cmbScanner.setAvialabilityCallback（function（availability）{/***availability-设备可用性的int表示形式*/if（availability==CONSTANTS.availability\u UNKNOWN）{//在设备可用性未知时执行一些操作}否则if（availability==CONSTANTS.availability\u availability）{//在设备可用时执行一些操作}否则如果（可用性==常量。可用性{不可用）{//在设备不可用时执行一些操作}）；

所有连接/断开连接事件应该回调函数，可使用此API方法中进行处理。

回调是可选的，因为插件提供了默认的回调手柄连接/断开连接事件，但默认的回调只是一个占位符函数，并没有为应用程序的最终开发者提供太多的功能。

当connetionStateDidChange被触发，它将返回4个可能整数一个

这些可以作为整数直接访问，或者开发人员可以通过访问cmbScanner中的CONSTANTS对象从可用的CONSTANTS enum中使用它们．

具体的例子有:

cmbScanner.setConnectionStateDidChangeOfReaderCallback(function(connectionState){if(connectionState == cmbScanner.CONSTANTS.CONNECTION_STATE_CONNECTED){//在连接时做事情，然后(function(rr){//请参阅setSymbologyEnabled以获得关于rr(返回结果)对象的更多信息//在符号被设置之后，我们可以发送一个命令。让我们把闪光灯设置在cmbScanner上。sendCommand(“光。INTERNAL-ENABLE”)(函数(结果){/ /命令是否成功我们应该光打开当我们开始扫描过程/ /而且检查是否我们可以使用flash isLightsOn API方法cmbScanner.isLightsOn()(函数(lights_on){/ /光应该});}）;}）;} }）;

在这里我们不仅听连接/断开连接事件，但我们也启用了一些符号，并通过命令和API方法打开闪光灯isLightsOn．

启动/停止扫描过程，我们使用这两种方法。它们可以通过应用的UI从按钮中调用，也可以通过编程方式调用。

startScanning宣言

stopScanning宣言

使用

由于读者的性质，我们始终将setActiveStartScanningCallback ()功能，如果我们要根据扫描仪（Reader）的状态来控制某些DOM元素。

cmbscanner . startscan (function(scannerState){if(scannerState) document.getElementById(' scannerState -active-label')[remove] = 'RUNNING';else document.getElementById('scanner-active-label')[deleted] = '已停止';}）;

例子

< a href = " cmbScanner.startScanning ();" < / > < >开始扫描仪!——按钮启动扫描——>  < >停止扫描仪!——button来停止扫描仪——>  < >开始扫描仪!——button以回调启动扫描器，避免此操作，并始终使用setActiveStartScanningCallback——>

为了检查是否启用了符号，我们使用isSymbologyEnabled ()．

/ ** @返回一个承诺，包含对象{行动：这是调用的状态DMCC命令：没有它成功与否，如果发生错误，将其设置为false结果：如果符号已启用则为true，如果没有那么假错误：错误消息，如果动作没有完成} * /

例子

cmbScanner.isSymbologyEnabled(“SYMBOL.C93函数(rr) {console.log (JSON.stringify (rr));//将打印{"action": "GET SYMBOL. "C93”、“地位”:真的,“犯错”:空,“结果”:真正}});

当我们使用摄像头设备作为条形码阅读器时，设置摄像头的行为方式:

/ **使用没有Aimer的相机。预览是打开的，照明可用。no_aimer = 0，用基本瞄准器使用相机（例如，Stingray）。预览关闭，不可用照明。passive_aimer = 1，使用带有活跃的Aimer（例如，MX-100）的相机。预览关闭，照明可用。active_aimer = 2，使用移动设备前置摄像头。预览是开启的，不可用的照明。front_camera = 3 * /

设置预览容器的大小和位置(仅当用户使用相机阅读器时可用):

/* @params x,y,w,h x,y:左上角位置w,h:矩形的宽度和高度(占整个容器的百分比)*/

cmbScanner.setPreviewContainerPositionAndSize（0,0,100,50）;//将设置预览0,0和100％的宽度50％的高度

要以编程方式启用闪光灯，我们可以使用：

/ * * @return承诺包含JSON对象{(string)行动:DMCC命令被调用(bool)地位:它成功与否,如果一个错误发生,它将被设置为false(字符串)错误:错误消息如果操作没有完成(bool)结果:执行操作的结果，在这种情况下，如果灯光被启用，则为TRUE，否则为false} */

例子

cmbScanner.setLightsOn（true，函数（response）{//console.log（response）；}）；cmbScanner.setLightsOn（true）。然后（函数（response）{///或使用承诺，回调函数包装在承诺中//因此，如果我们不将回调函数设置为参数，将使用默认函数//并返回继续链的承诺}）；

要检查闪光灯是否打开，我们可以使用：

/ * * @return承诺包含JSON对象{(string)行动:DMCC命令被调用(bool)地位:它成功与否,如果一个错误发生,它将被设置为false(字符串)错误:错误消息如果操作没有完成(bool)结果:执行操作的结果，在这种情况下，如果灯光被启用，则为TRUE，否则为false} */

例子

cmbScanner.isLightsOn(真的,函数(响应){/ / console.log(响应);}）;cmbScanner.isLightsOn(true).then(function(response){//或者带有承诺的回调函数被包装在一个承诺中//所以如果我们不设置一个回调函数作为参数，将使用默认的一个回调函数//它将返回一个承诺来继续链});

如果我们想返回我们使用的解码器看到的最后一个图像enerialImage（）．如果我们想要使用返回图像的图像统计enableImageGraphics()。

宣言

使用

cmbScanner.enableImage(真正的);//它将在结果中启用图像cmbScanner.enableImageGraphics(true);//将显示在图像上检测到的条形码的确切位置

条形码结果对象的结构是：

interface BarcodeResult {readString: string, symbologyString: string, symbology: integer, goodRead: bool, xml: string, imageGraphics?:字符串,图片吗?:字符串};

大多数API方法可以替换为将适当的命令发送到MX（或摄像机）读取器。

发送命令接收回调并将其包裹成一个承诺，因此链可以继续。

使用

cmbScanner.sendCommand（ “SET SYMBOL.POSTNET OFF”）。然后（函数（结果）{//并承诺让我们看看我们的命令所做的console.log（JSON.stringify（结果））;}）;//或这样cmbScanner.sendCommand（“SET LIGHT.INTERNAL-ENABLE ON”）。然后（函数（结果）{//如果命令是成功的，我们应具有灯开每当我们开始扫描过程的console.log（JSON.stringify（结果））;}）;

第一个命令将禁用象征POSTNET.第二个将打开闪光灯。

这两种操作都可以通过相应的API函数执行setSymbologyEnabled（）和setlightson（）一般来说，开发人员应该总是倾向于使用API函数sendcommand（）。

不过，也有在科尔多瓦插件不包括某些用例场景的情况下，我们总是可以使用sendCommand的。

例子

如果我们想改变我们的MX设备“哔声”和“灯光”，我们可以使用：

所以对于我们的例子，我们将有：

cmbScanner.sendCommand（“setoutput.USER-configure1 1 2 4 ON”）。然后（函数（响应）{//console.log（响应）；//打印操作结果}）；

这将用户事件#1配置为两个带有红色LED和振动的中等嘟嘟声。为了激活这个事件，我们使用:

cmbscanner.sendcommand（“output.user1”）。然后（函数（响应）{//这将调用user1的存储设置项，因此MX设备基本上用红色LED和振动越大哔哔声}）

如果我们需要重新设置MX/摄像头读取器的配置，我们可以使用:

宣言

使用

cmbscanner.resetconfig（函数（结果）{console.log（结果）;}）

结果界面

/*@return A promission包含JSON对象{（字符串）操作：已调用的DMCC命令（bool）状态：是否成功，如果发生错误，将设置为false（字符串）err：如果操作未完成且存在错误，则显示错误消息。默认值为null（bool）result:sendCommand操作的结果}*/

如果您使用相机设备，请添加许可证密钥的另一种方法。这个将从清单中覆盖您的许可证密钥安卓或信息。plist为iOS.．

例子

cmbScanner.registerSDK（ “SDK_KEY”）;