NeoEdge X OT Device RESTful API

NeoEdge X 提供 RESTful API ，讓您的外部應用程式可以讀取(Read) 設備數據和發送 (Write) 控制指令來操控 OT 設備。本文件將說明 NeoEdge X RESTful API 的使用方式及每個欄位的定義，幫助您整合到您的應用系統。

讀取 OT Device Tag 數值
curl -X 'GET' 'http://<Gatewap_IP>:59882/api/v3/device/name/<Device_Name>/<Tag_Nme>' | jq '.event.readings[0]'
回覆內容
{
    "id": "5522d833-8383-48a5-b8ed-7a534a701ef3",
    "origin": <timestamp>,
    "deviceName": "<Device_Name>",
    "resourceName": "<Tag_Name>",
    "profileName": "<Porfile_Name>",
    "valueType": "<Tag_Type>",
    "value": "<Tag_Value>"
}
欄位名稱
說明

origin

數據擷取的Timestamp，單位為ns

deviceName

OT Device Name

resourceName

OT Tag Name

profileName

OT Profile Name，預設值為 <Device_Name>-profile

valueType

OT Tag Type

依照設定的tag資料型別，可能數值為：

[“Bool”, “Int16”, “Int32”, “Int64”, “Uint16”, “Uint32”, “Uint64”, “Float32”, “Float64”, “String”]
value Tag的讀值
寫入OT Device Tag 數值
curl -X 'PUT' 'http://<Gatewap_IP>:59882/api/v3/device/name/<Device_Name>/<Tag_Nme>' \
     -H 'Content-Type: application/json' \
     -d '{"<Tag_Nme>":<New_Value>}'
回覆內容
{
  "apiVersion": "v3",
  "statusCode": 200
}
欄位名稱
說明

statusCode

HTTP狀態碼

相關文章