Module com.pi4j.plugin.pigpio

Package com.pi4j.plugin.pigpio.provider.i2c

Class PiGpioI2C

java.lang.Object

com.pi4j.common.IdentityBase

com.pi4j.io.IOBase<I2C,I2CConfig,I2CProvider>

com.pi4j.io.i2c.I2CBase<PiGpioI2CBus>

com.pi4j.plugin.pigpio.provider.i2c.PiGpioI2C

All Implemented Interfaces:

Describable, Identity, Lifecycle, Extension, I2C, I2CRegisterDataReader, I2CRegisterDataReaderWriter, I2CRegisterDataWriter, IO<I2C,I2CConfig,I2CProvider>, IODataReader, IODataWriter, AutoCloseable, Readable

public class PiGpioI2C
extends I2CBase<PiGpioI2CBus>
implements I2C

PiGpioI2C class.

Version:

$Id: $Id

Author:

Robert Savage (http://www.savagehomeautomation.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	handle
protected final PiGpio	piGpio

Fields inherited from class com.pi4j.io.i2c.I2CBase

i2CBus, isOpen

Fields inherited from class com.pi4j.io.IOBase

config, provider

Fields inherited from class com.pi4j.common.IdentityBase

description, id, logger, metadata, name

Constructor Summary

Constructors

Constructor	Description
PiGpioI2C(PiGpio piGpio, PiGpioI2CBus i2CBus, I2CProvider provider, I2CConfig config)	Constructor for PiGpioI2C.

Method Summary

Modifier and Type	Method	Description
void	close()
I2C	initialize(Context context)
int	read()
int	read(byte[] buffer, int offset, int length)
int	readRegister(byte[] register, byte[] buffer, int offset, int length)
int	readRegister(int register)
int	readRegister(int register, byte[] buffer, int offset, int length)
int	write(byte b)
int	write(byte[] data, int offset, int length)
int	writeReadRegisterWord(int register, int word)
int	writeRegister(byte[] register, byte[] data, int offset, int length)
int	writeRegister(int register, byte b)
int	writeRegister(int register, byte[] data, int offset, int length)

Methods inherited from class com.pi4j.io.i2c.I2CBase

execute, getRegister, isOpen, shutdown

Methods inherited from class com.pi4j.io.IOBase

config, context, describe, description, name, provider

Methods inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.io.i2c.I2C

bus, device, execute, getBus, getDevice, getRegister, isOpen, register, writeRead, writeRead

Methods inherited from interface com.pi4j.io.i2c.I2CRegisterDataReader

readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegister, readRegisterByte, readRegisterByteBuffer, readRegisterByteBuffer, readRegisterCharArray, readRegisterCharArray, readRegisterCharArray, readRegisterCharArray, readRegisterCharBuffer, readRegisterCharBuffer, readRegisterCharBuffer, readRegisterCharBuffer, readRegisterNBytes, readRegisterNBytes, readRegisterString, readRegisterString, readRegisterString, readRegisterString, readRegisterWord

Methods inherited from interface com.pi4j.io.i2c.I2CRegisterDataWriter

write, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegister, writeRegisterWord

Methods inherited from interface com.pi4j.common.Identity

description, getDescription, getId, getMetadata, getName, id, metadata, name

Methods inherited from interface com.pi4j.io.IO

config, description, name, provider, type

Methods inherited from interface com.pi4j.io.IODataReader

getInputStream, in, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, readByte, readByteBuffer, readByteBuffer, readCharArray, readCharArray, readCharArray, readCharArray, readCharBuffer, readCharBuffer, readCharBuffer, readCharBuffer, readNBytes, readNBytes, readString, readString, readString, readString

Methods inherited from interface com.pi4j.io.IODataWriter

getOutputStream, out, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write

Methods inherited from interface com.pi4j.common.Lifecycle

shutdown

Field Details

piGpio

protected final PiGpio piGpio

handle

protected final int handle

Constructor Details

PiGpioI2C

public PiGpioI2C(PiGpio piGpio,
 PiGpioI2CBus i2CBus,
 I2CProvider provider,
 I2CConfig config)

Constructor for PiGpioI2C.

Parameters:

piGpio - a PiGpio object.

i2CBus - a PiGpioI2CBus object.

provider - a I2CProvider object.

config - a I2CConfig object.

Method Details

initialize

public I2C initialize(Context context)
               throws InitializeException

Specified by:

initialize in interface Lifecycle

Overrides:

initialize in class IOBase<I2C,I2CConfig,I2CProvider>

Throws:

InitializeException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface I2C

Overrides:

close in class I2CBase<PiGpioI2CBus>

write

public int write(byte b)

Specified by:

write in interface IODataWriter

write

public int write(byte[] data,
 int offset,
 int length)

Specified by:

write in interface IODataWriter

read

public int read()

Specified by:

read in interface IODataReader

read

public int read(byte[] buffer,
 int offset,
 int length)

Specified by:

read in interface IODataReader

writeRegister

public int writeRegister(int register,
 byte b)

Specified by:

writeRegister in interface I2CRegisterDataWriter

writeRegister

public int writeRegister(int register,
 byte[] data,
 int offset,
 int length)

Specified by:

writeRegister in interface I2CRegisterDataWriter

writeRegister

public int writeRegister(byte[] register,
 byte[] data,
 int offset,
 int length)

Note: Function not supported with PIGPIO provider. This method 'is' supported in the LinuxFS provider

Specified by:

writeRegister in interface I2CRegisterDataWriter

readRegister

public int readRegister(int register)

Specified by:

readRegister in interface I2CRegisterDataReader

readRegister

public int readRegister(byte[] register,
 byte[] buffer,
 int offset,
 int length)

Note: Function not supported with PIGPIO provider. This method 'is' supported in the LinuxFS provider

Specified by:

readRegister in interface I2CRegisterDataReader

readRegister

public int readRegister(int register,
 byte[] buffer,
 int offset,
 int length)

Specified by:

readRegister in interface I2CRegisterDataReader

writeReadRegisterWord

public int writeReadRegisterWord(int register,
 int word)

Specified by:

writeReadRegisterWord in interface I2CRegisterDataReaderWriter