设备传感器API - 新大陆物联网云平台

请求方式及地址

   GET 
   http://api.nlecloud.com/devices/{deviceId}/Sensors/{apiTag}

URL请求参数

参数	类型	描述	其它
deviceId	integer	设备ID（必须）	Required
apiTag	string	传感标识名（必须）	Required
isPrivate	boolean		Default value is False

响应参数

参数	类型	描述
ResultObj	SensorBaseInfoDTO
Status	ResultStatus	返回状态
StatusCode	integer	返回的状态码
Msg	string	返回的消息
ErrorObj	Object

响应示例

{
  "ResultObj": {
     "ApiTag": "sample string 1",
     "Groups": 64,
     "Protocol": 64,
     "Name": "sample string 4",
     "CreateDate": "sample string 5",
     "TransType": 64,
     "DataType": 64,
     "TypeAttrs": { },
     "DeviceID": 9,
     "SensorType": "sample string 10",
     "Value": { },
     "RecordTime": "sample string 12",
     --------传感器时的字段----------
     "Unit": "m/s",
     --------执行器时的字段----------
     "OperType": 2,
     "OperTypeAttrs": {"MaxRange" : 180, "MinRange" : 0, "Step" : 10},
     --------摄像头时的字段----------
     "HttpIp": "192.168.14.222",
     "HttpPort": 805,
     "UserName": "admin",
     "Password": "123456",
     "VideoStreamUrl": "/videostream.cgi?user={1}&pwd={2}&resolution=8&rate=0",
     "VideoStreamProtocol": "http",
     "VideoStreamPort": "",
     "CtrlUrl": "/decoder_control.cgi?user={1}&pwd={2}&command={3}&t={4}",
   },
   "Status": 0,
   "StatusCode": 1,
   "Msg": "sample string 2",
   "ErrorObj": { }
}

请求方式及地址

   GET 
   http://api.nlecloud.com/devices/{deviceId}/Sensors

URL请求参数

参数	类型	描述	其它
deviceId	integer	设备ID（必须）	Required
apiTags	string	传感标识名（必须），多个标识名之间用逗号分开（参数值为空时查询所有传感器）	Required
isPrivate	boolean		Default value is False

响应参数

参数	类型	描述
ResultObj	Collection of SensorBaseInfoDTO
Status	ResultStatus	返回状态
StatusCode	integer	返回的状态码
Msg	string	返回的消息
ErrorObj	Object

响应示例

{
  "ResultObj": [
   {
     "ApiTag": "sample string 1",
     "Groups": 1,
     "Protocol": 1,
     "Name": "sample string 4",
     "CreateDate": "sample string 5",
     "TransType": 1,
     "DataType": 1,
     "TypeAttrs": {},
     "DeviceID": 1,
     "SensorType": "sample string 10",
     "Value": {},
     "RecordTime": "sample string 12",
     --------传感器时的字段----------
     "Unit": "m/s",
     --------执行器时的字段----------
     "OperType": 2,
     "OperTypeAttrs": {"MaxRange" : 180, "MinRange" : 0, "Step" : 10},
     --------摄像头时的字段----------
     "HttpIp": "192.168.14.222",
     "HttpPort": 805,
     "UserName": "admin",
     "Password": "123456",
     "VideoStreamUrl": "/videostream.cgi?user={1}&pwd={2}&resolution=8&rate=0",
     "VideoStreamProtocol": "http",
     "VideoStreamPort": "",
     "CtrlUrl": "/decoder_control.cgi?user={1}&pwd={2}&command={3}&t={4}",
  },
  {
      "ApiTag": "sample string 1", 
      "Groups": 64, 
      "Protocol": 64, 
      "Name": "sample string 4",
      "CreateDate": "sample string 5",
      "TransType": 64,
      "DataType": 64,
      "TypeAttrs": {},
      "DeviceID": 9,
      "SensorType": "sample string 10",
      "Value": {},
      "RecordTime": "sample string 12",
      --------传感器时的字段----------
      "Unit": "m/s",
      --------执行器时的字段----------
      "OperType": 2,
      "OperTypeAttrs": {"MaxRange" : 180, "MinRange" : 0, "Step" : 10},
      --------摄像头时的字段----------
      "HttpIp": "192.168.14.222",
      "HttpPort": 805,
      "UserName": "admin",
      "Password": "123456",
      "VideoStreamUrl": "/videostream.cgi?user={1}&pwd={2}&resolution=8&rate=0",
      "VideoStreamProtocol": "http",
      "VideoStreamPort": "",
      "CtrlUrl": "/decoder_control.cgi?user={1}&pwd={2}&command={3}&t={4}",
  }
 ],
 "Status": 0,
 "StatusCode": 1,
 "Msg": "sample string 2",
 "ErrorObj": { }
}

请求方式及地址

   POST 
   http://api.nlecloud.com/devices/{deviceId}/Sensors

URL请求参数

参数	类型	描述	其它
deviceId	integer	设备ID	Required

包体请求参数

