com.pi4j.component.potentiometer.microchip

Class MCP4642

java.lang.Object

com.pi4j.component.ComponentBase

com.pi4j.component.potentiometer.microchip.impl.MicrochipPotentiometerBase

com.pi4j.component.potentiometer.microchip.MCP4642

All Implemented Interfaces:

Component, MicrochipPotentiometer, Potentiometer

public class MCP4642
extends MicrochipPotentiometerBase
implements MicrochipPotentiometer

Pi4J-device for MCP4642.

Author:

Raspelikan

Field Summary

Fields inherited from class com.pi4j.component.potentiometer.microchip.impl.MicrochipPotentiometerBase

INITIALVALUE_LOADED_FROM_EEPROM, nonVolatileMode, PIN_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
MCP4642(I2CBus i2cBus, boolean pinA0, boolean pinA1, MicrochipPotentiometerChannel channel, MicrochipPotentiometerNonVolatileMode nonVolatileMode) Builds an instance which is ready to use.

Method Summary

Modifier and Type	Method and Description
int	getMaxValue()
MicrochipPotentiometerChannel[]	getSupportedChannelsByDevice()
boolean	isCapableOfNonVolatileWiper()
boolean	isRheostat()
static int	maxValue()
void	setNonVolatileMode(MicrochipPotentiometerNonVolatileMode nonVolatileMode) The visibility of this method is protected because not all devices support non-volatile wipers.

Methods inherited from class com.pi4j.component.potentiometer.microchip.impl.MicrochipPotentiometerBase

buildI2CAddress, decrease, decrease, equals, getChannel, getCurrentValue, getDeviceStatus, getNonVolatileMode, getNonVolatileValue, getTerminalConfiguration, increase, increase, initialize, isChannelSupportedByDevice, setCurrentValue, setTerminalConfiguration, setWiperLock, setWriteProtection, toString, updateCacheFromDevice

Methods inherited from class com.pi4j.component.ComponentBase

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pi4j.component.potentiometer.microchip.MicrochipPotentiometer

getChannel, getDeviceStatus, getNonVolatileMode, getTerminalConfiguration, isChannelSupportedByDevice, setTerminalConfiguration, setWiperLock, setWriteProtection, updateCacheFromDevice

Methods inherited from interface com.pi4j.component.potentiometer.Potentiometer

decrease, decrease, getCurrentValue, increase, increase, setCurrentValue

Methods inherited from interface com.pi4j.component.Component

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Constructor Detail

MCP4642

public MCP4642(I2CBus i2cBus,
               boolean pinA0,
               boolean pinA1,
               MicrochipPotentiometerChannel channel,
               MicrochipPotentiometerNonVolatileMode nonVolatileMode)
        throws IOException

Builds an instance which is ready to use.

Parameters:

i2cBus - The Pi4J-I2CBus to which the device is connected to

pinA0 - Whether the device's address pin A0 is high (true) or low (false)

pinA1 - Whether the device's address pin A1 (if available) is high (true) or low (false)

channel - Which of the potentiometers provided by the device to control

nonVolatileMode - The way non-volatile reads or writes are done

Throws:

IOException - Thrown if communication fails or device returned a malformed result

Method Detail

isCapableOfNonVolatileWiper

public boolean isCapableOfNonVolatileWiper()

Specified by:

isCapableOfNonVolatileWiper in interface MicrochipPotentiometer

Specified by:

isCapableOfNonVolatileWiper in class MicrochipPotentiometerBase

Returns:

Whether device is capable of non volatile wipers (true for MCP4642)

setNonVolatileMode

public void setNonVolatileMode(MicrochipPotentiometerNonVolatileMode nonVolatileMode)

Description copied from class: MicrochipPotentiometerBase

The visibility of this method is protected because not all devices support non-volatile wipers. Any derived class may publish this method.

Overrides:

setNonVolatileMode in class MicrochipPotentiometerBase

Parameters:

nonVolatileMode - The way non-volatile reads or writes are done

getMaxValue

public int getMaxValue()

Specified by:

getMaxValue in interface Potentiometer

Returns:

The maximal value at which a wiper can be (128 for MCP4642)

maxValue

public static int maxValue()

Returns:

The maximal value at which a wiper can be (128 for MCP4642)

isRheostat

public boolean isRheostat()

Specified by:

isRheostat in interface Potentiometer

Returns:

Whether this device is a potentiometer or a rheostat (true for MCP4642)

getSupportedChannelsByDevice

public MicrochipPotentiometerChannel[] getSupportedChannelsByDevice()

Specified by:

getSupportedChannelsByDevice in interface MicrochipPotentiometer

Specified by:

getSupportedChannelsByDevice in class MicrochipPotentiometerBase

Returns:

All channels supported by the underlying device (A, B for MCP4642)