tuwien.auto.calimero.process.ProcessCommunicationBase Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2010, 2018 B. Malinowsky
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 of the License, 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under terms
of your choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module. An
independent module is a module which is not derived from or based on
this library. If you modify this library, you may extend this exception
to your version of the library, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from your
version.
*/
package tuwien.auto.calimero.process;
import tuwien.auto.calimero.GroupAddress;
import tuwien.auto.calimero.KNXException;
import tuwien.auto.calimero.KNXFormatException;
import tuwien.auto.calimero.KNXTimeoutException;
import tuwien.auto.calimero.Priority;
import tuwien.auto.calimero.datapoint.Datapoint;
import tuwien.auto.calimero.dptxlator.DPTXlator;
import tuwien.auto.calimero.link.KNXLinkClosedException;
import tuwien.auto.calimero.link.KNXNetworkLink;
/**
* Process communication interface for writing to a KNX network.
*
*
* @author B. Malinowsky
*/
public interface ProcessCommunicationBase extends AutoCloseable
{
/**
* Represents "on" of datapoint type Switch (DPT ID 1.001), value =
* {@value #BOOL_ON}.
*
* @see #write(GroupAddress, boolean)
* @see #write(GroupAddress, boolean, int)
*/
boolean BOOL_ON = true;
/**
* Represents "off" of datapoint type Switch (DPT ID 1.001), value =
* {@value #BOOL_OFF}.
*
* @see #write(GroupAddress, boolean)
* @see #write(GroupAddress, boolean, int)
*/
boolean BOOL_OFF = false;
/**
* Represents "up" of datapoint type Up/Down (DPT ID 1.008), value =
* {@value #BOOL_UP}.
*
* @see #write(GroupAddress, boolean)
* @see #write(GroupAddress, boolean, int)
*/
boolean BOOL_UP = false;
/**
* Represents "down" of datapoint type Up/Down (DPT ID 1.008), value =
* {@value #BOOL_DOWN}.
*
* @see #write(GroupAddress, boolean)
* @see #write(GroupAddress, boolean, int)
*/
boolean BOOL_DOWN = true;
/**
* Represents "start" of datapoint type Start (DPT ID 1.010), value =
* {@value #BOOL_START}.
*
* @see #write(GroupAddress, boolean)
* @see #write(GroupAddress, boolean, int)
*/
boolean BOOL_START = true;
/**
* Represents "stop" of datapoint type Start (DPT ID 1.010), value =
* {@value #BOOL_STOP}.
*
* @see #write(GroupAddress, boolean)
* @see #write(GroupAddress, boolean, int)
*/
boolean BOOL_STOP = false;
/**
* Represents "increase" of datapoint type Step (DPT ID 1.007), value =
* {@value #BOOL_INCREASE}.
*
* @see #write(GroupAddress, boolean)
* @see #write(GroupAddress, boolean, int)
*/
boolean BOOL_INCREASE = true;
/**
* Represents "decrease" of datapoint type Step (DPT ID 1.007), value =
* {@value #BOOL_DECREASE}.
*
* @see #write(GroupAddress, boolean)
* @see #write(GroupAddress, boolean, int)
*/
boolean BOOL_DECREASE = false;
/**
* Represents the scaling format of datapoint type Scaling (DPT ID 5.001).
*
* This format scales the 8 Bit unsigned value range from 0 to 100.
*
* @see #write(GroupAddress, int, String)
*/
String SCALING = "5.001";
/**
* Represents the unscaled format, no scaling is used (like in datapoint types
* Unsigned count (DPT ID 5.010) or Decimal factor (DPT ID 5.005) ).
*
* @see #write(GroupAddress, int, String)
*/
String UNSCALED = "5.010";
/**
* Represents the scaling format of datapoint type Angle (DPT ID 5.003).
*
* This format scales the 8 Bit unsigned value range from 0 to 360.
*
* @see #write(GroupAddress, int, String)
*/
String ANGLE = "5.003";
/**
* Sets the KNX message priority for KNX messages to send.
*
* @param p new priority to use
*/
void setPriority(Priority p);
/**
* Returns the currently used KNX message priority for KNX messages.
*
*
* @return message Priority
*/
Priority getPriority();
/**
* Adds the specified event listener l to receive events from this
* process communicator.
*
* If l was already added as listener, no action is performed.
*
* @param l the listener to add
*/
void addProcessListener(ProcessListener l);
/**
* Removes the specified event listener l, so it does no longer
* receive events from this process communicator.
*
* If l was not added in the first place, no action is performed.
*
* @param l the listener to remove
*/
void removeProcessListener(ProcessListener l);
/**
* Writes a boolean datapoint value to a group destination.
*
* @param dst group destination to write to
* @param value boolean value to write, consider the predefined BOOL_* constants (e.g.
* {@link #BOOL_ON})
* @throws KNXTimeoutException on a timeout during send
* @throws KNXLinkClosedException if network link to KNX network is closed
*/
void write(GroupAddress dst, boolean value) throws KNXTimeoutException,
KNXLinkClosedException;
/**
* Writes a 8 bit unsigned datapoint value to a group destination.
*
* The predefined scaling format constants are equal to DPT identifiers of the 8 Bit
* DPT translator, any other suiting IDs of that type might be specified as well.
*
* @param dst group destination to write to
* @param value unsigned scaled value to write, 0 <= value <= scale format
* specific upper value
* @param scale scaling of the read value before return, one of {@link #SCALING},
* {@link #UNSCALED}, {@link #ANGLE}
* @throws KNXTimeoutException on a timeout during send
* @throws KNXFormatException on translation problem of the supplied datapoint value
* @throws KNXLinkClosedException if network link to KNX network is closed
* @throws KNXException on other write problems
*/
void write(GroupAddress dst, int value, String scale) throws KNXException;
/**
* Writes a 3 bit controlled datapoint value to a group destination.
*
* @param dst group destination to write to
* @param control control information, one of the predefined BOOL_* constants of DPT
* Step and DPT Up/Down
* @param stepcode stepcode value, 0 <= value <= 7
* @throws KNXTimeoutException on a timeout during send
* @throws KNXFormatException on translation problem of the supplied datapoint value
* @throws KNXLinkClosedException if network link to KNX network is closed
* @throws KNXException on other write problems
*/
void write(GroupAddress dst, boolean control, int stepcode) throws KNXException;
/**
* Writes a float datapoint value to a group destination.
*
* The supplied float value is written according to the specified float datapoint type.
*
* @param dst group destination to write to
* @param value float value to write
* @param use4ByteFloat specifies the float type of the datapoint; either writes a 2-byte KNX
* float of DPT main number 9 (false), or a 4-byte float of DPT main number
* 14 (true)
* @throws KNXTimeoutException on a timeout during send
* @throws KNXFormatException on translation problem of the supplied datapoint value
* @throws KNXLinkClosedException if network link to KNX network is closed
* @throws KNXException on other write problems
*/
void write(GroupAddress dst, double value, boolean use4ByteFloat) throws KNXException;
/**
* Writes a string datapoint value to a group destination.
*
* The supported character set covers at least ISO-8859-1 (Latin 1), with an allowed
* string length of 14 characters.
*
* @param dst group destination to write to
* @param value string value to write
* @throws KNXTimeoutException on a timeout during send
* @throws KNXFormatException on translation problem of the supplied datapoint value
* @throws KNXLinkClosedException if network link to KNX network is closed
* @throws KNXException on other write problems
*/
void write(GroupAddress dst, String value) throws KNXException;
/**
* Writes the content of the supplied DPTXlator to a group destination.
*
* @param dst group destination to write to
* @param value DPTXlator which's value to write
* @throws KNXTimeoutException on a timeout during send
* @throws KNXFormatException on translation problem of the supplied datapoint value
* @throws KNXLinkClosedException if network link to KNX network is closed
* @throws KNXException on other write problems
*/
void write(GroupAddress dst, DPTXlator value) throws KNXException;
/**
* Writes a datapoint value to a group destination.
*
* The used KNX message priority is according the supplied datapoint priority.
*
* @param dp the datapoint for write
* @param value datapoint value in textual representation according the datapoint its
* type
* @throws KNXTimeoutException on a timeout during send
* @throws KNXFormatException on translation problem of the supplied datapoint value
* @throws KNXLinkClosedException if network link to KNX network is closed
* @throws KNXException if no appropriate DPT translator for the datapoint type is
* available
*/
void write(Datapoint dp, String value) throws KNXException;
/**
* Detaches the network link from this process communicator.
*
* If no network link is attached, no action is performed.
*
* Note that a detach does not trigger a close of the used network link.
*
* @return the formerly attached KNX network link, or null if already
* detached
*/
KNXNetworkLink detach();
@Override
default void close() { detach(); }
}