@cpzxrobot/sdk 1.0.16 → 1.0.18

package/device_filter.ts

@@ -277,6 +277,7 @@ export abstract class DeviceFilter<T extends { id: number }> {
           status?: string;
           unit?: Number;
           detail?: boolean;
+          supplier?: string; //供应商,可用于过滤设备
         } = undefined
   ): Promise<T[]> {
     // if (this.devices.length > 0) {

package/device_gateway.ts

@@ -1,6 +1,6 @@
 import { DeviceTypeGateway } from "./device_type_gateway";
 import { DeviceFilter } from "./device_filter";
-import type {  ElectricMeter, Cpzxrobot } from ".";
+import type { ElectricMeter, Cpzxrobot } from ".";
 import { FeedTowerGateway } from "./device_types/feedtower";
 import { ElectricMeterGateway } from "./device_types/electricmeter";
 import { NormalGateway } from "./device_types/normal_type";
@@ -63,12 +63,29 @@ export class DeviceGateway extends Object {
   // }
 
   //获取设备列表，注意特殊类型，比如electricMeter和feedTower，需要通过属性访问
-  get list() {
-    return this.normalFilter.list;
+  list(
+    options:
+      | undefined
+      | {
+          id?: Number | null | undefined;
+          data?:
+            | "diffPerDay"
+            | "sumPerDay"
+            | "latest"
+            | "weekoverweek"
+            | "last"
+            | "rangeToday"
+            | null; //如果data为null，则不获取数据，只获取设备列表，否则获取设备列表和数据
+          status?: string;
+          unit?: Number;
+          detail?: boolean;
+          supplier?: string; //供应商,可用于过滤设备
+        } = undefined
+  ) {
+    return this.normalFilter.list(options);
   }
 
   get getHistoryDatas() {
     return this.normalFilter.getHistoryDatas;
   }
-  
 }

package/dist/device_gateway.js

@@ -47,8 +47,8 @@ class DeviceGateway extends Object {
     //   return this.devices
     // }
     //获取设备列表，注意特殊类型，比如electricMeter和feedTower，需要通过属性访问
-    get list() {
-        return this.normalFilter.list;
+    list(options = undefined) {
+        return this.normalFilter.list(options);
     }
     get getHistoryDatas() {
         return this.normalFilter.getHistoryDatas;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cpzxrobot/sdk",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "description": "提供给上海正芯数智APP第三方H5应用使用的SDK",
   "main": "dist/index.js",
   "scripts": {

package/readme.md

@@ -2,21 +2,21 @@
 
 这是提供给上海正芯数智APP第三方H5应用使用的SDK模块，包含相关物联网设备的获取方式和接口功能
 
-## 使用方式
+## 1、使用方式
 
 ```
 npm i @cpzxrobot/sdk
 ```
 
-## 开发指南
+## 2、开发指南
 
-### 引入包
+### 2.1、引入包
 
 ```
 import cpzxrobot from "@cpzxrobot/sdk"
 ```
 
-### 配置开发信息
+### 2.2、配置开发信息
 ```
 cpzxrobot({
   devAuth: "从上海正芯获得的开发临时token",
@@ -37,7 +37,7 @@ cpzxrobot({
 
 使用上述模板进行sdk初始化
 
-#### 开发时的CORS问题
+#### 2.2.1、开发时的CORS问题
 
 如果上述配置后，出现调用接口CORS问题，请在初始化增加参数：
 ```
@@ -55,6 +55,18 @@ baseURL: "/"
   },
 ```
 
+### 2.3、使用方法
+
+#### 2.3.1、Vue使用方法
+
+在App.vue中调用2.1所示初始化程序，即可完成SDK初始化。
+
+在其他文件中需要使用sdk时，需要
+
+* 引用库 `import cpzxrobot from "@cpzxrobot/sdk"`
+* 调用对应的接口方法，例如`cpzxrobot().factory.workshops(factory_id)`
+
+
 ### 调用接口
 
 主要包入口：
@@ -62,6 +74,9 @@ baseURL: "/"
 | 调用入口                | 功能说明             |
 | ----------------------- | -------------------- |
 | cpzxrobot().factory.xxx | 获得工厂的相关信息   |
+| cpzxrobot().device.normalFilter.list | 获得常见设备的列表（当没有特殊类型需求时调用）   |
+| cpzxrobot().device.normalFilter.getData | 获得设备的数据   |
+| cpzxrobot().device.feedTower.list | 获得料塔设备的列表   |
 | cpzxrobot().device.xxx  | 获得设备的相关信息   |
 | cpzxrobot().camera.xxx  | 获得摄像头的相关信息 |