Scanning Capabilities

To configure your scanner to use a specific capability, a specific configuration is required.

To demonstrate how this works, here’s a JSON example:

{
  "pluginConfig": {
    "id": "MyDialMeterPlugin",
    "meterConfig": {
      "scanMode": "dial_meter"
    },
    "cancelOnResult": true
  }
}

The type of capability is determined by the type of config within the pluginConfig node. In this case, it’s a meterConfig.

Use the "id" property to set a name for your Scan Plugin, which will be returned to you in the Scan Result with the "pluginID" property.

Each type of config produces the respective type of result. So in this case, you can expect to get a pluginResult that contains a meterResult. For example:

{
  "confidence": 56,
  "cropRect": {
    "height": 432,
    "width": 864,
    "x": 208,
    "y": 0
  },
  "meterResult": {
    "value": "39804"
  },
  "pluginID": "MyMeterPlugin"
}

Here’s a list of each configuration type matched with the result type:

Config Type Result Type Supported

barcodeConfig

barcodeResult

Yes

meterConfig

meterResult

Partially (Analog Meters, Digital Meters & Dial Meters only)

universalIdConfig

universalIdResult

Partially (AT/DE Driving License)

mrzConfig

mrzResult

Yes

licensePlateConfig

licensePlateResult

Partially (All EU Countries & US only)

tinConfig

tinResult

Yes

tireSizeConfig

tireSizeResult

Yes

commercialTireIdConfig

commercialTireIdResult

Yes

vinConfig

vinResult

Yes

containerConfig

containerResult

Yes

ocrConfig

ocrResult

Partially (VIN, Shipping Container & Universal Serial Number only)

The PluginConfig and PluginResult parameters are documented in the following pages.