/*
* #%L
* OW2 Chameleon - Fuchsia Framework
* %%
* Copyright (C) 2009 - 2014 OW2 Chameleon
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
/*
Calimero - A library for KNX network access
Copyright (C) 2006-2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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.CloseEvent;
import tuwien.auto.calimero.DataUnitBuilder;
import tuwien.auto.calimero.FrameEvent;
import tuwien.auto.calimero.GroupAddress;
import tuwien.auto.calimero.KNXAddress;
import tuwien.auto.calimero.Priority;
import tuwien.auto.calimero.cemi.CEMIFactory;
import tuwien.auto.calimero.cemi.CEMILData;
import tuwien.auto.calimero.exception.KNXAckTimeoutException;
import tuwien.auto.calimero.exception.KNXException;
import tuwien.auto.calimero.exception.KNXFormatException;
import tuwien.auto.calimero.exception.KNXIllegalArgumentException;
import tuwien.auto.calimero.exception.KNXTimeoutException;
import tuwien.auto.calimero.link.event.NetworkLinkListener;
import tuwien.auto.calimero.link.medium.KNXMediumSettings;
import tuwien.auto.calimero.log.LogManager;
import tuwien.auto.calimero.log.LogService;
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}.
* <p>
* Once a link has been closed, it is not available for further link communication, i.e.
* it can't be reopened.
*
* @author B. Malinowsky
*/
public class KNXNetworkLinkFT12 implements KNXNetworkLink
{
private static final class LinkNotifier extends EventNotifier
{
LinkNotifier(Object source, LogService logger)
{
super(source, logger);
}
public void frameReceived(FrameEvent e)
{
try {
final CEMILData f =
(CEMILData) CEMIFactory.createFromEMI(e.getFrameBytes());
final int mc = f.getMessageCode();
if (mc == CEMILData.MC_LDATA_IND) {
addEvent(new Indication(new FrameEvent(source, f)));
logger.info("indication from " + f.getSource());
}
else if (mc == CEMILData.MC_LDATA_CON) {
addEvent(new Confirmation(new FrameEvent(source, f)));
logger.info("confirmation of " + f.getDestination());
}
}
catch (final KNXFormatException ex) {
logger.warn("unspecified frame event - ignored", ex);
}
}
public void connectionClosed(CloseEvent e)
{
((KNXNetworkLinkFT12) source).closed = true;
super.connectionClosed(e);
logger.info("link closed");
LogManager.getManager().removeLogService(logger.getName());
}
};
private static final int PEI_SWITCH = 0xA9;
private volatile boolean closed;
private final FT12Connection conn;
private volatile byte hopCount = 6;
private KNXMediumSettings medium;
private final LogService logger;
// our link connection event notifier
private final EventNotifier notifier;
/**
* Creates a new network link based on the FT1.2 protocol for accessing the KNX
* network.
* <p>
* 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
*/
public KNXNetworkLinkFT12(String portID, KNXMediumSettings settings)
throws KNXException
{
conn = new FT12Connection(portID);
try {
linkLayerMode();
}
catch (final KNXAckTimeoutException e) {
conn.close();
throw e;
}
logger = LogManager.getManager().getLogService(getName());
notifier = new LinkNotifier(this, logger);
conn.addConnectionListener(notifier);
// configure KNX medium stuff
setKNXMedium(settings);
}
/**
* Creates a new network link based on the FT1.2 protocol for accessing the KNX
* network.
* <p>
* 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
*/
public KNXNetworkLinkFT12(int portNumber, KNXMediumSettings settings)
throws KNXException
{
conn = new FT12Connection(portNumber);
linkLayerMode();
logger = LogManager.getManager().getLogService(getName());
notifier = new LinkNotifier(this, logger);
conn.addConnectionListener(notifier);
// configure KNX medium stuff
setKNXMedium(settings);
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#setKNXMedium
* (tuwien.auto.calimero.link.medium.KNXMediumSettings)
*/
public void setKNXMedium(KNXMediumSettings settings)
{
if (settings == null)
throw new KNXIllegalArgumentException("medium settings are mandatory");
if (medium != null && !settings.getClass().isAssignableFrom(medium.getClass())
&& !medium.getClass().isAssignableFrom(settings.getClass()))
throw new KNXIllegalArgumentException("medium differs");
medium = settings;
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#getKNXMedium()
*/
public KNXMediumSettings getKNXMedium()
{
return medium;
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#addLinkListener
* (tuwien.auto.calimero.link.event.NetworkLinkListener)
*/
public void addLinkListener(NetworkLinkListener l)
{
notifier.addListener(l);
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#removeLinkListener
* (tuwien.auto.calimero.link.event.NetworkLinkListener)
*/
public void removeLinkListener(NetworkLinkListener l)
{
notifier.removeListener(l);
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#setHopCount(int)
*/
public void setHopCount(int count)
{
if (count < 0 || count > 7)
throw new KNXIllegalArgumentException("hop count out of range [0..7]");
hopCount = (byte) count;
logger.info("hop count set to " + count);
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#getHopCount()
*/
public byte getHopCount()
{
return hopCount;
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#sendRequest
* (tuwien.auto.calimero.KNXAddress, tuwien.auto.calimero.Priority, byte[])
*/
public void sendRequest(KNXAddress dst, Priority p, byte[] nsdu)
throws KNXTimeoutException, KNXLinkClosedException
{
doSend(createEMI(CEMILData.MC_LDATA_REQ, dst, p, nsdu), false, dst);
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#sendRequestWait
* (tuwien.auto.calimero.KNXAddress, tuwien.auto.calimero.Priority, byte[])
*/
public void sendRequestWait(KNXAddress dst, Priority p, byte[] nsdu)
throws KNXTimeoutException, KNXLinkClosedException
{
doSend(createEMI(CEMILData.MC_LDATA_REQ, dst, p, nsdu), true, dst);
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#send
* (tuwien.auto.calimero.cemi.CEMILData, boolean)
*/
public void send(CEMILData msg, boolean waitForCon) throws KNXTimeoutException,
KNXLinkClosedException
{
doSend(createEMI(msg), waitForCon, msg.getDestination());
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#getName()
*/
public String getName()
{
return "link " + conn.getPortID();
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#isOpen()
*/
public boolean isOpen()
{
return !closed;
}
/* (non-Javadoc)
* @see tuwien.auto.calimero.link.KNXNetworkLink#close()
*/
public void close()
{
synchronized (this) {
if (closed)
return;
closed = true;
}
try {
normalMode();
}
catch (final KNXException e) {
logger.error("could not switch BCU back to normal mode", e);
}
conn.close();
notifier.quit();
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
public String toString()
{
return getName() + (closed ? "(closed), " : ", ") + medium.getMediumString()
+ " medium hopcount " + hopCount;
}
private void linkLayerMode() throws KNXAckTimeoutException, KNXPortClosedException
{
// link layer mode
final byte[] switchLinkLayer =
{ (byte) PEI_SWITCH, 0x00, 0x18, 0x34, 0x56, 0x78, 0x0A, };
conn.send(switchLinkLayer, true);
}
private void normalMode() throws KNXAckTimeoutException, KNXPortClosedException
{
final byte[] switchNormal =
{ (byte) PEI_SWITCH, 0x1E, 0x12, 0x34, 0x56, 0x78, (byte) 0x9A, };
conn.send(switchNormal, true);
}
private byte[] createEMI(CEMILData f)
{
final byte[] buf =
createEMI(f.getMessageCode(), f.getDestination(), f.getPriority(), f
.getPayload());
final int ctrl =
(f.isRepetition() ? 0x20 : 0) | (f.isAckRequested() ? 0x02 : 0)
| (f.isPositiveConfirmation() ? 0 : 0x01);
buf[1] |= (byte) ctrl;
if (f.getHopCount() != hopCount)
buf[6] = (byte) (buf[6] & ~0x70 | f.getHopCount() << 4);
return buf;
}
private byte[] createEMI(int mc, KNXAddress dst, Priority p, byte[] nsdu)
{
if (nsdu.length > 16)
throw new KNXIllegalArgumentException(
"maximum TPDU length is 16 in standard frame");
// TP1, standard frames only
final byte[] buf = new byte[nsdu.length + 7];
buf[0] = (byte) mc;
// ack don't care
buf[1] = (byte) (p.value << 2);
// on dst null, default address 0 is used
// (null indicates system broadcast in link API)
final int d = dst != null ? dst.getRawAddress() : 0;
buf[4] = (byte) (d >> 8);
buf[5] = (byte) d;
buf[6] = (byte) (hopCount << 4 | (nsdu.length - 1));
if (dst instanceof GroupAddress)
buf[6] |= 0x80;
for (int i = 0; i < nsdu.length; ++i)
buf[7 + i] = nsdu[i];
return buf;
}
// dst is just for log information
private void doSend(byte[] msg, boolean wait, KNXAddress dst)
throws KNXAckTimeoutException, KNXLinkClosedException
{
if (closed)
throw new KNXLinkClosedException("link closed");
try {
logger.info("send message to " + dst + (wait ? ", wait for ack" : ""));
logger.trace("EMI " + DataUnitBuilder.toHex(msg, " "));
conn.send(msg, wait);
logger.trace("send to " + dst + " succeeded");
}
catch (final KNXPortClosedException e) {
logger.error("send error, closing link", e);
close();
throw new KNXLinkClosedException("link closed, " + e.getMessage());
}
}
}