Skip to content

Latest commit

 

History

History
372 lines (248 loc) · 14.6 KB

README.md

File metadata and controls

372 lines (248 loc) · 14.6 KB
Raw

Matter EFR32 Lighting lite Example

An example showing the use of Matter on the Silicon Labs EFR32 in a minimal memory requirement configuration.

Introduction

The EFR32 lighting lite example provides a baseline demonstration of a Light control device, built using Matter and the Silicon Labs Gecko SDK. It can be controlled by a Chip controller over Openthread network.

The EFR32 device can be commissioned over Bluetooth Low Energy where the device and the Chip controller will exchange security information with the Rendez-vous procedure. Thread Network credentials are then provided to the EFR32 device, which will then join the network.

The lighting lite example is intended to serve both as a means to explore the workings of Matter as well as a minimal template for creating real products featuring the lowest memory requirements possible based on the Silicon Labs platform.

Building

  • Download the Simplicity Commander command line tool, and ensure that commander is in your shell search path. (For Mac OS X, commander is located inside Commander.app/Contents/MacOS/.)

  • Download and install a suitable ARM GCC tool chain: GNU Arm Embedded Toolchain (arm-none-eabi)

  • Install some additional tools (likely already present for CHIP developers):

    • Linux: sudo apt-get install git ninja-build

    • Mac OS X: brew install ninja

  • Supported hardware:

    • For the latest supported hardware please refer to the Hardware Requirements in the Silicon Labs Matter Github Repo

    MG12 boards:

    • BRD4161A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
    • BRD4162A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
    • BRD4163A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm, 868MHz@19dBm
    • BRD4164A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@19dBm
    • BRD4166A / SLTB004A / Thunderboard Sense 2 / 2.4GHz@10dBm
    • BRD4170A / SLWSTK6000B / Multiband Wireless Starter Kit / 2.4GHz@19dBm, 915MHz@19dBm
    • BRD4304A / SLWSTK6000B / MGM12P Module / 2.4GHz@19dBm

    MG21 boards: Currently not supported due to RAM limitation.

    • BRD4180A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm

    MG24 boards :

    • BRD2601B / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
    • BRD2703A / SLWSTK6000B / Wireless Starter Kit / 2.4GHz@10dBm
    • BRD4186A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
    • BRD4186C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@10dBm
    • BRD4187A / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm
    • BRD4187C / SLWSTK6006A / Wireless Starter Kit / 2.4GHz@20dBm

  • Build the example application for your specific board:

      cd ~/matter
  ./scripts/examples/gn_efr32_example.sh ./silabs_examples/lighting-lite-app/efr32/ ./out/lighting-lite-app BRD4161A

  • To delete generated executable, libraries and object files use:

      $ cd ~/matter
  $ rm -rf ./out/

    OR use GN/Ninja directly

      $ cd ~/matter/silabs_examples/lighting-lite-app/efr32
  $ git submodule update --init
  $ source third_party/matter/scripts/activate.sh
  $ export EFR32_BOARD=BRD4161A
  $ gn gen out/debug
  $ ninja -C out/debug

  • To delete generated executable, libraries and object files use:

      $ cd ~/matter/silabs_examples/lighting-lite-app/efr32
  $ rm -rf out/

  • Build the example as Sleepy End Device (SED)

      $ ./scripts/examples/gn_efr32_example.sh ./silabs_examples/lighting-lite-app/efr32/ ./out/lighting-lite-app_SED BRD4161A --sed

    or use gn as previously mentioned but adding the following arguments:

      $ gn gen out/debug '--args=efr32_board="BRD4161A" enable_sleepy_device=true chip_openthread_ftd=false'

  • Build the example with pigweed RPC

      $ ./scripts/examples/gn_efr32_example.sh silabs_examples/lighting-lite-app/efr32/ out/lighting_lite_app_rpc BRD4161A 'import("//with_pw_rpc.gni")'

    or use GN/Ninja Directly

      $ cd ~/matter/silabs_examples/lighting-lite-app/efr32
  $ git submodule update --init
  $ source third_party/matter/scripts/activate.sh
  $ export EFR32_BOARD=BRD4161A
  $ gn gen out/debug --args='import("//with_pw_rpc.gni")'
  $ ninja -C out/debug

    Running Pigweed RPC console

