Package com.diozero.api

Class I2CDevice.Builder

java.lang.Object

com.diozero.api.I2CDevice.Builder

Enclosing class:

I2CDevice

public static class I2CDevice.Builder
extends Object

I2C device builder. Default values:

• controller: 1
• addressSize: 7
• byteOrder: Big Endian

Field Summary

Fields

Modifier and Type	Field	Description
static ByteOrder	DEFAULT_BYTE_ORDER	Default to ByteOrder.BIG_ENDIAN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(int address)

Method Summary

Modifier and Type	Method	Description
I2CDevice	build()	Construct a new I2CDevice instance
I2CDeviceFactoryInterface	getFactory()
I2CDevice.Builder	setAddress(int address)	Set the I2c device address
I2CDevice.Builder	setAddressSize(I2CConstants.AddressSize addressSize)	Set the I2C device address size
I2CDevice.Builder	setByteOrder(ByteOrder byteOrder)	Set the Default byte order for this device
I2CDevice.Builder	setController(int controller)	Set the I2C bus controller
I2CDevice.Builder	setFactory(I2CDeviceFactoryInterface factory)	Set the I2C device factory to use for provisioning I2C device instances

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BYTE_ORDER

public static final ByteOrder DEFAULT_BYTE_ORDER

Default to ByteOrder.BIG_ENDIAN

Constructor Details

Builder

protected Builder(int address)

Method Details

getFactory

public I2CDeviceFactoryInterface getFactory()

setFactory

public I2CDevice.Builder setFactory(I2CDeviceFactoryInterface factory)

Set the I2C device factory to use for provisioning I2C device instances

Parameters:

factory - the I2C device factory to use for provisioning I2C device instances

Returns:

this builder instance

setController

public I2CDevice.Builder setController(int controller)

Set the I2C bus controller

Parameters:

controller - the I2C bus controller number (/dev/i2c-<controller>)

Returns:

this builder instance

setAddress

public I2CDevice.Builder setAddress(int address)

Set the I2c device address

Parameters:

address - the I2C device address

Returns:

this builder instance

setAddressSize

public I2CDevice.Builder setAddressSize(I2CConstants.AddressSize addressSize)

Set the I2C device address size

Parameters:

addressSize - the I2C device address size

Returns:

this builder instance

setByteOrder

public I2CDevice.Builder setByteOrder(ByteOrder byteOrder)

Set the Default byte order for this device

Parameters:

byteOrder - the byte order that is only used in the additional non-SMBus I2C device utility methods

Returns:

this builder instance

build

public I2CDevice build()

Construct a new I2CDevice instance

Returns:

a new I2C device