pamoja for TypeScript - v0.2.0
    Preparing search index...

    Interface I2cBus

    One I2C bus, shared by the program and every driver built on it.

    Transfers run one at a time, synchronously; each is quick, the time a few bytes take on the wire. A failed transfer throws with the reason: nothing answered at the address, the script expected something else, or the kernel's own words.

    interface I2cBus {
        get kind(): I2cBusKind;
        get remaining(): number | null;
        get transfers(): number;
        get waitedMicros(): number;
        attach(part: hal.I2cPart | hal.WordPart | hal.CommandPart): void;
        part(address: number): hal.I2cPart | hal.WordPart | hal.CommandPart | null;
        read(address: number, length: number): Buffer;
        write(address: number, bytes: Buffer): void;
        writeRead(address: number, bytes: Buffer, length: number): Buffer;
    }
    Index
    • get remaining(): number | null

      How many steps a script has left, or null when the bus is not scripted.

      Returns number | null

    • get transfers(): number

      How many transfers have been made on the bus, by the program and every driver on it, including any that failed.

      Returns number

    • get waitedMicros(): number

      How long the drivers on the bus have asked to wait, in microseconds, whether or not the process slept through it.

      Returns number

    • Reads length bytes from a part in one transaction.

      Parameters

      • address: number
      • length: number

      Returns Buffer

    • Writes bytes to a part in one transaction: usually a register address and its value.

      Parameters

      • address: number
      • bytes: Buffer

      Returns void

    • Writes bytes and then reads length bytes in one transaction, with a repeated start between them, which is how a register is read.

      Parameters

      • address: number
      • bytes: Buffer
      • length: number

      Returns Buffer