tree: befd7303d17bb857e70c3a6f51012230fe0074a9 [path history] [tgz]
  1. include/
  2. src/
  3. third_party/
  4. .gn
  5. args.gni
  6. BUILD.gn
  7. README.md
examples/light-switch-app/infineon/cyw30739/README.md

Matter CYW30739 Light Switch Example

An example showing the use of Matter on the Infineon CYW30739 platform.


Table of Contents


Introduction

The CYW30739 light switch example provides a baseline demonstration of a on-off light switch device, built using Matter and the Infineon Modustoolbox SDK. It can be controlled by a Matter controller over Openthread network.

The CYW30739 device can be commissioned over Bluetooth Low Energy where the device and the Matter controller will exchange security information with the Rendez-vous procedure. Target Thread Network information including the active dataset and CASE credentials are then provided.

Installing ModusToolbox™ Software

Follow the Installation Guide to download and install the ModusToolbox™ Software.

ModusToolbox™ tools package

ModusToolbox™ tools package should be automatically installed in the default location if you followed the Installation Guide. Please refer to the Installation Guide for the default location for different operating systems.

If you need to install the ModusToolbox™ tools package in a custom location, you must set the environment variable CY_TOOLS_PATHS to the /path/to/ModusToolbox/tools_x.x to specify the location of tools.

export CY_TOOLS_PATHS="/path/to/ModusToolbox/tools_x.x"

Note for WSL (Windows Subsystem for Linux)

If you are using WSL, please ensure you have installed the ModusToolbox™ Software for Linux. Running Windows tools directly from the WSL command line would cause path resolution failure in the build process.

Checkout Submodules and Bootstrap

Before building the example, check out the Matter repository and sync submodules using the following command:

$ cd ~/connectedhomeip
$ scripts/checkout_submodules.py --platform infineon
$ bash scripts/bootstrap.sh -p all,infineon

Building

  • Build the example application:

    $ cd ~/connectedhomeip
    $ scripts/examples/gn_build_example.sh examples/light-switch-app/infineon/cyw30739 out/cyw30739-light-switch
    
  • OR use GN/Ninja directly

    $ cd ~/connectedhomeip
    $ source scripts/activate.sh
    $ gn gen --root=examples/light-switch-app/infineon/cyw30739 out/cyw30739-light-switch
    $ ninja -C out/cyw30739-light-switch [light_switch_app-BOARD_NAME]
    
  • To delete generated executable, libraries and object files use:

    $ cd ~/connectedhomeip
    $ rm -rf out/cyw30739-light-switch
    

Factory Data

Commissionable Data

Infineon CYW30739 examples use test passcode, discriminator and PAKE parameters by default. For a production build, manufacturers should override commissionable data by the following arguments:

  • matter_passcode, matter_discriminator, matter_pake_iteration_count, matter_pake_salt

    $ cd ~/connectedhomeip
    $ scripts/examples/gn_build_example.sh examples/light-switch-app/infineon/cyw30739 out/cyw30739-light-switch \
    'matter_passcode=20202021' \
    'matter_discriminator=3840' \
    'matter_pake_iteration_count=1000' \
    'matter_pake_salt="U1BBS0UyUCBLZXkgU2FsdA=="'
    

Device Information

Infineon CYW30739 examples support overriding the default device information by the following arguments:

  • matter_vendor_name
  • matter_vendor_id
  • matter_product_name
  • matter_product_id
  • matter_serial_number
  • matter_hardware_version
  • matter_hardware_version_string

To override the default device information, pass the desired values to the gn_build_example.sh script as arguments.

```bash
$ cd ~/connectedhomeip
$ scripts/examples/gn_build_example.sh examples/light-switch-app/infineon/cyw30739 out/cyw30739-light-switch \
'matter_vendor_name="Infineon"' \
'matter_vendor_id="0x1388"' \
'matter_product_name="TEST_PRODUCT"' \
'matter_product_id="0x0001"' \
'matter_serial_number="TEST_SN"' \
'matter_hardware_version=30739' \
'matter_hardware_version_string="30739"'
```

DAC / DAC Key / PAI Certificate / Certificate Declaration

Infineon CYW30739 examples use development certifications, keys, and CD by default. For a production build, manufacturers can provision certifications, keys, and CD by the following arguments:

  • matter_att_cert, matter_att_cert_password, matter_cd

    $ cd ~/connectedhomeip
    $ scripts/examples/gn_build_example.sh examples/light-switch-app/infineon/cyw30739 out/cyw30739-light-switch \
    'matter_att_cert="/path/to/att_cert.p12"' \
    'matter_att_cert_password="password"' \
    'matter_cd="/path/to/cd.der"'
    

Use Provisioned Optiga Trust M

For boards supported by Optiga Trust M, CYW30739 will provision factory data to the Optiga Trust M by default for easy development.

The Optiga Trust M on a production board should come with provisioned factory data. To ensure its optimal use, please configure the Optiga using the following arguments:

  • use_provisioned_optiga, optiga_dac_object_id, optiga_dac_key_object_id, optiga_pai_cert_object_id

    $ cd ~/connectedhomeip
    $ scripts/examples/gn_build_example.sh examples/light-switch-app/infineon/cyw30739 out/cyw30739-light-switch \
    'optiga_dac_object_id="0xe0e0"' \
    'optiga_dac_key_object_id="0xe0f0"' \
    'optiga_pai_cert_object_id="0xe0e8"'
    

The developer must set the object IDs to corresponding values matching the configurations used in the Optiga provisioning procedure.

Flashing the Application

Enter Recovery Mode

