nayota-show-sdk 0.0.6 → 0.0.7

package/api/product.js

@@ -5,66 +5,126 @@
  */
 import { requestShow as request } from '../utils'
 
-// name	是	string	设备名称。
-// shortAddress	是	number	485设备/Http设备为设备短地址,TCP设备为设备mac地址,注意：Hardware(485)/NetDrive(TCP)/HttpDrive(Http)设备类型才有此参数且是必选。
-// depart	是	string	可视化层级的id。
-// control	是	number	网关id。
-// parentType	否	string	485设备所属父级设备的类型，tcp1，mqtt2.注意：Hardware(485)设备类型才有此参数。
-// parentId	否	string	所属mqtt设备的id或者所属tcp设备的id，注意：Hardware(485)设备类型才有此参数。
-// type	否	number	0：OTTA，1：ABP，Loranwan设备类型，注意：Lorawan设备类型才有此参数。
-// devEui	否	string	注意：Lorawan设备类型才有此参数，type为0和1时必选。
-// deviceProfileId	否	string	注意：Lorawan设备类型才有此参数，type为0和1时必选。
-// deviceKeys	否	string	注意：Lorawan设备类型才有此参数，type为0时必选。
-// devAddr	否	string	注意：Lorawan设备类型才有此参数，type为1时必选。
-// nwkSkey	否	string	注意：Lorawan设备类型才有此参数，type为1时必选。
-// appSkey	否	string	注意：Lorawan设备类型才有此参数，type为1时必选。
-// type	否	number	0：tcp客户端，1：tcp服务端，2：udp客户端，3：udp服务端，tcp设备类型，注意：NetDrive设备类型才有此参数。
-// range	否	number	设备轮询时间ms单位
-// tcp_client_ip	否	string	tcpIp，注意：NetDrive设备类型才有此参数且必选。
-// tcp_client_port	否	string	tcp端口，注意：NetDrive设备类型才有此参数，type为1时必选。
-// udp_client_ip	否	string	udpIp，注意：NetDrive设备类型才有此参数且必选。
-// udp_client_port	否	string	udp端口，注意：NetDrive设备类型才有此参数，type为3时必选。
-// ip	否	string	设备IP地址，注意：HttpDrive设备类型才有此参数且必选。
-// port	否	string	设备端口默认80，注意：HttpDrive设备类型才有此参数且必选。
-// url	否	string	设备url，注意：HttpDrive设备类型才有此参数且必选。
-// range	否	number	设备轮询时间ms单位，默认为3000ms，注意：HttpDrive设备类型才有此参数且必选。
-// describe, line, hasPtz
+
+// * RS485设备创建所需参数
+//   * {
+//   *  name: '485设备',
+//   *  shortAddress: '06',
+//   *  depart: '667d2ecc52d21700095b58b4',
+//   *  control: '667a30ea3d569977280ea5fc',
+//   *  parentType: 1,
+//   *  parentId: '667a30ea3d569977280ea5fc',
+//   * }
+
+/**
+ * RS485父级设备类型枚举
+ * @readonly
+ * @enum {number}
+ */
+var parentType = {
+  TCP: 1,
+  MQTT: 2
+}
+
+/**
+ * Lorawan设备类型枚举
+ * @readonly
+ * @enum {number}
+ */
+var lorawanType = {
+  OTTA: 0,
+  ABP: 1
+}
+
+/**
+ * TCP设备类型枚举
+ * @readonly
+ * @enum {number}
+ */
+var tcpType = {
+  tcp客户端: 0,
+  tcp服务端: 1,
+  udp客户端: 2,
+  udp服务端: 3
+}
+/**
+ * @typedef {Object} Hardware设备创建所需参数
+ * @property {string} _id - 产品id
+ * @property {string} name - 设备名称
+ * @property {string} shortAddress - 短地址
+ * @property {string} depart - 可视化层级的id
+ * @property {string} control - 网关id
+ * @property {number} parentType - 查看枚举类型parentType{@link parentType}。
+ * @property {string} parentId - 所属父级设备的id。
+ */
+
+/**
+ * @typedef {Object} Lorawan设备创建所需参数
+ * @property {string} _id - 产品id
+ * @property {string} name - 设备名称
+ * @property {string} shortAddress - 短地址
+ * @property {string} depart - 可视化层级的id
+ * @property {string} control - 网关id
+ * @property {number} type - 查看枚举类型lorawanType{@link lorawanType}。
+ * @property {string} devEui - devEui。
+ * @property {string} deviceProfileId - deviceProfileId。
+ * @property {string} deviceKeys - deviceKeys当type字段为0时必选。
+ * @property {string} devAddr - devAddr当type字段为1时必选。
+ * @property {string} nwkSkey - nwkSkey当type字段为1时必选。
+ * @property {string} appSkey - appSkey当type字段为1时必选。
+ */
+
+
+/**
+ * @typedef {Object} TCP设备创建所需参数
+ * @property {string} _id - 产品id
+ * @property {string} name - 设备名称
+ * @property {string} shortAddress - 短地址
+ * @property {string} depart - 可视化层级的id
+ * @property {string} control - 网关id
+ * @property {number} type - 查看枚举类型tcpType。
+ * @property {number} range - 设备轮询时间ms单位，默认为3000ms。
+ * @property {string} tcp_client_ip - tcpIp，type为0或者1时必选。
+ * @property {string} tcp_client_port - tcp端口，type为1时必选。
+ * @property {string} udp_client_ip - udpIp，type为2或者3时必选。
+ * @property {string} udp_client_port - udp端口，type为3时必选。
+ */
+
+/**
+ * @typedef {Object} HttpDrive设备创建所需参数
+ * @property {string} _id - 产品id
+ * @property {string} name - 设备名称
+ * @property {string} shortAddress - 短地址
+ * @property {string} depart - 可视化层级的id
+ * @property {string} control - 网关id
+ * @property {string} ip - 设备IP地址。
+ * @property {string} port - 设备端口默认80。
+ * @property {string} url - 设备url。
+ * @property {number} range - 设备轮询时间ms单位，默认为3000ms。
+ */
+
+/**
+ * @typedef {Object} 摄像头设备创建所需参数
+ * @property {string} _id - 产品id
+ * @property {string} name - 设备名称
+ * @property {string} depart - 可视化层级的id
+ * @property {string} thirdPartyCameraAccount - 平台账号id，查config三方摄像头账号接口，平台摄像头必选。
+ * @property {number} number - 设备序号，平台摄像头必选。
+ * @property {number} channelNo - 通道号，平台摄像头且三方摄像头的类型为2时必选，其余三方摄像头类型可选。
+ * @property {string} iconName - 设备图标。
+ * @property {string} local_ip - 本地RTSP地址，本地摄像头必选。
+ * @property {string} local_username - 本地用户名，本地摄像头必选。
+ * @property {string} local_password - 本地密码，本地摄像头必选。
+ * @property {string} describe - 设备备注。
+ * @property {boolean} line - 设备在离线。
+ * @property {boolean} hasPtz - 是否带云台。
+ */
+
+
+
 /**
-  * 创建多平台设备
-  *
-  * @param {Object} data - 包含参数的请求体。
-  * @param {string} data.name - 设备名称。
-  * @param {number} data.shortAddress - 485设备/Http设备为设备短地址,TCP设备为设备mac地址,注意：Hardware(485)/NetDrive(TCP)/HttpDrive(Http)设备类型才有此参数且是必选。
-  * @param {string} data.depart - 可视化层级的id。
-  * @param {string} data.control - 网关id。
-  * @param {number} data.parentType - 485设备所属父级设备的类型，tcp1，mqtt2.注意：Hardware(485)设备类型才有此参数。
-  * @param {string} data.parentId - 所属mqtt设备的id或者所属tcp设备的id，注意：Hardware(485)设备类型才有此参数。
-  * @param {number} data.type - 0：OTTA，1：ABP，Loranwan设备类型，注意：Lorawan设备类型才有此参数。
-  * @param {string} data.devEui - 注意：Lorawan设备类型才有此参数，type为0和1时必选。
-  * @param {string} data.deviceProfileId - 注意：Lorawan设备类型才有此参数，type为0和1时必选。
-  * @param {string} data.deviceKeys - 注意：Lorawan设备类型才有此参数，type为0时必选。
-  * @param {string} data.devAddr - 注意：Lorawan设备类型才有此参数，type为1时必选。
-  * @param {string} data.nwkSkey - 注意：Lorawan设备类型才有此参数，type为1时必选。
-  * @param {string} data.appSkey - 注意：Lorawan设备类型才有此参数，type为1时必选。
-  * @param {number} data.type - 0：tcp客户端，1：tcp服务端，2：udp客户端，3：udp服务端，tcp设备类型，注意：NetDrive设备类型才有此参数。
-  * @param {string} data.tcp_client_ip - tcpIp，注意：NetDrive设备类型才有此参数且必选。
-  * @param {string} data.tcp_client_port - tcp端口，注意：NetDrive设备类型才有此参数，type为1时必选。
-  * @param {string} data.udp_client_ip - udpIp，注意：NetDrive设备类型才有此参数且必选。
-  * @param {string} data.udp_client_port - udp端口，注意：NetDrive设备类型才有此参数，type为3时必选。
-  * @param {string} data.ip - 设备IP地址，注意：HttpDrive设备类型才有此参数且必选。
-  * @param {string} data.port - 设备端口默认80，注意：HttpDrive设备类型才有此参数且必选。
-  * @param {string} data.url - 设备url，注意：HttpDrive设备类型才有此参数且必选。
-  * @param {number} data.range - 设备轮询时间ms单位，默认为3000ms，注意：HttpDrive设备类型和NetDrive设备类型才有此参数且必选。
-  * @param {string} data.thirdPartyCameraAccount - 平台账号，查config三方摄像头账号接口，注意：摄像头类型才有此参数。
-  * @param {number} data.number - 设备序号，注意：摄像头类型才有此参数。
-  * @param {number} data.channelNo - 通道号，注意：摄像头类型才有此参数。
-  * @param {string} data.iconName - 设备图标，注意：摄像头类型才有此参数。
-  * @param {string} data.local_ip - 本地RTSP地址，注意：摄像头类型才有此参数。
-  * @param {string} data.local_username - 本地用户名，注意：摄像头类型才有此参数。
-  * @param {string} data.local_password - 本地密码，注意：摄像头类型才有此参数。
-  * @param {string} data.describe - 设备备注，注意：摄像头类型才有此参数。
-  * @param {boolean} data.line - 设备在离线，注意：摄像头类型才有此参数。
-  * @param {boolean} data.hasPtz - 是否带云台，注意：摄像头类型才有此参数。
+  * 通过产品类型添加设备，该接口会同时创建IOT设备、展示设备及可视化设备。
+  * @param {Object} data - 包含参数的请求体，data对象通过判断产品类型中的IOT设备类型字段创建不同类型的设备，摄像头设备则通过判断产品标签去判断，以下为不同类型设备创建所需参数。
   * @example <caption>请求范例</caption>
   * RS485设备创建所需参数
   * {
@@ -223,7 +283,7 @@ function list(query) {
   * 创建产品信息
   * @param {Object} data - 创建产品信息
   * @param {string} data.name - 产品名称。
-  * @param {string} data.productCode - 产品名称。
+  * @param {string} data.productCode - 产品型号。
   * @param {string} data.tags - 产品标签
   * @param {string} data.brand - 产品品牌
   * @param {string} data.img - 产品图片
@@ -234,7 +294,7 @@ function list(query) {
   * @param {string} data.description - 产品描述
   * @param {string} data.hardwareWord - 设备字典
   * @param {string} data.addressDesc - 地址介绍
-  * @param {string} data.deviceUI - 产品名称。
+  * @param {string} data.deviceUI - 展示模型UIid。
   * @param {string} data.deviceType - IOT设备类型
   */
 function create(data) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nayota-show-sdk",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "nayota-show-server rest-api",
   "type": "module",
   "main": "index.js",