For more build options, help is provided when running the build script without arguments

     ./scripts/examples/gn_efr32_example.sh

Flashing the Application

  • On the command line:

      $ cd ~/matter/silabs_examples/lighting-lite-app/efr32
  $ python3 out/debug/chip-efr32-lighting-lite-example.flash.py

  • Or with the Ozone debugger, just load the .out file.

Viewing Logging Output

The example application is built to use the SEGGER Real Time Transfer (RTT) facility for log output. RTT is a feature built-in to the J-Link Interface MCU on the WSTK development board. It allows bi-directional communication with an embedded application without the need for a dedicated UART.

Using the RTT facility requires downloading and installing the SEGGER J-Link Software and Documentation Pack (web site).

Alternatively, SEGGER Ozone J-Link debugger can be used to view RTT logs too after flashing the .out file.

  • Install the J-Link software

      $ cd ~/Downloads
  $ sudo dpkg -i JLink_Linux_V*_x86_64.deb

  • In Linux, grant the logged in user the ability to talk to the development hardware via the linux tty device (/dev/ttyACMx) by adding them to the dialout group.

      $ sudo usermod -a -G dialout ${USER}

Once the above is complete, log output can be viewed using the JLinkExe tool in combination with JLinkRTTClient as follows:

  • Run the JLinkExe tool with arguments to autoconnect to the WSTK board:

    For MG12 use:

      $ JLinkExe -device EFR32MG12PXXXF1024 -if JTAG -speed 4000 -autoconnect 1

    For MG21 use:

      $ JLinkExe -device EFR32MG21AXXXF1024 -if SWD -speed 4000 -autoconnect 1

  • In a second terminal, run the JLinkRTTClient to view logs:

      $ JLinkRTTClient

Running the Complete Example

  • It is assumed here that you already have an OpenThread border router configured and running. If not see the following guide Openthread_border_router for more information on how to set up a border router on a Raspberry Pi.

    Note that the RCP code is available directly through Simplicity Studio 5 under File->New->Project Wizard->Examples->Thread : ot-rcp

    LED 0 shows the overall state of the device and its connectivity. The following states are possible:

    -   _Short Flash On (50 ms on/950 ms off)_ ; The device is in the
    unprovisioned (unpaired) state and is waiting for a commissioning
    application to connect.

-   _Rapid Even Flashing_ ; (100 ms on/100 ms off)_ — The device is in the
    unprovisioned state and a commissioning application is connected through
    Bluetooth LE.

-   _Short Flash Off_ ; (950ms on/50ms off)_ — The device is fully
    provisioned, but does not yet have full Thread network or service
    connectivity.

-   _Solid On_ ; The device is fully provisioned and has full Thread
    network and service connectivity.

    LED 1 Simulates the Light The following states are possible:

    -   _Solid On_ ; Light is on
-   _Off_ ; Light is off

    Push Button 0

    -   _Press and Release_ : Start, or restart, BLE advertisement in fast mode. It will advertise in this mode
    for 30 seconds. The device will then switch to a slower interval advertisement.
    After 15 minutes, the advertisement stops.

-   _Press and hold for 6 s_ : Initiates the factory reset of the device.
    Releasing the button within the 6-second window cancels the factory reset
    procedure. **LEDs** blink in unison when the factory reset procedure is
    initiated.

    Push Button 1 Toggles the light state On/Off

  • You can provision and control the Chip device using the python controller, Chip tool standalone, Android or iOS app

  • You can provision and control the Chip device using the python controller, Chip tool standalone, Android or iOS app

    CHIPTool

    Here is an example with the CHIPTool:

    chip-tool pairing ble-thread 1 hex: 20202021 3840

    chip-tool onoff on 1 1

