Bluetooth Mesh

Bluetooth mesh enables Bluetooth devices to communicate with each other over a mesh network. This topic describes the API methods and examples of Bluetooth mesh capabilities provided by Cube App SDK for Android.

Concepts

The Bluetooth Special Interest Group (SIG) provides Bluetooth mesh technologies to enable mesh networking. Bluetooth mesh is also known as Bluetooth SIG mesh. This mesh networking standard allows for many-to-many communication over Bluetooth radio. The standard must be followed to implement Bluetooth mesh networking and device updates.

Terms

Term	Description
Product category and type	Each Bluetooth mesh device corresponds to a product that belongs to a product category and a product type. The SDK provides pcc to specify a product category and type to specify a product type.
Mesh group localId	The 2-byte localId field provides a unique identifier to distinguish each mesh group on a mesh network. To control devices in a group, commands can be sent to the mesh network with the specified localId field value.
Mesh nodeId	The 2-byte node ID provides a unique identifier to distinguish each mesh device on a mesh network. To control a device on the network, commands can be sent to the mesh network with the specified nodeId field value.
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.

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.

Device classification rules (categories and types)

• A device is classified with a combination of device type, product category, and product type. The class name is then stored in the little-endian format.

  • Device type:
    • Standard type: 1
    • Raw: 2
  • Bluetooth mesh products are classified into the following product categories:
    • Lighting (01): smart lights ranging from cool white lights (C) to white and colored lights (RGBCW)
    • Electrical (02): one to six-outlet sockets
    • Remote control (05): one to six-button remote controls
  • Product types of a category:
    • Smart lights ranging from cool white lights (C) to white and colored lights (RGBCW) (01–05)
    • One to six-outlet power strips (01–06)
    • One to six-button remote controls (01–06)

• Example:

  Product	Category value	Description
  Standard white and colored light (RGBCW)	1510	1015 in the little-endian format: 1: standard device 01: light 5: white and colored light (RGBCW)
  Standard 4-outlet power strip	2410	1024 in the little-endian format: 1: standard device 02: socket 4: 4-outlet power strip
  Raw type of device	xx20	20xx in the little-endian format: 2 represents a raw type of device.

Preparation

• System requirements: Bluetooth connectivity requires Android 4.3 and later, and the Cube App SDK supports Android 6.0 and later.

• Manifest permissions:

  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
  <uses-permission android:name="android.permission.BLUETOOTH" />
  <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
  

• Precheck of Bluetooth permissions: This percheck is essential. Otherwise, the app cannot use Bluetooth connectivity as expected.

  • Check whether location is 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 Cube App SDK. You can manually perform the precheck.

• Initialize a home: Before the development of Tuya mesh capabilities, get familiar with Cube App SDK. All Bluetooth mesh operations are implemented based on the initialized home data. For more information, see Home Management.

Management

Create a Bluetooth mesh network

A home can belong to multiple Bluetooth mesh networks, but one Bluetooth mesh network is recommended for each home.

API description

void createSigMesh(IThingResultCallback<SigMeshBean> callback);

Example

ThingHomeSdk.newHomeInstance(123xxx) // The `homeId` parameter of long type.
    .createSigMesh(new IThingResultCallback<SigMeshBean>() {

    @Override
    public void onError(String errorCode, String errorMsg) {

    }

    @Override
    public void onSuccess(SigMeshBean sigMeshBean) {

    }
});

Delete a Bluetooth mesh network

Deletes a Bluetooth mesh network. If sub-devices are included in the mesh group, they are also removed.

API description

void removeMesh(IResultCallback callback);

Example

ThingHomeSdk.newSigMeshDeviceInstance(meshId).removeMesh(new IResultCallback() {
    @Override
    public void onError(String errorCode, String errorMsg) {

    }

    @Override
    public void onSuccess() {

    }
});

Query a list of Bluetooth mesh networks in a home

Returns a list of mesh networks for an initialized home instance.

API description

List<SigMeshBean> getSigMeshList();

Example

IThingHome mThingHome = ThingHomeSdk.newHomeInstance(123xxx); // The `homeId` parameter.

