Interface I2C

Hierarchy

I2C

Index

Methods

find readFrom setup writeTo

Methods

find

find(pin): I2C
Find an I2C interface by its pin.
Parameters
- pin: number
  
  The pin the I2C interface is connected to.
Returns I2C
The I2C interface, or undefined if not found.
- Defined in i2c.d.ts:8

readFrom

readFrom(address, quantity): Uint8Array
Read from the given address.
Parameters
- address: number
  
  The address to read from.
- quantity: number
  
  The number of bytes to read.
Returns Uint8Array
The bytes read.
- Defined in i2c.d.ts:16

setup

setup(options): void
Setup the I2C interface.
Parameters
- options: {
      bitrate?: number;
      scl?: number;
      sda?: number;
  }
  
  The options to use when setting up the I2C interface.
  - Optional bitrate?: number
  - Optional scl?: number
  - Optional sda?: number
Returns void
- Defined in i2c.d.ts:29

writeTo

writeTo(address, buffer): void
Write to the given address.
Parameters
- address: number
  
  The address to write to.
- buffer: string | number | number[] | ArrayBuffer | Uint8Array
  
  The data to write.
Returns void
- Defined in i2c.d.ts:23

Generated using TypeDoc