tree: 9742ed5b05ab724cbf3f3d0cce72484f79aa64d1 [path history] [tgz]
  1. main/
  2. third_party/
  3. .gn
  4. args.gni
  5. BUILD.gn
  6. chip.syscfg
  7. README.md
examples/lock-app/cc32xx/README.md

Matter CC32XXSF Lock Example Application

An example application showing the use of Matter on the Texas Instruments CC32XX family of Wireless MCUs.



Introduction

CC3235SF_LAUNCHXL

The CC32XX lock example application provides a working demonstration of a connected door lock device. This uses the open-source CHIP implementation and the Texas Instruments SimpleLinkā„¢ Wi-FiĀ® CC32xx software development kit.

By default this example targets the CC3235SF_LAUNCHXL LaunchPad, but the example application is enabled to build on the whole CC32XX family of MCUs.

The lock example is intended to serve both as a means to explore the workings of CHIP, as well as a template for creating real products based on the Texas Instruments devices.

Device UI

This example application has a simple User Interface to depict the state of the door lock and to control the state. The user LEDs on the LaunchPad are set on when the lock is locked, and are set off when unlocked. The LEDs will flash when in the transition state between locked and unlocked. The user buttons are used for requesting lock and unlock of the door lock. The left button (BTN-1) is used to enable provisioning (provisioning is enabled as “oneshot” by default. The right button (BTN-2) us used to toggle the “Lock” state.

Building

Preparation

Some initial setup is necessary for preparing the build environment. This section will need to be done when migrating to new versions of the SDK. This guide assumes that the environment is linux based, and recommends Ubuntu 20.04.

  • Download and install SysConfig (recommended version). This can be done simply with the following commands.

    $ cd ~
    $ wget https://software-dl.ti.com/ccs/esd/sysconfig/sysconfig-1.12.1_2446-setup.run
    $ chmod +x sysconfig-1.12.1_2446-setup.run
    $ ./sysconfig-1.12.1_2446-setup.run
    
  • Run the bootstrap script to setup the build environment.

    $ cd ~/connectedhomeip
    $ source ./scripts/bootstrap.sh
    

Compilation

It is necessary to activate the environment in every new shell. Then run GN and Ninja to build the executable.

  • Activate the build environment with the repository activate script.

    $ cd ~/connectedhomeip
    $ source ./scripts/activate.sh
    
  • Run the build to produce a default executable. By default on Linux the Sysconfig is located in a ti folder in the user's home directory, and you must provide the absolute path for it. For example /home/username/ti/sysconfig_1.12.1. On Windows the default directory is C:\ti. Take note of this install path, as it will be used in the next step.

    $ cd ~/connectedhomeip/examples/lock-app/cc32xx
    $ gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.12.1\""
    $ ninja -C out/debug
    

Programming

Loading the built image onto a LaunchPad is supported through Code Composer Studio (CCS). Code Composer Studio can be used to load the image and debug the source code. UniFlash programming (bin) image is not generated currently.

Code Composer Studio

Programming with CCS will allow for a full debug environment within the IDE. This is accomplished by creating a target connection to the XDS110 debugger and starting a project-less debug session. The CCS IDE will attempt to find the source files on the local machine based on the debug information embedded within the ELF. CCS may prompt you to find the source code if the image was built on another machine or the source code is located in a different location than is recorded within the ELF.

Download and install Code Composer Studio.

First open CCS and create a new workspace.

Create a target connection (sometimes called the CCXML) for your target SoC and debugger as described in the Manual Method section of the CCS User's Guide.

Next initiate a project-less debug session as described in the Manual Launch section of the CCS User's Guide.

CCS should switch to the debug view described in the After Launch section of the User‘s Guide. The SoC core will likely be disconnected and symbols will not be loaded. Connect to the core as described in the Debug View section of the User’s Guide. Once the core is connected, use the Load button on the toolbar to load the ELF image.

Note that the default configuration of the CCXML uses 2-wire cJTAG instead of the full 4-wire JTAG connection to match the default jumper configuration of the LaunchPad.

Viewing Logging Output

By default the log output will be sent to the Application/User UART. Open a terminal emulator to that port to see the output with the following options:

ParameterValue
Speed (baud)115200
Data bits8
Stop bits1
ParityNone
Flow controlNone

Running the Example

Provisioning

The first step to bring the Matter device onto the network is to provision it. The example accomplishes this through the proprietary SimpleLink provisioning method (AP or Smart Config) using the SimpleLink Starter Pro mobile app. Once the device is connected to the local AP, commissioning can be triggered using “OnNetwork” configuration.

Bluetooth LE Provisioning

BLE provisioning is not supported currently.

CHIP tool changes needed for Wi-Fi example

The timeout for the CHIP tool needs to be increased from 10 to 15 seconds. This can be done in chip::System::Clock::Timeout GetWaitDuration in connectedhomeip/examples/chip-tool/commands/clusters/ModelCommand.h

TI Support

For technical support, please consider creating a post on TI's E2E forum. Additionally, we welcome any feedback.