Click here to Skip to main content
14,459,279 members

Just Launched a New Open Source Project QrCode.Net at http://qrcodenet.codeplex.com

Rate this:
4.86 (7 votes)
Please Sign up or sign in to vote.
4.86 (7 votes)
22 Sep 2011CPOL
Just launched a new open source project QrCode.Net at http://qrcodenet.codeplex.com

Background

Recently, I was looking for a .NET implementation of QR code generator. Most of the components either use online services to generate and/or recognize QR code or the implementation was not “good enough” for my purposes. The most popular and very powerful Java implementation comes from Google’s open source project code.google.com/p/zxing called ZXing (Zebra Crossing => Z=Zebra + X=Cross + ing).

There I found a one-to-one c# port of earlier version. The project is focusing on additional features and further development in Java so it seems that no one is taking care of C# branch.

Thus, I have decided to set-up this project QRCode.Netqrcodenet.codeplex.com.

As a start point, I took a straight forward C# port of Google’s QR code implementation from ZXing project.
I wrote a wrapper around and a demo application which is able to generate QR code from text as you type and save it to file.

In addition, it contains a very naive and simple implementation of Artistic QR code generation. At the highest error correction level, it is possible to create artistic QR codes that still scans correctly, but contains intentional errors to make them more readable or attractive to the human eye, as well as to incorporate colors, logos and other features into the QR code block.

Image 1

Using the Library

If you cannot wait to try it out, just download the source or binaries and follow this short guide.

First of all, add a reference to the project or assembly _Gma.QrCodeNet.Encoding_ and import the namespace.

using Gma.QrCodeNet.Encoding;

Sample 1

Encoding text to QR code bit matrix and printing out the result to console:

Console.Write(@"Type some text to QR code: ");
string sampleText = Console.ReadLine();
QrEncoder qrEncoder = new QrEncoder(ErrorCorrectionLevel.M);
QrCode qrCode = qrEncoder.Encode(sampleText);
for (int j = 0; j < qrCode.Matrix.Width; j++)
{
    for (int i = 0; i < qrCode.Matrix.Width; i++)
    {
       char charToPrint = qrCode.Matrix[i, j] ? '¦' : ' ';
       Console.Write(charToPrint);
    }
    Console.WriteLine();
}
Console.WriteLine(@"Press any key to quit.");
Console.ReadKey();

Tada!

Image 2

Sample 2

Rendering QR code to graphics, let’s say to panel control with segment size of 5 pixel, blue on yellow and 10 pixel padding:

using Gma.QrCodeNet.Rendering;

const string helloWorld = "Hello World!";

QrEncoder qrEncoder = new QrEncoder(ErrorCorrectionLevel.H);
QrCode qrCode = qrEncoder.Encode(helloWorld);

const int moduleSizeInPixels = 5;
Renderer renderer = new Renderer(moduleSizeInPixels, Brushes.Blue, Brushes.Yellow);

Panel panel = new Panel();
Point padding =  new Point(10,16);
Size qrCodeSize = renderer.Measure(qrCode.Matrix.Width);
panel.AutoSize = false;
panel.Size = qrCodeSize + new Size(2 * padding.X, 2 * padding.Y);

using (Graphics graphics = panel.CreateGraphics())
{
    renderer.Draw(graphics, qrCode.Matrix, padding);
}

Sample 3

Using out-of-the-box WinForms control. Just drag & drop it to your form an set Text and AutoSize property:

Image 3

Sample 4

Saving QR code to file:

QrEncoder qrEncoder = new QrEncoder(ErrorCorrectionLevel.H);
QrCode qrCode = qrEncoder.Encode("Hello World!");

Renderer renderer = new Renderer(5, Brushes.Black, Brushes.White);
renderer.CreateImageFile(qrCode.Matrix, @"c:\temp\HelloWorld.png", ImageFormat.Png);

Project TODOs and Plans

I think this project would be a good playground for:

  1. Understanding QR code form inside
  2. Designing and implementing efficient and elegant data structures and algorithms. I have looked at the ZXing codebase, especially encoding. The code is good, but there are still many things to improve. Furthermore, the automated Java to C# converter produced a lot of mess.
  3. Refactoring and rewriting code in a TDD manner – the existing implementation can be used as an excellent refactoring initial point. In some cases, I think I would prefer to rewrite and use old classes as reference implementations and run my test again, both the old and the new code.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

George Mamaladze
Software Developer
Germany Germany
Tweeter: @gmamaladze
Google+: gmamaladze
Blog: gmamaladze.wordpress.com

Comments and Discussions

 
GeneralYou look just like Robert Picardo :) Pin
strogg7-Nov-15 20:21
Memberstrogg7-Nov-15 20:21 
QuestionJavaScript implementation Pin
Kathrene73-Jul-15 3:18
MemberKathrene73-Jul-15 3:18 
Questionsaved image with right and bottom border Pin
Member 1137750315-Jan-15 4:36
MemberMember 1137750315-Jan-15 4:36 
AnswerRe: saved image with right and bottom border Pin
Christopher Enengl22-Feb-16 5:46
MemberChristopher Enengl22-Feb-16 5:46 
QuestionAbout dll file and project Pin
lepteo144-Mar-14 21:41
Memberlepteo144-Mar-14 21:41 
QuestionUTF-8 Charset Pin
m_reshadi8-Nov-13 12:44
Memberm_reshadi8-Nov-13 12:44 
QuestionIt dosen't work in Chinese Pin
bruce_wang20018-Aug-13 10:19
Memberbruce_wang20018-Aug-13 10:19 
SuggestionFully test your artistic QR Code before publishing! Pin
mic212-May-13 7:26
Membermic212-May-13 7:26 
GeneralRe: Fully test your artistic QR Code before publishing! Pin
priyanga@y7mail.com4-Sep-13 3:38
Memberpriyanga@y7mail.com4-Sep-13 3:38 
Questionsample code for generating QR Code Pin
fdgsasfsd5-Feb-13 16:56
Memberfdgsasfsd5-Feb-13 16:56 
QuestionvCard Support? Pin
i0030-Jan-13 18:57
Member i0030-Jan-13 18:57 
GeneralMy vote of 4 Pin
Burak Tunçbilek12-Jun-12 3:44
MemberBurak Tunçbilek12-Jun-12 3:44 
QuestionDecoding QR Code Pin
LaunaSere9-Mar-12 17:06
MemberLaunaSere9-Mar-12 17:06 
QuestionIndex out of range exception Pin
LaunaSere28-Jan-12 3:52
MemberLaunaSere28-Jan-12 3:52 
GeneralMy vote of 4 Pin
wvd_vegt13-Oct-11 8:26
professionalwvd_vegt13-Oct-11 8:26 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Technical Blog
Posted 22 Sep 2011

Tagged as

Stats

86.1K views
42 bookmarked