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

package/lib/config/dp-map/unlock-method.js

@@ -0,0 +1,231 @@
+/**
+ * 开门方式配置
+ */
+
+import { pwdConfigDpMap, validConfigDpMap } from "./common";
+const common = [
+// 开门方式
+{
+  name: "type"
+},
+// 阶段(步骤)
+{
+  name: "stage"
+},
+// 管理员标记
+{
+  name: "admin",
+  type: "boolean",
+  defaultValue: false
+},
+// 成员 id
+{
+  name: "memberId"
+},
+//   硬件id(开锁id)
+{
+  name: "unlockId"
+}];
+
+/**
+ * 小容量开门方式配置
+ * 下发配置
+ */
+const add = [...common,
+// 时效性，当为
+validConfigDpMap,
+// 有效次数
+{
+  name: "validNum"
+}, ...pwdConfigDpMap, {
+  name: "sn",
+  bytes: 2
+}];
+
+/**
+ * 小容量开门方式配置
+ * 上报配置
+ */
+const reportAdd = [...common,
+// 需录入的总次数
+{
+  name: "total",
+  condition: {
+    prop: "stage",
+    value: 0
+  }
+},
+// 录入次数
+{
+  name: "step",
+  condition: {
+    prop: "stage",
+    value: 0xfc
+  }
+},
+//   录入失败时，失败的阶段
+{
+  name: "stageFail",
+  condition: {
+    prop: "stage",
+    value: 0xfd
+  }
+},
+// 无意义
+{
+  name: "none",
+  condition: {
+    type: "and",
+    conditions: [{
+      prop: "stage",
+      value: 0,
+      operation: "neq"
+    }, {
+      prop: "stage",
+      value: 0xfc,
+      operation: "neq"
+    }, {
+      prop: "stage",
+      value: 0xfd,
+      operation: "neq"
+    }]
+  }
+},
+// 返回状态
+{
+  name: "status"
+}, {
+  name: "sn",
+  bytes: 2
+}];
+
+/**
+ * 小容量删除开门方式配置
+ * 上报配置
+ */
+const remove = [...common,
+// 删除方式，0 表示删除全部开门方式，1 表示删除指定开门方式
+{
+  name: "target"
+}];
+
+/**
+ * 小容量删除开门方式配置
+ * 下报配置
+ */
+const reportRemove = [...remove, {
+  name: "status"
+}];
+/**
+ * 小容量修改开门方式配置
+ * 下报配置
+ */
+const update = [...common, validConfigDpMap, {
+  name: "validNum"
+}, ...pwdConfigDpMap];
+
+/**
+ * 小容量修改开门方式配置，只修改成员角色
+ * 下发配置
+ */
+const updateMemberRole = common;
+
+/**
+ * 小容量删除开门方式配置
+ * 上报配置
+ */
+const reportUpdate = [...common, {
+  name: "validNum"
+}, {
+  name: "status"
+}];
+
+/**
+ * 添加临时密码
+ * 下发配置
+ */
+const addTempPwd = [{
+  name: "cloudNo",
+  bytes: 2
+}, {
+  name: "valid",
+  type: "boolean"
+}, validConfigDpMap, {
+  name: "validNum"
+}, ...pwdConfigDpMap];
+
+/**
+ * 添加临时密码
+ * 上报配置
+ */
+const reportAddTempPwd = [{
+  name: "cloudNo",
+  bytes: 2
+}, {
+  name: "unlockId"
+}, {
+  name: "status"
+}];
+
+/**
+ * 删除临时密码
+ * 下发配置
+ */
+const removeTempPwd = [{
+  name: "unlockId"
+}];
+
+/**
+ * 删除临时密码
+ * 上报配置
+ */
+const reportRemoveTempPwd = [{
+  name: "unlockId"
+}, {
+  name: "status"
+}];
+
+/**
+ * 修改临时密码
+ * 下发配置
+ */
+const updateTempPwd = [{
+  name: "unlockId"
+}, {
+  name: "valid",
+  type: "boolean"
+}, validConfigDpMap, {
+  name: "validNum"
+}, ...pwdConfigDpMap];
+
+/**
+ * 修改临时密码
+ * 上报配置
+ */
+const reportUpdateTempPwd = [{
+  name: "unlockId"
+}, {
+  name: "status"
+}];
+
+/**
+ * 同步解锁方式
+ * 下发配置
+ */
+const sync = [{
+  name: "type",
+  loop: true
+}];
+
+/**
+ * 同步解锁方式
+ * 上报配置
+ */
+const reportSync = [{
+  name: "stage"
+}, {
+  name: "package"
+}
+// 同步的数据，面板不关注，固这里不解析
+];
+export { add, reportAdd, remove, reportRemove, update, updateMemberRole, reportUpdate, addTempPwd, reportAddTempPwd, removeTempPwd, reportRemoveTempPwd, updateTempPwd, reportUpdateTempPwd, sync, reportSync };

package/lib/config/index.d.ts

@@ -0,0 +1,46 @@
+import { ProductCommunicationType } from "../constant";
+import { CapabilityInfo, DeviceInfo, DpSchema, RemotePermission, DeviceStatus } from "../interface";
+declare const config: {
+    devInfo: DeviceInfo;
+    dpSchema: Record<string, DpSchema>;
+    codesById: Record<string, string>;
+    idsByCode: Record<string, number>;
+    remoteOpenEnabled: boolean;
+    remoteOpenPermission: RemotePermission;
+    capabilities: CapabilityInfo | null;
+    onlineType: number;
+    /**
+     * 产品的通讯能力
+     */
+    communication: ProductCommunicationType[];
+    /**
+     * 是否为支持大容量的产品
+     */
+    supportBigData: boolean;
+    /**
+     * 密码进行的进制
+     */
+    passwordDigitalBase: number;
+    /**
+     * 密码是否支持0
+     */
+    passwordSupportZero: boolean;
+    /**
+     * 是否严格模式
+     * 严格模式下，sdk 会对一些操作进行严格校验，比如 dp 协议校验
+     */
+    strictMode: boolean;
+    /**
+     * 图片旋转角度
+     */
+    imageAngle: number;
+    /**
+     * 视频旋转角度
+     */
+    videoAngle: number;
+    /**
+     * 设备的状态信息
+     */
+    deviceStatus: DeviceStatus;
+};
+export default config;

package/lib/config/index.js

@@ -0,0 +1,56 @@
+const config = {
+  // 设备信息
+  devInfo: {},
+  // 设备 dp 定义
+  dpSchema: {},
+  // 设备 dp 映射关系, id => code
+  codesById: {},
+  // 设备 dp 映射关系, code => id
+  idsByCode: {},
+  // 是否支持远程开锁
+  remoteOpenEnabled: false,
+  // 远程开锁权限, 0: '仅管理员可以使用', 1: '所有用户可以使用', 2: '所有用户都不可以',
+  remoteOpenPermission: "everyOne",
+  // 设备能力
+  capabilities: null,
+  // 设备在线情况，默认为离线
+  onlineType: 0,
+  /**
+   * 产品的通讯能力
+   */
+  communication: [0],
+  /**
+   * 是否为支持大容量的产品
+   */
+  supportBigData: false,
+  /**
+   * 密码进行的进制
+   */
+  passwordDigitalBase: 10,
+  /**
+   * 密码是否支持0
+   */
+  passwordSupportZero: true,
+  /**
+   * 是否严格模式
+   * 严格模式下，sdk 会对一些操作进行严格校验，比如 dp 协议校验
+   */
+  strictMode: true,
+  /**
+   * 图片旋转角度
+   */
+  imageAngle: 0,
+  /**
+   * 视频旋转角度
+   */
+  videoAngle: 0,
+  /**
+   * 设备的状态信息
+   */
+  deviceStatus: {
+    type: "offline",
+    connectEanble: false,
+    onlineType: "none"
+  }
+};
+export default config;

package/lib/constant.d.ts

@@ -0,0 +1,101 @@
+/**
+ * 用户类型
+ * 10 - 管理员
+ * 20 - 普通成员
+ * 30 - 匿名用户
+ * 40 - 分享成员
+ * 50 - 家庭拥有者
+ */
+export declare enum UserType {
+    ADMIN = 10,// 管理员
+    MEMBER = 20,// 普通成员
+    UNKNOW = 30,// 匿名用户
+    SHARE = 40,// 分享成员
+    OWNER = 50
+}
+export declare enum ModuleType {
+    T31 = 0,
+    WBRL = 1,
+    M9116 = 2,
+    M7258 = 3,
+    T3 = 4
+}
+export declare enum VedioType {
+    NONE = 0,// 不支持视频相关能力
+    VEDIO_OR_SNAPSHOT = 1
+}
+export declare enum VoiceType {
+    ONE_WAY = 0,// 单向
+    TWO_WAY = 1
+}
+export declare enum VedioStreamType {
+    STREAMER = 0,// 推流方式
+    P2P = 1
+}
+export declare enum CommunicationType {
+    WIFI = 0,// WIFI
+    WIFI_BLE = 1,// 蓝牙 + wifi
+    THREAD = 2,// 蓝牙 + Thread
+    THREAD_BLE = 3,// 蓝牙 + thread
+    NONE = 255
+}
+export declare enum RotateType {
+    PID = 0,// pid旋转
+    SEI = 1
+}
+/**
+ * 涂鸦支持的通讯能力
+ */
+export declare enum ProductCommunicationType {
+    WIFI = 0,
+    CABLE = 1,
+    GPRS = 2,
+    NB_IOT = 3,
+    BLUETOOTH = 10,
+    BLE_MESH = 11,
+    ZIGBEE = 12,
+    INFRARED = 13,
+    SUBPIECES = 14,
+    SIGMESH = 15,
+    MCU = 16,
+    TY_SMESH = 17,
+    ZWAVE = 18,
+    PL_MESH = 19,
+    CAT1 = 20,
+    BEACON = 21,
+    CAT4 = 22,
+    CAT10 = 23,
+    LTE_CATM = 24,
+    THREAD = 25
+}
+/**
+ * 本地管理用户类型
+ */
+export declare enum LocalOperateUserType {
+    SUPER_ADMIN = 0,
+    ADMIN = 1,
+    SPECIAL_USER = 2,
+    NORMAL_USER = 3
+}
+/**
+ * 本地管理操作类型
+ * 开锁方式类：
+ * 0 表示 添加开锁方式
+ * 1 表示删除开锁方式
+ * 2 表示修改开锁方式
+ *
+ * 操作用户类：
+ * 16：添加用户
+ * 17：删除用户
+ *
+ * 本地设置类：
+ * 32 表示本地设备设置
+ */
+export declare enum LocalOperateCategory {
+    ADD_UNLOCK_METHOD = 0,
+    DELETE_UNLOCK_METHOD = 1,
+    MODIFY_UNLOCK_METHOD = 2,
+    ADD_USER = 16,
+    DELETE_USER = 17,
+    SETTING = 32
+}

package/lib/constant.js

@@ -0,0 +1,136 @@
+/**
+ * 用户类型
+ * 10 - 管理员
+ * 20 - 普通成员
+ * 30 - 匿名用户
+ * 40 - 分享成员
+ * 50 - 家庭拥有者
+ */
+export let UserType = /*#__PURE__*/function (UserType) {
+  UserType[UserType["ADMIN"] = 10] = "ADMIN";
+  // 管理员
+  UserType[UserType["MEMBER"] = 20] = "MEMBER";
+  // 普通成员
+  UserType[UserType["UNKNOW"] = 30] = "UNKNOW";
+  // 匿名用户
+  UserType[UserType["SHARE"] = 40] = "SHARE";
+  // 分享成员
+  UserType[UserType["OWNER"] = 50] = "OWNER"; // 家庭拥有者
+  return UserType;
+}({});
+
+// 模组类型
+export let ModuleType = /*#__PURE__*/function (ModuleType) {
+  ModuleType[ModuleType["T31"] = 0] = "T31";
+  ModuleType[ModuleType["WBRL"] = 1] = "WBRL";
+  ModuleType[ModuleType["M9116"] = 2] = "M9116";
+  ModuleType[ModuleType["M7258"] = 3] = "M7258";
+  ModuleType[ModuleType["T3"] = 4] = "T3";
+  return ModuleType;
+}({});
+
+// 支持视频类型
+export let VedioType = /*#__PURE__*/function (VedioType) {
+  VedioType[VedioType["NONE"] = 0] = "NONE";
+  // 不支持视频相关能力
+  VedioType[VedioType["VEDIO_OR_SNAPSHOT"] = 1] = "VEDIO_OR_SNAPSHOT"; // 支持视频或者抓拍
+  return VedioType;
+}({});
+
+// 语音类型
+export let VoiceType = /*#__PURE__*/function (VoiceType) {
+  VoiceType[VoiceType["ONE_WAY"] = 0] = "ONE_WAY";
+  // 单向
+  VoiceType[VoiceType["TWO_WAY"] = 1] = "TWO_WAY"; // 双向
+  return VoiceType;
+}({});
+
+// 视频流方案
+export let VedioStreamType = /*#__PURE__*/function (VedioStreamType) {
+  VedioStreamType[VedioStreamType["STREAMER"] = 0] = "STREAMER";
+  // 推流方式
+  VedioStreamType[VedioStreamType["P2P"] = 1] = "P2P"; // P2P 方式
+  return VedioStreamType;
+}({});
+
+// 通讯能力
+export let CommunicationType = /*#__PURE__*/function (CommunicationType) {
+  CommunicationType[CommunicationType["WIFI"] = 0] = "WIFI";
+  // WIFI
+  CommunicationType[CommunicationType["WIFI_BLE"] = 1] = "WIFI_BLE";
+  // 蓝牙 + wifi
+  CommunicationType[CommunicationType["THREAD"] = 2] = "THREAD";
+  // 蓝牙 + Thread
+  CommunicationType[CommunicationType["THREAD_BLE"] = 3] = "THREAD_BLE";
+  // 蓝牙 + thread
+  CommunicationType[CommunicationType["NONE"] = 255] = "NONE"; // 未知
+  return CommunicationType;
+}({});
+export let RotateType = /*#__PURE__*/function (RotateType) {
+  RotateType[RotateType["PID"] = 0] = "PID";
+  // pid旋转
+  RotateType[RotateType["SEI"] = 1] = "SEI"; // sei旋转
+  return RotateType;
+}({});
+
+/**
+ * 涂鸦支持的通讯能力
+ */
+export let ProductCommunicationType = /*#__PURE__*/function (ProductCommunicationType) {
+  ProductCommunicationType[ProductCommunicationType["WIFI"] = 0] = "WIFI";
+  ProductCommunicationType[ProductCommunicationType["CABLE"] = 1] = "CABLE";
+  ProductCommunicationType[ProductCommunicationType["GPRS"] = 2] = "GPRS";
+  ProductCommunicationType[ProductCommunicationType["NB_IOT"] = 3] = "NB_IOT";
+  ProductCommunicationType[ProductCommunicationType["BLUETOOTH"] = 10] = "BLUETOOTH";
+  ProductCommunicationType[ProductCommunicationType["BLE_MESH"] = 11] = "BLE_MESH";
+  ProductCommunicationType[ProductCommunicationType["ZIGBEE"] = 12] = "ZIGBEE";
+  ProductCommunicationType[ProductCommunicationType["INFRARED"] = 13] = "INFRARED";
+  ProductCommunicationType[ProductCommunicationType["SUBPIECES"] = 14] = "SUBPIECES";
+  ProductCommunicationType[ProductCommunicationType["SIGMESH"] = 15] = "SIGMESH";
+  ProductCommunicationType[ProductCommunicationType["MCU"] = 16] = "MCU";
+  ProductCommunicationType[ProductCommunicationType["TY_SMESH"] = 17] = "TY_SMESH";
+  ProductCommunicationType[ProductCommunicationType["ZWAVE"] = 18] = "ZWAVE";
+  ProductCommunicationType[ProductCommunicationType["PL_MESH"] = 19] = "PL_MESH";
+  ProductCommunicationType[ProductCommunicationType["CAT1"] = 20] = "CAT1";
+  ProductCommunicationType[ProductCommunicationType["BEACON"] = 21] = "BEACON";
+  ProductCommunicationType[ProductCommunicationType["CAT4"] = 22] = "CAT4";
+  ProductCommunicationType[ProductCommunicationType["CAT10"] = 23] = "CAT10";
+  ProductCommunicationType[ProductCommunicationType["LTE_CATM"] = 24] = "LTE_CATM";
+  ProductCommunicationType[ProductCommunicationType["THREAD"] = 25] = "THREAD";
+  return ProductCommunicationType;
+}({});
+
+/**
+ * 本地管理用户类型
+ */
+export let LocalOperateUserType = /*#__PURE__*/function (LocalOperateUserType) {
+  LocalOperateUserType[LocalOperateUserType["SUPER_ADMIN"] = 0] = "SUPER_ADMIN";
+  LocalOperateUserType[LocalOperateUserType["ADMIN"] = 1] = "ADMIN";
+  LocalOperateUserType[LocalOperateUserType["SPECIAL_USER"] = 2] = "SPECIAL_USER";
+  LocalOperateUserType[LocalOperateUserType["NORMAL_USER"] = 3] = "NORMAL_USER";
+  return LocalOperateUserType;
+}({});
+
+/**
+ * 本地管理操作类型
+ * 开锁方式类：
+ * 0 表示 添加开锁方式
+ * 1 表示删除开锁方式
+ * 2 表示修改开锁方式
+ *
+ * 操作用户类：
+ * 16：添加用户
+ * 17：删除用户
+ *
+ * 本地设置类：
+ * 32 表示本地设备设置
+ */
+export let LocalOperateCategory = /*#__PURE__*/function (LocalOperateCategory) {
+  LocalOperateCategory[LocalOperateCategory["ADD_UNLOCK_METHOD"] = 0] = "ADD_UNLOCK_METHOD";
+  LocalOperateCategory[LocalOperateCategory["DELETE_UNLOCK_METHOD"] = 1] = "DELETE_UNLOCK_METHOD";
+  LocalOperateCategory[LocalOperateCategory["MODIFY_UNLOCK_METHOD"] = 2] = "MODIFY_UNLOCK_METHOD";
+  LocalOperateCategory[LocalOperateCategory["ADD_USER"] = 16] = "ADD_USER";
+  LocalOperateCategory[LocalOperateCategory["DELETE_USER"] = 17] = "DELETE_USER";
+  LocalOperateCategory[LocalOperateCategory["SETTING"] = 32] = "SETTING";
+  return LocalOperateCategory;
+}({});

