Firmware guide for Mesh light applications based on the TG7100B chip

TG7100B overview

The TG7100B is a cost-effective Bluetooth chip customized by Tmall Genie for Bluetooth Mesh access. It features a simple circuit design, excellent radio frequency (RF) performance, low power consumption, and an automotive-grade temperature range of -40 °C to 125 °C. For documents and software tools related to the TG7100B chip, see TG7100B.

Compile and flash the firmware

1. Download the SDK. For the download link, see Get the SDK. Make sure that you download TG7100B SDK V1.3.4.
2. Configure the development environment. For more information, see Prepare the development environment.
3. Compile the firmware. For more information, see Develop device firmware.
   Note

   • Generated flashing file: out/bluetooth.light_ctl@tg7100b/binary/total_image.hexf
   • Generated OTA file: out/bluetooth.light_ctl@tg7100b/binary/fota.bin
4. Flash the firmware. For more information, see Flash the firmware.
5. Flash the device certificate.
   • Disconnect the TG71XX Programmer.exe flashing tool, set the DIP switch on the development board to GND, and press the reset button on the board.
   • Open the SecureCRT serial debugging tool, select File > Quick Connect, and configure the serial port parameters for the development board as shown in the following figure. The default baud rate is 512000.
     Note The port number must be the same as the one that is automatically detected by the TG71XX Programmer.exe tool. You can also find the port number by right-clicking This PC and selecting Manage > System Tools > Device Manager > Ports (COM & LPT). The path to Device Manager may vary based on your operating system.
     
   • Click Connect.
   • Enter the following command to flash the device certificate.

     set_tt <ProductID> <Device Secret> <Device Name>

     Note The Product id, Device Secret, and Device Name (MAC address) in this command are the device certificate credentials that are generated when you add a device.

Application model configuration

For more information about Mesh Models, see Mesh Model guide for Bluetooth Mesh light applications. The light_ctl application example in the Bluetooth Mesh SDK implements control only for the on/off state, brightness, color temperature, and scene modes. The following table lists the Thing Specification Language (TSL) models and Attribute Types that are supported by default in the firmware.

The code that corresponds to the model configuration is in the app/example/bluetooth/light_ctl/light_ctl.c file, as shown below.

/* SIG general-purpose model definitions in the light product */
static struct bt_mesh_model primary_element[] = {
    BT_MESH_MODEL_CFG_SRV(),     /* Configuration Server */
    BT_MESH_MODEL_HEALTH_SRV(),  /* Health Server */

  MESH_MODEL_GEN_ONOFF_SRV(&light_elem_stat[0]),    /* On/Off Generic OnOff Server */
  MESH_MODEL_LIGHTNESS_SRV(&light_elem_stat[0]),    /* Lightness Server */
  MESH_MODEL_CTL_SRV(&light_elem_stat[0]),          /* Color Temperature Light CTL Server */
  MESH_MODEL_SCENE_SRV(&light_elem_stat[0]),        /* Scene Mode Scene Server */
};
/* Vendor-defined model definitions */
static struct bt_mesh_model primary_vendor_element[] = {
  MESH_MODEL_VENDOR_SRV(&light_elem_stat[0]),
};

/* Register the SIG general-purpose models and vendor-defined models for the main element of the light. GENIE_ADDR_LIGHT is defined as the multicast address 0xC000 for the light category. */
struct bt_mesh_elem light_elements[] = {
  BT_MESH_ELEM(0, primary_element, primary_vendor_element, GENIE_ADDR_LIGHT),
};

Application layer event handling

The code for application layer event handling is located in the app/example/bluetooth/light_ctl/light_ctl.c file, as shown below.

static void light_ctl_event_handler(genie_event_e event, void *p_arg)
{
  switch (event)
  {
  case GENIE_EVT_SW_RESET:                            /* Software reset */
  {
    light_param_reset();
    light_led_blink(3, 1);
    aos_msleep(3000);
  }
  break;
  case GENIE_EVT_MESH_READY:                          /* The Mesh protocol stack is ready. Data can be sent and received. */
  {
    //User can report data to cloud at here
    GENIE_LOG_INFO("User report data");
    light_report_poweron_state(&light_elem_stat[0]);
  }
  break;
  case GENIE_EVT_SDK_MESH_PROV_SUCCESS:               /* Network provisioning successful */
  {
    light_led_blink(3, 0);                          /* The light blinks to indicate successful network provisioning. */
  }
  break;
#ifdef CONFIG_MESH_MODEL_TRANS
  case GENIE_EVT_USER_TRANS_CYCLE:
#endif
  case GENIE_EVT_USER_ACTION_DONE:                    /* Light effect transition finished */
  {
    sig_model_element_state_t *p_elem = (sig_model_element_state_t *)p_arg;
    light_update(p_elem);    
    if (event == GENIE_EVT_USER_ACTION_DONE)
    {
      light_save_state(p_elem);
    }
  }
  break;
  case GENIE_EVT_SIG_MODEL_MSG:                      /* Received a downstream SIG Model message */
  {
    sig_model_msg *p_msg = (sig_model_msg *)p_arg;

    if (p_msg)
    {
      GENIE_LOG_INFO("SIG mesg ElemID(%d)", p_msg->element_id);
    }
  }
  break;
  case GENIE_EVT_VENDOR_MODEL_MSG:                   /* Received a downstream Vendor Model message */
  {
    genie_transport_model_param_t *p_msg = (genie_transport_model_param_t *)p_arg;

    if (p_msg && p_msg->p_model && p_msg->p_model->user_data)
    {
      sig_model_element_state_t *p_elem_state = (sig_model_element_state_t *)p_msg->p_model->user_data;
      GENIE_LOG_INFO("ElemID(%d) TID(%d)", p_elem_state->element_id, p_msg->tid);
    }
  }
  break;
#ifdef CONFIG_GENIE_MESH_USER_CMD                     /* Used to implement a custom serial protocol */
  case GENIE_EVT_DOWN_MSG:
  {
    genie_down_msg_t *p_msg = (genie_down_msg_t *)p_arg;
    //User handle this msg,such as send to MCU    /* Here, you can forward data to the MCU based on a custom serial protocol. */
    if (p_msg)
    {
    }
  }
  break;
#endif
#ifdef MESH_MODEL_VENDOR_TIMER
  case GENIE_EVT_TIMEOUT:                           /* Entry point for handling local TimerOnOff timeouts */
  {
    vendor_attr_data_t *pdata = (vendor_attr_data_t *)p_arg;
    //User handle vendor timeout event at here
    if (pdata)
    {
      light_ctl_handle_order_msg(pdata);        /* The light On/Off operation is performed here. */
    }
  }
  break;
#endif
  default:
    break;
            

Serial command description

The following serial commands can be used for development and debugging.

Firmware macro definitions