Skip to main content

API Device Integration

tip

All types of devices can be integrated into the Neuron platform via API.

1. Choose Integration Method​

In the Device Management List Page, click the "Add" button to begin the device integration process.

device_list

Select API as the integration method and click Next.

deviceAccess

2. Select Token​

tip

To push device data via API, you need to apply for a token in the Neuron platform and use the provided Demo algorithm to call the API for device integration.

Select an Existing Token​

Choose the required token and click Next to proceed to the device twin configuration.

You can search tokens by name and download the token text by clicking the red box on the right.

api_add_device_token

Create a New Token​

Click Add Token to enter the creation page and fill in a token name (must be unique in the system).

api_add_token_name

3. Configure Device Twins​

tip

Device Twins Definition: In the Neuron platform, a collection of devices with similar capabilities or characteristics is referred to as a device twin. See 【Device Twins Management】 for more details.

You can either choose an existing device twin or create a new one.

Select an Existing Device Twin​

Select the required device twin and click Next to proceed to the device registration page.

Search by device twin name/type/brand for quick filtering.

api_checked_device_twins

Create a New Device Twin​

Click Add Device Twin, fill in the twin information, and click Submit to create the device twin.

api_add_device_twins_name

Note: Device twin names must be unique. The system will validate the uniqueness during submission. If the name already exists, the creation will fail.

Configure Function Types (Points)​

After creating the device model, you can configure the Function Types under it.

Click the plus button as indicated in the image to enter the Function Type creation page.

lora_add_device_twins_functions

Select or add a Function Type in the input box. For additional configuration details, refer to 【Device Twins Management】.

lora_adding_device_twins_functions

Repeat the steps to add multiple Function Types if required. After configuration, click Next to proceed to the device registration page.

api_added_device_twins_functions

4. Device Registration​

You can register devices via online editing or batch Excel upload.

Bind Device to Platform Project​

Before registering the device, select the platform project it belongs to. Click the Project Dropdown to select an existing project. If no project exists, create one first. See 【Create Project】 for details.

lora_add_device_binding_project

Batch Excel Upload​

Steps: Download the template -> Fill in the Excel -> Upload the Excel -> Edit online if there are errors -> Click Next to complete the registration.

Download Template​

On the device registration page, click the red box to download the template file.

api_add_device_download_temp_iot

Fill in the Excel Template​

Fill in the required device information in the Excel file.

lora_add_device_download_temp_csv

  • DevEUI: Unique identifier for IoT devices, typically the DevEUI on the device. Required.
  • Device Name: Must be unique. Required.
  • Building Name: Location information. Required.
  • Location: Device location. Optional.

Upload Excel​

Click/Drag the filled Excel file into the platform using the red box. The uploaded device information will appear in an online table. Edit entries as needed.

api_add_device_upload_temp_iot

Online Editing​

Manually enter device information on the page. Click Add New to add a new row and continue entering device information.

lora_add_device_ui_add

Once all information is entered, click Submit. A confirmation window will appear. Confirm to complete the device registration.

lora_add_device_submit_confirm

Upon successful registration, the page will redirect to the Device Registration Page. When the platform receives properly formatted reported data, the device integration will be successful.

api_add_device_submit_success_iot

After successful registration, view device information and data in the device management interface. See 【Device Management】 for details.

API Call Method​

After completing device registration, you need to perform API calls in your system. See 【Open API Guide】 for details.

Note: Successful device registration indicates the device is recorded in the Neuron platform with the status Registered, but it is not yet connected to real-time data. Once the platform receives and processes reported data, the device status will change to Connected and appear in the device list.

API Code Examples​

Download the sample code files for reference: