这些wiki页面的目的是提供API方法的详细描述科尔多瓦实现cmbSDK的插件。
JavaScript方面的插件是作为一个整体实现的js文件中可以找到的www你的文件夹科尔多瓦应用程序。
在插件文件夹中,我们还提供了一个示例文件夹,它基本上是三个文件,可以复制到您的js / index.js css / index.css而且index . html你的项目和一个cmbconfig.js文件,该文件将自动复制到/ js文件夹,当插件安装时。
它还特别涵盖了其他实现离子以及基于SAP /菲奥里平台。
来开发一个很棒的应用科尔多瓦,我们首先需要创建一个与科多瓦启动器:
cordova create excellent -cordova-app-with-cmbsdk cd excellent -cordova-app-with-cmbsdk cordova plugin add absolute_path_to_plugin_directory //例如:/Users/superUser/cmb-cordova-master cordova platform add android //cordova platform add ios //如果你想在ios上构建
对于一个离子解决方案:
#安装离子sudo npm安装- g科尔多瓦离子#开始标签布局离子的离子应用开始awesome-ionic-app标签cd awesome-ionic-app #我们的插件添加离子科尔多瓦插件添加/工作/ PLUGINS / cmb-cordova / /路径到解压缩我们的插件#添加平台离子科尔多瓦平台添加android@7.0.0酿造更新& &酿造安装gradle #看到https://gradle.org/install/ /建立直接从控制台需要更改的权限gradlew文件sudo chmod 755/Users/**/platform /android/gradlew //将需要ionic-native too npm安装ionic-native——save //将运行在android与实时刷新和控制台日志ionic- cordova运行android -l -c
这将创建一个应用程序。开发人员需要熟悉开发的过程科尔多瓦.有一些怪癖,比如iOS想要签名资料,还是安卓将会抱怨清单文件。
一旦有了科尔多瓦应用,我们可以添加我们的Cognex解决方案。
在科尔多瓦插件文件夹从样例文件夹我们需要复制index . html进入平台www文件夹中。的index.js成www / js / index.js,和index.css成www / css / index.css.cmbconfig.js自动复制到www / js文件夹中。
如果您计划使用cmbSDK在智能手机或平板电脑(没有MX移动终端)上进行移动扫描,那么SDK需要安装许可密钥。没有许可密钥,SDK仍将运行,尽管扫描结果将被混淆(SDK将随机地用星号字符替换扫描结果中的字符)。
与您的康耐视销售代表联系,了解如何获取许可密钥,包括可用于30天评估SDK的试用许可证。
安卓系统,获得许可密钥后,在应用程序的AndroidManifest.xml文件中,在应用程序标签下添加以下行:
接下来,将密钥放在YOUR_MX_MOBILE_LICENSE的位置。
iOS。获得许可密钥后,将其作为字符串添加到应用程序的Info中。Plist文件,下键MX_MOBILE_LICENSE.
开发者可以使用的常量列表如下:
有两种类型的设备可以用于此科尔多瓦插件。一个MX设备是一个硬件扫描仪,还有一个智能手机摄像头。
设备:["DEVICE_TYPE_MX_1000","DEVICE_TYPE_MOBILE_DEVICE"], DEVICES_FRIENDLY: ["MX Device","Camera"],
有两种类型的触发器,但保留了6个值。为MANUAL_TRIGGER设置,一旦在扫描过程中发现条码,扫描仪将自动停止进一步扫描。为CONTINUOUS_TRIGGER它将继续寻找条形码,并在每次找到条形码时触发事件。
TRIGGER_TYPES : ["",""," MANUAL_TRIGGER”、“”、“”、“CONTINUOUS_TRIGGER”),
Availability_unknown: 0, availability_available: 1, availability_unavailable: 2,
当我们监视READER设备(Camera或MX)与setConnectionStateDidChangeOfReaderCallback方法可以获得以下整数值之一常量对象
Connection_state_disconnected: 0, connection_state_connecting: 1, connection_state_connected: 2, connection_state_disconnect: 3,
开发者可以使用以下摄像模式:
Camera_modes: [" no_aimer ", " passive_aimer ", " active_aimer ", " front_camera "]
开发者可以使用以下预览叠加模式:
预览overlay_mode: [" om_cmb ", " om_legacy "],
可用的列表符号与我们的扫描仪一起使用。
参考维基页面摄像机阅读器的附录A DMCC有关支持的更多信息符号.
符号:{"符号。未知“:0,”符号。Datamatrix ": 1,"符号。Qr ": 2,"符号。C128": 3,"符号。Upc-ean ": 4,"符号。C11": 5,"符号。C39": 6,"符号。C93": 7,"符号。I2o5 ": 8,"符号。Codabar“:9,”符号。Ean-ucc ": 10,"符号。药典“:11,”符号。Maxicode ": 12,"符号。Pdf417 ": 13,"符号。Micropdf417 ": 14,"符号。数据“:15,”符号。邮政网“:16,”符号。行星“:17,”符号。4STATE-JAP" : 18 ,"SYMBOL.4STATE-AUS" : 19 ,"SYMBOL.4STATE-UPU" : 20 ,"SYMBOL.4STATE-IMB" : 21 ,"SYMBOL.VERICODE" : 22 ,"SYMBOL.RPC" : 23 ,"SYMBOL.MSI" : 24 ,"SYMBOL.AZTECCODE" : 25 ,"SYMBOL.DOTCODE" : 26 ,"SYMBOL.C25" : 27 ,"SYMBOL.C39-CONVERT-TO-C32" : 28 ,"SYMBOL.OCR" : 29 ,"SYMBOL.4STATE-RMC" : 30 }
接口BarcodeResult {readString: string, symbolologystring: string, symbolology: integer, goodRead: bool, xml: string, imageGraphics?:字符串,图像?: string};
成功扫描的结果以JavaScript对象的形式返回,其布局如上所示。图像是可选的,它取决于enableImage() API方法。
要启动并运行扫描仪,要做的第一件事是调用loadScanner ()方法。
它期望设备类型和一个回调函数作为第二个参数。的回调函数被包装在Promise中,并作为Promise返回。
/* @return {const (string)action:所采取的动作(将始终返回LOAD READER) (string) result:来自服务器的消息(bool) status:如果读取器被加载,它将返回true (string) err:抛出错误的字符串错误(int) type:我们连接的设备的类型[0,1](string) name:设备类型的名称DEVICES[type]} */
设备类型参数可以是字符串常量,有以下几种可能的值:
设备:[" device_type_mx_1000 "," device_type_mobile_device "]
或者我们可以直接为DEVICE_TYPE_MX传递0,为DEVICE_TYPE_MOBILE_DEVICE传递1
//回调示例:cmbScanner.loadScanner("DEVICE_TYPE_MOBILE_DEVICE",function(result){cmbScanner.connect();});//示例作为承诺cmbScanner.loadScanner("DEVICE_TYPE_MOBILE_DEVICE").then(函数(结果){cmbScanner.connect();});//传递设备类型为整数的示例cmbScanner.loadScanner(0).then(函数(结果){cmbScanner.connect();});
要在加载READER后连接到它,我们需要使用连接.
cmbScanner.connect((回调));
/* @return (promise) {status: boolean,如果连接成功则为true,如果不为false则为err: string,如果状态为false则err不会为null} */
/**使用connect并返回作为承诺的值*/ cmbScanner.connect().then(function(connectionState){console.log(connectionState);// {"status": false, "err": "没有成功返回OK "}});/**使用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.disconnect((回调))
类似于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.
它为所有设置回调函数didReceiveReadResultFromReader事件。
cmbScanner.setResultCallback(函数(结果){if(结果&&结果。readResults && result.readResults.length > 0){result.readResults. readResults.lengthforEach(函数(项目,索引){if(项目。{//对条形码读取执行一些操作//示例:document.getElementById('content')。insertAdjacentHTML('beforeend',''+项目。symbologyString +”< / span >: ' + item.readString + < / div >);//我们可以把所有这些DOM处理放在DOM帮助器对象中,但因为它只是一行代码,所以让它保持原样}else{//在没有读取条码时执行一些操作或将其保留为空// navigator.notification.alert("Stopped");}});}});
ResultCallback将在每次进行条形码扫描时触发(或者扫描仪被手动停止,或者由于没有结果而超时)。
结果对象
条码结果结构如下:
-result.readResults- json数组。如果在这里使用多代码模式,您将发现主结果(所有部分结果的集合合并在一个readString中)和所有其他部分结果
-result.subReadResults所有部分结果的json数组(如果使用单代码模式,该数组将为空)
-result.xml-读取器的完整结果的XML格式的字符串表示
result.readResults而且result.subReadResults是json数组,包含具有此结构的项:
-item.readString-条码的字符串表示
-item.symbologyString-检测到的条形码符号的字符串表示
-item.goodRead- bool标识条形码是否扫描成功
-。-以XML格式表示部分结果的字符串
-item.imageGraphics表示最后检测帧的SVG图像的字符串
-item.image- base64字符串,包含来自最后检测帧的图像
监视MX设备使用的可用性:
在可用性更改上设置侦听器。将在设备变为可用或失去可用性时触发。
cmbScanner.setAvialabilityCallback(函数(可用性){/ * * *可用性- int表示设备的可用性* /如果(可用性= = CONSTANTS.AVAILABILITY_UNKNOWN){/ /执行一些操作时设备可用性}不知道其他如果(可用性= = CONSTANTS.AVAILABILITY_AVAILABLE){/ /执行一些操作设备时可用}其他如果(可用性= = CONSTANTS.AVAILABILITY_UNAVAILABLE){/ /执行一些操作时设备不可用}});
所有连接/断开连接事件应该在使用此API方法的回调函数集中处理。
回调是可选的,因为插件提供了一个默认的回调来处理连接/断开连接事件,但默认回调只是一个占位符函数,并没有为最终应用程序开发人员提供太多功能。
当connetionStateDidChange是否触发,它将返回4个可能的整数值之一
这些可以作为整数直接访问,或者开发人员可以通过访问cmbScanner中的CONSTANTS对象从他们可用的CONSTANTS enum中使用它们.
这方面的实际例子是:
cmbScanner.setConnectionStateDidChangeOfReaderCallback(function(connectionState){if(connectionState == cmbScanner.CONSTANTS.CONNECTION_STATE_CONNECTED){//在连接时做一些事情,比如设置一个符号为enabled返回cmbScanner.setSymbologyEnabled(" symbol . qr ",true).then(function(rr){//查看setSymbologyEnabled获取rr(返回结果)对象的更多信息//在设置了符号之后,我们可以发送一个命令。让我们把闪光灯设置在cmbScanner上。sendCommand(“光。内部- enable ON") .then(function(result){//如果命令是成功的,我们应该让LIGHT打开每当我们开始扫描过程//和检查闪光是否打开我们可以使用isLightsOn API方法cmbScanner.isLightsOn().then(function(lights_on){// LIGHT应该是打开});});});}});
在这里我们不仅听连接/断开连接事件,但我们也启用了一些符号,并通过命令和API方法设置闪光灯isLightsOn.
如果希望监视扫描器(READER)的状态,则需要设置这个回调函数。
cmbScanner.setActiveStartScanningCallback(function(scannerState){if(scannerState == true){console.log('扫描仪正在工作');} else{console.log('扫描器不工作');}});
如前所述,设置此函数完全消除了在startScanning ()或stopScanning ()方法。
尽管在承诺或回调中立即返回该操作似乎更合适startScanning ()/stopScanning ()是叫,由于性质stopScanning过程,它在每次有结果时发生,最好在同一个地方监听两个动作(开始和停止)。
检查并请求允许使用摄像头用移动设备扫描条形码。
/* @return (promise) {status: boolean,使用摄像头的权限状态message: int,如果可以请求权限,则为1,否则为0}*/
要启动/停止扫描过程,我们使用这两种方法。它们既可以通过应用程序的UI从按钮调用,也可以通过编程调用。
由于读者的性质,我们应该始终设定setActiveStartScanningCallback ()函数,如果我们想基于扫描器(Reader)的状态控制某些DOM元素。
cmbScanner.startScanning(function(scannerState){if(scannerState) document.getElementById('scanner-active-label')[removed] = 'RUNNING';else document.getElementById('scanner-active-label')[removed] = 'STOPPED';});
< a href = " cmbScanner.startScanning ();">启动扫描仪 Stop Scanner Start Scanner
要从图像中扫描条形码,我们可以使用scanImage或scanImageFromBase64。
/* @return (promise) {status: boolean,图像扫描执行状态err: string,如果status false err将不会为null} */
setsymbolologyenabled (symbol,on_off,[callback]) /* @return一个承诺,包含JSON对象{action:被调用的DMCC命令status:它是否成功,如果发生错误,它将被设置为false result:如果启用了符号则为true,如果没有则为false err:如果操作未完成的错误消息}*/
如何使用它的例子:
cmbScanner.setSymbologyEnabled(“SYMBOL.C93”,的确,函数(结果){console.log (JSON.stringify(结果));//将打印{"action": "SET SYMBOL. "C93 ON","status": true, "result": true, "err": null}});//或使用承诺cmbscanner . setsymbolologyenabled ("SYMBOL.C93",true).then(function(result){console.log(JSON.stringify(result));//将打印{"action": "SET SYMBOL. "C93 ON","status": true, "result": true, "err": null}});
要检查是否启用了某个符号,可以使用isSymbologyEnabled ().
/** @return一个承诺,包含对象{action:被调用的DMCC命令status:它是否成功,如果发生错误,它将被设置为false result:如果符号启用则为true,如果未启用则为false err:如果操作未完成则为错误消息}*/
cmbScanner.isSymbologyEnabled(“SYMBOL.C93函数(rr) {console.log (JSON.stringify (rr));//将打印{"action": "GET符号。C93”、“地位”:真的,“犯错”:空,“结果”:真正}});
当我们使用摄像头设备作为条形码阅读器时,要设置摄像头的行为方式:
/**使用不带瞄准镜的相机。预览打开,照明可用。NO_AIMER = 0,使用相机与基本的瞄准器(例如,StingRay)。预览关闭,照明不可用。1、使用带有主动瞄准器的相机(例如MX-100)。预览关闭,照明可用。ACTIVE_AIMER = 2,使用移动设备前置摄像头。预览打开,照明不可用。Front_camera = 3 */
当使用移动设备相机时,它控制预览/扫描选项。多个选项可以一起“或”。
/** *使用默认值(不覆盖)。*/ "DEFAULTS": 0, /** *禁用缩放功能(从预览中移除缩放按钮)。*/ "NO_ZOOM_BTN": 1, /** *禁用照明(从预览中移除照明按钮)。*/ "NO_ILLUM_BTN": 2, /** *启用模拟硬件触发器(音量下降按钮)。*/ "HARDWARE_TRIGGER": 4, /** *当扫描开始时,预览显示,但解码暂停,直到按下触发器(屏幕上的按钮或音量下降按钮,如果启用)。*/ "PREVIEW_PAUSED": 8, /** *强制预览显示,即使默认是关闭的(例如,当使用kCDMCameraModePassiveAimer或kCDMCameraModeActiveAimer)。*/ "PREVIEW_ALWAYS_SHOW": 16, /** *如果设备支持,请使用更高分辨率。默认值是1280x720,这个参数是1920x1080。*/ "HIGH_RESOLUTION": 64, /** *如果设备支持,请使用更高的帧速率。默认是30帧,这个参数将使用60帧。 */ "HIGH_FRAME_RATE" : 128, /** * Show close button in partial view. */ "SHOW_CLOSE_BUTTON" : 256, /** * Keep the preview in paused state after read or timeout. */ "KEEP_PREVIEW_IN_PAUSED_STATE" : 512
/* @params x,y,w,h x,y:左上角的位置w,h:矩形的宽度和高度占整个容器的百分比*/
cmbScanner.setPreviewContainerPositionAndSize(0、0100、50);//将设置预览为0,0和100%宽度50%高度
仅在iOS上可用,仅适用于摄像头阅读器。
设置摄像头预览部分视图顶部轴,以匹配android行为的状态栏下方开始。它需要一个布尔参数。
cmb.setPreviewContainerBelowStatusBar(真正的);cmb.setPreviewContainerPositionAndSize ([0, 0100, 50]);//将设置预览为0,0和100%宽度50%高度。//在iOS上,部分视图将显示在状态栏的下方。
cmb.setPreviewContainerBelowStatusBar(假);cmb.setPreviewContainerPositionAndSize ([0, 0100, 50]);//将设置预览为0,0和100%宽度50%高度。//在iOS上,部分视图将从屏幕顶部开始,并与状态栏重叠。
设置相机叠加模式。您需要在调用loadScanner之前执行该操作,否则它将无法正常工作。
只在MX-Mobile上可用。
阅读更多关于叠加模式的信息在这里
cmb.setPreviewOverlayMode (cmb.CONSTANTS.PREVIEW_OVERLAY_MODE.OM_CMB);
设置当应用程序UI改变方向时是否应该停止扫描会话。它需要一个布尔参数。
cmb.setStopScannerOnRotate(真正的);
在使用移动相机扫描时显示或隐藏在相机预览顶部的消息。
要以编程方式启用闪光灯,我们可以使用:
/** @return一个包含JSON对象{(string) action的承诺:被调用的DMCC命令(bool) status:它是否成功,如果发生错误,它将被设置为false (string) err:操作未完成时的错误消息(bool) result:所执行操作的结果,在这种情况下,灯亮时为TRUE,未灯亮时为false} */
cmbScanner.setLightsOn(真的,函数(响应){/ / console.log(响应);});cmbScanner.setLightsOn(true).then(function(response){//或者带有承诺,回调函数被封装在承诺中//所以如果我们没有将回调函数设置为参数,将使用默认的回调函数//它将返回一个承诺以继续链});
要检查闪光灯是否亮着,我们可以用:
/** @return一个包含JSON对象{(string) action的承诺:被调用的DMCC命令(bool) status:它是否成功,如果发生错误,它将被设置为false (string) err:操作未完成时的错误消息(bool) result:所执行操作的结果,在这种情况下,灯亮时为TRUE,未灯亮时为false} */
cmbScanner.isLightsOn(真的,函数(响应){/ / console.log(响应);});cmbScanner.isLightsOn(true).then(function(response){//或者带有承诺,回调函数被封装在承诺中//所以如果我们没有设置回调函数作为参数,将使用默认的回调函数//它将返回一个承诺以继续链});
如果我们想返回我们使用的解码器所看到的最后一个图像enableImage ().如果我们想要使用返回图像的图像图形统计enableImageGraphics()。
cmbScanner.enableImage(真正的);cmbScanner.enableImageGraphics(true);//将显示条形码在图像上被检测到的确切位置
条码结果对象的结构为:
接口BarcodeResult {readString: string, symbolologystring: string, symbolology: integer, goodRead: bool, xml: string, imageGraphics?:字符串,图像?: string};
启用或禁用扫描条形码的解析。期望有一个cmb.CONSTANTS.PARSERS类型的参数。
cmb.setParser (cmb.CONSTANTS.PARSERS.GS1);
为readString结果类型设置编码。期望有一个cmb.CONSTANTS.READSTRING_ENCODING类型的参数。
cmb.setReadStringEncoding (cmb.CONSTANTS.READSTRING_ENCODING.UTF_8);
大多数API方法都可以替换为只向MX(或Camera)阅读器发送适当的命令。
Send命令接收回调并将其包装为承诺,这样链就可以继续。
使用
cmbScanner。sendCommand(“设置标志。然后(function(result){//在promise中让我们看看我们的命令做了什么console.log(JSON.stringify(result));});//或者像这个cmbScanner。sendCommand(“光。then(function(result){//如果命令成功,我们应该在启动扫描过程时打开LIGHT。});
第一个命令将禁用象征POSTNET.第二步将设置Flash ON。
这两个操作都可以用它们相应的API函数执行setSymbologyEnabled ()而且setLightsOn ()一般来说,开发人员应该总是喜欢API函数而不是sendCommand()。
然而,在有些情况下,Cordova插件不覆盖某些用例场景,我们总是可以使用sendCommand的。
如果我们想改变MX设备“哔”和“亮”的方式,我们可以使用:
行动 | 命令 | 参数 | 参数值 | 参数说明 | 产生的作用 |
---|---|---|---|---|---|
设置|获取 |
输出。USER-CONFIGURE |
事件编号,蜂鸣声,蜂鸣声编号,LED颜色,振动 |
[1,2] [0-2] [0-3] [0-7] [on | off] |
1: user_event_1, 2: user_event_2 |
为USER_EVENT_1或USER_EVENT_2设置蜂鸣声和蜂鸣声的数量。 |
在我们的例子中,我们有:
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和振动})
仅支持iOS。
拥有和运营许多康耐视移动终端的公司可能希望远程收集关于电池电量、电池健康状况、已安装固件等的最新信息。
使用cmbSDK框架的iOS应用程序可以向MDM实例报告所连接的移动终端的状态信息。这可以通过setMDMReportingEnabled方法来实现,该方法接受一个布尔参数。
可以找到关于MDM Reporting的更多信息在这里
cmb.setMDMReportingEnabled(真正的);
仅支持iOS。
用于创建用于MDM报告的身份验证凭据。它接受四个字符串参数:username、password、clientID和clientSecret。
应该在setMDMReportingEnabled之前调用。
可以找到关于MDM Reporting的更多信息在这里
招商银行。createMDMAuthCredentials("username", "password", "clientID", "clientSecret");
如果我们需要重置为MX/Camera阅读器存储的配置设置,我们可以使用:
cmbScanner.resetConfig(函数(结果){console.log(结果);})
/* @return一个包含JSON对象{(string)动作的承诺:被调用的DMCC命令(bool)状态:它是否成功,如果发生错误,它将被设置为false (string) err:如果操作没有完成,有错误,则返回错误消息。default是null (bool) result: sendCommand操作的结果}*/
要查看您当前使用的cmbSDK版本:
/** @return包含cmbSDK版本字符串{(string) version: cmbSDK version} */的承诺
获取相机曝光补偿范围。
返回成功的回调函数并将range作为JSON对象,或者返回错误回调函数并在出错时返回错误消息。
cmbScanner.getCameraExposureCompensationRange(函数(范围){//范围是带有这些属性的JSON对象// "lower":最小相机曝光值// "upper":最大相机曝光值// "step":相机曝光步长值console.log(JSON.stringify(范围));},函数(错误){console.log(错误);});
注意:相机需要在cmbSDK中至少启动一次,以获得相机曝光补偿范围。
设置相机曝光补偿值。发送将被设置为曝光补偿的浮动值。
cmbScanner。setCameraExposureCompensation(5,函数(错误){console.log(错误);});
注意:这需要在成功连接到阅读器设备后调用。如果发送值大于相机曝光最大值,则设置最大值,如果发送值小于相机曝光最小值,则设置最小值。