Barcode Streaming for .NET Core | .NET 8+ | User Manual

Buy License Support Download Demo Release Log

Streaming .NET Core Barcode Generator Availability

Streaming .NET Core Barcode Generator Example

The Streaming component is licensed with the following products:

.NET Core Barcode Streaming

The .NET Core Streaming Component is compatible with .NET8 and up. It streams an image or font text to any application making the request. It is provided as a standalone EXE file that, when executed, enables streaming from that system without a webserver. It can also be installed on IIS. The Visual Studio Project for streaming is included in the "Streaming API Project" folder to allow changing the port number or for custom development.

Standalone EXE Streaming for Windows

Open the EXE file from the "Streaming API .NET 8+" folder. Once executed, the PC running this EXE file can easily stream barcodes. The following URLs may be opened in the browser to view the streamed image:

  • http://localhost:5000/idautomation-aztec
  • http://localhost:5000/idautomation-datamatrix
  • http://localhost:5000/idautomation-dotcode
  • http://localhost:5000/idautomation-maxicode
  • http://localhost:5000/idautomation-linear
  • http://localhost:5000/idautomation-pdf417
  • http://localhost:5000/idautomation-qrcode
  • http://localhost:5000/idautomation-qrenh (Enhanced QR is currently in development, beta testing available upon request)

Note: Only run one EXE at a time; an error will occur if two are running on the same port at the same time.


IIS Streaming for Windows Server

The streaming IIS component is designed to be installed on an existing IIS website using SSL and a valid domain. This example uses the QR Code Generator; other barcode types are implemented in the same way. Each barcode type implemented will need its own application pool and a separate application.

  1. Copy all of the files from the "Streaming API .NET 8+" folder of the zip file to a folder named "qrcode" from the root of the website.
  2. In IIS Manager, right-click on Application Pools and create an Application Pool. Name it "IDAutomation QRCode Generator", choose No Managed Code and Integrated Managed pipeline mode.
    In IIS right-click on Application Pools and create an Application Pool
  3. In IIS Manager, select the qrcode folder, and choose Convert to Application.
    QRCode Convert to Application IIS
  4. Within the properties of the IIS Application, select the "IDAutomation QRCode Generator" Application Pool. In a production system with heavy usage, implement the IIS Application Pool Streaming Best Practices.
    Within the properties of the IIS Application, select the "IDAutomation QRCode Generator" Application Pool
  5. Access the URL from the root of the website to view the generated barcode. For example, https://www.yoursite.com/qrcode/idautomation-qrcode?D=Hello_World&X=4 would generate a QR Code encoding the data of Hello_World with an X of 4. Additional parameters may be added as necessary from the information provided below. The following URLs may be opened in the browser to view the streamed image:
    • /idautomation-aztec
    • /idautomation-datamatrix
    • /idautomation-dotcode
    • /idautomation-maxicode
    • /idautomation-linear
    • /idautomation-pdf417
    • /idautomation-qrcode
    • /idautomation-qrenh  (Enhanced QR is currently in development, beta testing available upon request)

Common Streaming Parameters

NOTE: If linear barcodes are difficult to scan on screen, try increasing the Q and X values incrementally until the barcodes can be scanned. Printing the barcodes to PDF or a printer will scan without increasing those values.

  • Apply Tilde | Process Tilde (PT): When True, several ApplyTilde Options are enabled. (Default: T)
  • Data Encoded (D): The data that is to be encoded in the barcode. 
  • Image Type (I): The image type streamed. Valid values are BMP, PNG, JPEG, GIF, or font text (FT), as listed below. (Default: PNG) *
      FT - returns text for the IDAutomation 2D font with the common CR and LF for a new line.
      FTLF - returns text for the IDAutomation 2D font with only the LF included for a new line.
      FTBR - returns text for the IDAutomation 2D font with <BR> for a new line, useful in HTML.
      UI - returns text in Unicode Image format for use with a monospaced font such as Courier New.
    • Dotcode and the enhanced QRCode have slightly different parameters; see their specific sections for more information.
  • Orientation (O): The orientation of the barcode. Valid values are 0, 90, 180, and 270. (Default: 0)
  • Quiet Zone (Q): The margin around the symbol. (Default: 1)
  • XDimension (X): The size of the smallest module in the symbol. When X < 1, the value is in CM; when X >= 1, the value is in pixels. 1 pixel = 1/96 of an inch. Default is 1 for linear barcode types and 2 for 2D barcode types such as QR Code, PDF417, and Data Matrix.

Linear Specific

  • Symbology ID (S): Select which linear barcode type to display. Valid values are: 0 (Code 39), 1 (Code 128), 2 (ITF). (Default: 1)
  • Character Set (CS): The set of characters to be used for Code 128. Valid values are: 0 (Auto), 1 (A), 2(B), 3(C). (Default: 0)
  • Bar Height (BH): The barcode height in CM. (Default: 1)
  • ShowText (ST): If set to F, the human-readable text interpretation will not be displayed. (Default: F)
  • Check Character (CC): Automatically adds the check digit to the barcode when equal to "T". (Default: T for ITF and F for C39)
  • Check Character in Text (CT): Automatically adds the check digit that is encoded in the barcode to the human-readable text when equal to "T". (Default: T)
  • Font Size (FS): The font size used for human-readable text. (Default: 12)