if (mThingHome.getHomeBean() != null){
    List<SigMeshBean> meshList = ThingHomeSdk.getSigMeshInstance().getSigMeshList()
}

Query a list of Bluetooth mesh sub-devices

API description

List<DeviceBean> getMeshSubDevList();

Example

List<DeviceBean> meshSubDevList = ThingHomeSdk.newSigMeshDeviceInstance("meshIdxxxxx").getMeshSubDevList();

Initialize a Bluetooth mesh network

Initializes a Bluetooth mesh network and registers a listener for status changes from the cloud. This API method is called when users switch between or initialize Bluetooth mesh networks.

API description

void initMesh(String meshId);

Example

ThingHomeSdk.getThingSigMeshClient().initMesh("meshIdxxxxx");

Destroy a Bluetooth mesh instance

We recommend that you destroy the current Bluetooth mesh instance and initialize the Bluetooth mesh instance for the target home when you switch between homes.

API description

void destroyMesh();

Example

ThingHomeSdk.getThingSigMeshClient().destroyMesh();

Connect to or disconnect from a Bluetooth mesh sub-device

IThingBlueMeshClient provides API methods to start a connection, close a connection, start scanning, and stop scanning.

Example

// Starts a connection.
ThingHomeSdk.getThingSigMeshClient().startClient(mSigMeshBean);
// Starts a connection with a specified scanning period.
ThingHomeSdk.getThingSigMeshClient().startClient(mSigMeshBean,searchTime);

// Closes a connection.
ThingHomeSdk.getThingSigMeshClient().stopClient();

// Starts scanning.
ThingHomeSdk.getThingSigMeshClient().startSearch()

// Stops scanning.
ThingHomeSdk.getThingSigMeshClient().stopSearch();

Device Pairing UI BizBundle

In a pairing process, the Bluetooth mesh device joins the target mesh network based on certain communication technologies.

Scan for sub-devices ready for pairing

Scans for a Bluetooth mesh device ready for pairing. When the device is discovered, it can be paired.

API description

// Starts scanning.
void startSearch();
// Stops scanning.
void stopSearch();

Example

IThingBlueMeshSearchListener iThingBlueMeshSearchListener=new IThingBlueMeshSearchListener() {
    @Override
    public void onSearched(SearchDeviceBean deviceBean) {

    }

    @Override
    public void onSearchFinish() {

    }
};
// The UUID of a Bluetooth mesh device to be paired is unchanged.
UUID[] MESH_PROVISIONING_UUID = {UUID.fromString("00001827-0000-1000-8000-00805f9b34fb")};
SearchBuilder searchBuilder = new SearchBuilder()
                                .setServiceUUIDs(MESH_PROVISIONING_UUID)    // The UUID of the Bluetooth mesh device is a fixed value.
                .setTimeOut(100)        // The duration of the scanning. Unit: seconds.
                .setThingBlueMeshSearchListener(iThingBlueMeshSearchListener).build();

IThingBlueMeshSearch mMeshSearch = ThingHomeSdk.getThingBlueMeshConfig().newThingBlueMeshSearch(searchBuilder);

// Starts scanning.
mMeshSearch.startSearch();

// Stops scanning.
mMeshSearch.stopSearch();

Query device information

Returns the name and icon of a discovered device.

API description

void getActivatorDeviceInfo(String productId, String uuid, String mac, IThingDataCallback<ConfigProductInfoBean> callback);

Parameters

Parameter	Type	Description
productId	String	SearchDeviceBean.productId. byte[] must be converted into String before this parameter is set.
uuid	String	The device UUID. The value is null for a Bluetooth mesh device.
mac	String	SearchDeviceBean.productId

Example

ThingHomeSdk.getActivatorInstance().getActivatorDeviceInfo(
    // btye[] to String
    new String(bean.getProductId(), StandardCharsets.UTF_8),
    // uuid
    null,
    // mac
    scanDeviceBean.getMacAdress(),
    // callback
    new IThingDataCallback<ConfigProductInfoBean>() {
        @Override
        public void onSuccess(ConfigProductInfoBean result) {

        }

        @Override
        public void onError(String errorCode, String errorMessage) {

        }
});

Callback description

