tuwien.auto.calimero.link.KNXNetworkLinkFT12 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;
import tuwien.auto.calimero.DataUnitBuilder;
import tuwien.auto.calimero.KNXAckTimeoutException;
import tuwien.auto.calimero.KNXAddress;
import tuwien.auto.calimero.KNXException;
import tuwien.auto.calimero.KNXTimeoutException;
import tuwien.auto.calimero.cemi.CEMILData;
import tuwien.auto.calimero.link.medium.KNXMediumSettings;
import tuwien.auto.calimero.serial.FT12Connection;
import tuwien.auto.calimero.serial.KNXPortClosedException;
/**
* Implementation of the KNX network network link based on the FT1.2 protocol, using a
* {@link FT12Connection}.
*
* @author B. Malinowsky
*/
public class KNXNetworkLinkFT12 extends AbstractLink
{
private static final int PEI_SWITCH = 0xA9;
/**
* Creates a new network link based on the FT1.2 protocol for accessing the KNX network.
*
* The port identifier is used to choose the serial port for communication. These identifiers
* are usually device and platform specific.
*
* @param portID identifier of the serial communication port to use
* @param settings medium settings defining device and medium specifics needed for communication
* @throws KNXException on error creating FT1.2 connection, timeout, or interrupt switching to link layer mode
*/
public KNXNetworkLinkFT12(final String portID, final KNXMediumSettings settings) throws KNXException
{
this(new FT12Connection(portID), settings);
}
/**
* Creates a new network link based on the FT1.2 protocol for accessing the KNX network.
*
* The port number is used to choose the serial port for communication. It is mapped to the
* default port identifier using that number on the platform.
*
* @param portNumber port number of the serial communication port to use
* @param settings medium settings defining device and medium specifics needed for communication
* @throws KNXException on error creating FT1.2 connection, timeout, or interrupt switching to link layer mode
*/
public KNXNetworkLinkFT12(final int portNumber, final KNXMediumSettings settings) throws KNXException
{
this(new FT12Connection(portNumber), settings);
}
/**
* Creates a new network link to a KNX network based on the supplied FT1.2 protocol connection.
*
* @param c a FT1.2 protocol connection in open state
* @param settings medium settings defining device and medium specifics needed for communication
* @throws KNXException on error, timeout, or interrupt while switching to link layer mode
*/
protected KNXNetworkLinkFT12(final FT12Connection c, final KNXMediumSettings settings) throws KNXException
{
super(c, c.getPortID(), settings);
cEMI = false;
sendCEmiAsByteArray = true;
linkLayerMode();
conn.addConnectionListener(notifier);
}
@Override
protected void onSend(final KNXAddress dst, final byte[] msg, final boolean waitForCon)
throws KNXTimeoutException, KNXLinkClosedException
{
try {
logger.debug("send message to {}{}", dst, (waitForCon ? ", wait for ack" : ""));
if (logger.isTraceEnabled())
logger.trace("EMI {}", DataUnitBuilder.toHex(msg, " "));
conn.send(msg, waitForCon);
logger.trace("send to {} succeeded", dst);
}
catch (KNXPortClosedException | InterruptedException e) {
logger.error("send error, closing link", e);
close();
if (e instanceof InterruptedException)
Thread.currentThread().interrupt();
throw new KNXLinkClosedException("link closed, " + e.getMessage());
}
}
@Override
protected void onSend(final CEMILData msg, final boolean waitForCon)
{}
@Override
protected void onClose()
{
try {
normalMode();
}
catch (final Exception e) {
logger.error("could not switch BCU back to normal mode", e);
}
}
private void linkLayerMode() throws KNXException
{
// link layer mode
final byte[] switchLinkLayer = { (byte) PEI_SWITCH, 0x00, 0x18, 0x34, 0x56, 0x78, 0x0A, };
try {
conn.send(switchLinkLayer, true);
}
catch (final InterruptedException e) {
conn.close();
Thread.currentThread().interrupt();
throw new KNXLinkClosedException(e.getMessage());
}
catch (final KNXAckTimeoutException e) {
conn.close();
throw e;
}
}
private void normalMode() throws KNXAckTimeoutException, KNXPortClosedException, InterruptedException
{
final byte[] switchNormal = { (byte) PEI_SWITCH, 0x1E, 0x12, 0x34, 0x56, 0x78, (byte) 0x9A, };
conn.send(switchNormal, true);
}
}