Cognex移动条码SDK - Cordova插件

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

预计一个设备类型和一个回调函数作为第二个参数回调函数被包装在Promise中，并作为Promise返回。

/ * @return {const（string）操作：所采取的操作（将始终返回加载读取器）（String）结果：来自服务器（BOOL）状态的消息：如果加载读取器，则会返回true（字符串）err：字符串错误如果抛出错误（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();}）;

要在我们加载后连接到读者，我们需要使用连接。

cmbScanner.connect((回调));

/* @return (promise) {status: boolean，如果连接成功，则为true如果不是false err: string，如果状态为false err将不为null} */

例子

*/ cmbScanner.connect().then(function(connectionState){console.log(connectionState);// {"status": false， "err": "Did not return OK in success"}});/**使用connect并返回值作为回调函数*/ cmbScanner.connect(function(connectionState){console.log(connectionState);}）;

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

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

/* @return (promise) {status: boolean，如果连接成功，则为true如果不是false err: string，如果状态为false err将不为null} */

正如有connect ()，有一个断开()相反的方法connect ()：

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 ()这将侦听器设置为所有连接/断开/连接/断开事件。

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

它为all设置回调函数DidReceivedResultFromReader事件。

cmbScanner.setResultCallback(function(result){if(result && result);readResults && result.readResults.length > 0);forEach(function (item, index)){if (item. index);goodRead == true){//对条形码读取执行一些操作//示例:document.getElementById('content')。insertAdjacentHTML (' beforeend ', ' < div class = "结果" > <跨类=“象征”>“+项目。symbologyString +”< / span >: ' + item.readString + < / div >);//我们可以把所有这些DOM处理都放在DOM helper对象中，但因为它只是一行代码，所以让它保持不变。} }）;} }）;

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

结果对象

条码结果的结构如下:

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

在可用性更改时设置侦听器。将在设备可用或失去可用时触发。

使用

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

所有连接/断开连接事件应该在使用此API方法的回调函数集中处理。

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

当连接状态改变触发时，它将返回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方法打开闪光灯伊斯莱特森。

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

startScanning宣言

停止宣言

使用

由于读者的性质，我们应该始终设置setActiveStartScanningCallback ()函数，如果我们想根据扫描器(Reader)的状态来控制某些DOM元素。

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

例子

  start scanner  <！ - 按钮启动扫描仪的回调，避免它始终使用setAtactivestartScanningCallback  - >

如果我们想要监视扫描器(READER)的状态，我们需要设置这个回调函数。

宣言

使用

cmbscanner.setActivestartArtScanningCallback（函数（Scannstate）{if（scannstate == true）{console.log（'扫描仪工作'）;否则{console.log（'扫描仪不起作用'）;}};

如前所述，设置此函数完全不需要在startScanning ()或stopScanning ()方法。

尽管让动作在承诺中返回或在之后立即回调似乎更合适startScanning ()/stopScanning ()被称为，由于性质停止扫描进程，它在每次有结果时发生，最好在同一位置侦听两个动作(启动和停止)。

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

/ ** @return包含对象{action：调用的dmcc命令的承诺：它是否成功了，如果发生错误，它将设置为假结果：如果符号已启用，则为真，如果不是那么false err：如果操作没有完成，则错误消息} * /

例子

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

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

/**使用无瞄准器的相机。预览打开，照明可用。使用基本瞄准器(例如，StingRay)。预览关闭，照明不可用。被动瞄准器= 1，使用主动瞄准器(如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){//或者带有承诺的回调函数被包装在一个承诺中//所以如果我们不设置一个回调函数作为参数，将使用默认的一个回调函数//它将返回一个承诺来继续链});

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

宣言

使用

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

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

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

大多数API方法都可以用向MX(或Camera)读取器发送适当的命令来代替。

Send命令接收回调并将其封装到承诺中，这样链就可以继续。

使用

cmbScanner。sendCommand(“设置标志。POSTNET OFF") .then(function(result){//在promise中让我们看看我们的命令做了什么}）;//类似cmbScanner。sendCommand(“光。then(function(result){//如果命令成功，当我们启动扫描进程时，应该将LIGHT打开。}）;

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

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

但是，有些情况下，Cordova插件不会涵盖某些用例场景，我们可以始终使用Sendcommand.的。

例子

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

所以对于我们的例子，我们有:

cmbScanner。sendCommand(“设置输出。USER-CONFIGURE1 1 2 4 ON").then(function(response){ //console.log(response); //print out the result of the action });

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

cmbScanner.sendCommand("OUTPUT.USER1").then(function(response){//这将调用USER1的存储设置项，所以MX设备将基本哔哔两次红色LED和振动})

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

宣言

使用

cmbScanner.resetConfig(函数(结果){console.log(结果);}）

结果界面

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

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

例子

cmbScanner.registerSDK(“SDK_KEY”);