nayota-show-sdk 0.0.2 → 0.0.4

package/api/alarmProgress.js

@@ -1,6 +1,6 @@
 /**
  * @file 报警进度接口
- * @module requestShow.alarmProgress  
+ * @module 报警进度接口
  * @memberof requestShow
  */
 import { requestShow } from '../utils'

package/api/alarmRecord.js

@@ -1,15 +1,14 @@
 /**
  * @file 报警记录api
- * @module requestShow.alarmRecord  
+ * @module 报警记录接口
  * @memberof requestShow
  */
 import { requestShow } from '../utils'
 
-
 /**
  * 获取列表
- * @param {*} query 
- *  @param {number} query.page - 页码
+ * @param {*} query
+ * @param {number} query.page - 页码
  * @param {number} query.limit - 每页数量
  * @param {string} query.label - 模糊查询关键字
  * @param {string} query.search - 模糊查询内容
@@ -136,16 +135,35 @@ export function alarmCloudCall(data) {
 /**
  * 批量处理
  * @param {Object} data 处理参数对象
+ * @param {boolean} data.isAll - 是否全部处理
+ * @param {Object} data.query - 查询参数对象 当isAll为true时，query必传
+ * @param {number} data.query.mainType - 查询告警的主要类型（1：设备告警，2：异常告警，3：设备故障，4：离线告警）
+ * @param {Array} data.query.range - 查询的时间范围[开始毫秒时间戳，结束毫秒时间戳]
+ * @param {number} data.query.processingState - 查询的告警的处理状态（1：待处理，2：处理中，3：已处理）
  * @param {Array} data.alarmRecords - 待处理的报警记录id数组
- * @param {number} data.mainType - 告警的主要类型（1：设备告警，2：异常告警，3：设备故障，4：离线告警）
- * @param {number} data.processingResult - 处理结果（9：云呼通知失败，10：缺岗，12：短信发送失败，1：已通知，11：云呼通知中，2：真实火灾，3：测试，4：误报，5：真实预警，6：人工处理，7：设备自动复位，8：已推送至第三方）
- * @param {number} data.fireReason fireReason 火灾原因 误报原因
- * @param {string} data.fireDesc fireDesc 报警描述
- * @param {string} data.handle_user_name 现场处置人员姓名
- * @param {number} data.fault_content 处理情况（设备异常）
- * @param {string} data.reportperson_name 处理人员姓名（设备异常）
+ * @param {number} data.processingResult - 处理结果（9：云呼通知失败，10：缺岗，12：短信发送失败，1：已通知，11：云呼通知中，2：真实告警，3：测试，4：误报，5：处理完成，6：人工处理，7：设备自动复位，8：已推送至第三方）
+ * @param {string} data.fireDesc - 报警描述
  * @returns {Object} - 返回对象
  * @returns {number} code - 返回码，0表示成功
+ * @example <caption>请求范例</caption>
+ * 当isAll为true时，传以下参数。代表处理条件内的所有报警记录
+ * {
+ *  isAll: true,
+ *  query: {
+ *    mainType: 1,
+ *    range: [1727078400000, 1727164800000],
+ *    processingState: 1
+ *  },
+ *  processingResult: 2,
+ *  fireDesc: '报警描述'
+ * }
+ * 当isAll为false时，传以下参数
+ * {
+ *  alarmRecords: ['5f7d9d5d5d1d8a00177d5d1c', '5f7d9d5d5d1d8a00177d5d1d'],
+ *  mainType: 1,
+ *  processingResult: 2,
+ *  fireDesc: '报警描述'
+ * }
  */
 export function processingManyAlarm(data) {
   return requestShow({
@@ -195,10 +213,9 @@ export function exportAlarmRecord(data) {
   })
 }
 
-
 /**
  * 获取报警详情
- * @param {string} 报警id 
+ * @param {string} 报警id
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
 * @returns {Object} data - 报警记录对象 字段见list返回字段
@@ -227,7 +244,7 @@ export function updateOne(data) {
 
 /**
  * 删除报警
- * @param {string} 报警id 
+ * @param {string} 报警id
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
 * @returns {Object} data - 报警记录对象 字段见list返回字段
@@ -241,7 +258,7 @@ export function deleteOne(id) {
 
 /**
  * 批量删除报警
- * @param {Array} 报警ids 
+ * @param {Array} 报警ids
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
  */

package/api/departs.js

@@ -1,7 +1,7 @@
 import { requestShow } from '../utils'
 /**
  * @file 层级api
- * @module departs
+ * @module 层级接口
  */
 /**
  * 

package/api/product.js

@@ -1,11 +1,201 @@
 /**
  * @file 产品管理api
- * @module requestShow.product  
+ * @module 产品管理接口
  * @memberof requestShow
  */
 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/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,11 @@ import { init } from './utils'
 import emitter from './utils/EventEmitter'
 import alarmRecord from './api/alarmRecord'
 import alarmProgress from './api/alarmProgress'
+import systeminfo from './api/systeminfo'
 const api = {
   alarmRecord,
-  alarmProgress
+  alarmProgress,
+  systeminfo
 }
 
 export default { config: options => {

package/jsdoc.json

@@ -17,7 +17,7 @@
         ]
     },
     "templates": {
-        "systemName": "nayota-datav-sdk",
+        "systemName": "nayota-show-sdk",
         "footer": "宁波边缘物联有限公司",
         "copyright": "宁波边缘物联有限公司",
         "navType": "vertical",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nayota-show-sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "nayota-show-server rest-api",
   "type": "module",
   "main": "index.js",
@@ -24,4 +24,4 @@
     "jsdom": "^24.0.0",
     "taffydb": "^2.7.3"
   }
-}
+}