diff --git a/docs/classes/I2CAccess.html b/docs/classes/I2CAccess.html index ddac092..fa960c9 100644 --- a/docs/classes/I2CAccess.html +++ b/docs/classes/I2CAccess.html @@ -1,10 +1,10 @@ I2CAccess | node-web-i2c
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class I2CAccess

I2CAccess クラス

-

Hierarchy

  • I2CAccess

Index

Constructors

Properties

Accessors

Constructors

constructor

Hierarchy

  • I2CAccess

Index

Constructors

Properties

Accessors

Constructors

constructor

Properties

Private Readonly _ports

_ports: I2CPortMap

Accessors

ports

Returns I2CAccess

Properties

Private Readonly _ports

_ports: I2CPortMap

Accessors

ports

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/I2CPort.html b/docs/classes/I2CPort.html index 14f47a1..45cb4db 100644 --- a/docs/classes/I2CPort.html +++ b/docs/classes/I2CPort.html @@ -1,16 +1,16 @@ I2CPort | node-web-i2c
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class I2CPort

I2CPort クラス

-

Hierarchy

  • I2CPort

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new I2CPort(portNumber: number): I2CPort

Hierarchy

  • I2CPort

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new I2CPort(portNumber: number): I2CPort
  • Creates an instance of GPIOPort.

    Parameters

    • portNumber: number

      ポート番号

      -

    Returns I2CPort

Properties

Private Readonly _portNumber

_portNumber: number

Accessors

portName

  • get portName(): string

Returns I2CPort

Properties

Private Readonly _portNumber

_portNumber: number

Accessors

portName

  • get portName(): string
  • ポート名取得処理

    Returns string

    現在のポート名

    -

portNumber

  • get portNumber(): number

portNumber

  • get portNumber(): number
  • ポート番号取得処理

    Returns number

    現在のポート番号

    -

Methods

open

Methods

open

  • I2CSlave 接続デバイスオープン処理

    Parameters

    • slaveAddress: number

      接続デバイス情報のアドレス

      diff --git a/docs/classes/I2CPortMap.html b/docs/classes/I2CPortMap.html index b270060..6855cec 100644 --- a/docs/classes/I2CPortMap.html +++ b/docs/classes/I2CPortMap.html @@ -4,7 +4,7 @@

      Returns an iterable of entries in the map.

      Returns IterableIterator<[number, I2CPort]>

clear

  • clear(): void
  • Returns void

delete

  • delete(key: number): boolean
  • Parameters

    • key: number

    Returns boolean

entries

  • entries(): IterableIterator<[number, I2CPort]>
  • Returns an iterable of key, value pairs for every entry in the map.

    -

    Returns IterableIterator<[number, I2CPort]>

forEach

  • forEach(callbackfn: (value: I2CPort, key: number, map: Map<number, I2CPort>) => void, thisArg?: any): void
  • Parameters

    • callbackfn: (value: I2CPort, key: number, map: Map<number, I2CPort>) => void
    • Optional thisArg: any

    Returns void

get

  • get(key: number): undefined | I2CPort
  • Parameters

    • key: number

    Returns undefined | I2CPort

getByName

  • getByName(portName: string): undefined | I2CPort

has

  • has(key: number): boolean
  • Parameters

    • key: number

    Returns boolean

keys

  • keys(): IterableIterator<number>
  • +

    Returns IterableIterator<[number, I2CPort]>

forEach

  • forEach(callbackfn: (value: I2CPort, key: number, map: Map<number, I2CPort>) => void, thisArg?: any): void
  • Parameters

    • callbackfn: (value: I2CPort, key: number, map: Map<number, I2CPort>) => void
    • Optional thisArg: any

    Returns void

get

  • get(key: number): undefined | I2CPort
  • Parameters

    • key: number

    Returns undefined | I2CPort

getByName

  • getByName(portName: string): undefined | I2CPort

has

  • has(key: number): boolean
  • Parameters

    • key: number

    Returns boolean

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the map

    Returns IterableIterator<number>

set

  • Parameters

    Returns I2CPortMap

values

  • values(): IterableIterator<I2CPort>
  • Returns an iterable of values in the map

    diff --git a/docs/classes/OperationError.html b/docs/classes/OperationError.html index e940a43..aed6286 100644 --- a/docs/classes/OperationError.html +++ b/docs/classes/OperationError.html @@ -1,6 +1,6 @@ OperationError | node-web-i2c
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class OperationError

    操作エラー

    -

    Hierarchy

    • Error
      • OperationError

    Index

    Constructors

    constructor

    Hierarchy

    • Error
      • OperationError

    Index

    Constructors

    constructor

    Methods

    read16

    • read16(registerNumber: number): Promise<number>
    • function

      I2C 読み取り処理

      Parameters

      • registerNumber: number

        読み取りアドレス

        -

      Returns Promise<number>

    read8

    • read8(registerNumber: number): Promise<number>

Returns Promise<number>

read8

  • read8(registerNumber: number): Promise<number>
  • function

    I2C 読み取り処理

    Parameters

    • registerNumber: number

      読み取りアドレス

      -

    Returns Promise<number>

readByte

  • readByte(): Promise<number>
  • function

    I2c bytes 読み取りバイト処理 +

Returns Promise<number>

readByte

  • readByte(): Promise<number>
  • function

    I2c bytes 読み取りバイト処理 Different from Web I2C API specification.

    -

    Returns Promise<number>

readBytes

  • readBytes(length: number): Promise<Uint8Array>
  • function

    I2c bytes 読み取りバイト処理 +

    Returns Promise<number>

readBytes

  • readBytes(length: number): Promise<Uint8Array>
  • function

    I2c bytes 読み取りバイト処理 Different from Web I2C API specification.

    Parameters

    • length: number

      読み取る配列の長さ

      -

    Returns Promise<Uint8Array>

write16

  • write16(registerNumber: number, value: number): Promise<number>
  • function

    I2c bytes 書き込み処理

    +

Returns Promise<Uint8Array>

write16

write8

Returns Promise<number>

write8

writeByte

Returns Promise<number>

writeByte

writeBytes

Returns Promise<number>

writeBytes