Skip to content

Commit 7df00ad

Browse files
Add code parser articles
1 parent 6016f69 commit 7df00ad

2 files changed

Lines changed: 208 additions & 1 deletion

File tree

programming/android/user-guide/capabilities/parse-drivers-license.md

Lines changed: 102 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,105 @@ needGenerateH3Content: true
88
noTitleIndex: true
99
---
1010

11-
# Parse Drivers' License
11+
# Parse Drivers License
12+
13+
## How to Enable Drivers License Parsing
14+
15+
1. Add code parser task.
16+
17+
```json
18+
"CodeParserTaskSettingOptions": [
19+
{
20+
"Name": "parse-drivers-license",
21+
"CodeSpecifications": [
22+
"AAMVA_DL_ID",
23+
"AAMVA_DL_ID_WITH_MAG_STRIPE",
24+
"SOUTH_AFRICA_DL"
25+
]
26+
},
27+
]
28+
```
29+
30+
2. Add semantic processing options and specify the target ROI to reference.
31+
32+
```json
33+
"SemanticProcessingOptions": [
34+
{
35+
"Name": "sp-drivers-license",
36+
"ReferenceObjectFilter": {
37+
"ReferenceTargetROIDefNameArray": [
38+
"roi-drivers-license"
39+
]
40+
},
41+
"TaskSettingNameArray": [
42+
"parse-drivers-license"
43+
]
44+
},
45+
]
46+
```
47+
48+
3. Add the semantic processing option names to your template.
49+
50+
```json
51+
"CaptureVisionTemplates": [
52+
{
53+
"Name": "ReadDriversLicense",
54+
"ImageROIProcessingNameArray": [
55+
"roi-drivers-license"
56+
],
57+
"SemanticProcessingNameArray": [
58+
"sp-drivers-license"
59+
]
60+
}
61+
]
62+
```
63+
64+
## How to Receive Parsed Results
65+
66+
Receive the `ParsedResult` from the [`onParsedResultsReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) callback of `CapturedResultReceiver`.
67+
68+
```java
69+
mRouter.addResultReceiver(new CapturedResultReceiver() {
70+
@Override
71+
public void onParsedResultsReceived(@NonNull ParsedResult result) {
72+
// Add your code to use the ParsedResult
73+
}
74+
});
75+
```
76+
77+
You can also receive the `ParsedResult` from the [`onCapturedResultReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) callback if you want to use the barcode result as well.
78+
79+
```java
80+
mRouter.addResultReceiver(new CapturedResultReceiver() {
81+
@Override
82+
public void onCapturedResultReceived(@NonNull CapturedResult result) {
83+
DecodedBarcodesResult decodedBarcodesResult = result.getDecodedBarcodesResult();
84+
ParsedResult parsedResult = result.getParsedResult();
85+
}
86+
});
87+
```
88+
89+
## Common Fields
90+
91+
92+
| Field Name | Description |
93+
| ---------- | ----------- |
94+
| CodeType | Code type, always has value "AAMVA_DL_ID" |
95+
| AAMVAVersionNumber | AAMVA Version Number |
96+
| fullName | Full name of cardholder |
97+
| lastName | Last name of cardholder |
98+
| givenName | Given name of cardholder |
99+
| firstName | First name of cardholder |
100+
| middleName | Middle name of cardholder |
101+
| street_1 | Street portion of the cardholder address |
102+
| street_2 | Second line of street portion of the cardholder address |
103+
| city | City portion of the cardholder address |
104+
| postalCode | Postal code portion of the cardholder address |
105+
| licenseNumber | License/ID Number |
106+
| vehicleClass | Jurisdiction-specific vehicle class / Driver License Classification Code |
107+
| expirationDate | Expiration Date |
108+
| birthDate | Date of Birth |
109+
| sex | Sex |
110+
| issuedDate | Date on which the document was issued |
111+
112+
View more [Drivers License fields]({{ site.code_types }}gs1-ai.html).

