What is it?
The “Quick Setup” button displayed on the start screen provides a quick way to setup an iPad simply by scanning a QR code. The QR code can be used to log the Device in, to download a set of events to the Device and to automatically run the first event. This can be an ideal way to run “Ship Out” photo booths (where you can pre-ship a booth, and email a QR code to setup), or for White Label partners to configure a Photo Booth to your requirements.
In this Guide
- Encrypted QR codes
- Less Secure QR codes
- Appearance
- Generating QR codes for Quick Setup
- QR code quality
- Saving the QR code
- QR code overlay
- Base URL
- Syncing the Event
- Run After Syncing
- Auto Login
- Expiry
- Generating Admin QR codes via the Command Line
Encrypted QR codes
The QR codes are encrypted and can be optionally setup so that they will only work on one particular iPad. This means that a QR code containing login information can be safely used by operators or sent to clients without them being able to see information such as the password. Secure, encrypted QR codes can only be generated using the Event Editor – either using the “Admin QR Code Generator” dialog or the command line interface.
Less Secure QR Codes
Less secure plain text QR codes which can be generated on a website or as part of a CRM system can also be used.
Appearance
The appearance of the quick setup page can be customized by creating background and/or overlay screen images. Please see Customizing the Start Screen and Removing Branding for details.
Generating QR Codes for Quick Setup
The QR codes used for quick setup are generated using the “Admin QR Code Generator” tool in the Event Editor. Select “QR code generator…” from the File menu in the Event Editor to open the “Admin QR Code Generator” tool.
QR Code Quality
The QR code quality can be set using the “QR Code quality” dropdown list. The low or medium setting should be fine for most applications but you may need to increase the quality if you add an overlay image to the QR code.
Saving the QR Code
The generated QR code can be saved as a PNG image by clicking in the “Save as PNG…” button. This will save the QR code as a PNG file which is 500 × 500 pixels in size.
QR Code Overlay
An optional overlay can be added to the QR code to provide branding by entering the filename in the “Overlay:” edit box or by clicking on the “…” button to open a file browser.
The overlay should be a PNG image which is 500 × 500 pixels in size with a transparent background and the logo placed in the center.
The overlay should not cover too much of the QR code otherwise it may not work. More of the QR code can be covered if the QR code quality is set to a higher setting.
Base URL
The base URL is the URL that would be loaded into a web browser if a user scanned the QR code with their phone (ie, not in Breeze). Set this to a suitable location, e.g. your website’s home page, in case a user scans the QR code outside of Breeze Booth.
Syncing the Event
The admin QR code can be used to automatically sync the iPad using HTTP GET, HTTP POST or Dropbox.
- HTTP GET = quickest and simplest, but less secure.
- HTTP POST or Dropbox = more secure.
Run After Syncing
Select “Run event after syncing” to automatically run the first event after syncing the events.
Auto Login
The Admin QR code can also be used to automatically log the iPad in by entering the username and password. The username and password should correspond to a user defined in the Online Account.
- The QR code is encrypted so passwords are not exposed.
- Optionally restrict QR code use by vendor ID.
Expiry
An admin QR code can also be given an expiry time after which it cannot be used.
- Select the “Expiry” checkbox and define a date/time.
- If the QR code contains login info and an expiry, the iPad will auto log out once expired (app must be foreground).
Generating Admin QR Codes via the Command Line
Admin QR codes can be generated using the Event Editor with command line arguments:
| Parameter | Description |
|---|---|
| -qr_path | Where to save the PNG image of the QR code |
| -qr_base_url | The base URL |
| -qr_username | Username for login |
| -qr_password | Password for login |
| -qr_sync_method | Sync method: GET, POST or Dropbox |
| -qr_sync_url | Sync URL for GET or POST |
| -qr_post_password | Optional POST password |
| -qr_dropbox_prefix | Dropbox prefix |
| -qr_auto_run | Auto run the first event after updating |
| -qr_expiry | Expiry time (Unix epoch seconds) |
| -qr_vendor_id | Optional vendor id |
| -qr_logo_path | Path to logo PNG overlay |
Example:
BreezeBoothEventEditor.exe -qr_username “test_user” -qr_password “test_user_password” -qr_path “D:\qr_code.png”
Less secure plain text QR codes
Plain text QR codes can be generated externally (CRM, website). They are disabled by default but can be enabled in settings.xml:
true
- Use parameter “admin” containing URL-encoded JSON commands.
- Example: https://breezesys.com?admin=
Examples of JSON commands
- Sync via GET: { “sync”: “https://bb4ipad.com/sync” }
- Sync via POST: { “post”: “https://mysite.com/sync_script.php” }
- Sync via Dropbox: { “dropbox”: “prefix” }
- Autorun: { “autorun”: 1 }
- Expiry: { “expiry”: 1594913923 }
- Status URL: { “statusUrl”: “https://mysite.com/webhook.php” }
- Event Name: { “en”: “The Event Name” }
- Limit to iPad: { “id”: “ABCDEF123456QWERTY123” }
Example URL
Sync via GET and autorun first event:
{ “sync”: “https://bb4ipad.com/sync”, “autorun”: 1 }
URL encoded:
%7B%20%22sync%22%3A%20%22https%3A%2F%2Fbb4ipad.com%2Fsync%22%2C%20%22autorun%22%3A%201%20%7D
Final URL:
https://breezesys.com?admin=%7B%20%22sync%22%3A%20%22https%3A%2F%2Fbb4ipad.com%2Fsync%22%2C%20%22autorun%22%3A%201%20%7D
Logging in an iPad
Logging in is not supported via plain text QR codes (since passwords are sensitive). Use secure encrypted QR codes from the Event Editor if login is required.
Post your comment on this topic.