nayota-show-sdk 0.0.3 → 0.0.5

package/api/alarmRecord.js

@@ -5,10 +5,9 @@
  */
 import { requestShow } from '../utils'
 
-
 /**
  * 获取列表
- * @param {*} query 
+ * @param {*} query
  * @param {number} query.page - 页码
  * @param {number} query.limit - 每页数量
  * @param {string} query.label - 模糊查询关键字
@@ -214,10 +213,9 @@ export function exportAlarmRecord(data) {
   })
 }
 
-
 /**
  * 获取报警详情
- * @param {string} 报警id 
+ * @param {string} 报警id
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
 * @returns {Object} data - 报警记录对象 字段见list返回字段
@@ -246,7 +244,7 @@ export function updateOne(data) {
 
 /**
  * 删除报警
- * @param {string} 报警id 
+ * @param {string} 报警id
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
 * @returns {Object} data - 报警记录对象 字段见list返回字段
@@ -260,7 +258,7 @@ export function deleteOne(id) {
 
 /**
  * 批量删除报警
- * @param {Array} 报警ids 
+ * @param {Array} 报警ids
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
  */

package/api/product.js

@@ -5,7 +5,197 @@
  */
 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
+/**
+  * 创建多平台设备
+  *
+  * @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 - 是否带云台，注意：摄像头类型才有此参数。
+  * @example <caption>请求范例</caption>
+  * RS485设备创建所需参数
+  * {
+  *  name: '485设备',
+  *  shortAddress: '06',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  control: '667a30ea3d569977280ea5fc',
+  *  parentType: 1,
+  *  parentId: '667a30ea3d569977280ea5fc',
+  * }
+  * Lorawan设备创建所需参数
+  * type为0时，必选参数
+  * {
+  *  name: 'Lorawan设备',
+  *  shortAddress: '06',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  control: '667a30ea3d569977280ea5fc',
+  *  type: 0,
+  *  devEui: '06',
+  *  deviceProfileId: '667d2ecc52d21700095b58b4',
+  *  deviceKeys: '06',
+  * }
+  * type为1时，必选参数
+  * {
+  *  name: 'Lorawan设备',
+  *  shortAddress: '06',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  control: '667a30ea3d569977280ea5fc',
+  *  type: 1,
+  *  devEui: '06',
+  *  deviceProfileId: '667d2ecc52d21700095b58b4',
+  *  devAddr: '06',
+  *  nwkSkey: '06',
+  *  appSkey: '06',
+  * }
+  * TCP设备创建所需参数
+  * type为0时，必选参数
+  * {
+  *  name: 'TCP设备',
+  *  shortAddress: '06',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  control: '667a30ea3d569977280ea5fc',
+  *  type: 0,
+  *  range: 3000,
+  *  tcp_client_ip: '192.168.1.1',
+  *  tcp_client_port: '80',
+  * }
+  * type为1时，必选参数
+  * {
+  *  name: 'TCP设备',
+  *  shortAddress: '06',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  control: '667a30ea3d569977280ea5fc',
+  *  type: 1,
+  *  range: 3000,
+  *  tcp_client_ip: '192.168.1.1',
+  * }
+  * type为2时，必选参数
+  * {
+  *  name: 'UDP设备',
+  *  shortAddress: '06',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  control: '667a30ea3d569977280ea5fc',
+  *  type: 2,
+  *  range: 3000,
+  *  udp_client_ip: '192.168.1.1',
+  *  udp_client_port: '80',
+  * }
+  * type为3时，必选参数
+  * {
+  *  name: 'UDP设备',
+  *  shortAddress: '06',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  control: '667a30ea3d569977280ea5fc',
+  *  type: 3,
+  *  range: 3000,
+  *  udp_client_ip: '192.168.1.1',
+  * }
+  * Http设备创建所需参数
+  * {
+  *  name: 'Http设备',
+  *  shortAddress: '06',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  control: '667a30ea3d569977280ea5fc',
+  *  ip: '192.168.1.1',
+  *  port: '80',
+  *  url: 'http://192.168.1.1',
+  *  range: 3000,
+  * }
+  * 摄像头设备创建所需参数
+  * 平台摄像头所传参数
+  * {
+  *  name: '摄像头设备',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  thirdPartyCameraAccount: '667d2ecc52d21700095b58b4',
+  *  number: '1',
+  *  channelNo: '1',
+  *  iconName: '摄像头',
+  *  describe: '备注',
+  *  line: true,
+  *  hasPtz: true,
+  * }
+  * 本地摄像头所传参数
+  * {
+  *  name: '摄像头设备',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  local_ip: '192.168.1.1',
+  *  local_username: 'admin',
+  *  local_password: '123456',
+  *  iconName: '摄像头',
+  *  describe: '备注',
+  *  line: true,
+  *  hasPtz: true,
+  * }
+  * WEBRTC摄像头创建所需参数
+  * {
+  *  name: 'WEBRTC摄像头',
+  *  depart: '667d2ecc52d21700095b58b4',
+  *  local_ip: '192.168.1.1',
+  *  local_username: 'admin',
+  *  local_password: '123456',
+  *  iconName: '摄像头',
+  *  describe: '备注',
+  *  line: true,
+  *  hasPtz: true,
+  * }
+  * @returns {Object} result - 返回结果
+  * @returns {number} result.code - 返回码，0表示成功
+  * @returns {string} result.data - 返回创建设备数据
+  * @returns {string} result.message - 返回信息
+*/
 function createAllDevice(data) {
   return request({
     url: `/product/${data._id}/createAllDevice`,

package/api/router.js

@@ -0,0 +1,93 @@
+import { requestShow } from '../utils'
+/**
+ * @file 路由api
+ * @module 路由接口
+ */
+/**
+ * 
+ * @param {*} query
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 路由总数
+ * @returns {Array} rows - 路由数组
+ * @returns {string} rows._id - 路由id
+ * @returns {string} rows.name - 路由名称
+ * @returns {string} rows.path - 路由路径
+ * @returns {number} rows.level - 路由等级
+ * @returns {number} rows.sort - 排序序号
+ * @returns {Array<mongoose.Schema.Types.ObjectId>} rows.children - 子路由列表
+ * @returns {('all'|'get'|'post'|'put'|'delete')} rows.method - HTTP请求方法
+ * @returns {string} rows.desc - 路由描述
+ * @returns {Array<mongoose.Schema.Types.ObjectId>} rows.roles - 关联的角色列表
+ * @returns {string} rows.icon - 路由图标
+ */
+export function list(query) {
+  return request({
+    url: '/routers',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增路由
+ * @param {Object} data - 包含路由的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
+ */
+export function create(data) {
+  return requestShow({
+    url: '/routers',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 修改路由
+ * @param {Object} data - 包含路由的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/routers/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除路由
+ * @param {string} id - 删除的路由id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/routers/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除路由
+ * @param {Array} ids - 删除的路由ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/routers',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany
+}
+

package/api/systeminfo.js

@@ -0,0 +1,57 @@
+/**
+ * @file 报警记录api
+ * @module 报警记录接口
+ * @memberof requestShow
+ */
+import { requestShow } from '../utils'
+/**
+  * 获取容器信息。
+  *
+  */
+export function containers() {
+  return requestShow({
+    url: '/system/containers/stats',
+    method: 'get'
+  })
+}
+
+/**
+ * 获取cpu信息。
+ *
+ */
+export function cpuinfo() {
+  return requestShow({
+    url: '/system/cpuinfo',
+    method: 'get'
+  })
+}
+
+/**
+ * 获取负载信息。
+ *
+ */
+export function loadavg() {
+  return requestShow({
+    url: '/system/loadavg',
+    method: 'get'
+  })
+}
+
+/**
+ * 获取内存信息。
+ *
+ */
+export function meminfo() {
+  return requestShow({
+    url: '/system/meminfo',
+    method: 'get'
+  })
+}
+
+export default {
+  containers,
+  cpuinfo,
+  loadavg,
+  meminfo
+
+}

package/index.js

@@ -3,9 +3,13 @@ import { init } from './utils'
 import emitter from './utils/EventEmitter'
 import alarmRecord from './api/alarmRecord'
 import alarmProgress from './api/alarmProgress'
+import systeminfo from './api/systeminfo'
+import router from './api/router'
 const api = {
   alarmRecord,
-  alarmProgress
+  alarmProgress,
+  systeminfo,
+  router
 }
 
 export default { config: options => {

package/package.json

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