Notes

  • Depending on your network settings your router might not provide native ipv6 addresses to your devices (Border router / PC). If this is the case, you need to add a static ipv6 addresses on both device and then an ipv6 route to the border router on your PC

    • On Border Router: sudo ip addr add dev <Network interface> 2002::2/64

    • On PC(Linux): sudo ip addr add dev <Network interface> 2002::1/64

    • Add Ipv6 route on PC(Linux) sudo ip route add <Thread global ipv6 prefix>/64 via 2002::2

Running RPC console

  • As part of building the example with RPCs enabled the chip_rpc python interactive console is installed into your venv. The python wheel files are also created in the output folder: out/debug/chip_rpc_console_wheels. To install the wheel files without rebuilding: pip3 install out/debug/chip_rpc_console_wheels/*.whl

  • To use the chip-rpc console after it has been installed run: chip-console --device /dev/tty.<SERIALDEVICE> -b 115200 -o /<YourFolder>/pw_log.out

  • Then you can simulate a button press or release using the following command where : idx = 0 or 1 for Button PB0 or PB1 action = 0 for PRESSED, 1 for RELEASE Test toggling the LED with rpcs.chip.rpc.Button.Event(idx=1, pushed=True)

  • You can also Get and Set the light directly using the RPCs: rpcs.chip.rpc.Lighting.Get()

    rpcs.chip.rpc.Lighting.Set(on=True, level=128, color=protos.chip.rpc.LightingColor(hue=5, saturation=5))

Device Tracing

Device tracing is available to analyze the device performance. To turn on tracing, build with RPC enabled. See Build the example with pigweed RPC.

Obtain tracing json file.

$ ./{PIGWEED_REPO}/pw_trace_tokenized/py/pw_trace_tokenized/get_trace.py -d {PORT} -o {OUTPUT_FILE} \
-t {ELF_FILE} {PIGWEED_REPO}/pw_trace_tokenized/pw_trace_protos/trace_rpc.proto

Memory settings

While most of the RAM usage in CHIP is static, allowing easier debugging and optimization with symbols analysis, we still need some HEAP for the crypto and OpenThread. Size of the HEAP can be modified by changing the value of the configTOTAL_HEAP_SIZE define inside of the FreeRTOSConfig.h file of this example. Please take note that a HEAP size smaller than 13k can and will cause a Mbedtls failure during the BLE rendez-vous or CASE session

To track memory usage you can set enable_heap_monitoring = true either in the BUILD.gn file or pass it as a build argument to gn. This will print on the RTT console the RAM usage of each individual task and the number of Memory allocation and Free. While this is not extensive monitoring you're welcome to modify examples/platform/efr32/MemMonitoring.cpp to add your own memory tracking code inside the trackAlloc and trackFree function

OTA Software Update

For the description of Software Update process with EFR32 example applications see EFR32 OTA Software Update

Group Communication (Multicast)

With this lighting lite example you can also use group communication to send Lighting commands to multiples devices at once. Please refer to the chip-tool documentation Configuring the server side for Group Commands and Using the Client to Send Group (Multicast) Matter Commands

Building options

This example has only minimal features enabled, with features such as logging, debug, etc. disabled by default. However some of those features can easily be toggled on or off. Here is a short list of options to be passed to the build scripts.

Enabling logging

chip_progress_logging, chip_detail_logging, chip_automation_logging

$ ./scripts/examples/gn_efr32_example.sh ./silabs_examples/lighting-lite-app/efr32 ./out/lighting-lite-app BRD4164A "chip_detail_logging=true chip_automation_logging=true chip_progress_logging=true"

Enabling Debug build

is_debug

$ ./scripts/examples/gn_efr32_example.sh ./silabs_examples/lighting-lite-app/efr32 ./out/lighting-lite-app BRD4164A "is_debug=true"

KVS maximum entry count

kvs_max_entries

Set the maximum Kvs entries that can be stored in NVM (Default 75)
Thresholds: 30 <= kvs_max_entries <= 255

$ ./scripts/examples/gn_efr32_example.sh ./silabs_examples/lighting-lite-app/efr32 ./out/lighting-lite-app BRD4164A kvs_max_entries=50