Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeviceConnectionInterface

Device Extension DeviceConnection Interface

这是最核心的 硬件设备 接口

Hierarchy

  • DeviceConnectionInterface

Implemented by

Index

Properties

Methods

Properties

connectStatus

connectStatus: DeviceConnectStatusUnionType

连接状态 是一个枚举类型

 enum EConnectStatus {
   Connected = 0,
   Disconnected = 1,
   Connecting = 2,
   Disconnecting = 3,
   ConnectFail = 4,
   DisconnectFail = 5,
 }

Optional deviceType

deviceType?: DeviceType

硬件协议的设备类型，会在 DeviceConnection 实例化的时候被注入

Optional discoverDevice

discoverDevice?: IDiscoverDevice

扫描的时候选中的设备

Optional eventbus

eventbus?: DeviceEventbusInterface

硬件协议的事件 bus，会在 DeviceConnection 实例化的时候被注入

Methods

Optional afterConnect

  • afterConnect(device: IDiscoverDevice): Promise<void | { deviceName: string }>

  • 连接后的钩子

    deprecated

    before/after 打头的API 由于早期设计问题, 都不是真正的钩子, 因为它不对行为造成影响, 也没有感知, 我们不建议继续使用

    hook

    Parameters

    Returns Promise<void | { deviceName: string }>

Optional afterDisconnect

  • afterDisconnect(): Promise<void>

  • 断开连接后的钩子

    deprecated

    before/after 打头的API 由于早期设计问题, 都不是真正的钩子, 因为它不对行为造成影响, 也没有感知, 我们不建议继续使用

    hook

    Returns Promise<void>

Optional beforeConnect

  • 连接前的钩子

    deprecated

    before/after 打头的API 由于早期设计问题, 都不是真正的钩子, 因为它不对行为造成影响, 也没有感知, 我们不建议继续使用

    hook

    Parameters

    Returns Promise<void>

Optional beforeDisconnect

  • beforeDisconnect(): Promise<void>

  • 断开连接前的钩子

    deprecated

    before/after 打头的API 由于早期设计问题, 都不是真正的钩子, 因为它不对行为造成影响, 也没有感知, 我们不建议继续使用

    hook

    Returns Promise<void>

Optional checkEnv

  • checkEnv(): Promise<void>

  • 环境检测接口

    Returns Promise<void>

connect

  • 设备连接标准接口

    Parameters

    • device: IDiscoverDevice

      扫描设备，注意，在自动连接的时候，这个值可能是空的

    Returns Promise<void>

destroy

  • destroy(): Promise<void>

  • 销毁动作

    Returns Promise<void>

disconnect

  • disconnect(): Promise<void>

  • 设备断开连接标准接口

    Returns Promise<void>

Optional enableCheckEnv

  • enableCheckEnv(): boolean

  • 是否开启环境检测

    📢 注意: 该接口仅在 checkEnv 不为空的时候有效

    • 如果该接口为空, 默认认为开启环境检测

    • 如果该接口不为空, 返回的值是 false, uCode 执行的时候会跳过 (不会显示环检测的接口)

    主要用于同步处理 例如: 第一次连接硬件设备的时候, 需要检测 uCodeLink 是否开启, 一旦开启了之后, socket 的判断是同步的, 则可以显示 环境检测中 的界面

    Returns boolean

Optional handleError

  • handleError(errorActionId: string): Promise<boolean>

  • 错误处理 如果 reject 抛出的是一个 UCodeCustomError subErrorCode 是 "timeout" 的错误, 会报超时 Toast (停留在当前窗口)

    Parameters

    • errorActionId: string

    Returns Promise<boolean>

    返回 Promise 才会继续下一步, 返回 Promise 会停留在当前窗口

isConnected

  • isConnected(): boolean

  • 是否正在连接，由 DeviceConnection 提供

    Returns boolean

Optional reBindDevice

  • reBindDevice(): Promise<void>

  • 重新绑定设备，主要是针对模式不匹配需要重连的情况

    Returns Promise<void>

Generated using TypeDoc