Package com.diozero.api

Class I2CDevice

java.lang.Object
com.diozero.api.I2CDevice
All Implemented Interfaces:
I2CConstants, java.io.Closeable, java.lang.AutoCloseable
public class I2CDevice
extends java.lang.Object
implements java.io.Closeable, I2CConstants
Utility class reading / writing to I2C devices.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  I2CDevice.ProbeMode  

  • Field Summary

    Fields inherited from interface com.diozero.api.I2CConstants

    ADDR_SIZE_10, ADDR_SIZE_7, BUS_0, BUS_1, DEFAULT_CLOCK_FREQUENCY, SUB_ADDRESS_SIZE_1_BYTE, SUB_ADDRESS_SIZE_2_BYTES, UNASSIGNED

  • Constructor Summary

    Constructors 
    Constructor Description
    I2CDevice​(int controller, int address)  
    I2CDevice​(int controller, int address, int addressSize, int clockFrequency)  
    I2CDevice​(int controller, int address, int addressSize, int clockFrequency, java.nio.ByteOrder order)  
    I2CDevice​(int controller, int address, java.nio.ByteOrder order)  
    I2CDevice​(I2CDeviceFactoryInterface deviceFactory, int controller, int address, int addressSize, int clockFrequency, java.nio.ByteOrder order)  

  • Method Summary

    Modifier and Type Method Description
    void close()  
    int getAddress()  
    int getAddressSize()  
    int getClockFrequency()  
    int getController()  
    boolean isOpen()  
    boolean probe()  
    boolean probe​(I2CDevice.ProbeMode mode)  
    byte[] read​(int count)  
    java.nio.ByteBuffer read​(int address, int count)  
    byte[] read​(int address, int subAddressSize, int count)  
    void read​(int address, int subAddressSize, java.nio.ByteBuffer buffer)  
    void read​(int address, java.nio.ByteBuffer dst)  
    void read​(java.nio.ByteBuffer dst)  
    boolean readBit​(int regAddr, int bitNum)
    Read a single bit from an 8-bit device register
    byte readBits​(int regAddr, int bitStart, int length)
    Read multiple bits from an 8-bit device register
    byte readByte()  
    byte readByte​(int regAddr)
    Read a single byte from an 8-bit device register
    byte readByte​(int register, int subAddressSize)  
    byte[] readBytes​(int regAddr, int length)
    Read multiple bytes from an 8-bit device register
    short readShort​(int address)  
    short readShort​(int address, int subAddressSize)  
    short readShort​(int address, int subAddressSize, java.nio.ByteOrder order)  
    short readUByte​(int regAddr)  
    long readUInt​(int address)  
    long readUInt​(int address, int subAddressSize, int length)  
    long readUInt​(int address, int subAddressSize, int length, java.nio.ByteOrder order)  
    long readUInt​(int address, java.nio.ByteOrder order)  
    int readUShort​(int address)  
    int readUShort​(int address, int subAddressSize)  
    int readUShort​(int address, int subAddressSize, java.nio.ByteOrder order)  
    void write​(byte[] data)  
    void write​(byte[] data, java.nio.ByteOrder order)  
    void write​(int register, int subAddressSize, byte value)
    Writes a single byte to a register
    void write​(int register, int subAddressSize, byte[] value)
    Writes a single byte to a register
    void write​(int registerAddress, int addressSize, java.nio.ByteBuffer buffer, int payloadLength, java.nio.ByteOrder order)  
    void write​(int registerAddress, java.nio.ByteBuffer buffer, int payloadLength)  
    void write​(java.nio.ByteBuffer buffer, int payloadLength)  
    void write​(java.nio.ByteBuffer buffer, int payloadLength, java.nio.ByteOrder order)  
    void writeBit​(int regAddr, int bitNum, boolean value)
    write a single bit in an 8-bit device register
    void writeBit​(int regAddr, int bitNum, int value)
    write a single bit in an 8-bit device register
    void writeBits​(int regAddr, int bitStart, int length, int data)
    Write multiple bits in an 8-bit device register
    void writeByte​(byte data)  
    void writeByte​(int regAddr, byte data)
    Write a single byte to an 8-bit device register
    void writeByte​(int regAddr, int data)
    Write a single byte to an 8-bit device register
    void writeBytes​(int regAddr, int length, byte[] data)
    Write multiple bytes to an 8-bit device register
    void writeBytes​(int regAddr, int length, byte[] data, int offset)  
    void writeShort​(int regAddr, short val)  
    void writeWord​(int regAddr, int data)
    Write a single word to a 16-bit device register

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait