nayota-show-sdk 0.1.0 → 0.1.2

package/api/deviceClass.js

@@ -0,0 +1,151 @@
+import { requestShow } from '../utils'
+/**
+ * @file 设备类型api
+ * @module 设备类型接口
+ */
+
+
+/**
+ * 属性数据维度dataDimension
+ * @readonly
+ * @enum {string}
+ */
+var dataDimension = {
+  日: 'day',
+  月: 'month',
+  年: 'year'
+}
+
+/**
+ * 属性类型propType
+ * @readonly
+ * @enum {string}
+ */
+var propType = {
+  check: 'check',
+  operate: 'operate'
+}
+
+
+/**
+ * UI模型类型uiType
+ * @readonly
+ * @enum {string}
+ */
+var uiType = {
+  画布: 'canvas',
+  组件: 'component'
+}
+
+/**
+ * @typedef {Object} deviceClass设备类型
+ * @property {string} _id - 设备类型id
+ * @property {string} name - 设备类型名称.
+ * @property {string} icon - 设备类型图标
+ * @property {string} code - 设备类型编码
+ * @property {string} departTag - 设备类型的层级标签
+ * @property {Array} attribute - 设备类型属性
+ * @property {string} props._id - 属性id
+ * @property {string} props.name - 属性名称
+ * @property {string} props.key - 属性key
+ * @property {string} props.dataDimension - 属性数据维度，默认为day天，查看枚举dataDimension
+ * @property {string} props.type - 属性类型，查看枚举propType
+ * @property {boolean} props.filterable - 属性是否可搜索
+ * @property {boolean} props.lineType - 属性在离线判定是否开启
+ * @property {string} props.lineTime - 属性在离线判定时间（单位小时）
+ * @property {boolean} props.statusType - 属性是否开启异常值判定
+ * @property {string} props.interval - 属性异常值判定的区间
+ * @property {array} relations - 与IOT字典的绑定关系
+ * @property {string} relations.hwId - 字典id
+ * @property {string} relations.hwName - 字典名称
+ * @property {string} relations.hwType - 字典类型
+ * @property {string} relations.hwCode - 字典编码
+ * @property {array} relations.attrs - 设备属性和字典的绑定关系
+ * @property {array} uis - 与UI模型的关系
+ * @property {string} uis.uiId - UI模型id
+ * @property {string} uis.uiName - UI模型名称
+ * @property {string} uis.uiCode - UI模型编码
+ * @property {string} uis.type - UI模型类型查看枚举uiType
+ * @property {array} uis.attrs - 设备属性和UI模型的绑定关系
+ * @property {string} deviceUI - 设备类型关联IOT展示模型的_id
+ * @property {boolean} isSimulation - 设备类型是否为模拟
+ */
+
+/**
+ * 
+ * @param {*} query
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 设备总数
+ * @returns {Array} rows - 设备数组查看设备数据定义
+ */
+export function list(query) {
+  return request({
+    url: '/device-classes',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增设备
+ * @param {Object} data - 包含设备的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
+ */
+export function create(data) {
+  return requestShow({
+    url: '/device-classes',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 修改设备
+ * @param {Object} data - 包含设备的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/device-classes/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除设备
+ * @param {string} id - 删除的设备id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/device-classes/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除设备
+ * @param {Array} ids - 删除的设备ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/device-classes',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany
+}
+

package/api/devices.js

@@ -39,10 +39,10 @@ var deviceStatus = {
 }
 
 /**
- * @typedef {Object} device
+ * @typedef {Object} device设备
  * @property {string} _id - 设备id
  * @property {string} name - 设备名称.
- * @property {Array} hash - 根据参数PropId生成，用于判定设备是否已经导入（新版弃用）
+ * @property {Array} hash - 根据参数PropId生成，用于判定设备是否已经导入
  * @property {Array} latLng - 设备在平面图上的经纬度
  * @property {Array} mapLatLng - 设备在地图上的经纬度
  * @property {string} shortAddress - 设备短地址

package/index.js

@@ -8,6 +8,8 @@ import router from './api/router'
 import departs from './api/departs'
 import bmsRole from './api/bmsRole'
 import bmsRouter from './api/bmsRouter'
+import devices from './api/devices'
+import deviceClass from './api/deviceClass'
 const api = {
   alarmRecord,
   alarmProgress,
@@ -15,7 +17,9 @@ const api = {
   router,
   departs,
   bmsRole,
-  bmsRouter
+  bmsRouter,
+  devices,
+  deviceClass
 }
 
 export default { config: options => {

package/package.json

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