DeviceStateUpdate.java

/**
 * Copyright (c) 2014-2017 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.eclipse.smarthome.binding.digitalstrom.internal.lib.structure.devices.deviceParameters;

import org.eclipse.smarthome.binding.digitalstrom.internal.lib.sensorJobExecutor.SensorJobExecutor;
import org.eclipse.smarthome.binding.digitalstrom.internal.lib.sensorJobExecutor.sensorJob.SensorJob;

/**
 * Represents a device state update for lights, joker, shades and sensor data.
 *
 * @author Michael Ochel - Initial contribution
 * @author Matthias Siegele - Initial contribution
 */
public interface DeviceStateUpdate {

    // Update types

    // light
    public final static String UPDATE_BRIGHTNESS = "brightness";
    public final static String UPDATE_ON_OFF = "OnOff";
    public final static String UPDATE_BRIGHTNESS_INCREASE = "brightnessIncrese";
    public final static String UPDATE_BRIGHTNESS_DECREASE = "brightnessDecrese";
    public final static String UPDATE_BRIGHTNESS_STOP = "brightnessStop";
    public final static String UPDATE_BRIGHTNESS_MOVE = "brightnessMove";

    // shades
    public final static String UPDATE_SLATPOSITION = "slatposition";
    public static final String UPDATE_SLAT_ANGLE = "slatAngle";
    public final static String UPDATE_SLAT_INCREASE = "slatIncrese";
    public final static String UPDATE_SLAT_DECREASE = "slatDecrese";
    public static final String UPDATE_SLAT_ANGLE_INCREASE = "slatAngleIncrese";
    public static final String UPDATE_SLAT_ANGLE_DECREASE = "slatAngleDecrese";
    public final static String UPDATE_OPEN_CLOSE = "openClose";
    public static final String UPDATE_OPEN_CLOSE_ANGLE = "openCloseAngle";
    public final static String UPDATE_SLAT_MOVE = "slatMove";
    public final static String UPDATE_SLAT_STOP = "slatStop";

    // sensor data
    public final static String UPDATE_ACTIVE_POWER = "activePower";
    public final static String UPDATE_OUTPUT_CURRENT = "outputCurrent";
    public final static String UPDATE_ELECTRIC_METER = "electricMeter";
    public final static String UPDATE_OUTPUT_VALUE = "outputValue";

    // scene
    /** A scene call can have the value between 0 and 127. */
    public final static String UPDATE_CALL_SCENE = "callScene";
    public final static String UPDATE_UNDO_SCENE = "undoScene";
    public final static String UPDATE_SCENE_OUTPUT = "sceneOutput";
    public final static String UPDATE_SCENE_CONFIG = "sceneConfig";

    // general
    /** command to refresh the output value of an device. */
    public static final String REFRESH_OUTPUT = "refreshOutput";

    /**
     * Returns the state update value.
     * <p>
     * <b>NOTE:</b>
     * <ul>
     * <li>For all OnOff-types the value for off is < 0 and for on > 0.</li>
     * <li>For all Increase- and Decrease-types the value is the new output value.</li>
     * <li>For SceneCall-type the value is between 0 and 127.</li>
     * <li>For all SceneUndo-types the value is the new output value.</li>
     * <li>For all SensorUpdate-types will read the sensor data directly, if the value is 0, otherwise a
     * {@link SensorJob} will be added to the {@link SensorJobExecutor}.</li>
     * </ul>
     * </p>
     *
     * @return new state value
     */
    public int getValue();

    /**
     * Returns the state update type.
     *
     * @return state update type
     */
    public String getType();
}