Properties of ConfigProductInfoBean

Property	Type	Description
name	String	The product name of the device. The value is set in the cloud. In most cases, it is the name used when you create the product.
icon	String	The icon of the product.

Pair Bluetooth mesh sub-devices

Sub-devices can be paired with the app over Bluetooth or through a gateway.

API description

// Starts pairing.
void startActivator();
// Stops pairing.
void stopActivator();

Example

ThingSigMeshActivatorBuilder ThingSigMeshActivatorBuilder = new ThingSigMeshActivatorBuilder()
            .setSearchDeviceBeans(mSearchDeviceBeanList)
            .setSigMeshBean(sigMeshBean) // Information about the Bluetooth mesh network.
            .setTimeOut(100)  // The timeout value.
            .setThingBlueMeshActivatorListener(new IThingBlueMeshActivatorListener() {
     @Override
     public void onSuccess(String mac, DeviceBean deviceBean) {
         L.d(TAG, "subDevBean onSuccess: " + deviceBean.getName());
     }
     @Override
     public void onError(String mac, String errorCode, String errorMsg) {
         L.d(TAG, "config mesh error" + errorCode + " " + errorMsg);
     }
     @Override
     public void onFinish() {
      L.d(TAG, "config mesh onFinish");
     });

IThingBlueMeshActivator iThingBlueMeshActivator = ThingHomeSdk.getThingBlueMeshConfig().newSigActivator(ThingSigMeshActivatorBuilder);

// Starts pairing.
iThingBlueMeshActivator.startActivator();

// Stops pairing.
iThingBlueMeshActivator.stopActivator();

Parameters

Parameter	Description
mSearchDeviceBeanList	The collection of devices to be paired. They can be returned in the result of startSearch.
timeout	The timeout value of a pairing task. Default value: 100. Unit: seconds. The value can be increased to pair a large number of devices.
sigMeshBean	SigMeshBean

Response parameters

Parameter	Description
DeviceBean	The type of device data. For more information, see Data types of DeviceBean.
errorCode	For more information, see Pairing error codes.

Pair a Bluetooth mesh gateway

A Bluetooth mesh gateway is a combo device.

• For a gateway connected to the network over Wi-Fi, use the API for pairing in Wi-Fi Easy Connect (EZ) mode.

• For a Bluetooth Low Energy (LE) and Wi-Fi combo gateway, use the API for pairing a combo device.

Pair Bluetooth mesh sub-devices

Bluetooth mesh sub-devices can be paired through a gateway in a similar way like Zigbee sub-devices. For more information, see Sub-Device Pairing.

Pairing error codes

Error code	Error message
21002	The invite failure has occurred.
21004	The provision failure has occurred.
21006	Failed to send a public key.
21008	The conform failure has occurred.
210010	The random conform failure has occurred.
210014	Failed to send data.
210016	The composition data failure has occurred.
210018	Failed to add appkey.
210020	Failed to bind a model.
210022	A publication model failure has occurred.
210024	A network transmission failure has occurred.
210026	Failed to register the device in the cloud.
210027	The upper limit of the number of device addresses is reached.
210034	An error has occurred while processing notify.
20021	The pairing task timed out.

Devices

The IThingBlueMeshDevice class provides operations to manage Bluetooth mesh groups.

Query a device instance

Example

IThingBlueMeshDevice mThingBlueMeshDevice = ThingHomeSdk.newSigMeshDeviceInstance("meshIdxxxx");

Query Bluetooth mesh connection status

Example

DeviceBean deviceBean=ThingHomeSdk.getDataInstance().getDeviceBean(mDevId);
DeviceBean gwBean=ThingHomeSdk.getDataInstance().getDeviceBean(deviceBean.getParentId());

// The online status, including the status of connections to the local Bluetooth mesh network and gateway.
boolean online=deviceBean.getIsOnline()
// The device online status of connections to the local Bluetooth mesh network.
boolean localOnline=deviceBean.getIsLocalOnline()
// The device online status of connections to the gateway. The gateway is online only when the gateway and its sub-devices are both online.
boolean wifiOnline=deviceBean.isCloudOnline() && gwBean.getIsOnline()

Check Bluetooth mesh sub-devices and gateway

Example

DeviceBean deviceBean=ThingHomeSdk.getDataInstance().getDeviceBean(mDevId);
// Checks whether a Bluetooth mesh device is a gateway or a sub-device.
if(deviceBean.isSigMesh()){
    // This device is a Bluetooth mesh device.
}

// Check whether a device is a Bluetooth mesh gateway.
if(deviceBean.isSigMeshWifi()){
    // This device is a Wi-Fi and Bluetooth mesh combo device.
}

Rename a Bluetooth mesh sub-device

API description

void renameMeshSubDev(String devId, String name, IResultCallback callback);

Parameters

Parameter	Description
devId	The device ID.
name	The new name of the device.
callback	The callback.

Example

IThingBlueMeshDevice mThingBlueMeshDevice= ThingHomeSdk.newSigMeshDeviceInstance("meshIdxxxx");

mThingBlueMeshDevice.renameMeshSubDev("devIdxxxx","New device name", new IResultCallback() {
     @Override
     public void onError(String code, String errorMsg) {
        // The failure callback.
     }

     @Override
     public void onSuccess() {
        // The success callback.
     }
});

Query Bluetooth mesh sub-device status

The data point (DP) information returned from the cloud might not be the real-time data of the specified device. You can run the following command to query the current DP value of the device. The result is returned by the method onDpUpdate of IMeshDevListener.

API description

void querySubDevStatusByLocal(String pcc, final String nodeId, final IResultCallback callback);

Parameters

Parameter	Description
pcc	The category and type of the device.
nodeId	The value of nodeId for the device.
callback	The callback.

Example

IThingBlueMeshDevice mThingBlueMeshDevice = ThingHomeSdk.newSigMeshDeviceInstance("meshIdxxxx");

mThingBlueMeshDevice.querySubDevStatusByLocal(devBean.getCategory(), devBean.getNodeId(), new IResultCallback() {
    @Override
    public void onError(String code, String errorMsg) {
        // The failure callback.
    }
    @Override
    public void onSuccess() {
        // The success callback. The result is returned by `IMeshDevListener`.
    }
});

Configure online profile of networked Bluetooth mesh devices

The SDK provides the following online profiles that define the online or offline status of Bluetooth mesh devices after they are paired:

• Online profile 1: By default, all sub-devices go online after they are connected to a Bluetooth mesh network.
• Online profile 2: Check whether sub-devices are online or offline after they are connected to a Bluetooth mesh network.

The following example shows how to configure the online profile of networked Bluetooth mesh devices.

Example

// Configure the online profile to check whether sub-devices are online or offline after they are connected to a Bluetooth mesh network.
SigMeshConfiguration.OnlineMode onlineMode = SigMeshConfiguration.OnlineMode.RESPONSE_ONLINE;
ISigMeshControl sigMeshControl = ThingOSMesh.getSigMeshControl(mMeshId);
if (sigMeshControl != null){
    SigMeshConfiguration sigMeshConfiguration = sigMeshControl.getSigMeshConfiguration();
    if (sigMeshConfiguration != null){
        sigMeshConfiguration.setOnlineMode(onlineMode);
    }
}

Description of online profile

SigMeshConfiguration.OnlineMode

Enum value	Description
DEFAULT	By default, all Bluetooth mesh sub-devices go online after they are paired.
RESPONSE_ONLINE	Check whether all Bluetooth mesh sub-devices are online or offline after they are paired.

Check if sub-devices go online

Method 1: Follow the online profile for Bluetooth mesh sub-devices

Checks whether sub-devices are online or offline after they are connected to a Bluetooth mesh network based on the specified online profile. The value of OnlineMode determines the types of sub-devices to be queried:

• If OnlineMode is RESPONSE_ONLINE, the online or offline status of all sub-devices are returned automatically.
• If OnlineMode is DEFAULT, the status of offline sub-devices are returned automatically.

API description

ISigMeshControl sigMeshControl = ThingOSMesh.getSigMeshControl(mMeshId);
if (sigMeshControl != null){
    sigMeshControl.queryAllOnLineStatusByLocal(new IResultCallback() {
        @Override
        public void onError(String code, String error) {
             // The failure callback.
        }

        @Override
        public void onSuccess() {
            // The success callback.
        }
    });
}

Method 2: Customize online profile

API description

ISigMeshControl sigMeshControl = ThingOSMesh.getSigMeshControl(mMeshId);
int queryStrategy = 0;
// The online profile. Valid values: 0 means to return only the offline Bluetooth mesh sub-devices in the query result. 1 means to return the online or offline status of all Bluetooth mesh sub-devices in the query result.
if (sigMeshControl != null){
    sigMeshControl.queryMeshDeviceOnlineStatusByLocal(queryStrategy, new IResultCallback() {
        @Override
        public void onError(String code, String error) {
             // The failure callback.
        }

        @Override
        public void onSuccess() {
            // The success callback.
        }
    });
}

Parameters

Enum value	Description
queryStrategy	Specifies the types of devices to be queried in the online profile: 0: returns only the offline Bluetooth mesh sub-devices in the query result. 1: returns the online or offline status of all Bluetooth mesh sub-devices in the query result.

Remove a Bluetooth mesh sub-device

API description

void removeMeshSubDev(String devId, IResultCallback callback);

Parameters

Parameter	Description
devId	The device ID.
pcc	The category and type of the device.
callback	The callback.

Example

IThingBlueMeshDevice mThingBlueMeshDevice = ThingHomeSdk.newSigMeshDeviceInstance("meshIdxxxx");

mThingBlueMeshDevice.removeMeshSubDev(devBean.getDevId(), devBean.getCategory(), new IResultCallback() {
    @Override
    public void onError(String code, String errorMsg) {

    }
    @Override
    public void onSuccess() {

    }
});

Groups

The IThingGroup class provides operations to manage Bluetooth mesh groups.

Determine a Bluetooth mesh group

Checks whether MeshId is used by a group to determine whether it is a Bluetooth mesh group or a common Wi-Fi group.

Example

GroupBean groupBean=ThingHomeSdk.getDataInstance().getGroupBean("groupId");
if(!TextUtils.isEmpty(groupBean.getMeshId())){
    // This group is mesh group"
}

Create a Bluetooth mesh group

Each Bluetooth mesh network supports up to 16,128 groups. In the response to group creation, the group ID ranges from C000 to FEFF in hexadecimal and can be locally maintained.

API description

void addGroup(String name, String pcc, String localId,IAddGroupCallback callback);

Parameters

Parameter	Description
name	The name of the group.
pcc	The categories and types of devices in the group. Different types of devices can be created in a group.
localId	The value of localId for the group. Valid values: C000 and FEFF in hexadecimal.
callback	The callback.

Example

IThingBlueMeshDevice mThingSigMeshDevice= ThingHomeSdk.newSigMeshDeviceInstance("meshId");

mThingSigMeshDevice.addGroup("Group name","Category and type of product", "C001", new IAddGroupCallback() {
    @Override
    public void onError(String errorCode, String errorMsg) {
// The failure callback.
    }

    @Override
    public void onSuccess(long groupId) {
// The success callback.
    }
});

Add a device to a group

API description

void addDevice(String devId,IResultCallback callback);

Parameters

Parameter	Description
devId	The device ID.
callback	The callback.

Example

IThingGroup mGroup = ThingHomeSdk.newSigMeshGroupInstance(groupId);

mGroup.addDevice("devId", new IResultCallback() {
    @Override
    public void onError(String code, String errorMsg) {
        // The failure callback.
    }

    @Override
    public void onSuccess() {
        // The success callback.
    }
});

Remove a device from a group

API description

void removeDevice(String devId,IResultCallback callback);

Parameters

Parameter	Description
devId	The device ID.
callback	The callback.

Example

IThingGroup mGroup = ThingHomeSdk.newSigMeshGroupInstance(groupId);

mGroup.removeDevice("devId", new IResultCallback() {
    @Override
    public void onError(String code, String errorMsg) {
        // The failure callback.
    }

    @Override
    public void onSuccess() {
        // The success callback.
    }
});

Dismiss a Bluetooth mesh group

API description

void dismissGroup(IResultCallback callback);

Parameters

Parameter	Description
callback	The callback.

Example

IThingGroup mGroup = ThingHomeSdk.newSigMeshGroupInstance(groupId);
mGroup.dismissGroup(new IResultCallback() {
    @Override
    public void onError(String code, String errorMsg) {
        // The failure callback.
    }

    @Override
    public void onSuccess() {
        // The success callback.
    }
});

Rename a Bluetooth mesh group

API description

void renameGroup(String groupName,IResultCallback callback);

Parameters

Parameter	Description
groupName	The new name of the group.
callback	The callback.

Example

IThingGroup mGroup = ThingHomeSdk.newSigMeshGroupInstance(groupId);
mGroup.renameGroup("Group name",new IResultCallback() {
    @Override
    public void onError(String code, String errorMsg) {
        // The failure callback.
    }

    @Override
    public void onSuccess() {
        // The success callback.
    }
});

Control

Smart devices are managed with DPs. Bluetooth mesh devices are also controlled by device DPs. The IThingBlueMeshDevice class provides operations to manage Bluetooth mesh devices.

Format of DPs

Sends a control command in the following format:

{
    "(dpId1)":(dpValue1),
    "(dpId2)":(dpValue2)
}

For more information about DPs, see Data points.

Send DPs to control a device

API description

void publishDps(String nodeId, String pcc, String dps, IResultCallback callback);

Parameters

Parameter	Description
nodeId	The local ID of a sub-device.
pcc	The product category and type of a sub-device.
dps	The list of DPs. For more information, see Data points.
callback	The callback.

Example

String dps = {"1":false};

IThingBlueMeshDevice mThingSigMeshDevice=ThingHomeSdk.newSigMeshDeviceInstance("meshIdxxxx");

mThingSigMeshDevice.publishDps(devBean.getNodeId(), devBean.getCategory(), dps, new IResultCallback() {
    @Override
    public void onError(String s, String s1) {
        // The failure callback.
    }

    @Override
    public void onSuccess() {
        // The success callback.
    }
});

Send DPs to control a group

API description

void multicastDps(String localId, String pcc, String dps, IResultCallback callback)

Parameters

Parameter	Description
localId	The local ID of a group.
pcc	The product category and type of a sub-device.
dps	The list of DPs. For more information, see Data points.
callback	The callback.

Example

String dps = {"1":false};

IThingBlueMeshDevice mThingSigMeshDevice= ThingHomeSdk.newSigMeshDeviceInstance("meshId");

mThingSigMeshDevice.multicastDps(groupBean.getLocalId(), devBean.getCategory(), dps, new IResultCallback() {
    @Override
    public void onError(String errorCode, String errorMsg) {
        // The failure callback.
    }

    @Override
    public void onSuccess() {
        // The success callback.
    }
});

Listener for device control

Device information on a Bluetooth mesh network, such as DP data, status changes, device name, and device removal, is synchronized to IMeshDevListener in real time.

Example

mThingSigMeshDevice.registerMeshDevListener(new IMeshDevListener() {
    /**
    * Data is updated.
    * @param nodeId    The value of `nodeId` for the device.
    * @param dps       DP data.
    * @param isFromLocal   The data source. Valid values: `true` indicates the local Bluetooth mesh network and `false` indicates the cloud.
    */
    @Override
    public void onDpUpdate(String nodeId, String dps,boolean isFromLocal) {
        // Returns `DeviceBean` by using `node`.
        DeviceBean deviceBean = mThingBlueMeshDevice.getMeshSubDevBeanByNodeId(nodeId);
    }
    /**
    * Reports the device status.
    * @param online    The list of online devices.
    * @param offline   The list of offline devices.
    */
    @Override
    public void onStatusChanged(List<String> online, List<String> offline,String gwId) {

    }

    /**
    * The changed network status.
    * @param devId
    * @param status
    */
    @Override
    public void onNetworkStatusChanged(String devId, boolean status) {

    }
    /**
    * Reports the Raw type of data.
    * @param bytes
    */
    @Override
    public void onRawDataUpdate(byte[] bytes) {

    }
    /**
    * The changes of device information, such as the device name.
    * @param bytes
    */
    @Override
    public void onDevInfoUpdate(String devId) {

    }
    /**
    * The device is removed.
    * @param devId
    */
    @Override
    public void onRemoved(String devId) {

    }
});

Update

Bluetooth mesh sub-devices can be updated over the air.

Query firmware update information

API description

void requestUpgradeInfo(String devId, IRequestUpgradeInfoCallback callback);

Parameters

Parameter	Description
devId	The value of devId for the target device.
callback	The callback.

Example

ThingHomeSdk.getMeshInstance().requestUpgradeInfo(mDevID, new IRequestUpgradeInfoCallback() {
    @Override
    public void onSuccess(ArrayList<BLEUpgradeBean> bleUpgradeBeans) {

    }

    @Override
    public void onError(String errorCode, String errorMsg) {

    }
});

BLEUpgradeBean returns the firmware update information as described in the following table.

Field	Type	Description
upgradeStatus	int	The update status. Valid values: 0: no update available 1: update available 2: updating
version	String	The target firmware version.
currentVersion	String	The current firmware version.
timeout	int	The specified timeout, in seconds.
upgradeType	int	0: app notification of update 2: forced app update 3: check for update
type	int	The type of module. Valid values: 0: Wi-Fi module 1: Bluetooth module 2: GPRS module 3: Zigbee module 9: MCU
typeDesc	String	The description of the update module.
lastUpgradeTime	long	The duration of the latest update, in milliseconds.
url	String	The URL to download the new firmware. url has a value when type is 1 or 9.
fileSize	long	The size of the new firmware.
md5	String	The MD5 (Message-Digest algorithm 5) hash value of the firmware.

Update a Bluetooth mesh sub-device

API description

void startOta();

Example

private MeshUpgradeListener mListener = new MeshUpgradeListener() {
    @Override
    public void onUpgrade(int percent) {
        // The progress of the firmware update.
    }

    @Override
    public void onSendSuccess() {
        // Transmission of updates is completed.
    }

    @Override
    public void onUpgradeSuccess() {
        // The firmware is updated.
        mMeshOta.onDestroy();
    }

    @Override
    public void onFail(String errorCode, String errorMsg) {
        // Failed to update the firmware.
        mMeshOta.onDestroy();
    }
};

// Returns the byte stream of a specified file.
byte data[] = getFromFile(path);

ThingBlueMeshOtaBuilder build = new ThingBlueMeshOtaBuilder()
        .setData(data)
        .setMeshId(mDevBean.getMeshId())
        .setMac(mDevBean.getMac())
        .setProductKey(mDevBean.getProductId())
        .setNodeId(mDevBean.getNodeId())
        .setDevId(mDevID)
        .setVersion("version")
        .setThingBlueMeshActivatorListener(mListener)
        .bulid();
IThingBlueMeshOta mMeshOta = ThingHomeSdk.newMeshOtaManagerInstance(build);

// Starts an OTA update.
mMeshOta.startOta();

Request parameters

ThingBlueMeshOtaBuilder

Parameter	Type	Description
data	byte[]	The byte stream of the target firmware.
meshId	String	The value of MeshId of the Bluetooth mesh device.
mac	String	The MAC address of the device.
productKey	String	The product ID of the device.
mNodeId	String	The value of NodeId for the device.
devId	String	The device ID.
version	String	The version number of the target firmware.

Update a Bluetooth mesh sub-device

Updates a Bluetooth mesh gateway in a similar way that a common Wi-Fi device is updated.

Example

private IOtaListener iOtaListener = new IOtaListener() {
    @Override
    public void onSuccess(int otaType) {
        // The firmware is updated.
    }

    @Override
    public void onFailure(int otaType, String code, String error) {
        // Failed to update the firmware.
    }

    @Override
    public void onProgress(int otaType, final int progress) {
        // The progress of the firmware update.
    }
};

IThingOta iThingOta = ThingHomeSdk.newOTAInstance(devId);
iThingOta.setOtaListener(mOtaListener);
// Starts an OTA update.
iThingOta.startOta();

// Destroys the update task.
iThingOta.onDestroy();