Test Tool Demo#

This page walks through validating Aliro reader functionality using the Connectivity Standards Alliance (CSA) Aliro Test Tool (user device) against the Aliro Minimal Reader and AliroMatterLock examples. See Build and Flash Example for project creation and programming steps.

Prerequisites#

  • Example firmware flashed to a supported EFR32MG24 or EFR32MG26 board (see Build and Flash Example)

  • Near Field Communication (NFC) or Bluetooth Low Energy (BLE) transport hardware connected per Hardware and Setup

  • CSA Aliro Test Tool — GitHub repository (requires CSA membership); refer to that repository for host setup instructions

  • Raspberry Pi 4 with Ubuntu Server 22.04.3 LTS (64-bit) or Ubuntu Server 22.04.4 LTS (64-bit)

  • For NFC: NXP OM27160B1 (Serial Peripheral Interface (SPI) based board) or OM27160A1 (Inter-Integrated Circuit (I2C) based)

  • For BLE: Murata LBUA0VG2BP-EVK-P

  • AliroMatterLock demos also require the Silicon Labs Matter extension and a Matter controller (for example chip-tool)

The Aliro configuration set used in both demos on this page corresponds to the Test Tool's default project configuration set.

Aliro Minimal Reader — Aliro Demo#

In this demo, the Aliro configuration is provisioned through the command-line interface (CLI) and the Aliro exchange is performed between the Aliro Minimal Reader and the CSA Aliro Test Tool (user device) over NFC or BLE.

Programming a Bootloader#

If building a solution, the bootloader is included and flashed as part of the combined artifact. If building the sample application on its own, a bootloader must be flashed separately before the application.

Steps for Execution#

  1. Build and flash the bootloader and application to your board.

  2. Connect to the Aliro Shell CLI over Universal Asynchronous Receiver-Transmitter (UART) and issue the following commands:

aliro clear-all
aliro reader-config-set priv-key 8aefdff8d5b47aa9a3edbac7a345ed2221021512fd55abde3b8ee0f208952693
aliro reader-config-set pub-key 043928f322019d4757893bde6a0fe5e13e3e537b9ca0f549c0bd2f40f79060252a0a4f291192157a95cb6eb202759428c00cd834998c5d0eab192ee8873c5d34ee
aliro reader-config-set group-id 00113344667799aa00113344667799aa
aliro reader-config-set sub-group-id 113344667799aa00113344667799aa00
aliro cred-add 1 04742df736d0fc9be978c45b00e8fdf7cea684ea105ae574c1505a2c24ab6198e3125b7f1b7e1d134c55ece69681ba8ecc18a3836dc5199c759f31e8ccf17e3efa evictable

  1. Using the Aliro Test Tool, run one of the Expedited Flow test cases: NFC_RDR_STANDARD_NO_CERT (NFC) or BLERKE_RDR_UNSECURE (BLE remote keyless entry (RKE)).

  2. In Aliro Shell, observe log messages recording the Aliro exchange and access being granted or denied.

AliroMatterLock — Matter DoorLock Demo#

Programming a Bootloader#

If building a solution, the bootloader is included and flashed as part of the combined artifact.

If building the sample application on its own, a bootloader must be flashed separately before the application. Pre-built bootloader binaries for all supported devices are available at Matter Bootloader Binaries.

Configuration and Setup#

This sample app works out of the box with no additional configuration required. To customize the device, see the Custom Matter Device Development guide.

Steps for Execution#

  1. Build and flash the bootloader and application to your board.

  2. On startup, LED 0 flashes short-on (50 ms on / 950 ms off), indicating the device is waiting for commissioning.

  3. Commission the device using one of the following methods:

    chip-tool (standalone or pre-built): The pre-built chip-tool instance ships with the Matter Hub image. More information on using the Matter Hub is in the Silicon Labs Matter Hub Documentation.

    chip-tool pairing ble-thread 1 hex:<operationalDataset> 20202021 3840

    Simplicity Connect mobile app: Scan the QR code shown on the liquid crystal display (LCD) or the URL printed to Real-Time Transfer (RTT) logs on startup or by pressing BTN0. The URL can also be retrieved via the Matter shell:

    matterCli> onboardingcodes ble qrcodeurl

    Example RTT log output:

    [SVR] Copy/paste the below URL in a browser to see the QR Code:
[SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3A6FCJ142C00KA0648G00

    This QR code is only valid for an unprovisioned device; provisioning may change it.

    Other: The device can also be provisioned and controlled using the Python controller, Android, or iOS app.

  4. Control the lock:

    chip-tool doorlock unlock-door 1 1
chip-tool doorlock lock-door 1 1

Doorlock Management (chip-tool)#

  • Set a user: chip-tool doorlock set-user <OperationType> <UserIndex> <UserName> <UserUniqueId> <UserStatus> <UserType> <CredentialRule> <node-id> <endpoint> [--timedInteractionTimeoutMs 1000]

  • Set or change a credential: chip-tool doorlock set-credential <OperationType> <Credential> <CredentialData> <UserIndex> <UserStatus> <UserType> <node-id> <endpoint> [--timedInteractionTimeoutMs 1000]

  • Get user: chip-tool doorlock get-user <UserIndex> <node-id> <endpoint>

Example (node-id 1, endpoint 1):

chip-tool doorlock set-user 0 1 "mike" 5 1 0 0 1 1 --timedInteractionTimeoutMs 1000
chip-tool doorlock set-credential 0 '{ "credentialType": 1, "credentialIndex": 1 }' "123456" 1 null null 1 1 --timedInteractionTimeoutMs 1000
chip-tool doorlock get-user 1 1 1

To change a credential, use OperationType 2 in set-credential (for example, new credential data 123457). For full parameter descriptions and other doorlock commands, see the chip-tool README.

Button and LED Reference#

Control

Action

Result

BTN0

Press and release

Start/restart BLE advertisement, print QR code URL to RTT logs

BTN0

Hold 6 s

Initiate factory reset (release within 6 s to cancel)

BTN1

Press and release

Toggle bolt state

LED 0

(Intermittently Connected Device (ICD) default)

Active during factory reset or when Identify command received

LED 0

(Non-ICD) Short flash on

Unprovisioned, waiting for commissioning

LED 0

(Non-ICD) Rapid even flash

BLE connected, commissioning in progress

LED 0

(Non-ICD) Short flash off

Provisioned, no full Thread connectivity

LED 0

(Non-ICD) Solid on

Fully provisioned with Thread connectivity

LED 1

Solid on

Bolt unlocked

LED 1

Blinking

Bolt moving

LED 1

Off

Bolt locked

AliroMatterLock — Aliro DoorLock Demo#

In this demo, the Aliro configuration is provisioned through Matter and the Aliro exchange is performed between the Aliro Matter Lock and the CSA Aliro Test Tool (user device) over NFC or BLE.

Steps for Execution#

  1. Complete the commissioning and lock-control steps in AliroMatterLock — Matter DoorLock Demo on this page.

  2. Provision the Aliro configuration through Matter:

chip-tool doorlock set-aliro-reader-config hex:8aefdff8d5b47aa9a3edbac7a345ed2221021512fd55abde3b8ee0f208952693 hex:043928f322019d4757893bde6a0fe5e13e3e537b9ca0f549c0bd2f40f79060252a0a4f291192157a95cb6eb202759428c00cd834998c5d0eab192ee8873c5d34ee hex:00113344667799aa00113344667799aa 1 1 --timedInteractionTimeoutMs 1000
chip-tool doorlock set-user 0 1 Home 0 1 0 0 1 1 --timedInteractionTimeoutMs 5000
chip-tool doorlock set-credential 0 '{"credentialType": 8, "credentialIndex": 1}' hex:04742df736d0fc9be978c45b00e8fdf7cea684ea105ae574c1505a2c24ab6198e3125b7f1b7e1d134c55ece69681ba8ecc18a3836dc5199c759f31e8ccf17e3efa 1 null null 1 1 --timedInteractionTimeoutMs 5000

  1. In chip-tool, subscribe to the DoorLock cluster events:

chip-tool interactive start
doorlock subscribe-event lock-operation 1 5 1 1
doorlock lock-door 1 1 --timedInteractionTimeoutMs 1000

  1. Connect to the Matter Shell CLI over UART and issue:

matterCli> aliro reader-config-set sub-group-id 113344667799aa00113344667799aa00

  1. Using the Aliro Test Tool, run one of the Expedited Flow test cases: NFC_RDR_STANDARD_NO_CERT (NFC) or BLERKE_RDR_UNSECURE (BLE RKE).

  2. In the chip-tool interactive session, observe the lock-operation events.

Note: Instead of Matter, you can use the CLI to provision the Aliro parameters. See Aliro Minimal Reader — Aliro Demo on this page for a CLI-based example.

Troubleshooting#

Issue

Suggestion

Test Tool cannot reach reader

Confirm Raspberry Pi and reader share network access; verify NFC/BLE transport hardware matches your build

Aliro exchange fails

Verify reader configuration keys and credentials match the Test Tool default project set

Matter commissioning fails

Confirm chip-tool operational dataset and pairing parameters; see Matter documentation

No lock-operation events

Confirm DoorLock event subscription is active before running the Test Tool case

Related Topics#