Configure Pairing Information
Version: 20210602
Introduction
During product creation, pairing information can be set in the Product Configuration step, followed by generating a PID-based QR code for pairing. Even if the pairing information is modified, the QR code remains unchanged. When end-users scan the QR code via the app to pair, they utilize the latest information to complete the pairing procedure.
1 Advantage
The QR code is typically included in the user's guide, allowing users to scan it to enter the pairing page. Tuya's pairing information offers the following advantages:
- Based on accurate pairing operations, it improves the pairing success rate.
- Even if pairing information is not set, the pairing content defaults to the content of all-in-one apps.
- If multiple pairing methods are available for a product, the display order can be sorted and determined.
- Packaging and delivery are not affected by the pairing method or language.
- Paper user guides remain viable; the QR code does not require changes with pairing updates.
- Provides user-friendly pairing steps by simply scanning the QR code with the app.
2 Prerequisite
- At least one product must have been created. For more information, refer to the "Create Products" documentation.
- Pairing information setting is supported by the Smart Life app and Tuya Smart app (v3.12.0 and later), as well as OEM apps from the ODM branch (v3.12.0 and later). QR codes are provided to update the app version.
[QR code for updating Tuya Smart App or Smart Life App version]
3 Method 1: Multi-step mode
Note: Refer to Method 2: Simple mode for details on the Simple mode.
- Log in to the IoT Platform and navigate to "My Products".
- Select a product in the "Developing" status and click "Entering to Develop" in the Operation list.
- Click "Product Configuration".
- Find "Network Connections Guides" and click "Settings".
- On the "Network Connections Guides" page, complete the configuration according to the guide:
- Pairing text: This is displayed on the homepage. Texts in Chinese Simplified and English are required.
- Pairing guide image or video: Upload images or videos as prompted. Note: Fill in proper text in Chinese Simplified and English, and upload pairing guide images or videos for each pairing step.
- Steps can be added or deleted from the default steps based on the pairing processes for different products.
- (Optional) Upload pairing guide videos no longer than 45 seconds, corresponding to the pairing processes of different products. Note: Videos can be uploaded in Chinese and English versions for different app language environments, or a single video covering both languages can be used.
- Preview the configured app interface.
- For multi-language configuration, click "More languages" and complete the related information according to the guide. Available languages are determined by the IoT Platform account level. Upgrade your account in "Account" > "Account Level" in the top-right corner.
- Click the "download QR code" button at the bottom of the page. A QR code for downloading the network connection guide is available.
[QR code for downloading the Network Connections Guide]
The PID-based QR code remains unchanged even if pairing information is modified. It can be included in the user guide's pairing section and used in packaging design. Detailed pairing steps and introductions corresponding to the QR code can be configured and changed later.
Note: The QR code shown below is for demonstration only. Download the QR code corresponding to your product PID for details.
[Demonstration QR code for product PID. Download the actual QR code for your product PID for details.]
- (Optional) Click "Custom mode" in the top-right corner to sort the display of pairing methods on the app.
- After completing and confirming the configuration information, click "Save" at the bottom of the page.
- Open your app and test the pairing. Open the Tuya Smart app (or Smart Life app or other OEM app), tap "+" in the top-right corner, and Scan the downloaded QR code to display the product's pairing information.
4 Method 2: Simple mode
This section describes the mapping relationship between the description and app page for setting up the simple mode.
Note: Refer to Method 1: Multi-step mode for details on the Multi-step mode.
- Log in to the IoT Platform and navigate to "My Products".
- Select a product in the "Developing" status and click "Entering to Develop" in the Operation list.
- Click "Product Configuration".
- Find "Network Connections Guides" and click "Settings".
- Navigate to the "Network Connections Guides" page and scroll down to "Simple mode" to complete the following configuration:
- Pairing description: Displays on the home page, including key and necessary pairing information.
- Pairing guide image: Upload the pairing guide image as prompted. PNG and GIF formats are supported (recommended).
- Text for single selection box: Enter corresponding content. Note: Enter content for both Chinese Simplified and English options.
- (Optional) Set the content for "View help". "View help" specifies how to reset the device. If the content in "Set Up" is not updated, it defaults to the pairing information of the corresponding product category. Help content can be customized according to the following steps:
- Select a language, such as Simplified Chinese, and click "Set Up".
- On the "Help guide settings", enter pairing help information. The image below shows the visual effect corresponding to each help information. Describe each step of pairing status and provide related images, such as PNG and GIF.
The "Help guide settings" interface allows configuration of page title, general description, step-by-step instructions (e.g., "Step 1: Power on the device", "Step 2: Switch the device on-off-on-off-on"), and a help button text. It also indicates support for image formats like JPG, JPEG, PNG, GIF with recommended dimensions of 800x600px and a file size limit of 300K. An "Additional step" button is available.
Note: The image shows an example of a help guide configuration, including a blinking light indicator for reset steps and power-on instructions.
- After completing and checking the supplied configuration information, click "Confirm".
- Return to the pairing guide and click "View help links" to check the updated content.
After completing and checking the supplied configuration information, click "Save" at the bottom of the page.
Open your app and test the pairing. Open the Tuya Smart app (or Smart Life app or other OEM app), tap "+" in the top-right corner, and Scan the downloaded QR code to display the product's pairing information.
The image on page 10 displays a product manual excerpt for a smart bulb (智能球泡灯). It includes sections for product specifications, warranty certificates, packaging lists, warranty policies, non-warranty terms, product introduction, and preparation for use. The preparation steps include installing the bulb, turning on the power, downloading and opening the app, and connecting the phone to a 2.4GHz Wi-Fi network. It also shows a declaration of hazardous substances in electronic information products. The app download instructions mention searching for "涂鸦智能" (Tuya Smart) or scanning a QR code. It details the registration/login process and adding a device by selecting "Tuya Smart Bulb" from the brand list. Finally, it shows the device added to the "My Home" list.