Interface UartHandle

UART 设备句柄

Description

通过 UART.open() 打开UART设备后，返回此句柄对象，用于操控UART设备（例如读写等）。当此对象被释放时，打开的UART设备自动关闭。

Hierarchy

Readable
Writable
IEventSource<{
data: [ArrayBuffer];
}>
- UartHandle

Index

Methods

emit off on once read write writeAll

Methods

emit

emit<T>(type: T, ...args: {
data: [ArrayBuffer];
}[T]): UartHandle
触发事件
Type Parameters
- T extends "data"
Parameters
- type: T
  
  事件类型
- Rest ...args: {
  data: [ArrayBuffer];
  }[T]
  
  事件参数
Returns UartHandle

Inherited from IEventSource.emit

off

off<T>(type: T, handler: ((...args: {
data: [ArrayBuffer];
}[T]) => void)): UartHandle
取消监听
Type Parameters
- T extends "data"
Parameters
- type: T
- handler: ((...args: {
  data: [ArrayBuffer];
  }[T]) => void)
  - - (...args: {
      data: [ArrayBuffer];
      }[T]): void
    - Parameters
      
      Rest ...args: {
      data: [ArrayBuffer];
      }[T]
      
      Returns void
Returns UartHandle

Inherited from IEventSource.off

on

on<T>(type: T, handler: ((...args: {
data: [ArrayBuffer];
}[T]) => void)): UartHandle
添加监听
Type Parameters
- T extends "data"
Parameters
- type: T
  
  Event type
- handler: ((...args: {
  data: [ArrayBuffer];
  }[T]) => void)
  
  A callback function to process the incomming event
  - - (...args: {
      data: [ArrayBuffer];
      }[T]): void
    - Parameters
      
      Rest ...args: {
      data: [ArrayBuffer];
      }[T]
      
      Returns void
Returns UartHandle

Inherited from IEventSource.on

once

once<T>(type: T, handler: ((...args: {
data: [ArrayBuffer];
}[T]) => void)): UartHandle
添加一次性监听
Type Parameters
- T extends "data"
Parameters
- type: T
  
  Event type
- handler: ((...args: {
  data: [ArrayBuffer];
  }[T]) => void)
  
  A callback function to process the incomming event
  - - (...args: {
      data: [ArrayBuffer];
      }[T]): void
    - Parameters
      
      Rest ...args: {
      data: [ArrayBuffer];
      }[T]
      
      Returns void
Returns UartHandle

Inherited from IEventSource.once

read

read(buffer: BufferedType): Promise<number>
读取数据到指定缓冲对象。

Returns
实际读取的字节数。
Parameters
- buffer: BufferedType
  
  缓冲对象
Returns Promise<number>

Inherited from Readable.read

write

write(data: string | BufferedType | Byte[]): Promise<number>
向数据流写数据，返回实际写入的字节数。

Returns
实际写入的字节数
Parameters
- data: string | BufferedType | Byte[]
  
  数据
Returns Promise<number>

Inherited from Writable.write

writeAll

writeAll(data: string | BufferedType | Byte[]): Promise<void>
写入全部数据
Parameters
- data: string | BufferedType | Byte[]
  
  数据
Returns Promise<void>

Inherited from Writable.writeAll

Interface UartHandle

Description

Hierarchy

Index

Methods

Methods

emit

Type Parameters

T extends "data"

Parameters

type: T

Rest ...args: { data: [ArrayBuffer]; }[T]

Returns UartHandle

off

Type Parameters

T extends "data"

Parameters

type: T

handler: ((...args: { data: [ArrayBuffer]; }[T]) => void)

Parameters

Rest ...args: { data: [ArrayBuffer]; }[T]

Returns void

Returns UartHandle

on

Type Parameters

T extends "data"

Parameters

type: T

handler: ((...args: { data: [ArrayBuffer]; }[T]) => void)

Parameters

Rest ...args: { data: [ArrayBuffer]; }[T]

Returns void

Returns UartHandle

once

Type Parameters

T extends "data"

Parameters

type: T

handler: ((...args: { data: [ArrayBuffer]; }[T]) => void)

Parameters

Rest ...args: { data: [ArrayBuffer]; }[T]

Returns void

Returns UartHandle

read

Returns

Parameters

buffer: BufferedType

Returns Promise<number>

write

Returns

Parameters

data: string | BufferedType | Byte[]

Returns Promise<number>

writeAll

Parameters

data: string | BufferedType | Byte[]

Returns Promise<void>

Settings

Member Visibility

Theme

`Rest` ...args: {
data: [ArrayBuffer];
}[T]

handler: ((...args: {
data: [ArrayBuffer];
}[T]) => void)

`Rest` ...args: {
data: [ArrayBuffer];
}[T]

handler: ((...args: {
data: [ArrayBuffer];
}[T]) => void)

`Rest` ...args: {
data: [ArrayBuffer];
}[T]

handler: ((...args: {
data: [ArrayBuffer];
}[T]) => void)

`Rest` ...args: {
data: [ArrayBuffer];
}[T]