Project Management

The user and device data between different projects are isolated, but the same user can be authorized to multiple projects.

Create a Project

1. Register and log in to Aqara Developer Platform;
2. Enter "Console" in the upper right corner, and click "Project Management" in the left navigation bar;
3. Click "New project" in the upper right corner;
4. Fill in "Project Name", "Industry Type", "Introduction" as required;
5. Click "Save" to submit for review;
6. The page jumps to the project list, you can view the basic information of the newly created project, including the appId, and the current "review status" is "pending review";
7. After the review is passed, the "review status" is changed to "approved", and the project details can be viewed.

Edit Project

1. On the "Project Management" page, you can view the list of projects under the current developer account;
2. Click the "Details" operation after any reviewed project to view the project details;
3. Click "Edit" to change the project information.

Manage Projects

The project details page includes functions such as "authorization management", "message push settings", "key management", "IP settings", and "device debugging". Developers can make relevant configurations according to actual needs.

Key Management

When the project is approved, a default key will be generated, which can be viewed on the "Project Details"-"Key Management" page. Developers can also click "Add" in the upper right corner to add a new key.

Authorization Management

Only with the authorization of the account can you access and control the devices under the account. Currently, the developer platform supports three types of authorization: Aqara account, virtual account and project authorization.

1. For detailed authorization process and interface, please refer to Authorization Management.
2. After the authorization is successful, on the "Project Details"-"Authorization Management" page, select the authorized "Server Area" and "Authorization Type";
3. View the list of authorized users, and support the operation of the "Jump to management platform" and "Device debugging" functions at the same time. -"Jump to management platform": Jump to different management platforms according to the authorization type, can manage and control devices in batches, view device trajectories, topology maps, etc., and quickly locate problems. -"Device debugging": You can jump to the device debugging page, view the device list, and perform online debugging.

Message push settings

Through the message push function, device data can be pushed to a third-party server for secondary development. For specific operations, please refer to Message Push Instructions.

IP settings

By default, the IP setting is empty, that is, you can access the interface without IP restrictions. If you consider security issues, you can configure an IP whitelist, that is, only the added IP can access the current project interface.

1. On the "Project Details"-"IP Settings" page, click "Add" in the upper right corner;
2. Fill in information such as "Network Outlet IP", "Server Area", "Status" according to the actual situation;
3. Click "Save" to view the basic configuration information on the list page.

Device debugging

The developer platform supports online device debugging for real devices and virtual devices.

Create a device

• Real Device

  Jump through the "Authorization Management" page, and you can perform online debugging of the devices under the authorized account.

• Virtual Device

  On the "Device debugging" page, click "Add" in the upper right corner, select "openId", "Virtual Device Model Value", "Virtual Gateway Device", and click Save to complete the creation.

  Note: You need to add the gateway device first, and then add the sub-devices.

Debugging device

On the "Device debugging" page, click "Debug" in the operation bar of the device to be debugged, select "Resource", "Method" and "Description" on the "Resource Control" page, fill in the corresponding JSON request, and click "Send" to send commands. In the "real-time log", you can view the result of the commands.

Delete device

Only virtual devices can be deleted on the "Device debugging" page, just click "Delete" in the operation bar.

The real device needs to be deleted through the interface or reset the device.