TUYA mesh User manual

Tuya mesh
Version: 20211129
Online Version

Contents
Contents
1 Scenarios 2
2 Preparation 3
3 Concepts 4
3.1 Product categories and types . . . . . . . . . . . . . . . . . . . . 4
3.2 Mesh terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4 Manage mesh networks 6
4.1 Create a mesh network . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.2 Delete a mesh network . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.3 Query a list of mesh networks in a site . . . . . . . . . . . . . . . . . 7
4.4 Query a list of mesh sub-devices . . . . . . . . . . . . . . . . . . . . 8
4.5 Query and destroy mesh instances . . . . . . . . . . . . . . . . . . . 8
4.6 Connect to and disconnect from a mesh sub-device . . . . . . . . . . 8
5 Pair devices 10
5.1 Reset devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.2 Scan for sub-devices pending pairing . . . . . . . . . . . . . . . . . . 11
5.3 Pair mesh sub-devices . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.4 Pair a mesh gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.5 Pairing error codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6 Manage devices 17
6.1 Check a mesh device type . . . . . . . . . . . . . . . . . . . . . . . . 17
6.2 Rename a sub-device . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.3 Connect to a mesh network and a gateway . . . . . . . . . . . . . . . 18
6.4 Remove a sub-device . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.5 Query sub-device status . . . . . . . . . . . . . . . . . . . . . . . . . 20
7 Manage groups 22
7.1 Check a mesh group . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
7.2 Create a group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
7.3 Add sub-devices to a group . . . . . . . . . . . . . . . . . . . . . . . 23
7.4 Remove sub-devices from a group . . . . . . . . . . . . . . . . . . . . 24
I

Contents
7.5 Delete a group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
7.6 Rename a group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
8 Control devices and groups 27
8.1 Control devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
8.2 Control groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
8.3 Listen for mesh device status . . . . . . . . . . . . . . . . . . . . . . 29
9 Update rmware 31
II

Contents
Tuya supports the following three Bluetooth connectivity topology options: Blue-
tooth Low Energy (Bluetooth LE), Tuya’s proprietary Bluetooth mesh connections
(Tuya mesh), and Bluetooth mesh networking (Bluetooth mesh) provided by Blue-
tooth Special Interest Group (Bluetooth SIG). This topic describes the development
guidance on pairing, control, and management of devices that use Tuya mesh.
1 / 31

1 Scenarios
1 Scenarios
The following table lists the Bluetooth connectivity topology options that vary de-
pending on di󰍒erent smart products.
Type Product
Bluetooth LE Body fat scales, wrist-worn trackers,
thermostats, electric toothbrushes, and
smart locks
Bluetooth mesh Cool white lights (C), cool and warm
white lights (CW), white and colored
lights (RGBCW), sockets, sensors, and
other Bluetooth mesh sub-devices
Tuya mesh Similar to the products that use
Bluetooth mesh, but with Tuya mesh
Combo devices Bluetooth mesh gateways, IP cameras
(IPCs), and new devices that support
Bluetooth and Wi-Fi combo
The devices that support Bluetooth and Wi-Fi combo can be paired over ei-
ther Bluetooth or Wi-Fi. In this case, Bluetooth LE technology is used when combo
devices are paired over Bluetooth. For more information, see Bluetooth.
Before the development of Bluetooth mesh capabilities, get familiar with Smart Life
App SDK. All Bluetooth mesh operations are implemented based on the initialized
site data. A site can belong to multiple Bluetooth mesh networks, but one Bluetooth
mesh network is recommended for each site.
2 / 31

