TCP

This guide will show you how to integrate TCP protocol devices into Aqara Studio by writing JS scripts, and how to map device function points according to the Aqara Data Model Specification, enabling device discovery, addition, and control of function points.

Learn and Write JavaScript Scripts

Please refer to the JavaScript script (for UDP and TCP) guide to write a JavaScript script that complies with the Aqara Data Model Specification. This script instructs Aqara Studio how to discover devices, and add and control function points.

Add TCP Devices

1. In the left sidebar, click to enter the Devices page. In the left Protocols and Devices panel, click the ... button and select Add Protocol.

   

2. In the popup, select TCP to add a TCP node.

   

3. Select the node to enter the management page. Click the Protocol Configuration button.

   

4. In the popup, click the Script Configuration button.

   

5. Paste the JavaScript script you wrote into the code editor, ensuring that the TCP device and its function points can be correctly recognized and managed by Aqara Studio.

   

6. (Optional) If you want to use msgId to match sent messages with received messages, enable the Match by msgId switch. If it is not enabled, messages are processed in order.

   

7. Return to the TCP management page and click the Add Device button.

   

8. In the popup, select Auto Discovery as the integration method, then select Start Integrating Device to proceed to the next step.

   

9. (Optional) Click the ⚙ icon.

   

   If your TCP device is discovered via the TCP protocol, select the TCP option; if your TCP device is discovered via the UDP protocol, select the UDP option.

   tip

   If you do not use the following configuration, it is recommended to directly specify the target TCP device's IP address and port number in the return value of parseDiscoveryResponse in the JS script to achieve precise device discovery and integration.

   • TCP:
     Enter the target TCP IP address and port number in the popup. This information will be used by the buildDiscoveryRequest interface in the JS script to instruct Aqara Studio to automatically discover all TCP devices at the specified address.

     

   • UDP:
     Set Discovery Type to UDP.

     

     Enter the UDP server IP address and port number in the popup. This information will be used by the buildDiscoveryRequest interface in the JS script to instruct Aqara Studio to automatically discover all TCP devices at the specified address.

     

10. Click the Discover Devices button.

    Aqara Studio will automatically scan and identify TCP devices that can be integrated based on the JS script you wrote, and the discovered devices will be displayed in the Discovered Devices list.

    

11. Select the devices to integrate and click the + button in the center.

    

    Newly added devices will appear in the Added Device List on the right. Click the Complete button to exit the add device process.

    

12. You will then see the successfully added devices under the TCP node in the left Protocols and Devices panel, as well as in the device list on the TCP management page.

    

Add Points

1. Under the TCP node, select a TCP device and click the Add Point button.

   

2. Click the Discover Points button.

   tip

   • If the device function points are dynamic, implement the buildDiscoverPointsRequest and parseDiscoverPointsResponse interfaces in the JS script.
     In this case, when you click the Add Point button, Aqara Studio calls buildDiscoverPointsRequest to dynamically discover device function points, and uses the return value of that interface as the input of parseDiscoverPointsResponse.
   • If the device function points are static, implement the parseDiscoverPointsResponse interface in the JS script, and directly provide the target device's function-point list in the return value.
     In this case, when you click the Add Point button, Aqara Studio will discover these function points directly.
   

3. In the Discovered Points list, check the required points and click the middle + button.

   

   Newly added points will appear in the Added Points list on the right. Click the Complete button to exit the add points process.

   

4. You will then see the successfully added points on the management page of that TCP device.

   

Next Steps

Now, you can view details and control the device, or use the device in automation.