com.pi4j.component.potentiometer.microchip.MicrochipPotentiometer Maven / Gradle / Ivy

Go to download
package com.pi4j.component.potentiometer.microchip;

import com.pi4j.component.potentiometer.Potentiometer;

import java.io.IOException;

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: Device Abstractions
 * FILENAME      :  MicrochipPotentiometer.java  
 * 
 * This file is part of the Pi4J project. More information about 
 * this project can be found here:  http://www.pi4j.com/
 * **********************************************************************
 * %%
 * Copyright (C) 2012 - 2015 Pi4J
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

/**
 * Abstract Pi4J-device for MCP45XX and MCP46XX ICs.
 * 
 * @see com.pi4j.component.potentiometer.microchip.MCP4561
 * @see com.pi4j.component.potentiometer.microchip.MCP4651
 * @author Raspelikan
 */
public interface MicrochipPotentiometer extends Potentiometer {

	/**
	 * @return The channel this potentiometer is configured for
	 */
	public MicrochipPotentiometerChannel getChannel();

	/**
	 * @return Whether device is capable of non volatile wipers
	 */
	public boolean isCapableOfNonVolatileWiper();


    /**
     * @return The way non-volatile reads or writes are done
     */
    public MicrochipPotentiometerNonVolatileMode getNonVolatileMode();

	/**
	 * @return All channels supported by the underlying device
	 */
	public MicrochipPotentiometerChannel[] getSupportedChannelsByDevice();

	/**
	 * Updates the cache to the wiper's value.
	 *
	 * @return The wiper's current value
	 * @throws java.io.IOException Thrown if communication fails or device returned a malformed result
	 */
	public int updateCacheFromDevice() throws IOException;

	/**
	 * @return The device- and wiper-status
	 * @throws java.io.IOException Thrown if communication fails or device returned a malformed result
	 */
	public MicrochipPotentiometerDeviceStatus getDeviceStatus() throws IOException;

	/**
	 * @return The current terminal-configuration
	 * @throws java.io.IOException Thrown if communication fails or device returned a malformed result
	 */
	public MicrochipPotentiometerTerminalConfiguration getTerminalConfiguration() throws IOException;

	/**
	 * @param terminalConfiguration The new terminal-configuration
	 * @throws java.io.IOException Thrown if communication fails or device returned a malformed result
	 */
	public void setTerminalConfiguration(
			final MicrochipPotentiometerTerminalConfiguration terminalConfiguration) throws IOException;

	/**
	 * Enables or disables wiper-lock. See chapter 5.3.
	 *
	 * @param enabled wiper-lock for the poti's channel has to be enabled
	 * @throws java.io.IOException Thrown if communication fails or device returned a malformed result
	 */
	public void setWiperLock(final 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).
	 *
	 * @param enabled write-protection has to be enabled
	 * @throws java.io.IOException Thrown if communication fails or device returned a malformed result
	 */
	public void setWriteProtection(final boolean enabled) throws IOException;


	/**
	 * @param channel A certain channel
	 * @return Whether the given channel is supported by the underlying device
	 */
	public boolean isChannelSupportedByDevice(final MicrochipPotentiometerChannel channel);
}