Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CanariumGen2

PERIDOTボードドライバ(第2世代通信仕様)

Hierarchy

  • EventEmitter
    • CanariumGen2

Index

Interfaces

Type aliases

Constructors

Properties

Accessors

Methods

Type aliases

Static AvsReadableStream

AvsReadableStream: AvsReadableStream

Avalon-STストリーム入力クラス

Static AvsWritableStream

AvsWritableStream: AvsWritableStream

Avalon-STストリーム出力クラス

Static RpcClient

RpcClient: RpcClient

RPCクライアントクラス

Static RpcError

RpcError: RpcError

RPC関連エラークラス

Constructors

constructor

  • Canarium(Gen2)のインスタンスを生成する

    Parameters

    • _path: string

      接続先のパス

    • Optional options: OpenOptions

      接続オプション

    Returns CanariumGen2

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

avm

opened

  • get opened(): boolean

  • 接続されているか否か

    Returns boolean

path

  • get path(): string

Static Binding

  • get Binding(): SerialPort
  • set Binding(binding: SerialPort): void

  • SerialPortクラスへのbinding

    Returns SerialPort

  • SerialPortクラスへのbinding

    Parameters

    • binding: SerialPort

    Returns void

Static version

  • get version(): string

  • バージョン (canariumパッケージのバージョン)

    Returns string

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

close

  • close(): Promise<void>
  • close(callback: function): void

  • ボードから切断する

    Returns Promise<void>

  • ボードから切断する

    Parameters

    • callback: function

      コールバック関数

        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

createReadStream

  • 読み込みストリームを作成する

    Parameters

    • channel: number

      チャネル番号

    • Optional packetized: boolean

      パケット化するか否か(trueの場合、SOP&EOPで識別されたパケットを単位として受信する)

    Returns AvsReadableStream

  • 読み込みストリームを作成する

    Parameters

    • channel: number

      チャネル番号

    • options: StreamOptions

      ストリームの振る舞いを指定するオプション

    Returns AvsReadableStream

createRpcClient

createWriteStream

  • 書き込みストリームを作成する

    Parameters

    • channel: number

      チャネル番号

    • Optional packetized: boolean

      パケット化するか否か(trueの場合、1回で書き込まれたデータは1パケットとして送信される)

    Returns AvsWritableStream

  • 書き込みストリームを作成する

    Parameters

    • channel: number

      チャネル番号

    • options: StreamOptions

      ストリームの振る舞いを指定するオプション

    Returns AvsWritableStream

dispose

  • dispose(): Promise<void>

  • オブジェクトの廃棄

    Returns Promise<void>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getInfo

  • getInfo(): Promise<BoardInfo>
  • getInfo(callback: function): void

  • ボード情報を取得する

    Returns Promise<BoardInfo>

  • ボード情報を取得する

    Parameters

    • callback: function

      コールバック関数

        • Parameters

          Returns void

    Returns void

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

once

  • once(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

open

  • open(): Promise<void>
  • open(boardInfo: BoardInfo): Promise<void>
  • open(callback: function): void
  • open(boardInfo: BoardInfo, callback: function): void

  • ボードに接続する

    Returns Promise<void>

  • 接続できるボードを限定して、ボードに接続する

    Parameters

    • boardInfo: BoardInfo

      接続先ボード情報

    Returns Promise<void>

  • ボードに接続する

    Parameters

    • callback: function

      コールバック関数

        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • 接続できるボードを限定して、ボードに接続する

    Parameters

    • boardInfo: BoardInfo

      接続先ボード情報

    • callback: function

      コールバック関数

        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

prependListener

  • prependListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Static list

  • 接続先を列挙する (PERIDOTでないデバイスも列挙されうることに注意)

    Parameters

    • Optional options: ListOptions

      列挙のオプション

    Returns Promise<PortInfo[]>

  • 接続先を列挙する (PERIDOTでないデバイスも列挙されうることに注意)

    Parameters

    • callback: function

      コールバック関数

        • (err: Error, ports?: PortInfo[]): void

        • Parameters

          Returns void

    Returns void

  • 接続先を列挙する (PERIDOTでないデバイスも列挙されうることに注意)

    Parameters

    • options: ListOptions

      列挙のオプション

    • callback: function

      コールバック関数

        • (err: Error, ports?: PortInfo[]): void

        • Parameters

          Returns void

    Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc