Serial Port Communication on the Silicon Labs Platform#

The matter-shell exposes the configuration and the management APIs via the matter command line interface (matter CLI). This interface can be used to change the state of the device.

Hardware Requirements#

Software Requirements#

Execute Matter Shell on Silicon Labs Platform#

  1. Download and Install Simplicity Studio.

  2. To install the software packages for Simplicity Studio, refer Software Package Installation.

  3. Log in to Simplicity Studio and connect the EFR32 board to the computer.

  4. Go to the All Products section. Silicon Labs - design

  5. Type and Select the radio board from the displayed list and select Start. Silicon Labs - design

  6. The Launcher page will display the selected radio board's details. Silicon Labs - design

  7. Verify the following in the General Information section:

    • The Debug Mode is Onboard Device (MCU).

    • The Preferred SDK is the version you selected earlier.Silicon Labs - design

  8. Open the Example Projects and Demos tab and create a project for Matter Lock Application. Silicon Labs - design

  9. In the New Project Wizard window, click Finish. Silicon Labs - design

  10. After creation of project, open the Software Components tab and in search bar type Matter Shell and install it. Silicon Labs - desing

  11. Build the project after enabling Matter Shell component.

  12. After a successful build, commission the device as described in Commission Matter Platform.

  13. Open Tera Term and under New Connection, under Serial Port, select JLink port and click OK. Silicon Labs - design

  14. Click on Setup from Menu bar and change the value to 115200 under Speed category, then click on New setting. Silicon Labs - design

  15. Inside Terminal Set the below values and click OK.

  • Terminal Size : 80 * 24

  • New-Line

    • Receive : CR+LF

    • Transmit : CR+LFSilicon Labs - design

  1. Click on File from Menu bar again, select Serial Port option. Silicon Labs - design

  2. Increase the speed to 115200 and click on New setting. Silicon Labs - design

  3. Click on File from Menu bar, select TTY Record. Create any empty file with extension " .tty " and click on save. Silicon Labs - design

  4. After creating tty file just click on Enter button from Keyboard then it will show you matterCli terminal. Silicon Labs - design

  5. Send any command through matterCli terminal, from the below list of commands:

  6. doorlock event door-state-change "DoorState"

    • Door State List

      • DoorOpen = 0

      • DoorClosed = 1

      • DoorJammed = 2

      • DoorForcedOpen = 3

      • DoorUnspecifiedError = 4

      • DoorAjar = 5

  7. doorlock event lock-alarm "AlarmCode"

    • Alarm Code List

    • LockJammed = 0

    • LockFactoryReset = 1

    • LockRadioPowerCycle = 3

    • WrongCodeEntryLimit = 4

    • FrontEsceutcheonRemoved = 5

    • DoorForcedOpen = 6

    • DoorAjar = 7

    • ForcedUser = 8

  8. onboardingcodes ble, command will show QR Code. Silicon Labs - design

  9. After changing DoorState and AlarmCode in matterCli, run the commands below using chip-tool on Raspberry PI to verify the event.

  • To Read Door State

    ./chip-tool doorlock read-event door-state-change "node_id" "endpoint"

  • To Read Alarm Code

    ./chip-tool doorlock read-event door-lock-alarm "node_id" "endpoint"

Note: Type help in matterCli terminal for more information about supported features.