diff --git a/docs/hosted/express/configuration/device-pairing/online-connection.md b/docs/hosted/express/configuration/device-pairing/online-connection.md index cd02da85d4..b363960b89 100644 --- a/docs/hosted/express/configuration/device-pairing/online-connection.md +++ b/docs/hosted/express/configuration/device-pairing/online-connection.md @@ -31,17 +31,18 @@ npm install @scandit/web-barcode-link import { BarcodeLink, BarcodeLinkMode, + BarcodeLinkSymbology, BarcodeLinkUiFlow } from '@scandit/web-barcode-link'; ``` -2. Initialize BarcodeLink +2. Create a BarcodeLink Instance ```javascript const barcodeLink = BarcodeLink.forLicenseKey('YOUR_SCANDIT_LICENSE_KEY'); ``` -3. Set the Scanning Mode +3. Set the Barcode Link Mode ```javascript barcodeLink.setBarcodeLinkMode(BarcodeLinkMode.ContinuousScanning); @@ -51,9 +52,9 @@ barcodeLink.setBarcodeLinkMode(BarcodeLinkMode.ContinuousScanning); ```javascript barcodeLink.setSymbologies({ - ean13Upca: { enabled: true }, - code128: { enabled: true }, - qr: { enabled: true } + [BarcodeLinkSymbology.EAN13UPCA]: { enabled: true }, + [BarcodeLinkSymbology.Code128]: { enabled: true }, + [BarcodeLinkSymbology.QR]: { enabled: true } }); ``` @@ -61,11 +62,14 @@ barcodeLink.setSymbologies({ ```javascript barcodeLink.addListener({ - onCapture: (barcodes) => { + onCapture: (barcodes, finished) => { barcodes.forEach((barcode) => { console.log('Scanned:', barcode.data); // Handle the scanned data here }); + if (finished) { + // The scanning session has ended + } } }); ``` @@ -79,7 +83,7 @@ await barcodeLink.initialize(new BarcodeLinkUiFlow()); ## Terminate the Session ```javascript -await barcodeLink.dispose(); +barcodeLink.dispose(); ``` ## API Reference @@ -102,7 +106,7 @@ Use `forLicenseKey(licenseKey: string): BarcodeLink` to create a new `BarcodeLin barcodeLink.setBarcodeLinkMode(BarcodeLinkMode.ContinuousListBuilding); ``` -Sets the scanning mode. +Sets the Barcode Link mode. **Available values:** @@ -140,6 +144,8 @@ barcodeLink.setDisconnectionTimeout(30 * 60 * 1000); Sets how long Barcode Link keeps trying to reconnect after the desktop and the smartphone lose their connection to each other. If the connection is not restored within this window, the session is aborted on both devices. +Added in `@scandit/web-barcode-link` 1.2.0. + The value is in milliseconds. It defaults to 15 minutes (`900000`) and is clamped between 1 minute (`60000`) and 60 minutes (`3600000`). #### `setPlatform(platform: BarcodeLinkPlatform): BarcodeLink` @@ -166,6 +172,10 @@ barcodeLink.setBarcodeRegexValidation(/\d+/); Defines a regex to validate barcodes. Only matching barcodes are processed. By default no validation is applied. +:::warning +Don't add flags such as `i`, `g` or `u` to the regex. Barcode Link removes only the first and last character of the regex, so `/abc/i` becomes the pattern `abc/` and valid barcodes no longer match. For case-insensitive matching, list both cases in the pattern, for example `/^[A-Za-z0-9]+$/`. Patterns that need the `u` flag, such as `\p{L}`, don't work. +::: + #### `setBarcodeTransformations(barcodeTransformations: unknown): BarcodeLink` ```ts @@ -178,13 +188,13 @@ Sets barcode transformation logic. Only used when `platform` is `BarcodeLinkPlat ```ts barcodeLink.setSymbologies({ - ean13upca: { + [BarcodeLinkSymbology.EAN13UPCA]: { enabled: true, }, }); ``` -Enables specific symbologies for scanning. +Enables specific symbologies for scanning. Use the `BarcodeLinkSymbology` constants as keys. They hold the exact key strings Barcode Link expects, such as `ean13Upca`. **[See all supported symbologies](https://docs.scandit.com/barcode-symbologies/)** @@ -227,7 +237,7 @@ barcodeLink.addListener({ ``` Called when the remote device sends barcodes. -- `finished`: Indicates if scanning has finished (used in continuous modes). +- `finished`: `true` when the scanning session on the remote device has ended. Check it in every mode to know when to clean up. ##### `onConnectionStateChanged` @@ -263,7 +273,7 @@ Removes a previously added listener. ### Initialization -#### `initialize(flow: BarcodeLinkFlow): Promise` +#### `initialize(flow: BarcodeLinkFlow): Promise` ```ts await barcodeLink.initialize(new BarcodeLinkUiFlow()); @@ -287,6 +297,8 @@ Initializes Barcode Link using a specific flow. Example: ```ts +import { BarcodeLinkHeadlessFlow } from "@scandit/web-barcode-link"; + const qrcode = await barcodeLink.initialize(new BarcodeLinkHeadlessFlow()); const img = document.createElement("img"); @@ -304,7 +316,7 @@ document.body.append(a); #### `dispose(): void` ```ts -await barcodeLink.dispose(); +barcodeLink.dispose(); ``` Closes the Barcode Link session, useful when unmounting components or ending a session manually. diff --git a/docs/hosted/express/configuration/index.md b/docs/hosted/express/configuration/index.md index 0ca6f5c390..59ce6c6cbb 100644 --- a/docs/hosted/express/configuration/index.md +++ b/docs/hosted/express/configuration/index.md @@ -45,27 +45,25 @@ You can configure Scandit Express to inject additional keystrokes after a barcod ### Scanning Options -Scandit Express supports different scanning options to optimize the scanning experience for different use cases. There are two options available by default: Accuracy and Speed. Two additional options, Batch and List, are available if you have purchased MatrixScan. +Scandit Express has two scanning modes: Single and Batch. You can also turn on list building to collect your scans in a list. -#### Accuracy +#### Single -Use this mode to select one barcode out of many. This mode detects all barcodes available, then gives visual feedback on the screen (an augmented-reality overlay) so the user can select the target barcode. This mode scans one barcode at a time. +Use Single mode to scan one barcode at a time. Point the camera at a barcode and Scandit Express scans it. If several barcodes are close together, choose the one you want. -#### Speed - -Use this mode to scan barcodes consecutively at high speed. This mode scans successive items at high speed without the need to keep tapping on the screen. - -Speed Mode +Single mode, also called Smart Scan Selection, is available from Scandit Express 4.3.0 on iOS and 4.4.0 on Android. It replaces the Accuracy and Speed modes of earlier versions. #### Batch -Use this mode to scan a batch of barcodes all at once. This mode scans all visible barcodes instantly. It’s perfect when all barcodes are visible and the volume is high. +Use Batch mode to scan all visible barcodes at once, for example when you have many barcodes in view. + +To use Batch mode, you need a MatrixScan license and list building turned on. Batch Mode -#### List +#### List Building -The list mode icon allows the user to see the list of barcodes that have been scanned. List mode, when activated, works for barcodes scanned in any mode (basic speed scanning, accuracy, and batch). +List building collects your scans in a list. You check the list, and then Scandit Express types the barcodes into the field. List building works in Single and Batch mode. It doesn't need a MatrixScan license, but Batch mode does. ### Activate via Hardware Button diff --git a/docs/hosted/express/configuration/scan-labels.md b/docs/hosted/express/configuration/scan-labels.md index 10f4b20b18..f6e85fbdfc 100644 --- a/docs/hosted/express/configuration/scan-labels.md +++ b/docs/hosted/express/configuration/scan-labels.md @@ -28,11 +28,11 @@ Label scanning can be enabled and configured in your [Scandit Dashboard](https:/ Label Scanning

-Once enabled, you can select from a the following pre-defined label types, and the respective fields will be automatically detected when scanning: +Once enabled, you can select from the following predefined label types, and the respective fields will be automatically detected when scanning: -* **Smart Device**: Captures the UPC/EAN, IMEI1 and IMEI2, and Serial Number from mobile device labels. -* **Price Weight**: This factory method is designed for price checking scenarios where both barcode and price text need to be captured from product labels. Returns `SKU` and `priceText` fields. -* **VIN**: Captures the Vehicle Identification Number (VIN) from vehicle labels. +* **Smart Device Label**: Captures the UPC/EAN, IMEI1 and IMEI2, and Serial Number from mobile device labels. +* **Price Label**: Captures the product barcode and the printed price from price labels. +* **VIN Label**: Captures the Vehicle Identification Number (VIN) from vehicle labels. :::tip If you need to customize the behavior of the Smart Label Capture feature, please contact [Scandit Support](mailto:support@scandit.com). diff --git a/docs/hosted/express/overview.md b/docs/hosted/express/overview.md index 6f3db77ad1..09c850b78d 100644 --- a/docs/hosted/express/overview.md +++ b/docs/hosted/express/overview.md @@ -29,15 +29,16 @@ The Scandit Express user interface (UI) is designed to resemble a smartphone cam ![Scandit Express](/img/express/express_ui.png) -Depending on the mode selected, the user has a choice of scanning barcodes one by one or batch scanning many codes simultaneously. For batch scanning, users can scan as many barcodes as they want and verify them in a list, before inputting them into the desired field. +You can scan barcodes one at a time or all at once, and collect your scans in a list to check them before they go into the field. ### Scanning Modes -Scandit Express offers multiple scanning modes: +Scandit Express offers two scanning modes: -* **Accuracy**: Scans one barcode out of many in the camera’s field of view. It detects all barcodes available and provides an AR overlay to help the user select one target barcode. -* **Speed**: Scans multiple barcodes in quick succession. It removes the need to tap the screen repeatedly. -* **Batch**: Scans all visible barcodes and stores them in a list. +* **Single**: Point the camera at a barcode to scan it. If several barcodes are close together, choose the one you want. Single mode, also called Smart Scan Selection, is available from Scandit Express 4.3.0 on iOS and 4.4.0 on Android. It replaces the earlier Accuracy and Speed modes. +* **Batch**: Scan all visible barcodes at once. To use Batch mode, you need a MatrixScan license and list building turned on. + +With list building, your scans go into a list. You check the list, and then Scandit Express types the barcodes into the field. List building works in both modes. It doesn't need a MatrixScan license, but Batch mode does. ## Security and Compliance diff --git a/docs/hosted/id-bolt/data-handling.md b/docs/hosted/id-bolt/data-handling.md index aaaa8eae05..874734d180 100644 --- a/docs/hosted/id-bolt/data-handling.md +++ b/docs/hosted/id-bolt/data-handling.md @@ -65,6 +65,10 @@ const idBoltSession = IdBoltSession.create(ID_BOLT_URL, { | `AnonymizationMode.ImagesOnly` | Only images are anonymized | 1.3 | | `AnonymizationMode.FieldsAndImages` | Both fields and images are anonymized | 1.3 | +:::note +ID Bolt's default differs from the ID Capture SDK's. ID Bolt applies `AnonymizationMode.None` unless you set another mode, while the ID Capture SDK defaults to `FieldsOnly`. To get the SDK's behavior, set `anonymizationMode: AnonymizationMode.FieldsOnly`. +::: + ### Effects of Anonymization - **Fields Anonymization**: Sensitive fields are not extracted from documents diff --git a/docs/hosted/id-bolt/overview.md b/docs/hosted/id-bolt/overview.md index ec54221c5e..c6adc06bde 100644 --- a/docs/hosted/id-bolt/overview.md +++ b/docs/hosted/id-bolt/overview.md @@ -1,5 +1,5 @@ --- -description: "ID Bolt is a cloud-based identity scanning solution for fast, on-device ID scanning across desktop and mobile, improving experience and compliance." +description: "ID Bolt is a hosted identity scanning solution for fast, on-device ID scanning across desktop and mobile, improving experience and compliance." sidebar_position: 1 sidebar_label: "Overview" @@ -11,7 +11,7 @@ keywords: - bolt --- -ID Bolt is a cloud-based identity scanning solution that enables you to provide customers a fast, foolproof ID scanning in just 1 second, leading to an improved customer experience as well as compliance. It works on-device, via desktop and mobile in a unified solution, ensuring no identity information is collected by third-party servers and reduces latency for quick scanning performance. +ID Bolt is a hosted identity scanning solution that enables you to provide customers a fast, foolproof ID scanning in just 1 second, leading to an improved customer experience as well as compliance. Scandit hosts the scanning UI and keeps it up to date. The scanning itself runs on the user's device, in the browser, on desktop and mobile alike. Scandit's servers never see identity data in readable form, and on-device scanning reduces latency for quick scanning performance. :::tip In addition to ID Bolt, Scandit provides an [ID Capture SDK for the Web](/sdks/web/id-capture/intro.md) that allows full flexibility around the user interface and user flow. @@ -22,8 +22,8 @@ In addition to ID Bolt, Scandit provides an [ID Capture SDK for the Web](/sdks/w ID Bolt offers the following features: - **Fast Scanning**: ID Bolt scans an ID in just 1 second. Scans are performed from video streams for the fastest possible scanning. -- **On-Device Scanning/Processing**: ID Bolt scans IDs on-device, ensuring no identity information is collected by third-party servers, and handling all processing on the device for improved performance. -- **Device Handover**: ID Bolt works on both desktop and mobile devices, providing a unified solution. Desktop/laptop users can scan IDs using their mobile device camera. +- **On-Device Scanning/Processing**: ID Bolt scans IDs on the user's device, in the browser. Scandit's servers never see identity data in readable form, and processing on the device improves performance. +- **Device Handover**: ID Bolt works on both desktop and mobile devices, providing a unified solution. Desktop/laptop users can scan IDs using their mobile device camera. The handover goes through Scandit's relay, end-to-end encrypted. - **Industry Leading UX**: ID Bolt presents a simple, intuitive interface, designed based on the millions of scans performed by Scandit customers each year. -- **Compliance**: ID Bolt ensures compliance with data protection regulations, such as GDPR, by processing all data on-device and not collecting any identity information on third-party servers. +- **Compliance**: ID Bolt ensures compliance with data protection regulations, such as GDPR, by scanning on the device. Scandit's servers never see identity data in readable form, including during device handover. - **White-Label Solution**: ID Bolt can be placed behind your own domain, allowing you to maintain brand consistency and provide an integrated experience to your customers while leveraging Scandit's powerful ID scanning capabilities. diff --git a/docs/partials/_id-scanning.mdx b/docs/partials/_id-scanning.mdx index b6b9c348d9..dfa91cf3e9 100644 --- a/docs/partials/_id-scanning.mdx +++ b/docs/partials/_id-scanning.mdx @@ -36,7 +36,7 @@ To experience Scandit scanning and verification capabilities firsthand, check ou ## ID Bolt -ID Bolt is a cloud-based identity scanning solution that can be quickly and easily integrated into any existing web-based application. ID Bolt can be used to scan and extract data from a wide range of identity documents, including passports, visas, driver’s licenses, and ID cards. +ID Bolt is a hosted identity scanning solution that can be quickly and easily integrated into any existing web-based application. ID Bolt can be used to scan and extract data from a wide range of identity documents, including passports, visas, driver’s licenses, and ID cards. diff --git a/docs/partials/advanced/_id-documents-full-document.mdx b/docs/partials/advanced/_id-documents-full-document.mdx index 33cbf4b59c..6ff5493fc5 100644 --- a/docs/partials/advanced/_id-documents-full-document.mdx +++ b/docs/partials/advanced/_id-documents-full-document.mdx @@ -331,8 +331,12 @@ This scanner combines data extraction from all supported parts of the document a #### Anonymized Documents -Some countries have specific requirements for the anonymization of documents. By default, ID Capture will omit sensitive fields from countries with such restrictions. To control this behavior, you can set the `IdAnonymizationMode` parameter. -Depending on the anonymization mode, certain sensitive fields are not extracted from documents (their values are returned as nil) or they are blacked out on the returned document images. +Some countries have specific requirements for the anonymization of documents. By default, ID Capture omits sensitive fields from documents of those countries: `IdCaptureSettings.anonymizationMode` defaults to `IdAnonymizationMode.FieldsOnly`. To turn anonymization off and receive all fields, set it to `IdAnonymizationMode.None`. Value names follow each platform's conventions, for example `fieldsOnly` on iOS and `FIELDS_ONLY` on Android. +Depending on the anonymization mode, certain sensitive fields are not extracted from documents (their values are returned empty: `nil` or `null`, depending on the platform) or they are blacked out on the returned document images. + +Because of this default, the fields listed in the table below come back empty, for example the document number of German ID cards and passports. That's the result of anonymization, not a scanning error. + +ID Bolt uses a different default, `AnonymizationMode.None`. See [ID Bolt data handling](/hosted/id-bolt/data-handling.md#anonymization-mode). Documents and fields that are subject to anonymization are listed below: diff --git a/docs/partials/intro/_about-id-capture.mdx b/docs/partials/intro/_about-id-capture.mdx index efbf9e890f..8815f19e55 100644 --- a/docs/partials/intro/_about-id-capture.mdx +++ b/docs/partials/intro/_about-id-capture.mdx @@ -7,5 +7,5 @@ The scanning and validation results can be used to enable real-time decision mak ID Capture runs on any smart device with a camera, including smartphones, tablets, and dedicated scanners. :::tip -In addition to the ID Capture capabilities of the Scandit SDK, Scandit also offers a cloud-based identity scanning solution called [ID Bolt](https://www.scandit.com/products/id-bolt/). ID Bolt can be quickly and easily integrated into any existing web-based application. See the [documentation](https://docs.scandit.com/hosted/id-bolt/overview/) for more information. +In addition to the ID Capture capabilities of the Scandit SDK, Scandit also offers a hosted identity scanning solution called [ID Bolt](https://www.scandit.com/products/id-bolt/). ID Bolt can be quickly and easily integrated into any existing web-based application. See the [documentation](https://docs.scandit.com/hosted/id-bolt/overview/) for more information. ::: \ No newline at end of file diff --git a/docs/partials/intro/_about-matrixscan-pick.mdx b/docs/partials/intro/_about-matrixscan-pick.mdx index 97e7a74120..c41afa9039 100644 --- a/docs/partials/intro/_about-matrixscan-pick.mdx +++ b/docs/partials/intro/_about-matrixscan-pick.mdx @@ -28,6 +28,6 @@ MatrixScan Pick is implemented through functionality provided by symbologies **except** DotCode, MaxiCode and postal codes (KIX, RM4SCC). +MatrixScan Pick supports all symbologies **except** DotCode, MaxiCode and postal codes (KIX, RM4SCC). If you are not familiar with the symbologies that are relevant for your use case, you can use capture presets that are tailored for different verticals (e.g. retail, logistics, etc.). diff --git a/docs/sdks/ios/matrixscan-find/get-started.md b/docs/sdks/ios/matrixscan-find/get-started.md index c26a21bf31..38903d33d8 100644 --- a/docs/sdks/ios/matrixscan-find/get-started.md +++ b/docs/sdks/ios/matrixscan-find/get-started.md @@ -15,7 +15,7 @@ In this guide you will learn step-by-step how to add MatrixScan Find to your app - A Barcode Find View: The pre-built UI elements used to highlight found items. :::note -MatrixScan Count is implemented via [`SDCBarcodeFind`](https://docs.scandit.com/data-capture-sdk/ios/barcode-capture/api/barcode-find.html#class-scandit.datacapture.barcode.find.BarcodeFind). +MatrixScan Find is implemented via [`SDCBarcodeFind`](https://docs.scandit.com/data-capture-sdk/ios/barcode-capture/api/barcode-find.html#class-scandit.datacapture.barcode.find.BarcodeFind). ::: The general steps are: @@ -39,7 +39,7 @@ import DataCaptureContextIos from '../../../partials/get-started/_create-data-ca -## Configure the Barcode Count Mode +## Configure the Barcode Find Mode The main entry point for the Barcode Find Mode is the [`SDCBarcodeFind`](https://docs.scandit.com/data-capture-sdk/ios/barcode-capture/api/barcode-find.html#class-scandit.datacapture.barcode.find.BarcodeFind) object. You can configure the supported Symbologies through its [`SDCBarcodeFindSettings`](https://docs.scandit.com/data-capture-sdk/ios/barcode-capture/api/barcode-find-settings.html#class-scandit.datacapture.barcode.find.BarcodeFindSettings), and set up the list of items that you want MatrixScan Find to highlight. diff --git a/src/data/products.json b/src/data/products.json index 36ba79024c..830e1685f0 100644 --- a/src/data/products.json +++ b/src/data/products.json @@ -192,7 +192,7 @@ { "key": "parser", "name": "Parser", - "description": "Extract structured data from encoded barcodes including GS1, AAMVA, HIBC, and other industry-standard formats. Automatically parse complex barcode data into easily usable fields without manual string manipulation.", + "description": "Extract structured data from encoded barcodes including GS1, HIBC, Swiss QR, VIN, and other industry-standard formats. Automatically parse complex barcode data into easily usable fields without manual string manipulation.", "frameworks": { "iOS": { "version": "6.1", "apiUrl": "/sdks/ios/parser/get-started" }, "Android": { "version": "6.1", "apiUrl": "/sdks/android/parser/get-started" }, diff --git a/versioned_docs/version-7.6.15/hosted/express/configuration/device-pairing/online-connection.md b/versioned_docs/version-7.6.15/hosted/express/configuration/device-pairing/online-connection.md index 0174c75505..35e9986702 100644 --- a/versioned_docs/version-7.6.15/hosted/express/configuration/device-pairing/online-connection.md +++ b/versioned_docs/version-7.6.15/hosted/express/configuration/device-pairing/online-connection.md @@ -30,17 +30,18 @@ npm install @scandit/web-barcode-link import { BarcodeLink, BarcodeLinkMode, + BarcodeLinkSymbology, BarcodeLinkUiFlow } from '@scandit/web-barcode-link'; ``` -2. Initialize BarcodeLink +2. Create a BarcodeLink Instance ```javascript const barcodeLink = BarcodeLink.forLicenseKey('YOUR_SCANDIT_LICENSE_KEY'); ``` -3. Set the Scanning Mode +3. Set the Barcode Link Mode ```javascript barcodeLink.setBarcodeLinkMode(BarcodeLinkMode.ContinuousScanning); @@ -50,9 +51,9 @@ barcodeLink.setBarcodeLinkMode(BarcodeLinkMode.ContinuousScanning); ```javascript barcodeLink.setSymbologies({ - ean13Upca: { enabled: true }, - code128: { enabled: true }, - qr: { enabled: true } + [BarcodeLinkSymbology.EAN13UPCA]: { enabled: true }, + [BarcodeLinkSymbology.Code128]: { enabled: true }, + [BarcodeLinkSymbology.QR]: { enabled: true } }); ``` @@ -60,11 +61,14 @@ barcodeLink.setSymbologies({ ```javascript barcodeLink.addListener({ - onCapture: (barcodes) => { + onCapture: (barcodes, finished) => { barcodes.forEach((barcode) => { console.log('Scanned:', barcode.data); // Handle the scanned data here }); + if (finished) { + // The scanning session has ended + } } }); ``` @@ -78,7 +82,7 @@ await barcodeLink.initialize(new BarcodeLinkUiFlow()); ## Terminate the Session ```javascript -await barcodeLink.dispose(); +barcodeLink.dispose(); ``` ## API Reference @@ -101,7 +105,7 @@ Use `forLicenseKey(licenseKey: string): BarcodeLink` to create a new `BarcodeLin barcodeLink.setBarcodeLinkMode(BarcodeLinkMode.ContinuousListBuilding); ``` -Sets the scanning mode. +Sets the Barcode Link mode. **Available values:** @@ -131,6 +135,18 @@ Sets the behavior for how barcodes are listed. Only used in `SingleListBuilding` and `ContinuousListBuilding` modes. ::: +#### `setDisconnectionTimeout(disconnectionTimeout: number): BarcodeLink` + +```ts +barcodeLink.setDisconnectionTimeout(30 * 60 * 1000); +``` + +Sets how long Barcode Link keeps trying to reconnect after the desktop and the smartphone lose their connection to each other. If the connection is not restored within this window, the session is aborted on both devices. + +Added in `@scandit/web-barcode-link` 1.2.0. + +The value is in milliseconds. It defaults to 15 minutes (`900000`) and is clamped between 1 minute (`60000`) and 60 minutes (`3600000`). + #### `setPlatform(platform: BarcodeLinkPlatform): BarcodeLink` ```ts @@ -155,6 +171,10 @@ barcodeLink.setBarcodeRegexValidation(/\d+/); Defines a regex to validate barcodes. Only matching barcodes are processed. By default no validation is applied. +:::warning +Don't add flags such as `i`, `g` or `u` to the regex. Barcode Link removes only the first and last character of the regex, so `/abc/i` becomes the pattern `abc/` and valid barcodes no longer match. For case-insensitive matching, list both cases in the pattern, for example `/^[A-Za-z0-9]+$/`. Patterns that need the `u` flag, such as `\p{L}`, don't work. +::: + #### `setBarcodeTransformations(barcodeTransformations: unknown): BarcodeLink` ```ts @@ -167,13 +187,13 @@ Sets barcode transformation logic. Only used when `platform` is `BarcodeLinkPlat ```ts barcodeLink.setSymbologies({ - ean13upca: { + [BarcodeLinkSymbology.EAN13UPCA]: { enabled: true, }, }); ``` -Enables specific symbologies for scanning. +Enables specific symbologies for scanning. Use the `BarcodeLinkSymbology` constants as keys. They hold the exact key strings Barcode Link expects, such as `ean13Upca`. **[See all supported symbologies](https://docs.scandit.com/barcode-symbologies/)** @@ -216,7 +236,7 @@ barcodeLink.addListener({ ``` Called when the remote device sends barcodes. -- `finished`: Indicates if scanning has finished (used in continuous modes). +- `finished`: `true` when the scanning session on the remote device has ended. Check it in every mode to know when to clean up. ##### `onConnectionStateChanged` @@ -230,7 +250,7 @@ barcodeLink.addListener({ }); ``` -Tracks connection state changes. Only available in `BarcodeLinkUilessFlow`. +Tracks connection state changes. Only available in `BarcodeLinkHeadlessFlow`. **Available connection states:** @@ -252,7 +272,7 @@ Removes a previously added listener. ### Initialization -#### `initialize(flow: BarcodeLinkFlow): Promise` +#### `initialize(flow: BarcodeLinkFlow): Promise` ```ts await barcodeLink.initialize(new BarcodeLinkUiFlow()); @@ -267,7 +287,7 @@ Initializes Barcode Link using a specific flow. - Initializes with a pre-built UI. - Shows a QR code for smartphone connection. -##### `BarcodeLinkUilessFlow` +##### `BarcodeLinkHeadlessFlow` - Initializes a headless session. - Requires custom UI. @@ -276,7 +296,9 @@ Initializes Barcode Link using a specific flow. Example: ```ts -const qrcode = await barcodeLink.initialize(new BarcodeLinkUilessFlow()); +import { BarcodeLinkHeadlessFlow } from "@scandit/web-barcode-link"; + +const qrcode = await barcodeLink.initialize(new BarcodeLinkHeadlessFlow()); const img = document.createElement("img"); img.src = qrcode.src; @@ -293,7 +315,7 @@ document.body.append(a); #### `dispose(): void` ```ts -await barcodeLink.dispose(); +barcodeLink.dispose(); ``` Closes the Barcode Link session, useful when unmounting components or ending a session manually. diff --git a/versioned_docs/version-7.6.15/hosted/express/configuration/index.md b/versioned_docs/version-7.6.15/hosted/express/configuration/index.md index 074de3b954..da8135f730 100644 --- a/versioned_docs/version-7.6.15/hosted/express/configuration/index.md +++ b/versioned_docs/version-7.6.15/hosted/express/configuration/index.md @@ -44,27 +44,25 @@ You can configure Scandit Express to inject additional keystrokes after a barcod ### Scanning Options -Scandit Express supports different scanning options to optimize the scanning experience for different use cases. There are two options available by default: Accuracy and Speed. Two additional options, Batch and List, are available if you have purchased MatrixScan. +Scandit Express has two scanning modes: Single and Batch. You can also turn on list building to collect your scans in a list. -#### Accuracy +#### Single -Use this mode to select one barcode out of many. This mode detects all barcodes available, then gives visual feedback on the screen (an augmented-reality overlay) so the user can select the target barcode. This mode scans one barcode at a time. +Use Single mode to scan one barcode at a time. Point the camera at a barcode and Scandit Express scans it. If several barcodes are close together, choose the one you want. -#### Speed - -Use this mode to scan barcodes consecutively at high speed. This mode scans successive items at high speed without the need to keep tapping on the screen. - -Speed Mode +Single mode, also called Smart Scan Selection, is available from Scandit Express 4.3.0 on iOS and 4.4.0 on Android. It replaces the Accuracy and Speed modes of earlier versions. #### Batch -Use this mode to scan a batch of barcodes all at once. This mode scans all visible barcodes instantly. It’s perfect when all barcodes are visible and the volume is high. +Use Batch mode to scan all visible barcodes at once, for example when you have many barcodes in view. + +To use Batch mode, you need a MatrixScan license and list building turned on. Batch Mode -#### List +#### List Building -The list mode icon allows the user to see the list of barcodes that have been scanned. List mode, when activated, works for barcodes scanned in any mode (basic speed scanning, accuracy, and batch). +List building collects your scans in a list. You check the list, and then Scandit Express types the barcodes into the field. List building works in Single and Batch mode. It doesn't need a MatrixScan license, but Batch mode does. ### Activate via Hardware Button diff --git a/versioned_docs/version-7.6.15/hosted/express/configuration/scan-labels.md b/versioned_docs/version-7.6.15/hosted/express/configuration/scan-labels.md index 746356bf1d..5c1bbd24c9 100644 --- a/versioned_docs/version-7.6.15/hosted/express/configuration/scan-labels.md +++ b/versioned_docs/version-7.6.15/hosted/express/configuration/scan-labels.md @@ -27,11 +27,11 @@ Label scanning can be enabled and configured in your [Scandit Dashboard](https:/ Label Scanning

-Once enabled, you can select from a the following pre-defined label types, and the respective fields will be automatically detected when scanning: +Once enabled, you can select from the following predefined label types, and the respective fields will be automatically detected when scanning: -* **Smart Device**: Captures the UPC/EAN, IMEI1 and IMEI2, and Serial Number from mobile device labels. -* **Price Weight**: This factory method is designed for price checking scenarios where both barcode and price text need to be captured from product labels. Returns `SKU` and `priceText` fields. -* **VIN**: Captures the Vehicle Identification Number (VIN) from vehicle labels. +* **Smart Device Label**: Captures the UPC/EAN, IMEI1 and IMEI2, and Serial Number from mobile device labels. +* **Price Label**: Captures the product barcode and the printed price from price labels. +* **VIN Label**: Captures the Vehicle Identification Number (VIN) from vehicle labels. :::tip If you need to customize the behavior of the Smart Label Capture feature, please contact [Scandit Support](mailto:support@scandit.com). diff --git a/versioned_docs/version-7.6.15/hosted/express/overview.md b/versioned_docs/version-7.6.15/hosted/express/overview.md index 4633c32ed9..66735374d6 100644 --- a/versioned_docs/version-7.6.15/hosted/express/overview.md +++ b/versioned_docs/version-7.6.15/hosted/express/overview.md @@ -28,15 +28,16 @@ The Scandit Express user interface (UI) is designed to resemble a smartphone cam ![Scandit Express](/img/express/express_ui.png) -Depending on the mode selected, the user has a choice of scanning barcodes one by one or batch scanning many codes simultaneously. For batch scanning, users can scan as many barcodes as they want and verify them in a list, before inputting them into the desired field. +You can scan barcodes one at a time or all at once, and collect your scans in a list to check them before they go into the field. ### Scanning Modes -Scandit Express offers multiple scanning modes: +Scandit Express offers two scanning modes: -* **Accuracy**: Scans one barcode out of many in the camera’s field of view. It detects all barcodes available and provides an AR overlay to help the user select one target barcode. -* **Speed**: Scans multiple barcodes in quick succession. It removes the need to tap the screen repeatedly. -* **Batch**: Scans all visible barcodes and stores them in a list. +* **Single**: Point the camera at a barcode to scan it. If several barcodes are close together, choose the one you want. Single mode, also called Smart Scan Selection, is available from Scandit Express 4.3.0 on iOS and 4.4.0 on Android. It replaces the earlier Accuracy and Speed modes. +* **Batch**: Scan all visible barcodes at once. To use Batch mode, you need a MatrixScan license and list building turned on. + +With list building, your scans go into a list. You check the list, and then Scandit Express types the barcodes into the field. List building works in both modes. It doesn't need a MatrixScan license, but Batch mode does. ## Security and Compliance