设备写入数据接口

1.根据属性标识符写入值，可写入多个点位

请求语法

POST /equipment/{code}/write-by-code/values

请求参数

参数名称	类型	是否必选	位置	描述
code	String	是	path	需要读取的设备编码
values	object[]	是	body	需要写入的对象与值
values.fieldName	string	否	body	需要写入的属性标识符
values.value	object	否	body	需要写入的值

响应语法

HTTP/1.1 StatusCode

{
  "data": {
    "status": "string",
    "error": string,
    "duration": string,
    "details": {
    		"fieldName“: "string",
    		"message": "string"
    	},
    "success": bool
  },
  "code": number,
  "message": string
}

响应参数

参数名称	类型	描述
code	Number	HTTP状态码。返回200表示成功，返回其它状态码表示失败。
message	String	附加信息
data	Object	点位数据信息存储其中
data.status	string	是否成功, 全部成功显示 ok, 失败显示 fail
data.error	string	异常信息，
data.duration	string	持续时间
data.details	objects[]	写入详情
data.details.fieldName	string	写入失败点位的标识符
data.details.message	string	写入失败原因

举个例子

请求

curl -X POST "http://192.168.10.12:9700/equipment/xhjing_test_s7-1200_test/write-by-code/values" -H "accept: */*" -H "Content-Type: application/json" -d "[ { \"fieldName\": \"d1\", \"value\": 70.54 }, { \"fieldName\": \"d2\", \"value\": true}]"

响应(部分成功，部分失败)：

{
  "data": {
    "status": "fail",
    "error": null,
    "duration": null,
    "details": [
      {
        "fieldName": "d1",
        "message": "属性d1的值70.54不是合法值"
      }
    ],
    "success": false
  },
  "code": 200,
  "message": null
}

响应（全成功）：

{
  "data": {
    "status": "ok",
    "error": null,
    "duration": null,
    "details": [],
    "success": true
  },
  "code": 200,
  "message": null
}

响应（全失败）:

{
  "data": {
    "status": "fail",
    "error": null,
    "duration": null,
    "details": [
      {
        "fieldName": "d1",
        "message": "属性d1的值80.2不是合法值"
      },
      {
        "fieldName": "d2",
        "message": "属性d2的值12不是合法值"
      }
    ],
    "success": false
  },
  "code": 200,
  "message": null
}

2.根据属性标识符写入值，单点位写入

请求语法

POST /equipment/{code}/write-by-code/{fieldName}

请求参数

参数名称	类型	是否必选	位置	描述
code	String	是	path	需要读取的设备编码
fieldName	string	是	path	需要写入的属性标识符
values	object	是	body	需要写入的值

响应语法

HTTP/1.1 StatusCode

{
  "data": {
    "status": "string",
    "error": string,
    "duration": string,
    "details": {
    		"fieldName“: "string",
    		"message": "string"
    	},
    "success": bool
  },
  "code": number,
  "message": string
}

响应参数

参数名称	类型	描述
code	Number	HTTP状态码。返回200表示成功，返回其它状态码表示失败。
message	String	附加信息
data	Object	点位数据信息存储其中
data.status	string	是否成功, 全部成功显示 ok, 失败显示 fail
data.error	string	异常信息，
data.duration	string	持续时间
data.details	objects[]	写入详情
data.details.fieldName	string	写入失败点位的标识符
data.details.message	string	写入失败原因

举个例子

请求

curl -X POST "http://192.168.10.12:9700/equipment/xhjing_test_s7-1200_test/write-by-code/d1" -H "accept: */*" -H "Content-Type: application/json" -d "123"

响应：写入成功

{
  "data": {
    "status": "ok",
    "error": null,
    "duration": null,
    "details": [],
    "success": true
  },
  "code": 200,
  "message": null
}

响应：写入失败

{
  "data": {
    "status": "fail",
    "error": null,
    "duration": null,
    "details": [
      {
        "fieldName": "d1",
        "message": "属性d1的值52.1不是合法值"
      }
    ],
    "success": false
  },
  "code": 200,
  "message": null
}

2024-10-16

设备写入数据接口

1.根据属性标识符写入值，可写入多个点位

2.根据属性标识符写入值，单点位写入

本页目录