Skip to content

Commit 91a90eb

Browse files
committed
add readme for new samples
1 parent 65edc46 commit 91a90eb

File tree

7 files changed

+112
-4
lines changed

7 files changed

+112
-4
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ Get the basic features working with plain/native JavaScript or within a framewor
4747

4848
* [**Scan Single Barcode**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/hello-world.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-single-barcode/hello-world.html?utm_source=sampleReadme): Scan single barcode from video stream with minimum code in JavaScript.
4949
* [**Scan And Search**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/scan-and-search.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-single-barcode/scan-and-search.html?utm_source=sampleReadme): Scan a barcode to retrieve the relevant product information from the database in JavaScript.
50+
* [**Pick One to Fill**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/pick-one-to-fill/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-single-barcode/pick-one-to-fill/index.html?utm_source=sampleReadme): Pick one and auto-fill fields by simply opening the camera and scanning a group of barcodes.
51+
* [**Use Customized Template**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/use-customized-template/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-single-barcode/use-customized-template/index.html?utm_source=sampleReadme): Use different customized templates for scanning various barcode types.
5052
* [**Hello World in Angular**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/angular): Read single barcode from camera in an Angular application.
5153
* [**Hello World in React**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/react): Read single barcode from camera in a React application.
5254
* [**Hello World in Vue**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/vue): Read single barcode from camera in a Vue application.
@@ -55,6 +57,7 @@ Get the basic features working with plain/native JavaScript or within a framewor
5557

5658
* [**Scan Multiple Barcodes**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/barcode-scanner-api-samples/scan-multiple-barcodes/hello-world.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-multiple-barcodes/hello-world.html?utm_source=sampleReadme): Scan barcodes from video stream with minimum code in JavaScript.
5759
* [**Cart Builder**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/barcode-scanner-api-samples/scan-multiple-barcodes/cart-builder.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-multiple-barcodes/cart-builder.html?utm_source=sampleReadme): Simulates a shopping experience where users scan barcodes to add items to a dynamic cart in JavaScript.
60+
* [**Batch Inventory**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/barcode-scanner-api-samples/scan-multiple-barcodes/batch-inventory/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/barcode-scanner-api-samples/scan-multiple-barcodes/batch-inventory/index.html?utm_source=sampleReadme): An inventory management tool scan barcodes in batches and provide real-time analysis of the scanned data.
5861

5962
### Foundational API samples
6063

