Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


license release

AwesomeQRCode in this repository was written in Kotlin.

Take a look at original version written in Java.


Special, thus awesome.

Add dependency into your project

Add below lines in build.gradle of your project:

allprojects {
	repositories {
		maven { url '' }

Then, add below lines in build.gradle of your app module:

dependencies {
        compile 'com.github.SumiMakito:AwesomeQRCode-Kotlin:1.0.5'

Quick start

"I just wanna get a Bitmap":

In this case, QR code will be generated synchronously. Thus it means you may take a risk blocking the UI thread, which would lead to Application Not Responding (ANR). I strongly recommend you to use it in a non-UI thread.

Thread{ {
  var qrCode: Bitmap = AwesomeQRCode.Renderer().contents(contents).size(800).margin(20).render()

Generate a QR code asynchronously and show the QR code in an ImageView:

 .renderAsync(object : AwesomeQRCode.Callback {
  override fun onRendered(renderer: AwesomeQRCode.Renderer, bitmap: Bitmap) {
   // Tip: here we use runOnUiThread {...} to avoid the problems caused by operating UI elements from a non-UI thread.
   runOnUiThread {
   override fun onError(renderer: AwesomeQRCode.Renderer, e: Exception) {


Parameter Type Explanation Default Value Misc.
contents String Contents to encode. null Required
size int-px Width as well as the height of the output QR code, includes margin. 800 Required
margin int-px Margin to add around the QR code. 20 Required
dataDotScale float Value used to scale down the data dots' size. 0.3f (0, 1.0f)
colorDark int-color Color of "true" blocks. Works only when both colorDark and colorLight are set. Color.BLACK
colorLight int-color Color of empty space, or "false" blocks. Works only when both colorDark and colorLight are set. Color.WHITE
background Bitmap Background image to embed in the QR code. Leave null to disable. null
whiteMargin int-px If set to true, a white border will appear around the background image. true
autoColor boolean If set to true, the dominant color of backgroundImage will be used as colorDark. true
binarize boolean If set to true, the whole image will be binarized with the given threshold, or default threshold if not specified. fasle
binarizeThreshold int Threshold used to binarize the whole image. 128 (0, 255)
roundedDataDots boolean If set to true, data dots will appear as solid dots instead of blocks. false
logo Bitmap Logo image to embed at the center of generated QR code. Leave null to disable. null
logoMargin int-px White margin that appears around the logo image. Leave 0 to disable. LOGO 10
logoCornerRadius int-px Radius of the logo's corners. Leave 0 to disable. 8
logoScale float Value used to scale the logo image. Larger value may result in decode failure. 0.2f (0, 1.0f)


Version 1.0.5

  • The way to use AwesomeQRCode is more elegant.

Version 1.0.4

  • New feature: Embedding a logo image in the QR code.
  • Sample/Demo application updated.

Version 1.0.3

  • Added CHARACTER_SET => UTF-8 to QR code's hints before encoding.
  • Fixed an encoding issue mentioned in #7.

Version 1.0.2

  • Added an optional parameter which enables the data dots to appear as filled circles.

Version 1.0.1

  • Now background images can be binarized as you like.

Version 1.0.0

  • Initial release.


EFQRCode written in Swift

EFQRCode is a tool to generate QRCode image or recognize QRCode from image, in Swift.

AwesomeQRCode is inspired by EFQRCode by EyreFree.

If your application is in need of generating pretty QR codes in Swift, take a look at EFQRCode. It should help.

Awesome-qr.js written in JavaScript

Redirect to Awesome-qr.js

Would you like to buy me a cup of cappuccino?

PayPal Alipay
PayPal Alipay

Copyright & License

Copyright © 2017 Sumi Makito

Licensed under Apache License 2.0 License.

Copyright 2017 Sumi Makito

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.