@ray-js/lock-sdk 1.0.0-beta-1

package/lib/media.js

@@ -0,0 +1,80 @@
+import { getMediaUrl as getMediaUrlApi } from "./api/log";
+import config from "./config";
+import dpCodes from "./config/dp-code";
+import { openNativeRouter } from "./utils/device";
+import { publishDps } from "./utils/publishDps";
+
+/**
+ * 多媒体相关接口
+ */
+
+/**
+ * 获取视频的实际播放地址参数
+ */
+
+/**
+ * 获取视频的实际播放地址
+ * @param params
+ * @returns
+ */
+export const getMediaUrl = async params => {
+  return getMediaUrlApi({
+    devId: config.devInfo.devId,
+    mediaPath: params.mediaPath,
+    mediaBucket: params.mediaBucket
+  });
+};
+
+/**
+ * 跳转到本地相册页面
+ */
+export const goToLocalAlbum = async params => {
+  return openNativeRouter("ipc_album_panel", {
+    extra_camera_uuid: config.devInfo.devId,
+    theme: typeof (params === null || params === void 0 ? void 0 : params.theme) === "string" ? params.theme === "dark" ? 1 : 2 : undefined
+  });
+};
+
+/**
+ * 跳转到回放页面
+ * @param params { theme?: "dark" | "light" }
+ * @returns Promise<boolean>
+ */
+export const goToPlayback = async params => {
+  const tabs = [];
+  if (config.codesById[dpCodes.recordModeAovSwitch]) {
+    tabs.push("cloud");
+
+    // 如果存在 dp updataInfo，则进行一次同步更新
+    if (config.codesById[dpCodes.updataInfo] && config.deviceStatus.type === "online") {
+      try {
+        await publishDps({
+          updata_info: "010001FF"
+        }, {
+          timeout: 6000
+        });
+      } catch (e) {
+        // 不处理
+      }
+    }
+  }
+  // 有 SD 卡时，支持本地回放
+  if (config.codesById[dpCodes.sdStatus]) {
+    tabs.push("local");
+  }
+  return openNativeRouter("camera_playbacks_panel", {
+    extra_camera_uuid: config.devInfo.devId,
+    defaultShowTabs: true,
+    isLowPowerDevice: true,
+    rotate: config.videoAngle,
+    tabs: JSON.stringify(tabs),
+    bizType: "doorLock",
+    theme: typeof (params === null || params === void 0 ? void 0 : params.theme) === "string" ? params.theme === "dark" ? 1 : 2 : undefined
+  });
+};
+export const openCameraSettings = async params => {
+  return openNativeRouter("camera_base_setting", {
+    extra_camera_uuid: config.devInfo.devId,
+    theme: typeof (params === null || params === void 0 ? void 0 : params.theme) === "string" ? params.theme === "dark" ? 1 : 2 : undefined
+  });
+};

package/lib/open.d.ts

@@ -0,0 +1,48 @@
+import { RemotePermission } from "./interface";
+/**
+ * 校验是否可以远程开关门
+ */
+export declare const checkRemoteEnabled: () => Promise<void>;
+/**
+ * 开锁
+ * @param option 开锁选项
+ * @param option.timeout 超时时间，默认 15000 毫秒
+ * @returns Promise<void>
+ */
+export declare const openDoor: (option?: {
+    timeout?: number;
+} | undefined) => Promise<void>;
+/**
+ * 关锁
+ * @param option 关锁选项
+ * @param option.timeout 超时时间，默认 15000 毫秒
+ * @returns Promise<void>
+ */
+export declare const closeDoor: (option?: {
+    timeout?: number;
+} | undefined) => Promise<void>;
+/**
+ * 是否开启远程开关门功能
+ * @param state
+ */
+export declare const remoteEnabled: (state: boolean) => Promise<void>;
+/**
+ * 获取远程开关门是否开启
+ * @returns boolean
+ */
+export declare const getRemoteEnabled: () => boolean;
+/**
+ * 获取远程开关门权限列表
+ * @returns
+ */
+export declare const getRemotePermissionList: () => RemotePermission[];
+/**
+ * 获取远程开关门当前权限
+ * @returns 远程开关门权限
+ */
+export declare const getRemotePermission: () => RemotePermission;
+/**
+ * 更新远程开关门权限
+ * @param permission
+ */
+export declare const updateRemotePermission: (permission: RemotePermission) => Promise<void>;

package/lib/open.js

@@ -0,0 +1,247 @@
+/**
+ * 远程开关锁 API
+ */
+import dpUtils from "@ray-js/tuya-dp-transform";
+import { getDoorKey, openDoorByCloud } from "./api/lock";
+import config from "./config";
+import { isUseNearChannel, parallelMerge, parallelOnly } from "./utils";
+import { decrypt } from "./utils/device";
+import { publishDps } from "./utils/publishDps";
+import { open as openMap, reportOpen as reportOpenMap } from "./config/dp-map/open";
+import { stringToBytes } from "./utils/byte";
+import emitter from "./utils/event";
+import { getError } from "./utils/errors";
+import { DPCHANGE } from "./utils/constant";
+import dpCodes from "./config/dp-code";
+import { getCurrentUser, permissions } from "./state";
+import { setDeviceProperties } from "./api/setting";
+import syncRemoteSerectKey from "./sync/remote-serect-key";
+import { ProductCommunicationType } from "./constant";
+const getReportError = status => {
+  // 状态码为 0 表示开锁成功，其他  0x01：失败  0x02：失效  0x03：秘钥次数使用完  0x04：秘钥不在有效期内  0x05：秘钥比对错误
+  let error = getError(1004);
+  switch (status) {
+    case 0x02:
+      error = getError(1005);
+      break;
+    case 0x03:
+      error = getError(1006);
+      break;
+    case 0x04:
+      error = getError(1007);
+      break;
+    case 0x05:
+      error = getError(1008);
+      break;
+    default:
+  }
+  return error;
+};
+
+/**
+ * 校验是否可以远程开关门
+ */
+export const checkRemoteEnabled = parallelMerge(async () => {
+  const {
+    devInfo,
+    dpSchema,
+    remoteOpenEnabled,
+    remoteOpenPermission
+  } = config;
+  const {
+    userType
+  } = await getCurrentUser();
+  if (!devInfo.isOnline) {
+    // 设备不在线
+    throw getError(1001);
+  }
+
+  // 是否支持远程开门
+  if (dpSchema[dpCodes.remoteNoDpKey] === undefined) {
+    // 不支持远程开门
+    throw getError(1045);
+  }
+  // 是否开启远程开关门
+  if (!remoteOpenEnabled) {
+    // 远程开关门未开启
+    throw getError(1046);
+  }
+  // 是否有权限开关门
+  if (remoteOpenPermission === "noOne" || remoteOpenPermission === "adminsOnly" && +userType === 20) {
+    throw getError(1047);
+  }
+});
+const _doAction = async (isOpen, timeout) => {
+  const {
+    devInfo,
+    onlineType,
+    capabilities,
+    communication,
+    dpSchema
+  } = config;
+
+  // 校验远程开关门是否可用
+  await checkRemoteEnabled();
+  const isNear = isUseNearChannel();
+  const currentUser = await getCurrentUser();
+  const memberId = currentUser.lockUserId !== 0 ? currentUser.lockUserId : currentUser.userId;
+  const checkReport = dpData => {
+    if (typeof dpData[dpCodes.remoteNoDpKey] !== "undefined") {
+      const result = dpUtils.parse(dpData[dpCodes.remoteNoDpKey], reportOpenMap);
+      // 由于有两端操作的可能，所以需要判断是否有相同的成员id
+      if (result.memberId === memberId) {
+        // 有相同的成员开锁，表示此操作有结果
+        return result;
+      } else {
+        // 提示可能返回了一个错误的成员id
+        console.warn("An incorrect member id was returned");
+      }
+    }
+    return false;
+  };
+
+  // 是否为蓝牙在线
+  if (isNear) {
+    // 为双模支持蓝牙控制且蓝牙在线
+    if (communication.includes(ProductCommunicationType.WIFI) || communication.includes(ProductCommunicationType.THREAD)) {
+      // 先尝试同步密钥
+      await syncRemoteSerectKey();
+
+      // 蓝牙在线时，通过蓝牙开锁
+      const {
+        password
+      } = await getDoorKey(devInfo.devId);
+      const pw = await decrypt(devInfo.devId, password);
+      const response = await publishDps({
+        [dpCodes.remoteNoDpKey]: dpUtils.format({
+          status: Number(isOpen),
+          memberId,
+          key: stringToBytes(pw),
+          type: 3 // 0x03 表示蓝牙方式开锁
+        }, openMap)
+      }, {
+        timeout,
+        checkReport
+      });
+      const result = response[dpCodes.remoteNoDpKey];
+      // 状态码为 0 表示开锁成功，其他  0x01：失败  0x02：失效  0x03：秘钥次数使用完  0x04：秘钥不在有效期内  0x05：秘钥比对错误
+      if (result.status !== 0) {
+        throw getReportError(result.status);
+      }
+
+      // 开锁成功
+      return;
+    }
+
+    // 纯蓝牙设备
+    if (communication.length === 1 && communication.includes(ProductCommunicationType.BLUETOOTH)) {
+      // TODO 后继实际蓝牙门锁开锁
+      throw new Error("Bluetooth lock opening is not supported yet");
+    }
+  }
+
+  // 其他情况默认为云端开锁
+  return new Promise((resolve, reject) => {
+    // 走云端远程开锁逻辑
+    const handleReport = dpCodes => {
+      const result = checkReport(dpCodes);
+      if (result) {
+        emitter.off(DPCHANGE, handleReport);
+        clearTimeout(timeoutTask);
+        if (result.status !== 0) {
+          // 失败
+          reject(getReportError(result.status));
+        } else {
+          // 开锁成功
+          resolve();
+        }
+      }
+    };
+    // 监听开锁结果
+    // 设置超时任务
+    const timeoutTask = setTimeout(() => {
+      emitter.off(DPCHANGE, handleReport);
+      // 超时处理
+      reject(getError(1002));
+    }, timeout);
+    // 加入监听器
+    emitter.on(DPCHANGE, handleReport);
+    openDoorByCloud(devInfo.devId, isOpen).catch(() => {
+      clearTimeout(timeoutTask);
+      emitter.off(DPCHANGE, handleReport);
+      // 开锁失败
+      reject(getError(1003));
+    });
+  });
+};
+
+/**
+ * 开锁
+ * @param option 开锁选项
+ * @param option.timeout 超时时间，默认 15000 毫秒
+ * @returns Promise<void>
+ */
+export const openDoor = parallelOnly(option => {
+  return _doAction(true, (option === null || option === void 0 ? void 0 : option.timeout) || 15000);
+});
+
+/**
+ * 关锁
+ * @param option 关锁选项
+ * @param option.timeout 超时时间，默认 15000 毫秒
+ * @returns Promise<void>
+ */
+export const closeDoor = parallelOnly(option => {
+  return _doAction(false, (option === null || option === void 0 ? void 0 : option.timeout) || 15000);
+});
+
+/**
+ * 是否开启远程开关门功能
+ * @param state
+ */
+export const remoteEnabled = parallelMerge(async state => {
+  await setDeviceProperties(config.devInfo.devId, {
+    UNLOCK_PHONE_REMOTE: state
+  });
+  config.remoteOpenEnabled = state;
+  if (state) {
+    // 同步密钥
+    syncRemoteSerectKey();
+  }
+});
+
+/**
+ * 获取远程开关门是否开启
+ * @returns boolean
+ */
+export const getRemoteEnabled = () => {
+  return config.remoteOpenEnabled;
+};
+
+/**
+ * 获取远程开关门权限列表
+ * @returns
+ */
+export const getRemotePermissionList = () => {
+  return permissions;
+};
+
+/**
+ * 获取远程开关门当前权限
+ * @returns 远程开关门权限
+ */
+export const getRemotePermission = () => {
+  return config.remoteOpenPermission;
+};
+
+/**
+ * 更新远程开关门权限
+ * @param permission
+ */
+export const updateRemotePermission = async permission => {
+  const index = permissions.indexOf(permission);
+  await setDeviceProperties(config.devInfo.devId, {
+    REMOTE_UNLOCK_AUTH: index > 0 ? index : 0
+  });
+  config.remoteOpenPermission = permission;
+};

