QR Code Access Control

The QR Code Keypad function allows Thinknx Up to be used as an access control keypad. When the QR Code associated with an access point is scanned, Thinknx Up automatically opens the keypad for the configured project and checker. The user can then enter their PIN to request access.

The QR Code identifies the project and access point, while authorization is determined by the entered PIN and its settings: user status, role, permitted areas, validity period, and weekly schedule.

1. An Access Control object is created and configured in the Configurator.
2. A prototype using QR Code Keypad technology is created and associated with the Integration Kit API key.
3. A checker, representing the physical access point, is configured by specifying the commands to execute for a valid or invalid code.
4. The corresponding QR Code is generated and exported from the checker.
5. The user(with the app and the project on his mobile device) scans the QR Code with their mobile device and opens the keypad in Thinknx Up.
6. Thinknx verifies the entered PIN and executes the configured command if the request is authorized.

Before proceeding, make sure the following are available:

• a Thinknx project containing an Access Control system object;
• a Thinknx server correctly configured and associated with the project;
• the Integration Kit enabled on the server page and a valid API key;
• the Thinknx Up application installed on the mobile device used for scanning;
• at least one enabled access user with a valid PIN and permission for the relevant area;
• a data connection on the device when required by the link embedded in the QR Code.

Open the project in Thinknx Configurator and go to:

System > Security > Access Control

Create a new object or select the Access Control object already included in the project. Then configure the parameters that determine keypad behavior and PIN rules.

Also configure any time-related parameters and other access control options required by the installation.

Within the Access Control object, open the Keypad Prototypes collection and add a new prototype.

1. Assign a clear, recognizable name to the prototype.
2. Under Technology, select QR Code Keypad.
3. Enter the API key generated after enabling the Integration Kit on the project server page in the corresponding field.
4. Save the configuration.

The prototype defines the connection between the QR Code keypad and the integration used to identify and authorize the request. The same prototype can be used by one or more checkers.

The checker represents the physical access point, such as a door, gate, or entrance. Each checker uses the configured prototype and determines which command is executed according to the verification result.

Open the Checkers collection and add a new item:

1. assign an identifying name to the checker;
2. select the previously created QR Code Keypad prototype;
3. configure Command if success, the command to execute when the PIN is accepted;
4. if necessary, configure Command if fail, the command to execute when the request is rejected;
5. save the configuration.

Where required by the project structure, associate the checker or entrance door with the relevant areas.

In the checker configuration, select Show QR code to open the window containing the QR Code for that specific access point.

The following options are available:

Place the exported QR Code near the corresponding access point. Make sure it is sufficiently large, has good contrast, is protected, and can be easily read by the mobile device camera.

Access control users are managed through the Access Control Manager. You can use an existing code or create a new user with a dedicated PIN.

In Thinknx Up:

1. open Project Properties;
2. select Manage Access Control;
3. locate the code you want to use in the list;
4. make sure the user is enabled;
5. check that the role and authorized areas are consistent with the configured checker.

The PIN associated with the user can be entered on the keypad displayed after scanning the QR Code.

If no suitable code is available, open Access Control Manager and select the + button.

Configure the following information:

1. user name;
2. Enabled status;
3. assigned role;
4. areas the user is authorized to access;
5. numeric PIN;
6. card code use, if required;
7. validity period, if required;
8. weekly schedule, if required.

Confirm with the check mark to save the user.

1. Open the Camera application on the mobile device.
2. Point the camera at the QR Code exported from the checker.
3. Wait for the application link to appear.
4. Select Open in Thinknx Up.
5. Thinknx Up opens the keypad associated with the project and checker identified by the QR Code.

Enter the complete PIN using the displayed keypad. When the code is recognized as valid, the indicators turn green. If required, press the green > button to confirm.

The checker then executes the command configured under Command if success.

The request may be validated against all the following conditions:

• the user is enabled;
• the PIN is correct and has the required length;
• the assigned role;
• authorization for the checker area;
• the validity period;
• the weekly schedule.

If the entered code is incorrect or is not authorized at that time, the indicators turn red and the opening command is not executed.

In this case:

1. check the PIN and the required number of digits;
2. make sure the user is enabled;
3. check the assigned role and areas;
4. check the validity period and weekly schedule;
5. if configured, check the behavior of Command if fail.

Thinknx Up can store the project code locally so the user does not need to enter it manually each time.

When the application reports that the project code has not been saved:

• select YES to save it;
• select NO to continue without saving it.

The saved code is associated with the current project.

To manage the locally saved code:

1. open Project Properties;
2. select Predefined ViaVai Code;
3. use the displayed keypad to replace or clear the code.

To replace the code, enter the new value and confirm with the green arrow.

To remove the code, clear all digits using the C button, leave the field empty, and confirm.

The Predefined ViaVai Code option may remain disabled until the project and access control configuration support the use of a predefined code.

After completing the configuration, perform a full test directly at the access point.

• The Access Control object is available under System > Security.
• Code length, available digits, and use of zero are configured correctly.
• The Integration Kit is enabled and the API key is valid.
• A QR Code Keypad prototype is available.
• The checker is associated with the correct prototype.
• Command if success and, if required, Command if fail are configured.
• The QR Code has been exported in PNG or SVG format and is stored securely.

• The user and PIN are enabled and authorized for the correct area.
• Scanning the QR Code prompts the device to open Thinknx Up.
• Scanning opens the keypad for the intended checker.
• A valid PIN produces the green confirmation and executes the success command.
• An invalid PIN is rejected and, if configured, executes the failure command.
• The code-saving prompt has been tested on a trusted device.
• The predefined code can be changed and removed from Project Properties.

Check:

• that the Integration Kit is enabled;
• that the API key is valid and entered in the correct prototype;
• that the checker uses the intended QR Code Keypad prototype;
• that Command if success is configured correctly;
• that the user is authorized for the area associated with the checker.

Check the Code numbers and Zero included parameters in the Access Control object. Also check Code length if the keypad does not accept the expected number of digits.

Check:

• the PIN length;
• whether the user is enabled;
• the assigned role;
• the authorized areas;
• the validity period;
• the weekly schedule.

If all valid PINs are rejected, also check the Integration Kit API key, the prototype selected by the checker, and the user configuration on the server.

• Use the original PNG or SVG file exported from the Configurator.
• Make sure the QR Code is sufficiently large and has adequate contrast.
• Avoid reflections, distortion, or low-quality printing.
• Do not use obscured, cropped, or modified images.
• Make sure the device recognizes the application links associated with Thinknx Up.

• Do not include API keys, configuration URLs, or operational QR Codes in public documents.
• Display the QR Code only at the intended access point.
• Promptly disable users who should no longer have access to the installation.
• Use roles, areas, validity periods, and schedules to restrict each PIN to the required scope only.
• If configuration material is disclosed without authorization, replace the affected credentials and regenerate the necessary items.