参数	类型	描述	其它
Name	String	名称（中英文、数字或下划线的2到10个字符）
ApiTag	String	标识名（英文、数字与下划线，须以英文字母开头，设备内唯一）
TransType	byte	传输类型（可选，0：只上报1：上报和下发2：报警3：故障，默认0）	传感器无法添加为【1：上报和下发】类型
DataType	byte	数据类型（可选，0：整数型1：浮点型2：布尔型3：字符型4：枚举型5：二进制型，默认0）	当TransType传输类型为报警或故障时，此参数无效，强制为布尔型
TypeAttrs	String	数据类型的附加属性（可选，如枚举型值以半角逗号分隔：可爱，有在，装备，蜗牛）	当数据类型未定义为指定类型（如枚举型）时，此参数无效
传感器还包括以下字段
Unit	integer	单位（可选，定义传感器的单位）
Precision	byte	精度（可选，默认保留两位小数）
执行器还包括以下字段
OperType	byte	操作类型（1：开关型 2：开关停型 3：按钮型 4：刻度型）	未定义此依赖参数时，其他执行器参数无效
OperTypeAttrs	String	操作类型的附加属性（JSON格式，如刻度型时定义：{"MaxRange" : 180 ,"MinRange" : 0, "Step" : 10}）
摄像头还包括以下字段
HttpIp	String	IP地址	未定义此依赖参数时，其他摄像头参数无效
HttpPort	integer	端口（定义视频流或控制流的端口，默认80）
UserName	String	登录用户名
Password	String	登录密码
VideoStreamUrl	String	视频流路径（一般是以“/”开头的一串字符串路径，每产家每款摄像头一般不一样）
VideoStreamProtocol	String	视频流协议（可选，值可以是http/rtsp）
VideoStreamPort	integer	视频流端口（可选，若视频流端口与HttpPort字段不一致时可定义）
CtrlUrl	String	控制流路径（一般是以“/”开头的一串字符串路径，每产家每款摄像头一般不一样）

请求示例

响应参数

参数	类型	描述
ResultObj	integer
Status	ResultStatus	返回状态
StatusCode	integer	返回的状态码
Msg	string	返回的消息
ErrorObj	Object

响应示例

{
  "ResultObj": 1,
  "Status": 0,
  "StatusCode": 2,
  "Msg": "sample string 3",
  "ErrorObj": {}
}

请求方式及地址

   PUT 
   http://api.nlecloud.com/devices/{deviceId}/Sensors/{apiTag}

URL请求参数

参数	类型	描述	其它
deviceId	integer	设备ID	Required
apiTag	string	传感器标识名	Required

包体请求参数

参数	类型	描述	其它
Name	String	名称（中英文、数字或下划线的2到10个字符）
TransType	byte	传输类型（可选，0：只上报1：上报和下发2：报警3：故障，默认0）	传感器无法添加为【1：上报和下发】类型
DataType	byte	数据类型（可选，0：整数型1：浮点型2：布尔型3：字符型4：枚举型5：二进制型，默认0）	当TransType传输类型为报警或故障时，此参数无效，强制为布尔型
TypeAttrs	String	数据类型的附加属性（可选，如枚举型值以半角逗号分隔：可爱，有在，装备，蜗牛）	当数据类型未定义为指定类型（如枚举型）时，此参数无效
传感器还包括以下字段
Unit	integer	单位（可选，定义传感器的单位）
Precision	byte	精度（可选，默认保留两位小数）
执行器还包括以下字段
OperType	byte	操作类型（1：开关型 2：开关停型 3：按钮型 4：刻度型）	未定义此依赖参数时，其他执行器参数无效
OperTypeAttrs	String	操作类型的附加属性（JSON格式，如刻度型时定义：{"MaxRange" : 180 ,"MinRange" : 0, "Step" : 10}）
摄像头还包括以下字段
HttpIp	String	IP地址	未定义此依赖参数时，其他摄像头参数无效
HttpPort	integer	端口（定义视频流或控制流的端口，默认80）
UserName	String	登录用户名
Password	String	登录密码
VideoStreamUrl	String	视频流路径（一般是以“/”开头的一串字符串路径，每产家每款摄像头一般不一样）
VideoStreamProtocol	String	视频流协议（可选，值可以是http/rtsp）
VideoStreamPort	integer	视频流端口（可选，若视频流端口与HttpPort字段不一致时可定义）
CtrlUrl	String	控制流路径（一般是以“/”开头的一串字符串路径，每产家每款摄像头一般不一样）

请求示例

响应参数

参数	类型	描述
Status	ResultStatus	返回状态
StatusCode	integer	返回的状态码
Msg	string	返回的消息
ErrorObj	Object

响应示例

{
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

请求方式及地址

   DELETE 
   http://api.nlecloud.com/devices/{deviceId}/Sensors/{apiTag}

URL请求参数

参数	类型	描述	其它
deviceId	integer	设备ID	Required
apiTag	string	传感标识名	Required

响应参数

参数	类型	描述
Status	ResultStatus	返回状态
StatusCode	integer	返回的状态码
Msg	string	返回的消息
ErrorObj	Object

响应示例

{
  "Status": 0,
  "StatusCode": 1,
  "Msg": "sample string 2",
  "ErrorObj": {}
}

应用开发●API接口●设备传感器API

查询单个传感器

模糊查询传感器

添加个新传感器

更新某个传感器

删除某个传感器