/*
 * Copyright (c) 2006, Swedish Institute of Computer Science.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the Institute nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $Id: ContikiLED.java,v 1.3 2007/01/29 14:29:39 fros4943 Exp $
 */

package se.sics.cooja.contikimote.interfaces;

import java.awt.*;
import java.util.*;
import javax.swing.JPanel;
import org.apache.log4j.Logger;
import org.jdom.Element;

import se.sics.cooja.*;
import se.sics.cooja.contikimote.ContikiMoteInterface;
import se.sics.cooja.interfaces.LED;

/**
 * This class represents three mote LEDs.
 * 
 * It needs read access to the following core variables:
 * <ul>
 * <li>char simLedsValue
 * </ul>
 * <p>
 * Dependency core interfaces are:
 * <ul>
 * <li>leds_interface
 * </ul>
 * <p>
 * This observable is changed and notifies observers whenever any led has
 * changed.
 * 
 * @author Fredrik Osterlind
 */
public class ContikiLED extends LED implements ContikiMoteInterface {
  private static Logger logger = Logger.getLogger(ContikiLED.class);
  private Mote mote = null;
  private SectionMoteMemory moteMem = null;
  private byte oldLedValue = 0;

  private static final byte LEDS_GREEN = 1;
  private static final byte LEDS_YELLOW = 2;
  private static final byte LEDS_RED = 4;

  private static final Color DARK_GREEN = new Color(0, 50, 0);
  private static final Color DARK_YELLOW = new Color(50, 50, 0);
  private static final Color DARK_RED = new Color(50, 0, 0);
  private static final Color GREEN = new Color(0, 255, 0);
  private static final Color YELLOW = new Color(255, 255, 0);
  private static final Color RED = new Color(255, 0, 0);

  private double myEnergyConsumption = 0.0;

  /**
   * Approximate energy consumption of a green led (mA). ESB measured value:
   * 5.69 mA. TODO Measure energy consumption
   */
  public final double ENERGY_CONSUMPTION_GREEN_LED;

  /**
   * Approximate energy consumption of a yellow led (mA). ESB measured value:
   * 5.69 mA. TODO Measure energy consumption
   */
  public final double ENERGY_CONSUMPTION_YELLOW_LED;

  /**
   * Approximate energy consumption of a red led (mA). ESB measured value: 5.69
   * mA.
   */
  public final double ENERGY_CONSUMPTION_RED_LED;

  private double energyOfGreenLedPerTick = -1;
  private double energyOfYellowLedPerTick = -1;
  private double energyOfRedLedPerTick = -1;

  public ContikiLED() {
    ENERGY_CONSUMPTION_GREEN_LED = 0;
    ENERGY_CONSUMPTION_YELLOW_LED = 0;
    ENERGY_CONSUMPTION_RED_LED = 0;
  }

  /**
   * Creates an interface to the led at mote.
   * 
   * @param mote
   *          Led's mote.
   * @see Mote
   * @see se.sics.cooja.MoteInterfaceHandler
   */
  public ContikiLED(Mote mote) {
    // Read class configurations of this mote type
    ENERGY_CONSUMPTION_GREEN_LED = mote.getType().getConfig()
        .getDoubleValue(ContikiLED.class, "GREEN_LED_CONSUMPTION_mA");
    ENERGY_CONSUMPTION_YELLOW_LED = mote.getType().getConfig()
        .getDoubleValue(ContikiLED.class, "YELLOW_LED_CONSUMPTION_mA");
    ENERGY_CONSUMPTION_RED_LED = mote.getType().getConfig()
        .getDoubleValue(ContikiLED.class, "RED_LED_CONSUMPTION_mA");

    this.mote = mote;
    this.moteMem = (SectionMoteMemory) mote.getMemory();

    if (energyOfGreenLedPerTick < 0) {
      energyOfGreenLedPerTick = ENERGY_CONSUMPTION_GREEN_LED
          * mote.getSimulation().getTickTimeInSeconds();
      energyOfYellowLedPerTick = ENERGY_CONSUMPTION_YELLOW_LED
          * mote.getSimulation().getTickTimeInSeconds();
      energyOfRedLedPerTick = ENERGY_CONSUMPTION_RED_LED
          * mote.getSimulation().getTickTimeInSeconds();
    }
  }

  public static String[] getCoreInterfaceDependencies() {
    return new String[]{"leds_interface"};
  }

  public boolean isAnyOn() {
    return oldLedValue > 0;
  }

  public boolean isGreenOn() {
    return (oldLedValue & LEDS_GREEN) > 0;
  }

  public boolean isYellowOn() {
    return (oldLedValue & LEDS_YELLOW) > 0;
  }

  public boolean isRedOn() {
    return (oldLedValue & LEDS_RED) > 0;
  }

  public void doActionsBeforeTick() {
    // Nothing to do
  }

  public void doActionsAfterTick() {
    if (checkLedStatus()) {
      this.setChanged();
      this.notifyObservers(mote);
    }
  }

  private boolean checkLedStatus() {
    boolean ledChanged;

    byte newLedsValue = moteMem.getByteValueOf("simLedsValue");
    if (newLedsValue != oldLedValue) {
      ledChanged = true;
    } else {
      ledChanged = false;
    }

    myEnergyConsumption = 0.0;
    if ((newLedsValue & LEDS_GREEN) > 0)
      myEnergyConsumption += energyOfGreenLedPerTick;
    if ((newLedsValue & LEDS_YELLOW) > 0)
      myEnergyConsumption += energyOfYellowLedPerTick;
    if ((newLedsValue & LEDS_RED) > 0)
      myEnergyConsumption += energyOfRedLedPerTick;

    oldLedValue = newLedsValue;
    return ledChanged;
  }

  public JPanel getInterfaceVisualizer() {
    final JPanel panel = new JPanel() {
      public void paintComponent(Graphics g) {
        super.paintComponent(g);

        if (isGreenOn()) {
          g.setColor(GREEN);
          g.fillOval(20, 20, 20, 20);
        } else {
          g.setColor(DARK_GREEN);
          g.fillOval(20, 20, 20, 20);
        }

        if (isYellowOn()) {
          g.setColor(YELLOW);
          g.fillOval(60, 20, 20, 20);
        } else {
          g.setColor(DARK_YELLOW);
          g.fillOval(60, 20, 20, 20);
        }

        if (isRedOn()) {
          g.setColor(RED);
          g.fillOval(100, 20, 20, 20);
        } else {
          g.setColor(DARK_RED);
          g.fillOval(100, 20, 20, 20);
        }
      }
    };

    Observer observer;
    this.addObserver(observer = new Observer() {
      public void update(Observable obs, Object obj) {
        panel.repaint();
      }
    });

    // Saving observer reference for releaseInterfaceVisualizer
    panel.putClientProperty("intf_obs", observer);

    panel.setMinimumSize(new Dimension(140, 60));
    panel.setPreferredSize(new Dimension(140, 60));

    return panel;
  }

  public void releaseInterfaceVisualizer(JPanel panel) {
    Observer observer = (Observer) panel.getClientProperty("intf_obs");
    if (observer == null) {
      logger.fatal("Error when releasing panel, observer is null");
      return;
    }

    this.deleteObserver(observer);
  }

  public double energyConsumptionPerTick() {
    return myEnergyConsumption;
  }

  public Collection<Element> getConfigXML() {
    return null;
  }

  public void setConfigXML(Collection<Element> configXML, boolean visAvailable) {
  }

}