Bluetooth Pairing

Overview

Description

For Wi-Fi and Bluetooth combo devices, the pairing data can be sent to the device over Bluetooth.

After entering pairing mode, the device sends Bluetooth advertising packets and waits to be discovered by the mobile app. The mobile app can initiate a Bluetooth connection to the device and send pairing data to it.

Pairing process

Initialization process

Development guide

Runtime environment

Be sure tuya_iot_config.h is configured in the header file and enable the Bluetooth service and Bluetooth pairing. The code below shows the macros that should be enabled.

/* Enable/disable Bluetooth service */
#define ENABLE_BT_SERVICE 1
/* Enable/disable Bluetooth pairing */
#define ENABLE_BT_NETCFG 1

Associated components

• svc_bt

How to

During initialization, Bluetooth pairing is initialized automatically.

API description

Set Bluetooth device name

This API is used to change the Bluetooth device name. In Tuya’s Bluetooth protocol v3.x, the default Bluetooth device name is TY. In v4.x, the default name is TUYA__. The macro TUYA_BLE_VER in tuya_iot_config.h specifies the protocol version you use.

/**
 * @brief Set name for Bluetooth device.
 *
 * @param[in] dev_name: device name
 *
 * @note This API is used for setting the name of Bluetooth device. This API should be called before Bluetooth is initialized.
 *
 * @return OPRT_OK on success. For others on error, please refer to tuya_error_code.h
 */
OPERATE_RET tuya_set_bt_device_name(CHAR_T* dev_name);

Enable/disable the Bluetooth service

This API is used to enable or disable the Bluetooth service. If you disable this service, the Bluetooth stack is turned off and Bluetooth is unavailable. By default, the Bluetooth service is enabled.

/**
 * @brief Set enable switch for Bluetooth service
 *
 * @param[in] switch: enable switch: TRUE-open, FALSE-close
 *
 * @note This API is used for enabling Bluetooth service. It should be called before SDK initialization.
 *
 * @return VOID
 */
VOID_T tuya_ble_set_serv_switch(BOOL_T swith);

Get the status of Bluetooth service

This API is used to check if the Bluetooth service is enabled.

/**
 * @brief Get status of Bluetooth service
 *
 * @param VOID
 *
 * @note This API is used to get status of the Bluetooth service.
 *
 * @return status of the Bluetooth service
 */
TUYA_BT_SERV_STAT tuya_ble_get_serv_stat(VOID_T);

Restart Bluetooth advertising

This API is used to restart Bluetooth advertising. When advertising parameters are updated, this API is called to update the advertising packets. For common applications, there is no need to take care of this API.

/**
 * @brief Resend the Bluetooth adv data to hal and start Bluetooth adv
 *
 * @param
 *
 * @note
 *
 * @return VOID
 */
VOID_T tuya_ble_restart_adv(VOID_T);

Set Bluetooth startup property

This API is used to set the Bluetooth startup property. If you do not call this API, all Bluetooth capabilities are started by default when the device boots.

• If you set TUYA_BLE_ABILITY_NONE, the Bluetooth service is not started when the device boots.

• If you set TUYA_BLE_ABILITY_NETCFG, only Bluetooth pairing is enabled when the device boots. The Bluetooth service will be disabled after the device is paired.

  typedef BYTE_T TUYA_BLE_ABILITY_T;
  #define TUYA_BLE_ABILITY_NONE      0x0
  #define TUYA_BLE_ABILITY_NETCFG    0x1
  #define TUYA_BLE_ABILITY_ALL       0xFF
  /**
  	* @brief Set abilitiy attribute of Bluetooth
  	*
  	* @param attr
  	*
  	* @note  This API is used to set abilitiy attribute of Bluetooth.
  	*
  	* @return VOID
  */
  VOID_T tuya_ble_set_startup_attr(TUYA_BLE_ABILITY_T attr);
  

FAQs

To reduce power usage, can I disable the Bluetooth service after the device is paired over Bluetooth?

Yes, you can.

There are two options to achieve this:

• Option 1: Before the framework is initialized, set tuya_ble_set_startup_attr to only enable Bluetooth pairing.
• Option 2: After the device is paired, call tuya_ble_set_serv_switch and set it to FALSE to disable the Bluetooth service.

Why can’t devices be discovered during pairing?

Check if the device sends advertising packets using the nRF Sniffer. If the device fails to send advertising packets, it cannot be discovered by the Smart Life app.

If the device can send advertising packets, check if it has been paired. If so, reset the device and pair it again.