Skip to content

Commit 5352049

Browse files
committed
added PDF417 generator support and updated Linux generator page
1 parent 64b37a0 commit 5352049

File tree

5 files changed

+52
-6
lines changed

5 files changed

+52
-6
lines changed

docs/sdks/android/barcode-generator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The Barcode Generator supports the following formats:
1919
* ITF
2020
* QR
2121
* DataMatrix
22+
* PDF417 (SDK version >= 8.2)
2223

2324
## Prerequisites
2425

docs/sdks/capacitor/barcode-generator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ The Barcode Generator supports the following formats:
2020
* ITF
2121
* QR
2222
* DataMatrix
23+
* PDF417 (SDK version >= 8.2)
2324

2425
## Prerequisites
2526

docs/sdks/flutter/barcode-generator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The Barcode Generator supports the following formats:
1919
* ITF
2020
* QR
2121
* DataMatrix
22+
* PDF417 (SDK version >= 8.2)
2223

2324
## Prerequisites
2425

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,69 @@
11
---
22
displayed_sidebar: linuxSidebar
3-
sidebar_label: JSON Settings
3+
sidebar_label: Configure barcode encoding
44
---
55

66
# Barcode Generator
77

8-
The Barcode Generator is a simple API to generate barcodes directly from the Scandit SDK. This document describes the JSON format understood by the [`sc_barcode_generator_set_options()`](https://docs.scandit.com/stable/c_api/struct_sc_barcode_generator.html#a045a2b9474895067e8eb1610ae6c5fef) function.
8+
The Barcode Generator is a simple API to generate barcodes directly from the Scandit SDK. The function [`sc_barcode_generator_new`](https://docs.scandit.com/stable/c_api/struct_sc_barcode_generator.html) creates a barcode generator for a sepcific symbology.
99

10-
## General Options
10+
The Barcode Generator supports the following formats:
11+
12+
* Code 39
13+
* Code 128
14+
* EAN 13
15+
* UPCA
16+
* ITF
17+
* QR
18+
* DataMatrix
19+
* PDF417 (SDK version >= 8.2)
20+
21+
## Sample
22+
23+
A C and Python sample is provided in the Linux SDK archive: `CommandLineBarcodeGeneratorSample.c/py`.
24+
25+
## JSON Configuration
26+
27+
The generator can be configured using a JSON string understood by the [`sc_barcode_generator_set_options()`](https://docs.scandit.com/stable/c_api/struct_sc_barcode_generator.html#a045a2b9474895067e8eb1610ae6c5fef) function.
28+
29+
### General Options
1130

1231
* `foregroundColor`: 4-tuple of integers [r, g, b, a] with `r`, `g`, `b` and `a` being in the range [0, 255]
1332
* `backgroundColor`: 4-tuple of integers [r, g, b, a] with `r`, `g`, `b` and `a` being in the range [0, 255]
1433

15-
## 2D Symbologies
16-
1734
### QR Code
1835

1936
* `errorCorrectionLevel`: string, may be `"L"` (up to 7% damage), `"M"` (up to 15% damage), `"Q"` (up to 25% damage) or `"H"` (up to 30% damage). Default correction level is `"M"`.
20-
* `versionNumber`: positive integer, overrides desired version number. Version number is automatically chosen if not set. Barcode generation might fail if version number is too small.
37+
* `versionNumber`: integer from 1 to 40, overrides desired version number. Version number is automatically chosen if not set. Barcode generation might fail if version number is too small.
38+
39+
Example:
2140
```json
2241
{
2342
"foregroundColor" : [ 255, 0, 0, 255 ],
2443
"backgroundColor" : [ 0, 0, 255, 255 ],
2544
"errorCorrectionLevel": "Q"
2645
}
2746
```
47+
48+
### PDF417
49+
50+
All settings are optional.
51+
52+
* `errorCorrectionLevel`: integer with values 0 to 8. A higher numbers increases the error correction data in the code.
53+
* `compact`: boolean, switches from normal to a compact code layout.
54+
* `compaction`: string, values `TEXT`, `BYTE`, `NUMERIC` or `AUTO`.
55+
* `dimensions`: object, `{"minCols" : n, "maxCols" : n, "minRows" : n, "maxRows" : n}` symbol dimensions as integer. Encoding fails if incompatible dimensions are defined.
56+
57+
Example:
58+
```json
59+
{
60+
"errorCorrectionLevel": 3,
61+
"compact": true,
62+
"dimensions" {
63+
"minCols" : 1,
64+
"maxCols" : 3,
65+
"minRows" : 2,
66+
"maxRows" : 10
67+
}
68+
}
69+
```

docs/sdks/react-native/barcode-generator.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ The Barcode Generator supports the following formats:
2020
* ITF
2121
* QR
2222
* DataMatrix
23+
* PDF417 (SDK version >= 8.2)
2324

2425
## Prerequisites
2526

0 commit comments

Comments
 (0)