@@ -83,6 +86,7 @@ Get the basic features of the library working with plain/native JavaScript or wi
8386
* [**Read a Driver's License**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/read-a-drivers-license/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/read-a-drivers-license/index.html?utm_source=sampleReadme): Read the PDF417 barcode on a driver's license (AAMVA compliant) and parse it.
8487
* [**Show Result Texts on the Video**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/show-result-texts-on-the-video.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/show-result-texts-on-the-video.html?utm_source=sampleReadme): Read barcodes via camera and show result texts on the video.
8588
* [**Locate an Item with Barcode**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/locate-an-item-with-barcode/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/locate-an-item-with-barcode/index.html?utm_source=sampleReadme): Find a specific item in a large collection by scanning its unique barcode
89+
* [**Read and Parse GS1-AI**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/foundational-api-samples/use-case/read-and-parse-GS1-AI/index.html) - [run↗](https://demo.dynamsoft.com/samples/dbr/js/foundational-api-samples/use-case/read-and-parse-GS1-AI/index.html?utm_source=sampleReadme): Read GS1 Application Identifier (AI) barcode and parse its structured data.
8690

8791
***Others***
8892

barcode-scanner-api-samples/scan-multiple-barcodes/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,40 @@ The UI features a "Scan Barcode" button, a styled cart, and basic interactivity
6868

6969
A list of 20 dummy products is used, with each scan randomly adding a product to the cart showing its name, shortened barcode, and price.
7070

71+
## 🛒 3. Batch inventory
72+
73+
This project is a simple web-based inventory management tool that uses `BarcodeScanner` to scan barcodes in batches and provide real-time analysis of the scanned data.
74+
75+
### ✨ Features
76+
77+
- Automatically deduplicate barcodes in each session
78+
79+
- Show session summary:
80+
- Total unique barcodes
81+
- Barcode type distribution
82+
- Session duration
83+
84+
- Track duration of each scan session
85+
86+
### 🔧 How It Works
87+
88+
- The scanner is embedded using `BarcodeScanner` with `SM_MULTI_UNIQUE` mode to capture unique barcodes.
89+
90+
- Once the scan completes, the results are analyzed.
91+
92+
- You can click the back arrow to restart scanning.
93+
94+
### 📌 Notes
95+
96+
- The barcode value must be unique, otherwise it won’t be counted.
97+
98+
- Applicable scenarios may include:
99+
100+
- Warehouse inventory checks
101+
- Retail stock intake
102+
- Barcode-based asset tracking
103+
- Batch QR code scanning
104+
71105
## 📄 See other BarcodeScanner samples
72106

73107
Multiple samples are provided for single barcode scanning. These samples can be easily adapted to scan multiple unique barcodes by simply updating the `config` object.

barcode-scanner-api-samples/scan-single-barcode/README.md

Lines changed: 65 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 📦 Scan Single Barcode
1+
# 📦 Scan Single Barcode
22

33
## 🚀 1.Hello World
44

@@ -43,7 +43,7 @@ barcodeScanner.launch();
4343

4444
## 🛒 2. Scan and Search
4545

46-
This simple demonstrates how to use the `BarcodeScanner` API from the [Dynamsoft Barcode Reader JavaScript SDK](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/) to scan a product barcode and simulate a search from a product database.
46+
This simple demonstrates how to use the `BarcodeScanner` API to scan a product barcode and simulate a search from a product database.
4747

4848
### ✨ Features
4949

@@ -52,7 +52,7 @@ This simple demonstrates how to use the `BarcodeScanner` API from the [Dynamsoft
5252
- Displays mock product data as search results
5353
- Responsive UI with modern styling
5454

55-
### 🔧 How It Works
55+
### 🔄 Sample Usage Flow
5656

5757
1. Click the Scan button to launch the barcode scanner.
5858
2. Once a barcode is detected, its value is displayed along with placeholder product information.
@@ -64,6 +64,68 @@ This simple demonstrates how to use the `BarcodeScanner` API from the [Dynamsoft
6464
- No real backend is connected in this demo; results are mocked.
6565
- You can integrate with a real product API by replacing the placeholder content in the searchResult.value.
6666

67+
## 📷 3. Pick One To Fill
68+
69+
A web-based form-filling utility that uses the `BarcodeScanner` to scan and auto-fill fields by simply opening the camera and scanning a barcode.
70+
71+
### ✨ Features
72+
73+
- Field-specific Camera Activation
74+
Open the camera individually for different fields.
75+
76+
- Manual control when to start decoding
77+
Start decoding manually after aiming at the target to reduce the risk of misreads and missed barcodes.
78+
79+
- Auto-Fill with Scan Result
80+
Automatically populates input fields with scanned barcode values.
81+
82+
### 🔄 Sample Usage Flow
83+
84+
1. Click the "Open Camera" button to activate the camera.
85+
86+
2. Aim at the sample image shown below.
87+
88+
3. Click the "Decode" button to start barcode recognition.
89+
90+
4. If only one barcode is detected, its value will be automatically filled into the corresponding field.
91+
If multiple barcodes are detected, the video stream will freeze, and you’ll need to manually select one from the decoded results to fill in.
92+
93+
### 📌 Notes
94+
95+
- This usage is especially suitable for scenarios with densely packed barcodes, where secondary confirmation or manual selection is highly needed.
96+
- You can find a sample reference image in `./pick-one-to-fill/`.
97+
98+
## 🎥 4. Use Customized Template
99+
100+
This is a sample web application demonstrating how to use the `BarcodeScanner` with different customized templates for scanning various barcode types.
101+
102+
It allows users to dynamically select a scanning template (e.g., DPM, Dot Code, OneD Retail, OneD Industrial), and launch a camera-based barcode scanner accordingly.
103+
104+
### ✨ Features
105+
106+
- Support for custom barcode scanning templates using local JSON files.
107+
108+
- Easily switch between different template configurations.
109+
110+
### 🔄 Sample Usage Flow
111+
112+
1. Open the HTML file in a browser. The app will automatically initialize the scanner using the ReadDPM template.
113+
114+
2. Choose from the available templates:
115+
- Direct Part Marking (DPM)
116+
- Dot Code
117+
- OneD Retail
118+
- OneD Industrial
119+
120+
Scanner Loads with Selected Template. When a new template is selected, the scanner is re-initialized using the corresponding .json file.
121+
122+
3. Point your camera at a barcode matching the selected template type. A popup alert will display the result upon successful detection.
123+
124+
### 📌 Notes
125+
126+
- The scanner is disposed and recreated every time a different template is selected, ensuring the correct settings are applied.
127+
- You can find sample images in `./use-customized-template/`.
128+
67129
## 📄 See other BarcodeScanner samples
68130

69131
* [**Hello World in Angular**](https://github.com/Dynamsoft/barcode-reader-javascript-samples/tree/main/barcode-scanner-api-samples/scan-single-barcode/angular): Read single barcode from camera in an Angular application.
59.6 KB
Loading
18.7 KB
Loading
128 KB
Loading

foundational-api-samples/use-case/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The following official sample shows how to use the SDK to read and extract drive
1818

1919
Also, see [Driver's License Scanner SDK for Mobile and Web](https://www.dynamsoft.com/use-cases/driver-license/).
2020

21-
## Read barcodes via camera and show result texts on the video
21+
## Read Barcodes via Camera and Show Result Texts on the Video
2222

2323
When the SDK picks up a barcode in a video stream, it will automatically highlight it with a built-in style. But it is also possible to show the barcode text on the video with the help of the function `convertToPageCoordinates()` or `convertToClientCoordinates()`.
2424

@@ -38,6 +38,14 @@ Additionally, this sample demonstrates how to utilize the SDK to fill out form f
3838
* <a target = "_blank" href="https://demo.dynamsoft.com/Samples/DBR/JS/foundational-api-samples/use-case/locate-an-item-with-barcode/index.html">Locate an Item with Barcode - Demo</a>
3939
* <a target = "_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/foundational-api-samples/use-case/locate-an-item-with-barcode/index.html">Locate an Item with Barcode - Source Code</a>
4040

41+
## Read the GS1-AI Barcode and Parse it
42+
43+
GS1-AI barcodes contain standardized information such as product ID (GTIN), expiration date, batch/lot number, and more, encoded using specific Application Identifiers (AIs).
44+
45+
This sample demonstrates how to scan a GS1 Application Identifier (AI) barcode using the Dynamsoft Barcode Reader SDK and parse its structured data.
46+
47+
* <a target = "_blank" href="https://demo.dynamsoft.com/Samples/DBR/JS/foundational-api-samples/use-case/read-and-parse-GS1-AI/index.html">Read the GS1-AI Barcode and Parse It - Demo</a>
48+
* <a target = "_blank" href="https://github.com/Dynamsoft/barcode-reader-javascript-samples/blob/main/foundational-api-samples/use-case/read-and-parse-GS1-AI/index.html">Read the GS1-AI Barcode and Parse It - Source Code</a>
4149

4250
## Support
4351

0 commit comments

Comments
 (0)