Device.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.digitalstrom.internal.client.entity;

import java.util.List;

import org.openhab.binding.digitalstrom.internal.client.constants.OutputModeEnum;
import org.openhab.binding.digitalstrom.internal.client.events.DeviceListener;

/**
 * @author Alexander Betker
 * @since 1.3.0
 */
public interface Device {

    public DSID getDSID();

    public String getName();

    public void setName(String name);

    public int getZoneId();

    /**
     * This device is available in his zone or not.
     * Every 24h the dSM (meter) checks, if the devices are
     * plugged in
     * 
     * @return true, if device is plugged into the wall
     */
    public boolean isPresent();

    public boolean isOn();

    public void setIsOn(boolean flag);

    public boolean isDimmable();

    public boolean isRollershutter();

    /**
     * There are different modes for devices (for example:
     * a device can be in dim mode or not). Please have
     * a look at the name of this enum (a little bit self-explaining)
     * 
     * @return the current mode of this device
     */
    public OutputModeEnum getOutputMode();

    public void increase();

    public void decrease();

    public int getSlatPosition();

    public void setSlatPosition(int position);

    public int getMaxSlatPosition();

    public int getMinSlatPosition();

    public int getOutputValue();

    public void setOutputValue(int value);

    public int getMaxOutPutValue();

    /**
     * current Temperature sensor value
     * 
     * @param sensorValue
     */
    public void setTemperatureSensorValue(int sensorValue);

    public int getTemperatureSensorValue();

    /**
     * current Humidity sensor value
     * 
     * @param sensorValue
     */
    public void setHumiditySensorValue(int sensorValue);

    public int getHumiditySensorValue();

    public int getPowerConsumption();

    /**
     * current power consumption in watt
     * 
     * @param powerConsumption in w
     */
    public void setPowerConsumption(int powerConsumption);

    /**
     * to get the energy meter value of this device
     * 
     * @return energy meter value in wh
     */
    public int getEnergyMeterValue();

    public void setEnergyMeterValue(int value);

    /**
     * amperage of this device
     * 
     * @return electric meter value in mA
     */
    public int getElectricMeterValue();

    public void setElectricMeterValue(int electricMeterValue);

    public List<Short> getGroups();

    public short getSceneOutputValue(short sceneId);

    public void setSceneOutputValue(short sceneId, short value);

    /**
     * This configuration is very important. The devices can
     * be configured to not react to some commands (scene calls).
     * So you can't imply that a device automatically turns on (by default yes,
     * but if someone configured his own scenes, then maybe not) after a
     * scene call. This method returns true or false, if the configuration
     * for this sceneID already has been read
     * 
     * @param sceneId the sceneID
     * @return true if this device has the config for this specific scene
     */
    public boolean containsSceneConfig(short sceneId);

    /**
     * Add the config for this scene. The config has the configuration
     * for the specific sceneID.
     * 
     * @param sceneId scene call id
     * @param sceneSpec config for this sceneID
     */
    public void addSceneConfig(short sceneId, DeviceSceneSpec sceneSpec);

    /**
     * Should the device react on this scene call or not
     * 
     * @param sceneId scene call id
     * @return true, if this device should react on this sceneID
     */
    public boolean doIgnoreScene(short sceneId);

    /**
     * To get notifications if something happens
     * (for example a new metering value)
     * 
     * @param listener
     */
    public void addDeviceListener(DeviceListener listener);

    /**
     * Don't get notifications anymore
     * 
     * @param listener
     */
    public void removeDeviceListener(DeviceListener listener);

    /**
     * To send notifications
     * 
     * @param dsid the device unique id
     * @param event what happend
     */
    public void notifyDeviceListener(String dsid);

}