Variable i2cConst

Type Declaration

• RESERVED_BELOW: number

  The first 7-bit address above the reserved block at the bottom of the range.

• RESERVED_FROM: number

  The lowest 7-bit address the specification keeps for itself.

• addressFrame: function

  • addressFrame(
        address: number,
        options?: { read?: boolean; tenBit?: boolean },
    ): Buffer

    Returns the address bytes a controller puts on the bus for a transfer.

    Parameters

    • address: number

      The device address.

    • Optionaloptions: { read?: boolean; tenBit?: boolean }

      read selects the direction, tenBit the address width.

    Returns Buffer

    One byte for a 7-bit address, two for a 10-bit one.

    Throws

    If the address is outside its width's range.

• frameLen: function

  • frameLen(address: number, tenBit?: boolean): number

    Returns how many bytes an address frame occupies.

    Parameters

    • address: number

      The device address.

    • OptionaltenBit: boolean

      Whether it is a 10-bit address.

    Returns number

    1 for a 7-bit address, 2 for a 10-bit one.

    Throws

    If the address is outside its width's range.

• isGeneralCall: function

  • isGeneralCall(address: number, tenBit?: boolean): boolean

    Reports whether an address is the general call address 0x00.

    Parameters

    • address: number

      The device address.

    • OptionaltenBit: boolean

      Whether it is a 10-bit address.

    Returns boolean

    Whether this is the broadcast every device listens to.

    Throws

    If the address is outside its width's range.

• isReserved: function

  • isReserved(address: number, tenBit?: boolean): boolean

    Reports whether an address falls in a range the specification reserves.

    UM10204 reserves 0x00..=0x07 and 0x78..=0x7F, leaving 0x08..=0x77 for ordinary devices.

    Parameters

    • address: number

      The device address.

    • OptionaltenBit: boolean

      Whether it is a 10-bit address, which is never reserved.

    Returns boolean

    Whether the address is reserved.

    Throws

    If the address is outside its width's range.