2 Preparation
2 Preparation
•System requirements: Bluetooth connectivity requires Android 4.3 and later,
and the Smart Life App SDK supports Android 4.4 and later.
•Manifest permissions
1<uses-permission android :name="android .permission .ACCESS_COARSE_LOCA
2TION" />
3<uses-permission android :name="android .permission .ACCESS_FINE_LOCATI
4ON" />
5<uses-permission android :name="android .permission .BLUETOOTH " />
6<uses-permission android :name="android .permission .BLUETOOTH_ADMIN " /
7>
•Precheck of Bluetooth permissions
• Check whether the location permissions are enabled for an app before it uses
Bluetooth connectivity or starts scanning.
• Check whether the Bluetooth feature is enabled.
This precheck is not provided by the Smart Life App SDK. You can manually perform
the precheck. This percheck is essential. Otherwise, the app cannot use Bluetooth
connectivity as expected.
3 / 31

3 Concepts
3 Concepts
3.1 Product categories and types
Bluetooth mesh products are classi󰍓ed into:
• Five categories:
• Lighting (01): smart lights ranging from cool white lights (C) to white and col-
ored lights (RGBCW)
• Electrical (02): one to six-outlet sockets
• Sensors (04): contact sensors, passive infrared (PIR) sensors, and more
• Actuators (10): devices used for actuation, such as motors and alarms
• Adapters (08): gateways (adapters with Bluetooth mesh and other communi-
cation nodes)
• Product types of a category:
• Smart lights ranging from cool white lights (C) to white and colored lights (RG-
BCW) (01–05)
• One to six-outlet power strips (01–06)
• Examples of device category values
• Cool white and colored light (RGBC): 0401
• Five-outlet socket: 0502
3.2 Mesh terms
Term Description
NodeId Represents a mesh node in a 2-byte
󰍓eld. The NodeId 󰍓eld provides a unique
identi󰍓er to distinguish each mesh
device on a mesh network. To control a
device on the network, commands can
be sent to the device with the speci󰍓ed
NodeId 󰍓eld value.
4 / 31

3 Concepts
Term Description
LocalId Represents a mesh group in a 2-byte
󰍓eld. The LocalId 󰍓eld provides a unique
identi󰍓er to distinguish each mesh
group on a mesh network. To control a
group device on the network,
commands can be sent to the speci󰍓ed
LocalId 󰍓eld value of the device.
Synchronous operations When devices are added, deleted, or
managed in a group, these operations
are implemented with local Bluetooth
commands and synchronously recorded
in the cloud. Therefore, device
information is synchronized to the local
mesh network and the cloud at the
same time.
Local connections Paired devices are controlled with
commands on a mesh network through
Bluetooth connections.
Gateway connections Paired devices are controlled with
commands on a mesh network through
gateway connections. The gateway
must be deployed close to the devices.
5 / 31

4 Manage mesh networks
4 Manage mesh networks
4.1 Create a mesh network
API description
1void createBlueMesh(String meshName,ITuyaResultCallback <BlueMeshBea
2n>callback );
Parameters
Parameter Type Description
meshName String The name of a mesh
network, with up to 16
bytes.
callback ITuyaResultCallback The callback.
Example
1TuyaHomeSdk.newHomeInstance("siteId ").createBlueMesh(" meshName ",new
2ITuyaResultCallback<BlueMeshBean >() {
3@Override
4public void onError(String errorCode ,String errorMsg ) {
5}
6@Override
7public void onSuccess(BlueMeshBean blueMeshBean) {
8}
9});
4.2 Delete a mesh network
API description
6 / 31

4 Manage mesh networks
1void removeMesh(IResultCallback callback );
Parameters
Parameter Type Description
callback IResultCallback The callback.
Example
1TuyaHomeSdk.newBlueMeshDeviceInstance(meshId).removeMesh(new IResult
2Callback () {
3@Override
4public void onError(String errorCode ,String errorMsg ) {
5}
6@Override
7public void onSuccess() {
8}
9});
4.3 Query a list of mesh networks in a site
API description
1List<BlueMeshBean>getMeshList();
Example
1ITuyaHome mTuyaHome =TuyaHomeSdk.newHomeInstance("siteId");
2if (mTuyaHome .getHomeBean() != null){
3List<BlueMeshBean>meshList =mTuyaHome.getHomeBean(). getMeshList();
4BlueMeshBean meshBean=meshList.get(0);
5}
7 / 31