com.pi4j.component.sensor.DistanceSensor Maven / Gradle / Ivy

Go to download
package com.pi4j.component.sensor;

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: Device Abstractions
 * FILENAME      :  DistanceSensor.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%
 */


import java.util.Date;

import com.pi4j.component.ObserveableComponent;

public interface DistanceSensor extends ObserveableComponent {
    
    Date getLastDistanceTimestamp();
    
    double getDistance();
    double getDistance(double value);
    boolean isDistance(double distance);
    boolean isDistanceInRange(double min, double max);
    void addCalibrationCoordinate(double value, double distance);
    
    double getValue();
    boolean isValue(double value);
    boolean isValueInRange(double min, double max);
    
    void addListener(DistanceSensorListener... listener);
    void removeListener(DistanceSensorListener... listener);
}