tuya Smart App SDK Device Pairing UI Biz Bundle
Specifications
- Product Name: Device Pairing UI BizBundle
- Version: 20241218
- Device Types: Wi-Fi, Zigbee, Bluetooth, QR Code
Product Information
Device Pairing UI BizBundle is used to implement pairing guidance and smart device activation. It applies to multiple common types of smart devices, such as Wi-Fi devices, Zigbee devices, Bluetooth devices, and devices that support QR code scanning like GPRS & NB-smart devices. The UI BizBundle provides the service logic and UI encapsulation to guide pairing and activate smart devices over different protocols.
Instructions for use
Device types
Wi-Fi device pairing
Wi-Fi smart devices can be paired and connected to cloud services in two modes: Wi-Fi Easy Connect (EZ) mode and access point (AP) or hotspot mode. IP cameras (IPCs) can be paired after QR code scanning.
Term Description
Wi-Fi EZ mode
Also known as the EZ mode. This pairing mode is implemented through the following steps:
- The app encapsulates the pairing data into the specified section of an IEEE 802.11 packet and sends the packet to the network.
- The Wi-Fi module of a smart device runs in promiscuous mode and listens for and captures all packets over the network.
- The Wi-Fi mode parses the packets that carry the pairing data from the app into the data format specified by the protocol.
AP mode
Also known as the hotspot mode. A mobile phone acts as a station (STA) and connects to the hotspot of a smart device. Then, both devices are paired to establish a socket connection between them and exchange data through the specified ports.
IPC pairing in QR code mode
An IPC scans the QR code on the app to get the pairing data.
Zigbee device pairing
Zigbee gateways and sub-devices can be paired.
Term Description
Zigbee gateway
The device that integrates the coordinator with Wi-Fi features on a Zigbee network. The gateway is responsible to formulate the Zigbee network and store data.
Zigbee sub-device
A router or an end device on a Zigbee network. Each Zigbee sub-device is responsible to forward data, or respond to control commands
Bluetooth device pairing
Tuya provides the following Bluetooth solutions.
Term Description
Bluetooth Low Energy (LE)
A point-to-point connection is created between a Bluetooth or Bluetooth LE device and a mobile phone.
Bluetooth mesh
Enable many-to-many (m:m) device communications over a mesh network released by Bluetooth Special Interest Group (SIG). This solution is also known as Bluetooth LE mesh.
Tuya mesh
Tuya’s proprietary technology that enables Bluetooth devices to communicate over a mesh network.
Combo devices
The devices that support Bluetooth and Wi-Fi combo can be paired over either Bluetooth or Wi-Fi.
QR code pairing
A smart device that supports this pairing mode is connected to Tuya’s cloud services immediately after power on. The app can be used to scan the QR code on the device to implement cloud-based device activation and binding. The QR code must comply with Tuya’s QR code rules. For more information, contact Tuya’s account manager.
Term Description
GPRS devices
Smart devices that apply GPRS technologies to connect to the network and access cloud services.
NB-smart devices
Smart devices that apply NB-IoT technologies.
Matter device pairing
If you want to use the Matter device pairing feature, see Prepare for Integration with Matter Device for initialization.
Pairing by auto discovery
Tuya provides efficient pairing features on top of Tuya’s generic pairing technologies for smart devices.
Integrate with the UI BizBundle
- Create a project.
Integrate Smart Life App SDK for Android into your project with Android Studio and add the framework of the UI BizBundle to your project . - Configure the build.gradle file.
- Obfuscate the code.
Configure features
Configure auto discovery
Create a JSON file named activator_auto_search_capacity.json in the assets directory. Add the following code to this file.
Make API requests
Open the pairing page
Request parameters
Parameter Description
- activity The pairing activity.
- homeId The home ID. For more information, see Home Information Management .
Response parameters
Parameter Description
- devIds
The success callback. A list of paired device IDs is returned. - updateRoomData
Indicates whether room device details are updated. - onOpenDevicePanel
Indicates whether a certain panel can be opened. You can implement this feature as needed. - onExitConfigBiz
Indicates whether to exit the pairing service if pairing is not performed. You can implement this feature as needed.
Open the QR code scanning page
FAQ
- Q: How can I pair a Wi-Fi device in EZ mode?
- A: To pair a Wi-Fi device in EZ mode, insert the data into an IEEE 802.11 packet and send it to establish a connection.
- Q: What is the role of a Zigbee Gateway?
- A: A Zigbee Gateway integrates the coordinator with Wi-Fi features on a Zigbee network and is responsible for formulating the network and storing data.
Documents / Resources
 |
tuya Smart App SDK Device Pairing UI Biz Bundle [pdf] User Guide Smart App SDK Device Pairing UI Biz Bundle, Device Pairing UI Biz Bundle, Pairing UI Biz Bundle, UI Biz Bundle, Biz Bundle |
