com.mbientlab.metawear.module

Interface SerialPassthrough

All Superinterfaces:

MetaWearBoard.Module

public interface SerialPassthrough
extends MetaWearBoard.Module

Bridge for serial communication to connected sensors

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SerialPassthrough.I2C Data received from the I2C bus
static interface	SerialPassthrough.SPI Data received from the SPI bus
static class	SerialPassthrough.SpiFrequency Supported SPI frequencies
static interface	SerialPassthrough.SpiParameterBuilder<T> Builder to construct common parameters for an SPI read/write operation.

Method Summary

Modifier and Type	Method and Description
SerialPassthrough.I2C	i2c(byte length, byte id) Get an object representing the I2C data corresponding to the id.
bolts.Task<byte[]>	readI2cAsync(byte deviceAddr, byte registerAddr, byte length) Read data from a sensor via the I2C bus.
SerialPassthrough.SpiParameterBuilder<bolts.Task<byte[]>>	readSpiAsync(byte length) Read data from a sensor via the SPI bus.
SerialPassthrough.SPI	spi(byte length, byte id) Get an object representing the SPI data corresponding to the id.
void	writeI2c(byte deviceAddr, byte registerAddr, byte[] data) Write data to a sensor via the I2C bus.
SerialPassthrough.SpiParameterBuilder<java.lang.Void>	writeSpi() Write data to a sensor via the SPI bus.

Method Detail

i2c

SerialPassthrough.I2C i2c(byte length,
                          byte id)

Get an object representing the I2C data corresponding to the id. If the id value cannot be matched with an existing object, the API will create a new object using the length parameter otherwise the existing object will be returned

Parameters:

length - Expected length of the data

id - Value between [0, 254]

Returns:

I2C object representing I2C data

writeI2c

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

Write data to a sensor via the I2C bus.

Parameters:

deviceAddr - Device to write to

registerAddr - Device's register to write to

data - DataToken to write, up to 10 bytes

readI2cAsync

bolts.Task<byte[]> readI2cAsync(byte deviceAddr,
                                byte registerAddr,
                                byte length)

Read data from a sensor via the I2C bus. Unlike SerialPassthrough.I2C.read(byte, byte), this function provides a direct way to access I2C data as opposed to creating a data route.

Parameters:

deviceAddr - Address of the slave device

registerAddr - Register on the slave device to access

length - How many bytes to read

Returns:

Task holding the returned value

spi

SerialPassthrough.SPI spi(byte length,
                          byte id)

Get an object representing the SPI data corresponding to the id. If the id value cannot be matched with an existing object, the API will create a new object using the length parameter otherwise the existing object will be returned

Parameters:

length - Expected length of the data

id - Value between [0, 14]

Returns:

SPI object representing SPI data, null if the SPI bus is not accessible with the current firmware

writeSpi

SerialPassthrough.SpiParameterBuilder<java.lang.Void> writeSpi()

Write data to a sensor via the SPI bus. The data to be written to the board is set with the SerialPassthrough.SpiParameterBuilder.data(byte[]) method

Returns:

Builder to set additional parameters, null if the SPI bus is not accessible with the current firmware

readSpiAsync

SerialPassthrough.SpiParameterBuilder<bolts.Task<byte[]>> readSpiAsync(byte length)

Read data from a sensor via the SPI bus. Unlike SerialPassthrough.SPI.read(), this function provides a direct way to access SPI data as opposed to creating a data route. If the SPI bus is not accessible with the current firmware, the operation will fail with an UnsupportedOperationException.

Parameters:

length - How many bytes to read

Returns:

Editor object to configure the read parameters