Skip to content

Commit 988604c

Browse files
committed
Updating ReadMe files
1 parent 76d8443 commit 988604c

File tree

6 files changed

+122
-40
lines changed

6 files changed

+122
-40
lines changed
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
## AI Data Capture Demo Application
2+
3+
This application demonstrates the features available in the [Zebra AI Data Capture SDK](https://techdocs.zebra.com/ai-datacapture) .
4+
5+
The application demonstrates technology features, including **Barcode Recognizer**, **Text/OCR Recognizer**, and **Product & Shelf Localizer**, and usecase feature including **Product & Shelf Recognizer**, and **OCR Finder**.
6+
7+
Each feature is illustrated through a live preview that provides real-time, on-screen feedback, displaying bounding boxes around detected objects and additionally showing recognition results for Product and Shelf Recognition and OCR Text Find.
8+
9+
## Useful References
10+
- [SDK Documentation](https://techdocs.zebra.com/ai-datacapture/latest/about/)
11+
- [Models](https://techdocs.zebra.com/ai-datacapture/latest/setup/#featuresmodels)
12+
- [Developer Experience Videos](https://www.youtube.com/zebratechnologies)
13+
14+
### Demo Selection
15+
### Usecase Demos
16+
**Product Shelf Recognizer** - Product Recognition:
17+
- Enables creation of a product index
18+
- Multi-step process required to create index followed displaying results on live viewfinder
19+
- Recognizes products with results displayed as text within each product’s bounding box.
20+
- Highlights enrolled products in green during enrollment; non-enrolled products do not display text results.
21+
**OCR Finder** - Optical Character Recognition:
22+
- Displays text recognition results on the live viewfinder.
23+
- The search icon enables the user to locate text by filtering for numeric, alphabetic, or alphanumeric content, including options for specifying size ranges or exact string matches
24+
25+
### Technology Demos
26+
**Barcode Recognizer** - Barcode Detection and Decode
27+
- Displays a live camera preview.
28+
- Highlights 1D and 2D barcodes with bounding boxes in various colors.
29+
- Displays decoded barcode value below the bounding boxes.
30+
**Text OCR Recognizer** - Optical Character Recognition:
31+
- Displays text recognition results on the live viewfinder.
32+
- The settings menu offers controls to customize detection, recognition, and grouping features.
33+
**Product & Shelf Localizer** - Retail Shelf Localizer
34+
- Provides a live camera preview with bounding boxes over detected features like shelves, labels, pegs labels and products.
35+
- Uses specific colors for each feature: Red for shelves, Blue for labels, Magenta for Peg and Green for products.
36+
37+
### Generic Settings - Model Processing Configurations
38+
**CPU / GPU / DSP** - Configures processor type for running the selected model
39+
- CPU – runs model on CPU, this is typically the least performant for inference time
40+
- GPU – runs model on GPU, typically higher performance than CPU
41+
- DSP – runs model on DSP, fastest performance
42+
43+
**640 / 1280 / 1600 / 2560** - Configures the AI Models to run at a specific resolution
44+
- 640 -> set’s the model inference dimensions to 640x640
45+
- 1280 -> set’s the model inference dimensions to 1280x1280
46+
- 1600 -> set’s the model inference dimensions to 1600x1600
47+
- 2560 -> set’s the model inference dimensions to 2560x2560
48+
49+
Typically lower resolutions should be used when capturing images close-up while higher resolutions allow detection of smaller features or features that are far away.
50+
51+
### Product Recognition
52+
Product Recognition is initialized to use products.db file in internal storage folder (filesDir). User has no direct access to this folder and file.
53+
**Import DB**
54+
- Allows user to select a database file using the file picker feature.
55+
- This functionality is specifically intended for those managing a list of previously enrolled product database files.
56+
- The feature allows users to load a product database file (*.db) from local storage.
57+
- Once a file is selected, it is copied to the products.db file within the filesDir directory,
58+
and Product Recognition is initialized to use the newly selected database file.
59+
60+
**Clear DB**
61+
- Clear’s database from file local storage.
62+
- Shows “Deleted Product Database” toast
63+
64+
**Export DB**
65+
- Copies products.db file from filesDir, that is used currently for product recognition into **Downloads** folder.
66+
67+
***Supporting Information***
68+
By default, this application does not include a product recognition database. However, users can manually enroll products using the _Product_ model setting sequence and save the associated database for future use. The application also allows users to load databases from memory. Product databases are located in the _/Download/_ directory, while manually labeled product images are stored in the _/Pictures/_ directory.
69+
70+
Once manual labeling is complete, users can run real-time product recognition in _Product_ mode and review the results. If the product recognition results do not meet the desired accuracy levels, additional captures of the same product set may be needed. The sequence of screens required to perform product enrollment is shown below.
71+
72+
### Build Dependencies:
73+
This application requires specific dependencies made available by Zebra through a maven repository. Access to this repository is necessary in order for the application to include all the required libraries required.
74+
## Support
75+
If you encounter any issues or have questions about using the AI Suite, feel free to contact Zebra Technologies support through the official support page.
76+
77+
## Thank You
78+
Lastly, thank you for being a part of our community. If you have any quesitons, please reach out to our DevRel team at developer@zebra.com
79+
80+
This README.md is designed to provide clarity and a user-friendly onboarding experience for developers. If you have specific details about the project that you would like to include, feel free to let us know!
81+
82+
## License
83+
All content under this repository's root folder is subject to the [Development Tool License Agreement](../../Zebra%20Development%20Tool%20License.pdf). By accessing, using, or distributing any part of this content, you agree to comply with the terms of the Development Tool License Agreement.

AISuite_Demos/AI_Barcode_Finder/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Use this project as a sample for:
2222
### Prerequisites
2323
- Android Studio Hedgehog or later
2424
- Android SDK 34 (Android 14)
25-
- Zebra AI Data Capture SDK ([Documentation](https://techdocs.zebra.com/enterprise-ai/vision-sdk/))
25+
- Zebra AI Data Capture SDK ([Documentation](https://techdocs.zebra.com/ai-datacapture/latest/about/))
2626

2727
### Setup & Installation
2828
1. **Clone the repository:**
@@ -47,11 +47,11 @@ Use this project as a sample for:
4747
- **Scan Results:** View completed scan operations and manage barcode inventory.
4848

4949
## Documentation & Support
50-
- [Zebra AI Data Capture SDK Documentation](https://techdocs.zebra.com/enterprise-ai/vision-sdk/)
50+
- [Zebra AI Data Capture SDK Documentation](https://techdocs.zebra.com/ai-datacapture/latest/about/)
5151
- [Jetpack Compose Documentation](https://developer.android.com/jetpack/compose)
5252
- [CameraX Documentation](https://developer.android.com/training/camerax)
5353
- [Android Developer Documentation](https://developer.android.com/docs)
5454

5555
---
5656

57-
*This project is a sample implementation of Zebra's EntityTrackerAnalyzer. For questions or support, please refer to Zebra's developer resources or open an issue in this repository.*
57+
*This project is a sample implementation of Zebra's EntityTrackerAnalyzer. For questions or support, please refer to Zebra's developer resources or open an issue in this repository.*

AISuite_Demos/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The AI Suite Demo repository provides re-usable source code that can be used to
1111

1212
## Useful References
1313
- [SDK Documentation](https://techdocs.zebra.com/ai-datacapture/latest/about/)
14-
- [Model Information](https://techdocs.zebrea.com/ai-datacapture/latest/models/)
14+
- [Model Information](https://techdocs.zebra.com/ai-datacapture/latest/setup/#featuresmodels)
1515
- [Developer Experience Videos](https://www.youtube.com/zebratechnologies)
1616

1717
## Key Features
@@ -46,4 +46,4 @@ This README.md is designed to provide clarity and a user-friendly onboarding exp
4646
## License
4747
All content under this repository's root folder is subject to the [Development Tool License Agreement](../Zebra%20Development%20Tool%20License.pdf). By accessing, using, or distributing any part of this content, you agree to comply with the terms of the Development Tool License Agreement.
4848

49-
This README.md is designed to provide clarity and a user-friendly onboarding experience for developers. If you have specific details about the project that you would like to include, feel free to let us know!
49+
This README.md is designed to provide clarity and a user-friendly onboarding experience for developers. If you have specific details about the project that you would like to include, feel free to let us know!

0 commit comments

Comments
 (0)