You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,11 +98,11 @@ yarn ios
98
98
If everything is set up _correctly_, you should see your new app running on your device.
99
99
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
100
100
101
-
> Note:
101
+
> [!NOTE]
102
102
> If you want to run Android via `Windows`, You may encounter some build errors due to the `Windows Maximum Path Length Limitation`.
103
103
> Therefore, we recommend that you move the project to a directory with a shorter path.
104
104
105
-
> Note:
105
+
> [!NOTE]
106
106
>
107
107
>- The application needs to run on a physical device rather than a simulator as it requires the use of the camera. If you try running it on a simulator, you will most likely run into a number of errors/failures.
108
108
>- On iOS, in order to run the React Native app on a physical device you will need to install the [`ios-deploy`](https://www.npmjs.com/package/ios-deploy) library. Afterwards, you can run the react native app from the terminal as such `npx react-native run-ios --device` assuming it's the only device connected to the Mac.
>- The license string here grants a time-limited free trial which requires network connection to work.
91
91
>- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=dcv&utm_source=guide&package=mobile) link.
@@ -218,7 +218,7 @@ yarn ios
218
218
If everything is set up _correctly_, you should see your new app running on your device.
219
219
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
220
220
221
-
> Note:
221
+
> [!NOTE]
222
222
> If you want to run Android via `Windows`, You may encounter some build errors due to the `Windows Maximum Path Length Limitation`.
223
223
> Therefore, we recommend that you move the project to a directory with a shorter path.
>- The license string here grants a time-limited free trial which requires network connection to work.
104
104
>- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=guide&package=mobile) link.
@@ -197,7 +197,7 @@ export function Scanner() {
197
197
}
198
198
```
199
199
200
-
> Note:
200
+
> [!NOTE]
201
201
>
202
202
> - The `parsedItemToDriverLicenseData` function is a helper function to convert `ParsedResultItem` into an easier-to-read structure(`DriverLicenseData`). You can get the source code from [DriverLicenseScanResult.tsx](ReadDriverLicense/src/DriverLicenseScanResult.tsx).
Copy file name to clipboardExpand all lines: foundation-barcode-reader-guide.md
+7-40Lines changed: 7 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,45 +1,12 @@
1
-
# Foundation Barcode Reader Integration Guide
1
+
# Foundational Barcode Reader Integration Guide
2
2
3
3
In this guide, we will explore the Barcode Reader features of the [Dynamsoft Capture Vision](https://www.dynamsoft.com/capture-vision/docs/core/introduction/) SDK.
4
4
5
5
## Supported Barcode Symbologies
6
6
7
-
- Linear Barcodes (1D)
8
-
- Code 39 (including Code 39 Extended)
9
-
- Code 93
10
-
- Code 128
11
-
- Codabar
12
-
- Interleaved 2 of 5
13
-
- EAN-8
14
-
- EAN-13
15
-
- UPC-A
16
-
- UPC-E
17
-
- Industrial 2 of 5
18
-
19
-
- 2D Barcodes
20
-
- QR Code (including Micro QR Code and Model 1)
21
-
- Data Matrix
22
-
- PDF417 (including Micro PDF417)
23
-
- Aztec Code
24
-
- MaxiCode (mode 2-5)
25
-
- DotCode
26
-
27
-
- Patch Code
28
-
29
-
- GS1 Composite Code
30
-
31
-
- GS1 DataBar
32
-
- Omnidirectional,
33
-
- Truncated, Stacked,
34
-
- Stacked Omnidirectional, Limited,
35
-
- Expanded, Expanded Stacked
36
-
37
-
- Postal Codes
38
-
- USPS Intelligent Mail
39
-
- Postnet
40
-
- Planet
41
-
- Australian Post
42
-
- UK Royal Mail
7
+
| Linear Barcodes (1D) | 2D Barcodes | Others |
8
+
| :------------------- | :---------- | :----- |
9
+
| Code 39 (including Code 39 Extended)<br>Code 93<br>Code 128<br>Codabar<br>Interleaved 2 of 5<br>EAN-8<br>EAN-13<br>UPC-A<br>UPC-E<br>Industrial 2 of 5<br><br><br><br><br><br><br><br> | QR Code (including Micro QR Code and Model 1)<br>Data Matrix<br>PDF417 (including Micro PDF417)<br>Aztec Code<br>MaxiCode (mode 2-5)<br>DotCode<br><br><br><br><br><br><br><br><br><br><br><br> | Patch Code<br><br>GS1 Composite Code<br><br>GS1 DataBar<br><li>Omnidirectional</li><li>Truncated, Stacked</li><li>Stacked Omnidirectional, Limited</li><li>Expanded, Expanded Stacked</li><br>Postal Codes<br><li>USPS Intelligent Mail</li><li>Postnet</li><li>Planet</li><li>Australian Post</li><li>UK Royal Mail</li> |
>- The license string here grants a time-limited free trial which requires network connection to work.
131
98
>- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=guide&package=mobile) link.
> - A template file is a JSON file that includes a series of algorithm parameter settings. It is always used to customize the performance for different usage scenarios. [Contact us](https://www.dynamsoft.com/company/contact/) to get a customized template for your barcode scanner.
255
222
@@ -303,7 +270,7 @@ yarn ios
303
270
If everything is set up _correctly_, you should see your new app running on your device.
304
271
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
305
272
306
-
> Note:
273
+
> [!NOTE]
307
274
> If you want to run Android via `Windows`, You may encounter some build errors due to the `Windows Maximum Path Length Limitation`.
308
275
> Therefore, we recommend that you move the project to a directory with a shorter path.
Copy file name to clipboardExpand all lines: mrz-scanner-guide.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ The Machine Readable Travel Documents (MRTD) standard specified by the Internati
13
13
14
14
Currently, the SDK supports three types of MRTD:
15
15
16
-
> Note: If you need support for other types of MRTDs, our SDK can be easily customized. Please contact [email protected].
16
+
> [!NOTE] If you need support for other types of MRTDs, our SDK can be easily customized. Please contact [email protected].
17
17
18
18
### ID (TD1 Size)
19
19
@@ -144,7 +144,8 @@ function App(): React.JSX.Element {
144
144
);
145
145
}
146
146
```
147
-
>Note:
147
+
148
+
> [!NOTE]
148
149
>
149
150
>- The license string here grants a time-limited free trial which requires network connection to work.
150
151
>- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=mrz&utm_source=github&package=mobile) link.
@@ -276,7 +277,7 @@ yarn ios
276
277
If everything is set up _correctly_, you should see your new app running on your device.
277
278
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
278
279
279
-
> Note:
280
+
> [!NOTE]
280
281
> If you want to run Android via `Windows`, You may encounter some build errors due to the `Windows Maximum Path Length Limitation`.
281
282
> Therefore, we recommend that you move the project to a directory with a shorter path.
Copy file name to clipboardExpand all lines: ready-to-use-barcode-scanner-guide.md
+15-48Lines changed: 15 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,51 +1,18 @@
1
-
# Barcode Reader Integration Guide
1
+
# BarcodeScanner Integration Guide
2
2
3
-
In this guide, we will explore the Barcode Reader features of the [Dynamsoft Capture Vision](https://www.dynamsoft.com/capture-vision/docs/core/introduction/) SDK.
3
+
In this guide, we will explore the `BarcodeScanner` features of the [Dynamsoft Capture Vision](https://www.dynamsoft.com/capture-vision/docs/core/introduction/) SDK.
4
4
5
-
We provide BarcodeScanner APIs, which is a ready-to-use component that allows developers to quickly set up a barcode scanning app.
5
+
We provide `BarcodeScanner` APIs, which is a ready-to-use component that allows developers to quickly set up a barcode scanning app.
6
6
With the built-in component, it streamlines the integration of barcode scanning functionality into any application.
7
7
8
-
In the BarcodeScanner APIs, we provide some customization features based on easy integration to meet your needs.
8
+
In the `BarcodeScanner` APIs, we provide some customization features based on easy integration to meet your needs.
9
9
However, if you want to achieve a higher level of customization, we recommend that you use our Foundation APIs and see this [Foundation Barcode Reader Guide](./foundation-barcode-reader-guide.md).
10
10
11
11
## Supported Barcode Symbologies
12
12
13
-
- Linear Barcodes (1D)
14
-
- Code 39 (including Code 39 Extended)
15
-
- Code 93
16
-
- Code 128
17
-
- Codabar
18
-
- Interleaved 2 of 5
19
-
- EAN-8
20
-
- EAN-13
21
-
- UPC-A
22
-
- UPC-E
23
-
- Industrial 2 of 5
24
-
25
-
- 2D Barcodes
26
-
- QR Code (including Micro QR Code and Model 1)
27
-
- Data Matrix
28
-
- PDF417 (including Micro PDF417)
29
-
- Aztec Code
30
-
- MaxiCode (mode 2-5)
31
-
- DotCode
32
-
33
-
- Patch Code
34
-
35
-
- GS1 Composite Code
36
-
37
-
- GS1 DataBar
38
-
- Omnidirectional,
39
-
- Truncated, Stacked,
40
-
- Stacked Omnidirectional, Limited,
41
-
- Expanded, Expanded Stacked
42
-
43
-
- Postal Codes
44
-
- USPS Intelligent Mail
45
-
- Postnet
46
-
- Planet
47
-
- Australian Post
48
-
- UK Royal Mail
13
+
| Linear Barcodes (1D) | 2D Barcodes | Others |
14
+
| :------------------- | :---------- | :----- |
15
+
| Code 39 (including Code 39 Extended)<br>Code 93<br>Code 128<br>Codabar<br>Interleaved 2 of 5<br>EAN-8<br>EAN-13<br>UPC-A<br>UPC-E<br>Industrial 2 of 5<br><br><br><br><br><br><br><br> | QR Code (including Micro QR Code and Model 1)<br>Data Matrix<br>PDF417 (including Micro PDF417)<br>Aztec Code<br>MaxiCode (mode 2-5)<br>DotCode<br><br><br><br><br><br><br><br><br><br><br><br> | Patch Code<br><br>GS1 Composite Code<br><br>GS1 DataBar<br><li>Omnidirectional</li><li>Truncated, Stacked</li><li>Stacked Omnidirectional, Limited</li><li>Expanded, Expanded Stacked</li><br>Postal Codes<br><li>USPS Intelligent Mail</li><li>Postnet</li><li>Planet</li><li>Australian Post</li><li>UK Royal Mail</li> |
49
16
50
17
## System Requirements
51
18
@@ -115,9 +82,9 @@ For iOS, you need to include the camera permission in `ios/your-project-name/Inf
115
82
<string></string>
116
83
```
117
84
118
-
## Build the Barcode Reader Component
85
+
## Build the BarcodeScanner Component
119
86
120
-
Now that the package is added, it's time to start building the barcode reader component using the SDK.
87
+
Now that the package is added, it's time to start building the `BarcodeScanner` component using the SDK.
121
88
122
89
### Import
123
90
To use the BarcodeScanner API, please import `BarcodeScanner` class
@@ -149,8 +116,8 @@ function App(): React.JSX.Element {
149
116
);
150
117
}
151
118
```
152
-
>Note:
153
-
>
119
+
120
+
>[!NOTE]
154
121
>- The license string here grants a time-limited free trial which requires network connection to work.
155
122
>- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=guide&package=mobile) link.
156
123
@@ -173,7 +140,7 @@ import {BarcodeScanConfig, EnumBarcodeFormat} from 'dynamsoft-capture-vision-rea
173
140
174
141
const config = {
175
142
/**
176
-
* The license key required to initialize the barcode reader.
143
+
* The license key required to initialize the BarcodeScanner.
177
144
*/
178
145
license: "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", //The license string here grants a time-limited free trial which requires network connection to work.
179
146
@@ -229,7 +196,7 @@ const config = {
229
196
isScanLaserVisible: true,
230
197
231
198
/**
232
-
* Sets the scanning mode for the barcode reader.
199
+
* Sets the scanning mode for the BarcodeScanner.
233
200
* The mode is defined by the EnumScanningMode and affects the scanning behavior. Default is SM_SINGLE.
234
201
*/
235
202
scanningMode: EnumScanningMode.SM_SINGLE,
@@ -249,7 +216,7 @@ const config = {
249
216
maxConsecutiveStableFramesToExit: 10,
250
217
251
218
/**
252
-
* Specifies the template configuration for the barcode scanner.
219
+
* Specifies the template configuration for the BarcodeScanner.
253
220
* This can be either a file path or a JSON string that defines various scanning parameters.
254
221
* Default is undefined, which means the default template will be used.
255
222
*/
@@ -297,7 +264,7 @@ yarn ios
297
264
If everything is set up _correctly_, you should see your new app running on your device.
298
265
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
299
266
300
-
> Note:
267
+
> [!NOTE]
301
268
> If you want to run Android via `Windows`, You may encounter some build errors due to the `Windows Maximum Path Length Limitation`.
302
269
> Therefore, we recommend that you move the project to a directory with a shorter path.
0 commit comments