Ruby Requires Chilkat v11.7.0+

Create a Wi-Fi QR Code

Demonstrates a QR code that joins a phone to a Wi-Fi network when scanned. A QR code only holds text. Phones recognize text of the form WIFI:T:;S:;P:;; and offer to join the network. T is WPA (also used for WPA2 and WPA3), WEP, or nopass for an open network, and H:true can be added for a hidden network. In the name and the password, the characters backslash, semicolon, comma, colon and double quote must each be preceded by a backslash.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

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

json = Chilkat::CkJsonObject.new()
json.UpdateString("payload.text","WIFI:T:WPA;S:Chilkat Guest;P:correct-horse-battery-staple;;")

#  Level Q, so that the code still scans when it is printed small or gets worn.
json.UpdateString("encoding.qr.errorCorrection","Q")
json.UpdateInt("render.moduleSize",8)

#  Say which network it is under the code.
json.UpdateBool("render.text.enabled",true)
json.UpdateString("render.text.value","Wi-Fi: Chilkat Guest")
json.UpdateInt("render.text.scale",2)

json.UpdateString("output.path","qa_output/qr_wifi.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

print "file: " + jsonOut.stringOf("outputs[0].path") + "\n";
print "QR version: " + jsonOut.IntOf("symbols[0].selectedEncoding.version").to_s() + "\n";
print "image: " + jsonOut.IntOf("outputs[0].width").to_s() + " x " + jsonOut.IntOf("outputs[0].height").to_s() + " pixels" + "\n";

#  The image written to qa_output/qr_wifi.png:

#  

#  Sample output:

#  file: qa_output/qr_wifi.png
#  QR version: 5
#  image: 360 x 374 pixels