com.pi4j.component.potentiometer.microchip.impl

Class MicrochipPotentiometerBase

java.lang.Object

com.pi4j.component.ComponentBase

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

All Implemented Interfaces:

Component, MicrochipPotentiometer, Potentiometer

Direct Known Subclasses:

MCP4431, MCP4432, MCP4441, MCP4442, MCP4451, MCP4452, MCP4461, MCP4462, MCP4531, MCP4532, MCP4541, MCP4542, MCP4551, MCP4552, MCP4561, MCP4562, MCP4631, MCP4632, MCP4641, MCP4642, MCP4651, MCP4652, MCP4661, MCP4662

public abstract class MicrochipPotentiometerBase
extends ComponentBase
implements MicrochipPotentiometer

Abstract Pi4J-device for MCP45XX and MCP46XX ICs.

Author:

Raspelikan

See Also:

MCP4561, MCP4651

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	INITIALVALUE_LOADED_FROM_EEPROM The value which is used for devices capable of non-volatile wipers.
protected MicrochipPotentiometerNonVolatileMode	nonVolatileMode Whether to use the volatile or the non-volatile wiper
protected static boolean	PIN_NOT_AVAILABLE The value which is used for address-bit if the device's package does not provide a matching address-pin (see 6.2.4)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MicrochipPotentiometerBase(I2CBus i2cBus, boolean pinA0, boolean pinA1, boolean pinA2, MicrochipPotentiometerChannel channel, MicrochipPotentiometerNonVolatileMode nonVolatileMode, int initialValueForVolatileWipers) Builds an instance which is ready to use.
protected	MicrochipPotentiometerBase(I2CBus i2cBus, boolean pinA0, boolean pinA1, boolean pinA2, MicrochipPotentiometerChannel channel, MicrochipPotentiometerNonVolatileMode nonVolatileMode, int initialValueForVolatileWipers, MicrochipPotentiometerDeviceControllerFactory controllerFactory) Builds an instance which is ready to use.

Method Summary

Modifier and Type	Method and Description
protected static int	buildI2CAddress(boolean pinA0, boolean pinA1, boolean pinA2)
void	decrease() Decreases the wiper's value for one step.
void	decrease(int steps) Decreases the wiper's value for n steps.
boolean	equals(Object obj) Tests whether a given object equals to this object.
MicrochipPotentiometerChannel	getChannel()
int	getCurrentValue() The wiper's value read from cache.
MicrochipPotentiometerDeviceStatus	getDeviceStatus()
MicrochipPotentiometerNonVolatileMode	getNonVolatileMode()
protected int	getNonVolatileValue() The visibility of this method is protected because not all devices support non-volatile wipers.
abstract MicrochipPotentiometerChannel[]	getSupportedChannelsByDevice()
MicrochipPotentiometerTerminalConfiguration	getTerminalConfiguration()
void	increase() Increases the wiper's value for one step.
void	increase(int steps) Increases the wiper's value for n steps.
protected void	initialize(int initialValueForVolatileWipers) Initializes the wiper to a defined status.
abstract boolean	isCapableOfNonVolatileWiper()
boolean	isChannelSupportedByDevice(MicrochipPotentiometerChannel channel)
void	setCurrentValue(int value) Set wiper's value.
protected void	setNonVolatileMode(MicrochipPotentiometerNonVolatileMode nonVolatileMode) The visibility of this method is protected because not all devices support non-volatile wipers.
void	setTerminalConfiguration(MicrochipPotentiometerTerminalConfiguration terminalConfiguration)
void	setWiperLock(boolean enabled) Enables or disables wiper-lock.
void	setWriteProtection(boolean enabled) Enables or disables write-protection for devices capable of non-volatile memory.
String	toString()
int	updateCacheFromDevice() Updates the cache to the wiper's value.

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.Potentiometer

getMaxValue, isRheostat

Methods inherited from interface com.pi4j.component.Component

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

Field Detail

PIN_NOT_AVAILABLE

protected static final boolean PIN_NOT_AVAILABLE

The value which is used for address-bit if the device's package does not provide a matching address-pin (see 6.2.4)

See Also:

Constant Field Values

INITIALVALUE_LOADED_FROM_EEPROM

protected static final int INITIALVALUE_LOADED_FROM_EEPROM

The value which is used for devices capable of non-volatile wipers. For those devices the initial value is loaded from EEPROM.

See Also:

Constant Field Values

nonVolatileMode

protected MicrochipPotentiometerNonVolatileMode nonVolatileMode

Whether to use the volatile or the non-volatile wiper

Constructor Detail

MicrochipPotentiometerBase

protected MicrochipPotentiometerBase(I2CBus i2cBus,
                                     boolean pinA0,
                                     boolean pinA1,
                                     boolean pinA2,
                                     MicrochipPotentiometerChannel channel,
                                     MicrochipPotentiometerNonVolatileMode nonVolatileMode,
                                     int initialValueForVolatileWipers)
                              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)

pinA2 - Whether the device's address pin A2 (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

initialValueForVolatileWipers - The value for devices which are not capable of non-volatile wipers

Throws:

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

MicrochipPotentiometerBase

protected MicrochipPotentiometerBase(I2CBus i2cBus,
                                     boolean pinA0,
                                     boolean pinA1,
                                     boolean pinA2,
                                     MicrochipPotentiometerChannel channel,
                                     MicrochipPotentiometerNonVolatileMode nonVolatileMode,
                                     int initialValueForVolatileWipers,
                                     MicrochipPotentiometerDeviceControllerFactory controllerFactory)
                              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)

pinA2 - Whether the device's address pin A2 (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

initialValueForVolatileWipers - The value for devices which are not capable of non-volatile wipers

controllerFactory - builds new controllers

Throws:

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

See Also:

MicrochipPotentiometerDefaultDeviceControllerFactory

Method Detail

initialize

protected void initialize(int initialValueForVolatileWipers)
                   throws IOException

Initializes the wiper to a defined status. For devices capable of non-volatile-wipers the non-volatile-value is loaded. For devices not capable the given value is set in the device.

Parameters:

initialValueForVolatileWipers - The initial value for devices not capable

Throws:

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

getChannel

public MicrochipPotentiometerChannel getChannel()

Specified by:

getChannel in interface MicrochipPotentiometer

Returns:

The channel this potentiometer is configured for

isCapableOfNonVolatileWiper

public abstract boolean isCapableOfNonVolatileWiper()

Specified by:

isCapableOfNonVolatileWiper in interface MicrochipPotentiometer

Returns:

Whether device is capable of non volatile wipers

getSupportedChannelsByDevice

public abstract MicrochipPotentiometerChannel[] getSupportedChannelsByDevice()

Specified by:

getSupportedChannelsByDevice in interface MicrochipPotentiometer

Returns:

All channels supported by the underlying device

buildI2CAddress

protected static int buildI2CAddress(boolean pinA0,
                                     boolean pinA1,
                                     boolean pinA2)

Parameters:

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)

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

Returns:

The I2C-address based on the address-pins given

getNonVolatileMode

public MicrochipPotentiometerNonVolatileMode getNonVolatileMode()

Specified by:

getNonVolatileMode in interface MicrochipPotentiometer

Returns:

The way non-volatile reads or writes are done

setNonVolatileMode

protected void setNonVolatileMode(MicrochipPotentiometerNonVolatileMode nonVolatileMode)

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

Parameters:

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

updateCacheFromDevice

public int updateCacheFromDevice()
                          throws IOException

Updates the cache to the wiper's value.

Specified by:

updateCacheFromDevice in interface MicrochipPotentiometer

Returns:

The wiper's current value

Throws:

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

getNonVolatileValue

protected int getNonVolatileValue()
                           throws IOException

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

Returns:

The non-volatile-wiper's value.

Throws:

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

getCurrentValue

public int getCurrentValue()
                    throws IOException

The wiper's value read from cache. The cache is updated on any modifying action or the method 'updateCacheFromDevice'.

Specified by:

getCurrentValue in interface Potentiometer

Returns:

The wipers current value

Throws:

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

See Also:

updateCacheFromDevice()

setCurrentValue

public void setCurrentValue(int value)
                     throws IOException

Description copied from interface: Potentiometer

Set wiper's value. Values from 0 to 'maxValue' are valid. Values above or below this boundaries are corrected quietly.

Specified by:

setCurrentValue in interface Potentiometer

Parameters:

value - The wiper's value to be set

Throws:

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

See Also:

Potentiometer.getMaxValue()

decrease

public void decrease()
              throws IOException

Decreases the wiper's value for one step.

Specified by:

decrease in interface Potentiometer

Throws:

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

decrease

public void decrease(int steps)
              throws IOException

Decreases the wiper's value for n steps.

Specified by:

decrease in interface Potentiometer

Parameters:

steps - The number of steps to decrease

Throws:

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

increase

public void increase()
              throws IOException

Increases the wiper's value for one step.

Specified by:

increase in interface Potentiometer

Throws:

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

See Also:

Potentiometer.getMaxValue()

increase

public void increase(int steps)
              throws IOException

Increases the wiper's value for n steps.

Specified by:

increase in interface Potentiometer

Parameters:

steps - The number of steps to increase

Throws:

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

getDeviceStatus

public MicrochipPotentiometerDeviceStatus getDeviceStatus()
                                                   throws IOException

Specified by:

getDeviceStatus in interface MicrochipPotentiometer

Returns:

The device- and wiper-status

Throws:

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

getTerminalConfiguration

public MicrochipPotentiometerTerminalConfiguration getTerminalConfiguration()
                                                                     throws IOException

Specified by:

getTerminalConfiguration in interface MicrochipPotentiometer

Returns:

The current terminal-configuration

Throws:

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

setTerminalConfiguration

public void setTerminalConfiguration(MicrochipPotentiometerTerminalConfiguration terminalConfiguration)
                              throws IOException

Specified by:

setTerminalConfiguration in interface MicrochipPotentiometer

Parameters:

terminalConfiguration - The new terminal-configuration

Throws:

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

setWiperLock

public void setWiperLock(boolean enabled)
                  throws IOException

Enables or disables wiper-lock. See chapter 5.3.

Specified by:

setWiperLock in interface MicrochipPotentiometer

Parameters:

enabled - wiper-lock for the poti's channel has to be enabled

Throws:

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

setWriteProtection

public void setWriteProtection(boolean enabled)
                        throws IOException

Enables or disables write-protection for devices capable of non-volatile memory. Enabling write-protection does not only protect non-volatile wipers it also protects any other non-volatile information stored (f.e. wiper-locks).

Specified by:

setWriteProtection in interface MicrochipPotentiometer

Parameters:

enabled - write-protection has to be enabled

Throws:

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

equals

public boolean equals(Object obj)

Tests whether a given object equals to this object.

Especially to any class deriving PotentiometerImpl this test does not take properties into account which do not point to a specific device/channel.

Overrides:

equals in class Object

Parameters:

obj - The other object

Returns:

Whether the other object equals to this object.

toString

public String toString()

Overrides:

toString in class Object

isChannelSupportedByDevice

public boolean isChannelSupportedByDevice(MicrochipPotentiometerChannel channel)

Specified by:

isChannelSupportedByDevice in interface MicrochipPotentiometer

Parameters:

channel - A certain channel

Returns:

Whether the given channel is supported by the underlying device