History

Stefan Hutter 9c13c94f74 Initial commit		5 years ago
..
.github	Initial commit	5 years ago
QRCoder	Initial commit	5 years ago
QRCoderConsole	Initial commit	5 years ago
QRCoderDemo	Initial commit	5 years ago
QRCoderDemoUWP	Initial commit	5 years ago
QRCoderTests	Initial commit	5 years ago
VBDemo	Initial commit	5 years ago
.gitattributes	Initial commit	5 years ago
.gitignore	Initial commit	5 years ago
CheckBinaries.bat	Initial commit	5 years ago
Compile.bat	Initial commit	5 years ago
Compile_Single.bat	Initial commit	5 years ago
LICENSE.txt	Initial commit	5 years ago
MyGet.bat	Initial commit	5 years ago
QRCoder.NETCore20.sln	Initial commit	5 years ago
QRCoder.nuspec	Initial commit	5 years ago
QRCoderPackageBuild.sln	Initial commit	5 years ago
QRCoderProject.NET40.sln	Initial commit	5 years ago
QRCoderProject.NETCore.sln	Initial commit	5 years ago
QRCoderProject.Portable.sln	Initial commit	5 years ago
QRCoderProject.sln	Initial commit	5 years ago
QRCoderProject.sln.DotSettings	Initial commit	5 years ago
readme.md	Initial commit	5 years ago

readme.md

QRCoder

Info

QRCoder is a simple library, written in C#.NET, which enables you to create QR codes. It hasn't any dependencies to other libraries and is available as .NET Framework and .NET Core PCL version on NuGet.

Feel free to grab-up/fork the project and make it better!

For more information see: QRCode Wiki | Creator's blog (english) | Creator's blog (german)

Legal information and credits

QRCoder is project by Raffael Herrmann and was first released in 10/2013. It's licensed under the MIT license.

Installation

Either checkout this Github repository or install QRCoder via NuGet Package Manager. If you want to use NuGet just search for "QRCoder" or run the following command in the NuGet Package Manager console:

PM> Install-Package QRCoder

Note: The NuGet feed contains only stable releases. If you wan't the latest build add one of the following urls to the "Package Sources" of Visual Studio's NuGet Package Manager options.

NuGet V3 feed URL (Visual Studio 2015+): https://www.myget.org/F/qrcoder/api/v3/index.json

NuGet V2 feed URL (Visual Studio 2012+): https://www.myget.org/F/qrcoder/api/v2

Usage

You only need five lines of code, to generate and view your first QR code.

QRCodeGenerator qrGenerator = new QRCodeGenerator();
QRCodeData qrCodeData = qrGenerator.CreateQrCode("The text which should be encoded.", QRCodeGenerator.ECCLevel.Q);
QRCode qrCode = new QRCode(qrCodeData);
Bitmap qrCodeImage = qrCode.GetGraphic(20);

Optional parameters and overloads

The GetGraphics-method has some more overloads. The first two enable you to set the color of the QR code graphic. One uses Color-class-types, the other HTML hex color notation.

//Set color by using Color-class types
Bitmap qrCodeImage = qrCode.GetGraphic(20, Color.DarkRed, Color.PaleGreen, true);

//Set color by using HTML hex color notation
Bitmap qrCodeImage = qrCode.GetGraphic(20, "#000ff0", "#0ff000");

The another overload enables you to render a logo/image in the center of the QR code.

Bitmap qrCodeImage = qrCode.GetGraphic(20, Color.Black, Color.White, (Bitmap)Bitmap.FromFile("C:\\myimage.png"));

There are a plenty of other options. So feel free to read more on that in our wiki: Wiki: How to use QRCoder

Special rendering types

Besides the normal QRCode class (which is shown in the example above) for creating QR codes in Bitmap format, there are some more QR code rendering classes, each for another special purpose.

(*) - These classes are only available in the .NET Framework/.NET Standard version. If you use the PCL version (e.g. for Universal apps), you have to use either BitmapByteQRCode or PngByteQRCode classes.
(**) - This class is hosted in an own package (QRCoder.Unity).

For more information about the different rendering types click on one of the types in the list above or have a look at: Wiki: Advanced usage - QR-Code renderers

PayloadGenerator.cs - Generate QR code payloads

Technically QR code is just a visual representation of a text/string. Nevertheless most QR code readers can read "special" QR codes which trigger different actions.

For example: WiFi-QRcodes which, when scanned by smartphone, let the smartphone join an access point automatically.

This "special" QR codes are generated by using special structured payload string, when generating the QR code. The PayloadGenerator.cs class helps you to generate this payload strings. To generate a WiFi payload for example, you need just this one line of code:

PayloadGenerator.WiFi wifiPayload = new PayloadGenerator.WiFi("MyWiFi-SSID", "MyWiFi-Pass", PayloadGenerator.WiFi.Authentication.WPA);

To generate a QR code from this payload, just call the "ToString()"-method and pass it to the QRCoder.

//[...]
QRCodeData qrCodeData = qrGenerator.CreateQrCode(wifiPayload.ToString(), QRCodeGenerator.ECCLevel.Q);
//[...]

You can also use overloaded method that accepts Payload as parameter. Payload generator can have QR Code Version set (default is auto set), ECC Level (default is M) and ECI mode (default is automatic detection).

//[...]
QRCodeData qrCodeData = qrGenerator.CreateQrCode(wifiPayload);
//[...]

Or if you want to override ECC Level set by Payload generator, you can use overloaded method, that allows setting ECC Level.

//[...]
QRCodeData qrCodeData = qrGenerator.CreateQrCode(wifiPayload, QRCodeGenerator.ECCLevel.Q);
//[...]

You can learn more about the payload generator in our Wiki.

The PayloadGenerator supports the following types of payloads: