@hyext/types-ext-sdk-hy 4.2.5-beta.7 → 4.2.5-beta.9

package/index.d.ts

@@ -4426,6 +4426,108 @@ namespace device {
      * 获取系统信息
      */
     function getSystemInfo(): Promise<SystemInfo>;
+    /**
+     * 断开与蓝牙低功耗设备的连接
+     * @param params - 输入参数
+     */
+    function closeBLEConnection(params: CloseBLEConnectionReq): Promise<CloseBLEConnectionRsp>;
+    /**
+     * 关闭蓝牙模块
+     */
+    function closeBluetoothAdapter(): Promise<CloseBluetoothAdapterRsp>;
+    /**
+     * 连接蓝牙低功耗设备
+     * @param params - 输入参数
+     */
+    function createBLEConnection(params: CreateBLEConnectionReq): Promise<CreateBLEConnectionRsp>;
+    /**
+     * 获取蓝牙低功耗设备某个服务中所有特征 (characteristic)
+     * @param params - 输入参数
+     */
+    function getBLEDeviceCharacteristics(params: GetBLEDeviceCharacteristicsReq): Promise<GetBLEDeviceCharacteristicsRsp>;
+    /**
+     * 获取蓝牙低功耗设备所有服务 (service)
+     * @param params - 输入参数
+     */
+    function getBLEDeviceServices(params: GetBLEDeviceServicesReq): Promise<GetBLEDeviceServicesRsp>;
+    /**
+     * 获取设备设置
+     */
+    function getSystemSetting(): Promise<GetSystemSettingRsp>;
+    /**
+     * 请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回
+     */
+    function getWifiList(): Promise<GetWifiListRsp>;
+    /**
+     * 启用蓝牙低功耗设备特征值变化时的 notify 功能，订阅特征
+     * @param params - 输入参数
+     */
+    function notifyBLECharacteristicValueChange(params: NotifyBLECharacteristicValueChangeReq): Promise<NotifyBLECharacteristicValueChangeRsp>;
+    /**
+     * 监听蓝牙适配器状态变化事件
+     * @param params - 输入参数
+     */
+    function onBluetoothAdapterStateChange(params: OnBluetoothAdapterStateChangeReq): Promise<void>;
+    /**
+     * 移除蓝牙适配器状态变化事件的全部监听函数
+     */
+    function offBluetoothAdapterStateChange(): Promise<void>;
+    /**
+     * 监听搜索到新设备的事件
+     * @param params - 输入参数
+     */
+    function onBluetoothDeviceFound(params: OnBluetoothDeviceFoundReq): Promise<void>;
+    /**
+     * 监听获取到 Wi-Fi 列表数据事件
+     * @param params - 输入参数
+     */
+    function onGetWifiList(params: OnGetWifiListReq): Promise<void>;
+    /**
+     * 初始化蓝牙模块
+     * @param params - 输入参数
+     */
+    function openBluetoothAdapter(params: OpenBluetoothAdapterReq): Promise<OpenBluetoothAdapterRsp>;
+    /**
+     * 跳转系统蓝牙设置页
+     */
+    function openSystemBluetoothSetting(): Promise<OpenSystemBluetoothSettingRsp>;
+    /**
+     * 读取蓝牙低功耗设备特征值的二进制数据。注意：必须设备的特征支持 read 才可以成功调用
+     * @param params - 输入参数
+     */
+    function readBLECharacteristicValue(params: ReadBLECharacteristicValueReq): Promise<ReadBLECharacteristicValueRsp>;
+    /**
+     * 开始搜寻附近的蓝牙外围设备
+     * @param [params] - 输入参数
+     */
+    function startBluetoothDevicesDiscovery(params?: StartBluetoothDevicesDiscoveryReq): Promise<StartBluetoothDevicesDiscoveryRsp>;
+    /**
+     * 初始化 Wi-Fi 模块
+     */
+    function startWifi(): Promise<StartWifiRsp>;
+    /**
+     * 停止搜寻附近的蓝牙外围设备
+     */
+    function stopBluetoothDevicesDiscovery(): Promise<StopBluetoothDevicesDiscoveryRsp>;
+    /**
+     * 关闭 Wi-Fi 模块
+     */
+    function stopWifi(): Promise<StopWifiRsp>;
+    /**
+     * 向蓝牙低功耗设备特征值中写入二进制数据。注意：必须设备的特征支持 write 才可以成功调用
+     * @param params - 输入参数
+     */
+    function writeBLECharacteristicValue(params: WriteBLECharacteristicValueReq): Promise<WriteBLECharacteristicValueRsp>;
+    /**
+     * 监听蓝牙低功耗设备的特征值变化事件
+     * @param params - 输入参数
+     */
+    function onBLECharacteristicValueChange(params: OnBLECharacteristicValueChangeReq): Promise<void>;
+    /**
+     * 监听蓝牙低功耗连接状态改变事件
+     * @param params - 输入参数
+     */
+    function onBLEConnectionStateChange(params: OnBLEConnectionStateChangeReq): Promise<void>;
 }
 
 /**
@@ -4815,6 +4917,466 @@ type SystemInfo = {
     host: HostInfo;
 };
 
+/**
+ * 断开蓝牙低功耗设备连接参数
+ * @property deviceId - 蓝牙设备 id
+ */
+type CloseBLEConnectionReq = {
+    deviceId: string;
+};
+
+/**
+ * 断开蓝牙低功耗设备连接结果
+ * @property errMsg - 错误信息，如果调用成功返回 closeBLEConnection:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type CloseBLEConnectionRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 关闭蓝牙模块结果
+ * @property errMsg - 错误信息，如果调用成功返回 closeBluetoothAdapter:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type CloseBluetoothAdapterRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 连接蓝牙低功耗设备参数
+ * @property deviceId - 蓝牙设备 id
+ * @property [timeout] - 超时时间，单位 ms，不传表示不会超时
+ */
+type CreateBLEConnectionReq = {
+    deviceId: string;
+    timeout?: number;
+};
+
+/**
+ * 连接蓝牙低功耗设备结果
+ * @property errMsg - 错误信息，如果调用成功返回 createBLEConnection:ok
+ * @property errCode - 错误码，成功时为 0
+ * @property errno - 错误码，成功时为 0
+ */
+type CreateBLEConnectionRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
+/**
+ * 获取蓝牙低功耗设备特征参数
+ * @property deviceId - 蓝牙设备 id
+ * @property serviceId - 蓝牙服务 UUID，需要使用 getBLEDeviceServices 获取
+ */
+type GetBLEDeviceCharacteristicsReq = {
+    deviceId: string;
+    serviceId: string;
+};
+
+/**
+ * 蓝牙设备特征支持的操作类型
+ * @property read - 该特征是否支持 read 操作
+ * @property write - 该特征是否支持 write 操作
+ * @property notify - 该特征是否支持 notify 操作
+ * @property indicate - 该特征是否支持 indicate 操作
+ * @property writeNoResponse - 该特征是否支持无回应写操作
+ * @property writeDefault - 该特征是否支持有回应写操作
+ */
+type BLECharacteristicProperties = {
+    read: boolean;
+    write: boolean;
+    notify: boolean;
+    indicate: boolean;
+    writeNoResponse: boolean;
+    writeDefault: boolean;
+};
+
+/**
+ * 蓝牙设备特征
+ * @property uuid - 蓝牙设备特征的 UUID
+ * @property properties - 该特征支持的操作类型
+ */
+type BLECharacteristic = {
+    uuid: string;
+    properties: BLECharacteristicProperties;
+};
+
+/**
+ * 获取蓝牙低功耗设备特征结果
+ * @property errMsg - 错误信息，如果调用成功返回 getBLEDeviceCharacteristics:ok
+ * @property errCode - 错误码，成功时为 0
+ * @property characteristics - 设备特征列表
+ */
+type GetBLEDeviceCharacteristicsRsp = {
+    errMsg: string;
+    errCode: number;
+    characteristics: BLECharacteristic[];
+};
+
+/**
+ * 获取蓝牙低功耗设备服务参数
+ * @property deviceId - 蓝牙设备 id
+ */
+type GetBLEDeviceServicesReq = {
+    deviceId: string;
+};
+
+/**
+ * 蓝牙设备服务
+ * @property uuid - 蓝牙设备服务的 UUID
+ * @property isPrimary - 该服务是否为主服务
+ */
+type BLEService = {
+    uuid: string;
+    isPrimary: boolean;
+};
+
+/**
+ * 获取蓝牙低功耗设备服务结果
+ * @property errMsg - 错误信息，如果调用成功返回 getBLEDeviceServices:ok
+ * @property errCode - 错误码，成功时为 0
+ * @property services - 设备服务列表
+ */
+type GetBLEDeviceServicesRsp = {
+    errMsg: string;
+    errCode: number;
+    services: BLEService[];
+};
+
+/**
+ * 获取设备设置结果
+ * @property bluetoothEnabled - 蓝牙的系统开关
+ * @property locationEnabled - 地理位置的系统开关
+ * @property wifiEnabled - Wi-Fi 的系统开关
+ * @property deviceOrientation - 设备方向，竖屏 portrait、横屏 landscape
+ * @property errMsg - 错误信息，如果调用成功返回 getSystemSetting:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type GetSystemSettingRsp = {
+    bluetoothEnabled: boolean;
+    locationEnabled: boolean;
+    wifiEnabled: boolean;
+    deviceOrientation: string;
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 请求获取 Wi-Fi 列表结果
+ * @property errMsg - 错误信息，如果调用成功返回 getWifiList:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type GetWifiListRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 启用蓝牙低功耗设备特征值变化时的 notify 功能参数
+ * @property deviceId - 蓝牙设备 id
+ * @property serviceId - 蓝牙特征对应服务的 UUID
+ * @property characteristicId - 蓝牙特征的 UUID
+ * @property state - 是否启用 notify，true 为启用，false 为取消
+ * @property [type] - 设置特征订阅类型，有效值有 `notification` 和 `indication`
+ */
+type NotifyBLECharacteristicValueChangeReq = {
+    deviceId: string;
+    serviceId: string;
+    characteristicId: string;
+    state: boolean;
+    type?: string;
+};
+
+/**
+ * 启用蓝牙低功耗设备特征值变化时的 notify 功能结果
+ * @property errMsg - 错误信息，如果调用成功返回 notifyBLECharacteristicValueChange:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type NotifyBLECharacteristicValueChangeRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * @property available - 蓝牙适配器是否可用
+ * @property discovering - 蓝牙适配器是否处于搜索状态
+ */
+type OnBluetoothAdapterStateChangeNotice = {
+    available: boolean;
+    discovering: boolean;
+};
+
+/**
+ * @param res - 蓝牙适配器状态变化事件的回调参数
+ */
+type OnBluetoothAdapterStateChangeCallback = (res: OnBluetoothAdapterStateChangeNotice) => void;
+
+/**
+ * @property callback - 蓝牙适配器状态变化事件的回调函数
+ */
+type OnBluetoothAdapterStateChangeReq = {
+    callback: OnBluetoothAdapterStateChangeCallback;
+};
+
+/**
+ * @property name - 蓝牙设备名称，某些设备可能没有
+ * @property deviceId - 蓝牙设备 id
+ * @property RSSI - 当前蓝牙设备的信号强度，单位 dBm
+ * @property advertisData - 当前蓝牙设备的广播数据段中的 ManufacturerData 数据段
+ * @property advertisServiceUUIDs - 当前蓝牙设备的广播数据段中的 ServiceUUIDs 数据段
+ * @property localName - 当前蓝牙设备的广播数据段中的 LocalName 数据段
+ * @property serviceData - 当前蓝牙设备的广播数据段中的 ServiceData 数据段
+ * @property connectable - 当前蓝牙设备是否可连接（仅 iOS 支持）
+ */
+type BluetoothDeviceInfo = {
+    name: string;
+    deviceId: string;
+    RSSI: number;
+    advertisData: ArrayBuffer;
+    advertisServiceUUIDs: string[];
+    localName: string;
+    serviceData: any;
+    connectable: boolean;
+};
+
+/**
+ * @property devices - 新搜索到的设备列表
+ */
+type OnBluetoothDeviceFoundNotice = {
+    devices: BluetoothDeviceInfo[];
+};
+
+/**
+ * @param res - 搜索到新设备事件的回调参数
+ */
+type OnBluetoothDeviceFoundCallback = (res: OnBluetoothDeviceFoundNotice) => void;
+
+/**
+ * @property callback - 搜索到新设备事件的回调函数
+ */
+type OnBluetoothDeviceFoundReq = {
+    callback: OnBluetoothDeviceFoundCallback;
+};
+
+/**
+ * @property SSID - Wi-Fi 的 SSID
+ * @property BSSID - Wi-Fi 的 BSSID
+ * @property secure - Wi-Fi 是否安全
+ * @property signalStrength - Wi-Fi 信号强度，安卓取值 0 ～ 100 ，iOS 取值 0 ～ 1
+ * @property frequency - Wi-Fi 频段单位 MHz
+ */
+type WifiInfo = {
+    SSID: string;
+    BSSID: string;
+    secure: boolean;
+    signalStrength: number;
+    frequency: number;
+};
+
+/**
+ * @property wifiList - Wi-Fi 列表数据
+ */
+type OnGetWifiListNotice = {
+    wifiList: WifiInfo[];
+};
+
+/**
+ * @param notice - 监听获取到 Wi-Fi 列表数据事件的回调参数
+ */
+type OnGetWifiListCallback = (notice: OnGetWifiListNotice) => void;
+
+/**
+ * @property callback - 监听获取到 Wi-Fi 列表数据事件的回调函数
+ */
+type OnGetWifiListReq = {
+    callback: OnGetWifiListCallback;
+};
+
+/**
+ * @property mode - 蓝牙模式，可作为主/从设备，仅 iOS 需要
+ */
+type OpenBluetoothAdapterReq = {
+    mode: string;
+};
+
+/**
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考错误码说明
+ * @property state - 失败时返回的参数，仅iOS支持，参考state说明
+ * @property errno - 错误码，成功时为 0，失败时参考错误码说明
+ */
+type OpenBluetoothAdapterRsp = {
+    errMsg: string;
+    errCode: number;
+    state: number;
+    errno: number;
+};
+
+/**
+ * @property errMsg - 错误信息，如果调用成功返回 ${apiName}:ok
+ * @property errCode - 错误码，成功时为 0，失败时参考错误码说明
+ */
+type OpenSystemBluetoothSettingRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 读取蓝牙低功耗设备特征值参数
+ * @property deviceId - 蓝牙设备 id
+ * @property serviceId - 蓝牙特征对应服务的 UUID
+ * @property characteristicId - 蓝牙特征的 UUID
+ */
+type ReadBLECharacteristicValueReq = {
+    deviceId: string;
+    serviceId: string;
+    characteristicId: string;
+};
+
+/**
+ * 读取蓝牙低功耗设备特征值结果
+ * @property errMsg - 错误信息，如果调用成功返回 readBLECharacteristicValue:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type ReadBLECharacteristicValueRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 开始搜寻附近的蓝牙外围设备参数
+ * @property [services] - 要搜索的蓝牙设备主服务的 UUID 列表（iOS 平台必填）
+ * @property [allowDuplicatesKey] - 是否允许重复上报同一设备
+ * @property [interval] - 上报设备的间隔，单位 ms。0 表示找到新设备立即上报
+ * @property [powerLevel] - 扫描模式，可选值："low"、"balanced"、"high"
+ */
+type StartBluetoothDevicesDiscoveryReq = {
+    services?: string[];
+    allowDuplicatesKey?: boolean;
+    interval?: number;
+    powerLevel?: string;
+};
+
+/**
+ * 开始搜寻附近的蓝牙外围设备结果
+ * @property errMsg - 错误信息，如果调用成功返回 startBluetoothDevicesDiscovery:ok
+ * @property errCode - 错误码，成功时为 0
+ * @property errno - 错误码，成功时为 0
+ */
+type StartBluetoothDevicesDiscoveryRsp = {
+    errMsg: string;
+    errCode: number;
+    errno: number;
+};
+
+/**
+ * 初始化 Wi-Fi 模块结果
+ * @property errMsg - 错误信息，如果调用成功返回 startWifi:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type StartWifiRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 停止搜寻附近的蓝牙外围设备结果
+ * @property errMsg - 错误信息，如果调用成功返回 stopBluetoothDevicesDiscovery:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type StopBluetoothDevicesDiscoveryRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 关闭 Wi-Fi 模块结果
+ * @property errMsg - 错误信息，如果调用成功返回 stopWifi:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type StopWifiRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 向蓝牙低功耗设备特征值中写入二进制数据参数
+ * @property deviceId - 蓝牙设备 id
+ * @property serviceId - 蓝牙特征对应服务的 UUID
+ * @property characteristicId - 蓝牙特征的 UUID
+ * @property value - 蓝牙设备特征对应的二进制值
+ * @property [writeType] - 蓝牙特征值的写模式设置，有效值有 write（需要从机确认）和 writeNoResponse（不需要从机确认）
+ */
+type WriteBLECharacteristicValueReq = {
+    deviceId: string;
+    serviceId: string;
+    characteristicId: string;
+    value: ArrayBuffer;
+    writeType?: string;
+};
+
+/**
+ * 向蓝牙低功耗设备特征值中写入二进制数据结果
+ * @property errMsg - 错误信息，如果调用成功返回 writeBLECharacteristicValue:ok
+ * @property errCode - 错误码，成功时为 0
+ */
+type WriteBLECharacteristicValueRsp = {
+    errMsg: string;
+    errCode: number;
+};
+
+/**
+ * 蓝牙低功耗设备的特征值变化事件通知
+ * @property deviceId - 蓝牙设备 id
+ * @property serviceId - 蓝牙特征对应服务的 UUID
+ * @property characteristicId - 蓝牙特征的 UUID
+ * @property value - 特征值最新的值
+ */
+type OnBLECharacteristicValueChangeNotice = {
+    deviceId: string;
+    serviceId: string;
+    characteristicId: string;
+    value: ArrayBuffer;
+};
+
+/**
+ * @param res - 蓝牙低功耗设备的特征值变化事件通知
+ */
+type OnBLECharacteristicValueChangeCallback = (res: OnBLECharacteristicValueChangeNotice) => void;
+
+/**
+ * 监听蓝牙低功耗设备的特征值变化事件参数
+ * @property callback - 蓝牙低功耗设备的特征值变化事件的回调函数
+ */
+type OnBLECharacteristicValueChangeReq = {
+    callback: OnBLECharacteristicValueChangeCallback;
+};
+
+/**
+ * @property deviceId - 蓝牙设备 id
+ * @property connected - 是否处于已连接状态
+ */
+type OnBLEConnectionStateChangeNotice = {
+    deviceId: string;
+    connected: boolean;
+};
+
+/**
+ * @param res - 蓝牙低功耗连接状态改变事件的回调参数
+ */
+type OnBLEConnectionStateChangeCallback = (res: OnBLEConnectionStateChangeNotice) => void;
+
+/**
+ * @property callback - 蓝牙低功耗连接状态改变事件的回调函数
+ */
+type OnBLEConnectionStateChangeReq = {
+    callback: OnBLEConnectionStateChangeCallback;
+};
+
 /**
  * 逐步废弃
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyext/types-ext-sdk-hy",
-  "version": "4.2.5-beta.7",
+  "version": "4.2.5-beta.9",
   "description": "TypeScript definitions for sdk",
   "types": "./index.d.ts",
   "main": "",