programming/android/user-guide/capabilities/parse-gs1.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,109 @@ noTitleIndex: true
99
---
1010

1111
# Parse GS1 AI
12+
13+
## How to Enable GS1 AI Parsing
14+
15+
1. Add code parser task.
16+
17+
```json
18+
"CodeParserTaskSettingOptions": [
19+
{
20+
"Name": "parse_gs1",
21+
"CodeSpecifications": [
22+
"GS1_AI"
23+
]
24+
}
25+
]
26+
```
27+
28+
2. Add semantic processing options and specify the target ROI to reference.
29+
30+
```json
31+
"SemanticProcessingOptions": [
32+
{
33+
"Name": "sp_gs1",
34+
"ReferenceObjectFilter": {
35+
"ReferenceTargetROIDefNameArray": [
36+
"roi_read_gs1"
37+
]
38+
},
39+
"TaskSettingNameArray": [
40+
"parse_gs1"
41+
]
42+
}
43+
]
44+
```
45+
46+
3. Add the semantic processing option names to your template.
47+
48+
```json
49+
"CaptureVisionTemplates": [
50+
{
51+
"Name": "ReadGS1AI",
52+
"ImageROIProcessingNameArray": [
53+
"roi_read_gs1"
54+
],
55+
"SemanticProcessingNameArray": [
56+
"sp_gs1"
57+
]
58+
}
59+
]
60+
```
61+
62+
## How to Receive Parsed Results
63+
64+
Receive the `ParsedResult` from the [`onParsedResultsReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) callback of `CapturedResultReceiver`.
65+
66+
```java
67+
mRouter.addResultReceiver(new CapturedResultReceiver() {
68+
@Override
69+
public void onParsedResultsReceived(@NonNull ParsedResult result) {
70+
// Add your code to use the ParsedResult
71+
}
72+
});
73+
```
74+
75+
You can also receive the `ParsedResult` from the [`onCapturedResultReceived`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) callback if you want to use the barcode result as well.
76+
77+
```java
78+
mRouter.addResultReceiver(new CapturedResultReceiver() {
79+
@Override
80+
public void onCapturedResultReceived(@NonNull CapturedResult result) {
81+
DecodedBarcodesResult decodedBarcodesResult = result.getDecodedBarcodesResult();
82+
ParsedResult parsedResult = result.getParsedResult();
83+
}
84+
});
85+
```
86+
87+
## Common Fields
88+
89+
| Field Name | Description |
90+
| ---------- | ----------- |
91+
| CodeType | Code type, always has value `GS1_AI` |
92+
| 01 | Identification of a trade item (GTIN) |
93+
| 10 | Batch or lot number |
94+
| 11 | Production date |
95+
| 12 | Due date for amount on payment slip |
96+
| 13 | Packaging date |
97+
| 15 | Best before date |
98+
| 16 | Sell by date |
99+
| 17 | Expiration date |
100+
| 20 | Internal product variant |
101+
| 21 | Serial number |
102+
| 22 | Consumer product variant |
103+
| 30 | Variable count of items |
104+
| 310n | Net weight, kilograms |
105+
| 37 | Count of trade items or trade item pieces contained in a logistic unit |
106+
| 390n | Amount payable or coupon value - Single monetary area |
107+
| 391n | Amount payable and ISO currency code |
108+
| 392n | Amount payable for a variable measure trade item - Single monetary area |
109+
| 393n | Amount payable for a variable measure trade item and ISO currency code |
110+
| 394n | Percentage discount of a coupon |
111+
| 395n | Amount payable per unit of measure single monetary area |
112+
| 400 | Customer’s purchase order number |
113+
| 401 | Global Identification Number for Consignment (GINC) |
114+
| 402 | Global Shipment Identification Number (GSIN) |
115+
| 410 | Ship to - Deliver to Global Location Number (GLN) |
116+
117+
View more [GS1 AI fields]({{ site.code_types }}gs1-ai.html).

0 commit comments

Comments
 (0)