esp-rainmaker/examples/matter/matter_controller_with_touchscreen

Matter + Rainmaker Controller With Touchscreen Example

• This example demonstrates a Matter + RainMaker Controller which running on ESP32-S3-BOX or ESP32-S3-LCD-EV-BOARD. Matter is used for commissioning (also known as Wi-Fi provisioning) and local control, whereas RainMaker is used for remote control.

Usage

Setting prerequisites and environment

Claiming device certificates

Generating the factory nvs binary

Building the example

$ idf.py set-target esp32s3
$ idf.py build
$ idf.py flash monitor

Please check the board selection (default ESP32-S3-BOX-3) in one of the ways:

• Use idf.py menuconfig->HMI Board Config->Selece BSP board to select board.
• Add only one board config in 'sdkconfig.defaults'. e.g. 'CONFIG_BSP_BOARD_ESP32_S3_LCD_EV_BOARD=y' to select ESP32-S3-LCD-EV-BOARD as board. 'CONFIG_BSP_BOARD_ESP32_S3_BOX_3=y' to select ESP32-S3-BOX-3 as board.

• Please use ESP-IDF v5.2.
• If the board is ESP32-S3-LCD-EV-BOARD, set-target command should be idf.py -D SDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.defaults.lcdboard" set-target esp32s3, remember to select board at the same time.

Commissioning

To commission the Controller with touchscreen, scan the QR Code shown on the screen using ESP RainMaker app.

• After commissioning successfully, the Controller could control the other devices (supporting On/Off cluster server) in the same fabric locally by clicking the icon on the screen.
• Besides the Matter + Rainmaker light, a Matter-only light at '$ESP_MATTER_PATH/examples/light' can also be commissioned by using a similar method. The QR code for Matter-only light is on the website.
• Long click the BOOT button will reset factory, then the device can be commissioned again.

Please refer to the README in the parent folder for instructions.

Fetching the details of the devices commissioned in the RainMaker Fabric:

$ cd $RMAKER_PATH/cli
$ ./rainmaker.py login --email <rainmaker-account-email>
$ ./rainmaker.py getparams <rainmaker-node-id-of-controller>

Note:

1. Please use the same account credentials that are used to claim the controller and signed into the Rainmaker app.
2. Get the rainmaker-node-id-of-controller by logging into ESP Rainmaker Dashboard.

Controlling the devices remotely using rainmaker cli:

$ cd $RMAKER_PATH/cli
$ ./rainmaker.py login --email <rainmaker-account-email>

Toggle command:

$ ./rainmaker.py setparams --data '{"Matter-Controller":{"Matter-Devices":{"matter-nodes":[{"matter-node-id":"<matter-node-id-of-device>","endpoints":[{"endpoint-id":"0x1","clusters":[{"cluster-id":"0x6","commands":[{"command-id":"0x2"}]}]}]}]}}}' <rainmaker-node-id-of-controller>

Set Brightness command:

$ ./rainmaker.py setparams --data '{"Matter-Controller":{"Matter-Devices":{"matter-nodes":[{"matter-node-id":"<matter-node-id-of-device>","endpoints":[{"endpoint-id":"0x1","clusters":[{"cluster-id":"0x8","commands":[{"command-id":"0x0","data":{"0:U8": 10, "1:U16": 0, "2:U8": 0, "3:U8": 0}}]}]}]}]}}}' <rainmaker-node-id-of-controller>

Note:

1. Get the matter-node-id-of-device from the details reported by the controller using getparams command.