com.pi4j.component.potentiometer.microchip.impl

Class MicrochipPotentiometerDeviceController

java.lang.Object

com.pi4j.component.potentiometer.microchip.impl.MicrochipPotentiometerDeviceController

public class MicrochipPotentiometerDeviceController
extends Object

Ported from Stibro's code blog.

Author:

Raspelikan

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	NONVOLATILE_WIPER
static boolean	VOLATILE_WIPER

Constructor Summary

Constructors

Constructor and Description
MicrochipPotentiometerDeviceController(I2CDevice i2cDevice) Builds an instance which is ready to use.

Method Summary

Modifier and Type	Method and Description
void	decrease(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel, int steps) Decrements the volatile wiper for the given number steps.
boolean	equals(Object obj)
com.pi4j.component.potentiometer.microchip.impl.DeviceControllerDeviceStatus	getDeviceStatus() Returns the status of the device according EEPROM and WiperLocks.
com.pi4j.component.potentiometer.microchip.impl.DeviceControllerTerminalConfiguration	getTerminalConfiguration(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel) Fetches the terminal-configuration from the device for a certain channel.
int	getValue(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel, boolean nonVolatile) Receives the current wiper's value from the device.
void	increase(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel, int steps) Increments the volatile wiper for the given number steps.
void	setTerminalConfiguration(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerTerminalConfiguration config) Sets the given terminal-configuration to the device.
void	setValue(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel, int value, boolean nonVolatile) Sets the wiper's value in the device.
void	setWiperLock(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel, boolean locked) Enables or disables a wiper's lock.
void	setWriteProtection(boolean enabled) Enables or disables the device's write-protection.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VOLATILE_WIPER

public static final boolean VOLATILE_WIPER

See Also:

Constant Field Values

NONVOLATILE_WIPER

public static final boolean NONVOLATILE_WIPER

See Also:

Constant Field Values

Constructor Detail

MicrochipPotentiometerDeviceController

public MicrochipPotentiometerDeviceController(I2CDevice i2cDevice)
                                       throws IOException

Builds an instance which is ready to use.

Parameters:

i2cDevice - The Pi4J-I2CDevice to which the instance is connected to

Throws:

IOException - throw

Method Detail

getDeviceStatus

public com.pi4j.component.potentiometer.microchip.impl.DeviceControllerDeviceStatus getDeviceStatus()
                                                                                             throws IOException

Returns the status of the device according EEPROM and WiperLocks.

Returns:

The device's status

Throws:

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

increase

public void increase(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel,
                     int steps)
              throws IOException

Increments the volatile wiper for the given number steps.

Parameters:

channel - Which wiper

steps - The number of steps

Throws:

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

decrease

public void decrease(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel,
                     int steps)
              throws IOException

Decrements the volatile wiper for the given number steps.

Parameters:

channel - Which wiper

steps - The number of steps

Throws:

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

getValue

public int getValue(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel,
                    boolean nonVolatile)
             throws IOException

Receives the current wiper's value from the device.

Parameters:

channel - Which wiper

nonVolatile - volatile or non-volatile value

Returns:

The wiper's value

Throws:

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

setValue

public void setValue(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel,
                     int value,
                     boolean nonVolatile)
              throws IOException

Sets the wiper's value in the device.

Parameters:

channel - Which wiper

value - The wiper's value

nonVolatile - volatile or non-volatile value

Throws:

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

getTerminalConfiguration

public com.pi4j.component.potentiometer.microchip.impl.DeviceControllerTerminalConfiguration getTerminalConfiguration(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel)
                                                                                                               throws IOException

Fetches the terminal-configuration from the device for a certain channel.

Parameters:

channel - The channel

Returns:

The current terminal-configuration

Throws:

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

setTerminalConfiguration

public void setTerminalConfiguration(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerTerminalConfiguration config)
                              throws IOException

Sets the given terminal-configuration to the device.

Parameters:

config - A terminal-configuration for a certain channel.

Throws:

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

setWiperLock

public void setWiperLock(com.pi4j.component.potentiometer.microchip.impl.DeviceControllerChannel channel,
                         boolean locked)
                  throws IOException

Enables or disables a wiper's lock.

Hint: This will only work using the "High Volate Command" (see 3.1).

Parameters:

channel - Which wiper

locked - Whether to enable the wiper's lock

Throws:

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

setWriteProtection

public void setWriteProtection(boolean enabled)
                        throws IOException

Enables or disables the device's write-protection.

Hint: This will only work using the "High Volate Command" (see 3.1).

Parameters:

enabled - Whether to enable write-protection

Throws:

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

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object