com.pi4j.component.potentiometer

Interface Potentiometer

All Superinterfaces:

Component

All Known Subinterfaces:

MicrochipPotentiometer

All Known Implementing Classes:

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

public interface Potentiometer
extends Component

A digital potentiometer component

Method Summary

Modifier and Type	Method and Description
void	decrease() Decrease the wiper's value by one step.
void	decrease(int steps) Decrease the wiper's value by n steps.
int	getCurrentValue() The implementation should cache to wiper's value and therefore should avoid accessing the device to often.
int	getMaxValue()
void	increase() Increase the wiper's value by one step.
void	increase(int steps) Increase the wiper's value by n steps.
boolean	isRheostat()
void	setCurrentValue(int value) Set wiper's value.

Methods inherited from interface com.pi4j.component.Component

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

Method Detail

getMaxValue

int getMaxValue()

Returns:

The maximum wiper-value supported by the device

isRheostat

boolean isRheostat()

Returns:

Whether the device is a potentiometer or a rheostat

setCurrentValue

void setCurrentValue(int value)
              throws IOException

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

Parameters:

value - The wiper's value.

Throws:

IOException - If communication with the device fails

See Also:

getMaxValue()

getCurrentValue

int getCurrentValue()
             throws IOException

The implementation should cache to wiper's value and therefore should avoid accessing the device to often.

Returns:

The wiper's current value.

Throws:

IOException - If communication with the device fails

increase

void increase()
       throws IOException

Increase the wiper's value by one step. It is not an error if the wiper already hit the upper boundary. In this situation the wiper doesn't change.

Throws:

IOException - If communication with the device fails

See Also:

getMaxValue()

increase

void increase(int steps)
       throws IOException

Increase the wiper's value by n steps. It is not an error if the wiper hits or already hit the upper boundary. In such situations the wiper sticks to the upper boundary or doesn't change.

Parameters:

steps - How many steps to increase.

Throws:

IOException - If communication with the device fails

decrease

void decrease()
       throws IOException

Decrease the wiper's value by one step. It is not an error if the wiper already hit the lower boundary (0). In this situation the wiper doesn't change.

Throws:

IOException - If communication with the device fails

decrease

void decrease(int steps)
       throws IOException

Decrease the wiper's value by n steps. It is not an error if the wiper hits or already hit the lower boundary (0). In such situations the wiper sticks to the lower boundary or doesn't change.

Parameters:

steps - How many steps to decrease.

Throws:

IOException - If communication with the device fails