/*
   Copyright (C) 2007 Dirk Huenniger
   
   This library 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 2.1 of the License, or (at your option) any later version.
   
   This library 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
  Lesser General Public License for more details.
  
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
   */
  
  package org.indi.examples;
  
  import java.io.IOException;
  
  import org.indi.clientmessages.GetProperties;
  import org.indi.objects.Blob;
  import org.indi.objects.BlobVector;
  import org.indi.objects.Number;
  import org.indi.objects.NumberVector;
  import org.indi.objects.Permission;
  import org.indi.objects.State;
  import org.indi.objects.Switch;
  import org.indi.objects.SwitchRule;
  import org.indi.objects.SwitchVector;
  import org.indi.reactor.TimerCallback;
  import org.indi.server.BasicDevice;
  import org.indi.server.IndiServer;
  
  /**
   * A simple CCD simulator. A .fits file is transferred after the given
   * exposuretime has been expired.
   * 
   * @author Dirk Hünniger
   * 
   */
  public class SimpleCCDSimulator extends BasicDevice implements TimerCallback {
      /**
       * the vector containing the switch to connect /disconnect the device
       */
      private final SwitchVector powerswitch;
      /**
       * the name of the powerswitch
       */
      private final String powervectorname = "CONNECTION";
      /**
       * the name of the only group contained in this device
       */
      private final String groupname = "Main Control";
      /**
       * the connectswitch used ti connect diconnect the device.
       */
      private Switch connectswitch = null;
      /**
       * the indivector hosting the temperature property
       */
      private NumberVector temperaturevector = null;
      /**
       * the temperature of the CCD
       */
      private Number temperature = null;
      /**
       * the number Vector hosting the exposuretime
       */
      private NumberVector exposuretimevector = null;
      /**
       * the exposuretime
       */
      private Number exposuretime = null;
      /**
       * the blobvector hosting the blob to carry the image
       */
      private BlobVector imagevector = null;
      /**
       * the time between onTimer callbacks in miliseconds
       */
      private final long timeout = 1000;
      /**
       * the Blob to carry the image to the client after the exposurtime has
       * expired
       */
      private Blob image = null;
      /**
       * the requested temperature of the ccd
       */
      private double targetTemperature = 0;
      /**
       * the name of this device
       */
      private final String name = "Simple CCD Simulator";
  
      /**
      * class constructor
      * 
      * @param server
      *                the indi server to host the device
      */
     public SimpleCCDSimulator(IndiServer server) {
 	super(server);
 	this.powerswitch = new SwitchVector(this.name, this.powervectorname,
 		"Connection", this.groupname, State.Idle, Permission.ReadWrite,
 		SwitchRule.OneOfMany, 0);
 	this.connectswitch = new Switch("CONNECT", "Connect", Switch.State.Off);
 	this.powerswitch.add(this.connectswitch);
 	this.powerswitch.add(new Switch("DISCONNECT", "Disconnect",
 		Switch.State.On));
 	this.exposuretimevector = new NumberVector(this.name,
 		"EXPOSE_DURATION", "Expose", this.groupname, State.Idle,
 		Permission.ReadWrite, 60);
 	this.exposuretime = new Number("EXPOSE_S", "Duration (s)", "%5.2f", 0.,
 		36000., .5, 1.);
 	this.exposuretimevector.add(this.exposuretime);
 	this.temperaturevector = new NumberVector(this.name, "CCD_TEMPERATURE",
 		"Temperature (C)", this.groupname, State.Idle,
 		Permission.ReadWrite, 60);
 	this.temperature = new Number("TEMPERATURE", "Temperature", "%+06.2f",
 		-30., 40., 1., 0.);
 	this.temperaturevector.add(this.temperature);
 	this.imagevector = new BlobVector(this.name, "Video", "Video",
 		this.groupname, State.Idle, Permission.ReadOnly, 0);
 	this.image = new Blob("CCD1", "Feed");
 	this.imagevector.add(this.image);
 	timer(this.timeout);
     }
 
     /**
      * Starts an indi server hosting a ccd simulator and a telescope (mount)
      * simulator
      * 
      * @param args
      *                Command line parameters (ignored)
      * @throws IOException
      */
     public static void main(String[] args) throws IOException {
 	IndiServer s = new IndiServer();
 	new SimpleCCDSimulator(s);
 	new SimpleTelescopeSimulator(s);
 	while (true) {
 	    s.reactor.handleEvents(10);
 	}
     }
 
     @Override
     public void onGetProperties(GetProperties o) {
 	def(this.powerswitch);
 	def(this.exposuretimevector);
 	def(this.temperaturevector);
 	def(this.imagevector);
     }
 
     @Override
     public void onNew(SwitchVector vector) {
 	if (!((this.powervectorname.equals(vector.getName())) && (this.name
 		.equals(vector.getDevice())))) {
 	    return;
 	}
 	this.powerswitch.update(vector);
 	switch (this.connectswitch.getState()) {
 	case On:
 	    this.powerswitch.setState(State.Ok);
 	    set(this.powerswitch,
 		    "Connection to Simple CCD Simulator is successful.");
 	    break;
 	case Off:
 	    this.powerswitch.setState(State.Idle);
 	    set(this.powerswitch, "Simple CCD Simulator has been disconneced.");
 	    break;
 	}
     }
 
     @Override
     public void onNew(NumberVector vector) {
 	if (!(this.name.equals(this.name))) {
 	    return;
 	}
 	if (vector.getName().equals(this.exposuretimevector.getName())) {
 	    if (this.connectswitch.getState() == Switch.State.Off) {
 		this.exposuretimevector.setState(State.Idle);
 		msg("CCD Simulator is offline");
 		set(this.exposuretimevector);
 	    } else {
 		this.exposuretimevector.setState(State.Busy);
 		this.exposuretimevector.update(vector);
 	    }
 	}
 	if (vector.getName().equals(this.temperaturevector.getName())) {
 	    if (this.connectswitch.getState() == Switch.State.Off) {
 		this.temperaturevector.setState(State.Idle);
 		msg("CCD Simulator is offline");
 	    } else {
 		for (Number n : vector.getChlidren()) {
 		    if (n.getName().equals(this.temperature.getName())) {
 			this.targetTemperature = n.getDouble();
 		    }
 		}
 		if (this.targetTemperature == this.temperature.getDouble()) {
 		    this.temperaturevector.setState(State.Ok);
 		} else {
 		    this.temperaturevector.setState(State.Busy);
 		    msg("Setting CCD temperature to "
 			    + String.valueOf(this.targetTemperature));
 		}
 		set(this.temperaturevector);
 	    }
 	}
     }
 
     @Override
     public void onTimer() {
 	switch (this.exposuretimevector.getState()) {
 	case Busy:
 	    this.exposuretime.subtractDouble(1.0);
 	    if (this.exposuretime.getDouble() <= 0) {
 		/* Let's set the state of OK and report that to the client */
 		this.exposuretimevector.setState(State.Ok);
 		/* Upload a sample FITS file */
 		this.image.setValue(Thread.currentThread()
 			.getContextClassLoader().getResourceAsStream(
 				"org/indi/examples/Test.fits"), "fits");
 		set(this.imagevector);
 	    }
 	    set(this.exposuretimevector);
 	    break;
 	}
 	switch (this.temperaturevector.getState()) {
 	case Busy:
 	    if (this.temperature.getDouble() < this.targetTemperature - 1.0) {
 		this.temperature.addDouble(1.0);
 		set(this.temperaturevector);
 	    } else if (this.temperature.getDouble() > this.targetTemperature + 1.0) {
 		this.temperature.subtractDouble(1.0);
 		set(this.temperaturevector);
 	    } else {
 		this.temperaturevector.setState(State.Ok);
 		this.temperature.setDouble(this.targetTemperature);
 		set(this.temperaturevector, "Target Temperature reached");
 	    }
 	    break;
 	}
 	timer(this.timeout);
     }
 }