com.mbientlab.metawear.module

Interface I2C

All Superinterfaces:

MetaWearBoard.Module

public interface I2C
extends MetaWearBoard.Module

Communicates with the I2C bus, providing direct access sensors connected via I2C

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	I2C.SourceSelector Selector for the I2C data sources

Method Summary

Modifier and Type	Method and Description
AsyncOperation<byte[]>	readData(byte deviceAddr, byte registerAddr, byte numBytes) Read data via the I2C bus and stream result to user.
AsyncOperation<java.lang.Void>	readData(byte deviceAddr, byte registerAddr, byte numBytes, byte id) Read data via the I2C bus.
I2C.SourceSelector	routeData() Initiates the creation of a data route
void	writeData(byte deviceAddr, byte registerAddr, byte[] data) Write data via the I2C bus without attaching a user id to the data.

Method Detail

writeData

void writeData(byte deviceAddr,
               byte registerAddr,
               byte[] data)

Write data via the I2C bus without attaching a user id to the data.

Parameters:

deviceAddr - Device to write to

registerAddr - Device's register to write to

data - Data to write, up to 10 bytes

readData

AsyncOperation<byte[]> readData(byte deviceAddr,
                                byte registerAddr,
                                byte numBytes)

Read data via the I2C bus and stream result to user. This version of the function does not use the data route system, it only streams data to the user.

Parameters:

deviceAddr - Device to read from

registerAddr - Device's register to read

numBytes - Number of bytes to read

Returns:

Byte array containing the register data, available when read operation completes

readData

AsyncOperation<java.lang.Void> readData(byte deviceAddr,
                                        byte registerAddr,
                                        byte numBytes,
                                        byte id)

Read data via the I2C bus. This version of the function uses the data route system. The user ID and data length (numBytes parameters) must match their respective parameters in the SourceSelector.fromId function

Parameters:

deviceAddr - Device to read from

registerAddr - Device's register to read

numBytes - User id identifying the data

id - Number of bytes to read

See Also:

I2C.SourceSelector.fromId(byte, byte)

routeData

I2C.SourceSelector routeData()

Initiates the creation of a data route

Returns:

Selection of available data sources