Put the CYW30739 in to the recovery mode before running the flash script.

  1. Press and hold the RECOVERY button on the board.
  2. Press and hold the RESET button on the board.
  3. Release the RESET button.
  4. After one second, release the RECOVERY button.

Run Flash Script

  • On the command line:

    $ cd ~/connectedhomeip
    $ out/cyw30739-light-switch/light_switch_app-BOARD_NAME.flash.py --port <port>
    

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 setup a border router on a raspberryPi.

  • For this example to work, it is necessary to have a second CYW30739 device running the lighting app example commissioned on the same OpenThread network

  • If the CYW30739 device is running the light switch example, then

    Push USER Button - Sends a Toggle command to bound light app.

    LED1 - Indicates the current button state.

    OnOff Cluster - As following commands are app shell commands.

    -  'switch local on'            : Lights On LED1 of light-switch device
    -  'switch local off'           : Lights Off LED1 of light-switch device
    -  'switch local toggle'        : Makes Toggle LED1 of light-switch device
    
    -  'switch onoff on'            : Sends unicast On command to bound device
    -  'switch onoff off'           : Sends unicast Off command to bound device
    -  'switch onoff toggle'        : Sends unicast Toggle command to bound device
    
    -  'switch groups onoff on'     : Sends On group command to bound group
    -  'switch groups onoff off'    : Sends On group command to bound group
    -  'switch groups onoff toggle' : Sends On group command to bound group
    
  • Here is an example with the CHIPTool for unicast commands only:

    chip-tool pairing ble-thread 1 hex:<operationalDataset> 20202021 3840
    
    chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [<chip-tool-node-id>], "targets": null}, {"fabricIndex": 1, "privilege": 3, "authMode": 2, "subjects": [<light-switch-node-id>], "targets": [{"cluster": 6, "endpoint": 1, "deviceType": null}]}]' <lighting-node-id> 0
    
    chip-tool binding write binding '[{"fabricIndex": 1, "node": <lighting-node-id>, "endpoint": 1, "cluster": 6}]' <light-switch-node-id> 1
    

    Example: After pairing successfully [lighting-node-id : 1, light-switch-node-id : 2]

    chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [112233], "targets": null}, {"fabricIndex": 1,
    "privilege": 3, "authMode": 2, "subjects": [2], "targets": [{"cluster": 6, "endpoint": 1, "deviceType": null}]}]' 1 0
    
    chip-tool binding write binding '[{"fabricIndex": 1, "node": 1, "endpoint": 1, "cluster": 6}]' 2 1
    
  • Here is an example with the CHIPTool for groups commands only:

    Pairing the device

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

    You can use a series of commands after pairing successfully. Here is a lighting device (node 1) and a light-switch device (node 2) for connection demonstration.

    chip-tool groupkeymanagement key-set-write '{"groupKeySetID": 417, "groupKeySecurityPolicy": 0, "epochKey0":"a0a1a2a3a4a5a6a7a8a9aaabacadaeaf", "epochStartTime0": 1110000,"epochKey1":"b0b1b2b3b4b5b6b7b8b9babbbcbdbebf", "epochStartTime1":1110001,"epochKey2":"c0c1c2c3c4c5c6c7c8c9cacbcccdcecf", "epochStartTime2": 1110002 }' 1 0
    
    chip-tool groupkeymanagement write group-key-map '[{"groupId": 257, "groupKeySetID": 417, "fabricIndex": 1}]' 1 0
    
    chip-tool groups add-group 257 demo 1 1
    
    chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": null, "targets": null}, {"fabricIndex": 1, "privilege": 3, "authMode": 3, "subjects": [257], "targets": null}]' 1 0
    
    chip-tool groupkeymanagement key-set-write '{"groupKeySetID": 417, "groupKeySecurityPolicy": 0, "epochKey0":"a0a1a2a3a4a5a6a7a8a9aaabacadaeaf", "epochStartTime0": 1110000,"epochKey1":"b0b1b2b3b4b5b6b7b8b9babbbcbdbebf", "epochStartTime1":1110001,"epochKey2":"c0c1c2c3c4c5c6c7c8c9cacbcccdcecf", "epochStartTime2": 1110002 }' 2 0
    
    chip-tool groupkeymanagement write group-key-map '[{"groupId": 257, "groupKeySetID": 417, "fabricIndex": 1}]' 2 0
    
    chip-tool groups add-group 257 demo 2 1
    
    chip-tool binding write binding '[{"fabricIndex": 1, "group": 257}]' 2 1
    

    Or you can use TestGroupDemoConfig after pairing successfully

    chip-tool tests TestGroupDemoConfig --nodeId <light-switch-node-id>
    
    chip-tool tests TestGroupDemoConfig --nodeId <lighting-node-id>
    
    chip-tool binding write binding '[{"fabricIndex": 1, "group": 257}]' <light-switch-node-id> 1
    

    Example: After pairing successfully [lighting-node-id : 1, light-switch-node-id : 2]

    chip-tool tests TestGroupDemoConfig --nodeId 2
    
    chip-tool tests TestGroupDemoConfig --nodeId 1
    
    chip-tool binding write binding '[{"fabricIndex": 1, "group": 257}]' 2 1
    

    To run the example with unicast and groups commands, run the group configuration commands and replace the last one with binding this command

    chip-tool binding write binding '[{"fabricIndex": 1, "group": 257},{"fabricIndex": 1, "node": <lighting-node-id>, "endpoint": 1, "cluster":6} ]' <light-switch-node-id> 1
    

    To acquire the chip-tool node id, read the acl table right after commissioning

    chip-tool accesscontrol read acl <nodeid> 0