Aztec Specific

  • Error Correction Level (ECL): The Reed-Solomon error correction level encoded in the symbol, specified as a value from 1 to 99. More error correction creates a larger symbol that can withstand more damage. The default setting of 0 performs automatic selection, which is usually a value of 23. (Default: 0)

Data Matrix Specific

  • Encoding Mode (MODE): Sets the mode for data being encoded (-1=Auto, 0=BASE256, 1=C40, 2=TEXT, 3=ASCII). (Default: -1)
  • Preferred Format (PFMT): Sets the preferred format represented by a number from 1 to 29; '0' is for automatic formatting. Format 29 is 16x48. (Default: 0)

PDF417 Specific

  • Columns (COL): The number of data columns in the symbol; 0 = automatic. (Default: 0)
  • Rows (ROWS): Sets the number of rows. It is recommended to leave this property at 0, the default. (Default: 0)
  • Error Correction Level (ECL): The amount of error correction in the symbol; 0 = automatic. (Default: 0)
  • Mode (MODE): The mode of compaction used; "Binary" for Binary or "Text" for TEXT. (Default: Binary)
  • Truncation (TRN): If True, creates a more area-efficient truncated PDF417 symbol. (Default: F)

QR-Code Specific

  • Error Correction Level (ECL): The level of error correction. Valid values are L, M, Q, and H. (Default: M)
  • Encoding Mode (MODE): The mode used to encode data. Valid values are X (Auto), B (binary), A (alphanumeric), and N (numeric). (Default: X)
  • Process Mask (BM): When set to F, the mask is not optimized, which improves processing time. (Default: T)
  • Version (V): The version of the symbol; setting this to -4 can generate a Micro QR Code. (Default: 1)

QRCode Enhanced Specific (QREnh)

The Enhanced QR Code allows for users to create custom qr-codes, with the use of their own logos, or brand colors. Explore rounded eyes or modules through our newly added parameters. Only available in PNG at this time, font text will return but without the extra cosmetic enhancements (logo, colors, etc).

  • Error Correction Level (ECL): The level of error correction. Valid values are L, M, Q, and H. (Default: M)
  • Encoding Mode (MODE): The mode used to encode data. Valid values are X (Auto), B (binary), A (alphanumeric), and N (numeric). (Default: X)
  • Process Mask (BM): When set to F, the mask is not optimized, which improves processing time. (Default: T)
  • Version (V): The version of the symbol; setting this to -4 can generate a Micro QR Code. (Default: 1)
  • ForeGround (FG): Changes the foreground color of the QR-Code, use hex colors (Default: #000000)
  • BackGround (BG): Changes the background color of the QR-Code, use hex colors (Default: #FFFFFF)
  • Eye ForeGround (EYEFG): Changes the foreground color of the QR-Code eyes, use hex colors (Default: null)
  • Eye BackGround (EYEBG): Changes the background color of the QR-Code eyes, use hex colors (Default: null)
  • Rounded Modules (RM): Changes modules to be rounder in apperance when set to RM=R (Default: null)
  • Rounded Eyes (EYE): Changes eyes to be rounder in apperance when set to EYE=R (Default: null)
  • Logo (LOGO): Path to image or url to image (Default: null)
  • Logo Size (LS): Set in a float, used to set the image size in the QR-Code (Default: LS=.20) Always ensure the qr-code is scannable, if the logo is too large it may be unscannable, consider setting the qr-code to a higher ECL, example: ECL=H.

DotCode Specific

  • Ratio (RATIO): The aspect ratio is set with a two-digit number where the first number is for columns and the second for rows. The default ratio is 2:1, which means 2 times more columns than rows. (Default: 21)
  • Imagetype (I):The image type streamed. Valid values are BMP, PNG, JPEG, GIF, FT, or as listed below. (Default: PNG)
    • 0 returns FontText in lowercase
    • 1 returns FontText in uppercase
    • 2 returns Unicode
    • 3 returns the dots as diamonds

MaxiCode Specific

  • Encoding Mode (M):The mode of compression and encoding used in the symbol. Modes 2 and 3 are designed for use in the transport industry. Mode 4 encodes up to 93 characters or 138 digits. Mode 5 encodes up to 77 characters and provides more error correction capabilities than mode 4. Mode 6 indicates that the symbol encodes a message used to program a reader system (scanner).(Default: 2)
  • Dot Per Millimeter (DOTPM): Defines the size of each module. (Default: 8)

Support

For testing purposes, IDAutomation offers the Barcode Decoder Verification App. This app is particularly useful in verifying lower ASCII codes, GS1 data, and UTF-8 Unicode encoding.

Free product support may be obtained by reviewing resolved .NET Public Forum Threads. Level 2 Priority Support is provided up to 30 days after purchase. Additional Priority Support may be obtained if the Priority Support and Upgrade Subscription is active.

To resolve most issues, refer to the examples provided in the download package and use a process of elimination to find the solution.

NOTE: Portions of this product utilize IDAutomation USA Patent 7,637,436.