package/lib/dp-interface.d.ts

@@ -0,0 +1,7 @@
+export interface UpdateUserEffectiveData {
+    type: 0;
+    stage: number;
+    admin: boolean;
+    memberId: number;
+    unlockId: 255;
+}

package/lib/dp-interface.js

@@ -0,0 +1 @@
+export {};

package/lib/event.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 休眠状态变更事件
+ */
+export declare const SLEEP_EVENT = "sleep_event";
+/**
+ * 设备状态变更事件
+ */
+export declare const DEVICE_STATUS_CHANGE_EVENT = "device_status_change";

package/lib/event.js

@@ -0,0 +1,9 @@
+/**
+ * 休眠状态变更事件
+ */
+export const SLEEP_EVENT = "sleep_event";
+
+/**
+ * 设备状态变更事件
+ */
+export const DEVICE_STATUS_CHANGE_EVENT = "device_status_change";

package/lib/index.d.ts

@@ -0,0 +1,25 @@
+import { LockSDKOption } from "./interface";
+import { getCurrentUser, getDeviceStatus, onDeviceStatusChange, offDeviceStatusChange, getCurrentUserSync, getMediaRotate } from "./state";
+import { syncUnlockMethod } from "./sync/unlock-mothod";
+export * from "./user";
+export * from "./unlock-method";
+export * from "./temporary";
+export * from "./open";
+export * from "./log";
+export * from "./signal";
+export * from "./sleep";
+export * from "./interface";
+export * from "./constant";
+export * from "./other";
+export * from "./media";
+export * from "./linkage";
+/**
+ * 初始化sdk
+ * @param options 初始化参数
+ */
+export declare const init: (options?: LockSDKOption) => Promise<void>;
+/**
+ * 销毁 sdk
+ */
+export declare const destroy: () => void;
+export { getCurrentUser, getMediaRotate, getCurrentUserSync, syncUnlockMethod, getDeviceStatus, onDeviceStatusChange, offDeviceStatusChange, };