diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index b563c8d..6248842 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -5,10 +5,10 @@ name: CI BBS # Controls when the workflow will run on: # Triggers the workflow on push events but only for the master branch - # push: - # branches: - # - main - #- preview + push: + branches: + - main + - preview # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -24,10 +24,10 @@ jobs: doc-url: batch-barcode-scanner/docs secrets: inherit - # Build-Preview: - # if: ${{ github.ref == 'refs/heads/preview' }} - # uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview - # with: - # doc-repo: batch-barcode-scanner-docs - # doc-url: batch-barcode-scanner/docs - # secrets: inherit + Build-Preview: + if: ${{ github.ref == 'refs/heads/preview' }} + uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview + with: + doc-repo: batch-barcode-scanner-docs + doc-url: batch-barcode-scanner/docs + secrets: inherit diff --git a/.gitignore b/.gitignore index 5cde66b..9d98baa 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,54 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. -.DS_Store -/.vs +# dependencies +/node_modules +.vs + +# Layout templates +_layouts/** +!_layouts/default-layout-OLD.html +!_layouts/home-page.html +!_layouts/search-page-OLD.html + +# Assets +assets/css/ +assets/font-face/ +assets/img-icon/ +assets/js/** +!assets/js/setLatestVersion.js +!assets/js/urlRewrite.js +assets/scripts/ + +# Includes +_includes/productNav/ +_includes/auto-version-list.html +_includes/head.html +_includes/liquid_autoGenerateHistoryList.html +_includes/liquid_breadcrumb.html +_includes/liquid_generateFullTree.html +_includes/liquid_searchVersionTreeFile.html +_includes/livehelp.html +_includes/main-page-head.html +_includes/page_footer.html +_includes/page_header.html +_includes/productNav_OLD.html +_includes/productNav.html +_includes/search-input.html +_includes/trialLicense.html + +# Plugins +_plugins/ + +# Site resources +_site/ + +sitemap.xml +Hide_Tree_Page.md +Gemfile.lock +Gemfile + +# Local development workspace +.dev/ +.bundle/ +.jekyll-cache/ +.sass-cache/ diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..f7908fb --- /dev/null +++ b/FAQ.md @@ -0,0 +1,23 @@ +--- +layout: default-layout +title: FAQ +keywords: FAQ +breadcrumbText: FAQ +description: FAQ of Dynamsoft Batch Barcode Scanner +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# FAQ + + +* What platforms does Batch Barcode Scanner support? + + The core library is written C++. It can run on mobile/desktop/web. Please contact us if you are interested. + +* Will there be an SDK version? + + Currently, we only provide apps. An SDK version is not planned for now. + + diff --git a/_config.yml b/_config.yml index 25941bc..1df9216 100644 --- a/_config.yml +++ b/_config.yml @@ -1,3 +1,4 @@ +title: Dynamsoft Batch Barcode Scanner Documentation repositoryUrl: https://github.com/dynamsoft-docs/batch-barcode-scanner-docs/blob/main repository: dynamsoft-docs/batch-barcode-scanner-docs docFullPath: https://www.dynamsoft.com/batch-barcode-scanner/docs/ @@ -7,6 +8,7 @@ searchIndexName: Crawler-BBS-Docs searchNeedFilter: false bbs_core: /batch-barcode-scanner/docs/ +bbs_app: /batch-barcode-scanner/docs/app/ bbs_parameters: /batch-barcode-scanner/docs/parameters/ bbs_release_notes: /batch-barcode-scanner/ bbs_license_activation: /batch-barcode-scanner/docs/ @@ -35,3 +37,7 @@ plugins: - jekyll-seo-tag url: "https://www.dynamsoft.com" # sitemap root +relative_links: + enabled: true + collections: true + diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html index bcff8ce..0f45b3a 100644 --- a/_includes/sidelist-full-tree.html +++ b/_includes/sidelist-full-tree.html @@ -1,23 +1,14 @@
  • Introduction
    • -
  • DEVELOPMENT
    • -
  • Mobile +
  • App Guide
    • -
  • Understanding BBS
  • Parameters
    • +
  • Release Notes + +
    • +
  • FAQ
    • + + diff --git a/app/guide/customization.md b/app/guide/customization.md new file mode 100644 index 0000000..458dc6c --- /dev/null +++ b/app/guide/customization.md @@ -0,0 +1,59 @@ +--- +layout: default-layout +title: Customization +keywords: Customization +breadcrumbText: Customization +description: This demostrates how to get your scanner customized. +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# Get Your Scanner Customized + +The scanning experience in **Dynamsoft Batch Barcode Scanner** is fully customizable. Open the settings page, you can configure it in the following aspects: + +* Camera +* Scanning +* Barcode Reading + +Settings screenshots: + +![Settings 1](/assets/images/guide/settings-1.jpg){:width="215"} ![Settings 2](/assets/images/guide/settings-2.jpg){:width="215"} + +## Camera + +| Settings | Description | +| --------- | ----------- | +| Resolution | The resolution of the camera preview. | +| Camera Type | Available for iOS, where you can select whether to use AR or the default camera with [Dynamsoft Camera Enhancer](https://www.dynamsoft.com/camera-enhancer/overview/) (DCE). Using AR has a smoother tracking experience, but may have trouble scanning close objects or multi-plane objects.| + +## Scanning + +| Settings | Description | +| --------- | ----------- | +| Scan Setting Name | The name of the scanning setting, which is used in the JSON template. | +| Scan Region | Specifies the scan region. | +| Stitch Level | Specifies how much effort to spend on stitching the images. | +| Auto Stop | Whether to stop scanning automatically when certain conditions are reached, like barcode count. | +| Layout | Specifies what layout analysis to enable. When enabled, it can highlight potential unrecognized barcodes based on layout. For example, a 20x20 grid. It is disabled by default. | + + +## Barcode Reading + +| Settings | Description | +| --------- | ----------- | +| Barcode Setting Name | The name of the barcode reading setting, which is used in the JSON template. | +| Barcode Colour Options | Configure this to read inverted barcodes. | +| Barcode Decode Level | Preset templates to control how much effort to spend on decoding barcodes. | +| Barcode Formats | Specifies what formats of barcode to read and output. | +| Has Duplicate Barcodes | If disabled, it only outputs one of the many duplicate barcodes, which is suitable if one object has many barcodes with the same value. It is enabled by default. | +| Min Localized Barcode Confidence | The minimum confidence level of the localized barcode. If the value is lower than 100, it will draw barcodes which haven't been recognized but localized on the result image in red. The default value is 100. | + +## Import and Export + +You can import and export the settings in JSON. The JSON template has more options and the settings specified with the UI has higher priority. + +You can [contact support](mailto:support@dynamsoft.com) to specify the default template for your account. + +Read the [parameters](/parameters/index.md) page to learn more about the JSON templates. diff --git a/app/guide/extra-features.md b/app/guide/extra-features.md new file mode 100644 index 0000000..0ef9f23 --- /dev/null +++ b/app/guide/extra-features.md @@ -0,0 +1,25 @@ +--- +layout: default-layout +title: Extra Features +description: Extra features Dynamsoft Batch Barcode Scanner +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + + +# Extra Features + +There are extra features for different use cases. + +## Wanted Barcodes + +Currently, the main extra feature is to specify wanted barcodes. + +In the live scanning interface, you can specify barcodes via manual input, selecting decoded barcodes on an image, etc. + +![setting wanted](/assets/images/guide/setting-wanted.jpg){:width="215"} + +In the scanning result, the wanted barcodes will be marked in purple. + +![found wanted](/assets/images/guide/found-wanted.jpg){:width="215"} diff --git a/app/guide/first-scan.md b/app/guide/first-scan.md new file mode 100644 index 0000000..502fb84 --- /dev/null +++ b/app/guide/first-scan.md @@ -0,0 +1,76 @@ +--- +layout: default-layout +title: Start Your First Scan +keywords: guide, first scan +breadcrumbText: Start Your First Scan +description: This page introduces how to perform a basic batch barcode scan. +needAutoGenerateSidebar: false +needGenerateH3Content: false +noTitleIndex: true +--- + +# Start Your First Scan + +Follow these steps to perform a basic batch barcode scan. We are using screenshots on Android for illustration. The iOS version's usage is similar. + +1. Open your app and you will see the following page. + + ![home](/assets/images/guide/home.jpg){:width="215"} + +2. Enter Field of View (FOV) scanning mode, press the shutter button to capture a photo and start scanning. The app will show the decoding result from the captured photo. Press "Retake" to scan more barcodes. + + ![fov start](/assets/images/guide/fov-start.jpg){:width="215"} ![fov initial result](/assets/images/guide/fov-initial-decoding-result.jpg){:width="215"} + +3. After pressing "Retake", the app will reenter the live capturing interface, with the previous decoding result displayed in the bottom‑left corner. + + ![fov live](/assets/images/guide/fov-live.jpg){:width="215"} + + Barcodes will be highlighted in different colors: + + * Already recognized: green. + * Newly recognized: light blue. + +4. Press the shutter button again. The app will take another photo and try decoding. The recognized barcodes (from the photo as well as camera frames) will be drawn on this last captured photo. + + ![fov second decoding result](/assets/images/guide/fov-second-decoding-result.jpg){:width="215"} + +5. Press "Done" to enter the result viewing page. You can view the whole image with recognized barcodes, verify the result and save the result. + + ![fov result](/assets/images/guide/fov-result.jpg){:width="215"} + + + There are many export options: + + * Save to local folder + * Save to OneDrive + * Share to third-party apps + + It saves the whole image and a CSV of barcode results. + +> [!NOTE] +> The export feature requires login. + +## Icon Reference + +| Icon | Description | +| --------- | ----------- | +| ![auto capture](/assets/images/guide/icon/auto_capture.svg) | Auto capture at fixed interval. | +| ![wanted](/assets/images/guide/icon/wanted.svg) | Set wanted barcodes. | +| ![flashlight](/assets/images/guide/icon/flashlight.svg){:height="23"}{:width="24"} | Toggle flashlight. | +| ![beep](/assets/images/guide/icon/beep.svg) | Beep after successful scanning. | +| ![vibrate](/assets/images/guide/icon/vibrate.svg) | Vibrate after successful scanning. | +| ![settings](/assets/images/guide/icon/settings.svg) | Go to settings page. | +| ![add](/assets/images/guide/icon/add.svg) | Import images and barcodes. | +| ![refresh](/assets/images/guide/icon/refresh.svg) | Start a new scanning. | +| ![capture](/assets/images/guide/icon/capture.svg) | Capture a photo for decoding. | +| ![download](/assets/images/guide/icon/download.svg) | Save the scanning result. | +| ![results](/assets/images/guide/icon/results.svg) | Go to the result page. | + + + +## More Scanning Modes + +Continue reading to learn other advanced scanning modes: [Three Scanning Modes](/app/guide/three-scanning-modes.md). + + + diff --git a/app/guide/three-scanning-modes.md b/app/guide/three-scanning-modes.md new file mode 100644 index 0000000..0f5b05f --- /dev/null +++ b/app/guide/three-scanning-modes.md @@ -0,0 +1,61 @@ +--- +layout: default-layout +title: Three Scanning Modes +keywords: guide, scanning mode +breadcrumbText: Three Scanning Modes +description: This page introduces how to perform a basic batch barcode scan. +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# Three Scanning Modes + +The app provides three core scanning modes, each tailored for different workflows: + +- **Field of View (FOV) Scan Mode (Default)** + + Results are drawn on the final captured photo. The app highlights all successfully decoded barcodes directly on that image – perfect for post-scan verification. + +- **Snap & Scan Mode** + + An improved version where a reference photo is taken beforehand. During the scanning process, only barcodes that exist within the pre-captured image are highlighted. Any codes appearing outside the original frame are ignored – ideal for fixed‑area inventory tracking. + +- **Panorama Scan Mode** + + A more advanced mode which stitches multiple photos into a single composite image. Best for codes extending beyond a single camera frame. + +We've introduced the usage of the FOV Mode in [introduction](/introduction.md). Let's learn how to use the two extra modes. + +> [!NOTE] +> The Snap & Scan and Panorama modes require login. + +## Snap & Scan + +When using the Snap & Scan mode, you need to capture a photo of all the barcodes first and there should be some barcodes recognized in this photo. + +Then, it works just like the FOV mode, except barcodes outside the photo taken will not be highlighted and the current field of view will be highlighted in the photo taken. + +![snap-and-scan](/assets/images/guide/snap-and-scan.jpg){:width="215"} + +Demo video: + + + +## Panorama + +When using the Panorama mode, you can take photos continuously to stitch images so that you can get a whole image of all the barcodes, which the default field of view cannot contain. + +![panorama](/assets/images/guide/panorama.jpg){:width="215"} + +There are some requirements for the Panorama mode: + +1. The barcodes have to be close to each other. +2. There should be some duplicate recognition results of each photo. Otherwise, it cannot stitch the photos accurately. + +Demo video: + + + + +Read on to learn about more customization options: [Customization](/app/guide/customization.md). \ No newline at end of file diff --git a/ios/guide/trouble-shooting.md b/app/guide/troubleshooting.md similarity index 82% rename from ios/guide/trouble-shooting.md rename to app/guide/troubleshooting.md index 90f87db..15c71e6 100644 --- a/ios/guide/trouble-shooting.md +++ b/app/guide/troubleshooting.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: Troubleshooting - Dynamsoft Batch Barcode Scanner iOS Documents +title: Troubleshooting keywords: Troubleshooting, Errors breadcrumbText: Troubleshooting description: This page guide you on troubleshooting issues when using the Dynamsoft Batch Barcode Scanner APP. @@ -33,21 +33,20 @@ Please contact us directly and include the error code. When reporting performance problems or crashes, please provide the following: - A **screen recording** that reproduces the issue. - > Tip: Enable **Settings → More Settings → Debug Mode Settings → Display Memory Debug Info** during recording for more detail. + > Tip: Enable **Settings → Debug → Display Memory Debug Info** during recording for more detail. - Screenshots or a screen recording of the **current settings**. - **Debug images** captured during scanning. - **Device information** (model, OS version, available storage, etc.). ### Capturing Original Images -1. Go to **Settings → More Settings → Debug Mode Settings** and enable **`Save Original Images`**. +1. Go to **Settings → Debug** and enable **`Save Original Images`**. 2. Return to the scan page and perform a typical scan. 3. After scanning, the original images are saved to your photo album. Copy them to your desktop. 4. Compress (ZIP) the images and share the file with Dynamsoft. -
    - -
    +![Settings](/assets/images/guide/settings-2.jpg){:width="215"} + If requested, you may also need to provide: diff --git a/app/release-notes/android.md b/app/release-notes/android.md new file mode 100644 index 0000000..b451358 --- /dev/null +++ b/app/release-notes/android.md @@ -0,0 +1,16 @@ +--- +layout: default-layout +title: Release Notes of Android App +keywords: Release Notes, Android +breadcrumbText: Release Notes of Android App +description: Release Notes of Dynamsoft Batch Barcode Scanner Android App +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# Android Release Notes + +## 3.0.0 (05/20/2026) + +Initial Android version. diff --git a/app/release-notes/ios.md b/app/release-notes/ios.md new file mode 100644 index 0000000..7f154df --- /dev/null +++ b/app/release-notes/ios.md @@ -0,0 +1,20 @@ +--- +layout: default-layout +title: Release Notes of iOS App +keywords: Release Notes, iOS +breadcrumbText: Release Notes of iOS App +description: Release Notes of Dynamsoft Batch Barcode Scanner Android App +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# iOS Release Notes + +## 3.0.0 coming soon + +A brand new iOS version comes with three scanning modes. + +## 2.x + +iOS app with panorama scanning ability diff --git a/assets/images/guide/found-wanted.jpg b/assets/images/guide/found-wanted.jpg new file mode 100644 index 0000000..8bdee4d Binary files /dev/null and b/assets/images/guide/found-wanted.jpg differ diff --git a/assets/images/guide/fov-initial-decoding-result.jpg b/assets/images/guide/fov-initial-decoding-result.jpg new file mode 100644 index 0000000..2631188 Binary files /dev/null and b/assets/images/guide/fov-initial-decoding-result.jpg differ diff --git a/assets/images/guide/fov-live.jpg b/assets/images/guide/fov-live.jpg new file mode 100644 index 0000000..6151a62 Binary files /dev/null and b/assets/images/guide/fov-live.jpg differ diff --git a/assets/images/guide/fov-result.jpg b/assets/images/guide/fov-result.jpg new file mode 100644 index 0000000..bb368d4 Binary files /dev/null and b/assets/images/guide/fov-result.jpg differ diff --git a/assets/images/guide/fov-second-decoding-result.jpg b/assets/images/guide/fov-second-decoding-result.jpg new file mode 100644 index 0000000..07ebadb Binary files /dev/null and b/assets/images/guide/fov-second-decoding-result.jpg differ diff --git a/assets/images/guide/fov-start.jpg b/assets/images/guide/fov-start.jpg new file mode 100644 index 0000000..2980adb Binary files /dev/null and b/assets/images/guide/fov-start.jpg differ diff --git a/assets/images/guide/home.jpg b/assets/images/guide/home.jpg new file mode 100644 index 0000000..dea0c99 Binary files /dev/null and b/assets/images/guide/home.jpg differ diff --git a/assets/images/guide/icon/add.svg b/assets/images/guide/icon/add.svg new file mode 100644 index 0000000..ec2b3ab --- /dev/null +++ b/assets/images/guide/icon/add.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/auto_capture.svg b/assets/images/guide/icon/auto_capture.svg new file mode 100644 index 0000000..cd9963d --- /dev/null +++ b/assets/images/guide/icon/auto_capture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/beep.svg b/assets/images/guide/icon/beep.svg new file mode 100644 index 0000000..10a4023 --- /dev/null +++ b/assets/images/guide/icon/beep.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/capture.svg b/assets/images/guide/icon/capture.svg new file mode 100644 index 0000000..f9cc349 --- /dev/null +++ b/assets/images/guide/icon/capture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/download.svg b/assets/images/guide/icon/download.svg new file mode 100644 index 0000000..7a2842c --- /dev/null +++ b/assets/images/guide/icon/download.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/flashlight.svg b/assets/images/guide/icon/flashlight.svg new file mode 100644 index 0000000..f2194ae --- /dev/null +++ b/assets/images/guide/icon/flashlight.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/refresh.svg b/assets/images/guide/icon/refresh.svg new file mode 100644 index 0000000..4354411 --- /dev/null +++ b/assets/images/guide/icon/refresh.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/results.svg b/assets/images/guide/icon/results.svg new file mode 100644 index 0000000..4f7f372 --- /dev/null +++ b/assets/images/guide/icon/results.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/settings.svg b/assets/images/guide/icon/settings.svg new file mode 100644 index 0000000..d0d0e98 --- /dev/null +++ b/assets/images/guide/icon/settings.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/vibrate.svg b/assets/images/guide/icon/vibrate.svg new file mode 100644 index 0000000..3fdbd1c --- /dev/null +++ b/assets/images/guide/icon/vibrate.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/icon/wanted.svg b/assets/images/guide/icon/wanted.svg new file mode 100644 index 0000000..5d6af28 --- /dev/null +++ b/assets/images/guide/icon/wanted.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/images/guide/panorama.jpg b/assets/images/guide/panorama.jpg new file mode 100644 index 0000000..c51d6bb Binary files /dev/null and b/assets/images/guide/panorama.jpg differ diff --git a/assets/images/guide/setting-wanted.jpg b/assets/images/guide/setting-wanted.jpg new file mode 100644 index 0000000..52a3a94 Binary files /dev/null and b/assets/images/guide/setting-wanted.jpg differ diff --git a/assets/images/guide/settings-1.jpg b/assets/images/guide/settings-1.jpg new file mode 100644 index 0000000..d10206f Binary files /dev/null and b/assets/images/guide/settings-1.jpg differ diff --git a/assets/images/guide/settings-2.jpg b/assets/images/guide/settings-2.jpg new file mode 100644 index 0000000..a9b63c6 Binary files /dev/null and b/assets/images/guide/settings-2.jpg differ diff --git a/assets/images/guide/snap-and-scan.jpg b/assets/images/guide/snap-and-scan.jpg new file mode 100644 index 0000000..ee88d0b Binary files /dev/null and b/assets/images/guide/snap-and-scan.jpg differ diff --git a/assets/images/introduction/barcodes-in-colors.jpg b/assets/images/introduction/barcodes-in-colors.jpg new file mode 100644 index 0000000..41c9aaa Binary files /dev/null and b/assets/images/introduction/barcodes-in-colors.jpg differ diff --git a/assets/images/introduction/completed.jpg b/assets/images/introduction/completed.jpg new file mode 100644 index 0000000..07ebadb Binary files /dev/null and b/assets/images/introduction/completed.jpg differ diff --git a/assets/images/introduction/one-time-decoding.jpg b/assets/images/introduction/one-time-decoding.jpg new file mode 100644 index 0000000..0cc1357 Binary files /dev/null and b/assets/images/introduction/one-time-decoding.jpg differ diff --git a/assets/images/introduction/photo-taken.jpg b/assets/images/introduction/photo-taken.jpg new file mode 100644 index 0000000..2980adb Binary files /dev/null and b/assets/images/introduction/photo-taken.jpg differ diff --git a/index.md b/index.md index 790698d..2563fc4 100644 --- a/index.md +++ b/index.md @@ -1,8 +1,7 @@ --- layout: home-page -title: BBS index -description: BBS index -keywords: BBS index +title: Index - Dynamsoft Batch Barcode Scanner Documentation +description: Dynamsoft Batch Barcode Scanner Documentation breadcrumbText: HomePage needAutoGenerateSidebar: true needGenerateH3Content: true @@ -12,9 +11,14 @@ noTitleIndex: false # Batch Barcode Scanner - [Introduction](introduction.md) -- Guide - - [Start Your First Scan]({{ site.bbs_ios }}guide/first-scan.html) - - [Get Your Scanner Customized]({{ site.bbs_ios }}guide/customization.html) - - [Operation Manual]({{ site.bbs_ios }}guide/manual.html) - - [Troubleshooting]({{ site.bbs_ios }}guide/trouble-shooting.html) -- [Parameters]({{ site.bbs_parameters }}) +- App Guide + - [Start Your First Scan](/app/guide/first-scan.md) + - [Three Scanning Modes](/app/guide/three-scanning-modes.md) + - [Get Your Scanner Customized](/app/guide/customization.md) + - [Troubleshooting](/app/guide/troubleshooting.md) + - [Extra Features](/app/guide/extra-features.md) +- [Parameters](/parameters/index.md) +- Release Notes + - [iOS App](/app/release-notes/ios.md) + - [Android App](/app/release-notes/android.md) +- [FAQ](FAQ.md) diff --git a/introduction.md b/introduction.md index 5dea4bd..b84306e 100644 --- a/introduction.md +++ b/introduction.md @@ -1,145 +1,93 @@ --- layout: default-layout -title: Introduction - Dynamsoft Batch Barcode Scanner -keywords: BBS, introduction +title: Introduction +keywords: Dynamsoft Batch Barcode Scanner, introduction breadcrumbText: Introduction -description: The introduction of Dynamsoft Batch Barcode Scanner +description: Introduction of Dynamsoft Batch Barcode Scanner needAutoGenerateSidebar: true needGenerateH3Content: true noTitleIndex: true --- -# Dynamsoft Batch Barcode Scanner – Introduction +# Introduction -Dynamsoft Batch Barcode Scanner captures and decodes large groups of barcodes from live video, delivering a read‑rate close to 100 %. +Dynamsoft Batch Barcode Scanner is a cross-platform (Android & iOS) batch barcode scanning application designed for efficiency and accuracy in high-volume scanning scenarios. Unlike traditional scanners that scan barcodes one at a time or using only one camera frame, our app continuously scan barcodes across multiple frames or photos to progressively build a complete picture of all codes in a scene with a great interactive experience. -
    - -

    Batch Barcode Scanner delivers a 100% read‑rate

    -
    +It is suitable for scanning densely placed items like lab tubes or inventory boxes. Using Batch Barcode Scanner, you can improve your barcode scanning workflow in the following aspects: -With Batch Barcode Scanner, you get: +* Boost worker productivity with high scanning efficiency +* Reduce human errors with visual feedback +* Handle challenging conditions with 100% read rate -1. **Guaranteed coverage** – Achieve a 100 % read rate, even with numerous barcodes. -2. **Live feedback** – Monitor in real time which barcodes have been read and which remain on a constantly expanding panoramic image. -3. **Panoramic recovery** – Recover missed codes by reviewing the marked barcodes on the consolidated panoramic image. +Demo video: -## 1. Key Features + -Batch Barcode Scanner reaches its high accuracy by combining the following capabilities: -### 1.1. Panoramic Technologies +## How it Works -These technologies combine results from multiple frames to handle wide or multi‑plane scenes and plays a critical role in achieving a 100 % read rate. +* **Multi-frame recognition fusion**: Read barcodes from multiple photos taken and live camera frames until all the barcodes are recognized. +* **Visual feedback**: Highlight barcodes in different colors to help the user know which barcodes are left for scanning: + + * recognized barcodes + * newly recognized barcodes + * unrecognized barcodes + * wanted barcodes + + Batch Barcode Scanner uses a special algorithm based on recognized barcodes and augmented reality (AR) to map previously scanned results to the latest frame. -- Panorama: Stitches the barcodes detected from all captured video frames into a single panoramic image. -- Overlap: Integrates the scan results from the latest frame into the panoramic image. +* **Result image for verification**: Draw recognition results on an image with the scanned objects for post-verification. Image stitching is supported if the camera cannot take one picture to cover all the objects. -
    - -

    Panoramic stitching and result overlapping

    -
    +**Example:** In the following screenshots, the tubes are in bad lighting condition, many of them cannot be recognized in one shot (unrecognized are in blue while recognized are in green). -### 1.2. Camera‑assisted Enhancement +![Photo of tubes in bad lighting condition](/assets/images/introduction/photo-taken.jpg){:width="215"} ![Decoding result of one photo](/assets/images/introduction/one-time-decoding.jpg){:width="215"} -The camera does more than capture images, it also supplies extra sensor data that guides the panoramic algorithm and sharpens overall accuracy. +You can move the phone closer to read more barcodes (newly recognized are in light blue). -- **AR Technology**: Enhances object tracking across large areas and sparsely distributed barcodes. -- **Camera Enhancer**: Provides advanced camera controls for reliable recognition of very small, densely packed codes. +![Barcodes in colors](/assets/images/introduction/barcodes-in-colors.jpg){:width="215"} -### 1.3. Auto-Stop & Layout Analysis +If all the barcodes are recognized, you can finish scanning and export the result. -The scanner accepts flexible auto‑stop conditions, scanning ends automatically once any of them are met. +![Completed](/assets/images/introduction/completed.jpg){:width="215"} -Layout Analysis is one of the conditions. It examines the spatial arrangement of barcodes to confirm when the task is complete and further boosts recognition accuracy. +## Scanning Modes -
    - -

    Layout analysis examples

    -
    +The app provides three core scanning modes, each tailored for different workflows: -### 1.4. Result-based Features +- **Field of View (FOV) Scan Mode (Default)** -The scan results also play a big role in the scanning process. The results are: + Results are drawn on the final captured photo. The app highlights all successfully decoded barcodes directly on that image – perfect for post-scan verification. -- **Previewable**: View the real‑time panoramic image with decoded barcodes highlighted. -- **Customizable**: Decide what to scan and define when scanning should stop. -- **Editable**: Correct values, remove non‑target codes, or add new images for further recognition. -- **Reusable**: Save results as historical data for future reference. +- **Snap & Scan Mode** -
    - -

    Get 100 % read rate by previewing & editing

    -
    + An improved version where a reference photo is taken beforehand. During the scanning process, only barcodes that exist within the pre-captured image are highlighted. Any codes appearing outside the original frame are ignored – ideal for fixed‑area inventory tracking. -## 2. Typical Use Cases +- **Panorama Scan Mode** -### 2.1. Densely Placed Batch Barcodes + A more advanced mode which stitches multiple photos into a single composite image. Best for codes extending beyond a single camera frame. -Inventory checks in manufacturing, retail, and healthcare often involve hundreds of tightly packed labels. +## Extra Features -
    - -
    +- **Wanted Barcode** – Highlight specific barcode values you are looking for, making target identification instant. +- **Export Results** – Save scan data as CSV files, share via email, messaging apps, or cloud storage. +- **Customizable Settings** – Adjust image processing parameters, camera settings, desired barcode formats, colors of barcodes, and more. -Challenges +## System Requirements -1. Item‑by‑item scanning is slow. -2. A single wide‑area scan may still overlook some codes. -3. Scenes often exceed a single camera frame. -4. Operators need confirmation that every barcode is correctly positioned. +The app works for the following systems: -Solution +* iOS or iPadOS 15.0 or newer +* Android 5.0 or newer (arm64-v8a) -1. Decodes many barcodes simultaneously. -2. Supports two modes for wide-area processing: - 1. First-pass: Continuously combines and updates results as new frames arrive. - 2. Sectional: Move closer and scan area by area; all views merge into one final panorama. +## Try Our Demo -### 2.2. Scan Different Planes +You can download the app on app store: -Sometimes, items are arranged so that their barcodes sit on different planes. +* [iOS](https://apps.apple.com/us/app/dynamsoftbatchbarcodescanner/id6751793075) (version 2.1.3) +* [Android](https://play.google.com/store/apps/details?id=com.dynamsoft.bbs.app) (version 3.0.0) -
    - -

    Barcodes on different planes

    -
    +You can also get a custom demo based on your specific use case: [request a demo](https://www.dynamsoft.com/use-cases/batch-barcode-scanning/#request-demo-form). -Challenges +## Next -1. A camera cannot focus on multiple planes simultaneously. -2. Plane‑by‑plane scanning makes the results harder to classify. -3. Determining when to stop scanning one plane and start another can be tricky. - -Solution - -1. Scan each plane individually, either in a single sweep or section by section. -2. Results from every plane are automatically merged into a single panoramic image for easy review and classification. - -### 2.3. Large-scale Item Inventory Check - -
    - -

    Large-scale Item Inventory Check

    -
    - -Challenges - -1. Barcodes become too small to decode when the entire scene is captured at once. -2. Duplicate barcodes in the same area can lead to inaccurate or misleading quantity counts. - -Solution: - -1. Move closer and scan barcodes in smaller segments; the scanner returns a complete set of results when finished. -2. Plane‑projection information records the exact position of each barcode, eliminating duplication issues. - -## 3. System Requirements - -- Supported Device: - - iPhone: iPhone 11 or newer - - iPad: iPad Pro 3rd generation or newer -- Supported OS: iOS 15.0 or later - -## 4. Try Our Demo - -Request a demo via [request demo form](https://www.dynamsoft.com/use-cases/batch-barcode-scanning/#request-demo-form). \ No newline at end of file +Continue to read the [guide](/app/guide/first-scan.md) to learn more about its usage. diff --git a/ios/guide/assets/manual-export.png b/ios/guide/assets/manual-export.png deleted file mode 100644 index 7277518..0000000 Binary files a/ios/guide/assets/manual-export.png and /dev/null differ diff --git a/ios/guide/assets/multi-scenarios.png b/ios/guide/assets/multi-scenarios.png deleted file mode 100644 index bb26cfc..0000000 Binary files a/ios/guide/assets/multi-scenarios.png and /dev/null differ diff --git a/ios/guide/assets/save-original-image.png b/ios/guide/assets/save-original-image.png deleted file mode 100644 index b4970b7..0000000 Binary files a/ios/guide/assets/save-original-image.png and /dev/null differ diff --git a/ios/guide/assets/start.png b/ios/guide/assets/start.png deleted file mode 100644 index 37f0e7d..0000000 Binary files a/ios/guide/assets/start.png and /dev/null differ diff --git a/ios/guide/assets/stop.png b/ios/guide/assets/stop.png deleted file mode 100644 index 73bd158..0000000 Binary files a/ios/guide/assets/stop.png and /dev/null differ diff --git a/ios/guide/customization.md b/ios/guide/customization.md deleted file mode 100644 index 1d8ad4c..0000000 --- a/ios/guide/customization.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -layout: default-layout -title: Customization - Dynamsoft Batch Barcode Scanner iOS Documents -keywords: Customization -breadcrumbText: Customization -description: This demostrates how to get your scanner customized. -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# Get Your Scanner Customized - -The scanning experience in **Dynamsoft Batch Barcode Scanner** is fully customizable. Below are common customization options and instructions on how to provide the necessary materials. - -## 1. Device and Camera - -Choosing the right device and camera configuration delivers a better scanning experience. - -- **AR Camera** - - **Strengths** - - Delivers superior real-time **tracking** of decoded barcodes. - - Maintains high accuracy even when many **duplicate** barcodes are present. - - Produces high-quality panoramic images even in **sparse** barcode layouts. - - Achieves even greater accuracy when **LiDAR** is available. - - **Limitations** - - Restricted to the wide-angle lens, which may not focus at very close range. - - Does not support manual zoom or focus control. - -- **DCE Camera** - - **Strengths** - - Supports close-up scanning of **small barcodes** using the ultra-wide camera. - - Allows flexible **focusing** on different points of interest. - - Use **zoom-in** to approach instead of reducing the scan distance. - - **Limitations** - - Provides less stable tracking compared to the AR Camera. - - Less accurate when counting duplicate barcodes. - - May produce segmented panoramic images when barcodes are sparse. - -| Device Type / Features | iPad Pro | iPhone Pro (Max) | iPhone 13 and newer | iPhone 11, 12 | iPhone SE (16E) | -| ----------- | -------- | ---------------- | ------------------- | ------------- | --------------- | -| **AR Close-Distance Focus** | ✓ | ✕ | ✕ | ✓ | ✓ | -| **AR 3840 × 2160 Resolution** | ✓ | ✓ | ✓ | ✓ | ✕ | -| **LiDAR Support** | ✓ | ✓ | ✕ | ✕ | ✕ | -| **Auto-Switch to Ultra-Wide Camera** | ✕ | ✓ | ✕ | ✕ | ✕ | -| **High-Quality Ultra-Wide Camera** | ✓ | ✓ | ✕ | ✕ | ✕ | - -> **Feature Details** -> -> **AR Close-Distance Focus** -> Enables the AR camera to focus sharply at short range, enhancing detection of small or densely packed barcodes. -> Below is a reference table of the **minimum focus distance** (approximate) for supported devices: -> -> | Device Model | Min Focus Distance | -> |-----------------------------------|---------------------| -> | iPhone 11 | ~12cm | -> | iPhone 11 Pro / Pro Max | ~12cm | -> | iPhone 12 / 12 Mini | ~8 – 12cm | -> | iPhone 12 Pro / 12 Pro Max | ~8cm | -> | iPhone 13 / 13 Mini | ~15cm | -> | iPhone 13 Pro / Pro Max | ~15cm | -> | iPhone 14 / 14 Plus | ~20cm | -> | iPhone 14 Pro / Pro Max | ~20cm | -> | iPhone 15 / 15 Plus | ~20cm | -> | iPhone 15 Pro / Pro Max | ~20cm | -> | iPhone 16e | ~12cm | -> | iPhone 16 / 16 Plus | ~20cm | -> | iPhone 16 Pro | ~24cm | -> | iPad Pro (2021 / 2022 / 2024) | ~5cm | -> -> *Tip:* Actual focusing distance can vary slightly depending on lighting conditions and individual device calibration. -> -> **AR 3840 × 2160 Resolution** -> Enables high-resolution scanning, which captures finer barcode details and increases decoding accuracy—especially for tiny codes. -> -> **LiDAR Support** -> Devices with a built-in LiDAR sensor provide depth information, giving the AR camera more reliable tracking and higher stitching accuracy. -> -> **Auto-Switch to Ultra-Wide Camera** -> Automatically switches from the standard wide-angle lens to the ultra-wide lens when the main camera cannot focus at close range, helping maintain focus without manual intervention. -> -> **High-Quality Ultra-Wide Camera** -> Some devices include an ultra-wide lens with superior optics. Using this lens improves clarity and barcode recognition when you need an extra-wide field of view or close-up focus. - -## 2. Barcode Reading Performance - -Provide **original images** from your own scenarios so we can optimize decoding performance. - -**How to capture original images** - -1. Go to **Settings → More Settings → Debug Mode Settings** and enable **`Save Original Images`**. -2. Return to the scan page and scan as usual. -3. After scanning, the original images are stored in your photo album. Copy them to your desktop. -4. Zip the images and share the file with Dynamsoft. - -
    - -
    - -By default, the app captures images at **4K resolution (3840 × 2160)**. -If your barcodes are large enough and you want faster processing, you may capture **1080p** images instead. - -**(Optional) Capture 1080p images** - -1. Go to **Settings → More Settings → Resolution** and select **1080p**. -2. Repeat the above steps to collect a new set of images. - -> [!NOTE] -> After collecting 1080p samples, remember to switch back to **4K** for normal scanning. - -## 3. Auto-Stop Conditions - -The scanner can stop automatically once specified conditions are met. -Available options include: - -- **Maximum barcode count reached** -- **No more results detected** -- **Layout analysis approved** - -> [!NOTE] -> Contact Dynamsoft if you need different or additional stop conditions. - -## 4. Result Output - -You can customize how scan results are presented: - -- Sort decoded barcodes with custom filter conditions. -- Adjust the highlight style in the panoramic image. -- Define the data fields included in the exported CSV file. - -## 5. Scanner UI - -Interface elements can also be tailored, such as: - -- Toolbar layout and appearance. -- Barcode highlight style on the camera view and the result-preview screen. diff --git a/ios/guide/first-scan.md b/ios/guide/first-scan.md deleted file mode 100644 index fa5fc1c..0000000 --- a/ios/guide/first-scan.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -layout: default-layout -title: Start Your First Scan - Dynamsoft Batch Barcode Scanner iOS Documents -keywords: guide, first scan -breadcrumbText: Start Your First Scan -description: This page introduces how to perform a basic batch barcode scan. -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# Start Your First Scan - -Follow these steps to perform a basic batch barcode scan. - -## 1. Log In - -A valid account is required to use the app. -If your account doesn’t have access to **Dynamsoft Batch Barcode Scanner**, or you don’t yet have an account, you can request one through the [demo request form](https://www.dynamsoft.com/use-cases/batch-barcode-scanning/#request-demo-form). - - -## 2. (Optional) Select a Scenario - -If you have different customized scenarios, they will be displayed on the front page after logging in. After clicking the scenario you want to scan, you will be directed to the working page customized for this scenario. - -If customized scanning scenarios are available for your account, they will appear on the home screen after login. -Tap the desired scenario to open its dedicated scanning workspace. - -
    - -
    - -## 3. Start Scanning - -
    - -
    - -Tap the **`Start`** button to begin scanning. While scanning, you can: - -- Move the device to cover different areas. -- Move closer to any barcode that isn’t recognized. - -
    - -
    - -Tap the **`Stop`** button to pause scanning. When paused, you can: - -- Add images from the album to enhance the current scan results. -- Tap **`Start`** again to resume. - -> [!NOTE] -> The **Add Image** and **Continue** features are not supported when using the AR camera. - - -## 4. Finish Scanning - -When you’re done, you can: - -- **Export** – Save a CSV file of the results and a panoramic image. -- **Save** – Store the current scan results for later viewing in **History**. -- **View History** – Open previously saved results. -- **Reset** – Clear the current session to start a new scan. diff --git a/ios/guide/manual.md b/ios/guide/manual.md deleted file mode 100644 index e0955dd..0000000 --- a/ios/guide/manual.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -layout: default-layout -title: Operating Manual - Dynamsoft Batch Barcode Scanner iOS Documents -keywords: Manual -breadcrumbText: Manual -description: This page is the operating Manual of Dynamsoft Batch Barcode Scanner iOS APP. -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# Operating Manual - -This manual explains all features and settings of the app. - -## Start / Stop & Reset - -
    - -
    - -- **`Start`** – Begin a new scanning task when no result is currently displayed. -- **`Continue`** – Resume scanning when a panoramic image is being previewed. -- **`Stop`** – Pause scanning and preview the generated panoramic image. - -
    - -
    - -To begin a new task, tap `Reset` first. -`Reset` clears the currently displayed `BatchBarcodeScanResult`. - ---- - -## Input - -### Video Stream - -To scan from a live video feed, simply tap `Start` or `Continue`. - -### Image - -
    - -
    - -You can add images in three ways: - -- Capture a new photo. -- Select an image from your photo album. -- Choose a `BatchBarcodeScanResult` from history. - -### Manual Input - -Manually add a barcode by specifying its position, type, and value. - ---- - -## Output - -Each scan generates a `BatchBarcodeScanResult`, which includes: - -- A collection of decoded barcodes. -- A panoramic image. - -### Save - -
    - -
    - -Tap `Save` at any time to store the current `BatchBarcodeScanResult`. -Saving multiple times creates separate copies. - -Saved results can be viewed and edited in **History**. -Only one `BatchBarcodeScanResult` can be previewed at a time. - -### History - -
    - -
    - -- **Preview** – Open and edit a saved result in the workspace. -- **Import** – Merge images and barcodes from a saved result into the current task. -- **Export** – Export data as a .csv or .png file. -- **Manage** – Delete unwanted saved results. - -### Export - -
    - -
    - -A quick access to the export feature. Export images and barcodes as a `.csv` or `.png` file. - ---- - -## Settings - -### Camera and UI Settings - -Settings that define the camera mode and UI behavior. - -#### Camera Type - -Camera Type - -- AR Camera - - Advantages - - Ideal for scenarios with sparse barcodes. - - Provides smooth real-time tracking and visualization of decoded barcodes. - - Offers higher accuracy in panoramic stitching and barcode counting. - - Limitations - - Uses only the wide-angle lens, which cannot focus at close range. - - Manual focus and zoom controls are unavailable. -- DCE (Dynamsoft Camera Enhancer) - - Advantages - - Supports camera selection. You can use the ultra-wide camera for close-up scanning. On Pro Max iPhones, it supports automatic switching between wide and ultra-wide lenses. - - Provides flexible manual focus and zoom control. - - Limitations - - Slightly lower accuracy when duplicate barcodes are present. - -#### Resolution - -Default: **3840 × 2160**. -If barcodes are large enough, switch to **1920 × 1080** to improve processing speed. - -#### Scan Direction - -Specifies the scan direction. It determines how the preview image is displayed. - -- Left → Right -- Right → Left -- Top → Bottom -- Bottom → Top - -#### Scan Region - -Specifies the scan region with a scan region object. It reduces the scan size to improve the speed and the accuracy. - -- Left: Distance between the left edge of the frame and the left edge of the scan region. -- Right: Distance between the left edge of the frame and the right edge of the scan region. -- Top: Distance between the top of the frame and the top edge of the scan region. -- Bottom: Distance between the top of the frame and the bottom edge of the scan region. - -#### Scan Setting Name - -Specify the base `BatchScanSettings` with its name. - -### BatchScanSettings - -Settings that define how the scanner stitches frames and generates panoramic images. - -#### Stitch Level - -Determines the stitching effort and affects the final panoramic image quality. - -#### Has Duplicate Barcodes - -Enables optimization for scenarios where duplicate barcodes appear. - -> [!Note] -> If this option is disabled, the scanner will decode only one copy when multiple identical barcodes are detected. - -#### Barcode Setting Name - -Specify the base `BarcodeSettings` with its name. - -#### Barcode Formats - -Defines which barcode types exist in the scene and which types to output. - -#### Auto Stop - -Specifies conditions for automatically stopping the scan. Multiple modes can be enabled simultaneously — scanning stops when any condition is met. - -- Stop when layout analysis is approved. -- Stop when the maximum barcode count is reached. -- Stop when no new results are detected. - -#### Min Localized Barcode Confidence - -Defines the minimum confidence threshold for localized barcodes. A value of 0 disables filtering; 100 filters out all localized results. - -#### Layout Settings - -Defines layout sections, their analysis modes, and the maximum number of barcodes per section. - -Layout Analysis Modes: - -- Matrix -- Line -- Skip - -### BarcodeSettings - -Controls the barcode decoding parameters. - -#### Decode Level - -Defines the decoding effort level. - -#### Barcode Colour Options - -Specifies whether to read barcodes in the original color, inverted color, or both. - -### Debug Mode Settings - -- Display memory Debug info. -- Save original images. -- Save original images with barcode highlights. -- Save intermediate result images. diff --git a/parameters/batch-scan-settings.md b/parameters/batch-scan-settings.md index 58e7a71..2a226dc 100644 --- a/parameters/batch-scan-settings.md +++ b/parameters/batch-scan-settings.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: BatchScanTemplate - Dynamsoft Batch Barcode Scanner +title: BatchScanTemplate description: The BatchScanTemplate of Dynamsoft Batch Barcode Scanner needAutoGenerateSidebar: true needGenerateH3Content: true @@ -9,6 +9,8 @@ noTitleIndex: false # Batch Scan Settings +The batch scanning settings are available under `BatchScanTemplates`. + ```json { "BatchScanTemplates": [ @@ -119,13 +121,11 @@ noTitleIndex: false | [`DuplicationCorrectionOption`](#duplicationcorrectionoption) | Determines how the algorithm deals with the duplicated barcodes. | | [`EnableOutputFrameMappedResult`](#enableoutputframemappedresult) | Whether to map the result coordinates from panoramic image to the video frame. | | [`EnableOutputPreviewPanorama`](#enableoutputpreviewpanorama) | Whether to enable result preview when scanning. | -| [`EnableOutputResultImage`](#enableoutputresultimage) | Whether to save image data and generate panoramic image in the final result. | | [`MaxOverlappingFrames`](#maxoverlappingframes) | The maximum number of overlapping frames of TTLO mode. | | [`MinLocalizedBarcodeConfidence`](#minlocalizedbarcodeconfidence) | The minimum confidence level of the localized barcodes. | -| [`PanoramicImageScalePercent`](#panoramicimagescalepercent) | Determines the scale down rate of the panoramic image. Measured by percentage. | | [`PerspectiveLevel`](#perspectivelevel) | Determines how much efforts to spend on correcting the perspective. | | [`PreviewImageOption`](#previewimageoption) | Defines how the preview image is output. | -| [`StitchLevel`](#stitchlevel) | Determines the how much effort to spend on stitching the video frames. | +| [`StitchLevel`](#stitchlevel) | Determines how much effort to spend on stitching the video frames. | | [`StitchMode`](#stitchmode) | Determines the stitching mode. | | [`UniqueBarcodeFormatIds`](#uniquebarcodeformatids) | If there exist duplicated barcodes, this option will be used to determine which barcodes are unique. | @@ -420,22 +420,6 @@ int 1 -### EnableOutputResultImage - -Whether to save image data and generate panoramic image in the final result. - -**Type** - -int - -**Range** - -[0,1] - -**Default Value** - -1 - ### MaxOverlappingFrames The maximum number of overlapping frames of TTLO mode. @@ -470,30 +454,6 @@ int 100 - - -### PanoramicImageScalePercent - -Determines the scale down rate of the panoramic image. Measured by percentage. - -**Type** - -int - -**Range** - -[0,100] - -> - 0 means auto. -> - 100 means original size. - -**Default Value** - -0 - ### PerspectiveLevel Determines how much efforts to spend on correcting the perspective. diff --git a/parameters/camera-and-ui-settings.md b/parameters/camera-and-ui-settings.md index 592b003..3e6d1fb 100644 --- a/parameters/camera-and-ui-settings.md +++ b/parameters/camera-and-ui-settings.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: CameraAndUITemplate - Dynamsoft Batch Barcode Scanner +title: CameraAndUITemplate description: The CameraAndUITemplate of Dynamsoft Batch Barcode Scanner needAutoGenerateSidebar: true needGenerateH3Content: true @@ -9,7 +9,7 @@ noTitleIndex: false # Camera and UI Settings -The camera and UI settings are also available under `CameraAndUITemplates` +The camera and UI settings are available under `CameraAndUITemplates`. ```json { @@ -17,7 +17,6 @@ The camera and UI settings are also available under `CameraAndUITemplates` { "Name": "CUT_Default", "CameraType": "CMT_DCE_WIDE_ANGLE", - "ScanUIScenario": "Inventory", "ScanRegion":{ "ScanRegionEnable": 0, "ScanRegionLeft": 0, @@ -25,9 +24,8 @@ The camera and UI settings are also available under `CameraAndUITemplates` "ScanRegionTop": 0, "ScanRegionBottom": 100 }, - "ScanDirection": "SD_LEFT_TO_RIGHT", "Resolution": "RESOLUTION_1080P", - "PanoramaTemplateName": "Panorama" + "BatchScanTemplateName": "BST_Stardard" } ] } @@ -38,10 +36,8 @@ The camera and UI settings are also available under `CameraAndUITemplates` | Parameter | Description | | --------- | ----------- | | [`Name`](#name) | The name of the template. | -| [`CameraType`](#cameratype) | Specifies the camera for batch barcode scanning. It can be a AR camera or a physical camera. | -| [`ScanUIScenario`](#scanuiscenario) | Defines the scan UI by the scenario. | +| [`CameraType`](#cameratype) | Specifies the camera for batch barcode scanning. It can be a AR camera or a physical camera. (Only valid for iOS) | | [`Resolution`](#resolution) | Specifies the resolution of the camera. | -| [`ScanDirection`](#scandirection) | Specifies the scan direction of the camera. It determines how the preview image is displayed. | | [`ScanRegion`](#scanregion) | Specifies the scan region. It reduces the scan size to improve the speed and the accuracy. | | [`BatchScanTemplateName`](#batchscantemplatename) | Specifies the `BatchScanTemplate` object required by this template for batch scanning with its name. | @@ -51,7 +47,7 @@ The name of the template. ### CameraType -Specifies the camera for batch barcode scanning. It can be a AR camera or a physical camera. +Specifies the camera for batch barcode scanning. It can be a AR camera or a physical camera. It is only valid for iOS. - CMT_AR_PLANE_PROJECTION - CMT_AR_FRAME_TRACE @@ -61,13 +57,6 @@ Specifies the camera for batch barcode scanning. It can be a AR camera or a phys DCE Camera: Supports auto-switching between Wide-Angle and Ultra-Wide-Angle camera. -### ScanUIScenario - -Defines the scan UI by the scenario. - -- "Inventory" -- "TargetLookup" - ### Resolution Specifies the resolution of the camera. @@ -75,17 +64,6 @@ Specifies the resolution of the camera. - 3840x2160: Read-Rate first. - 1920x1080: Speed first. -### ScanDirection - -Specifies the scan direction. It determines how the preview image is displayed. - -Available values: - -- "SD_LEFT_TO_RIGHT" -- "SD_RIGHT_TO_LEFT" -- "SD_TOP_TO_BOTTOM" -- "SD_BOTTOM_TO_TOP" - ### ScanRegion Specifies the scan region with a scan region object. It reduces the scan size to improve the speed and the accuracy. diff --git a/parameters/index.md b/parameters/index.md index 753825b..82ee33b 100644 --- a/parameters/index.md +++ b/parameters/index.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: CaptureVisionTemplate - Dynamsoft Batch Barcode Scanner +title: CaptureVisionTemplate description: The CaptureVisionTemplate of Dynamsoft Batch Barcode Scanner needAutoGenerateSidebar: true needGenerateH3Content: true @@ -9,42 +9,13 @@ noTitleIndex: false # BatchBarcodeScanner Parameters -## BatchScanTemplates Parameters +You can learn about the parameters of Batch Barcode Scanner here. Normally you don't need to know the details about the parameters and [contact support](mailto:support@dynamsoft.com) for help. But it helps if you have knowledge about them. -| Parameter | Description | -| --------- | ----------- | -| [`Name`](batch-scan-settings.md#name) | The name of the template. Must be unique. | -| [`CaptureVisionTemplateName`](batch-scan-settings.md#capturevisiontemplatename) | Specifies a name of the `CaptureVisionTemplate`. A `CaptureVisionTemplate` defines how to decode the barcodes. | -| [`BarcodeFormatIds`](batch-scan-settings.md#barcodeformatids) | Defines which formats are output in the final result. | -| [`ResultOutputSettings`](batch-scan-settings.md#resultoutputsettings) | Result output settings. | -| [`SectionLayoutOptions`](batch-scan-settings.md#sectionlayoutoptions) | Defines the layout sections with their layout analysis mode and maximum number of barcodes. | -| [`AutoStopOption`](batch-scan-settings.md#autostopoption) | Definds whether to stop scanning automatically and when to auto-stop. | -| [`ARCorrectionLevel`](batch-scan-settings.md#arcorrectionlevel) | A higher level means the algorithm will spend more efforts on correcting the AR data. | -| [`DuplicationCorrectionOption`](batch-scan-settings.md#duplicationcorrectionoption) | Determines how the algorithm deals with the duplicated barcodes. | -| [`EnableOutputFrameMappedResult`](batch-scan-settings.md#enableoutputframemappedresult) | Whether to map the result coordinates from panoramic image to the video frame. | -| [`EnableOutputPreviewPanorama`](batch-scan-settings.md#enableoutputpreviewpanorama) | Whether to enable result preview when scanning. | -| [`EnableOutputResultImage`](batch-scan-settings.md#enableoutputresultimage) | Whether to save image data and generate panoramic image in the final result. | -| [`MaxOverlappingFrames`](batch-scan-settings.md#maxoverlappingframes) | The maximum number of overlapping frames of TTLO mode. | -| [`MinLocalizedBarcodeConfidence`](batch-scan-settings.md#minlocalizedbarcodeconfidence) | The minimum confidence level of the localized barcodes. | -| [`PanoramicImageScalePercent`](batch-scan-settings.md#panoramicimagescalepercent) | Determines the scale down rate of the panoramic image. Measured by percentage. | -| [`PerspectiveLevel`](batch-scan-settings.md#perspectivelevel) | Determines how much efforts to spend on correcting the perspective. | -| [`PreviewImageOption`](batch-scan-settings.md#previewimageoption) | Defines how the preview image is output. | -| [`StitchLevel`](batch-scan-settings.md#stitchlevel) | Determines the how much effort to spend on stitching the video frames. | -| [`StitchMode`](batch-scan-settings.md#stitchmode) | Determines the stitching mode. | -| [`UniqueBarcodeFormatIds`](batch-scan-settings.md#uniquebarcodeformatids) | If there exist duplicated barcodes, this option will be used to determine which barcodes are unique. | +## Overview of Parameters -## CameraAndUITemplates Parameters +There are three types of parameters for Batch Barcode Scanner. They are defined in JSON templates. Click the links to learn about the parameters in detail. -| Parameter | Description | -| --------- | ----------- | -| [`Name`](camera-and-ui-settings.md#name) | The name of the template. | -| [`CameraType`](camera-and-ui-settings.md#cameratype) | Specifies the camera for batch barcode scanning. It can be a AR camera or a physical camera. | -| [`ScanUIScenario`](camera-and-ui-settings.md#scanuiscenario) | Defines the scan UI by the scenario. | -| [`Resolution`](camera-and-ui-settings.md#resolution) | Specifies the resolution of the camera. | -| [`ScanDirection`](camera-and-ui-settings.md#scandirection) | Specifies the scan direction of the camera. It determines how the preview image is displayed. | -| [`ScanRegion`](camera-and-ui-settings.md#scanregion) | Specifies the scan region. It reduces the scan size to improve the speed and the accuracy. | -| [`BatchScanTemplateName`](camera-and-ui-settings.md#batchscantemplatename) | Specifies the `BatchScanTemplate` object required by this template for batch scanning with its name. | +* [Parameters controlling the camera and UI](./camera-and-ui-settings.md) +* [Parameters controlling the batch scanning process](./batch-scan-settings.md) +* [Parameters controlling the barcode reading process](https://www.dynamsoft.com/barcode-reader/docs/core/parameters/structure-and-interfaces-of-parameters.html){:target="_blank"} -## CaptureVisionTemplates - -View in [Dynamsoft Barcode Reader docs](https://www.dynamsoft.com/barcode-reader/docs/core/parameters/structure-and-interfaces-of-parameters.html){:target="_blank"} diff --git a/scripts/download.sh b/scripts/download.sh new file mode 100644 index 0000000..ec57ec3 --- /dev/null +++ b/scripts/download.sh @@ -0,0 +1,121 @@ +#!/bin/bash + +# Exit on error +set -e + +# Define variables +DOCS_REPO_URL="https://github.com/dynamsoft-docs/batch-barcode-scanner-docs/archive/refs/heads/preview.zip" +TEMPLATE_REPO_URL="https://github.com/dynamsoft-docs/Docs-Template-Repo/archive/refs/heads/preview.zip" +TEMP_DIR="temp_docs" +TEMPLATE_DIR="Docs-Template-Repo-preview" +FINAL_DIR="batch-barcode-scanner-docs-preview" + +echo "=== Starting build script ===" + +# Clean up any existing temporary directories +echo "Cleaning up old directories..." +rm -rf "$TEMP_DIR" "$FINAL_DIR" "$TEMPLATE_DIR" + +# Create temporary directory +echo "Creating temporary directory: $TEMP_DIR" +mkdir -p "$TEMP_DIR" +cd "$TEMP_DIR" + +# Download first repository (batch-barcode-scanner-docs) +echo "Downloading batch-barcode-scanner-docs repository..." +curl -L -o docs.zip "$DOCS_REPO_URL" + +# Extract first repository +echo "Extracting batch-barcode-scanner-docs..." +unzip -q docs.zip + +# Get the extracted directory name (dynamic detection) +DOCS_EXTRACTED_DIR=$(find . -maxdepth 1 -type d -name "batch-barcode-scanner-docs-*" | head -1 | sed 's|^\./||') +echo "Detected docs directory: $DOCS_EXTRACTED_DIR" + +if [ -z "$DOCS_EXTRACTED_DIR" ]; then + echo "Error: Unable to find extracted docs directory" + exit 1 +fi + +# Create final directory and copy docs content into it +echo "Creating final directory and copying docs content..." +mkdir -p "../$FINAL_DIR" +cp -rf "$DOCS_EXTRACTED_DIR"/* "../$FINAL_DIR"/ 2>/dev/null || true + +# Go back to parent directory +cd .. + +# Download second repository (Docs-Template-Repo) +echo "Downloading Docs-Template-Repo repository..." +curl -L -o template.zip "$TEMPLATE_REPO_URL" + +# Extract second repository +echo "Extracting Docs-Template-Repo..." +unzip -q template.zip + +# Get the template extracted directory name +TEMPLATE_EXTRACTED_DIR=$(find . -maxdepth 1 -type d -name "Docs-Template-Repo-*" | head -1 | sed 's|^\./||') +echo "Detected template directory: $TEMPLATE_EXTRACTED_DIR" + +if [ -z "$TEMPLATE_EXTRACTED_DIR" ]; then + echo "Error: Unable to find extracted template directory" + exit 1 +fi + +# Rename template directory to standard name +if [ "$TEMPLATE_EXTRACTED_DIR" != "$TEMPLATE_DIR" ]; then + echo "Renaming $TEMPLATE_EXTRACTED_DIR to $TEMPLATE_DIR" + mv "$TEMPLATE_EXTRACTED_DIR" "$TEMPLATE_DIR" +fi + +# Ensure final directory exists +if [ ! -d "$FINAL_DIR" ]; then + echo "Error: Final directory $FINAL_DIR does not exist" + exit 1 +fi + +# Overwrite operation: Copy template repository contents to final directory (overwrite) +echo "Performing overwrite operation..." +cp -rf "$TEMPLATE_DIR"/* "$FINAL_DIR"/ 2>/dev/null || echo "Warning: Some files may not have been copied during the process, but execution can continue" + +# Enter final directory +cd "$FINAL_DIR" + +# Display current directory +echo "Current working directory: $(pwd)" +echo "Final directory contents:" +ls -la + +# Replace strings in all files under _includes directory +echo "Replacing assetsPath in _includes directory..." +if [ -d "_includes" ]; then + find _includes -type f -exec sed -i.bak "s|assetsPath = '/webres/wwwroot'|assetsPath = 'https://www.dynamsoft.com/webres/wwwroot'|g" {} \; + find _includes -name "*.bak" -type f -delete + echo "_includes directory processing completed" +else + echo "Warning: _includes directory does not exist" +fi + +# Replace strings in all files under _layouts directory +echo "Replacing assetsPath in _layouts directory..." +if [ -d "_layouts" ]; then + find _layouts -type f -exec sed -i.bak "s|assetsPath = '/webres/wwwroot'|assetsPath = 'https://www.dynamsoft.com/webres/wwwroot'|g" {} \; + find _layouts -name "*.bak" -type f -delete + echo "_layouts directory processing completed" +else + echo "Warning: _layouts directory does not exist" +fi + +# Go back to parent directory +cd .. + +# Clean up temporary files +echo "Cleaning up temporary files..." +rm -f template.zip +rm -rf "$TEMP_DIR" "$TEMPLATE_DIR" + +echo "=== Build completed ===" +echo "Final directory: $FINAL_DIR" +echo "Final directory contents:" +ls -la "$FINAL_DIR" diff --git a/search.md b/search.md index 0ce6a79..50d2760 100644 --- a/search.md +++ b/search.md @@ -1,6 +1,6 @@ --- layout: search-layout -title: Batch Barcode Scanner Mobile Edition Documentation Search +title: Search keywords: Batch Barcode Scanner Mobile Edition Documentation Search h1: Batch Barcode Scanner Mobile Edition Documentation Search breadcrumbText: HomePage