Ruby Requires Chilkat v11.7.0+

QR Code with Non-English Text (UTF-8 and ECI)

See more QR Code Examples

Demonstrates text outside ASCII. QrCode always stores text as UTF-8 bytes, which is what phones expect. A QR code can also say so explicitly with an ECI header: setting encoding.eci to 26 declares the bytes to be UTF-8, for readers that would otherwise assume another character set. The header costs a little space, and a few older readers do not understand it, so it is off by default. Ruby

require 'chilkat'

success = false

#  This example requires the Chilkat API to have been previously unlocked.
#  See Global Unlock Sample for sample code.

#  The text is "Gruesse aus Muenchen" written with u-umlaut and sharp s.  It is given here with
#  JSON escapes only so that this source is plain ASCII.  Decode turns the escapes into characters.
sbText = Chilkat::CkStringBuilder.new()
sbText.Append("Gr\u00fc\u00dfe aus M\u00fcnchen")
sbText.Decode("json","utf-8")

json = Chilkat::CkJsonObject.new()
json.UpdateSb("payload.text",sbText)
json.UpdateString("output.path","qa_output/qr_utf8.png")
json.UpdateBool("output.overwrite",true)
json.UpdateString("output.return","none")

fmt = Chilkat::CkFormats.new()
jsonOut = Chilkat::CkJsonObject.new()
success = fmt.QrCode("generate",json,jsonOut)
if (success == false)
    print fmt.lastErrorText() + "\n";
    exit
end

#  17 characters, three of which take two bytes in UTF-8.
print "characters: " + sbText.get_Length().to_s() + "\n";
print "bytes encoded: " + jsonOut.IntOf("symbols[0].payloadBytes").to_s() + "\n";
print "ECI header: " + jsonOut.HasMember("symbols[0].selectedEncoding.eci").to_s() + "\n";

#  Without an ECI header (qa_output/qr_utf8.png):

#  

#  The same text with an ECI header declaring UTF-8.
json.UpdateInt("encoding.eci",26)
json.UpdateString("output.path","qa_output/qr_utf8_eci.png")
success = fmt.QrCode("generate",json,jsonOut)
if (success == false)
    print fmt.lastErrorText() + "\n";
    exit
end

print "with encoding.eci = 26, ECI header: " + jsonOut.HasMember("symbols[0].selectedEncoding.eci").to_s() + ", value " + jsonOut.IntOf("symbols[0].selectedEncoding.eci").to_s() + "\n";

#  With the ECI header (qa_output/qr_utf8_eci.png).  Both scan as the same text:

#  

#  Sample output:

#  characters: 17
#  bytes encoded: 20
#  ECI header: False
#  with encoding.eci = 26, ECI header: True, value 26