nayota-show-sdk 1.3.30 → 1.3.32

package/api/energyCalculation.js

@@ -94,10 +94,8 @@ export function getOne(id) {
  * @param {Object} data - 更新的数据
  * @param {string} data._id - 能耗计算关联ID
  * @param {string} [data.deviceId] - 设备ID
- * @param {string} [data.electricityMeterId] - 电表ID
- * @param {string} [data.electricityCalculationNodeId] - 电表计算节点ID
- * @param {string} [data.flowCalculationNodeId] - 流量表计算节点ID
- * @param {string} [data.flowMeterId] - 流量表ID
+ * @param {Array<string>} [data.electricityMeterIds] - 电表ID
+ * @param {Array<string>} [data.flowMeterIds] - 流量表ID
  * @param {boolean} [data.isActive] - 是否启用
  * @param {string} [data.description] - 关联描述
  * @returns {Promise<Object>} 更新后的能耗计算关联记录

package/api/energyConsumption.js

@@ -0,0 +1,145 @@
+import { requestShow } from "../utils";
+
+/**
+ * @file 能源消耗表api
+ * @module 能源消耗表接口
+ * @category 能耗管理
+ */
+
+/**
+ * @typedef {Object} energyConsumption - 能源消耗记录
+ * @property {string} _id - 记录ID
+ * @property {string} deviceId - 设备ID，关联到设备表
+ * @property {number} electricityConsumption - 电量消耗 (kWh)
+ * @property {number} heatConsumption - 热量消耗 (kWh)
+ * @property {number} coolingConsumption - 冷量消耗 (kWh)
+ * @property {number} runningDuration - 运行时长 (小时)
+ * @property {Date} recordDate - 记录日期
+ * @property {string} creator - 创建者
+ * @property {Date} createdAt - 创建时间
+ * @property {Date} updatedAt - 更新时间
+ * @example
+ * {
+ *   "_id": "667d2efa52d21700095b58d5",
+ *   "deviceId": "667d2ee28aaf514ab9bcbca5",
+ *   "electricityConsumption": 150.5,
+ *   "heatConsumption": 80.2,
+ *   "coolingConsumption": 120.8,
+ *   "runningDuration": 24.5,
+ *   "recordDate": "2024-01-15T00:00:00.000Z",
+ *   "creator": "6678e31ff340dfdecd9e1a28",
+ *   "createdAt": "2024-01-15T10:30:00.000Z",
+ *   "updatedAt": "2024-01-15T10:30:00.000Z"
+ * }
+ */
+
+/**
+ * 创建能源消耗记录
+ * @param {Object} data - 能源消耗数据
+ * @param {string} data.deviceId - 设备ID
+ * @param {number} [data.electricityConsumption=0] - 电量消耗 (kWh)
+ * @param {number} [data.heatConsumption=0] - 热量消耗 (kWh)
+ * @param {number} [data.coolingConsumption=0] - 冷量消耗 (kWh)
+ * @param {number} [data.runningDuration=0] - 运行时长 (小时)
+ * @param {Date} [data.recordDate] - 记录日期
+ * @returns {Promise<Object>} 创建的能源消耗记录
+ */
+export function create(data) {
+  return requestShow({
+    url: "/energy-consumptions",
+    method: "post",
+    data,
+  });
+}
+
+/**
+ * 获取能源消耗记录列表
+ * @param {Object} [params] - 查询参数
+ * @param {number} [params.page=1] - 页码
+ * @param {number} [params.limit=50] - 每页数量
+ * @param {string} [params.deviceId] - 设备ID筛选
+ * @param {Date} [params.startDate] - 开始日期筛选
+ * @param {Date} [params.endDate] - 结束日期筛选
+ * @param {number} [params.minElectricity] - 最小电量消耗筛选
+ * @param {number} [params.maxElectricity] - 最大电量消耗筛选
+ * @param {number} [params.minHeat] - 最小热量消耗筛选
+ * @param {number} [params.maxHeat] - 最大热量消耗筛选
+ * @param {number} [params.minCooling] - 最小冷量消耗筛选
+ * @param {number} [params.maxCooling] - 最大冷量消耗筛选
+ * @param {string} [params.sortBy] - 排序字段
+ * @param {string} [params.sortOrder='desc'] - 排序方向，asc或desc
+ * @returns {Promise<Object>} 能源消耗记录列表
+ */
+export function list(params) {
+  return requestShow({
+    url: "/energy-consumptions",
+    method: "get",
+    params,
+  });
+}
+
+/**
+ * 根据ID获取能源消耗记录详情
+ * @param {string} id - 能源消耗记录ID
+ * @returns {Promise<Object>} 能源消耗记录详情
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/energy-consumptions/${id}`,
+    method: "get",
+  });
+}
+
+/**
+ * 更新能源消耗记录
+ * @param {Object} data - 更新的数据
+ * @param {string} data._id - 能源消耗记录ID
+ * @param {string} [data.deviceId] - 设备ID
+ * @param {number} [data.electricityConsumption] - 电量消耗 (kWh)
+ * @param {number} [data.heatConsumption] - 热量消耗 (kWh)
+ * @param {number} [data.coolingConsumption] - 冷量消耗 (kWh)
+ * @param {number} [data.runningDuration] - 运行时长 (小时)
+ * @param {Date} [data.recordDate] - 记录日期
+ * @returns {Promise<Object>} 更新后的能源消耗记录
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/energy-consumptions/${data._id}`,
+    method: "put",
+    data,
+  });
+}
+
+/**
+ * 删除能源消耗记录
+ * @param {string} id - 能源消耗记录ID
+ * @returns {Promise<Object>} 删除结果
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/energy-consumptions/${id}`,
+    method: "delete",
+  });
+}
+
+/**
+ * 批量删除能源消耗记录
+ * @param {Array<string>} ids - 能源消耗记录ID数组
+ * @returns {Promise<Object>} 批量删除结果
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: "/energy-consumptions",
+    method: "delete",
+    data: ids,
+  });
+}
+
+export default {
+  create,
+  list,
+  getOne,
+  updateOne,
+  deleteOne,
+  deleteMany,
+};

package/index.js

@@ -33,6 +33,7 @@ import datavForms from "./api/datavForms";
 import sensor from "./api/sensor";
 import scadaProject from "./api/scadaProject";
 import energyCalculation from "./api/energyCalculation";
+import energyConsumption from "./api/energyConsumption";
 const api = {
   alarmRecord,
   alarmProgress,
@@ -66,6 +67,7 @@ const api = {
   sensor,
   scadaProject,
   energyCalculation,
+  energyConsumption,
 };
 
 export default {

package/package.json

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