跳至主要内容

API 設備接入

概述

本文檔詳細介紹了通過 API 方式將設備接入 Neuron 平台的完整流程。接入過程包括選擇 API 接入方式、配置存取令牌、定義設備物模型,最終完成設備註冊。

提示

該方式適用於需要通過程式設計介面直接上報設備數據的場景,平台提供多語言程式碼範例(Python/Java/Golang/.Net)輔助開發。設備成功註冊後,通過呼叫 OpenAPI 介面上報數據,平台接收並處理數據後,設備狀態將從"已登記"更新為"已連線"。

開始之前

權限配置

為確保以下操作流程正常進行,請您確認是否擁有專案管理員權限。

前置配置

配置物模型

提示

物模型定義:在 Neuron 平台內,將某一類具有相同能力或特徵的設備的合集被稱為一款物模型。

設備接入前可在中台物模型列表中進行預配置,或在設備接入過程中逐一配置。詳情請見【物模型管理】。

device_twins_list


選擇接入方式

設備管理列表頁點選“新增”按鈕,進入設備接入流程。

device_list

接入方式選擇 API,點選下一步

deviceAccess

選擇令牌

提示

使用 API 推送設備數據,需要在 Neuron 平台先申請令牌,根據提供的 Demo 演算法,呼叫 API 介面完成設備接入。

選擇已存在的令牌

選擇所需的令牌後點選下一步,進入物模型的配置。

支援透過令牌名稱快速檢索,點選右側紅框處可以下載令牌文字。

api_add_device_token

新增令牌

點選新增令牌,進入新增介面,填寫令牌名稱(系統內不可重複)。

api_add_token_name

選擇物模型

選擇已存在的物模型

支援透過物模型名稱/類型/品牌快速檢索。

api_checked_device_twins

新增物模型

點選新增物模型按鈕,進入新增介面,填寫物模型資訊後,點選“提交”按鈕建立物模型。

api_add_device_twins_name

注意:物模型名稱不可重複,資訊提交時系統會驗證名稱唯一性,名稱重複則新增不成功。

配置 Function Type (點)

建立物模型成功後,可直接進行該物模型下的 Function Type 配置。

點選圖中所指的“+”按鈕,進入 Function Type 新增頁。

lora_add_device_twins_functions

點選 Function type 輸入框,選擇/新增一個 Function type。其餘配置說明詳見【物模型管理】。

lora_adding_device_twins_functions

如該物模型有多個 Function Type 可重複上面步驟,新增多個 Function Type。配置完成後,點選下一步,進入設備註冊頁面。

api_added_device_twins_functions

設備註冊

支援兩種錄入方式:線上編輯下載 Excel 批次錄入

設備綁定平台專案

註冊設備前,請先選擇設備所屬的專案。點選專案下拉框選擇現有專案。如尚未建立專案,請先新增一個,操作詳見【建立專案】。

lora_add_device_binding_project

批次 Excel

操作步驟:下載範本 -> 填寫 Excel -> 上傳 Excel -> 如有錯誤則進行線上編輯 -> 點選下一步完成設備註冊。

下載範本

在設備註冊頁,點選下圖紅框處,下載範本檔案。

api_add_device_download_temp_iot

填寫 Excel

將需要錄入的設備資訊填入 Excel。

lora_add_device_download_temp_csv

  • DevEUI:IoT 設備唯一標識,通常填寫設備上的 DevEUI 即可,必填;
  • deviceName:設備名稱,不可重複,必填;
  • buildingName:樓宇位置資訊,必填;
  • location:設備位置,非必填。

上傳 Excel

點選/拖曳下圖紅框處,將填寫好的 Excel 上傳至平台。上傳的設備資訊將會展示在線上表格中,如有錯誤可以繼續增刪改。

api_add_device_upload_temp_iot

線上編輯

在頁面上填寫設備資訊,點選新增按鈕新增新一行,繼續錄入設備資訊。

lora_add_device_ui_add

設備資訊填寫完成後,點選提交按鈕,出現確認視窗,確認後即可完成設備註冊。

lora_add_device_submit_confirm

註冊完成後會跳轉到設備註冊頁,平台接收到規範的上報數據後,設備即接入成功。設備註冊成功後,可在設備管理介面檢視設備資訊及數據,具體操作詳見【設備管理】。

api_add_device_submit_success_iot

注意:設備註冊成功表示已在 Neuron 平台登記,狀態為已登記,但未接通即時數據。系統接收到上報的數據並清洗入庫後,設備狀態更新為已連線,並顯示在設備列表中。


API 呼叫方法

完成設備註冊後,需在您的系統內完成 API 呼叫,操作詳見【Open API 指南】。

API 程式碼範例下載

Python 範例檔案

JAVA 範例檔案

Golang 範例檔案

.Net 範例檔案