package/lib/other.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 打开场景
+ * @param options - 打开场景的参数
+ * @param options.themeColor - 主题颜色
+ */
+export declare const openScene: (options?: {
+    themeColor?: string;
+}) => Promise<unknown>;
+/**
+ * 判断是否支持蓝牙控制
+ * @returns boolean
+ */
+export declare const isSupportBleControl: () => import("./interface").DpValue;
+/**
+ * 获取休眠时间段
+ * @param dpCode - 待获取时段的 dp
+ * @returns 返回时间段
+ * start: 开始时间（分钟）
+ * end: 结束时间（分钟）
+ */
+export declare const getDpPeriodTime: (dpCode: string) => {
+    start: number;
+    end: number;
+};
+/**
+ * 设置时间段
+ * @param dpCode - 待设置时段的 dp
+ * @param params 休眠时间段数据
+ * start: 开始时间（分钟）
+ * end: 结束时间（分钟）
+ * @returns Promise<void>
+ */
+export declare const updateDpPeriodTime: (dpCode: string, data: {
+    start: number;
+    end: number;
+}) => Promise<Record<string, import("./interface").DpValue>>;

package/lib/other.js

@@ -0,0 +1,178 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+const _excluded = ["themeColor"];
+import dpUtils from "@ray-js/tuya-dp-transform";
+import config from "./config";
+import dpCodes from "./config/dp-code";
+import { ProductCommunicationType } from "./constant";
+import { getDpValue } from "./state";
+import { openPanel } from "./utils/device";
+import { getError } from "./utils/errors";
+import { publishDps } from "./utils/publishDps";
+const {
+  alarmLock,
+  unlockFingerprint,
+  unlockPassword,
+  unlockCard,
+  unlockKey,
+  unlockPhoneRemote
+} = dpCodes;
+
+/**
+ * 打开场景
+ * @param options - 打开场景的参数
+ * @param options.themeColor - 主题颜色
+ */
+export const openScene = async options => {
+  const dpIds = [unlockFingerprint, unlockPassword, unlockCard, unlockKey, unlockPhoneRemote].reduce((acc, item) => {
+    const id = config.idsByCode[item];
+    if (id) {
+      acc.push(id);
+    }
+    return acc;
+  }, []);
+  const _ref = options || {},
+    {
+      themeColor = ""
+    } = _ref,
+    res = _objectWithoutProperties(_ref, _excluded);
+  return new Promise((resolve, reject) => {
+    openPanel({
+      deviceId: config.devInfo.devId,
+      extraInfo: {
+        productId: config.devInfo.productId,
+        bizClientId: "tyqawbz9jf6oqvynya",
+        productVersion: "1.0.0",
+        i18nTime: "12344",
+        uiType: "SMART_MINIPG"
+      },
+      initialProps: _objectSpread({
+        openDpLists: dpIds.join(","),
+        dpCode: alarmLock,
+        themeColor
+      }, res),
+      success: resolve,
+      fail: reject
+    });
+  });
+};
+
+/**
+ * 判断是否支持蓝牙控制
+ * @returns boolean
+ */
+export const isSupportBleControl = () => {
+  const {
+    devInfo,
+    codesById,
+    communication
+  } = config;
+  if (!codesById[dpCodes.unlockBle]) {
+    return false;
+  }
+
+  // 如果是 matter 设备，则判断是否有激活蓝牙
+  // 获取是否连云激活
+  const hasThread = communication.includes(ProductCommunicationType.THREAD);
+  const hasWifi = communication.includes(ProductCommunicationType.WIFI);
+  const hasBle = communication.includes(ProductCommunicationType.BLUETOOTH);
+  // 通讯能力不支持蓝牙时，不支持蓝牙控制
+  if (!hasBle) {
+    return false;
+  }
+  if (hasThread) {
+    var _devInfo$meta;
+    // 仅支持 Matter + BLE，当元数据里无 threadWithBLE 此标记时，表示蓝牙未激活
+    if (!(devInfo !== null && devInfo !== void 0 && (_devInfo$meta = devInfo.meta) !== null && _devInfo$meta !== void 0 && _devInfo$meta["threadWithBLE"])) {
+      return false;
+    }
+  }
+  // 双模设备下，如果未激活 Wifi，则都可以支持蓝牙控制
+  if (hasWifi && hasBle) {
+    if (devInfo.wifiEnableState === 1) {
+      return true;
+    }
+  }
+
+  // 存在 dp 42(蓝牙模块开启开关)，当 dp42 为 true 时，表示蓝牙模块已开启，则支持蓝牙控制
+  const bleControlDp = codesById[dpCodes.bleControl];
+  if (bleControlDp) {
+    var _devInfo$dpsTime;
+    // // 边界判断，是否有上报时间
+    const reportTIme = devInfo === null || devInfo === void 0 || (_devInfo$dpsTime = devInfo.dpsTime) === null || _devInfo$dpsTime === void 0 ? void 0 : _devInfo$dpsTime[bleControlDp];
+    const hasReportTime = !reportTIme || Math.floor(Number(reportTIme) / 1000) <= devInfo.activeTime;
+    if (!getDpValue(dpCodes.bleControl) || !hasReportTime) {
+      return true;
+    }
+    return getDpValue(dpCodes.bleControl);
+  }
+  return true;
+};
+const periodDpMap = [{
+  name: "startHour"
+}, {
+  name: "startMinute"
+}, {
+  name: "endHour"
+}, {
+  name: "endMinute"
+}];
+
+/**
+ * 获取休眠时间段
+ * @param dpCode - 待获取时段的 dp
+ * @returns 返回时间段
+ * start: 开始时间（分钟）
+ * end: 结束时间（分钟）
+ */
+export const getDpPeriodTime = dpCode => {
+  const {
+    dpSchema
+  } = config;
+  const dpValue = getDpValue(dpCode);
+  if (typeof dpSchema[dpCode] !== "undefined" && dpValue) {
+    var _data$startHour, _data$startMinute, _data$endHour, _data$endMinute;
+    const data = dpUtils.parse(getDpValue(dpCodes.dormantTimeSet),
+    // @ts-expect-error
+    periodDpMap);
+    return {
+      start: ((_data$startHour = data.startHour) !== null && _data$startHour !== void 0 ? _data$startHour : 0) * 60 + ((_data$startMinute = data.startMinute) !== null && _data$startMinute !== void 0 ? _data$startMinute : 0),
+      end: ((_data$endHour = data.endHour) !== null && _data$endHour !== void 0 ? _data$endHour : 0) * 60 + ((_data$endMinute = data.endMinute) !== null && _data$endMinute !== void 0 ? _data$endMinute : 0)
+    };
+  }
+  return {
+    start: 0,
+    end: 0
+  };
+};
+
+/**
+ * 设置时间段
+ * @param dpCode - 待设置时段的 dp
+ * @param params 休眠时间段数据
+ * start: 开始时间（分钟）
+ * end: 结束时间（分钟）
+ * @returns Promise<void>
+ */
+export const updateDpPeriodTime = (dpCode, data) => {
+  const {
+    dpSchema
+  } = config;
+  if (typeof dpSchema[dpCode] === "undefined") {
+    throw getError(1014);
+  }
+  const startHour = Math.floor(data.start / 60);
+  const startMinute = data.start % 60;
+  const endHour = Math.floor(data.end / 60);
+  const endMinute = data.end % 60;
+  return publishDps({
+    dormant_time_set: dpUtils.format({
+      startHour,
+      startMinute,
+      endHour,
+      endMinute
+    },
+    // @ts-expect-error
+    periodDpMap)
+  });
+};

package/lib/parse/index.d.ts

@@ -0,0 +1,6 @@
+import { CapabilityInfo } from "../interface";
+/**
+ * 解析设备能力
+ * @param dpValue
+ */
+export declare const parseCapabilities: (dpValue: string) => CapabilityInfo | null;

package/lib/parse/index.js

@@ -0,0 +1,22 @@
+import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import dpUtils from "@ray-js/tuya-dp-transform";
+import { capabilities as capabilitiesMap } from "../config/dp-map/normal";
+import { ModuleType } from "../constant";
+
+/**
+ * 解析设备能力
+ * @param dpValue
+ */
+export const parseCapabilities = dpValue => {
+  if (!dpValue) {
+    return null;
+  }
+  const data = dpUtils.parse(dpValue, capabilitiesMap);
+  if (data.tyep === ModuleType.M7258) {
+    // 针对 7258 模组，处理旋转方式，1和0互换
+    return _objectSpread(_objectSpread({}, data), {}, {
+      rotateType: data.rotateType === 1 ? 0 : data.rotateType === 0 ? 1 : data.rotateType
+    });
+  }
+  return data;
+};

package/lib/signal.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 获取设备信号强度
+ * 此方法只向设备触发动作不返回信号强度，信号强度变化通过 onSignalChange 监听
+ * @returns
+ */
+export declare const getWiFiSignal: () => Promise<{
+    fetchedData: Record<string, {
+        fetchedData: any;
+        timeStamp: number;
+    }>;
+} | null>;
+type WiFiSignalChangeListener = (params: {
+    signal: number;
+    level: "good" | "normal" | "weak" | "bad";
+}) => void;
+/**
+ * 监听设备信号强度变化
+ * @returns
+ */
+export declare const onWiFiSignalChange: (cb: WiFiSignalChangeListener) => void;
+/**
+ * 监听设备信号强度变化
+ * @returns
+ */
+export declare const offWiFiSignalChange: (cb: WiFiSignalChangeListener) => void;
+export {};

package/lib/signal.js

@@ -0,0 +1,38 @@
+import config from "./config";
+import { sendMqttMessage } from "./utils/device";
+import { getError } from "./utils/errors";
+import emitter from "./utils/event";
+
+/**
+ * 获取设备信号强度
+ * 此方法只向设备触发动作不返回信号强度，信号强度变化通过 onSignalChange 监听
+ * @returns
+ */
+export const getWiFiSignal = () => {
+  if (config.devInfo.isCloudOnline) {
+    return sendMqttMessage({
+      deviceId: config.devInfo.devId,
+      protocol: 22,
+      message: {
+        reqType: "sigQry"
+      }
+    });
+  } else {
+    throw getError(1001);
+  }
+};
+/**
+ * 监听设备信号强度变化
+ * @returns
+ */
+export const onWiFiSignalChange = cb => {
+  emitter.on("onWiFiSignalChange", cb);
+};
+
+/**
+ * 监听设备信号强度变化
+ * @returns
+ */
+export const offWiFiSignalChange = cb => {
+  emitter.off("onWiFiSignalChange", cb);
+};