tuwien.auto.calimero.link.medium.KNXMediumSettings Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2006, 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.link.medium;
import tuwien.auto.calimero.IndividualAddress;
import tuwien.auto.calimero.KNXIllegalArgumentException;
/**
* Container for device and medium specific settings for the KNX network.
*
* Used by a KNX link interface to obtain medium/device information necessary to handle
* communication with the KNX network based on the particular communication medium.
*
* @author B. Malinowsky
*/
public abstract class KNXMediumSettings
{
// medium codes are equal to the ones specified in KNXnet/IP
/**
* KNX medium code for twisted pair 1 (9600 bit/s).
*/
public static final int MEDIUM_TP1 = 0x02;
/**
* KNX medium code for power line 110 kHz (1200 bit/s).
*/
public static final int MEDIUM_PL110 = 0x04;
/**
* KNX medium code for radio frequency (868 MHz).
*/
public static final int MEDIUM_RF = 0x10;
/**
* KNX medium code for KNX IP.
*/
public static final int MEDIUM_KNXIP = 0x20;
/** Individual address 0.0.0. */
public static final IndividualAddress BackboneRouter = new IndividualAddress(0);
// local device address if in transparent server mode
private IndividualAddress dev;
// max APDU can be between 15 and 254 bytes (255 is Escape code for extended L-Data frames)
// should be set according to PropertyAccess.PID.MAX_APDULENGTH, mandatory for new implementations after 2007
private volatile int maxApduLength = 15;
/**
* Creates the medium settings for the specified KNX medium.
*
* @param medium the KNX medium type code, see definitions in {@link KNXMediumSettings}
* @param device individual address to use as source address in KNX messages
* @return the initialized medium-specific settings
* @throws KNXIllegalArgumentException on unknown medium code
*/
public static KNXMediumSettings create(final int medium, final IndividualAddress device)
{
switch (medium) {
case MEDIUM_TP1:
return new TPSettings(device);
case MEDIUM_PL110:
return new PLSettings(device, null);
case MEDIUM_RF:
return new RFSettings(device);
case MEDIUM_KNXIP:
return new KnxIPSettings(device);
default:
throw new KNXIllegalArgumentException("unknown medium type " + medium);
}
}
/**
* Creates a new container for KNX device/medium settings.
*
* @param device individual device address to use as source address in KNX messages
*/
protected KNXMediumSettings(final IndividualAddress device)
{
dev = device;
}
/**
* Sets the device individual address.
*
* @param device individual address to use as new source address in KNX messages
*/
public final synchronized void setDeviceAddress(final IndividualAddress device)
{
dev = device;
}
/**
* Returns the device individual address.
*
* @return individual address
*/
public final synchronized IndividualAddress getDeviceAddress()
{
return dev;
}
/**
* Returns the KNX medium type identifier specifying the communication medium this
* object represents.
*
* @return KNX medium type ID
*/
public abstract int getMedium();
/**
* Returns the KNX medium type code for the specified medium type name.
*
* Allowed type names are, case is ignored:
*
* - TP1
* - PL110, P110
* - RF
* - KNXIP, KNX IP
*
*
* @param mediumName the textual representation of a medium type as returned by
* {@link #getMediumString()}, case-insensitive
* @return the KNX medium type code
* @throws KNXIllegalArgumentException on unknown medium code
*/
public static int getMedium(final String mediumName)
{
if ("tp1".equalsIgnoreCase(mediumName))
return MEDIUM_TP1;
else if ("p110".equalsIgnoreCase(mediumName) || "pl110".equalsIgnoreCase(mediumName))
return MEDIUM_PL110;
else if ("rf".equalsIgnoreCase(mediumName))
return MEDIUM_RF;
else if ("knxip".equalsIgnoreCase(mediumName) || "knx ip".equalsIgnoreCase(mediumName))
return MEDIUM_KNXIP;
else
throw new KNXIllegalArgumentException("unknown medium type " + mediumName);
}
/**
* Returns a textual representation of the KNX medium type.
*
* @return KNX medium as string
* @see #getMedium()
*/
public String getMediumString()
{
return getMediumString(getMedium());
}
/**
* Returns a textual representation of the KNX medium type.
*
* @param knxMedium the KNX medium type identifier
* @return KNX medium as string, or "unknown" on unknown medium type
* @see #getMedium()
*/
public static String getMediumString(final int knxMedium)
{
switch (knxMedium) {
case MEDIUM_TP1:
return "TP1";
case MEDIUM_PL110:
return "PL110";
case MEDIUM_RF:
return "RF";
case MEDIUM_KNXIP:
return "KNX IP";
default:
return "unknown";
}
}
/**
* Returns the maximum APDU length used in the communication with the KNX network.
*
* @return APDU length in the range [15, ..., 254]
*/
public final int maxApduLength() {
return maxApduLength;
}
public void setMaxApduLength(final int maxApduLength) {
if (maxApduLength < 15 || maxApduLength > 254)
throw new KNXIllegalArgumentException("invalid maximum APDU setting of " + maxApduLength);
this.maxApduLength = maxApduLength;
}
/**
* Returns the medium dependent time factor required for calculating certain protocol timings.
*
* @return medium dependent time factor in milliseconds, might be 0
*/
public int timeFactor()
{
return 0;
}
@Override
public String toString()
{
return getMediumString() + " medium, device " + dev;
}
}