Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UCodeLinkAPI

UCodeLinkAPI

该 API 是封装了 访问 uCodeLink 接口 API

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AddressType

AddressType: { address: AddressInfo }

Type declaration

BufferEncoding

BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex"

LookupFunction

LookupFunction: (hostname: string, options: LookupOneOptions, callback: (err: ErrnoException | null, address: string, family: number) => void) => void

Type declaration

SPEncoding

SPEncoding: "ascii" | "utf8" | "utf16le" | "ucs2" | "base64" | "binary" | "hex"

SPErrorCallback

SPErrorCallback: (error?: Error | null) => void

Type declaration

    • (error?: Error | null): void

    • Parameters

      • Optional error: Error | null

      Returns void

SPListCallback

SPListCallback: (error: Error | null | undefined, ports: any[]) => void

Type declaration

    • (error: Error | null | undefined, ports: any[]): void

    • Parameters

      • error: Error | null | undefined
      • ports: any[]

      Returns void

SPModemBitsCallback

SPModemBitsCallback: (error: Error | null | undefined, status?: InputSignals) => void

Type declaration

    • (error: Error | null | undefined, status?: InputSignals): void

    • Parameters

      • error: Error | null | undefined
      • Optional status: InputSignals

      Returns void

SPWriteCallback

SPWriteCallback: (error: Error | null | undefined, bytesWritten?: number) => void

Type declaration

    • (error: Error | null | undefined, bytesWritten?: number): void

    • Parameters

      • error: Error | null | undefined
      • Optional bytesWritten: number

      Returns void

SPWriteData

SPWriteData: string | number[] | Buffer

SerialOptions

SerialOptions: { baudRate: number; bufferSize?: number; dataBits?: number; flowControl?: "none" | "hardware"; parity?: "none" | "even" | "odd"; stopBits?: number }

Type declaration

  • baudRate: number
  • Optional bufferSize?: number
  • Optional dataBits?: number
  • Optional flowControl?: "none" | "hardware"
  • Optional parity?: "none" | "even" | "odd"
  • Optional stopBits?: number

SerialPortInfo

SerialPortInfo: { usbProductId?: number; usbVendorId?: number }

Type declaration

  • Optional usbProductId?: number
  • Optional usbVendorId?: number

SerialPortRequestOptions

SerialPortRequestOptions: { filters: SerialPortInfo[] }

Type declaration

SetOptions

SetOptions: { brk?: boolean; cts?: boolean; dsr?: boolean; dtr?: boolean; rts?: boolean } & SerialOutputSignals

SocketConnectOpts

SocketConnectOpts: { family?: number; hints?: number; host?: string; localAddress?: string; localPort?: number; lookup?: LookupFunction; onread?: OnReadOpts; path?: string; port: number }

Type declaration

  • Optional family?: number
  • Optional hints?: number
  • Optional host?: string
  • Optional localAddress?: string
  • Optional localPort?: number
  • Optional lookup?: LookupFunction
  • Optional onread?: OnReadOpts
  • Optional path?: string
  • port: number

TCPMsg

TCPMsg: Uint8Array | string

tcp消息类型

UDPMsg

UDPMsg: string | Uint8Array | ReadonlyArray<any>

UDPSendOptionsType

UDPSendOptionsType: { address?: string; length?: number; offset?: number; port?: number }

Type declaration

  • Optional address?: string
  • Optional length?: number
  • Optional offset?: number
  • Optional port?: number

UDPSocketType

UDPSocketType: "udp4" | "udp6"

familyType

familyType: "IPv4" | "IPv6"

Variables

CurrentSerial

CurrentSerial: typeof SerialPort | typeof WebSerialPort = ...

Functions

downloadUCodeLink

  • downloadUCodeLink(): void

  • Returns void

enforceSplitWrite

  • enforceSplitWrite(mac: string, enforceSplit: boolean, splitSize: number): Promise<boolean>

  • enforceSplitWrite(enforceSplit: BridegBoolean, splitSize: Number)

    2.14或以上控制器版本传enforceSplitWrite(True, 20) 2.14以下控制器版本传enforceSplitWrite(False, 0)

    Parameters

    • mac: string
    • enforceSplit: boolean
    • splitSize: number

    Returns Promise<boolean>

getCanonicalUUID

  • getCanonicalUUID(uuid: string | number): string

  • Gets a canonical UUID from a partial UUID in string or hex format

    Parameters

    • uuid: string | number

      The partial UUID

    Returns string

    canonical UUID

getCharacteristicUUID

  • getCharacteristicUUID(characteristic: string | number): string

  • Gets a canonical characteristic UUID from a known characteristic name or partial UUID in string or hex format

    Parameters

    • characteristic: string | number

      The known characteristic name

    Returns string

    canonical UUID

getDescriptorUUID

  • getDescriptorUUID(descriptor: string | number): string

  • Gets a canonical descriptor UUID from a known descriptor name or partial UUID in string or hex format

    Parameters

    • descriptor: string | number

      The known descriptor name

    Returns string

    canonical UUID

getLinkRpc

  • getLinkRpc(timeout?: number): Promise<RpcClient>

  • Parameters

    • timeout: number = 3000

    Returns Promise<RpcClient>

getLinkRpcSync

getServiceUUID

  • getServiceUUID(service: string | number): string

  • Gets a canonical service UUID from a known service name or partial UUID in string or hex format

    Parameters

    • service: string | number

      The known service name

    Returns string

    canonical UUID

handleUCodeLinkError

  • handleUCodeLinkError(errorAction: string): Promise<boolean>

  • Parameters

    • errorAction: string

    Returns Promise<boolean>

initUCodeLink

  • initUCodeLink(timeout?: number): Promise<RpcClient>

  • Parameters

    • timeout: number = 3000

    Returns Promise<RpcClient>

injectRpcClient

  • injectRpcClient(): void

  • Returns void

startUCodeLink

  • startUCodeLink(): void

  • Returns void

uCodeLinkIsReady

  • uCodeLinkIsReady(): boolean

  • Returns boolean

uCodeLinkNotReady

  • uCodeLinkNotReady(): UCodeCustomError

  • Returns UCodeCustomError

waitUCodeLinkReady

  • waitUCodeLinkReady(timeoutDuration?: number): Promise<void>

  • Parameters

    • timeoutDuration: number = ...

    Returns Promise<void>

Generated using TypeDoc