Light.java

/**
 *
 * Copyright (c) 2009-2016 Freedomotic team http://freedomotic.com
 *
 * This file is part of Freedomotic
 *
 * This Program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2, 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 Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * Freedomotic; see the file COPYING. If not, see
 * <http://www.gnu.org/licenses/>.
 */
package com.freedomotic.things.impl;

import com.freedomotic.model.ds.Config;
import com.freedomotic.model.object.Behavior;
import com.freedomotic.model.object.RangedIntBehavior;
import com.freedomotic.behaviors.RangedIntBehaviorLogic;
import com.freedomotic.reactions.Command;

/**
 *
 * @author Enrico Nicoletti
 */
public class Light extends ElectricDevice {
    
    private RangedIntBehaviorLogic brightness;
    private int brightnessStoredValue = 0;
    protected final static String BEHAVIOR_BRIGHTNESS = "brightness";
    
    @Override
    public void init() {
        //linking this property with the behavior defined in the XML
        brightness = new RangedIntBehaviorLogic((RangedIntBehavior) getPojo().getBehavior(BEHAVIOR_BRIGHTNESS));
        brightness.setValue(brightnessStoredValue);
        brightness.addListener(new RangedIntBehaviorLogic.Listener() {
            
            @Override
            public void onLowerBoundValue(Config params, boolean fireCommand) {
                brightnessStoredValue = brightness.getMin();
                executePowerOff(params);
            }
            
            @Override
            public void onUpperBoundValue(Config params, boolean fireCommand) {
                brightnessStoredValue = brightness.getMax();
                executePowerOn(params);
            }
            
            @Override
            public void onRangeValue(int rangeValue, Config params, boolean fireCommand) {
                executeBrightness(rangeValue, params);
            }
        });
        //register this behavior to the superclass to make it visible to it
        registerBehavior(brightness);
        super.init();
    }
    
    @Override
    public void executePowerOff(Config params) {
        // when a light is "powered off" its brightness is set to the minValue but the current value is stored
        brightness.setValue(brightness.getMin());
        // executeCommand the body of the super implementation. The super call
        // must be the last call as it executes setChanged(true)
        super.executePowerOff(params);
    }
    
    @Override
    public void executePowerOn(Config params) {
        // when a light is "powered on" its brightness is set to the stored value if this is greater than the minValue
        if (brightnessStoredValue > brightness.getMin()) {
            brightness.setValue(brightnessStoredValue);
        } else {
            brightness.setValue(brightness.getMax());
        }
        // executeCommand the body of the super implementation. The super call
        // must be the last call as it executes setChanged(true)
        super.executePowerOn(params);
    }
    
    public void executeBrightness(int rangeValue, Config params) {
        boolean executed = executeCommand("set brightness", params); //executes the developer level command associated with 'set brightness' action

        if (executed) {
            powered.setValue(true);
            brightness.setValue(rangeValue);
            brightnessStoredValue = brightness.getValue();
            //set the light graphical representation
            getPojo().setCurrentRepresentation(1); //points to the second element in the XML views array (light on image)
            setChanged(true);
        }
    }
    
    @Override
    protected void createCommands() {
        super.createCommands();
        
        Command a = new Command();
        // a.setName(I18n.msg("set_X_brightness_to_50", new Object[]{this.getPojo().getName()}));
        a.setName("Set " + getPojo().getName() + " brightness to 50%");
        a.setDescription("the light " + getPojo().getName() + " changes its brightness");
        a.setReceiver("app.events.sensors.behavior.request.objects");
        a.setProperty("object",
                getPojo().getName());
        a.setProperty("behavior", BEHAVIOR_BRIGHTNESS);
        a.setProperty("value", "50");
        
        Command b = new Command();
        // b.setName(I18n.msg("increase_X_brightness", new Object[]{this.getPojo().getName()}));
        b.setName("Increase " + getPojo().getName() + " brightness");
        b.setDescription("increases " + getPojo().getName() + " brightness of one step");
        b.setReceiver("app.events.sensors.behavior.request.objects");
        b.setProperty("object",
                getPojo().getName());
        b.setProperty("behavior", BEHAVIOR_BRIGHTNESS);
        b.setProperty("value", Behavior.VALUE_NEXT);
        
        Command c = new Command();
        // c.setName(I18n.msg("decrease_X_brightness", new Object[]{this.getPojo().getName()}));
        c.setName("Decrease " + getPojo().getName() + " brightness");
        c.setDescription("decreases " + getPojo().getName() + " brightness of one step");
        c.setReceiver("app.events.sensors.behavior.request.objects");
        c.setProperty("object",
                getPojo().getName());
        c.setProperty("behavior", BEHAVIOR_BRIGHTNESS);
        c.setProperty("value", Behavior.VALUE_PREVIOUS);
        
        Command d = new Command();
        // d.setName(I18n.msg("set_its_brightness_to_50"));
        d.setName("Set its brightness to 50%");
        // d.setDescription(I18n.msg("set_its_brightness_to_50"));
        d.setDescription("Set its brightness to 50%");
        d.setReceiver("app.events.sensors.behavior.request.objects");
        d.setProperty("object", "@event.object.name");
        d.setProperty("behavior", BEHAVIOR_BRIGHTNESS);
        d.setProperty("value", "50");
        
        Command e = new Command();
        // e.setName(I18n.msg("increase_its_brightness"));
        e.setName("Increase its brightness");
        e.setDescription("increases its brightness of one step");
        e.setReceiver("app.events.sensors.behavior.request.objects");
        e.setProperty("object", "@event.object.name");
        e.setProperty("behavior", BEHAVIOR_BRIGHTNESS);
        e.setProperty("value", Behavior.VALUE_NEXT);
        
        Command f = new Command();
        // f.setName(I18n.msg("decrease_its_brightness"));
        f.setName("Decrease its brightness");
        f.setDescription("decreases its brightness of one step");
        f.setReceiver("app.events.sensors.behavior.request.objects");
        f.setProperty("object", "@event.object.name");
        f.setProperty("behavior", BEHAVIOR_BRIGHTNESS);
        f.setProperty("value", Behavior.VALUE_PREVIOUS);
        
        Command g = new Command();
        // g.setName(I18n.msg("set_brightness_from_event_value"));
        g.setName("Set its brightness to the value in the event");
        g.setDescription("set its brightness to the value in the event");
        g.setReceiver("app.events.sensors.behavior.request.objects");
        g.setProperty("object", "@event.object.name");
        g.setProperty("behavior", BEHAVIOR_BRIGHTNESS);
        g.setProperty("value", "@event.value");
        
        commandRepository.create(a);
        commandRepository.create(b);
        commandRepository.create(c);
        commandRepository.create(d);
        commandRepository.create(e);
        commandRepository.create(f);
        commandRepository.create(g);
    }
    
    @Override
    protected void createTriggers() {
        super.createTriggers();
    }
}