Quick Start

This topic describes the TuyaOS Gateway Development Kit directory, along with the compilation process, configuration files, and terminal login for the THP23-X-D development kit.

Directory

The directory structure of the TuyaOS Gateway Development Kit:

├── hardware                  # Hardware documentation.
├── pc
│    └── tools                # Development tools.
├── software
│    ├── packages             # SDK package.
│    ├── SDKInformation.json  # SDK information file.
│    └── TuyaOS               # SDK directory.
│        ├── apps             # The sample applications, which can be modified as needed.
│        ├── build
│        ├── docs             # API reference.
│        ├── include          # SDK header files.
│        ├── libs             # SDK libraries. You can link them as needed.
│        ├── scripts
│        ├── build_app.sh     # The build script.
│        ├── CHANGELOG.md
│        ├── LICENSE          # Tuya MIT License
│        ├── Makefile
│        ├── output           # The build output.
│        ├── README.md
│        └── vendor           # The toolchain. When you build a project, the toolchain is automatically downloaded to this directory.
└── tuya.json

The directory structure of the THP23-X-D Development Kit:

├── application_components    # Open source components
├── application_drivers
├── build                     # Files packaged into the firmware
├── build.conf
├── build.sh
├── include                   # Application header file
├── libs                      # Application library file
├── local.mk
├── Makefile
├── output                    # Output directory
├── package.json
├── README.md
└── src                       # Application source file

Build firmware

Here is how to build firmware:

1. You have downloaded the THP23-X-D development kit to the TuyaOS/apps directory. For more information, see Get Development Kit.

2. In Visual Studio Code, right-click the development kit directory and choose Build Project.

   

3. Enter the version number in the format x.x.x (where x is a number) and press Enter to start building.

   

4. The process output is shown in the Visual Studio Code Terminal window. After the process is completed, you can find the firmware file in the TuyaOS/output/tuyaos_core_board-tuyaos_gw_ssd202d/pack directory.

   Description of the generated files:

   File name	Description
   gateway.tar.gz	The application package for debugging.
   tuyaos_core_board-tuyaos_gw_ssd202d_*_debug	The application with a symbol table for debugging with GDB.
   tuyaos_core_board-tuyaos_gw_ssd202d_fw_PROD_*.tar.gz	The full firmware for production. This archive contains firmware for three different programming options. Flash a blank chip Flash via serial port Flash via USB
   tuyaos_core_board-tuyaos_gw_ssd202d_fw_UG_*.bin	The firmware update, used for OTA updates.

Configuration file

The configuration file for the THP23-X-D application is located at build > image > tuya_user1 > config.json. You can edit the configuration file as needed. For example, change the default product ID.

Description of the fields in the configuration file:

Terminal login

The THP23-X-D development board uses a one-device-one-key encryption scheme. You need the password before logging in. Submit a ticket to request the password by providing the SN of your THP23-X-D development board.

Log in via serial port

Connect a USB to UART converter to the debugging port on the THP23-X-D development board. Refer to the table below for wire connections:

The debugging port on the THP23-X-D development board:

Connect to the development board using a serial debugger such as PuTTY or SecureCRT, setting the baud rate to 115200.

Log in via SSH

SSH listens on port 2333, but it is disabled by default. You can log in via the serial port and then enable the SSH feature.

Run the following command to enable SSH.

root@SmartGateway:~# nvram set enable_ssh true
root@SmartGateway:~# nvram commit
root@SmartGateway:~# reboot

Processes

The processes for the gateway are as follows:

1100 root      2932 S    /bin/sh ./app_detect.sh ./tyZ3Gw /tmp/tuya /tmp/tuya/config.json
1106 root      2932 S    /bin/sh ./log_detect.sh /tmp/tuya.log 3
1114 root      2932 S    /bin/sh ./process_monitor.sh /tmp/tuya /tmp/tuya/config.json
1121 root      324m S    ./tyZ3Gw /tmp/tuya/tuya_user1 /tmp/tuya/config.json