Method Detail

• read8

  byte read8(int ireg)

  Read the byte at the indicated register. See readTimeStamped(int, int) for a complete description.

  Parameters:

  ireg - the register number to read

  Returns:

  the byte that was read

  See Also:

  read(int, int), readTimeStamped(int, int), I2cDeviceSynch.ensureReadWindow(I2cDeviceSynch.ReadWindow, I2cDeviceSynch.ReadWindow)

• read

  byte[] read(int ireg,
            int creg)

  Read a contiguous set of device I2C registers. See readTimeStamped(int, int) for a complete description.

  Parameters:

  ireg - the register number of the first byte register to read

  creg - the number of bytes / registers to read

  Returns:

  the data which was read

  See Also:

  read8(int), readTimeStamped(int, int), I2cDeviceSynch.ensureReadWindow(I2cDeviceSynch.ReadWindow, I2cDeviceSynch.ReadWindow)

• readTimeStamped

  I2cDeviceSynchSimple.TimestampedData readTimeStamped(int ireg,
                                                     int creg)

  Reads and returns a contiguous set of device I2C registers, together with a best-available timestamp of when the actual I2C read occurred. Note that this can take many tens of milliseconds to execute, and thus should not be called from the loop() thread.

  You can always just call this method without worrying at all about read windows, that will work, but usually it is more efficient to take some thought and care as to what set of registers the I2C device controller is being set up to read, as adjusting that window of registers incurs significant extra time.

  If the current read window can't be used to read the requested registers, then a new read window will automatically be created as follows. If the current read window is non null and wholly contains the registers to read but can't be read because it is a used-up ReadMode#ONLY_ONCE window, a new read fresh window will be created with the same set of registers. Otherwise, a window that exactly covers the requested set of registers will be created.

  Parameters:

  ireg - the register number of the first byte register to read

  creg - the number of bytes / registers to read

  Returns:

  the data which was read, together with the timestamp

  See Also:

  read(int, int), read8(int), I2cDeviceSynch.ensureReadWindow(I2cDeviceSynch.ReadWindow, I2cDeviceSynch.ReadWindow)

• write8

  void write8(int ireg,
            int bVal)

  Writes a byte to the indicated register. See also write(int, byte[], boolean).

  Parameters:

  ireg - the register number that is to be written

  bVal - the byte which is to be written to that register

  See Also:

  write(int, byte[], boolean)

• write

  void write(int ireg,
           byte[] data)

  Writes data to a set of registers, beginning with the one indicated. See also write(int, byte[], boolean).

  Parameters:

  ireg - the first of the registers which is to be written

  data - the data which is to be written to the registers

  See Also:

  write(int, byte[], boolean)

• write8

  void write8(int ireg,
            int bVal,
            boolean waitForCompletion)

  Writes a byte to the indicated register. See also write(int, byte[], boolean).

  Parameters:

  ireg - the register number that is to be written

  bVal - the byte which is to be written to that register

  waitForCompletion - whether or not to wait until the write has been sent to the controller

  See Also:

  write(int, byte[], boolean)

• write

  void write(int ireg,
           byte[] data,
           boolean waitForCompletion)

  Writes data to a set of registers, beginning with the one indicated. The data will be written to the I2C device in an expeditious manner. Once data is accepted by this API, it is guaranteed that (barring catastrophic failure) the data will be transmitted to the USB controller module before the I2cDeviceSync is closed. The call itself may or may block until the data has been transmitted to the USB controller module according to a caller-provided parameter.

  Parameters:

  ireg - the first of the registers which is to be written

  data - the data which is to be written to the registers

  waitForCompletion - whether or not to wait until the write has been sent to the controller

• waitForWriteCompletions

  void waitForWriteCompletions()

  Waits for any previously issued writes to be written to the USB controller module.

• enableWriteCoalescing

  void enableWriteCoalescing(boolean enable)

  Enables or disables an optimization wherein writes to two sets of adjacent register ranges may be coalesced into a single I2c transaction if the second write comes along while the first is still queued for writing. By default, write coalescing is disabled.

  Parameters:

  enable - whether to enable write coalescing or not

  See Also:

  isWriteCoalescingEnabled()

• isWriteCoalescingEnabled

  boolean isWriteCoalescingEnabled()

  Answers as to whether write coalescing is currently enabled on this device.

  Returns:

  whether write coalescing is currently enabled or not.

  See Also:

  enableWriteCoalescing(boolean)

• isArmed

  boolean isArmed()

  Returns whether, as of this instant, this device client is alive and operational in its normally expected mode; that is, whether it is currently in communication with its underlying hardware or whether it is in some other state. Note that a device client which is not engaged will never report as armed.

  Returns:

  the arming state of this device client

  See Also:

  Engagable.engage()

• setI2cAddr

  @Deprecated
  void setI2cAddr(I2cAddr i2cAddr)

  Deprecated. Use I2cAddrConfig.setI2cAddress(I2cAddr) instead.
  Sets the I2C address of the underlying client. If necessary, the client may be briefly disengaged (and then automatically reengaged) in the process.

  Parameters:

  i2cAddr - the new I2C address

• getI2cAddr

  @Deprecated
  I2cAddr getI2cAddr()

  Deprecated. Use I2cAddressableDevice.getI2cAddress() instead.
  Returns the I2C address currently being used by this device client

  Returns:

  the current I2C address

• setLogging

  void setLogging(boolean enabled)

  Turn logging on or off. Logging output can be viewed using the Android Logcat tools.

  Parameters:

  enabled - whether to enable logging or not

• setLoggingTag

  void setLoggingTag(java.lang.String loggingTag)

  Set the tag to use when logging is on.

  Parameters:

  loggingTag - the logging tag to sue