tuya/tuyaopen-dev-skills/add-board

TuyaOpen: Adding a New Board

SDK root: All paths and commands in this skill are relative to the TuyaOpen SDK root. After activating the environment, the SDK root is available as $OPEN_SDK_ROOT (Linux/macOS/PowerShell) or %OPEN_SDK_ROOT% (Windows CMD). Navigate there with cd $OPEN_SDK_ROOT before running any commands below.

Reference: $OPEN_SDK_ROOT/boards/add_new_board.md

Supported Platforms

Board Directory Structure

Create boards/<PLATFORM>/<BOARD_NAME>/ with these files:

boards/<PLATFORM>/<BOARD_NAME>/
├── CMakeLists.txt       # Build config (usually no modification needed)
├── Kconfig              # Board selection and feature toggles
├── board_com_api.h      # Board-level API declarations
├── board_config.h       # Hardware pin/peripheral configuration
└── <board_name>.c       # Board init implementation

Step-by-Step

1. Copy from an existing board

Pick a board on the same platform as a starting point:

cp -r boards/ESP32/DNESP32S3 boards/ESP32/MY_NEW_BOARD

2. Edit Kconfig

Set the chip and board identifiers. The BOARD_CHOICE value must match the directory name exactly (case-sensitive):

config CHIP_CHOICE
    string
    default "esp32s3"
 
config BOARD_CHOICE
    string
    default "MY_NEW_BOARD"
 
config BOARD_CONFIG
    bool
    default y
    select ENABLE_AUDIO
    select ENABLE_ESP_DISPLAY

3. Register in platform Kconfig

Add your board as an option in boards/<PLATFORM>/Kconfig so it appears in config choice. Skip this step if you used tos.py new board — it does this automatically.

4. Edit board_config.h

Define hardware-specific constants (display type, I/O expander, pin mappings, etc.):

#define BOARD_DISPLAY_TYPE   DISPLAY_TYPE_LCD_SH8601
#define BOARD_IO_EXPANDER_TYPE IO_EXPANDER_TYPE_TCA9554

5. Implement board driver

Implement the board-specific init functions in <board_name>.c. For the list of required driver functions per platform and the standard CMakeLists.txt template, see references/BOARD_LAYERS.md.

6. Create a project config (optional)

For app-specific projects, create a config file in the project's config/ directory:

cp apps/tuya.ai/your_chat_bot/config/TUYA_T5AI_EVB.config \
   apps/tuya.ai/your_chat_bot/config/MY_NEW_BOARD.config

7. Build and verify

cd apps/tuya.ai/your_chat_bot    # or your target project
tos.py config choice -c MY_NEW_BOARD   # non-interactive (Agent/CI)
# or: tos.py config choice             # interactive selection
tos.py build

Code Layer Rules & Shared Drivers

For the dependency layer diagram (platform → src → boards/common → boards/BOARD → apps), existing ESP32 shared drivers (audio, LCD, touch, IO expander, LED), and the board CMakeLists.txt template, see references/BOARD_LAYERS.md.